Programowanie lokalne za pomocą pakietu emulatorów Firebase

1. Zanim zaczniesz

Bezserwerowe narzędzia zaplecza, takie jak Cloud Firestore i Cloud Functions, są bardzo łatwe w użyciu, ale mogą być trudne do przetestowania. Pakiet Firebase Local Emulator Suite umożliwia uruchamianie lokalnych wersji tych usług na komputerze deweloperskim, dzięki czemu możesz szybko i bezpiecznie tworzyć swoją aplikację.

Warunki wstępne

  • Prosty edytor, taki jak Visual Studio Code, Atom lub Sublime Text
  • Node.js 10.0.0 lub nowszy (aby zainstalować Node.js, użyj nvm , aby sprawdzić swoją wersję, uruchom node --version )
  • Java 7 lub nowsza (aby zainstalować Javę, skorzystaj z tych instrukcji , aby sprawdzić swoją wersję, uruchom java -version )

Co zrobisz

Podczas tego ćwiczenia z programowania będziesz uruchamiać i debugować prostą aplikację do zakupów online, która jest obsługiwana przez wiele usług Firebase:

  • Cloud Firestore: globalnie skalowalna, bezserwerowa baza danych NoSQL z funkcjami czasu rzeczywistego.
  • Cloud Functions : bezserwerowy kod zaplecza, który jest uruchamiany w odpowiedzi na zdarzenia lub żądania HTTP.
  • Uwierzytelnianie Firebase : zarządzana usługa uwierzytelniania, która integruje się z innymi produktami Firebase.
  • Hosting Firebase : szybki i bezpieczny hosting aplikacji internetowych.

Połączysz aplikację z pakietem emulatorów, aby umożliwić rozwój lokalny.

2589e2f95b74fa88.png

Dowiesz się również, jak:

  • Jak połączyć swoją aplikację z pakietem emulatorów i jak połączone są różne emulatory.
  • Jak działają reguły bezpieczeństwa Firebase i jak testować reguły bezpieczeństwa Firestore na lokalnym emulatorze.
  • Jak napisać funkcję Firebase, która jest wyzwalana przez zdarzenia Firestore i jak pisać testy integracji, które działają z pakietem emulatorów.

2. Skonfiguruj

Pobierz kod źródłowy

W tym laboratorium kodowania zaczynasz od wersji próbki The Fire Store, która jest prawie gotowa, więc pierwszą rzeczą, którą musisz zrobić, to sklonować kod źródłowy:

$ git clone https://github.com/firebase/emulators-codelab.git

Następnie przejdź do katalogu codelab, gdzie będziesz pracować przez pozostałą część tego ćwiczenia z programowania:

$ cd emulators-codelab/codelab-initial-state

Teraz zainstaluj zależności, aby móc uruchomić kod. Jeśli korzystasz z wolniejszego połączenia internetowego, może to zająć minutę lub dwie:

# Move into the functions directory
$ cd functions

# Install dependencies
$ npm install

# Move back into the previous directory
$ cd ../

Pobierz interfejs wiersza polecenia Firebase

Pakiet emulatorów jest częścią Firebase CLI (interfejs wiersza poleceń), który można zainstalować na komputerze za pomocą następującego polecenia:

$ npm install -g firebase-tools

Następnie potwierdź, że masz najnowszą wersję interfejsu wiersza polecenia. To laboratorium powinno działać z wersją 9.0.0 lub nowszą, ale nowsze wersje zawierają więcej poprawek błędów.

$ firebase --version
9.6.0

Połącz się ze swoim projektem Firebase

Jeśli nie masz projektu Firebase, w konsoli Firebase utwórz nowy projekt Firebase. Zanotuj wybrany identyfikator projektu, będzie on potrzebny później.

Teraz musimy połączyć ten kod z Twoim projektem Firebase. Najpierw uruchom następujące polecenie, aby zalogować się do interfejsu Firebase CLI:

$ firebase login

Następnie uruchom następujące polecenie, aby utworzyć alias projektu. Zastąp $YOUR_PROJECT_ID identyfikatorem swojego projektu Firebase.

$ firebase use $YOUR_PROJECT_ID

Teraz możesz uruchomić aplikację!

3. Uruchom emulatory

W tej sekcji uruchomisz aplikację lokalnie. Oznacza to, że nadszedł czas, aby uruchomić pakiet emulatorów.

Uruchom emulatory

Z wnętrza katalogu źródłowego ćwiczeń z kodowania uruchom następujące polecenie, aby uruchomić emulatory:

$ firebase emulators:start --import=./seed

Powinieneś zobaczyć takie dane wyjściowe:

