Add callable HTTPS functions (#195)

Author: laurenzlong

changelog.txt

@@ -0,0 +1 @@
+feature - Adds HTTPS Callable Functions, a kind of HTTPS trigger that can be called from a Firebase client SDK.

integration_test/functions/src/https-tests.ts

@@ -0,0 +1,8 @@
+import * as functions from 'firebase-functions';
+import { TestSuite, expectEq } from './testing';
+
+export const callableTests: any = functions.https.onCall((data, context) => {
+  return new TestSuite('https onCall')
+    .it('should have the correct data', event => expectEq(event.data.foo, 'bar'))
+    .run(data.testId, { data: data, context: context });
+});

integration_test/functions/src/index.ts

@@ -1,5 +1,6 @@
 import * as functions from 'firebase-functions';
 import * as firebase from 'firebase';
+import * as https from 'https';
 import * as admin from 'firebase-admin';
 import * as _ from 'lodash';
 import { Request, Response } from 'express';
@@ -8,11 +9,33 @@ export * from './pubsub-tests';
 export * from './database-tests';
 export * from './auth-tests';
 export * from './firestore-tests';
+export * from './https-tests';
 const numTests = Object.keys(exports).length;  // Assumption: every exported function is its own test.
 
 firebase.initializeApp(_.omit(functions.config().firebase, 'credential'));  // Explicitly decline admin privileges.
 admin.initializeApp(functions.config().firebase);
 
+// TODO(klimt): Get rid of this once the JS client SDK supports callable triggers.
+function callHttpsTrigger(name: string, data: any) {
+  return new Promise((resolve, reject) => {
+    const request = https.request({
+      method: 'POST',
+      host: 'us-central1-' + functions.config().firebase.projectId + '.cloudfunctions.net',
+      path: '/' + name,
+      headers: {
+        'Content-Type': 'application/json',
+      },
+    }, (response) => {
+      let body = '';
+      response.on('data', (chunk) => { body += chunk; });
+      response.on('end', () => resolve(body));
+    });
+    request.on('error', reject);
+    request.write(JSON.stringify({data}));
+    request.end();
+  });
+}
+
 export const integrationTests: any = functions.https.onRequest((req: Request, resp: Response) => {
   let pubsub: any = require('@google-cloud/pubsub')();
 
@@ -35,6 +58,9 @@ export const integrationTests: any = functions.https.onRequest((req: Request, re
     }),
     // A firestore write to trigger the Cloud Firestore tests.
     admin.firestore().collection('tests').doc(testId).set({test: testId}),
+    // Invoke a callable HTTPS trigger.
+    callHttpsTrigger('callableTests', {foo: 'bar', testId}),
+
   ]).then(() => {
     // On test completion, check that all tests pass and reply "PASS", or provide further details.
     console.log('Waiting for all tests to report they pass...');

package.json

@@ -42,7 +42,7 @@
     "istanbul": "^0.4.2",
     "mocha": "^2.4.5",
     "mock-require": "^2.0.1",
-    "nock": "^8.0.0",
+    "nock": "^9.0.0",
     "sinon": "^1.17.4",
     "tslint": "^3.15.1",
     "typescript": "^2.0.3"
@@ -51,10 +51,12 @@
     "firebase-admin": "~5.10.0"
   },
   "dependencies": {
+    "@types/cors": "^2.8.1",
     "@types/express": "^4.0.33",
     "@types/jsonwebtoken": "^7.1.32",
     "@types/lodash": "^4.14.34",
     "@types/sha1": "^1.1.0",
+    "cors": "^2.8.4",
     "express": "^4.0.33",
     "jsonwebtoken": "^7.1.9",
     "lodash": "^4.6.1",

spec/fixtures/credential/key.d.ts

@@ -0,0 +1,10 @@
+/* tslint:disable */
+declare module "*key.json" {
+  const type: string;
+  const user_id: string;
+  const project_id: string;
+  const key_id: string;
+  const private_key: string;
+  const public_key: string;
+  const client_email: string;
+}

spec/fixtures/credential/key.json

@@ -1,7 +1,9 @@
 {
   "type": "service_account",
   "project_id": "project_id",
-  "private_key_id": "aaaaaaaaaabbbbbbbbbbccccccccccdddddddddd",
+  "user_id": "SomeUID",
+  "key_id": "THIS_IS_A_KID",
   "private_key": "-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEAwJENcRev+eXZKvhhWLiV3Lz2MvO+naQRHo59g3vaNQnbgyduN/L4krlr\nJ5c6FiikXdtJNb/QrsAHSyJWCu8j3T9CruiwbidGAk2W0RuViTVspjHUTsIHExx9euWM0Uom\nGvYkoqXahdhPL/zViVSJt+Rt8bHLsMvpb8RquTIb9iKY3SMV2tCofNmyCSgVbghq/y7lKORt\nV/IRguWs6R22fbkb0r2MCYoNAbZ9dqnbRIFNZBC7itYtUoTEresRWcyFMh0zfAIJycWOJlVL\nDLqkY2SmIx8u7fuysCg1wcoSZoStuDq02nZEMw1dx8HGzE0hynpHlloRLByuIuOAfMCCYwID\nAQABAoIBADFtihu7TspAO0wSUTpqttzgC/nsIsNn95T2UjVLtyjiDNxPZLUrwq42tdCFur0x\nVW9Z+CK5x6DzXWvltlw8IeKKeF1ZEOBVaFzy+YFXKTz835SROcO1fgdjyrme7lRSShGlmKW/\nGKY+baUNquoDLw5qreXaE0SgMp0jt5ktyYuVxvhLDeV4omw2u6waoGkifsGm8lYivg5l3VR7\nw2IVOvYZTt4BuSYVwOM+qjwaS1vtL7gv0SUjrj85Ja6zERRdFiITDhZw6nsvacr9/+/aut9E\naL/koSSb62g5fntQMEwoT4hRnjPnAedmorM9Rhddh2TB3ZKTBbMN1tUk3fJxOuECgYEA+z6l\neSaAcZ3qvwpntcXSpwwJ0SSmzLTH2RJNf+Ld3eBHiSvLTG53dWB7lJtF4R1KcIwf+KGcOFJv\nsnepzcZBylRvT8RrAAkV0s9OiVm1lXZyaepbLg4GGFJBPi8A6VIAj7zYknToRApdW0s1x/XX\nChewfJDckqsevTMovdbg8YkCgYEAxDYX+3mfvv/opo6HNNY3SfVunM+4vVJL+n8gWZ2w9kz3\nQ9Ub9YbRmI7iQaiVkO5xNuoG1n9bM+3Mnm84aQ1YeNT01YqeyQsipP5Wi+um0PzYTaBw9RO+\n8Gh6992OwlJiRtFk5WjalNWOxY4MU0ImnJwIfKQlUODvLmcixm68NYsCgYEAuAqI3jkk55Vd\nKvotREsX5wP7gPePM+7NYiZ1HNQL4Ab1f/bTojZdTV8Sx6YCR0fUiqMqnE+OBvfkGGBtw22S\nLesx6sWf99Ov58+x4Q0U5dpxL0Lb7d2Z+2Dtp+Z4jXFjNeeI4ae/qG/LOR/b0pE0J5F415ap\n7Mpq5v89vepUtrkCgYAjMXytu4v+q1Ikhc4UmRPDrUUQ1WVSd+9u19yKlnFGTFnRjej86hiw\nH3jPxBhHra0a53EgiilmsBGSnWpl1WH4EmJz5vBCKUAmjgQiBrueIqv9iHiaTNdjsanUyaWw\njyxXfXl2eI80QPXh02+8g1H/pzESgjK7Rg1AqnkfVH9nrwKBgQDJVxKBPTw9pigYMVt9iHrR\niCl9zQVjRMbWiPOc0J56+/5FZYm/AOGl9rfhQ9vGxXZYZiOP5FsNkwt05Y1UoAAH4B4VQwbL\nqod71qOcI0ywgZiIR87CYw40gzRfjWnN+YEEW1qfyoNLilEwJB8iB/T+ZePHGmJ4MmQ/cTn9\nxpdLXA==\n-----END RSA PRIVATE KEY-----\n",
+  "public_key": "-----BEGIN RSA PUBLIC KEY-----\nMIIBCgKCAQEAwJENcRev+eXZKvhhWLiV3Lz2MvO+naQRHo59g3vaNQnbgyduN/L4krlrJ5c6\nFiikXdtJNb/QrsAHSyJWCu8j3T9CruiwbidGAk2W0RuViTVspjHUTsIHExx9euWM0UomGvYk\noqXahdhPL/zViVSJt+Rt8bHLsMvpb8RquTIb9iKY3SMV2tCofNmyCSgVbghq/y7lKORtV/IR\nguWs6R22fbkb0r2MCYoNAbZ9dqnbRIFNZBC7itYtUoTEresRWcyFMh0zfAIJycWOJlVLDLqk\nY2SmIx8u7fuysCg1wcoSZoStuDq02nZEMw1dx8HGzE0hynpHlloRLByuIuOAfMCCYwIDAQAB\n-----END RSA PUBLIC KEY-----\n",
   "client_email": "foo@project_id.iam.gserviceaccount.com"
 }