Pengembangan Lokal dengan Firebase Emulator Suite

1. Sebelum Anda mulai

Alat backend tanpa server seperti Cloud Firestore dan Cloud Functions sangat mudah digunakan, tetapi mungkin sulit untuk diuji. Firebase Local Emulator Suite memungkinkan Anda menjalankan versi lokal dari layanan ini di mesin pengembangan sehingga Anda dapat mengembangkan aplikasi dengan cepat dan aman.

Prasyarat

• Editor sederhana seperti Visual Studio Code, Atom, atau Sublime Text
• Node.js 10.0.0 atau lebih tinggi (untuk menginstal Node.js, gunakan nvm , untuk memeriksa versi Anda, jalankan node --version )
• Java 7 atau lebih tinggi (untuk menginstal Java gunakan instruksi ini , untuk memeriksa versi Anda, jalankan java -version )

Apa yang akan Anda lakukan

Dalam codelab ini, Anda akan menjalankan dan men-debug aplikasi belanja online sederhana yang diberdayakan oleh beberapa layanan Firebase:

• Cloud Firestore: database NoSQL yang dapat diskalakan secara global, tanpa server, dengan kemampuan real-time.
• Cloud Functions : kode backend tanpa server yang berjalan sebagai respons terhadap peristiwa atau permintaan HTTP.
• Firebase Authentication : layanan autentikasi terkelola yang terintegrasi dengan produk Firebase lainnya.
• Firebase Hosting : hosting yang cepat dan aman untuk aplikasi web.

Anda akan menghubungkan aplikasi ke Emulator Suite untuk mengaktifkan pengembangan lokal.

Anda juga akan mempelajari cara:

• Cara menghubungkan aplikasi Anda ke Emulator Suite dan cara menghubungkan berbagai emulator.
• Cara kerja Aturan Keamanan Firebase dan cara menguji Aturan Keamanan Firestore terhadap emulator lokal.
• Cara menulis Fungsi Firebase yang dipicu oleh kejadian Firestore dan cara menulis pengujian integrasi yang dijalankan terhadap Emulator Suite.

2. Siapkan

Dapatkan kode sumber

Dalam codelab ini, Anda memulai dengan versi sampel The Fire Store yang hampir selesai, jadi hal pertama yang perlu Anda lakukan adalah menggandakan kode sumber:

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

Kemudian pindah ke direktori codelab, tempat Anda akan mengerjakan sisa codelab ini:

$ cd emulators-codelab/codelab-initial-state

Sekarang, instal dependensi sehingga Anda dapat menjalankan kodenya. Jika koneksi internet Anda lambat, ini mungkin memerlukan waktu satu atau dua menit:

# Move into the functions directory
$ cd functions

# Install dependencies
$ npm install

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

Dapatkan Firebase CLI

Emulator Suite adalah bagian dari Firebase CLI (antarmuka baris perintah) yang dapat dipasang di mesin Anda dengan perintah berikut:

$ npm install -g firebase-tools

Selanjutnya, konfirmasikan bahwa Anda memiliki CLI versi terbaru. Codelab ini seharusnya berfungsi dengan versi 9.0.0 atau lebih tinggi, tetapi versi yang lebih baru menyertakan lebih banyak perbaikan bug.

$ firebase --version
9.6.0

Hubungkan ke proyek Firebase Anda

Jika Anda tidak memiliki proyek Firebase, di konsol Firebase , buat proyek Firebase baru. Catat Project ID yang Anda pilih, Anda akan membutuhkannya nanti.

Sekarang kita perlu menghubungkan kode ini ke proyek Firebase Anda. Pertama jalankan perintah berikut untuk masuk ke Firebase CLI:

$ firebase login

Selanjutnya jalankan perintah berikut untuk membuat alias proyek. Ganti $YOUR_PROJECT_ID dengan ID project Firebase Anda.

$ firebase use $YOUR_PROJECT_ID

Sekarang Anda siap menjalankan aplikasi!

3. Jalankan emulator

Di bagian ini, Anda akan menjalankan aplikasi secara lokal. Ini berarti saatnya untuk mem-boot Emulator Suite.

Mulai Emulator

Dari dalam direktori sumber codelab, jalankan perintah berikut untuk memulai emulator:

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

Anda akan melihat beberapa output seperti ini:

$ 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://127.0.0.1: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://127.0.0.1:4000                │
└─────────────────────────────────────────────────────────────┘

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

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