$ firebase emulators:start --import=./seed
i  emulators: Starting emulators: auth, functions, firestore, hosting
⚠  functions: The following emulators are not running, calls to these services from the Functions emulator will affect production: database, pubsub
i  firestore: Importing data from /Users/samstern/Projects/emulators-codelab/codelab-initial-state/seed/firestore_export/firestore_export.overall_export_metadata
i  firestore: Firestore Emulator logging to firestore-debug.log
i  hosting: Serving hosting files from: public
✔  hosting: Local server: http://localhost:5000
i  ui: Emulator UI logging to ui-debug.log
i  functions: Watching "/Users/samstern/Projects/emulators-codelab/codelab-initial-state/functions" for Cloud Functions...
✔  functions[calculateCart]: firestore function initialized.

┌─────────────────────────────────────────────────────────────┐
│ ✔  All emulators ready! It is now safe to connect your app. │
│ i  View Emulator UI at http://localhost:4000                │
└─────────────────────────────────────────────────────────────┘

┌────────────────┬────────────────┬─────────────────────────────────┐
│ Emulator       │ Host:Port      │ View in Emulator UI             │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Authentication │ localhost:9099 │ http://localhost:4000/auth      │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Functions      │ localhost:5001 │ http://localhost:4000/functions │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Firestore      │ localhost:8080 │ http://localhost:4000/firestore │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Hosting        │ localhost:5000 │ n/a                             │
└────────────────┴────────────────┴─────────────────────────────────┘
  Emulator Hub running at localhost:4400
  Other reserved ports: 4500

Issues? Report them at https://github.com/firebase/firebase-tools/issues and attach the *-debug.log files.

Gdy zobaczysz komunikat Wszystkie emulatory uruchomione , aplikacja jest gotowa do użycia.

Połącz aplikację internetową z emulatorami

Na podstawie tabeli w dziennikach widzimy, że emulator Cloud Firestore nasłuchuje na porcie 8080 , a emulator uwierzytelniania nasłuchuje na porcie 9099 .

┌────────────────┬────────────────┬─────────────────────────────────┐
│ Emulator       │ Host:Port      │ View in Emulator UI             │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Authentication │ localhost:9099 │ http://localhost:4000/auth      │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Functions      │ localhost:5001 │ http://localhost:4000/functions │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Firestore      │ localhost:8080 │ http://localhost:4000/firestore │
├────────────────┼────────────────┼─────────────────────────────────┤
│ Hosting        │ localhost:5000 │ n/a                             │
└────────────────┴────────────────┴─────────────────────────────────┘

Połączmy Twój kod frontendu z emulatorem, a nie z produkcją. Otwórz plik public/js/homepage.js i znajdź funkcję onDocumentReady . Widzimy, że kod uzyskuje dostęp do standardowych instancji Firestore i Auth:

public/js/homepage.js

  const auth = firebaseApp.auth();
  const db = firebaseApp.firestore();

Zaktualizujmy obiekty db i auth , aby wskazywały na lokalne emulatory:

public/js/homepage.js

  const auth = firebaseApp.auth();
  const db = firebaseApp.firestore();

  // ADD THESE LINES
  if (location.hostname === "localhost") {
    console.log("localhost detected!");
    auth.useEmulator("http://localhost:9099");
    db.useEmulator("localhost", 8080);
  }

Teraz, gdy aplikacja działa na hoście lokalnym (obsługiwanym przez emulator hostingu), klient Firestore również wskazuje na emulator lokalny, a nie na produkcyjną bazę danych.

Otwórz EmulatorUI

W przeglądarce internetowej przejdź do http://localhost:4000/ . Powinieneś zobaczyć interfejs użytkownika pakietu emulatorów.

Ekran główny UI emulatorów

Kliknij, aby wyświetlić interfejs użytkownika emulatora Firestore. Kolekcja items zawiera już dane, ponieważ dane zostały zaimportowane z flagą --import .

4ef88d0148405d36.png

4. Uruchom aplikację

Otwórz aplikację

W przeglądarce internetowej przejdź do http://localhost:5000 i powinieneś zobaczyć The Fire Store działający lokalnie na twoim komputerze!

939f87946bac2ee4.png

Użyj aplikacji

Wybierz przedmiot na stronie głównej i kliknij Dodaj do koszyka . Niestety, napotkasz następujący błąd:

a11bd59933a8e885.png

Naprawmy ten błąd! Ponieważ wszystko działa w emulatorach, możemy eksperymentować i nie martwić się o wpływ na rzeczywiste dane.

5. Debuguj aplikację

Znajdź błąd

Ok, spójrzmy w konsoli programisty Chrome. Naciśnij Control+Shift+J (Windows, Linux, Chrome OS) lub Command+Option+J (Mac), aby wyświetlić błąd na konsoli:

74c45df55291dab1.png

Wygląda na to, że wystąpił błąd w metodzie addToCart , spójrzmy na to. Gdzie próbujemy uzyskać dostęp do czegoś zwanego uid w tej metodzie i dlaczego miałoby to być null ? W tej chwili metoda wygląda tak w public/js/homepage.js :

