สร้างและจัดการทริกเกอร์เหตุการณ์ที่กำหนดเอง

เมื่อใช้ Cloud Functions (รุ่นที่ 2) คุณจะเรียกใช้ฟังก์ชันเพื่อตอบสนองต่อเหตุการณ์ที่กำหนดเองได้ เหตุการณ์เหล่านี้เป็นเหตุการณ์ที่ได้จากผู้ให้บริการเหตุการณ์พิเศษหรือเพิ่มเติม ซึ่งตรงข้ามกับเหตุการณ์ Firebase ที่รองรับโดย SDK ของ Firebase สำหรับ Cloud Functions โดยค่าเริ่มต้น แอปของคุณสามารถตอบสนองต่อเหตุการณ์ที่ Firebase Extensions มีให้ผ่านทริกเกอร์เหตุการณ์ที่กำหนดเอง หรือคุณจะเผยแพร่เหตุการณ์ที่กำหนดเองและทริกเกอร์ฟังก์ชันเพื่อตอบสนองต่อเหตุการณ์เหล่านั้นก็ได้

เหตุการณ์ที่กำหนดเองทั้งหมดเป็นไปตามรูปแบบเหตุการณ์ JSON ของ CloudEvents และเผยแพร่ไปยัง Eventarc Eventarc ค่าธรรมเนียมการใช้งาน

ทริกเกอร์ฟังก์ชันด้วยเหตุการณ์ที่กำหนดเอง

คุณสามารถเผยแพร่เหตุการณ์ที่กำหนดเอง (หรือรับเหตุการณ์จาก Firebase Extensions) และทริกเกอร์ฟังก์ชันเพื่อตอบสนองต่อเหตุการณ์เหล่านั้นได้โดยใช้ขั้นตอนพื้นฐานต่อไปนี้

1. เผยแพร่เหตุการณ์ที่ต้องการไปยังช่องทาง Eventarc หรือระบุเหตุการณ์ที่พร้อมใช้งานซึ่งมาจากส่วนขยายที่คุณติดตั้งไว้
2. ในโค้ดฟังก์ชัน ให้สมัครรับเหตุการณ์ในช่องทาง Eventarc ด้วยเครื่องจัดการเหตุการณ์
3. ในฟังก์ชัน ให้แยกวิเคราะห์เพย์โหลดที่แสดงผลในออบเจ็กต์ CloudEvent และใช้ตรรกะที่กำหนดเองตามที่แอปต้องการ

ตัวอย่างเช่น แอปเกมอาจต้องการส่งการแจ้งเตือนให้ผู้ใช้เมื่อเข้าหรือออกจากลีดเดอร์บอร์ดของผู้แข่งขัน 10 อันดับแรก แอปนี้สามารถเผยแพร่กิจกรรมลีดเดอร์บอร์ดไปยังแชแนลเริ่มต้น แล้วจัดการกิจกรรมในฟังก์ชันที่ส่งข้อความ Push ที่กำหนดเป้าหมายไปยังผู้ใช้

ในอีกตัวอย่างหนึ่ง ส่วนขยายที่ออกแบบมาเพื่อช่วยแอปประมวลผลรูปภาพขนาดใหญ่อาจส่งเหตุการณ์เมื่อปรับขนาดรูปภาพเสร็จสมบูรณ์ แอปที่ติดตั้งส่วนขยายนี้จะจัดการเหตุการณ์การเสร็จสมบูรณ์ได้โดยการอัปเดตลิงก์ในแอปให้ชี้ไปยังรูปภาพเวอร์ชันที่ปรับขนาดแล้ว

เผยแพร่กิจกรรมไปยังช่อง

