Skip to content

Print a useful error explaining why Runtime Config doesn't work #930

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 10, 2021
Merged

Print a useful error explaining why Runtime Config doesn't work #930

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
147b61a
Print a useful error explaining why Runtime Config doesn't work
inlined Aug 3, 2021
70f9755
PR feedback
inlined Aug 4, 2021
b2ac37f
Merge branch 'master' into inlined.runtime-config-error
inlined Aug 4, 2021
72eeddb
Merge branch 'master' into inlined.runtime-config-error
inlined Aug 10, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions spec/v1/config.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,23 @@ describe('config()', () => {
(config as any).firebaseConfigCache = null;
delete process.env.FIREBASE_CONFIG;
delete process.env.CLOUD_RUNTIME_CONFIG;
delete process.env.K_CONFIGURATION;
});

it('will never load in GCFv2', () => {
const json = JSON.stringify({
foo: 'bar',
firebase: {},
});
readFileSync
.withArgs('/srv/.runtimeconfig.json')
.returns(Buffer.from(json));

process.env.K_CONFIGURATION = 'my-service';
expect(() => config.config()).to.throw(
Error,
/transition to using environment variables/
);
});

it('loads config values from .runtimeconfig.json', () => {
Expand Down
8 changes: 8 additions & 0 deletions src/v1/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,14 @@ import * as path from 'path';
import * as firebase from 'firebase-admin';

export function config(): config.Config {
// K_CONFIGURATION is only set in GCFv2
if (process.env.K_CONFIGURATION) {
throw new Error(
'functions.config() is no longer available in Cloud Functions for ' +
'Firebase v2. Please see the latest documentation for information ' +
'on how to transition to using environment variables'
);
}
if (typeof config.singleton === 'undefined') {
init();
}
Expand Down