public/js/homepage.js

  addToCart(id, itemData) {
    console.log("addToCart", id, JSON.stringify(itemData));
    return this.db
      .collection("carts")
      .doc(this.auth.currentUser.uid)
      .collection("items")
      .doc(id)
      .set(itemData);
  }

Aha! Nie jesteśmy zalogowani do aplikacji. Zgodnie z dokumentacją Firebase Authentication , gdy nie jesteśmy zalogowani, auth.currentUser ma null . Dodajmy na to czek:

public/js/homepage.js

  addToCart(id, itemData) {
    // ADD THESE LINES
    if (this.auth.currentUser === null) {
      this.showError("You must be signed in!");
      return;
    }

    // ...
  }

Przetestuj aplikację

Teraz odśwież stronę, a następnie kliknij Dodaj do koszyka . Tym razem powinieneś otrzymać ładniejszy błąd:

c65f6c05588133f7.png

Ale jeśli klikniesz Zaloguj się na górnym pasku narzędzi, a następnie ponownie klikniesz Dodaj do koszyka , zobaczysz, że koszyk został zaktualizowany.

Jednak nie wygląda na to, że liczby są w ogóle poprawne:

239f26f02f959eef.png

Nie martw się, wkrótce naprawimy ten błąd. Najpierw zagłębmy się w to, co faktycznie wydarzyło się po dodaniu przedmiotu do koszyka.

6. Lokalne wyzwalacze funkcji

Kliknięcie Dodaj do koszyka uruchamia łańcuch zdarzeń, które obejmują wiele emulatorów. W dziennikach Firebase CLI po dodaniu elementu do koszyka powinny pojawić się następujące komunikaty:

i  functions: Beginning execution of "calculateCart"
i  functions: Finished "calculateCart" in ~1s

Wystąpiły cztery kluczowe zdarzenia, które spowodowały wygenerowanie tych dzienników i zaobserwowanej aktualizacji interfejsu użytkownika:

68c9323f2ad10f7a.png

1) Firestore Write — klient

Nowy dokument zostanie dodany do kolekcji Firestore /carts/{cartId}/items/{itemId}/ . Możesz zobaczyć ten kod w funkcji addToCart wewnątrz public/js/homepage.js :

public/js/homepage.js

  addToCart(id, itemData) {
    // ...
    console.log("addToCart", id, JSON.stringify(itemData));
    return this.db
      .collection("carts")
      .doc(this.auth.currentUser.uid)
      .collection("items")
      .doc(id)
      .set(itemData);
  }

2) Wyzwolona funkcja chmury

Funkcja Cloud Function calculateCart nasłuchuje wszelkich zdarzeń zapisu (tworzenie, aktualizacja lub usuwanie), które zdarzają się elementom koszyka za pomocą wyzwalacza onWrite , który można zobaczyć w functions/index.js :

funkcje/indeks.js

exports.calculateCart = functions.firestore
    .document("carts/{cartId}/items/{itemId}")
    .onWrite(async (change, context) => {
      try {
        let totalPrice = 125.98;
        let itemCount = 8;

        const cartRef = db.collection("carts").doc(context.params.cartId);

        await cartRef.update({
          totalPrice,
          itemCount
        });
      } catch(err) {
      }
    }
);

3) Zapis Firestore — Administrator

Funkcja calculateCart w koszyku odczytuje wszystkie pozycje w koszyku i sumuje całkowitą ilość oraz cenę, a następnie aktualizuje dokument „koszyka” o nowe sumy (patrz cartRef.update(...) ).

4) Odczyt Firestore — klient

Frontend internetowy jest subskrybowany, aby otrzymywać aktualizacje o zmianach w koszyku. Otrzymuje aktualizację w czasie rzeczywistym po tym, jak funkcja w chmurze zapisze nowe sumy i zaktualizuje interfejs użytkownika, jak widać w public/js/homepage.js :

public/js/homepage.js

this.cartUnsub = cartRef.onSnapshot(cart => {
   // The cart document was changed, update the UI
   // ...
});

Podsumowanie

Dobra robota! Po prostu konfigurujesz w pełni lokalną aplikację, która używa trzech różnych emulatorów Firebase do w pełni lokalnego testowania.

db82eef1706c9058.gif

Ale czekaj, jest więcej! W kolejnej sekcji dowiesz się:

  • Jak pisać testy jednostkowe korzystające z emulatorów Firebase.
  • Jak używać emulatorów Firebase do debugowania reguł zabezpieczeń.

7. Utwórz reguły bezpieczeństwa dostosowane do Twojej aplikacji

Nasza aplikacja internetowa odczytuje i zapisuje dane, ale do tej pory w ogóle nie martwiliśmy się o bezpieczeństwo. Cloud Firestore używa systemu o nazwie „Reguły bezpieczeństwa” do deklarowania, kto ma dostęp do odczytu i zapisu danych. Emulator Suite to świetny sposób na prototypowanie tych reguł.