ระบบจะเผยแพร่เหตุการณ์ Eventarc ไปยังช่องทางต่างๆ ช่องทางเป็นวิธีจัดกลุ่มเหตุการณ์ที่เกี่ยวข้องและจัดการสิทธิ์เข้าถึง เมื่อคุณติดตั้งส่วนขยายหรือทำให้ฟังก์ชันที่ใช้เหตุการณ์ที่กำหนดเองใช้งานได้ Firebase จะสร้างแชแนลเริ่มต้นชื่อ firebase ในภูมิภาค us-central1 โดยอัตโนมัติ Firebase Admin SDK มีแพ็กเกจย่อย eventarc สำหรับการเผยแพร่ไปยังช่องทางต่างๆ

วิธีเผยแพร่เหตุการณ์จากเซิร์ฟเวอร์ที่เชื่อถือได้ (หรือฟังก์ชันอื่น) โดยใช้แชแนลเริ่มต้น

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 . . .'
    }
});

นอกจากการสร้างแชแนลเริ่มต้นโดยอัตโนมัติแล้ว Firebase ยังตั้งค่าตัวแปรสภาพแวดล้อม EVENTARC_CLOUD_EVENT_SOURCE ซึ่งระบุแหล่งที่มาของเหตุการณ์ด้วย หากคุณเผยแพร่เหตุการณ์นอก Cloud Functions for Firebase คุณจะต้องเพิ่มช่อง source ในเพย์โหลดเหตุการณ์อย่างชัดเจน

จัดการเหตุการณ์ที่กำหนดเอง

คุณสามารถจัดการเหตุการณ์ที่กำหนดเองทั้งหมด รวมถึงเหตุการณ์ของส่วนขยายด้วยแฮนเดิล onCustomEventPublished หรือ on_custom_event_published ก่อนอื่น ให้นำเข้าแฮนเดิลนี้จาก Eventarc SDK พร้อมกับ Firebase Admin SDK:

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

from firebase_admin import firestore, initialize_app
from firebase_functions import eventarc_fn
main.py

ในโค้ดฟังก์ชัน ให้ส่งชื่อเหตุการณ์ตามที่แสดงในฟังก์ชันตัวอย่าง

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
    });
index.js

@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
main.py

สำหรับส่วนขยายแต่ละรายการ เพย์โหลดที่แสดงผลในออบเจ็กต์เหตุการณ์จะให้ข้อมูลที่คุณสามารถใช้เพื่อใช้ตรรกะที่กำหนดเองสำหรับขั้นตอนของแอปพลิเคชัน ในกรณีนี้ ฟังก์ชันจะใช้ Admin SDK เพื่อคัดลอกข้อมูลเมตาเกี่ยวกับรูปภาพที่ปรับขนาดไปยังคอลเล็กชันใน Cloud Firestore โดยรับชื่อไฟล์จาก subject ที่ได้จากเหตุการณ์ และบันทึกข้อมูลเมตาจาก data ที่ได้จากเหตุการณ์

เผยแพร่และจัดการเหตุการณ์ในช่องทางที่ไม่ใช่ค่าเริ่มต้น

แชแนลที่กำหนดเองจะมีประโยชน์ในกรณีที่คุณต้องการสิทธิ์พิเศษหรือข้อกำหนดอื่นๆ และไม่ต้องการให้กิจกรรมทั้งหมดมีระดับการเข้าถึงและการเข้าถึงที่เหมือนกัน คุณสร้างช่องทางของตนเองได้โดยใช้คอนโซล Google Cloud การเผยแพร่และการสมัครรับข้อมูลกิจกรรมต้องดำเนินการในช่องทางเดียวกัน

ในกรณีที่มีการเผยแพร่เหตุการณ์ที่กำหนดเองในแชแนลที่ไม่ใช่ค่าเริ่มต้น คุณจะต้องระบุแชแนลในโค้ดฟังก์ชัน ตัวอย่างเช่น หากต้องการจัดการเหตุการณ์ที่เผยแพร่ในช่องที่ไม่ใช่ค่าเริ่มต้นสำหรับสถานที่ตั้ง us-west1 คุณต้องระบุช่องดังที่แสดงต่อไปนี้

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) => { ... });

@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)
    # ...
main.py