Trình bao Chức năng đám mây cung cấp một trình bao tương tác để gọi các chức năng với dữ liệu thử nghiệm. Shell hỗ trợ tất cả các loại trình kích hoạt.
Thiết lập thông tin đăng nhập của quản trị viên (tùy chọn)
Nếu bạn muốn kiểm tra chức năng của mình tương tác với API Google hoặc API Firebase khác thông qua SDK quản trị Firebase , thì bạn có thể cần phải thiết lập thông tin xác thực của quản trị viên.
- Trình kích hoạt Cơ sở dữ liệu thời gian thực và Cloud Firestore đã có đủ thông tin xác thực và không yêu cầu thiết lập bổ sung.
- Tất cả các API khác, bao gồm API Firebase, chẳng hạn như Xác thực và FCM hoặc API 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
firebase emulators:start.
Để thiết lập thông tin đăng nhập của quản trị viên cho các chức năng mô phỏng:
- Mở ngăn Tài khoản dịch vụ của Google Cloud Console.
- Đảm bảo rằng tài khoản dịch vụ mặc định của App Engine được chọn và sử dụng menu tùy chọn ở bên phải để chọn Tạo khóa .
- Khi được nhắc, hãy chọn JSON cho loại khóa và nhấp vào Tạo .
Đặt thông tin đăng nhập mặc định của Google để trỏ đến khóa đã tải xuống:
Unix
export GOOGLE_APPLICATION_CREDENTIALS="path/to/key.json" firebase functions:shell
các cửa sổ
set GOOGLE_APPLICATION_CREDENTIALS=path\to\key.json firebase functions:shell
Sau khi hoàn thành các bước này, các bài kiểm tra chức năng của bạn có thể truy cập vào Firebase và Google API bằng cách sử dụng SDK dành cho quản trị viên . Ví dụ: khi kiểm tra trình kích hoạt Xác thực, chức năng được mô phỏng có thể gọi admin.auth().getUserByEmail(email) .
Phục vụ các chức năng bằng cách sử dụng trình bao Chức năng đám mây
Trình bao Chức năng đám mây mô phỏng tất cả các loại trình kích hoạt chức năng bằng một trình bao tương tác để gọi các chức năng với dữ liệu thử nghiệm. Các tùy chọn khác nhau tùy theo loại chức năng, nhưng định dạng sử dụng cơ bản là:
myFunctionName(data, options)
Tham số data là bắt buộc đối với trình kích hoạt Cơ sở dữ liệu thời gian thực, Cloud Firestore và PubSub, đồng thời là tùy chọn đối với tất cả các loại chức năng khác. Ngoài ra, tham số options tùy chọn chỉ hợp lệ cho các chức năng Cơ sở dữ liệu thời gian thực và Cloud Firestore.
Theo tùy chọn, bạn có thể tải dữ liệu thử nghiệm từ một tệp cục bộ bằng cách lưu tệp dưới dạng một biến và gọi một hàm với nó:
var data = require('./path/to/testData.json');
myFunction(data);
Cài đặt và định cấu hình trình bao Chức năng đám mây
Để sử dụng tính năng này, firebase-tools phải có phiên bản tối thiểu 3.11.0 và SDK firebase-functions phải có phiên bản tối thiểu 0.6.2. Để cập nhật cả hai, hãy chạy các lệnh sau trong thư mục functions/ cho dự án của bạn:
npm install --save firebase-functions@latest
npm install -g firebase-tools
Nếu bạn đang sử dụng các biến cấu hình chức năng tùy chỉnh, trước tiên hãy chạy lệnh để nhận cấu hình tùy 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
Cuối cùng, chạy trình bao bằng lệnh sau:
firebase functions:shell
Gọi các hàm HTTPS
Để gọi các hàm HTTPS trong trình bao, cách sử dụng giống như mô-đun NPM request , nhưng thay thế request bằng tên của hàm bạn muốn mô phỏng. Ví dụ:
# invoke
myHttpsFunction()
myHttpsFunction.get()
myHttpsFunction.post()
# invoke at sub-path
myHttpsFunction('/path')
myHttpsFunction.get('/path')
myHttpsFunction.post('/path')
# send POST request with form data
myHttpsFunction.post('/path').form( {foo: 'bar' })
Gọi các chức năng có thể gọi HTTPS
Khi gọi cục bộ các hàm Có thể gọi HTTPS, bạn sẽ cần cung cấp dữ liệu thử nghiệm phù hợp.
# invoke
myCallableFunction('test data')
myCallableFunction({'foo': 'bar'})
Theo tùy chọn, bạn có thể chuyển mã Firebase-Instance-ID-token làm thông số thứ hai. Đây phải là một chuỗi.
# invoke with FCM registration token
myCallableFunction('test data', {instanceIdToken: 'sample token'})
Giả lập context.auth hiện không khả dụng.
Gọi các chức năng Cơ sở dữ liệu thời gian thực
Khi chạy các chức năng Cơ sở dữ liệu thời gian thực cục bộ, bạn sẽ cần cung cấp dữ liệu thử nghiệm phù hợp. Điều này thường có nghĩa là cung cấp dữ liệu thử nghiệm mới cho các thao tác onCreate , dữ liệu cũ/đã xóa cho các thao tác onDelete và cả cho các hàm onUpdate hoặc onWrite :
# invoke onCreate function
myDatabaseFunction('new_data')
# invoke onDelete function
myDatabaseFunction('old_data')
# invoke onUpdate or onWrite function
myDatabaseFunction({before: 'old_data', after: 'new_data' })
Ngoài các tùy chọn before/after , shell còn cung cấp tùy chọn params để sử dụng trong các ký tự đại diện mô phỏng trong một đường dẫn:
# mock wildcards in path, for example: if the path was input/{group}/{id}
myDatabaseFunction('data', {params: {group: 'a', id: 123}})
Theo mặc định, trình bao chạy các chức năng Cơ sở dữ liệu thời gian thực với các đặc quyền của quản trị viên (tài khoản dịch vụ). Thay vào đó, hãy sử dụng tùy chọn auth để chạy các chức năng với tư cách là người dùng cuối cụ thể hoặc với tư cách là người dùng chưa được xác thực:
# to mock unauthenticated user
myDatabaseFunction('data', {authMode: 'USER'})
# to mock end user
myDatabaseFunction('data', {auth: {uid: 'abcd'}})
Gọi các hàm Firestore
Khi chạy các chức năng của Firestore cục bộ, bạn sẽ cần cung cấp dữ liệu thử nghiệm thích hợp. Điều này thường có nghĩa là cung cấp dữ liệu thử nghiệm mới cho các thao tác onCreate , dữ liệu cũ/đã xóa cho các thao tác onDelete và cả cho các hàm onUpdate hoặc onWrite . Lưu ý rằng dữ liệu Firestore phải là cặp khóa-giá trị; xem Các loại dữ liệu được hỗ trợ .
# invoke onCreate function
myFirestoreFunction({foo: ‘new’})
# invoke onDelete function
myFirestoreFunction({foo: ‘old’})
# invoke onUpdate or onWrite function
myFirestoreFunction({before: {foo: ‘old’}, after: {foo: ‘new’} })
Ngoài các trường before/after của đối tượng data , bạn có thể sử dụng các trường params trên đối tượng options để mô phỏng ký tự đại diện trong tên tài liệu:
# mock wildcards in document name, for example: if the name was input/{group}/{id}
myFirestoreFunction({foo: ‘new’}, {params: {group: 'a', id: 123}})
Shell luôn chạy các chức năng của Firestore với các đặc quyền quản trị, có nghĩa là nó giả định một sự kiện tạo/cập nhật/xóa như thể nó được thực hiện bởi một người dùng quản trị.
Gọi các chức năng PubSub
Đối với các chức năng PubSub, hãy chèn tải tin nhắn của bạn vào một phiên bản Buffer và thêm các thuộc tính dữ liệu tùy chọn như được hiển thị:
// invokes a function with the JSON message { hello: 'world' } and attributes { foo: 'bar' }
myPubsubFunction({data: new Buffer('{"hello":"world"}'), attributes: {foo: 'bar'}})
Gọi hàm Analytics
Bạn có thể gọi một hàm Analytics mà không cần bất kỳ dữ liệu nào bằng cách chạy myAnalyticsFunction() trong trình bao. Để chạy hàm với dữ liệu thử nghiệm, bạn nên xác định một biến cho các trường dữ liệu sự kiện cụ thể mà hàm của bạn cần:
var data = {
eventDim: [{
// populates event.data.params
params: {foo: {stringValue: 'bar'} },
// Also valid:
// {intValue: '10'}, {floatValue: '1.0'}, {doubleValue: '1.0'}
// populates event.data.name
name: 'event_name',
// populates event.data.logTime, specify in microseconds
timestampMicros: Date.now() * 1000,
// populates event.data.previousLogTime, specify in microseconds
previousTimestampMicros: Date.now() * 1000,
// populates event.data.reportingDate, specify in 'YYYYMMDD' format
date: '20170930',
// populates event.data.valueInUSD
valueInUsd: 230
}],
userDim: userDim
};
myAnalyticsFunction(data);
Gọi chức năng Lưu trữ và Xác thực
Đối với các hàm Lưu trữ và Xác thực, hãy gọi hàm cục bộ với dữ liệu thử nghiệm mà bạn muốn xem bên trong hàm. Dữ liệu thử nghiệm của bạn phải tuân theo các định dạng dữ liệu tương ứng:
- Đối với lưu trữ đám mây:
ObjectMetadata - Để xác thực:
UserRecord
Chỉ chỉ định các trường mà mã của bạn phụ thuộc vào hoặc không có trường nào nếu bạn chỉ muốn chạy chức năng.