Триггеры Remote Config

Функцию можно запустить в ответ на Firebase Remote Config, например публикацию новой версии конфигурации или откат к более ранней версии. В этом руководстве рассказывается, как создать фоновую функцию Remote Config, которая сравнивает две версии шаблона.

Как запустить функцию Remote Config

Чтобы запустить функцию Remote Config, сначала импортируйте необходимые модули:

Node.js

 const {URL, URLSearchParams} = require("node:url");
// The Cloud Functions for Firebase SDK to set up triggers and logging.
const {onConfigUpdated} = require("firebase-functions/remoteConfig");
const {requiresRole, requiresAPI} = require("firebase-functions");
const logger = require("firebase-functions/logger");
// The Firebase Admin SDK to obtain access tokens.
const {initializeApp, applicationDefault} = require("firebase-admin/app");
initializeApp();
const jsonDiff = require("json-diff");

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

Затем определите обработчик для события обновления. Объект события, переданный этой функции, содержит метаданные об обновлении шаблона, например номер новой версии и время обновления. Вы также можете получить адрес электронной почты пользователя, который внес изменения, а также его имя и изображение, если оно доступно.

Ниже приведен пример функции Remote Config, которая регистрирует разницу между каждой обновленной версией и версией, которую она заменила. Функция проверяет поле номера версии объекта шаблона и извлекает текущую (обновленную) версию вместе с версией, номер которой на единицу меньше:

Node.js

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

    // Get the version number from the event object
    const remoteConfigApi = new URL(
        `https://firebaseremoteconfig.googleapis.com/v1/projects/${process.env.GCLOUD_PROJECT}/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 = await Promise.all(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);
  }
});

В этом примере используются модули json-diff и request-promise, чтобы создать разницу и запрос для получения объекта шаблона.

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())

В этом примере для создания различий используется deepdiff, а для создания и отправки запроса на получение объекта шаблона – requests.