Merge pull request #1013 from firebase/colerogers.remote-config

Adds v2 Remote Config Triggers

Author: colerogers

2nd-gen/remote-config-diff/README.md

@@ -0,0 +1,9 @@
+## Get the difference between the previous and current Remote Config templates.
+
+Use the Firebase Remote Config Cloud Function trigger to take action when your template is updated.
+
+This sample demonstrates how to use the Remote Config Cloud Function trigger to log the difference between the previous and current Remote Config templates.
+
+* See [eBay's real world implementation](https://github.com/eBay/firebase-remote-config-monitor).
+
+* See the [docs](https://firebase.google.com/docs/functions/rc-events) for more on Remote Config Triggers.

2nd-gen/remote-config-diff/firebase.json

@@ -0,0 +1 @@
+{}

2nd-gen/remote-config-diff/functions/.eslintrc.js

@@ -0,0 +1,14 @@
+module.exports = {
+  root: true,
+  env: {
+    es6: true,
+    node: true,
+  },
+  extends: [
+    "eslint:recommended",
+    "google",
+  ],
+  rules: {
+    quotes: ["error", "double"],
+  },
+};

2nd-gen/remote-config-diff/functions/index.js

@@ -0,0 +1,83 @@
+/**
+ * Copyright 2022 Google Inc. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+'use strict';
+
+// [START all]
+// [START import]
+// The Cloud Functions for Firebase SDK to create v2 Cloud Functions and set up triggers.
+const { onConfigUpdated } = require('firebase-functions/v2/remoteConfig');
+// The Firebase Admin SDK to obtain access tokens.
+const admin = require('firebase-admin');
+admin.initializeApp();
+const rp = require('request-promise');
+const jsonDiff = require('json-diff');
+// [END import]
+
+// [START showconfigdiff]
+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
+      functions.logger.log(diff);
+
+      return null;
+    }).catch(error => {
+      functions.logger.error(error);
+      return null;
+    });
+});
+// [END showconfigdiff]
+
+// [START getTemplate]
+function getTemplate(version, accessToken) {
+  const options = {
+    uri: 'https://firebaseremoteconfig.googleapis.com/v1/projects/remote-config-function/remoteConfig',
+    qs: {
+      versionNumber: version
+    },
+    headers: {
+        Authorization: 'Bearer ' + accessToken
+    },
+    json: true // Automatically parses the JSON string in the response
+  };
+  
+  // Obtain the template from the rest API
+  return rp(options).then(resp => {
+    return Promise.resolve(resp);
+  }).catch(err => {
+    functions.logger.error(err);
+    return Promise.resolve(null);
+  });
+}
+// [START getTemplate]
+// [END all]

2nd-gen/remote-config-diff/functions/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "remote-config-diff",
+  "description": "Get the difference between the previous and current Remote Config template",
+  "scripts": {
+    "lint": "eslint .",
+    "serve": "firebase emulators:start --only functions",
+    "shell": "firebase functions:shell",
+    "start": "npm run shell",
+    "deploy": "firebase deploy --only functions",
+    "logs": "firebase functions:log",
+    "compile": "cp ../../../tsconfig.template.json ./tsconfig-compile.json && tsc --project tsconfig-compile.json"
+  },
+  "dependencies": {
+    "firebase-admin": "^10.2.0",
+    "firebase-functions": "^4.0.0",
+    "json-diff": "^0.5.4",
+    "request": "^2.88.2",
+    "request-promise": "^4.2.5"
+  },
+  "devDependencies": {
+    "eslint": "^6.8.0",
+    "eslint-plugin-promise": "^4.2.1"
+  },
+  "engines": {
+    "node": "16"
+  },
+  "private": true
+}