Pengembangan Lokal dengan Firebase Emulator Suite

1. Sebelum Anda mulai

Alat backend tanpa server seperti Cloud Firestore dan Cloud Functions sangat mudah digunakan, tetapi bisa jadi sulit untuk diuji. Firebase Local Emulator Suite memungkinkan Anda menjalankan versi lokal 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, penggunaan nvm , untuk memeriksa versi Anda, jalankan node --version )
  • Java 7 atau lebih tinggi (untuk menginstal Java menggunakan petunjuk ini , untuk memeriksa versi Anda, jalankan java -version )

Apa yang akan kamu lakukan?

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

  • Cloud Firestore: a global scalable, serverless, basis data NoSQL dengan kemampuan real-time.
  • Cloud Fungsi: kode backend serverless yang berjalan dalam menanggapi peristiwa atau HTTP permintaan.
  • Firebase Authentication: layanan otentikasi dikelola yang terintegrasi dengan produk Firebase lainnya.
  • Firebase Hosting: cepat dan aman hosting untuk aplikasi web.

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

2589e2f95b74fa88.png

Anda juga akan belajar cara:

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

2. Siapkan

Dapatkan kode sumbernya

Di codelab ini, Anda memulai dengan versi sampel The Fire Store yang hampir selesai, jadi hal pertama yang perlu Anda lakukan adalah mengkloning 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 kode. Jika Anda menggunakan koneksi internet yang lebih lambat, ini mungkin memakan 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 diinstal pada mesin Anda dengan perintah berikut:

$ npm install -g firebase-tools

Selanjutnya, konfirmasikan bahwa Anda memiliki CLI versi terbaru. Codelab ini harus bekerja 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 Firebase konsol , membuat proyek Firebase baru. Catat ID Proyek 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 proyek 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 sudah waktunya 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://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.

Setelah Anda melihat Semua emulator mulai pesan, 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 adalah mendengarkan pada port 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                             │
└────────────────┴────────────────┴─────────────────────────────────┘

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

publik/js/beranda.js

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

Mari kita update db dan auth benda ke titik ke emulator lokal:

publik/js/beranda.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);
  }

Sekarang ketika aplikasi berjalan di localhost (dilayani oleh emulator Hosting), klien Firestore juga menunjuk ke emulator lokal daripada ke database produksi.

Buka EmulatorUI

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

Layar beranda Emulator UI

Klik untuk melihat UI untuk Firestore Emulator. The items koleksi yang sudah berisi data karena data yang diimpor dengan --import bendera.

4ef88d0148405d36.png

4. Jalankan aplikasi

Buka aplikasi

Di browser web Anda, navigasi ke http: // localhost: 5000 dan Anda akan melihat Api Toko berjalan secara lokal pada komputer Anda!

939f87946bac2ee4.png

Gunakan aplikasi

Memilih item pada homepage dan klik Add to Cart. Sayangnya, Anda akan mengalami kesalahan berikut:

a11bd59933a8e885.png

Mari kita perbaiki bug itu! Karena semuanya berjalan di emulator, kami 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 pada konsol:

74c45df55291dab1.png

Sepertinya ada beberapa kesalahan dalam addToCart metode, mari kita lihat itu. Di mana kita mencoba mengakses sesuatu yang disebut uid dalam metode itu dan mengapa itu akan menjadi null ? Sekarang metode terlihat seperti ini di public/js/homepage.js :

publik/js/beranda.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);
  }

Ah! Kami tidak masuk ke aplikasi. Menurut dokumentasi Firebase Authentication , ketika kita tidak masuk, auth.currentUser adalah null . Mari tambahkan tanda centang untuk itu:

publik/js/beranda.js

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

    // ...
  }

Uji aplikasi

Sekarang, refresh halaman dan kemudian klik Add to Cart. Anda harus mendapatkan kesalahan yang lebih baik kali ini:

c65f6c05588133f7.png

Tetapi jika Anda mengklik Masuk di toolbar atas dan kemudian klik Add to Cart lagi, Anda akan melihat bahwa gerobak diperbarui.

Namun, sepertinya jumlahnya tidak benar sama sekali:

239f26f02f959eef.png

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

6. Pemicu fungsi lokal

Mengklik Add untuk tendangan Cart off rantai peristiwa yang melibatkan beberapa emulator. Di log Firebase CLI, Anda akan melihat sesuatu seperti pesan berikut setelah Anda menambahkan item ke keranjang Anda:

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:

68c9323f2ad10f7a.png

1) Firestore Write - Klien

Sebuah dokumen baru ditambahkan ke koleksi Firestore /carts/{cartId}/items/{itemId}/ . Anda dapat melihat kode ini di addToCart fungsi dalam public/js/homepage.js :

publik/js/beranda.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

The Cloud Fungsi calculateCart mendengarkan untuk setiap menulis peristiwa (membuat, memperbarui, atau menghapus) yang terjadi pada item keranjang dengan menggunakan onWrite pemicu, 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) Firestore Write - Admin

The calculateCart fungsi membaca semua item dalam keranjang dan menambahkan sampai total kuantitas dan harga, maka update "keranjang" dokumen dengan total baru (lihat cartRef.update(...) di atas).

4) Baca Firestore - Klien

Frontend web berlangganan untuk menerima pembaruan tentang perubahan pada troli. Ia mendapat update real-time setelah Fungsi Cloud menulis jumlah baru dan update UI, seperti yang Anda lihat di public/js/homepage.js :

publik/js/beranda.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.

db82eef1706c9058.gif

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

  • Cara menulis pengujian unit yang menggunakan Firebase Emulator.
  • Cara menggunakan Firebase Emulator 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 tidak terlalu mengkhawatirkan keamanan sama sekali. Cloud Firestore menggunakan sistem yang disebut "Aturan Keamanan" untuk menyatakan siapa yang memiliki akses untuk membaca dan menulis data. Emulator Suite adalah cara yang bagus untuk membuat prototipe aturan ini.

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

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

Selama codelab ini, mengikuti Prinsip Privilege Terkecil, kami akan mengunci semua dokumen dan secara bertahap menambahkan akses hingga semua pengguna memiliki semua akses yang mereka butuhkan, tetapi tidak lebih. Pembaruan Mari dua aturan pertama untuk menolak akses dengan menetapkan kondisi untuk 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 baris perintah, 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 terhadap emulator tersebut.

Jalankan tes

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

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

$ cd functions

Sekarang jalankan tes moka di direktori fungsi, dan gulir ke 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 Anda membuat file aturan, Anda dapat mengukur kemajuan dengan melihat lebih banyak tes lulus.

9. Akses keranjang yang aman

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

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

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

Mari kita membuat tes ini lulus. Dalam editor, buka file aturan keamanan, firestore.rules , dan memperbarui laporan 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 yang masuk dan otentikasi pengguna, kami menggunakan dua objek yang tersedia dalam konteks setiap aturan:

  • The request objek berisi data dan metadata tentang operasi yang sedang berusaha.
  • Jika proyek Firebase menggunakan Firebase Authentication , yang request.auth objek menggambarkan pengguna yang membuat permintaan tersebut.

10. Uji akses keranjang

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

5680da418b420226.png

Jalankan kembali tes, dan periksa apakah dua tes 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 yang baik! Anda sekarang telah mengamankan akses ke keranjang belanja. Mari kita beralih ke tes gagal berikutnya.

11. Periksa alur "Tambahkan ke Keranjang" 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 sementara pemilik memiliki akses ke dokumen keranjang, mereka tidak memiliki akses ke keranjang ini item subcollection.

Ini adalah keadaan rusak bagi pengguna.

Kembali ke web UI, yang berjalan pada http://localhost:5000, dan mencoba untuk menambahkan sesuatu ke keranjang Anda. Anda mendapatkan Permission Denied kesalahan, terlihat dari konsol debug, karena kita belum diberikan pengguna akses ke dokumen yang dibuat dalam items subcollection.

12. Izinkan akses item keranjang

Kedua tes ini mengkonfirmasi bahwa pengguna hanya dapat menambahkan item ke atau membaca item dari keranjang mereka 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 bisa menulis aturan yang mengizinkan akses jika pengguna saat ini memiliki UID yang sama dengan ownerUID pada dokumen cart. Karena tidak ada perlu menentukan aturan yang berbeda untuk create, update, delete , Anda dapat menggunakan write aturan yang berlaku untuk semua permintaan data memodifikasi.

Perbarui aturan untuk dokumen di subkoleksi item. The get di kondisional adalah 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. Akses item keranjang uji

Sekarang kita dapat menjalankan kembali tes. Gulir ke 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 menyelesaikannya dalam beberapa langkah.

14. Periksa aliran "tambahkan ke troli" lagi