Setelah Anda melihat pesan Semua emulator dimulai , aplikasi siap digunakan.

Hubungkan aplikasi web ke emulator

Berdasarkan tabel di log kita dapat melihat bahwa emulator Cloud Firestore mendengarkan pada port 8080 dan emulator Authentication mendengarkan pada port 9099 .

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

Mari hubungkan kode frontend Anda ke emulator, bukan ke produksi. Buka file public/js/homepage.js dan temukan fungsi onDocumentReady . Kita dapat melihat bahwa kode tersebut mengakses instance Firestore dan Auth standar:

public/js/homepage.js

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

Mari perbarui objek db dan auth agar mengarah ke emulator lokal:

public/js/homepage.js

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

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

Sekarang saat aplikasi berjalan di komputer lokal Anda (dilayani oleh emulator Hosting), klien Firestore juga mengarah ke emulator lokal, bukan ke database produksi.

Buka Emulator UI

Di browser web Anda, navigasikan ke http://127.0.0.1:4000/ . Anda akan melihat UI Emulator Suite.

Klik untuk melihat UI untuk Firestore Emulator. Kumpulan items sudah berisi data karena data diimpor dengan flag --import .

4. Jalankan aplikasi

Buka aplikasi

Di browser web Anda, navigasikan ke http://127.0.0.1:5000 dan Anda akan melihat The Fire Store berjalan secara lokal di mesin Anda!

Gunakan aplikasi

Pilih item di beranda dan klik Tambahkan ke Troli . Sayangnya, Anda akan mengalami kesalahan berikut:

Mari kita perbaiki bug itu! Karena semuanya berjalan di emulator, kita dapat bereksperimen dan tidak khawatir akan memengaruhi data nyata.

5. Debug aplikasi

Temukan bugnya

Ok mari kita lihat di konsol pengembang Chrome. Tekan Control+Shift+J (Windows, Linux, Chrome OS) atau Command+Option+J (Mac) untuk melihat kesalahan di konsol:

Sepertinya ada beberapa kesalahan dalam metode addToCart , mari kita lihat itu. Di mana kami mencoba mengakses sesuatu yang disebut uid dalam metode itu dan mengapa itu null ? Saat ini metodenya terlihat seperti ini di 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! Kami tidak masuk ke aplikasi. Menurut dokumen Firebase Authentication , saat kita tidak masuk, auth.currentUser adalah null . Mari tambahkan cek untuk itu:

public/js/homepage.js

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

    // ...
  }

Uji aplikasi

Sekarang, segarkan halaman lalu klik Tambahkan ke Troli . Anda harus mendapatkan kesalahan yang lebih bagus kali ini:

Tetapi jika Anda mengklik Masuk di bilah alat atas dan kemudian mengklik Tambahkan ke Keranjang lagi, Anda akan melihat bahwa keranjang diperbarui.

Namun, sepertinya angkanya tidak benar sama sekali:

Jangan khawatir, kami akan segera memperbaiki bug itu. Pertama, mari selami lebih dalam apa yang sebenarnya terjadi saat Anda menambahkan item ke keranjang Anda.

6. Pemicu fungsi lokal

Mengklik Tambahkan ke Troli memulai rangkaian peristiwa yang melibatkan banyak emulator. Di log Firebase CLI, Anda akan melihat pesan seperti berikut setelah menambahkan item ke keranjang:

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

Ada empat peristiwa penting yang terjadi untuk menghasilkan log tersebut dan pembaruan UI yang Anda amati:

1) Firestore Write - Klien

Dokumen baru ditambahkan ke koleksi Firestore /carts/{cartId}/items/{itemId}/ . Anda dapat melihat kode ini di fungsi addToCart di dalam 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) Fungsi Cloud Dipicu

Cloud Function calculateCart memproses setiap peristiwa tulis (buat, perbarui, atau hapus) yang terjadi pada item keranjang dengan menggunakan pemicu onWrite , yang dapat Anda lihat di functions/index.js :

fungsi/index.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) Tulis Firestore - Admin

Fungsi calculateCart membaca semua item dalam keranjang dan menambahkan jumlah total dan harga, lalu memperbarui dokumen "keranjang" dengan total baru (lihat cartRef.update(...) di atas).

4) Baca Firestore - Klien

Frontend web berlangganan untuk menerima pembaruan tentang perubahan pada keranjang. Itu mendapat pembaruan waktu nyata setelah Cloud Function menulis total baru dan memperbarui UI, seperti yang Anda lihat di public/js/homepage.js :

