Özel etkinlik tetikleyicileri oluşturma ve işleme

Cloud Functions (2. nesil) ile özel etkinliklere yanıt olarak işlevleri tetikleyebilirsiniz. Bunlar, Cloud Functions için Firebase SDK'sı tarafından yerel olarak desteklenen Firebase etkinliklerinin aksine özel veya ek etkinlik sağlayıcılar tarafından sağlanan etkinliklerdir. Uygulamanız, özel etkinlik tetikleyicileri aracılığıyla Firebase Uzantıları tarafından sağlanan etkinliklere yanıt verebilir veya kendi özel etkinliklerinizi yayınlayıp bunlara göre işlevleri tetikleyebilirsiniz.

Tüm özel etkinlikler CloudEvents JSON etkinlik biçimine uygundur ve Eventarc'ta yayınlanır. Eventarc kullanım ücretleri geçerlidir.

İşlevleri özel etkinliklerle tetikleme

Aşağıdaki temel akışı uygulayarak özel etkinlikler yayınlayabilir (veya Firebase uzantılarından etkinlik alabilir) ve bu etkinliklere yanıt olarak işlevleri tetikleyebilirsiniz:

1. İstenen etkinlikleri bir Eventarc kanalında yayınlayın veya yüklediğiniz bir uzantının sağladığı kullanılabilir etkinlikleri tanımlayın.
2. İşlev kodunuzda, bir etkinlik işleyici ile Eventarc kanalındaki etkinliklere abone olun.
3. İşlevde, CloudEvent nesnesinde döndürülen yükü ayrıştırın ve uygulamanızın gerektirdiği özel mantığı gerçekleştirin.

Örneğin, bir oyun uygulaması, ilk on rakibinin skor tablosuna giren veya skor tablosundan ayrılan kullanıcılara bildirim göndermek isteyebilir. Bu uygulama, skor tablosu etkinliklerini varsayılan kanalda yayınlayabilir ve ardından etkinliği, kullanıcılara hedeflenmiş push bildirimleri gönderen bir işlevde işleyebilir.

Başka bir örnekte, uygulamaların büyük resimleri işlemesine yardımcı olmak için tasarlanmış bir uzantı, resim yeniden boyutlandırma işleminin tamamlanmasının ardından bir etkinlik yayınlayabilir. Bu uzantının yüklü olduğu uygulamalar, uygulamadaki bağlantıları resmin yeniden boyutlandırılan sürümlerine işaret edecek şekilde güncelleyerek tamamlama etkinliğini işleyebilir.

Kanalda etkinlik yayınlama

Eventarc etkinlikleri kanallara yayınlanır. Kanallar, ilgili etkinlikleri gruplandırmanın ve erişim izinlerini yönetmenin bir yoludur. Bir uzantı yüklediğinizde veya özel etkinlikleri kullanan bir işlev dağıttığınızda, Firebase otomatik olarak us-central1 bölgesinde firebase adlı bir varsayılan kanal oluşturur. Firebase Admin SDK, kanallarda yayınlama için bir eventarc alt paketi sağlar.

Varsayılan kanalı kullanarak güvenilir bir sunucudan (veya başka bir işlevden) etkinlik yayınlamak için:

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, varsayılan kanalı otomatik olarak oluşturmanın yanı sıra etkinliğin kaynağını belirten EVENTARC_CLOUD_EVENT_SOURCE ortam değişkenini de ayarlar. Cloud Functions for Firebase dışında etkinlik yayınlıyorsanız etkinlik yüküne source alanını açıkça eklemeniz gerekir.

Özel etkinlikleri işleme

Uzantı etkinlikleri dahil tüm özel etkinlikleri onCustomEventPublished veya on_custom_event_published işleyicileriyle işleyebilirsiniz. İlk olarak, bu işleyiciyi Firebase Admin SDK ile birlikte Eventarc SDK'sından içe aktarın:

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

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

İşlev kodunuzda, etkinlik adını örnek işlevde gösterildiği gibi iletin:

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

Her bir uzantı için etkinlik nesnesinde döndürülen yük, uygulama akışınıza özel mantık uygulamak amacıyla kullanabileceğiniz verileri sağlar. Bu durumda işlev, yeniden boyutlandırılan resimle ilgili meta verileri Cloud Firestore'daki bir koleksiyona kopyalamak için Yönetici SDK'sını kullanır. Dosya adını etkinlik tarafından sağlanan subject kaynağından alır ve etkinlik tarafından sağlanan data kaynağından meta verileri kaydeder.

Varsayılan olmayan kanallardaki etkinlikleri yayınlama ve işleme

Özel kanallar, özel izin gereksinimlerinizin veya başka gereksinimlerinizin olduğu ve tüm etkinlikler için aynı düzeyde görünürlük ve erişim istemediğiniz durumlarda yararlı olabilir. Google Cloud konsolunu kullanarak kendi kanallarınızı oluşturabilirsiniz. Etkinlik yayınlama ve etkinliklere abone olma aynı kanalda yapılmalıdır.

Özel bir etkinliğin varsayılan olmayan bir kanalda yayınlandığı durumlarda, işlev kodunuzda kanalı belirtmeniz gerekir. Örneğin, us-west1 konumu için varsayılan olmayan bir kanalda yayınlanan etkinlikleri işlemek istiyorsanız kanalı şu şekilde belirtmeniz gerekir:

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