Menjalankan fungsi secara lokal

Firebase CLI meliputi emulator Cloud Functions yang dapat mengemulasi jenis fungsi berikut:

  • Fungsi HTTPS
  • Fungsi yang dapat dipanggil
  • Fungsi Cloud Firestore

Anda dapat menjalankan fungsi secara lokal untuk mengujinya sebelum men-deploy ke produksi.

Menginstal Firebase CLI

Untuk menggunakan emulator Cloud Functions, terlebih dahulu instal Firebase CLI:

npm install -g firebase-tools

Untuk menggunakan emulator lokal, Cloud Functions Anda harus bergantung pada:

  • firebase-admin versi 8.0.0 atau lebih baru.
  • firebase-functions versi 3.0.0 atau lebih baru.

Menyiapkan kredensial admin (opsional)

Jika Anda ingin pengujian fungsi berinteraksi dengan Google API atau Firebase API lainnya melalui Firebase Admin SDK, Anda mungkin perlu menyiapkan kredensial admin.

  • Pemicu Cloud Firestore dan Realtime Database telah memiliki kredensial memadai, dan tidak memerlukan penyiapan tambahan.
  • Semua API lainnya, termasuk Firebase API seperti Authentication dan FCM, atau Google API seperti Cloud Translation atau Cloud Speech, memerlukan langkah penyiapan tambahan yang dijelaskan dalam bagian ini. Hal ini berlaku baik saat Anda menggunakan shell fungsi maupun firebase emulators:start.

Agar dapat menyiapkan kredensial admin untuk fungsi teremulasi:

  1. Buka panel Akun Layanan di Google Cloud Console.
  2. Pastikan akun layanan default App Engine dipilih, dan gunakan menu opsi di sebelah kanan untuk memilih Buat kunci.
  3. Saat diminta, pilih JSON untuk jenis kunci, lalu klik Buat.
  4. Atur agar kredensial default Google Anda mengarah ke kunci yang telah didownload:

    Unix

    $ export GOOGLE_APPLICATION_CREDENTIALS="path/to/key.json"
    
    $ firebase emulators:start
    

    Windows

    $ set GOOGLE_APPLICATION_CREDENTIALS=path\to\key.json
    
    $ firebase emulators:start
    

Setelah menyelesaikan langkah-langkah ini, pengujian fungsi Anda dapat mengakses Firebase API dan Google API menggunakan Admin SDK. Misalnya, saat menguji pemicu Authentication, fungsi yang diemulasi dapat memanggil admin.auth().getUserByEmail(email).

Menyiapkan konfigurasi fungsi (opsional)

Jika Anda menggunakan variabel konfigurasi fungsi kustom, jalankan perintah terlebih dahulu untuk mendapatkan konfigurasi kustom (jalankan ini dalam direktori functions) di lingkungan lokal Anda:

firebase functions:config:get > .runtimeconfig.json
# If using Windows PowerShell, replace the above with:
# firebase functions:config:get | ac .runtimeconfig.json
firebase functions:shell

Menjalankan emulator suite

Untuk menjalankan emulator Cloud Functions, gunakan perintah emulators:start:

firebase emulators:start

Perintah emulators:start akan memulai emulator untuk Cloud Functions, Cloud Firestore, Realtime Database, dan Firebase Hosting berdasarkan produk yang telah Anda inisialisasi dalam project lokal Anda menggunakan firebase init. Jika Anda ingin memulai emulator tertentu, gunakan flag --only:

firebase emulators:start --only functions

Jika Anda ingin menjalankan rangkaian pengujian atau skrip pengujian setelah emulator dimulai, gunakan perintah emulators:exec:

firebase emulators:exec "./my-test.sh"

Interaksi dengan layanan lain

Rangkaian emulator meliputi beberapa emulator yang memungkinkan pengujian interaksi lintas produk.

Cloud Firestore

Jika Anda memiliki Cloud Functions yang menggunakan Firebase Admin SDK untuk menulis ke Cloud Firestore, penulisan ini akan dikirim ke emulator Cloud Firestore jika sedang berjalan. Jika Cloud Functions selanjutnya dipicu oleh penulisan tersebut, maka penulisan akan dijalankan di emulator Cloud Functions.

Firebase Hosting

Jika Anda menggunakan Cloud Functions untuk membuat konten dinamis untuk Firebase Hosting, firebase emulators:start menggunakan fungsi HTTP lokal Anda sebagai proxy untuk hosting.

Logging

Emulator mengalirkan log dari fungsi ke jendela terminal tempat log tersebut dijalankan. Ini menampilkan semua output dari pernyataan console.log(), console.info(), console.error(), dan console.warn() dalam fungsi Anda.

Langkah Berikutnya

Untuk contoh lengkap penggunaan Firebase emulator suite, lihat contoh panduan memulai pengujian.