Rozszerz zdalną konfigurację za pomocą Cloud Functions


Funkcję możesz wywołać w odpowiedzi na zdarzenia Remote Config, w tym na publikację nowej wersji konfiguracji lub wycofanie starszej wersji. Z tego przewodnika dowiesz się, jak utworzyć funkcję Remote Config działającą w tle, która porównuje 2 wersje szablonu.

Aktywowanie funkcji Remote Config

Aby wywołać funkcję Remote Config, najpierw zaimportuj wymagane moduły:

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

Następnie zdefiniuj moduł obsługi zdarzenia aktualizacji. Obiekt zdarzenia przekazany do tej funkcji zawiera metadane dotyczące aktualizacji szablonu, takie jak nowy numer wersji i czas aktualizacji. Możesz też pobrać adres e-mail użytkownika, który wprowadził zmianę, wraz z nazwą i obrazem (jeśli jest dostępny).

Oto przykład funkcji Remote Config, która rejestruje różnice między każdą zaktualizowaną wersją a wersją, którą zastąpiła. Funkcja sprawdza pole numer wersji obiektu szablonu i pobiera bieżącą (nowo zaktualizowaną) wersję wraz z wersją o jeden numer niższą:

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

Ten przykład używa modułów json-diff i request-promise do tworzenia różnic i tworzenia żądania w celu uzyskania obiektu szablonu.

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

W tym przykładzie użyto funkcji deepdiff do tworzenia różnic, a funkcji requests do tworzenia i wysyłania żądania pobierania obiektu szablonu.