Benutzerdefinierte Ereignistrigger erstellen und verarbeiten

Mit Cloud Functions (2. Generation) können Sie Funktionen als Reaktion auf benutzerdefinierte Ereignisse auslösen. Diese Ereignisse werden von speziellen oder zusätzlichen Ereignisanbietern im Gegensatz zu den Firebase-Ereignissen bereitgestellt, die nativ vom Firebase SDK für Cloud Functions unterstützt werden. Über benutzerdefinierte Ereignistrigger kann Ihre App auf Ereignisse von Firebase Extensions reagieren. Sie können auch eigene benutzerdefinierte Ereignisse veröffentlichen und Funktionen als Reaktion darauf auslösen.

Alle benutzerdefinierten Ereignisse entsprechen dem CloudEvents-JSON-Ereignisformat und werden in Eventarc veröffentlicht. Eventarc Nutzungsgebühren fallen an.

Funktionen mit benutzerdefinierten Ereignissen auslösen

Sie können benutzerdefinierte Ereignisse veröffentlichen (oder Ereignisse aus Firebase Extensions abrufen) und Functions als Reaktion auf diese Ereignisse auslösen. Implementieren Sie dazu diesen grundlegenden Ablauf:

1. Veröffentlichen Sie die gewünschten Ereignisse in einem Eventarc-Kanal oder identifizieren Sie verfügbare Ereignisse, die von einer installierten Erweiterung bereitgestellt werden.
2. Abonnieren Sie in Ihrem Funktionscode Ereignisse im Eventarc-Kanal mit einem Event-Handler.
3. Parsen Sie in der Funktion die im CloudEvent-Objekt zurückgegebene Nutzlast und führen Sie die benutzerdefinierte Logik aus, die Ihre Anwendung erfordert.

Eine Gaming-App könnte beispielsweise Benachrichtigungen an Nutzer senden, wenn sie in die Bestenliste der zehn besten Spieler aufgenommen werden oder diese verlassen. Diese App könnte Bestenlistenereignisse im Standardkanal veröffentlichen und das Ereignis dann in einer Funktion verarbeiten, die gezielte Push-Benachrichtigungen an Nutzer sendet.

In einem anderen Beispiel könnte eine Erweiterung, die Apps bei der Verarbeitung großer Bilder unterstützt, ein Ereignis ausgeben, wenn die Größe des Bildes angepasst wurde. Apps, in denen diese Erweiterung installiert ist, können das Abschlussereignis verarbeiten, indem sie Links in der App so aktualisieren, dass sie auf Versionen des Bildes mit angepasster Größe verweisen.

Ereignis in einem Kanal veröffentlichen

Eventarc-Ereignisse werden in Kanälen veröffentlicht. Über Channels können Sie ähnliche Ereignisse gruppieren und Zugriffsberechtigungen verwalten. Wenn Sie eine Erweiterung installieren oder eine Funktion bereitstellen, die benutzerdefinierte Ereignisse nutzt, erstellt Firebase automatisch einen Standardkanal namens firebase in der Region us-central1. Firebase Admin SDK bietet ein eventarc-Unterpaket für die Veröffentlichung in Kanälen.

So veröffentlichen Sie ein Ereignis von einem vertrauenswürdigen Server (oder einer anderen Funktion) über den Standardkanal:

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

Zusätzlich zur automatischen Erstellung des Standardkanals legt Firebase die Umgebungsvariable EVENTARC_CLOUD_EVENT_SOURCE fest, die die Quelle des Ereignisses angibt. Wenn Sie Ereignisse außerhalb von Cloud Functions for Firebase veröffentlichen, müssen Sie das Feld source explizit in die Ereignisnutzlast einfügen.

Benutzerdefinierte Ereignisse verarbeiten

Sie können alle benutzerdefinierten Ereignisse, einschließlich Erweiterungsereignisse, mit den Handlern onCustomEventPublished oder on_custom_event_published verarbeiten. Importieren Sie zuerst diesen Handler aus dem Eventarc SDK zusammen mit dem 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

Übergeben Sie im Funktionscode den Ereignisnamen, wie im Beispiel für die Funktion gezeigt:

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

Für jede Erweiterung enthält die im Ereignisobjekt zurückgegebene Nutzlast Daten, die Sie für die benutzerdefinierte Logik Ihres Anwendungsablaufs verwenden können. In diesem Fall verwendet die Funktion Admin SDK, um Metadaten zum Bild mit geänderter Größe in eine Sammlung in Cloud Firestore zu kopieren. Dabei wird der Dateiname aus dem vom Ereignis bereitgestellten subject abgerufen und die Metadaten aus dem vom Ereignis bereitgestellten data gespeichert.

Ereignisse in nicht standardmäßigen Kanälen veröffentlichen und verarbeiten

Benutzerdefinierte Kanäle können nützlich sein, wenn Sie spezielle Berechtigungsanforderungen oder andere Anforderungen haben und nicht für alle Ereignisse dieselbe Sichtbarkeit und denselben Zugriff wünschen. Sie können eigene Kanäle mit der Google Cloud Console erstellen. Das Veröffentlichen und Abonnieren von Ereignissen muss über denselben Kanal erfolgen.

Wenn ein benutzerdefiniertes Ereignis auf einem nicht standardmäßigen Kanal veröffentlicht wird, müssen Sie den Kanal in Ihrem Funktionscode angeben. Wenn Sie beispielsweise Ereignisse verarbeiten möchten, die in einem nicht standardmäßigen Kanal für den Standort us-west1 veröffentlicht werden, müssen Sie den Kanal so angeben:

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