新しいバージョンの構成の公開、古いバージョンへのロールバックなどの Firebase Remote Config イベントに応答して、関数をトリガーできます。このガイドでは、テンプレートの 2 つのバージョンの差分を調べる Remote Config バックグラウンド関数の作成方法について説明します。
Remote Config 関数のトリガー
Remote Config 関数をトリガーするには、firebase-functions/v2/remoteConfig
サブパッケージを使用します。このガイドに示されている方法でテンプレートの更新に応答するには、onConfigUpdated
関数を他の必要なコンポーネント(Firebase Admin SDK など)と一緒にインポートして使用します。
// 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"); admin.initializeApp(); const fetch = require("node-fetch"); const jsonDiff = require("json-diff");
onConfigUpdated
から返される TemplateVersion
オブジェクトには、バージョン番号や更新時刻など、テンプレート更新に関する重要なメタデータ フィールドが含まれています。更新を行ったユーザーの名前や画像が提供されている場合は、それらを使ってメールを取得することもできます.
次に、更新後のバージョンと更新前のバージョンの差分を返す Remote Config 関数の例を示します。この関数はテンプレート オブジェクトの versionNumber
フィールドを調べて、最新の(更新された)バージョンとその 1 つ前のバージョンを取得します。
exports.showconfigdiff = onConfigUpdated((event) => { // Obtain the access token from the admin SDK return admin.credential.applicationDefault().getAccessToken() .then((accessTokenObj) => { return accessTokenObj.access_token; }) .then((accessToken) => { // Get the version number from the event object const currentVersion = event.data.versionNumber; const templatePromises = []; templatePromises.push(getTemplate(currentVersion, accessToken)); templatePromises.push(getTemplate(currentVersion - 1, accessToken)); // Get the templates return Promise.all(templatePromises); }) .then((results) => { 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); return null; }).catch((error) => { logger.error(error); return null; }); });
このサンプルでは json-diff
モジュールと request-promise
モジュールを使用して差分を作成し、テンプレート オブジェクトの取得リクエストを作成します。Remote Config のクライアント ロジックと Firebase Cloud Messaging が組み込まれた第 1 世代の関数の例については、Remote Config の更新をリアルタイムで伝播するをご覧ください。