public/js/homepage.js

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

Rekap

Kerja bagus! Anda baru saja menyiapkan aplikasi lokal sepenuhnya yang menggunakan tiga emulator Firebase berbeda untuk pengujian lokal sepenuhnya.

Tapi tunggu, masih ada lagi! Di bagian selanjutnya Anda akan belajar:

• Cara menulis pengujian unit yang menggunakan Emulator Firebase.
• Cara menggunakan Emulator Firebase untuk men-debug Aturan Keamanan Anda.

7. Buat aturan keamanan yang disesuaikan untuk aplikasi Anda

Aplikasi web kami membaca dan menulis data, tetapi sejauh ini kami sama sekali tidak mengkhawatirkan keamanan. Cloud Firestore menggunakan sistem yang disebut "Aturan Keamanan" untuk mendeklarasikan siapa yang memiliki akses untuk membaca dan menulis data. Emulator Suite adalah cara yang bagus untuk membuat prototipe aturan ini.

Di editor, buka file emulators-codelab/codelab-initial-state/firestore.rules . Anda akan melihat bahwa kami memiliki tiga bagian utama dalam aturan kami:

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;
    }
  }
}

Saat ini siapa pun dapat membaca dan menulis data ke database kami! Kami ingin memastikan bahwa hanya operasi yang valid yang berhasil dan kami tidak membocorkan informasi sensitif apa pun.

Selama codelab ini, dengan mengikuti Prinsip Hak Istimewa Terkecil, kami akan mengunci semua dokumen dan menambahkan akses secara bertahap hingga semua pengguna memiliki semua akses yang mereka perlukan, tetapi tidak lebih. Mari perbarui dua aturan pertama untuk menolak akses dengan menyetel kondisi ke 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. Jalankan emulator dan tes

Mulai emulator

Pada command line, pastikan Anda berada di emulators-codelab/codelab-initial-state/ . Anda mungkin masih menjalankan emulator dari langkah sebelumnya. Jika tidak, mulai emulator lagi:

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

Setelah emulator berjalan, Anda dapat menjalankan pengujian secara lokal terhadapnya.

Jalankan tes

Pada baris perintah di tab terminal baru dari direktori emulators-codelab/codelab-initial-state/

Pertama pindah ke direktori fungsi (kita akan tetap di sini selama sisa codelab):

$ cd functions

Sekarang jalankan tes moka di direktori fungsi, dan gulir ke bagian atas output:

# 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

Saat ini kami memiliki empat kegagalan. Saat membuat file aturan, Anda dapat mengukur progres dengan melihat lebih banyak tes yang lulus.

9. Akses keranjang aman

Dua kegagalan pertama adalah pengujian "keranjang belanja" yang menguji bahwa:

• Pengguna hanya dapat membuat dan memperbarui keranjang mereka sendiri
• Pengguna hanya dapat membaca keranjang mereka sendiri

fungsi/tes.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());
  });

Mari kita buat tes ini lulus. Di editor, buka file aturan keamanan, firestore.rules , dan perbarui pernyataan di dalam match /carts/{cartID} :

firestore.rules

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;
    }

    // ...
  }
}

Aturan ini sekarang hanya mengizinkan akses baca dan tulis oleh pemilik keranjang.

Untuk memverifikasi data masuk dan autentikasi pengguna, kami menggunakan dua objek yang tersedia dalam konteks setiap aturan:

• Objek request berisi data dan metadata tentang operasi yang sedang dicoba.
• Jika proyek Firebase menggunakan Firebase Authentication , objek request.auth mendeskripsikan pengguna yang membuat permintaan.

10. Uji akses keranjang

Emulator Suite secara otomatis memperbarui aturan setiap kali firestore.rules disimpan. Anda dapat mengonfirmasi bahwa emulator telah memperbarui aturan dengan melihat di tab yang menjalankan emulator untuk pesan Rules updated :

Jalankan ulang pengujian, dan periksa apakah dua pengujian pertama sekarang lulus:

$ 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

Kerja bagus! Anda sekarang telah mengamankan akses ke keranjang belanja. Mari beralih ke tes gagal berikutnya.

11. Periksa alur "Tambahkan ke Troli" di UI

