Vous pouvez permettre aux utilisateurs qui installent votre extension d'insérer leur propre logique personnalisée dans l'exécution de votre extension. Pour ce faire, deux méthodes sont possibles :
Événements Eventarc : pour permettre aux utilisateurs de réagir de manière asynchrone aux événements, vous pouvez publier sur Eventarc. Les utilisateurs peuvent déployer des fonctions de gestionnaire d'événements qui, par exemple, envoient des notifications une fois les tâches de longue durée terminées, ou ils peuvent définir leurs propres fonctions de post-traitement.
Crochets synchrones : pour permettre aux utilisateurs d'ajouter une logique de blocage à votre extension, vous pouvez ajouter des crochets synchrones à des points prédéfinis du fonctionnement de l'extension. À ces points, vous exécutez une fonction de fournisseur d'utilisateur et ne poursuivez que lorsqu'elle est terminée. Les tâches de prétraitement entrent souvent dans cette catégorie.
Une extension peut utiliser l'une ou l'autre de ces méthodes, ou les deux.
Événements Eventarc
Pour publier des événements à partir d'une extension :
Déclarez les types d'événements que vous allez publier dans le fichier
extension.yaml:events: - type: publisher-id.extension-name.version.event-name description: event-description - type: publisher-id.extension-name.version.another-event-name description: another-event-descriptionL'identifiant
typeest composé de plusieurs champs séparés par des points. Les champs ID d'éditeur, nom de l'extension et nom de l'événement sont obligatoires. Le champ "version" est recommandé. Choisissez un nom d'événement unique et descriptif pour chaque type d'événement que vous publiez.Par exemple, l'extension
storage-resize-imagesdéclare un seul type d'événement :events: - type: firebase.extensions.storage-resize-images.v1.complete description: | Occurs when image resizing completes. The event will contain further details about specific formats and sizes.Les utilisateurs pourront choisir les événements auxquels s'abonner lorsqu'ils installeront l'extension.
Dans les fonctions d'extension, importez l'API Eventarc à partir de Admin SDK et initialisez un canal d'événements à l'aide des paramètres d'installation de l'utilisateur. Ces paramètres sont exposés à l'aide des variables d'environnement suivantes :
EVENTARC_CHANNEL: nom complet du canal Eventarc sur lequel l'utilisateur a choisi de publier des événements.EXT_SELECTED_EVENTS: liste des types d'événements que l'utilisateur a choisi de publier, séparés par une virgule. Lorsque vous initialisez un canal avec cette valeur, le SDK Admin filtre automatiquement les événements que l'utilisateur n'a pas sélectionnés.EVENTARC_CLOUD_EVENT_SOURCE: identifiant de la source Cloud Events. Le SDK Admin transmet automatiquement cette valeur dans le champsourcedes événements publiés. Vous n'avez généralement pas besoin d'utiliser explicitement cette variable.
Si les événements n'ont pas été activés lors de l'installation, ces variables seront indéfinies. Vous pouvez utiliser ce fait pour initialiser un canal d'événements uniquement lorsque les événements sont activés :
import * as admin from "firebase-admin"; import {getEventarc} from 'firebase-admin/eventarc'; admin.initializeApp(); // Set eventChannel to a newly-initialized channel, or `undefined` if events // aren't enabled. const eventChannel = process.env.EVENTARC_CHANNEL && getEventarc().channel(process.env.EVENTARC_CHANNEL, { allowedEventTypes: process.env.EXT_SELECTED_EVENTS, });Publiez des événements sur la chaîne aux points de votre extension que vous souhaitez exposer aux utilisateurs. Exemple :
// If events are enabled, publish a `complete` event to the configured // channel. eventChannel && eventChannel.publish({ type: 'firebase.extensions.storage-resize-images.v1.complete', subject: filename, // the name of the original file data: { // ... } });Documentez les événements que vous publiez dans le fichier PREINSTALL ou POSTINSTALL.
Pour chaque événement, documentez les points suivants :
- sa finalité prévue ;
- Point de la logique de votre extension où elle s'exécute
- les données de sortie qu'il inclut ;
- les conditions de son exécution ;
Avertissez également les utilisateurs de ne pas effectuer d'actions dans leurs gestionnaires d'événements qui pourraient déclencher la même extension, ce qui entraînerait une boucle infinie.
Lorsque vous publiez des événements à partir d'une extension, les utilisateurs peuvent déployer des gestionnaires d'événements pour répondre avec une logique personnalisée.
Par exemple, l'exemple suivant supprime l'image d'origine après son redimensionnement. Notez que ce gestionnaire d'exemple utilise la propriété subject de l'événement, qui correspond dans ce cas au nom de fichier d'origine de l'image.
exports.onimageresized = onCustomEventPublished(
"firebase.extensions.storage-resize-images.v1.complete",
(event) => {
logger.info("Received image resize completed event", event);
// For example, delete the original.
return admin.storage()
.bucket("my-project.firebasestorage.app")
.file(event.subject)
.delete();
});
Pour en savoir plus, consultez Déclencheurs d'événements personnalisés.
Exemple
L'extension officielle Resize Images fournit un crochet asynchrone en publiant sur Eventarc après le redimensionnement d'une image.
Hooks synchrones
Utilisez des crochets synchrones lorsque vous souhaitez fournir aux utilisateurs un crochet qui doit se terminer correctement pour que l'une de vos fonctions d'extension fonctionne.
Un crochet synchrone appelle une fonction Cloud appelable HTTPS définie par l'utilisateur et attend la fin de l'exécution (éventuellement avec une valeur renvoyée) avant de continuer. Une erreur dans la fonction fournie par l'utilisateur entraîne une erreur dans la fonction d'extension.
Pour exposer un crochet synchrone :
Ajoutez un paramètre à votre extension pour permettre aux utilisateurs de la configurer avec l'URL de leur fonction Cloud personnalisée. Exemple :
- param: PREPROCESSING_FUNCTION label: Pre-processing function URL description: > An HTTPS callable function that will be called to transform the input data before it is processed by this function. type: string example: https://us-west1-my-project-id.cloudfunctions.net/preprocessData required: falseAu point de votre extension où vous souhaitez exposer le crochet, appelez la fonction à l'aide de son URL. Exemple :
const functions = require('firebase-functions/v1'); const fetch = require('node-fetch'); const preprocessFunctionURL = process.env.PREPROCESSING_FUNCTION; exports.yourFunctionName = functions.firestore.document("collection/{doc_id}") .onWrite((change, context) => { // PREPROCESSING_FUNCTION hook begins here. // If a preprocessing function is defined, call it before continuing. if (preprocessFunctionURL) { try { await fetch(preprocessFunctionURL); // Could also be a POST request if you want to send data. } catch (e) { // Preprocessing failure causes the function to fail. functions.logger.error("Preprocessor error:", e); return; } } // End of PREPROCESSING_FUNCTION hook. // Main function logic follows. // ... });Documentez tous les hooks que vous mettez à disposition dans le fichier PREINSTALL ou POSTINSTALL.
Pour chaque hook, documentez les points suivants :
- sa finalité prévue ;
- Point de la logique de votre extension où elle s'exécute
- Ses entrées et sorties attendues
- les conditions (ou options) de son exécution.
Avertissez également les utilisateurs de ne pas effectuer d'actions dans la fonction de crochet qui pourraient déclencher la même extension, ce qui entraînerait une boucle infinie.
Exemple
L'extension Algolia Search fournit un crochet synchrone pour appeler une fonction de transformation fournie par l'utilisateur avant l'écriture dans Algolia.