Support Node 8 Google Cloud Functions Runtime (firebase#203)

Author: laurenzlong

integration_test/functions/package.json

@@ -5,16 +5,20 @@
     "build": "./node_modules/.bin/tsc"
   },
   "dependencies": {
-    "@google-cloud/pubsub": "^0.6.0",
-    "@types/lodash": "^4.14.41",
-    "firebase": "^4.9.1",
+    "@google-cloud/pubsub": "~0.19.0",
+    "@types/google-cloud__pubsub": "^0.18.0",
+    "@types/lodash": "~4.14.41",
+    "firebase": "~5.2.0",
     "firebase-admin": "~5.12.1",
     "firebase-functions": "./firebase-functions.tgz",
-    "lodash": "^4.17.2"
+    "lodash": "~4.17.2"
   },
   "main": "lib/index.js",
   "devDependencies": {
     "typescript": "~2.8.3"
   },
+  "engines": {
+    "node": "8"
+  },
   "private": true
 }

integration_test/functions/src/index.ts

@@ -4,6 +4,9 @@ import * as https from 'https';
 import * as admin from 'firebase-admin';
 import { Request, Response } from 'express';
 
+import * as PubSub from '@google-cloud/pubsub';
+const pubsub = PubSub();
+
 export * from './pubsub-tests';
 export * from './database-tests';
 export * from './auth-tests';
@@ -14,7 +17,6 @@ const numTests = Object.keys(exports).length; // Assumption: every exported func
 import 'firebase-functions'; // temporary shim until process.env.FIREBASE_CONFIG available natively in GCF(BUG 63586213)
 const firebaseConfig = JSON.parse(process.env.FIREBASE_CONFIG);
 firebase.initializeApp(firebaseConfig);
-console.log('initializing admin');
 admin.initializeApp();
 
 // TODO(klimt): Get rid of this once the JS client SDK supports callable triggers.