W edytorze otwórz plik emulators-codelab/codelab-initial-state/firestore.rules . Zobaczysz, że w naszych zasadach mamy trzy główne sekcje:

rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    // User's cart metadata
    match /carts/{cartID} {
      // TODO: Change these! Anyone can read or write.
      allow read, write: if true;
    }

    // Items inside the user's cart
    match /carts/{cartID}/items/{itemID} {
      // TODO: Change these! Anyone can read or write.
      allow read, write: if true;
    }

    // All items available in the store. Users can read
    // items but never write them.
    match /items/{itemID} {
      allow read: if true;
    }
  }
}

Już teraz każdy może czytać i zapisywać dane w naszej bazie danych! Chcemy mieć pewność, że przechodzą tylko prawidłowe operacje i nie ujawniamy żadnych poufnych informacji.

Podczas tego ćwiczenia kodowania, zgodnie z zasadą najmniejszych uprawnień, będziemy blokować wszystkie dokumenty i stopniowo dodawać dostęp, aż wszyscy użytkownicy będą mieli dostęp, którego potrzebują, ale nie więcej. Zaktualizujmy dwie pierwsze reguły, aby odmówić dostępu, ustawiając warunek na false :

rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    // User's cart metadata
    match /carts/{cartID} {
      // UPDATE THIS LINE
      allow read, write: if false;
    }

    // Items inside the user's cart
    match /carts/{cartID}/items/{itemID} {
      // UPDATE THIS LINE
      allow read, write: if false;
    }

    // All items available in the store. Users can read
    // items but never write them.
    match /items/{itemID} {
      allow read: if true;
    }
  }
}

8. Uruchom emulatory i testy

Uruchom emulatory

W wierszu poleceń upewnij się, że jesteś w emulators-codelab/codelab-initial-state/ . Możesz nadal mieć uruchomione emulatory z poprzednich kroków. Jeśli nie, uruchom ponownie emulatory:

$ firebase emulators:start --import=./seed

Gdy emulatory są uruchomione, możesz uruchamiać na nich testy lokalnie.

Uruchom testy

W wierszu poleceń w nowej karcie terminala z katalogu emulators-codelab/codelab-initial-state/

Najpierw przejdź do katalogu funkcji (zostaniemy tutaj przez resztę ćwiczenia z programowania):

$ cd functions

Teraz uruchom testy mokki w katalogu funkcji i przewiń na górę danych wyjściowych:

# Run the tests
$ npm test

> functions@ test .../emulators-codelab/codelab-initial-state/functions
> mocha

  shopping carts
    1) can be created and updated by the cart owner
    2) can be read only by the cart owner

  shopping cart items
    3) can be read only by the cart owner
    4) can be added only by the cart owner

  adding an item to the cart recalculates the cart total. 
    - should sum the cost of their items


  0 passing (364ms)
  1 pending
  4 failing

W tej chwili mamy cztery porażki. Podczas tworzenia pliku reguł możesz mierzyć postęp, obserwując zaliczenie kolejnych testów.

9. Bezpieczny dostęp do koszyka

Pierwsze dwa błędy to testy „koszyka”, które sprawdzają, że:

  • Użytkownicy mogą tworzyć i aktualizować tylko własne koszyki
  • Użytkownicy mogą czytać tylko własne koszyki

funkcje/test.js

  it('can be created and updated by the cart owner', async () => {
    // Alice can create her own cart
    await firebase.assertSucceeds(aliceDb.doc("carts/alicesCart").set({
      ownerUID: "alice",
      total: 0
    }));

    // Bob can't create Alice's cart
    await firebase.assertFails(bobDb.doc("carts/alicesCart").set({
      ownerUID: "alice",
      total: 0
    }));

    // Alice can update her own cart with a new total
    await firebase.assertSucceeds(aliceDb.doc("carts/alicesCart").update({
      total: 1
    }));

    // Bob can't update Alice's cart with a new total
    await firebase.assertFails(bobDb.doc("carts/alicesCart").update({
      total: 1
    }));
  });

  it("can be read only by the cart owner", async () => {
    // Setup: Create Alice's cart as admin
    await admin.doc("carts/alicesCart").set({
      ownerUID: "alice",
      total: 0
    });

    // Alice can read her own cart
    await firebase.assertSucceeds(aliceDb.doc("carts/alicesCart").get());

    // Bob can't read Alice's cart
    await firebase.assertFails(bobDb.doc("carts/alicesCart").get());
  });

Niech te testy przejdą. W edytorze otwórz plik reguł bezpieczeństwa firestore.rules i zaktualizuj instrukcje w match /carts/{cartID} :

firestore.zasady

rules_version = '2';
service cloud.firestore {
    // UPDATE THESE LINES
    match /carts/{cartID} {
      allow create: if request.auth.uid == request.resource.data.ownerUID;
      allow read, update, delete: if request.auth.uid == resource.data.ownerUID;
    }

    // ...
  }
}

