Lay the groundwork for v3 (#450)

* Update dependencies to latest versions

* Revert ordering  alphabetically

* Add `dom` library to `package.json`

This is required by `@types/protobufjs`.

* Update dependencies once more

* Update dependencies again

* Sort package.json using sort-package-json

* Breaking changes to dependencies

* Remove upgrade warning

* Compile to ES2017

* Simplify test scripts

* Remove class prototype overrides

* Drop support for FIREBASE_PROJECT env variable

* Add changelog entries

* Adjust Travis config to run on Node.js 8 and Node.js 10

* Remove tests for FIREBASE_PROJECT env variable

* Remove v1 migration entry from the readme

* Specify keywords in a correct order

* Revert adding a newline before an if statement

* Remove an always truthy condition

* Remove DOM library

* Update dependency @types/lodash to ^4.14.133

* Add a changelog entry for FIREBASE_PROJECT

* Add typeRoots to tsconfig.release.json

* Require a version of firebase-tools that supports Node.js 10

* Adjust firebase-tools version in changelog entry

* Remove firebase-tool peer dependency.

Author: merlinnot

.travis.yml

@@ -1,6 +1,5 @@
 language: node_js
 node_js:
-- '6.14.0'
-- '8'
-- stable
+  - '8'
+  - '10'
 sudo: false

README.md

@@ -17,11 +17,7 @@ Here are some resources to get help:
 
 If the official documentation doesn't help, try asking through our official support channels: https://firebase.google.com/support/
 
-*Please avoid double posting across multiple channels!*
-
-## Migrating to v1
-
-To migrate from a beta version of firebase-functions to v1, please refer to the [migration guide](https://firebase.google.com/docs/functions/beta-v1-diff).
+_Please avoid double posting across multiple channels!_
 
 ## Usage
 

changelog.txt

@@ -0,0 +1,3 @@
+- important - [breaking change] The Firebase Functions SDK no longer supports Node 6. Developers must use Node 8.13.0 or higher.
+- important - [breaking change] The Firebase Functions SDK no longer supports Firebase Tools SDK below version 6.8.0.
+- important - [breaking change] FIREBASE_PROJECT environment variable is no longer supported and has been supplanted by FIREBASE_CONFIG.

package.json

@@ -2,69 +2,66 @@
   "name": "firebase-functions",
   "version": "2.3.1",
   "description": "Firebase SDK for Cloud Functions",
-  "main": "lib/index.js",
-  "scripts": {
-    "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",
-    "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 format && rm -rf .tmp",
-    "postinstall": "node ./upgrade-warning"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/firebase/firebase-functions.git"
-  },
   "keywords": [
     "firebase",
     "functions",
     "google",
     "cloud"
   ],
-  "author": "Firebase Team",
-  "license": "MIT",
+  "homepage": "https://github.com/firebase/firebase-functions#readme",
   "bugs": {
     "url": "https://github.com/firebase/firebase-functions/issues"
   },
-  "homepage": "https://github.com/firebase/firebase-functions#readme",
-  "devDependencies": {
-    "@types/chai": "^3.4.32",
-    "@types/chai-as-promised": "0.0.28",
-    "@types/mocha": "^5.2.5",
-    "@types/mock-require": "^1.3.3",
-    "@types/nock": "^0.54.32",
-    "@types/node": "^6.0.38",
-    "@types/sinon": "^1.16.29",
-    "chai": "^3.5.0",
-    "chai-as-promised": "^5.2.0",
-    "firebase-admin": "^7.0.0",
-    "istanbul": "^0.4.2",
-    "mocha": "^5.2.0",
-    "mock-require": "^2.0.1",
-    "nock": "^9.0.0",
-    "prettier": "^1.13.7",
-    "sinon": "^1.17.4",
-    "ts-node": "^7.0.1",
-    "typescript": "~3.1.0"
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/firebase/firebase-functions.git"
   },
-  "peerDependencies": {
-    "firebase-admin": "^7.0.0"
+  "license": "MIT",
+  "author": "Firebase Team",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
+  "scripts": {
+    "build:pack": "rm -rf lib && npm install && tsc -p tsconfig.release.json && npm pack",
+    "build:release": "npm install --production && npm install typescript firebase-admin && tsc -p tsconfig.release.json",
+    "build": "tsc -p tsconfig.release.json",
+    "format": "prettier --write '**/*.ts'",
+    "posttest": "npm run format",
+    "test": "mocha -r ts-node/register ./spec/index.spec.ts"
   },
   "dependencies": {
-    "@types/cors": "^2.8.1",
-    "@types/express": "^4.11.1",
-    "@types/jsonwebtoken": "^7.2.6",
-    "@types/lodash": "^4.14.34",
     "cors": "^2.8.4",
-    "express": "^4.16.2",
-    "jsonwebtoken": "^8.2.1",
+    "express": "^4.17.1",
+    "jsonwebtoken": "^8.3.2",
     "lodash": "^4.6.1"
   },
-  "engines": {
-    "node": ">=6.0.0"
+  "devDependencies": {
+    "@types/chai": "^4.1.7",
+    "@types/chai-as-promised": "^7.1.0",
+    "@types/cors": "^2.8.5",
+    "@types/express": "^4.11.1",
+    "@types/jsonwebtoken": "^8.3.2",
+    "@types/lodash": "^4.14.133",
+    "@types/mocha": "^5.2.7",
+    "@types/mock-require": "^2.0.0",
+    "@types/nock": "^10.0.2",
+    "@types/node": "^8.10.49",
+    "@types/sinon": "^7.0.12",
+    "chai": "^4.2.0",
+    "chai-as-promised": "^7.1.1",
+    "firebase-admin": "^8.0.0",
+    "istanbul": "^0.4.2",
+    "mocha": "^6.1.4",
+    "mock-require": "^3.0.3",
+    "nock": "^10.0.6",
+    "prettier": "^1.17.1",
+    "sinon": "^7.3.2",
+    "ts-node": "^8.2.0",
+    "typescript": "^3.5.1"
   },
-  "typings": "lib/index.d.ts"
+  "peerDependencies": {
+    "firebase-admin": "^8.0.0"
+  },
+  "engines": {
+    "node": "^8.13.0 || >=10.10.0"
+  }
 }

spec/config.spec.ts

@@ -29,7 +29,6 @@ describe('config()', () => {
     mockRequire.stopAll();
     delete config.singleton;
     delete process.env.FIREBASE_CONFIG;
-    delete process.env.FIREBASE_PROJECT;
     delete process.env.CLOUD_RUNTIME_CONFIG;
   });
 
@@ -50,16 +49,6 @@ describe('config()', () => {
     expect(firebaseConfig()).to.be.null;
   });
 
-  it('loads Firebase configs from FIREBASE_PROJECT env variable', () => {
-    process.env.FIREBASE_PROJECT = JSON.stringify({
-      databaseURL: '[email protected]',
-    });
-    expect(firebaseConfig()).to.have.property(
-      'databaseURL',
-      '[email protected]'
-    );
-  });
-
   it('loads Firebase configs from FIREBASE_CONFIG env variable', () => {
     process.env.FIREBASE_CONFIG = JSON.stringify({
       databaseURL: '[email protected]',
@@ -70,33 +59,6 @@ describe('config()', () => {
     );
   });
 
-  it('prefers FIREBASE_CONFIG over FIREBASE_PROJECT', () => {
-    process.env.FIREBASE_CONFIG = JSON.stringify({
-      databaseURL: 'firebase_config',
-    });
-    process.env.FIREBASE_PROJECT = JSON.stringify({
-      databaseURL: 'firebase_project',
-    });
-    expect(firebaseConfig()).to.have.property('databaseURL', 'firebase_config');
-  });
-
-  it('behaves well when both FIREBASE_PROJECT and .runtimeconfig.json present', () => {
-    process.env.FIREBASE_PROJECT = JSON.stringify({
-      databaseURL: '[email protected]',
-    });
-    mockRequire('../../../.runtimeconfig.json', {
-      firebase: {
-        databaseURL: '[email protected]',
-      },
-      foo: 'bar',
-    });
-    expect(firebaseConfig()).to.have.property(
-      'databaseURL',
-      '[email protected]'
-    );
-    expect(config()).to.have.property('foo', 'bar');
-  });
-
   it('accepts alternative locations for config file', () => {
     process.env.CLOUD_RUNTIME_CONFIG = 'another.json';
     mockRequire('another.json', { foo: 'bar', firebase: {} });
@@ -112,16 +74,4 @@ describe('config()', () => {
     expect(firebaseConfig()).to.not.be.null;
     expect(config()).to.have.property('foo', 'bar');
   });
-
-  it('behaves well when both env.CLOUD_RUNTIME_CONFIG and env.FIREBASE_PROJECT are set', () => {
-    process.env.CLOUD_RUNTIME_CONFIG = JSON.stringify({ foo: 'bar' });
-    process.env.FIREBASE_PROJECT = JSON.stringify({
-      databaseURL: '[email protected]',
-    });
-    expect(firebaseConfig()).to.have.property(
-      'databaseURL',
-      '[email protected]'
-    );
-    expect(config()).to.have.property('foo', 'bar');
-  });
 });

spec/fixtures/http.ts

@@ -39,15 +39,10 @@ export function mockRCVariableFetch(
   data: any,
   token: string = 'thetoken'
 ): nock.Scope {
-  let mock: nock.Scope = nock('https://runtimeconfig.googleapis.com').get(
-    `/v1beta1/projects/${projectId}/configs/firebase/variables/${varName}`
-  );
-
-  if (token) {
-    mock = mock.matchHeader('Authorization', `Bearer ${token}`);
-  }
-
-  return mock.reply(200, { text: JSON.stringify(data) });
+  return nock('https://runtimeconfig.googleapis.com')
+    .get(`/v1beta1/projects/${projectId}/configs/firebase/variables/${varName}`)
+    .matchHeader('Authorization', `Bearer ${token}`)
+    .reply(200, { text: JSON.stringify(data) });
 }
 
 export function mockMetaVariableWatch(
@@ -56,60 +51,54 @@ export function mockMetaVariableWatch(
   token: string = 'thetoken',
   updateTime: string = new Date().toISOString()
 ): nock.Scope {
-  let mock: nock.Scope = nock('https://runtimeconfig.googleapis.com').post(
-    `/v1beta1/projects/${projectId}/configs/firebase/variables/meta:watch`
-  );
-
-  if (token) {
-    mock = mock.matchHeader('Authorization', `Bearer ${token}`);
-  }
-
-  return mock.reply(200, {
-    updateTime,
-    state: 'UPDATED',
-    text: JSON.stringify(data),
-  });
+  return nock('https://runtimeconfig.googleapis.com')
+    .post(
+      `/v1beta1/projects/${projectId}/configs/firebase/variables/meta:watch`
+    )
+    .matchHeader('Authorization', `Bearer ${token}`)
+    .reply(200, {
+      updateTime,
+      state: 'UPDATED',
+      text: JSON.stringify(data),
+    });
 }
 
 export function mockMetaVariableWatchTimeout(
   projectId: string,
   delay: number,
   token?: string
 ): nock.Scope {
-  let mock: nock.Scope = nock('https://runtimeconfig.googleapis.com').post(
+  let interceptor = nock('https://runtimeconfig.googleapis.com').post(
     `/v1beta1/projects/${projectId}/configs/firebase/variables/meta:watch`
   );
 
-  if (token) {
-    mock = mock.matchHeader('Authorization', `Bearer ${token}`);
+  if (interceptor) {
+    interceptor = interceptor.matchHeader('Authorization', `Bearer ${token}`);
   }
 
-  return mock.delay(delay).reply(502);
+  return interceptor.delay(delay).reply(502);
 }
 
 export function mockCreateToken(
   token: AccessToken = { access_token: 'aToken', expires_in: 3600 }
 ): nock.Scope {
-  let mock: nock.Scope = nock('https://accounts.google.com').post(
-    '/o/oauth2/token'
-  );
-  return mock.reply(200, token);
+  return nock('https://accounts.google.com')
+    .post('/o/oauth2/token')
+    .reply(200, token);
 }
 
 export function mockRefreshToken(
   token: AccessToken = { access_token: 'aToken', expires_in: 3600 }
 ): nock.Scope {
-  let mock: nock.Scope = nock('https://www.googleapis.com').post(
-    '/oauth2/v4/token'
-  );
-  return mock.reply(200, token);
+  return nock('https://www.googleapis.com')
+    .post('/oauth2/v4/token')
+    .reply(200, token);
 }
 
 export function mockMetadataServiceToken(
   token: AccessToken = { access_token: 'aToken', expires_in: 3600 }
 ): nock.Scope {
-  let mock: nock.Scope = nock('http://metadata.google.internal').get(
-    '/computeMetadata/v1beta1/instance/service-accounts/default/token'
-  );
-  return mock.reply(200, token);
+  return nock('http://metadata.google.internal')
+    .get('/computeMetadata/v1beta1/instance/service-accounts/default/token')
+    .reply(200, token);
 }

spec/providers/https.spec.ts

@@ -213,14 +213,14 @@ const expectedResponseHeaders = {
  * verifying an id token.
  */
 function mockFetchPublicKeys(): nock.Scope {
-  let mock: nock.Scope = nock('https://www.googleapis.com:443').get(
-    '/robot/v1/metadata/x509/[email protected]'
-  );
   const mockedResponse = { [mocks.key_id]: mocks.public_key };
   const headers = {
     'cache-control': 'public, max-age=1, must-revalidate, no-transform',
   };
-  return mock.reply(200, mockedResponse, headers);
+
+  return nock('https://www.googleapis.com:443')
+    .get('/robot/v1/metadata/x509/[email protected]')
+    .reply(200, mockedResponse, headers);
 }
 
 /**

src/config.ts

@@ -40,10 +40,7 @@ export namespace config {
 
 /* @internal */
 export function firebaseConfig(): firebase.AppOptions | null {
-  // The FIREBASE_PROJECT environment variable was introduced to help local emulation with `firebase-tools` 3.18
-  // Unfortunately, API review decided that the name should be FIREBASE_CONFIG to avoid confusions that Firebase has
-  // a separate project from Google Cloud. This accepts both versions, preferring the documented name.
-  const env = process.env.FIREBASE_CONFIG || process.env.FIREBASE_PROJECT;
+  const env = process.env.FIREBASE_CONFIG;
   if (env) {
     return JSON.parse(env);
   }

src/providers/https.ts

@@ -169,16 +169,11 @@ export class HttpsError extends Error {
   /**
    * Extra data to be converted to JSON and included in the error response.
    */
-  readonly details?: any;
+  readonly details?: unknown;
 
-  constructor(code: FunctionsErrorCode, message: string, details?: any) {
+  constructor(code: FunctionsErrorCode, message: string, details?: unknown) {
     super(message);
 
-    // This is a workaround for a bug in TypeScript when extending Error:
-    // tslint:disable-next-line
-    // https://github.com/Microsoft/TypeScript-wiki/blob/master/Breaking-Changes.md#extending-built-ins-like-error-array-and-map-may-no-longer-work
-    Object.setPrototypeOf(this, HttpsError.prototype);
-
     if (!errorCodeMap[code]) {
       throw new Error('Unknown error status: ' + code);
     }

tsconfig.json

@@ -1,17 +1,12 @@
 {
   "compilerOptions": {
-    "lib": ["es6"],
+    "lib": ["es2017"],
     "module": "commonjs",
     "noImplicitAny": false,
     "outDir": ".tmp",
+    "resolveJsonModule": true,
     "sourceMap": true,
-    "target": "es6",
-    "typeRoots": [
-      "node_modules/@types"
-    ]
+    "target": "es2017"
   },
-  "include": [
-    "src/**/*.ts",
-    "spec/**/*.ts"
-  ]
+  "include": ["src/**/*.ts", "spec/**/*.ts"]
 }