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

Firebase CLI có 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
  • 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 cho bản phát hành công khai.

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 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 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 Firebase Admin SDK, 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 Cloud Firestore và Realtime Database đã có đủ thông tin xác thực và không yêu cầu 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 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 cả khi bạn đang sử dụng trình bao 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ụ của bảng điều khiển 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 kiểm thử hàm của bạn có thể truy cập vào Firebase và các API của Google bằng Admin SDK. Ví dụ: khi kiểm thử một 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 để nhận 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ộ mô phỏng

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

firebase emulators:start

Lệnh emulators:start sẽ khởi động các 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 động trong dự án cục bộ bằng cách sử dụ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 bạn nhằm tương tác với các trình mô phỏng, bạn có thể cần thực hiện một số cấu hình bổ sung.

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

Nếu các hoạt động nguyên mẫu và kiểm thử 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
// 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().useEmulator(withHost: "localhost", port: 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

Thiết lập ứ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 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 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 của bạn để mô phỏng các chức năng hàng đợi tác vụ

Trình mô phỏng tự động thiết lập các hàng đợi tác vụ được mô phỏng dựa trên các định nghĩa về trình kích hoạt và Admin SDK sẽ định tuyến lại các yêu cầu được đư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 gửi được dùng trong quá trình 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 sẽ 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 độ mà các tác vụ được gửi đi và thử lại.

Đ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:

  • 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
  • Trình mô phỏng cảnh báo của Firebase

Để kích hoạt các sự kiện ở chế độ nền, hãy sửa đổi 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 hoặc mã kiểm thử với trình mô phỏng bằng 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 phát ra

Đối với các hàm mà bạn triển khai để xử lý các 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ợ các 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 Cloud Functions và trình mô phỏng 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. Đến lượt, 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ề quá trình thực thi trình xử lý.

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 các sản phẩm.

Cloud Firestore

Nếu bạn có các hàm sử dụng Firebase Admin SDK để ghi vào Cloud Firestore, thì các thao tác 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ởi những thao tác ghi đó, thì các hàm này 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 thao tác 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ởi những thao tác ghi đó, thì các hàm này 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 Firebase Admin SDK (phiên bản 9.3.0 trở lên) để ghi vào Firebase Authentication, thì các thao tác 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 hàm khác được kích hoạt bởi những thao tác ghi đó, thì các hàm này sẽ 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, firebase emulators:start sẽ sử dụng các hàm HTTP cục bộ của bạn làm proxy để lưu trữ.

Cảnh báo Firebase

Trong mọi dự án có ít nhất một điều kiện kích hoạt cảnh báo Firebase được hỗ trợ, giao diện người dùng trình mô phỏng sẽ có thẻ FireAlerts. Cách mô phỏng một đ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ó liên kết với trình kích hoạt (ví dụ: nếu bạn có trình kích hoạt onNewFatalIssuePublished, thì crashlytics.newFatalIssue sẽ xuất hiện).
  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 được suy luận, giá trị mô phỏng hoặc được tạo ngẫu nhiên).
  3. Chọn Gửi cảnh báo để gửi một cảnh báo giả tạo đến trình mô phỏng hàm, với nhật ký có sẵn trong phần 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 trực tuyến nhật ký từ các hàm đến cửa sổ dòng lệnh nơi các hàm đó chạy. Công cụ này hiển thị tất cả đầu ra từ các 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 bắt đầu nhanh về kiểm thử.