Firebase Remote Config Functions SDK Integration (#215)

Adds a Remote Config event handler `firebase.remoteconfig.onUpdate()` that will be triggered whenever a Remote Config project is updated (i.e., when a publish or rollback occurs).

The event handler takes in a `TemplateVersion` object as an argument, which contains metadata about the last update that affected a Remote Config project.

The PR also contains corresponding unit test and integration tests. The integration test makes use of the Remote Config REST API: https://firebase.google.com/docs/remote-config/use-config-rest.

Author: clp93

integration_test/functions/src/index.ts

@@ -11,6 +11,7 @@ export * from './database-tests';
 export * from './auth-tests';
 export * from './firestore-tests';
 export * from './https-tests';
+export * from './remoteConfig-tests';
 const numTests = Object.keys(exports).length; // Assumption: every exported function is its own test.
 
 import 'firebase-functions'; // temporary shim until process.env.FIREBASE_CONFIG available natively in GCF(BUG 63586213)
@@ -86,6 +87,26 @@ export const integrationTests: any = functions
         .collection('tests')
         .doc(testId)
         .set({ test: testId }),
+      // A Remote Config update to trigger the Remote Config tests.
+      admin.credential
+        .applicationDefault()
+        .getAccessToken()
+        .then((accessToken) => {
+          const options = {
+            hostname: 'firebaseremoteconfig.googleapis.com',
+            path: `/v1/projects/${firebaseConfig.projectId}/remoteConfig`,
+            method: 'PUT',
+            headers: {
+              Authorization: 'Bearer ' + accessToken.access_token,
+              'Content-Type': 'application/json; UTF-8',
+              'Accept-Encoding': 'gzip',
+              'If-Match': '*',
+            },
+          };
+          const request = https.request(options, resp => {});
+          request.write(JSON.stringify({ version: { description: testId } }));
+          request.end();
+        }),
       // Invoke a callable HTTPS trigger.
       callHttpsTrigger('callableTests', { foo: 'bar', testId }),
     ])

integration_test/functions/src/remoteConfig-tests.ts

@@ -0,0 +1,29 @@
+import * as functions from 'firebase-functions';
+import { TestSuite, expectEq } from './testing';
+import TemplateVersion = functions.remoteConfig.TemplateVersion;
+
+export const remoteConfigTests: any = functions.remoteConfig.onUpdate(
+  (v, c) => {
+    return new TestSuite<TemplateVersion>('remoteConfig onUpdate')
+      .it('should have a project as resource', (version, context) =>
+        expectEq(
+          context.resource.name,
+          `projects/${process.env.GCLOUD_PROJECT}`
+        )
+      )
+
+      .it('should have the correct eventType', (version, context) =>
+        expectEq(context.eventType, 'google.firebase.remoteconfig.update')
+      )
+
+      .it('should have an eventId', (version, context) => context.eventId)
+
+      .it('should have a timestamp', (version, context) => context.timestamp)
+
+      .it('should not have auth', (version, context) =>
+        expectEq((context as any).auth, undefined)
+      )
+
+      .run(v.description, v, c);
+  }
+);

integration_test/run_tests.sh

@@ -51,7 +51,7 @@ function delete_all_functions {
   cd $DIR
   # Try to delete, if there are errors it is because the project is already empty,
   # in that case do nothing. 
-  firebase functions:delete callableTests createUserTests databaseTests deleteUserTests firestoreTests integrationTests pubsubTests --project=$PROJECT_ID -f || :
+  firebase functions:delete callableTests createUserTests databaseTests deleteUserTests firestoreTests integrationTests pubsubTests remoteConfigTests --project=$PROJECT_ID -f || :
   announce "Project emptied."
 }
 

spec/index.spec.ts

@@ -40,5 +40,6 @@ import './providers/database.spec';
 import './providers/firestore.spec';
 import './providers/https.spec';
 import './providers/pubsub.spec';