Te reguły pozwalają teraz tylko właścicielowi koszyka na dostęp do odczytu i zapisu.

Do weryfikacji przychodzących danych i uwierzytelnienia użytkownika wykorzystujemy dwa obiekty, które są dostępne w kontekście każdej reguły:

10. Przetestuj dostęp do koszyka

Emulator Suite automatycznie aktualizuje reguły po każdym zapisaniu firestore.rules . Możesz potwierdzić, że emulator zaktualizował reguły, przeglądając zakładkę z uruchomionym emulatorem w celu wyświetlenia komunikatu Rules updated :

5680da418b420226.png

Ponownie uruchom testy i sprawdź, czy pierwsze dwa testy teraz zakończą się pomyślnie:

$ npm test

> functions@ test .../emulators-codelab/codelab-initial-state/functions
> mocha

  shopping carts
    ✓ can be created and updated by the cart owner (195ms)
    ✓ can be read only by the cart owner (136ms)

  shopping cart items
    1) can be read only by the cart owner
    2) can be added only by the cart owner

  adding an item to the cart recalculates the cart total. 
    - should sum the cost of their items

  2 passing (482ms)
  1 pending
  2 failing

Dobra robota! Masz teraz zapewniony dostęp do koszyków. Przejdźmy do następnego nieudanego testu.

11. Sprawdź przepływ „Dodaj do koszyka” w interfejsie użytkownika

Obecnie, chociaż właściciele koszyków czytają i zapisują w swoim koszyku, nie mogą czytać ani zapisywać poszczególnych pozycji w swoim koszyku. Dzieje się tak, ponieważ właściciele mają dostęp do dokumentu koszyka, ale nie mają dostępu do podkolekcji elementów koszyka .

To jest zepsuty stan dla użytkowników.

Wróć do internetowego interfejsu użytkownika, który działa pod http://localhost:5000, i spróbuj dodać coś do koszyka. Pojawia się błąd Permission Denied widoczny w konsoli debugowania, ponieważ nie przyznaliśmy jeszcze użytkownikom dostępu do dokumentów utworzonych w podkolekcji items .

12. Zezwól na dostęp do elementów koszyka

Te dwa testy potwierdzają, że użytkownicy mogą dodawać elementy do lub czytać elementy tylko z własnego koszyka:

  it("can be read only by the cart owner", async () => {
    // Alice can read items in her own cart
    await firebase.assertSucceeds(aliceDb.doc("carts/alicesCart/items/milk").get());

    // Bob can't read items in alice's cart
    await firebase.assertFails(bobDb.doc("carts/alicesCart/items/milk").get())
  });

  it("can be added only by the cart owner",  async () => {
    // Alice can add an item to her own cart
    await firebase.assertSucceeds(aliceDb.doc("carts/alicesCart/items/lemon").set({
      name: "lemon",
      price: 0.99
    }));

    // Bob can't add an item to alice's cart
    await firebase.assertFails(bobDb.doc("carts/alicesCart/items/lemon").set({
      name: "lemon",
      price: 0.99
    }));
  });

Możemy więc napisać regułę, która zezwala na dostęp, jeśli bieżący użytkownik ma taki sam UID jak właściciel w dokumencie koszyka. Ponieważ nie ma potrzeby określania różnych reguł create, update, delete , możesz użyć reguły write , która ma zastosowanie do wszystkich żądań modyfikujących dane.

Zaktualizuj regułę dla dokumentów w podkolekcji elementów. Warunek get in odczytuje wartość z Firestore — w tym przypadku ownerUID w dokumencie koszyka.

rules_version = '2';
service cloud.firestore {
  match /databases/{database}/documents {
    // ...

    // UPDATE THESE LINES
    match /carts/{cartID}/items/{itemID} {
      allow read, write: if get(/databases/$(database)/documents/carts/$(cartID)).data.ownerUID == request.auth.uid;
    }

    // ...
  }
}

13. Testuj dostęp do pozycji koszyka

Teraz możemy powtórzyć test. Przewiń do góry danych wyjściowych i sprawdź, czy kolejne testy przeszły pomyślnie:

$ npm test

> functions@ test .../emulators-codelab/codelab-initial-state/functions
> mocha

  shopping carts
    ✓ can be created and updated by the cart owner (195ms)
    ✓ can be read only by the cart owner (136ms)

  shopping cart items
    ✓ can be read only by the cart owner (111ms)
    ✓ can be added only by the cart owner


  adding an item to the cart recalculates the cart total. 
    - should sum the cost of their items


  4 passing (401ms)
  1 pending

Miły! Teraz wszystkie nasze testy zdają. Mamy jeden test do wykonania, ale przejdziemy do tego w kilku krokach.

14. Ponownie sprawdź przepływ „dodaj do koszyka”

