Déclencheurs Remote Config

Vous pouvez déclencher une fonction en réponse à des événements Firebase Remote Config, y compris la publication d'une nouvelle version de configuration ou le rétablissement d'une ancienne version. Ce guide explique comment créer une fonction d'arrière-plan Remote Config qui effectue une comparaison de deux versions de modèle.

Déclencher une fonction Remote Config

Pour déclencher une fonction Remote Config, commencez par importer les modules requis:

Node.js

 // The Cloud Functions for Firebase SDK to set up triggers and logging.
const {onConfigUpdated} = require("firebase-functions/v2/remoteConfig");
const logger = require("firebase-functions/logger");
// The Firebase Admin SDK to obtain access tokens.
const admin = require("firebase-admin");
const app = admin.initializeApp();
const fetch = require("node-fetch");
const jsonDiff = require("json-diff");index.js

Python

 # The Cloud Functions for Firebase SDK to set up triggers and logging.
from firebase_functions import remote_config_fn

# The Firebase Admin SDK to obtain access tokens.
import firebase_admin

app = firebase_admin.initialize_app()

import deepdiff
import requestsmain.py

Définissez ensuite un gestionnaire pour l'événement de mise à jour. L'objet d'événement transmis à cette fonction contient des métadonnées sur une mise à jour de modèle, telles que le nouveau numéro de version et l'heure de la mise à jour. Vous pouvez également récupérer l'adresse e-mail de l'utilisateur qui a effectué la mise à jour, avec son nom et une image, le cas échéant.

Voici un exemple de fonction Remote Config qui consigne une différence entre chaque version mise à jour et la version qu'elle a remplacée. La fonction examine le champ de numéro de version de l'objet modèle et récupère la version actuelle (nouvellement mise à jour) ainsi que la version un numéro inférieur:

Node.js

 exports.showconfigdiff = onConfigUpdated(async (event) => {
  try {
    // Obtain the access token from the Admin SDK
    const accessTokenObj = await admin.credential.applicationDefault()
        .getAccessToken();
    const accessToken = accessTokenObj.access_token;

    // Get the version number from the event object
    const remoteConfigApi = "https://firebaseremoteconfig.googleapis.com/v1/" +
        `projects/${app.options.projectId}/remoteConfig`;
    const currentVersion = event.data.versionNumber;
    const prevVersion = currentVersion - 1;
    const templatePromises = [];
    templatePromises.push(fetch(
        remoteConfigApi,
        {
          method: "POST",
          body: new URLSearchParams([["versionNumber", currentVersion + ""]]),
          headers: {Authorization: "Bearer " + accessToken},
        },
    ));
    templatePromises.push(fetch(
        remoteConfigApi,
        {
          method: "POST",
          body: new URLSearchParams([["versionNumber", prevVersion + ""]]),
          headers: {Authorization: "Bearer " + accessToken},
        },
    ));

    // Get the templates
    const responses = await Promise.all(templatePromises);
    const results = responses.map((r) => r.json());
    const currentTemplate = results[0];
    const previousTemplate = results[1];
    // Figure out the differences of the templates
    const diff = jsonDiff.diffString(previousTemplate, currentTemplate);
    // Log the difference
    logger.log(diff);
  } catch (error) {
    logger.error(error);
  }
});index.js

Cet exemple utilise les modules json-diff et request-promise pour créer la différence et créer la requête afin d'obtenir l'objet de modèle.

Python

 @remote_config_fn.on_config_updated()
def showconfigdiff(event: remote_config_fn.CloudEvent[remote_config_fn.ConfigUpdateData]) -> None:
    """Log the diff of the most recent Remote Config template change."""

    # Obtain an access token from the Admin SDK
    access_token = app.credential.get_access_token().access_token

    # Get the version number from the event object
    current_version = int(event.data.version_number)

    # Figure out the differences between templates
    remote_config_api = ("https://firebaseremoteconfig.googleapis.com/v1/"
                         f"projects/{app.project_id}/remoteConfig")
    current_template = requests.get(remote_config_api,
                                    params={"versionNumber": current_version},
                                    headers={"Authorization": f"Bearer {access_token}"})
    previous_template = requests.get(remote_config_api,
                                     params={"versionNumber": current_version - 1},
                                     headers={"Authorization": f"Bearer {access_token}"})
    diff = deepdiff.DeepDiff(previous_template, current_template)

    # Log the difference
    print(diff.pretty())main.py

Cet exemple utilise deepdiff pour créer la différence et requests pour créer et envoyer la requête afin d'obtenir l'objet de modèle.