Chạy hàm cục bộ

Firebase CLI bao gồm một trình mô phỏng Cloud Functions có thể mô phỏng các loại hàm sau:

  • Các hàm HTTPS
  • Hàm có thể gọi
  • Các hàm nền được kích hoạt từ phương thức Xác thực Firebase, Cơ sở dữ liệu theo thời gian thực, Cloud Firestore, Cloud Storage và Cloud Pub/Sub.

Bạn có thể chạy các hàm cục bộ để kiểm thử trước khi triển khai chính thức.

Cài đặt Firebase CLI

Để sử dụng trình mô phỏng Cloud Functions, trước tiên, hãy cài đặt CLI của Firebase:

npm install -g firebase-tools

Để sử dụng trình mô phỏng cục bộ, Cloud Functions của bạn phải phụ thuộc vào:

  • firebase-admin phiên bản 8.0.0 trở lên.
  • firebase-functions phiên bản 3.0.0 trở lên.

Thiết lập thông tin đăng nhập của quản trị viên (không bắt buộc)

Nếu muốn các phép kiểm thử hàm của mình tương tác với API của Google hoặc các API khác của Firebase thông qua SDK quản trị của Firebase, bạn có thể cần thiết lập thông tin đăng nhập của quản trị viên.

  • Các điều kiện kích hoạt Cơ sở dữ liệu theo thời gian thực và Cloud Firestore đã có đủ thông tin đăng nhập và không yêu cầu thiết lập thêm.
  • Tất cả các API khác, kể cả các API của Firebase (chẳng hạn như API Xác thực và FCM) hoặc API của Google (chẳng hạn như Cloud Translation hoặc Cloud Speech) đều yêu cầu các bước thiết lập được mô tả trong phần này. Điều này áp dụng cho dù bạn đang sử dụng shell Cloud Functions hay firebase emulators:start.

Cách thiết lập thông tin đăng nhập của quản trị viên cho các chức năng được mô phỏng:

  1. Mở ngăn Tài khoản dịch vụ trên bảng điều khiển Google Cloud.
  2. Hãy nhớ chọn App Engine mặc định tài khoản dịch vụ và sử dụng trình đơn tuỳ chọn ở bên phải để chọn Create key (Tạo khoá).
  3. Khi được nhắc, hãy chọn JSON cho loại khoá rồi nhấp vào Tạo.

  4. Đặt thông tin xác thực mặc định trên Google của bạn để trỏ đến khoá đã tải xuống:

    Unix

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

    Windows

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

Sau khi hoàn tất các bước này, các hoạt động kiểm thử chức năng của bạn có thể truy cập vào các API của Firebase và Google bằng cách sử dụng SDK dành cho quản trị viên. Ví dụ: khi kiểm thử một điều kiện kích hoạt Xác thực, chức năng được mô phỏng có thể gọi admin.auth().getUserByEmail(email).

Thiết lập cấu hình hàm (không bắt buộc)

Nếu bạn đang sử dụng các biến cấu hình của hàm tuỳ chỉnh, trước tiên, hãy chạy lệnh để lấy cấu hình tuỳ chỉnh của bạn (chạy lệnh này trong thư mục functions) trong môi trường cục bộ của bạn:

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

Chạy bộ trình mô phỏng

Để chạy trình mô phỏng Cloud Functions, hãy sử dụng lệnh emulators:start:

firebase emulators:start

Lệnh emulators:start sẽ khởi động trình mô phỏng cho Cloud Functions, Cloud Firestore, Cơ sở dữ liệu theo thời gian thực và tính năng Lưu trữ Firebase dựa trên các sản phẩm mà bạn đã khởi chạy trong dự án cục bộ bằng firebase init. Nếu bạn muốn khởi động một trình mô phỏng cụ thể, hãy sử dụng cờ --only:

firebase emulators:start --only functions

Nếu bạn muốn chạy một bộ kiểm thử hoặc tập lệnh kiểm thử sau khi trình mô phỏng khởi động, hãy dùng lệnh emulators:exec:

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

Đo lường ứng dụng của bạn để trò chuyện với trình mô phỏng

Để đo lường ứng dụng của bạn tương tác với trình mô phỏng, có thể bạn cần thực hiện thêm một số cấu hình.

Đo lường ứng dụng cho các hàm có thể gọi

Nếu hoạt động thử nghiệm và nguyên mẫu của bạn liên quan đến các hàm phụ trợ có thể gọi, hãy định cấu hình hoạt động tương tác với trình mô phỏng Cloud Functions cho Firebase như sau:

Kotlin+KTX
// 10.0.2.2 is the special IP address to connect to the 'localhost' of
// the host computer from an Android emulator.
val functions = Firebase.functions
functions.useEmulator("10.0.2.2", 5001)
MainActivity.kt
Java
// 10.0.2.2 is the special IP address to connect to the 'localhost' of
// the host computer from an Android emulator.
FirebaseFunctions functions = FirebaseFunctions.getInstance();
functions.useEmulator("10.0.2.2", 5001);
MainActivity.java
Swift
Functions.functions().useFunctionsEmulator(origin: "http://127.0.0.1:5001")
ViewController.swift

Web

import { getApp } from "firebase/app";
import { getFunctions, connectFunctionsEmulator } from "firebase/functions";

const functions = getFunctions(getApp());
connectFunctionsEmulator(functions, "127.0.0.1", 5001);
fb_functions_emulator_connect.js

