Remote Config tetikleyicileri

Yeni bir yapılandırma sürümünün yayınlanması veya eski bir sürüme geri dönülmesi gibi Firebase Remote Config etkinliklerine yanıt olarak bir işlevi tetikleyebilirsiniz. Bu kılavuzda, iki şablon sürümü arasında fark işlemi gerçekleştiren bir Remote Config arka plan işlevinin nasıl oluşturulacağı açıklanmaktadır.

Remote Config işlevini tetikleme

Bir Remote Config işlevini tetiklemek için önce gerekli modülleri içe aktarın:

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

Ardından, güncelleme etkinliği için bir işleyici tanımlayın. Bu işleve iletilen etkinlik nesnesi, şablon güncellemesiyle ilgili meta veriler (ör. yeni sürüm numarası ve güncelleme zamanı) içerir. Ayrıca, güncellemeyi yapan kullanıcının e-posta adresini, adını ve varsa resmini de alabilirsiniz.

Aşağıda, güncellenen her sürümün ve değiştirilen sürümün farkını günlüğe kaydeden bir Remote Config işlevi örneği verilmiştir. İşlev, şablon nesnesinin sürüm numarası alanını inceler ve mevcut (yeni güncellenen) sürümü, bir alt sürüm numarasıyla birlikte alır:

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);
  }
});

Bu örnekte, farkı oluşturmak ve şablon nesnesini alma isteğini oluşturmak için json-diff ve request-promise modülleri kullanılır.

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

Bu örnekte, farkı oluşturmak için deepdiff, şablon nesnesini almak üzere isteği oluşturup göndermek için ise requests kullanılır.