Tạo và xử lý điều kiện kích hoạt sự kiện tuỳ chỉnh

Với Chức năng đám mây (thế hệ thứ 2), bạn có thể kích hoạt các hàm để phản hồi sự kiện tuỳ chỉnh. Đây là các sự kiện do các nhà cung cấp sự kiện đặc biệt hoặc bổ sung cung cấp, trái ngược với các sự kiện Firebase do SDK Firebase cho chức năng đám mây hỗ trợ sẵn. Thông qua trình kích hoạt sự kiện tuỳ chỉnh, ứng dụng của bạn có thể phản hồi các sự kiện do Tiện ích Firebase cung cấp hoặc bạn có thể phát hành các sự kiện tuỳ chỉnh và hàm kích hoạt của riêng mình để phản hồi các sự kiện đó.

Tất cả các sự kiện tuỳ chỉnh đều tuân thủ định dạng sự kiện JSON CloudEvents và được xuất bản lên Eventarc. Có áp dụng phí sử dụng cho Eventarc.

Kích hoạt hàm bằng sự kiện tuỳ chỉnh

Bạn có thể phát hành sự kiện tuỳ chỉnh (hoặc lấy sự kiện từ tiện ích Firebase) và kích hoạt các hàm để phản hồi những sự kiện đó bằng cách triển khai quy trình cơ bản sau:

  1. Phát hành các sự kiện mong muốn lên một kênh Eventarc hoặc xác định các sự kiện có sẵn do tiện ích mà bạn đã cài đặt cung cấp.
  2. Trong mã hàm, hãy đăng ký các sự kiện trên kênh Eventarc bằng một trình xử lý sự kiện.
  3. Trong hàm này, hãy phân tích cú pháp tải trọng được trả về trong đối tượng CloudEvent và thực hiện bất kỳ logic tuỳ chỉnh nào mà ứng dụng của bạn yêu cầu.

Ví dụ: một ứng dụng trò chơi nên gửi thông báo cho người dùng khi họ tham gia hoặc rời khỏi bảng xếp hạng của 10 đối thủ cạnh tranh hàng đầu. Ứng dụng này có thể phát hành các sự kiện bảng xếp hạng lên kênh mặc định, sau đó xử lý sự kiện đó trong một hàm gửi thông báo đẩy được nhắm mục tiêu đến người dùng.

Ở một ví dụ khác, một tiện ích được thiết kế để giúp các ứng dụng xử lý hình ảnh lớn có thể phát ra một sự kiện sau khi hoàn tất quá trình đổi kích thước hình ảnh. Các ứng dụng đã cài đặt tiện ích này có thể xử lý sự kiện hoàn thành bằng cách cập nhật các đường liên kết trong ứng dụng để trỏ đến các phiên bản đã đổi kích thước của hình ảnh.

Xuất bản sự kiện lên kênh

Các sự kiện Eventarc được xuất bản lên kênh. Kênh là một cách để nhóm các sự kiện liên quan và quản lý quyền truy cập. Khi bạn cài đặt một tiện ích hoặc triển khai một hàm sử dụng các sự kiện tuỳ chỉnh, Firebase sẽ tự động tạo một kênh mặc định có tên là firebase trong khu vực us-central1. SDK dành cho quản trị viên Firebase cung cấp một gói con eventarc để phát hành lên các kênh.

Cách phát hành sự kiện từ một máy chủ đáng tin cậy (hoặc một hàm khác) bằng cách sử dụng kênh mặc định:

import {getEventarc} from 'firebase-admin/eventarc';

getEventarc().channel().publish({
    type: 'achieved-leaderboard',
    subject: 'Welcome to the top 10',
    data: {
      message: 'You have achieved the nth position in our leaderboard!  To see . . .'
    }
});

Ngoài việc tự động tạo kênh mặc định, Firebase còn đặt biến môi trường EVENTARC_CLOUD_EVENT_SOURCE để chỉ định nguồn của sự kiện. Nếu định phát hành các sự kiện bên ngoài Cloud Functions cho Firebase, bạn cần thêm trường source một cách rõ ràng vào tải trọng sự kiện của mình.