Web

firebase.functions().useEmulator("127.0.0.1", 5001);
emulator-suite.js

Đo lường ứng dụng của bạn để mô phỏng các hàm HTTPS

Mỗi hàm HTTPS trong mã của bạn sẽ được phân phát từ trình mô phỏng cục bộ bằng cách sử dụng định dạng URL sau:

http://$HOST:$PORT/$PROJECT/$REGION/$NAME

Ví dụ: một hàm helloWorld đơn giản có cổng và khu vực máy chủ lưu trữ mặc định sẽ được phân phát tại:

https://localhost:5001/$PROJECT/us-central1/helloWorld

Đo lường ứng dụng của bạn để mô phỏng các hàm được kích hoạt ở chế độ nền

Trình mô phỏng Cloud Functions hỗ trợ các hàm được kích hoạt trong nền từ những nguồn sau:

  • Trình mô phỏng Cơ sở dữ liệu theo thời gian thực
  • Trình mô phỏng Cloud Firestore
  • Trình mô phỏng xác thực
  • Trình mô phỏng Pub/Sub

Để kích hoạt các sự kiện trong nền, hãy sửa đổi tài nguyên phụ trợ bằng cách sử dụng giao diện người dùng của Bộ mô phỏng hoặc bằng cách kết nối ứng dụng/mã kiểm thử của bạn với trình mô phỏng thông qua SDK cho nền tảng của bạn.

Trình xử lý kiểm thử cho các sự kiện tuỳ chỉnh do Tiện ích tạo ra

Đối với các hàm bạn triển khai để xử lý sự kiện tuỳ chỉnh của Tiện ích Firebase bằng Cloud Functions phiên bản 2, trình mô phỏng Cloud Functions sẽ ghép nối với trình mô phỏng Eventarc để hỗ trợ điều kiện kích hoạt Eventarc.

Để kiểm thử trình xử lý sự kiện tuỳ chỉnh cho các tiện ích phát ra sự kiện, bạn phải cài đặt trình mô phỏng Chức năng đám mây và Eventarc.

Môi trường thời gian chạy Cloud Functions đặt biến môi trường EVENTARC_EMULATOR thành localhost:9299 trong quy trình hiện tại nếu trình mô phỏng Eventarc đang chạy. SDK quản trị của Firebase tự động kết nối với trình mô phỏng Eventarc khi biến môi trường EVENTARC_EMULATOR được đặt. Bạn có thể sửa đổi cổng mặc định như thảo luận trong phần Định cấu hình bộ trình mô phỏng cục bộ.

Khi các biến môi trường được định cấu hình đúng cách, SDK quản trị của Firebase sẽ tự động gửi các sự kiện đến trình mô phỏng Eventarc. Đổi lại, trình mô phỏng Eventarc sẽ thực hiện lệnh gọi lại trình mô phỏng Cloud Functions để kích hoạt mọi trình xử lý đã đăng ký.

Bạn có thể kiểm tra nhật ký Hàm trong giao diện người dùng Bộ mô phỏng để biết thông tin chi tiết về quá trình thực thi trình xử lý.

Hoạt động tương tác với các dịch vụ khác

Bộ trình mô phỏng bao gồm nhiều trình mô phỏng, cho phép kiểm thử các hoạt động tương tác giữa nhiều sản phẩm.

Cloud Firestore

Nếu bạn có các hàm sử dụng SDK quản trị Firebase để ghi vào Cloud Firestore, thì các lượt ghi này sẽ được gửi đến trình mô phỏng Cloud Firestore nếu trình mô phỏng này đang chạy. Nếu các lượt ghi đó kích hoạt thêm các hàm khác, thì các hàm đó sẽ được chạy trong trình mô phỏng Cloud Functions.

Cloud Storage

Nếu bạn có các hàm sử dụng SDK quản trị của Firebase (phiên bản 9.7.0 trở lên) để ghi vào Cloud Storage, thì các lượt ghi này sẽ được gửi đến trình mô phỏng Cloud Storage nếu trình mô phỏng đó đang chạy. Nếu các lượt ghi đó kích hoạt thêm các hàm khác, thì các hàm đó sẽ được chạy trong trình mô phỏng Cloud Functions.

Xác thực Firebase

Nếu bạn có các hàm sử dụng SDK quản trị Firebase (phiên bản 9.3.0 trở lên) để ghi vào phương thức Xác thực Firebase, thì các lượt ghi này sẽ được gửi đến Trình mô phỏng xác thực nếu trình mô phỏng này đang chạy. Nếu các lượt ghi đó kích hoạt thêm các hàm khác, thì các hàm đó sẽ được chạy trong trình mô phỏng Cloud Functions.

Lưu trữ Firebase

Nếu bạn đang dùng Cloud Functions để tạo nội dung động cho tính năng Lưu trữ Firebase, thì firebase emulators:start sẽ sử dụng các hàm HTTP cục bộ làm proxy để lưu trữ.

Logging

Trình mô phỏng truyền nhật ký từ các hàm của bạn sang cửa sổ dòng lệnh nơi các hàm đó chạy. Phần này cho thấy tất cả kết quả từ câu lệnh console.log(), console.info(), console.error() và console.warn() bên trong các hàm của bạn.

Các bước tiếp theo

Để biết ví dụ đầy đủ về cách sử dụng bộ trình mô phỏng Firebase, hãy xem mẫu bắt đầu nhanh kiểm thử.