Kembali ke front end web ( http: // localhost: 5000 ) dan menambahkan item ke keranjang. Ini adalah langkah penting untuk mengonfirmasi bahwa pengujian dan aturan kami cocok dengan fungsionalitas yang dibutuhkan oleh klien. (Ingat bahwa terakhir kali kami mencoba pengguna UI tidak dapat menambahkan item ke keranjang mereka!)

69ad26cee520bf24.png

Klien secara otomatis ulang aturan ketika firestore.rules disimpan. Jadi, coba tambahkan sesuatu ke keranjang.

rekap

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

ba5440b193e75967.gif

Tapi tunggu, masih ada lagi!

jika Anda melanjutkan, Anda akan belajar:

  • Cara menulis fungsi yang dipicu oleh acara Firestore
  • Cara membuat tes yang berfungsi di beberapa emulator

15. Siapkan pengujian Cloud Functions

Sejauh ini kami telah berfokus pada frontend aplikasi web kami dan Aturan Keamanan Firestore. Tetapi aplikasi ini juga menggunakan Cloud Functions untuk menjaga agar keranjang pengguna tetap up to date, jadi kami ingin menguji kode itu juga.

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

Dalam editor, buka emulators-codelab/codelab-initial-state/functions/test.js berkas dan gulir untuk tes 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 tes, menghapus .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 () => {
    ...
  });
});

Berikutnya, menemukan REAL_FIREBASE_PROJECT_ID variabel di atas file dan mengubahnya ke nyata Firebase Proyek ID Anda .:

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

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

d6d0429b700d2b21.png

16. Ikuti 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 diharapkannya.

Buat keranjang

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

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 items subcollection dokumen cart kami untuk memicu fungsi. 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 harapan pengujian

Gunakan onSnapshot() untuk mendaftarkan pendengar untuk setiap perubahan pada dokumen keranjang. onSnapshot() mengembalikan fungsi yang Anda dapat menghubungi untuk unregister pendengar.

Untuk tes ini, tambahkan dua item yang bersama-sama berharga $9,98. Kemudian, memeriksa apakah keranjang memiliki diharapkan itemCount dan totalPrice . Jika demikian, maka fungsi 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 tes

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 (meninggalkan 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 spesifik, tampaknya itu adalah kesalahan batas waktu. Ini karena tes menunggu fungsi diperbarui dengan benar, tetapi tidak pernah melakukannya. Sekarang, kita siap untuk menulis fungsi untuk memenuhi pengujian.

18. Tulis fungsi

Untuk memperbaiki tes ini, Anda perlu memperbarui fungsi di functions/index.js . Meskipun beberapa dari fungsi ini ditulis, itu tidak lengkap. Beginilah tampilan fungsinya 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 benar menetapkan referensi keranjang, tapi kemudian bukannya menghitung nilai-nilai totalPrice dan itemCount , itu update mereka untuk orang-orang hardcoded.

Ambil dan ulangi melalui

items subcollection

Menginisialisasi sebuah konstanta baru, itemsSnap , menjadi items subcollection. 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 totalHarga dan jumlah item

Pertama, mari kita menginisialisasi nilai-nilai totalPrice dan itemCount ke nol.

Kemudian, tambahkan logika ke blok iterasi kita. Pertama, periksa apakah barang tersebut memiliki harga. Jika item tidak telah kuantitas ditentukan, biarkan default ke 1 . Kemudian, tambahkan kuantitas total menjalankan itemCount . Akhirnya, menambahkan harga item dikalikan dengan jumlah total menjalankan 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) {
      }
    });

Anda juga dapat menambahkan logging untuk membantu men-debug status keberhasilan dan 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 ulang tes

Pada baris perintah, pastikan emulator masih berjalan dan jalankan kembali pengujian. Anda tidak perlu memulai ulang emulator karena emulator 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 yang baik!

20. Cobalah menggunakan UI Storefront

Untuk ujian akhir, kembali ke aplikasi web ( http: // localhost: 5000 / ) dan menambahkan item ke keranjang.

69ad26cee520bf24.png

Konfirmasikan bahwa keranjang diperbarui dengan jumlah yang benar. Fantastis!

rekap

Anda telah melewati kasus pengujian yang rumit antara Cloud Functions for Firebase dan Cloud Firestore. Anda menulis Cloud Function untuk membuat tes lulus. Anda juga mengonfirmasi bahwa fungsionalitas 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.

c6a7aeb91fe97a64.gif