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

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

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

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

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

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

ตัวอย่างเช่น แอปเกมอาจต้องการส่งการแจ้งเตือนไปยังผู้ใช้เมื่อพวกเขาเข้าหรือออกจากลีดเดอร์บอร์ดของคู่แข่งสิบอันดับแรก แอปนี้สามารถเผยแพร่เหตุการณ์ลีดเดอร์บอร์ดไปยังช่องเริ่มต้น แล้วจัดการเหตุการณ์ในฟังก์ชันที่ส่งข้อความ 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");

index.js

Python

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

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

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

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

สำหรับส่วนขยายแต่ละรายการ เพย์โหลดที่แสดงผลในออบเจ็กต์เหตุการณ์จะให้ข้อมูลที่คุณใช้เพื่อดำเนินการตรรกะที่กำหนดเองสำหรับโฟลว์ของแอปพลิเคชันได้ ในกรณีนี้ ฟังก์ชันจะใช้ 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)
    # ...
main.py