Saat ini, meskipun pemilik keranjang membaca dan menulis ke keranjang mereka, mereka tidak dapat membaca atau menulis item satu per satu di keranjang mereka. Itu karena meskipun pemilik memiliki akses ke dokumen keranjang, mereka tidak memiliki akses ke subkoleksi item keranjang.

Ini adalah keadaan rusak bagi pengguna.

Kembali ke UI web, yang berjalan di http://127.0.0.1:5000, dan coba tambahkan sesuatu ke keranjang Anda. Anda mendapatkan kesalahan Permission Denied , terlihat dari konsol debug, karena kami belum memberi pengguna akses ke dokumen yang dibuat di subkoleksi items .

12. Izinkan akses item keranjang

Kedua pengujian ini memastikan bahwa pengguna hanya dapat menambahkan item ke atau membaca item dari keranjangnya sendiri:

  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
    }));
  });

Jadi kita dapat menulis aturan yang mengizinkan akses jika pengguna saat ini memiliki UID yang sama dengan pemilikUID pada dokumen keranjang. Karena tidak perlu menentukan aturan berbeda untuk create, update, delete , Anda bisa menggunakan aturan write , yang berlaku untuk semua permintaan yang mengubah data.

Perbarui aturan untuk dokumen di subkoleksi item. Kondisi yang get sedang membaca nilai dari Firestore–dalam hal ini, ownerUID pada dokumen keranjang.

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. Uji akses item keranjang

Sekarang kita dapat menjalankan kembali tes. Gulir ke bagian atas output dan periksa apakah lebih banyak tes lulus:

$ 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

Bagus! Sekarang semua tes kami lulus. Kami memiliki satu tes yang tertunda, tetapi kami akan membahasnya dalam beberapa langkah.

14. Periksa lagi alur "add to cart".

Kembali ke ujung depan web ( http://127.0.0.1:5000 ) dan tambahkan item ke troli. Ini adalah langkah penting untuk mengonfirmasi bahwa pengujian dan aturan kami cocok dengan fungsionalitas yang diperlukan oleh klien. (Ingat bahwa terakhir kali kami mencoba pengguna UI tidak dapat menambahkan item ke troli mereka!)

Klien secara otomatis memuat ulang aturan saat firestore.rules disimpan. Jadi, coba tambahkan sesuatu ke troli.

Rekap

Kerja bagus! Anda baru saja meningkatkan keamanan aplikasi Anda, sebuah langkah penting untuk menyiapkannya untuk produksi! Jika ini adalah aplikasi produksi, kami dapat menambahkan pengujian ini ke alur integrasi berkelanjutan kami. Ini akan memberi kami kepercayaan diri bahwa data keranjang belanja kami akan memiliki kontrol akses ini, bahkan jika orang lain mengubah aturan.

Tapi tunggu, masih ada lagi!

jika Anda melanjutkan, Anda akan belajar:

• Cara menulis fungsi yang dipicu oleh peristiwa Firestore
• Cara membuat pengujian yang berfungsi di beberapa emulator

15. Siapkan pengujian Cloud Functions

Sejauh ini kami berfokus pada frontend aplikasi web kami dan Aturan Keamanan Firestore. Namun aplikasi ini juga menggunakan Cloud Functions untuk menjaga keranjang pengguna tetap terbarui, jadi kami juga ingin menguji kode tersebut.

Emulator Suite memudahkan pengujian Cloud Functions, bahkan fungsi yang menggunakan Cloud Firestore dan layanan lainnya.

Di editor, buka file emulators-codelab/codelab-initial-state/functions/test.js dan scroll ke pengujian terakhir dalam file. Saat ini, itu ditandai sebagai tertunda:

//  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 () => {
    ...
  });
});

Untuk mengaktifkan pengujian, hapus .skip , sehingga terlihat seperti ini:

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

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

Selanjutnya, temukan variabel REAL_FIREBASE_PROJECT_ID di bagian atas file dan ubah ke ID Proyek Firebase asli Anda.:

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

Jika lupa ID proyek, Anda dapat menemukan ID Proyek Firebase di Pengaturan Proyek di Konsol Firebase:

16. Jalani tes Fungsi

Karena pengujian ini memvalidasi interaksi antara Cloud Firestore dan Cloud Functions, pengujian ini melibatkan lebih banyak penyiapan daripada pengujian di codelab sebelumnya. Mari kita jalani tes ini dan dapatkan gambaran tentang apa yang diharapkan.

Buat gerobak