@@ -45,22 +47,22 @@ function callHttpsTrigger(name: string, data: any) {
 
 export const integrationTests: any = functions.https.onRequest(
   (req: Request, resp: Response) => {
-    let pubsub: any = require('@google-cloud/pubsub')();
-
     const testId = firebase
       .database()
       .ref()
       .push().key;
     return Promise.all([
       // A database write to trigger the Firebase Realtime Database tests.
-      // The database write happens without admin privileges, so that the triggered function's "event.data.ref" also
-      // doesn't have admin privileges.
+      // The database write happens without admin privileges.
       firebase
         .database()
         .ref(`dbTests/${testId}/start`)
         .set({ '.sv': 'timestamp' }),
       // A Pub/Sub publish to trigger the Cloud Pub/Sub tests.
-      pubsub.topic('pubsubTests').publish({ testId }),
+      pubsub
+        .topic('pubsubTests')
+        .publisher()
+        .publish(Buffer.from(JSON.stringify({ testId }))),
       // A user creation to trigger the Firebase Auth user creation tests.
       admin
         .auth()

integration_test/functions/tsconfig.json

@@ -1,6 +1,6 @@
 {
   "compilerOptions": {
-    "lib": ["es6"],
+    "lib": ["es6", "dom"],
     "module": "commonjs",
     "target": "es6",
     "noImplicitAny": false,

package.json

@@ -7,12 +7,11 @@
     "build": "node_modules/.bin/tsc -p tsconfig.release.json",
     "build:pack": "rm -rf lib && npm install && node_modules/.bin/tsc -p tsconfig.release.json && npm pack",
     "build:release": "npm install --production && npm install typescript firebase-admin && node_modules/.bin/tsc -p tsconfig.release.json",
-    "lint": "node_modules/.bin/tslint src/{**/*,*}.ts spec/{**/*,*}.ts integration_test/functions/src/{**/*,*}.ts",
     "format": "prettier --write '**/*.ts'",
     "pretest": "node_modules/.bin/tsc && cp -r spec/fixtures .tmp/spec",
     "test": "npm run mocha",
     "mocha": "mocha .tmp/spec/index.spec.js",
-    "posttest": "npm run lint && rm -rf .tmp",
+    "posttest": "npm run format && rm -rf .tmp",
     "postinstall": "node ./upgrade-warning"
   },
   "repository": {
@@ -48,8 +47,7 @@
     "nock": "^9.0.0",
     "prettier": "^1.13.7",
     "sinon": "^1.17.4",
-    "typescript": "~2.8.3",
-    "tslint": "^3.15.1"
+    "typescript": "~2.8.3"
   },
   "peerDependencies": {
     "firebase-admin": "~5.12.1"

spec/cloud-functions.spec.ts

@@ -38,10 +38,17 @@ describe('makeCloudFunction', () => {
     service: 'service',
     triggerResource: () => 'resource',
     handler: () => null,
+    legacyEventType: 'providers/provider/eventTypes/event',
   };
 
   it('should put a __trigger on the returned CloudFunction', () => {
-    let cf = makeCloudFunction(cloudFunctionArgs);
+    let cf = makeCloudFunction({
+      provider: 'mock.provider',
+      eventType: 'mock.event',
+      service: 'service',
+      triggerResource: () => 'resource',
+      handler: () => null,
+    });
     expect(cf.__trigger).to.deep.equal({
       eventTrigger: {
         eventType: 'mock.provider.mock.event',
@@ -51,6 +58,17 @@ describe('makeCloudFunction', () => {
     });
   });
 
+  it('should have legacy event type in __trigger if provided', () => {
+    let cf = makeCloudFunction(cloudFunctionArgs);
+    expect(cf.__trigger).to.deep.equal({
+      eventTrigger: {
+        eventType: 'providers/provider/eventTypes/event',
+        resource: 'resource',
+        service: 'service',
+      },
+    });
+  });
+
   it('should construct the right context for legacy event format', () => {
     let args: any = _.assign({}, cloudFunctionArgs, {
       handler: (data: any, context: EventContext) => context,
@@ -105,6 +123,39 @@ describe('makeCloudFunction', () => {
       params: {},
     });
   });
+
+  it('should handle Node 8 function signature', () => {
+    let args: any = _.assign({}, cloudFunctionArgs, {
+      handler: (data: any, context: EventContext) => {
+        return { data, context };
+      },
+    });
+    let cf = makeCloudFunction(args);
+    let testContext = {
+      eventId: '00000',
+      timestamp: '2016-11-04T21:29:03.496Z',
+      eventType: 'provider.event',
+      resource: {
+        service: 'provider',
+        name: 'resource',
+      },
+    };
+    let testData = 'data';
+
+    return expect(cf(testData, testContext)).to.eventually.deep.equal({
+      data: 'data',
+      context: {
+        eventId: '00000',
+        timestamp: '2016-11-04T21:29:03.496Z',
+        eventType: 'provider.event',
+        resource: {
+          service: 'provider',
+          name: 'resource',
+        },
+        params: {},
+      },
+    });
+  });
 });
 
 describe('makeParams', () => {
@@ -114,13 +165,14 @@ describe('makeParams', () => {
     service: 'service',
     triggerResource: () => 'projects/_/instances/pid/ref/{foo}/nested/{bar}',
     handler: (data, context) => context.params,
+    legacyEventType: 'legacyEvent',
   };
   const cf = makeCloudFunction(args);
 
   it('should construct params from the event resource of legacy events', () => {
     const testEvent: LegacyEvent = {
       resource: 'projects/_/instances/pid/ref/a/nested/b',
-      eventType: 'event',
+      eventType: 'legacyEvent',
       data: 'data',
     };
 
@@ -160,14 +212,14 @@ describe('makeAuth and makeAuthType', () => {
     handler: (data, context) => {
       return {
         auth: context.auth,
-        authMode: context.authType,
+        authType: context.authType,
       };
     },
   };
   let cf = makeCloudFunction(args);
 
   it('should construct correct auth and authType for admin user', () => {
-    const testEvent: LegacyEvent = {
+    const testEvent = {
       data: 'data',
       auth: {
         admin: true,
@@ -176,12 +228,12 @@ describe('makeAuth and makeAuthType', () => {
 
     return expect(cf(testEvent)).to.eventually.deep.equal({
       auth: undefined,
-      authMode: 'ADMIN',
+      authType: 'ADMIN',
     });
   });
 
   it('should construct correct auth and authType for unauthenticated user', () => {
-    const testEvent: LegacyEvent = {
+    const testEvent = {
       data: 'data',
       auth: {
         admin: false,
@@ -190,7 +242,7 @@ describe('makeAuth and makeAuthType', () => {
 
     return expect(cf(testEvent)).to.eventually.deep.equal({
       auth: null,
-      authMode: 'UNAUTHENTICATED',
+      authType: 'UNAUTHENTICATED',
     });
   });
 
@@ -216,7 +268,7 @@ describe('makeAuth and makeAuthType', () => {
           sub: 'user',
         },
       },
-      authMode: 'USER',
+      authType: 'USER',
     });
   });
 });