Xử lý sự kiện tuỳ chỉnh

Bạn có thể xử lý tất cả sự kiện tuỳ chỉnh, bao gồm cả sự kiện tiện ích, bằng trình xử lý onCustomEventPublished hoặc on_custom_event_published. Trước tiên, hãy nhập trình xử lý này từ Eventarc SDK cùng với SDK dành cho quản trị viên của Firebase:

Node.js

const {onCustomEventPublished} = require("firebase-functions/v2/eventarc");
const logger = require("firebase-functions/logger");
const {initializeApp} = require("firebase-admin/app");
const {getFirestore} = require("firebase-admin/firestore");

Python

from firebase_admin import firestore, initialize_app
from firebase_functions import eventarc_fn

Trong mã hàm, hãy truyền tên sự kiện vào như ví dụ về hàm ví dụ:

Node.js

exports.onimageresized = onCustomEventPublished(
    "firebase.extensions.storage-resize-images.v1.complete",
    (event) => {
      logger.info("Received image resize completed event", event);
      // For example, write resized image details into Firestore.
      return getFirestore()
          .collection("images")
          .doc(event.subject.replace("/", "_")) // original file path
          .set(event.data); // resized images paths and sizes
    });

Python

@eventarc_fn.on_custom_event_published(
    event_type="firebase.extensions.storage-resize-images.v1.complete")
def onimageresized(event: eventarc_fn.CloudEvent) -> None:
    print("Received image resize completed event: ", event.type)

    if not isinstance(event.subject, str):
        print("No 'subject' data.")
        return

    # For example, write resized image details into Firestore.
    firestore_client: google.cloud.firestore.Client = firestore.client()
    collection = firestore_client.collection("images")
    doc = collection.document(event.subject.replace("/", "_"))  # original file path
    doc.set(event.data)  # resized images paths and sizes

Đối với mỗi phần mở rộng cụ thể, tải trọng được trả về trong đối tượng sự kiện sẽ cung cấp dữ liệu mà bạn có thể sử dụng để thực hiện logic tuỳ chỉnh cho luồng ứng dụng. Trong trường hợp này, hàm sẽ sử dụng SDK dành cho quản trị viên để sao chép siêu dữ liệu về hình ảnh đã đổi kích thước vào một bộ sưu tập trong Cloud Firestore, lấy tên tệp từ subject do sự kiện cung cấp và lưu siêu dữ liệu từ data do sự kiện cung cấp.

Xuất bản và xử lý sự kiện trên các kênh không phải kênh mặc định

Kênh tuỳ chỉnh có thể hữu ích cho các trường hợp bạn có nhu cầu về quyền đặc biệt hoặc các yêu cầu khác và không muốn có cùng một mức độ hiển thị và quyền truy cập cho tất cả các sự kiện. Bạn có thể tạo kênh của riêng mình bằng bảng điều khiển Google Cloud. Bạn phải đăng ký và đăng ký tham gia sự kiện trên cùng một kênh.

Trong trường hợp sự kiện tuỳ chỉnh được xuất bản trên một kênh không phải kênh mặc định, bạn sẽ cần chỉ định kênh đó trong mã hàm. Ví dụ: nếu muốn xử lý các sự kiện được xuất bản trên kênh không phải kênh mặc định cho vị trí us-west1, bạn cần chỉ định kênh như sau:

Node.js

import { onCustomEventPublished } from "firebase-functions/v2/eventarc";

export const func = onCustomEventPublished(
    {
      eventType: "firebase.extensions.storage-resize-images.v1.complete",
      channel: "locations/us-west1/channels/firebase",
      region: "us-west1",
    },
    (event) => { ... });

Python

@eventarc_fn.on_custom_event_published(
    event_type="firebase.extensions.storage-resize-images.v1.complete",
    channel="locations/us-west1/channels/firebase",
    region="us-west1")
def onimageresizedwest(event: eventarc_fn.CloudEvent) -> None:
    print("Received image resize completed event: ", event.type)
    # ...