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

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

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

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

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

  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 ดังนี้

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

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

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

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

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

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

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

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)
    # ...