Load Runtime Config from .runtimeconfig.json (#109)

Author: mbleigh

.gitignore

@@ -3,7 +3,7 @@
 .npm
 npm-debug.log
 lib
-
+yarn.lock
 coverage
 node_modules
 typings

spec/apps.spec.ts

@@ -22,7 +22,7 @@
 
 import { expect } from 'chai';
 import { fakeConfig } from './support/helpers';
-import {apps as appsNamespace, apps} from '../src/apps';
+import { apps as appsNamespace } from '../src/apps';
 import * as firebase from 'firebase-admin';
 import * as _ from 'lodash';
 import * as sinon from 'sinon';

spec/config.spec.ts

@@ -32,6 +32,13 @@ describe('config()', () => {
     unsetSingleton();
   });
 
+  it('loads config values from .runtimeconfig.json', () => {
+    mockRequire('../../../.runtimeconfig.json', { foo: 'bar', firebase: {} });
+    let loaded = config();
+    expect(loaded).to.have.property('firebase');
+    expect(loaded).to.have.property('foo','bar');
+  });
+
   it('loads config values from config.json', () => {
     mockRequire('../../../config.json', { foo: 'bar', firebase: {} });
     let loaded = config();
@@ -40,17 +47,17 @@ describe('config()', () => {
   });
 
   it('injects a Firebase credential', () => {
-    mockRequire('../../../config.json', { firebase: {} });
+    mockRequire('../../../.runtimeconfig.json', { firebase: {} });
     expect(config()).to.deep.property('firebase.credential');
   });
 
   it('throws an error if config.json not present', () => {
-    mockRequire('../../../config.json', 'does-not-exist');
+    mockRequire('../../../.runtimeconfig.json', 'does-not-exist');
     expect(config).to.throw('not available');
   });
 
   it('throws an error if Firebase configs not present', () => {
-    mockRequire('../../../config.json', {});
+    mockRequire('../../../.runtimeconfig.json', {});
     expect(config).to.throw('Firebase config variables are missing.');
   });
 });

src/config.ts

@@ -44,11 +44,16 @@ export namespace config {
 function init (credential: firebase.credential.Credential) {
   let loaded: any;
   try {
-    loaded = require('../../../config.json');
+    loaded = require('../../../.runtimeconfig.json');
   } catch (e) {
-    throw new Error ('functions.config() is not available. '
-      + 'Please use the Firebase CLI to deploy, or manually '
-      + 'add a config.json to your functions directory.');
+    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.'
+      );
+    }
   }
   if (!_.has(loaded, 'firebase')) {
     throw new Error('Firebase config variables are missing.');