Use process.env.FIREBASE_PROJECT for Firebase config values if available (#51)

Author: laurenzlong

spec/config.spec.ts

@@ -30,6 +30,8 @@ describe('config()', () => {
   afterEach(() => {
     mockRequire.stopAll();
     unsetSingleton();
+    delete process.env.FIREBASE_PROJECT;
+    delete process.env.CLOUD_RUNTIME_CONFIG;
   });
 
   it('loads config values from .runtimeconfig.json', () => {
@@ -39,25 +41,49 @@ describe('config()', () => {
     expect(loaded).to.have.property('foo','bar');
   });
 
-  it('loads config values from config.json', () => {
-    mockRequire('../../../config.json', { foo: 'bar', firebase: {} });
-    let loaded = config();
-    expect(loaded).to.have.property('firebase');
-    expect(loaded).to.have.property('foo','bar');
-  });
-
   it('injects a Firebase credential', () => {
     mockRequire('../../../.runtimeconfig.json', { firebase: {} });
     expect(config()).to.deep.property('firebase.credential');
   });
 
-  it('throws an error if config.json not present', () => {
+  it('throws an error if .runtimeconfig.json not present', () => {
     mockRequire('../../../.runtimeconfig.json', 'does-not-exist');
     expect(config).to.throw('not available');
   });
 
   it('throws an error if Firebase configs not present', () => {
     mockRequire('../../../.runtimeconfig.json', {});
-    expect(config).to.throw('Firebase config variables are missing.');
+    expect(config).to.throw('Firebase config variables are not available.');
+  });
+
+  it('loads Firebase configs from FIREBASE_PROJECT env variable', () => {
+    process.env.FIREBASE_PROJECT = JSON.stringify({
+      databaseURL: 'foo@firebaseio.com',
+    });
+    let firebaseConfig = config().firebase;
+    expect(firebaseConfig).to.have.property('databaseURL', 'foo@firebaseio.com');
+  });
+
+  it('behaves well when both FIREBASE_PROJECT and .runtimeconfig.json present', () => {
+    process.env.FIREBASE_PROJECT = JSON.stringify({
+      databaseURL: 'foo@firebaseio.com',
+    });
+    mockRequire('../../../.runtimeconfig.json', {
+      firebase: {
+        databaseURL: 'foo@firebaseio.com',
+      },
+      foo: 'bar',
+    });
+    let loaded = config();
+    expect(loaded.firebase).to.have.property('databaseURL', 'foo@firebaseio.com');
+    expect(loaded).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: {} });
+    let loaded = config();
+    expect(loaded).to.have.property('firebase');
+    expect(loaded).to.have.property('foo','bar');
   });
 });

src/config.ts

@@ -42,23 +42,25 @@ export namespace config {
 }
 
 function init (credential: firebase.credential.Credential) {
-  let loaded: any;
+  let loadedFromFile = {};
+  let firebaseEnv = {};
+  if (process.env.FIREBASE_PROJECT) {
+    firebaseEnv = { firebase: JSON.parse(process.env.FIREBASE_PROJECT) };
+  }
+
   try {
-    loaded = require('../../../.runtimeconfig.json');
+    let path = process.env.CLOUD_RUNTIME_CONFIG || '../../../.runtimeconfig.json';
+    loadedFromFile = require(path);
   } catch (e) {
-    try {
-      loaded = require('../../../config.json');
-    } catch (e) {
-      throw new Error(
-        'functions.config() is not available. ' +
-        'Please use the latest version of the Firebase CLI to deploy this function.'
-      );
-    }
+    // Do nothing
   }
-  if (!_.has(loaded, 'firebase')) {
-    throw new Error('Firebase config variables are missing.');
+  let merged= _.merge({}, loadedFromFile, firebaseEnv);
+
+  if (!_.has(merged, 'firebase')) {
+    throw new Error('Firebase config variables are not available. ' +
+    'Please use the latest version of the Firebase CLI to deploy this function.');
   }
 
-  _.set(loaded, 'firebase.credential', credential);
-  config.singleton = loaded;
+  _.set(merged, 'firebase.credential', credential);
+  config.singleton = merged;
 }

src/providers/database.ts

@@ -60,7 +60,8 @@ export function ref(path: string): RefBuilder {
   const normalized = normalizePath(path);
   const databaseURL = config().firebase.databaseURL;
   if (!databaseURL) {
-    throw new Error('Missing expected config value firebase.databaseURL');
+    throw new Error('Missing expected config value firebase.databaseURL, ' +
+    'config is actually' + JSON.stringify(config()));
   }
   const match = databaseURL.match(databaseURLRegex);
   if (!match) {