Trước khi kết nối ứng dụng với trình mô phỏng Cloud Functions, hãy đảm bảo rằng bạn hiểu quy trình làm việc tổng thể của Firebase Local Emulator Suite, cài đặt và định cấu hình Local Emulator Suite cũng như xem lại các lệnh CLI của trình mô phỏng này.
Chọn một dự án Firebase
Firebase Local Emulator Suite mô phỏng các sản phẩm cho một dự án Firebase.
Để chọn dự án cần sử dụng, trước khi khởi động trình mô phỏng, trong CLI, hãy chạy firebase use
trong thư mục đang hoạt động. Hoặc bạn có thể truyền cờ --project
đến từng lệnh của trình mô phỏng.
Local Emulator Suite hỗ trợ mô phỏng các dự án Firebase thực và dự án minh hoạ.
Loại dự án | Tính năng | Sử dụng với trình mô phỏng |
---|---|---|
Thực |
Dự án Firebase thực là dự án mà bạn đã tạo và định cấu hình (rất có thể là thông qua bảng điều khiển Firebase). Các dự án thực có tài nguyên trực tiếp, chẳng hạn như các thực thể cơ sở dữ liệu, bộ chứa bộ nhớ, hàm hoặc bất kỳ tài nguyên nào khác mà bạn thiết lập cho dự án Firebase đó. |
Khi làm việc với các dự án Firebase thực, bạn có thể chạy trình mô phỏng cho bất kỳ hoặc tất cả các sản phẩm được hỗ trợ. Đối với mọi sản phẩm mà bạn không mô phỏng, ứng dụng và mã của bạn sẽ tương tác với tài nguyên trực tiếp (phiên bản cơ sở dữ liệu, bộ chứa bộ nhớ, hàm, v.v.). |
Bản trình diễn |
Dự án Firebase minh hoạ không có cấu hình Firebase thực và không có tài nguyên trực tiếp. Bạn thường truy cập vào các dự án này thông qua các lớp học lập trình hoặc các hướng dẫn khác. Mã dự án cho các dự án minh hoạ có tiền tố |
Khi làm việc với các dự án Firebase minh hoạ, ứng dụng và mã của bạn chỉ tương tác với trình mô phỏng. Nếu ứng dụng của bạn cố gắng tương tác với một tài nguyên mà trình mô phỏng không chạy, thì mã đó sẽ không thành công. |
Bạn nên sử dụng các dự án minh hoạ bất cứ khi nào có thể. Các lợi ích bao gồm:
- Dễ thiết lập hơn vì bạn có thể chạy trình mô phỏng mà không cần tạo dự án Firebase
- An toàn hơn vì nếu mã của bạn vô tình gọi các tài nguyên không được mô phỏng (thực tế), thì sẽ không có khả năng thay đổi dữ liệu, mức sử dụng và thông tin thanh toán
- Hỗ trợ tốt hơn khi không có mạng, vì bạn không cần truy cập Internet để tải cấu hình SDK xuống.
Đo lường ứng dụng của bạn để giao tiếp với trình mô phỏng
Đ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)
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);
Swift
Functions.functions().useFunctionsEmulator(origin: "http://127.0.0.1:5001")
Web
import { getApp } from "firebase/app"; import { getFunctions, connectFunctionsEmulator } from "firebase/functions"; const functions = getFunctions(getApp()); connectFunctionsEmulator(functions, "127.0.0.1", 5001);
Web
firebase.functions().useEmulator("127.0.0.1", 5001);
Đ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 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ý 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 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 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ý.
Định cấu hình môi trường kiểm thử cục bộ
Nếu các hàm của bạn dựa vào cấu hình môi trường dựa trên dotenv, bạn có thể mô phỏng hành vi đó trong môi trường kiểm thử cục bộ.
Khi sử dụng trình mô phỏng Cloud Functions cục bộ, bạn có thể ghi đè các biến môi trường cho dự án bằng cách thiết lập tệp .env.local
. Nội dung của .env.local
được ưu tiên hơn .env
và tệp .env
dành riêng cho dự án.
Ví dụ: một dự án có thể bao gồm 3 tệp này chứa các giá trị khác nhau một chút cho hoạt động phát triển và kiểm thử cục bộ:
.env
|
.env.dev
|
.env.local
|
PLANET=Earth
AUDIENCE=Con người |
AUDIENCE=Dev Humans | AUDIENCE=Người dùng địa phương |
Khi khởi động trong ngữ cảnh cục bộ, trình mô phỏng sẽ tải các biến môi trường như sau:
$ firebase emulators:start
i emulators: Starting emulators: functions
# Starts emulator with following environment variables:
# PLANET=Earth
# AUDIENCE=Local Humans
Thông tin bí mật và thông tin xác thực trong trình mô phỏng Cloud Functions
Trình mô phỏng Cloud Functions hỗ trợ việc sử dụng thông tin bảo mật để lưu trữ và truy cập thông tin cấu hình nhạy cảm. Theo mặc định, trình mô phỏng sẽ cố gắng truy cập vào các bí mật phát hành chính thức bằng thông tin xác thực mặc định của ứng dụng. Trong một số trường hợp như môi trường CI, trình mô phỏng có thể không truy cập được các giá trị bí mật do các hạn chế về quyền.
Tương tự như tính năng hỗ trợ trình mô phỏng Cloud Functions cho các biến môi trường, bạn có thể ghi đè các giá trị bí mật bằng cách thiết lập tệp .secret.local
. Điều này giúp bạn dễ dàng kiểm thử các hàm trên máy, đặc biệt là khi bạn không có quyền truy cập vào giá trị bí mật.
Còn có công cụ nào khác để kiểm thử Cloud Functions không?
Trình mô phỏng Cloud Functions được bổ sung bằng các công cụ kiểm thử và nguyên mẫu khác:
- Vỏ chức năng trên đám mây cho phép tạo bản mô hình và phát triển các hàm tương tác, lặp lại. Shell sử dụng trình mô phỏng Cloud Functions với giao diện kiểu REPL để phát triển. Không tích hợp với trình mô phỏng Cloud Firestore hoặc Realtime Database. Khi sử dụng shell, bạn mô phỏng dữ liệu và thực hiện lệnh gọi hàm để mô phỏng hoạt động tương tác với các sản phẩm mà Local Emulator Suite hiện không hỗ trợ: Analytics, Cấu hình từ xa và Crashlytics.
- SDK kiểm thử Firebase cho Cloud Functions, một Node.js có khung mocha để phát triển các hàm. Về cơ bản, SDK kiểm thử Cloud Functions cung cấp tính năng tự động hoá trên shell Cloud Functions.
Bạn có thể tìm hiểu thêm về shell của Cloud Functions và SDK kiểm thử Cloud Functions trong bài viết Kiểm thử hàm theo cách tương tác và Kiểm thử đơn vị của Cloud Functions.
Sự khác biệt giữa trình mô phỏng Cloud Functions và bản phát hành chính thức
Trình mô phỏng Cloud Functions khá giống với môi trường phát hành chính thức trong hầu hết các trường hợp sử dụng. Chúng tôi đã nỗ lực rất nhiều để đảm bảo mọi thứ trong môi trường thời gian chạy Node đều gần với môi trường sản xuất nhất có thể. Tuy nhiên, trình mô phỏng không mô phỏng toàn bộ môi trường sản xuất được đóng gói, vì vậy, mặc dù mã hàm của bạn sẽ thực thi một cách thực tế, nhưng các khía cạnh khác của môi trường (tức là tệp cục bộ, hành vi sau khi các hàm gặp sự cố, v.v.) sẽ khác.
Cloud IAM
Bộ công cụ mô phỏng Firebase không cố gắng sao chép hoặc tuân thủ bất kỳ hành vi nào liên quan đến IAM để chạy. Trình mô phỏng tuân thủ các Quy tắc bảo mật của Firebase được cung cấp, nhưng trong trường hợp IAM thường được sử dụng, chẳng hạn như để đặt tài khoản dịch vụ gọi Hàm trên đám mây và do đó là các quyền, trình mô phỏng không thể định cấu hình và sẽ sử dụng tài khoản có sẵn trên toàn cầu trên máy của nhà phát triển, tương tự như việc chạy trực tiếp tập lệnh cục bộ.
Hạn chế về bộ nhớ và bộ xử lý
Trình mô phỏng không thực thi các hạn chế về bộ nhớ hoặc bộ xử lý cho các hàm của bạn. Tuy nhiên, trình mô phỏng hỗ trợ các hàm hết thời gian chờ thông qua đối số thời gian chạy timeoutSeconds
.
Xin lưu ý rằng thời gian thực thi hàm có thể khác với thời gian thực thi trong quá trình phát hành chính thức khi các hàm chạy trong trình mô phỏng. Sau khi thiết kế và kiểm thử các hàm bằng trình mô phỏng, bạn nên chạy các kiểm thử có giới hạn trong phiên bản chính thức để xác nhận thời gian thực thi.
Lập kế hoạch cho sự khác biệt giữa môi trường cục bộ và môi trường phát hành công khai
Vì trình mô phỏng chạy trên máy cục bộ, nên nó phụ thuộc vào môi trường cục bộ của bạn đối với các ứng dụng, chương trình và tiện ích tích hợp.
Xin lưu ý rằng môi trường cục bộ để phát triển Cloud Functions có thể khác với môi trường phát hành công khai của Google:
Các ứng dụng bạn cài đặt cục bộ để mô phỏng môi trường sản xuất (ví dụ: ImageMagick trong hướng dẫn này) có thể khác về hành vi so với môi trường sản xuất, đặc biệt là nếu bạn yêu cầu các phiên bản khác hoặc phát triển trong môi trường không phải Linux. Cân nhắc việc triển khai bản sao nhị phân của chương trình bị thiếu cùng với việc triển khai hàm.
Tương tự, các tiện ích tích hợp (ví dụ: các lệnh shell như
ls
,mkdir
) có thể khác với các phiên bản có sẵn trong bản phát hành chính thức, đặc biệt là nếu bạn đang phát triển trong môi trường không phải Linux (ví dụ: macOS). Bạn có thể xử lý vấn đề này bằng cách sử dụng các phương án thay thế chỉ dành cho Node cho các lệnh gốc hoặc bằng cách tạo các tệp nhị phân Linux để đóng gói cùng với quá trình triển khai.
Đang thử lại
Trình mô phỏng Cloud Functions không hỗ trợ thử lại các hàm khi không thành công.
Bước tiếp theo là gì?
- Để xem một bộ video được tuyển chọn và các ví dụ chi tiết về cách thực hiện, hãy tham khảo Danh sách phát hướng dẫn về Trình mô phỏng Firebase.
- Tìm hiểu thêm về trình mô phỏng Cloud Functions for Firebase tại phần Chạy các hàm trên máy.