Wróć do interfejsu internetowego ( http://localhost:5000 ) i dodaj element do koszyka. Jest to ważny krok, aby potwierdzić, że nasze testy i reguły odpowiadają funkcjonalności wymaganej przez klienta. (Pamiętaj, że ostatnim razem, gdy testowaliśmy, użytkownicy interfejsu nie mogli dodawać produktów do koszyka!)

69ad26cee520bf24.png

Klient automatycznie przeładowuje reguły po zapisaniu firestore.rules . Spróbuj więc dodać coś do koszyka.

Podsumowanie

Dobra robota! Właśnie poprawiłeś bezpieczeństwo swojej aplikacji, co jest niezbędnym krokiem do przygotowania jej do produkcji! Gdyby była to aplikacja produkcyjna, moglibyśmy dodać te testy do naszego potoku ciągłej integracji. Dałoby nam to pewność, że w przyszłości dane naszego koszyka będą miały te kontrole dostępu, nawet jeśli inni modyfikują reguły.

ba5440b193e75967.gif

Ale czekaj, jest więcej!

jeśli będziesz kontynuować, dowiesz się:

  • Jak napisać funkcję wyzwalaną przez zdarzenie Firestore
  • Jak tworzyć testy działające na wielu emulatorach

15. Skonfiguruj testy Cloud Functions

Do tej pory koncentrowaliśmy się na interfejsie naszej aplikacji internetowej i regułach bezpieczeństwa Firestore. Ale ta aplikacja korzysta również z Cloud Functions, aby aktualizować koszyk użytkownika, więc chcemy przetestować również ten kod.

Pakiet emulatorów ułatwia testowanie funkcji Cloud Functions, nawet funkcji korzystających z Cloud Firestore i innych usług.

W edytorze otwórz emulators-codelab/codelab-initial-state/functions/test.js i przewiń do ostatniego testu w pliku. Obecnie jest oznaczony jako oczekujący:

//  REMOVE .skip FROM THIS LINE
describe.skip("adding an item to the cart recalculates the cart total. ", () => {
  // ...

  it("should sum the cost of their items", async () => {
    ...
  });
});

Aby włączyć test, usuń .skip , więc wygląda to tak:

describe("adding an item to the cart recalculates the cart total. ", () => {
  // ...

  it("should sum the cost of their items", async () => {
    ...
  });
});

Następnie znajdź zmienną REAL_FIREBASE_PROJECT_ID u góry pliku i zmień ją na swój prawdziwy identyfikator projektu Firebase.:

// CHANGE THIS LINE
const REAL_FIREBASE_PROJECT_ID = "changeme";

Jeśli nie pamiętasz identyfikatora projektu, możesz go znaleźć w ustawieniach projektu w konsoli Firebase:

d6d0429b700d2b21.png

16. Przejdź przez testy funkcji

Ponieważ ten test weryfikuje interakcję między Cloud Firestore i Cloud Functions, obejmuje on więcej konfiguracji niż testy z poprzednich ćwiczeń z kodowania. Przejdźmy przez ten test i zorientujmy się, czego oczekuje.

Utwórz koszyk

Cloud Functions działa w środowisku zaufanego serwera i może korzystać z uwierzytelniania konta usługi używanego przez pakiet Admin SDK . Najpierw inicjujesz aplikację przy użyciu initializeAdminApp zamiast initializeApp . Następnie tworzysz dokument DocumentReference dla koszyka, do którego będziemy dodawać elementy i inicjujesz koszyk:

it("should sum the cost of their items", async () => {
    const db = firebase
        .initializeAdminApp({ projectId: REAL_FIREBASE_PROJECT_ID })
        .firestore();

    // Setup: Initialize cart
    const aliceCartRef = db.doc("carts/alice")
    await aliceCartRef.set({ ownerUID: "alice", totalPrice: 0 });

    ...
  });

Uruchom funkcję

Następnie dodaj dokumenty do podkolekcji items naszego dokumentu koszyka w celu uruchomienia funkcji. Dodaj dwa elementy, aby upewnić się, że testujesz dodawanie, które ma miejsce w funkcji.

it("should sum the cost of their items", async () => {
    const db = firebase
        .initializeAdminApp({ projectId: REAL_FIREBASE_PROJECT_ID })
        .firestore();

    // Setup: Initialize cart
    const aliceCartRef = db.doc("carts/alice")
    await aliceCartRef.set({ ownerUID: "alice", totalPrice: 0 });

    //  Trigger calculateCart by adding items to the cart
    const aliceItemsRef = aliceCartRef.collection("items");
    await aliceItemsRef.doc("doc1").set({name: "nectarine", price: 2.99});
    await aliceItemsRef.doc("doc2").set({ name: "grapefruit", price: 6.99 });

    ...
    });
  });

Ustaw oczekiwania testowe

Użyj onSnapshot() , aby zarejestrować detektor wszelkich zmian w dokumencie koszyka. onSnapshot() zwraca funkcję, którą możesz wywołać, aby wyrejestrować słuchacza.