+import './providers/remoteConfig.spec';
 import './providers/storage.spec';
 import './providers/crashlytics.spec';

spec/providers/remoteConfig.spec.ts

@@ -0,0 +1,128 @@
+// The MIT License (MIT)
+//
+// Copyright (c) 2017 Firebase
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+import { expect } from 'chai';
+import * as admin from 'firebase-admin';
+import * as _ from 'lodash';
+
+import { CloudFunction } from '../../src/cloud-functions';
+import * as functions from '../../src/index';
+import * as remoteConfig from '../../src/providers/remoteConfig';
+
+describe('RemoteConfig Functions', () => {
+  function constructVersion() {
+    return {
+      versionNumber: 1,
+      updateTime: '2017-07-02T18:48:58.920638Z',
+      updateUser: {
+        name: 'Foo Bar',
+        email: '[email protected]',
+      },
+      description: 'test description',
+      updateOrigin: 'CONSOLE',
+      updateType: 'INCREMENTAL_UPDATE',
+    };
+  }
+
+  function makeEvent(data: any, context?: { [key: string]: any }) {
+    context = context || {};
+    return {
+      data: data,
+      context: _.merge(
+        {
+          eventId: '123',
+          timestamp: '2018-07-03T00:49:04.264Z',
+          eventType: 'google.firebase.remoteconfig.update',
+          resource: {
+            name: 'projects/project1',
+            service: 'service',
+          },
+        },
+        context
+      ),
+    };
+  }
+
+  describe('#onUpdate', () => {
+    function expectedTrigger() {
+      return {
+        eventTrigger: {
+          resource: 'projects/project1',
+          eventType: 'google.firebase.remoteconfig.update',
+          service: 'firebaseremoteconfig.googleapis.com',
+        },
+      };
+    }
+
+    before(() => {
+      process.env.GCLOUD_PROJECT = 'project1';
+    });
+
+    after(() => {
+      delete process.env.GCLOUD_PROJECT;
+    });
+
+    it('should have the correct trigger', () => {
+      const cloudFunction = remoteConfig.onUpdate(() => null);
+      expect(cloudFunction.__trigger).to.deep.equal(expectedTrigger());
+    });
+
+    it('should allow both region and runtime options to be set', () => {
+      const cloudFunction = functions
+        .region('my-region')
+        .runWith({
+          timeoutSeconds: 90,
+          memory: '256MB',
+        })
+        .remoteConfig.onUpdate(() => null);
+
+      expect(cloudFunction.__trigger.regions).to.deep.equal(['my-region']);
+      expect(cloudFunction.__trigger.availableMemoryMb).to.deep.equal(256);
+      expect(cloudFunction.__trigger.timeout).to.deep.equal('90s');
+    });
+  });
+
+  describe('unwraps TemplateVersion', () => {
+    let cloudFunctionUpdate: CloudFunction<remoteConfig.TemplateVersion>;
+    let event: any;
+    before(() => {
+      process.env.GCLOUD_PROJECT = 'project1';
+      cloudFunctionUpdate = remoteConfig.onUpdate(
+        (version: remoteConfig.TemplateVersion) => version
+      );
+      event = {
+        data: constructVersion(),
+      };
+    });
+
+    after(() => {
+      delete process.env.GCLOUD_PROJECT;
+    });
+
+    it('should unwrap the version in the event', () => {
+      return Promise.all([
+        cloudFunctionUpdate(event).then((data: any) => {
+          expect(data).to.deep.equal(constructVersion());
+        }),
+      ]);
+    });
+  });
+});

src/function-builder.ts

@@ -30,8 +30,9 @@ import * as database from './providers/database';
 import * as firestore from './providers/firestore';
 import * as https from './providers/https';
 import * as pubsub from './providers/pubsub';
+import * as remoteConfig from './providers/remoteConfig';
 import * as storage from './providers/storage';