Cloud Functions berjalan di lingkungan server tepercaya dan dapat menggunakan autentikasi akun layanan yang digunakan oleh Admin SDK . Pertama, Anda menginisialisasi aplikasi menggunakan initializeAdminApp alih-alih initializeApp . Kemudian, Anda membuat DocumentReference untuk keranjang yang akan kami tambahkan item dan menginisialisasi keranjang:

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 });

    ...
  });

Memicu fungsi

Kemudian, tambahkan dokumen ke subkoleksi items dari dokumen keranjang kami untuk memicu fungsi tersebut. Tambahkan dua item untuk memastikan Anda menguji penambahan yang terjadi di fungsi.

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 });

    ...
    });
  });

Tetapkan ekspektasi pengujian

Gunakan onSnapshot() untuk mendaftarkan pemroses untuk setiap perubahan pada dokumen keranjang. onSnapshot() mengembalikan fungsi yang dapat Anda panggil untuk membatalkan pendaftaran pendengar.

Untuk tes ini, tambahkan dua item yang harganya $9,98. Kemudian, periksa apakah keranjang memiliki itemCount dan totalPrice yang diharapkan. Jika demikian, maka fungsinya melakukan tugasnya.

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. Jalankan pengujian

Anda mungkin masih menjalankan emulator dari pengujian sebelumnya. Jika tidak, mulai emulator. Dari baris perintah, jalankan

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

Buka tab terminal baru (biarkan emulator berjalan) dan pindah ke direktori fungsi. Anda mungkin masih membuka ini dari tes aturan keamanan.

$ cd functions

Sekarang jalankan tes unit, Anda akan melihat 5 tes total:

$ 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

Jika Anda melihat kegagalan tertentu, tampaknya itu adalah kesalahan waktu habis. Ini karena pengujian sedang menunggu fungsi diperbarui dengan benar, tetapi tidak pernah. Sekarang, kami siap menulis fungsi untuk memenuhi pengujian.

18. Tulis sebuah fungsi

Untuk memperbaiki pengujian ini, Anda perlu memperbarui fungsi di functions/index.js . Meskipun beberapa dari fungsi ini ditulis, itu tidak lengkap. Beginilah tampilan fungsi saat ini:

// 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) {
      }
    });

Fungsi ini menyetel referensi keranjang dengan benar, tetapi alih-alih menghitung nilai totalPrice dan itemCount , fungsi ini memperbaruinya menjadi yang di-hardcode.

Ambil dan ulangi melalui

subkoleksi items

Inisialisasi konstanta baru, itemsSnap , untuk menjadi subkoleksi items . Kemudian, ulangi semua dokumen dalam koleksi.

// 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) {
      }
    });

Hitung total Harga dan jumlah barang

Pertama, mari kita inisialisasi nilai totalPrice dan itemCount ke nol.

Kemudian, tambahkan logika ke blok iterasi kita. Pertama, periksa apakah item tersebut memiliki harga. Jika item tidak memiliki jumlah yang ditentukan, biarkan defaultnya menjadi 1 . Kemudian, tambahkan kuantitas ke total berjalan dari itemCount . Terakhir, tambahkan harga item dikalikan dengan kuantitas ke total totalPrice berjalan:

// 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) {
      }
    });

Anda juga dapat menambahkan logging untuk membantu keberhasilan debug dan status kesalahan:

// 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. Jalankan kembali tes

Pada baris perintah, pastikan emulator masih berjalan dan jalankan kembali pengujian. Anda tidak perlu memulai ulang emulator karena mereka mengambil perubahan fungsi secara otomatis. Anda akan melihat semua tes lulus:

$ 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)

Kerja bagus!

20. Cobalah menggunakan Storefront UI

Untuk tes terakhir, kembali ke aplikasi web ( http://127.0.0.1:5000/ ) dan tambahkan item ke keranjang.

Konfirmasikan bahwa keranjang diperbarui dengan total yang benar. Fantastis!

Rekap

Anda telah melewati kasus pengujian yang kompleks antara Cloud Functions for Firebase dan Cloud Firestore. Anda menulis Cloud Function untuk lulus ujian. Anda juga mengonfirmasi bahwa fungsi baru berfungsi di UI! Anda melakukan semua ini secara lokal, menjalankan emulator di mesin Anda sendiri.

Anda juga telah membuat klien web yang berjalan melawan emulator lokal, menyesuaikan aturan keamanan untuk melindungi data, dan menguji aturan keamanan menggunakan emulator lokal.