טריגרים של הגדרת תצורה מרחוק

אפשר להפעיל פונקציה בתגובה לאירועים של Firebase Remote Config, כולל פרסום של גרסת הגדרה חדשה או חזרה לגרסה ישנה יותר. במדריך הזה מוסבר איך ליצור פונקציית רקע Remote Config שמבצעת השוואה בין שתי גרסאות של תבנית.

הפעלת פונקציית Remote Config

כדי להפעיל פונקציה של Remote Config, קודם מייבאים את המודולים הנדרשים:

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

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

לאחר מכן מגדירים handler לאירוע העדכון. אובייקט האירוע שמועבר לפונקציה הזו מכיל מטא-נתונים על עדכון של תבנית, כמו מספר הגרסה החדשה ושעת העדכון. אפשר גם לאחזר את האימייל של המשתמש שביצע את העדכון, עם השם ותמונה אם יש.

דוגמה לפונקציה Remote Config שמתעדת את ההבדלים בין כל גרסה מעודכנת לבין הגרסה שהיא החליפה. הפונקציה בודקת את השדה של מספר הגרסה של אובייקט התבנית ומאחזרת את הגרסה הנוכחית (המעודכנת) יחד עם הגרסה הקודמת:

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

בדוגמה הזו נעשה שימוש במודולים 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 כדי ליצור ולשלוח את הבקשה לקבלת אובייקט התבנית.