-import { HttpsFunction } from './cloud-functions';
+import { CloudFunction, EventContext, HttpsFunction } from './cloud-functions';
 
 /**
  * Configure the regions that the function is deployed to.
@@ -212,6 +213,26 @@ export class FunctionBuilder {
     };
   }
 
+  get remoteConfig() {
+    return {
+      /**
+       * Handle all updates (including rollbacks) that affect a Remote Config
+       * project.
+       * @param handler A function that takes the updated Remote Config template
+       * version metadata as an argument.
+       */
+      onUpdate: (
+        handler: (
+          version: remoteConfig.TemplateVersion,
+          context: EventContext
+        ) => PromiseLike<any> | any
+      ) =>
+        remoteConfig._onUpdateWithOpts(handler, this.options) as CloudFunction<
+          remoteConfig.TemplateVersion
+        >,
+    };
+  }
+
   get storage() {
     return {
       /**

src/index.ts

@@ -29,6 +29,7 @@ import * as database from './providers/database';
 import * as firestore from './providers/firestore';
 import * as https from './providers/https';
 import * as pubsub from './providers/pubsub';
+import * as remoteConfig from './providers/remoteConfig';
 import * as storage from './providers/storage';
 import { firebaseConfig } from './config';
 
@@ -40,6 +41,7 @@ export {
   firestore,
   https,
   pubsub,
+  remoteConfig,
   storage,
 };
 

src/providers/remoteConfig.ts

@@ -0,0 +1,107 @@
+// The MIT License (MIT)
+//
+// Copyright (c) 2018 Firebase
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the 'Software'), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+// SOFTWARE.
+
+import * as _ from 'lodash';
+
+import {
+  CloudFunction,
+  Event,
+  EventContext,
+  makeCloudFunction,
+} from '../cloud-functions';
+import { DeploymentOptions } from '../function-builder';
+
+/** @internal */
+export const provider = 'google.firebase.remoteconfig';
+/** @internal */
+export const service = 'firebaseremoteconfig.googleapis.com';
+
+/**
+ * Handle all updates (including rollbacks) that affect a Remote Config project.
+ * @param handler A function that takes the updated Remote Config template
+ * version metadata as an argument.
+ */
+export function onUpdate(
+  handler: (
+    version: TemplateVersion,
+    context: EventContext
+  ) => PromiseLike<any> | any
+): CloudFunction<TemplateVersion> {
+  return _onUpdateWithOpts(handler, {});
+}
+
+/** @internal */
+export function _onUpdateWithOpts(
+  handler: (
+    version: TemplateVersion,
+    context: EventContext
+  ) => PromiseLike<any> | any,
+  opts: DeploymentOptions
+): CloudFunction<TemplateVersion> {
+  if (!process.env.GCLOUD_PROJECT) {
+    throw new Error('process.env.GCLOUD_PROJECT is not set.');
+  }
+  return makeCloudFunction({
+    handler,
+    provider,
+    service,
+    triggerResource: () => `projects/${process.env.GCLOUD_PROJECT}`,
+    eventType: 'update',
+    opts: opts,
+  });
+}
+
+/**
+ * Interface representing a Remote Config template version metadata object that
+ * was emitted when the project was updated.
+ */
+export interface TemplateVersion {
+  /** The version number of the updated Remote Config template. */
+  versionNumber: number;
+
+  /** When the template was updated in format (ISO8601 timestamp). */
+  updateTime: string;
+
+  /** Metadata about the account that performed the update. */
+  updateUser: RemoteConfigUser;
+
+  /** A description associated with the particular Remote Config template. */
+  description: string;
+
+  /** The origin of the caller. */
+  updateOrigin: string;
+
+  /** The type of update action that was performed. */
+  updateType: string;
+
+  /**
+   * The version number of the Remote Config template that was rolled back to,
+   * if the update was a rollback.
+   */
+  rollbackSource?: number;
+}
+
+export interface RemoteConfigUser {
+  name?: string;
+  email: string;
+  imageUrl?: string;
+}