Do tego testu dodaj dwa elementy, które razem kosztują 9,98 USD. Następnie sprawdź, czy koszyk ma oczekiwaną itemCount i totalPrice . Jeśli tak, to funkcja spełniła swoje zadanie.

it("should sum the cost of their items", (done) => {
    const db = firebase
        .initializeAdminApp({ projectId: REAL_FIREBASE_PROJECT_ID })
        .firestore();

    // Setup: Initialize cart
    const aliceCartRef = db.doc("carts/alice")
    aliceCartRef.set({ ownerUID: "alice", totalPrice: 0 });

    //  Trigger calculateCart by adding items to the cart
    const aliceItemsRef = aliceCartRef.collection("items");
    aliceItemsRef.doc("doc1").set({name: "nectarine", price: 2.99});
    aliceItemsRef.doc("doc2").set({ name: "grapefruit", price: 6.99 });
    
    // Listen for every update to the cart. Every time an item is added to
    // the cart's subcollection of items, the function updates `totalPrice`
    // and `itemCount` attributes on the cart.
    // Returns a function that can be called to unsubscribe the listener.
    await new Promise((resolve) => {
      const unsubscribe = aliceCartRef.onSnapshot(snap => {
        // If the function worked, these will be cart's final attributes.
        const expectedCount = 2;
        const expectedTotal = 9.98;
  
        // When the `itemCount`and `totalPrice` match the expectations for the
        // two items added, the promise resolves, and the test passes.
        if (snap.data().itemCount === expectedCount && snap.data().totalPrice == expectedTotal) {
          // Call the function returned by `onSnapshot` to unsubscribe from updates
          unsubscribe();
          resolve();
        };
      });
    });
   });
 });

17. Uruchom testy

Możesz nadal mieć uruchomione emulatory z poprzednich testów. Jeśli nie, uruchom emulatory. Z wiersza poleceń uruchom

$ firebase emulators:start --import=./seed

Otwórz nową zakładkę terminala (pozostaw uruchomione emulatory) i przejdź do katalogu funkcji. Możesz nadal mieć to otwarte z testów reguł bezpieczeństwa.

$ cd functions

Teraz uruchom testy jednostkowe, powinieneś zobaczyć 5 wszystkich testów:

$ npm test

> functions@ test .../emulators-codelab/codelab-initial-state/functions
> mocha

  shopping cart creation
    ✓ can be created by the cart owner (82ms)

  shopping cart reads, updates, and deletes
    ✓ cart can be read by the cart owner (42ms)

  shopping cart items
    ✓ items can be read by the cart owner (40ms)
    ✓ items can be added by the cart owner

  adding an item to the cart recalculates the cart total. 
    1) should sum the cost of their items

  4 passing (2s)
  1 failing

Jeśli spojrzysz na konkretną awarię, wydaje się, że jest to błąd przekroczenia limitu czasu. Dzieje się tak, ponieważ test czeka na poprawną aktualizację funkcji, ale nigdy tak się nie dzieje. Teraz jesteśmy gotowi do napisania funkcji, która spełni test.

18. Napisz funkcję

Aby naprawić ten test, musisz zaktualizować funkcję w functions/index.js . Chociaż część tej funkcji jest napisana, nie jest kompletna. Tak obecnie wygląda funkcja:

// Recalculates the total cost of a cart; triggered when there's a change
// to any items in a cart.
exports.calculateCart = functions
    .firestore.document("carts/{cartId}/items/{itemId}")
    .onWrite(async (change, context) => {
      console.log(`onWrite: ${change.after.ref.path}`);
      if (!change.after.exists) {
        // Ignore deletes
        return;
      }

      let totalPrice = 125.98;
      let itemCount = 8;
      try {
        
        const cartRef = db.collection("carts").doc(context.params.cartId);

        await cartRef.update({
          totalPrice,
          itemCount
        });
      } catch(err) {
      }
    });

Funkcja poprawnie ustawia odwołanie do koszyka, ale zamiast obliczać wartości totalPrice i itemCount , aktualizuje je do wartości zakodowanych na sztywno.

Pobierz i przeprowadź iterację

podkolekcja items

Zainicjuj nową stałą itemsSnap , która ma być podkolekcji items . Następnie przejrzyj wszystkie dokumenty w kolekcji.

// Recalculates the total cost of a cart; triggered when there's a change
// to any items in a cart.
exports.calculateCart = functions
    .firestore.document("carts/{cartId}/items/{itemId}")
    .onWrite(async (change, context) => {
      console.log(`onWrite: ${change.after.ref.path}`);
      if (!change.after.exists) {
        // Ignore deletes
        return;
      }


      try {
        let totalPrice = 125.98;
        let itemCount = 8;

        const cartRef = db.collection("carts").doc(context.params.cartId);
        // ADD LINES FROM HERE
        const itemsSnap = await cartRef.collection("items").get();

        itemsSnap.docs.forEach(item => {
          const itemData = item.data();
        })
        // TO HERE
       
        return cartRef.update({
          totalPrice,
          itemCount
        });
      } catch(err) {
      }
    });

