Chạy các hàm trên máy

Giao diện dòng lệnh (CLI) của Firebase bao gồm một trình mô phỏng Cloud Functions có thể mô phỏng các loại hàm sau:

  • Hàm HTTPS
  • Hàm có thể gọi
  • Hàm hàng đợi tác vụ
  • Các hàm nền được kích hoạt từ Firebase Authentication, Realtime Database, Cloud Firestore, Cloud Storage, các cảnh báo được hỗ trợ của Firebase 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 Giao diện dòng lệnh (CLI) của Firebase

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

npm install -g firebase-tools

Để sử dụng trình mô phỏng cục bộ, Cloud Functions 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 chương trình kiểm thử hàm tương tác với API của Google hoặc các API Firebase khác thông qua SDK quản trị Firebase, bạn có thể cần thiết lập thông tin xác thực quản trị.

  • Trình kích hoạt Cloud Firestore và Realtime Database đã có đủ thông tin xác thực và không cần thiết lập thêm.
  • Tất cả các API khác, bao gồm cả API Firebase như Authentication và FCM hoặc API của Google 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 hàm được mô phỏng:

  1. Mở ngăn Tài khoản dịch vụ trên bảng điều khiển của Google Cloud.
  2. Đảm bảo bạn đã chọn App Engine tài khoản dịch vụ mặc định và sử dụng trình đơn tuỳ chọn ở bên phải để chọn 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 của Google để 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ử trình kích hoạt Authentication, hàm đượ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 hàm tuỳ chỉnh, trước tiên, hãy chạy lệnh để lấy cấu hình tuỳ chỉnh (chạy lệnh này trong thư mục functions) trong môi trường cục bộ:

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 thời gian thực và Firebase Hosting 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 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 sử dụng lệnh emulators:exec:

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

Đo lường ứng dụng để giao tiếp với trình mô phỏng

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

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

Nếu hoạt động kiểm thử 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 for 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 chức năng 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 định dạng URL sau:

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

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

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

Đo lường ứng dụng để mô phỏng các chức năng của hàng đợi tác vụ

Trình mô phỏng sẽ tự động thiết lập hàng đợi tác vụ được mô phỏng dựa trên định nghĩa trình kích hoạt và SDK quản trị sẽ định tuyến lại các yêu cầu đã đưa vào hàng đợi đến trình mô phỏng nếu phát hiện thấy trình mô phỏng đang chạy thông qua biến môi trường CLOUD_TASKS_EMULATOR_HOST.

Xin lưu ý rằng hệ thống điều phối dùng trong môi trường sản xuất phức tạp hơn hệ thống được triển khai trong trình mô phỏng. Vì vậy, bạn không nên mong đợi hành vi được mô phỏng phản ánh chính xác môi trường sản xuất. Các tham số trong trình mô phỏng cung cấp giới hạn trên cho tốc độ gửi và thử lại tác vụ.

Đ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 ở chế độ nền từ các nguồn sau:

  • Trình mô phỏng Realtime Database
  • Trình mô phỏng Cloud Firestore
  • Trình mô phỏng Authentication
  • Trình mô phỏng Pub/Sub
  • Trình mô phỏng cảnh báo Firebase

Để kích hoạt các sự kiện trong nền, hãy sửa đổi các tài nguyên phụ trợ bằng cách sử dụng Emulator Suite UI hoặc bằng cách kết nối ứng dụng hay mã kiểm thử của bạn với trình mô phỏng thông qua SDK dành 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 phát ra

Đối với các hàm mà bạn triển khai để xử lý sự kiện tuỳ chỉnh Firebase Extensions 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ợ trình 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 Cloud Functions và Eventarc.

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. Firebase Admin SDK sẽ tự động kết nối với trình mô phỏng Eventarc khi bạn đặt biến môi trường EVENTARC_EMULATOR. 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 Local Emulator Suite.

Khi các biến môi trường được định cấu hình đúng cách, Firebase Admin SDK 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ẽ 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 Emulator Suite UI để biết thông tin chi tiết về việc 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 trên 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 hoạt động ghi này sẽ được gửi đến trình mô phỏng Cloud Firestore nếu trình mô phỏng đó đang chạy. Nếu các hàm khác được kích hoạt bằng các lệnh ghi đó, thì các hàm đó sẽ chạy trong trình mô phỏng Cloud Functions.

Cloud Storage

Nếu bạn có các hàm sử dụng Firebase Admin SDK (phiên bản 9.7.0 trở lên) để ghi vào Cloud Storage, thì các hoạt động 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 hàm khác được kích hoạt bằng các lệnh ghi đó, thì các hàm đó sẽ chạy trong trình mô phỏng Cloud Functions.

Firebase Authentication

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 Firebase Authentication, thì các hoạt động ghi này sẽ được gửi đến trình mô phỏng Auth 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.

Lưu trữ Firebase

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

Cảnh báo của Firebase

Trong mọi dự án có ít nhất một trình kích hoạt cảnh báo Firebase được hỗ trợ, giao diện người dùng của trình mô phỏng sẽ có thẻ FireAlerts. Cách mô phỏng điều kiện kích hoạt cảnh báo:

  1. Mở thẻ FireAlerts. Thẻ này hiển thị một trình đơn thả xuống chứa các loại cảnh báo có trình kích hoạt liên kết với chúng (ví dụ: nếu bạn có trình kích hoạt onNewFatalIssuePublished, thì crashlytics.newFatalIssue sẽ hiển thị).
  2. Chọn một loại cảnh báo. Biểu mẫu sẽ tự động điền các giá trị mặc định mà bạn có thể chỉnh sửa. Bạn có thể chỉnh sửa các trường của sự kiện (thông tin khác từ sự kiện cảnh báo là suy luận, giá trị mô phỏng hoặc được tạo ngẫu nhiên).
  3. Chọn Send Alert (Gửi cảnh báo) để gửi cảnh báo tổng hợp đến trình mô phỏng hàm, với tính năng ghi nhật ký có trong Alerts (Cảnh báo) trong bảng điều khiển Firebase (cũng như trong nhật ký).

Ghi nhật ký

Trình mô phỏng truyền nhật ký từ các hàm của bạn đến 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

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