Add integration test for firebase-functions binary (#1028)

Add integration test for firebase-functions binary.

The integration setup is more robust than what we had before - it builds and installs the Functions SDK package at the branch commit and try to run the produced binary that ships with the Functions SDK.

We also modify the github CI/release script setting to run the integration test as part of its workflow.

Author: taeold

.github/workflows/test.yaml

@@ -16,6 +16,7 @@ jobs:
           - 10.x
           - 12.x
           - 14.x
+          - 16.x
     steps:
       - uses: actions/checkout@v1
       - uses: actions/setup-node@v1
@@ -31,4 +32,26 @@ jobs:
       - run: npm install
       - run: npm run lint
       - run: npm run format
-      - run: npm run build && npm run test
+      - run: npm run test
+  integration:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version:
+          - 12.x
+          - 14.x
+          - 16.x
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - name: Cache npm
+        uses: actions/cache@v1
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }}
+
+      - run: npm install
+      - run: npm run test:bin

.mocharc.yaml

@@ -1,10 +1,8 @@
 exit: true
 extension:
   - ts
-file:
-  - mocha/setup.ts
 package: ./package.json
 reporter: spec
 require:
   - 'ts-node/register'
-spec: spec/**/*.spec.ts
+  - 'source-map-support/register'

package.json

@@ -149,7 +149,8 @@
     "format:fix": "prettier --write '**/*.{json,md,ts,yml,yaml}'",
     "lint": "tslint --config tslint.json --project tsconfig.json ",
     "lint:fix": "tslint --config tslint.json --fix --project tsconfig.json",
-    "test": "mocha"
+    "test": "mocha --file ./mocha/setup.ts spec/**/*.spec.ts ",
+    "test:bin": "./scripts/bin-test/run.sh"
   },
   "dependencies": {
     "@types/cors": "^2.8.5",
@@ -180,10 +181,12 @@
     "mock-require": "^3.0.3",
     "mz": "^2.7.0",
     "nock": "^10.0.6",
+    "node-fetch": "^2.6.7",
+    "portfinder": "^1.0.28",
     "prettier": "^1.18.2",
     "semver": "^7.3.5",
     "sinon": "^7.3.2",
-    "ts-node": "^8.3.0",
+    "ts-node": "^10.4.0",
     "tslint": "^5.18.0",
     "tslint-config-prettier": "^1.18.0",
     "tslint-no-unused-expression-chai": "^0.1.4",

scripts/bin-test/mocha-setup.ts

@@ -0,0 +1,4 @@
+import * as chai from 'chai';
+import * as chaiAsPromised from 'chai-as-promised';
+
+chai.use(chaiAsPromised);

scripts/bin-test/run.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+set -ex # Immediately exit on failure
+
+# Link the Functions SDK for the testing environment.
+npm run build
+npm link
+
+# Link local SDK to all test sources.
+for f in scripts/bin-test/sources/*; do
+    if [ -d "$f" ]; then
+        (cd "$f" && npm link firebase-functions)
+    fi
+done
+
+## DEBUG
+ls -la scripts/bin-test/sources/commonjs/node_modules
+
+mocha \
+  --file ./scripts/bin-test/mocha-setup.ts \
+  ./scripts/bin-test/test.ts

scripts/bin-test/sources/commonjs-grouped/g1.js

@@ -0,0 +1,9 @@
+const functions = require("firebase-functions");
+
+exports.groupedhttp = functions.https.onRequest((req, resp) => {
+    resp.status(200).send("PASS");
+});
+
+exports.groupedcallable = functions.https.onCall(() => {
+    return "PASS";
+});

scripts/bin-test/sources/commonjs-grouped/index.js

@@ -0,0 +1,20 @@
+const functions = require("firebase-functions");
+const functionsv2 = require("firebase-functions/v2");
+
+exports.v1http = functions.https.onRequest((req, resp) => {
+    resp.status(200).send("PASS");
+});
+
+exports.v1callable = functions.https.onCall(() => {
+    return "PASS";
+});
+
+exports.v2http = functionsv2.https.onRequest((req, resp) => {
+    resp.status(200).send("PASS");
+});
+
+exports.v2callable = functionsv2.https.onCall(() => {
+    return "PASS";
+});
+
+exports.g1 = require("./g1");

scripts/bin-test/sources/commonjs-grouped/package.json

@@ -0,0 +1,3 @@
+{
+  "name": "commonjs-grouped"
+}

scripts/bin-test/sources/commonjs-main/functions.js

@@ -0,0 +1,18 @@
+const functions = require("firebase-functions");
+const functionsv2 = require("firebase-functions/v2");
+
+exports.v1http = functions.https.onRequest((req, resp) => {
+    resp.status(200).send("PASS");
+});
+
+exports.v1callable = functions.https.onCall(() => {
+    return "PASS";
+});
+
+exports.v2http = functionsv2.https.onRequest((req, resp) => {
+    resp.status(200).send("PASS");
+});
+
+exports.v2callable = functionsv2.https.onCall(() => {
+    return "PASS";
+});

scripts/bin-test/sources/commonjs-main/package.json

@@ -0,0 +1,4 @@
+{
+  "name": "commonjs-main",
+  "main": "functions.js"
+}

scripts/bin-test/sources/commonjs/index.js

@@ -0,0 +1,18 @@
+const functions = require("firebase-functions");
+const functionsv2 = require("firebase-functions/v2");
+
+exports.v1http = functions.https.onRequest((req, resp) => {
+    resp.status(200).send("PASS");
+});
+
+exports.v1callable = functions.https.onCall(() => {
+    return "PASS";
+});
+
+exports.v2http = functionsv2.https.onRequest((req, resp) => {
+    resp.status(200).send("PASS");
+});
+
+exports.v2callable = functionsv2.https.onCall(() => {
+    return "PASS";
+});

scripts/bin-test/sources/commonjs/package.json

@@ -0,0 +1,3 @@
+{
+  "name": "commonjs"
+}

spec/fixtures/sources/esm-ext/index.mjs renamed to scripts/bin-test/sources/esm-ext/index.mjs

@@ -1,5 +1,5 @@
-import * as functions from '../../../../lib/index.js';
-import * as functionsv2 from "../../../../lib/v2/index.js";
+import * as functions from "firebase-functions";
+import * as functionsv2 from "firebase-functions/v2";
 
 export const v1http = functions.https.onRequest((req, resp) => {
   resp.status(200).send("PASS");

spec/fixtures/sources/esm-ext/package.json renamed to scripts/bin-test/sources/esm-ext/package.json

@@ -1,5 +1,5 @@
-import * as functions from "../../../../lib/index.js";
-import * as functionsv2 from "../../../../lib/v2/index.js";
+import * as functions from "firebase-functions";
+import * as functionsv2 from "firebase-functions/v2";
 
 export const v1http = functions.https.onRequest((req, resp) => {
     resp.status(200).send("PASS");

spec/fixtures/sources/esm-main/functions.js renamed to scripts/bin-test/sources/esm-main/functions.js

@@ -1,5 +1,5 @@
-import * as functions from "../../../../lib/index.js";
-import * as functionsv2 from "../../../../lib/v2/index.js";
+import * as functions from "firebase-functions";
+import * as functionsv2 from "firebase-functions/v2";
 
 export const v1http = functions.https.onRequest((req, resp) => {
     resp.status(200).send("PASS");