Oblicz całkowitą cenę i liczbę sztuk

Najpierw zainicjujmy wartości totalPrice i itemCount na zero.

Następnie dodaj logikę do naszego bloku iteracji. Najpierw sprawdź, czy przedmiot ma cenę. Jeśli element nie ma określonej ilości, niech domyślnie wynosi 1 . Następnie dodaj ilość do sumy bieżącej itemCount . Na koniec dodaj cenę towaru pomnożoną przez ilość do sumy bieżącej totalPrice :

// Recalculates the total cost of a cart; triggered when there's a change
// to any items in a cart.
exports.calculateCart = functions
    .firestore.document("carts/{cartId}/items/{itemId}")
    .onWrite(async (change, context) => {
      console.log(`onWrite: ${change.after.ref.path}`);
      if (!change.after.exists) {
        // Ignore deletes
        return;
      }

      try {
        // CHANGE THESE LINES
        let totalPrice = 0;
        let itemCount = 0;

        const cartRef = db.collection("carts").doc(context.params.cartId);
        const itemsSnap = await cartRef.collection("items").get();

        itemsSnap.docs.forEach(item => {
          const itemData = item.data();
          // ADD LINES FROM HERE
          if (itemData.price) {
            // If not specified, the quantity is 1
            const quantity = itemData.quantity ? itemData.quantity : 1;
            itemCount += quantity;
            totalPrice += (itemData.price * quantity);
          }
          // TO HERE
        })

        await cartRef.update({
          totalPrice,
          itemCount
        });
      } catch(err) {
      }
    });

Możesz również dodać rejestrowanie, aby ułatwić debugowanie stanów powodzenia i błędów:

// Recalculates the total cost of a cart; triggered when there's a change
// to any items in a cart.
exports.calculateCart = functions
    .firestore.document("carts/{cartId}/items/{itemId}")
    .onWrite(async (change, context) => {
      console.log(`onWrite: ${change.after.ref.path}`);
      if (!change.after.exists) {
        // Ignore deletes
        return;
      }

      let totalPrice = 0;
      let itemCount = 0;
      try {
        const cartRef = db.collection("carts").doc(context.params.cartId);
        const itemsSnap = await cartRef.collection("items").get();

        itemsSnap.docs.forEach(item => {
          const itemData = item.data();
          if (itemData.price) {
            // If not specified, the quantity is 1
            const quantity = (itemData.quantity) ? itemData.quantity : 1;
            itemCount += quantity;
            totalPrice += (itemData.price * quantity);
          }
        });

        await cartRef.update({
          totalPrice,
          itemCount
        });

        // OPTIONAL LOGGING HERE
        console.log("Cart total successfully recalculated: ", totalPrice);
      } catch(err) {
        // OPTIONAL LOGGING HERE
        console.warn("update error", err);
      }
    });

19. Powtórz testy

W wierszu poleceń upewnij się, że emulatory nadal działają i ponownie uruchom testy. Nie musisz ponownie uruchamiać emulatorów, ponieważ automatycznie wychwytują zmiany w funkcjach. Powinieneś zobaczyć, jak wszystkie testy przeszły pomyślnie:

$ npm test
> functions@ test .../emulators-codelab/codelab-initial-state/functions
> mocha

  shopping cart creation
    ✓ can be created by the cart owner (306ms)

  shopping cart reads, updates, and deletes
    ✓ cart can be read by the cart owner (59ms)

  shopping cart items
    ✓ items can be read by the cart owner
    ✓ items can be added by the cart owner

  adding an item to the cart recalculates the cart total. 
    ✓ should sum the cost of their items (800ms)


  5 passing (1s)

Dobra robota!

20. Wypróbuj za pomocą interfejsu użytkownika Storefront

W celu wykonania końcowego testu wróć do aplikacji internetowej ( http://localhost:5000/ ) i dodaj element do koszyka.

69ad26cee520bf24.png

Potwierdź, że koszyk zaktualizował się o prawidłową sumę. Fantastyczny!

Podsumowanie

Przeszedłeś przez złożony przypadek testowy między Cloud Functions dla Firebase a Cloud Firestore. Napisałeś funkcję Cloud Functions, aby test przeszedł pomyślnie. Potwierdziłeś również, że nowa funkcja działa w interfejsie użytkownika! Zrobiłeś to wszystko lokalnie, uruchamiając emulatory na własnym komputerze.

Utworzyłeś również klienta internetowego działającego z lokalnymi emulatorami, dostosowałeś reguły bezpieczeństwa w celu ochrony danych i przetestowałeś reguły bezpieczeństwa przy użyciu lokalnych emulatorów.

c6a7aeb91fe97a64.gif