了解 2023 年 Google I/O 大会上介绍的 Firebase 亮点。了解详情

Trang này được dịch bởi Cloud Translation API.

Kiểm tra các chức năng một cách tương tác

Lớp vỏ Chức năng đám mây cung cấp lớp vỏ tương tác để gọi các hàm bằng dữ liệu thử nghiệm. Shell hỗ trợ tất cả các loại 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 các thử nghiệm chức năng của mình tương tác với API Google hoặc các API Firebase khác thông qua SDK quản trị Firebase , 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 Cloud Firestore và Cơ sở dữ liệu thời gian thực đã 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 cả API Firebase như Xác thực 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 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 xác thực mặc định của Google của bạn để 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 Firebase và API Google bằng SDK quản trị viên . Ví dụ: khi kiểm tra trình kích hoạt Xác thực, hàm đượ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 shell Chức năng đám mây

Lớp vỏ Chức năng đám mây mô phỏng tất cả các loại trình kích hoạt hàm bằng lớp vỏ tương tác để gọi các hàm bằng 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 các trình kích hoạt Cơ sở dữ liệu thời gian thực, Cloud Firestore và PubSub và tùy chọn cho 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 hàm với nó:

var data = require('./path/to/testData.json');
myFunction(data);

Cài đặt và định cấu hình shell 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 hàm 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 shell bằng lệnh sau:

firebase functions:shell

Gọi các hàm HTTPS

Để gọi các hàm HTTPS trong shell, cách sử dụng cũ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 hàm có thể gọi HTTPS

Khi gọi cục bộ các hàm HTTPS có thể gọi được, bạn sẽ cần cung cấp dữ liệu thử nghiệm thích hợp.

# invoke
myCallableFunction('test data')
myCallableFunction({'foo': 'bar'})

Theo tùy chọn, bạn có thể chuyển Firebase-Instance-ID-token làm tham số thứ hai. Đây phải là một chuỗi.

# invoke with FCM registration token
myCallableFunction('test data', {instanceIdToken: 'sample token'})

Việc mô phỏng context.auth hiện không khả dụng.

Gọi các hàm cơ sở dữ liệu thời gian thực

Khi chạy cục bộ các chức năng Cơ sở dữ liệu thời gian thực, 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 hoạt động onCreate , dữ liệu cũ/đã bị xóa cho các hoạt động 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 việc mô phỏng các ký tự đại diện 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, shell chạy các chức năng Cơ sở dữ liệu thời gian thực với đặc quyền 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 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 hoạt động onCreate , dữ liệu cũ/đã bị xóa cho các hoạt động 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 các 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 Firestore với đặc quyền quản trị, có nghĩa là nó mô phỏng sự kiện tạo/cập nhật/xóa như thể nó được thực hiện bởi người dùng quản trị.

Gọi hàm PubSub

Đối với các hàm PubSub, hãy chèn tải trọng tin nhắn của bạn vào 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 các hàm Analytics

Bạn có thể gọi hàm Analytics mà không cần bất kỳ dữ liệu nào bằng cách chạy myAnalyticsFunction() trong shell. Để 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 các hàm 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 thấy 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 chỉ định trường nào nếu bạn chỉ muốn chạy hàm.