Skip to content

add environment variable to point admin sdk at rtdb emulator #589

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

Closed
wants to merge 10 commits into from
Closed

add environment variable to point admin sdk at rtdb emulator #589

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
4bb19be
add environment variable to point admin sdk at rtdb emulator
jmwski Jul 3, 2019
3b72fd6
return 'null' in DatabasEmulatorCredential#getCertificate
jmwski Jul 4, 2019
6409c68
add env var and databaseURL examples to comment
jmwski Jul 4, 2019
25fbff1
remove getCertificate from DatabaseEmulatorCredential
jmwski Jul 8, 2019
269293e
Merge branch 'master' into wyszynski/rtdb-emulator-host-envvar
jmwski Jul 8, 2019
c12c4bd
move env var parsing logic to database module
jmwski Jul 17, 2019
f3f5597
Merge branch 'master' into wyszynski/rtdb-emulator-host-envvar
jmwski Jul 17, 2019
7861050
implement Credential interface instead of FirebaseCredential
jmwski Jul 18, 2019
0f8f64b
move envvar parsing logic to database module
jmwski Jul 18, 2019
ba2acfe
undo extraneous diff
jmwski Jul 18, 2019
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
9 changes: 9 additions & 0 deletions src/auth/credential.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -419,6 +419,15 @@ export class ApplicationDefaultCredential implements FirebaseCredential {
}
}

export class DatabaseEmulatorCredential implements Credential {
public getAccessToken(): Promise<GoogleOAuthAccessToken> {
return Promise.resolve({
expires_in: 1000,
access_token: 'owner',
});
}
}

function credentialFromFile(filePath: string, httpAgent?: Agent): Credential {
const credentialsFile = readCredentialFile(filePath);
if (typeof credentialsFile !== 'object') {
Expand Down
28 changes: 28 additions & 0 deletions src/database/database.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,32 @@
import {DatabaseEmulatorCredential} from '../auth/credential';
import {FirebaseApp} from '../firebase-app';
import {FirebaseDatabaseError} from '../utils/error';
import {FirebaseServiceInterface, FirebaseServiceInternalsInterface} from '../firebase-service';
import {Database} from '@firebase/database';

import * as validator from '../utils/validator';

const APP_OPTIONS_PROJECT_ID = 'projectId';
const APP_OPTIONS_CREDENTIAL = 'credential';

/**
* Constant holding the fully-qualified domain URI for a database emulator
* instance. If specified, the contents of this variable will be used to
* set `databaseURL` in FirebaseAppOptions. The varaible should be a complete
* URI specifying a transfer protocol, hostname, and port number:
*
* FIREBASE_DATABASE_EMULATOR_HOST=http://localhost:9000
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I am not mistaken, the protocol is omitted in FIRESTORE_EMULATOR_HOST. I see that it might make sense to include it here (since we need to include the namespace). Should we come up with a consistent pattern that apploes to both RTDB and Firestore? @ryanpbrewster

Copy link
Contributor

@ryanpbrewster ryanpbrewster Jul 30, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the protocol should not be included in the FIRESTORE_EMULATOR_HOST variable.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we care about the consistency between FIRESTORE_EMULATOR_HOST and FIREBASE_DATABASE_EMULATOR_HOST?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, ideally neither should include the protocol.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This comment is dated, neither emulator host variable has a protocol.

*
*
* If a `projectId` is specified in FirebaseAppOptions, the database url will
* include the `ns=${projectId}` query parameter to identify the appropriate
* namespace within the emulator. The final `databaseURL` for a firebase project
* called "test" would be:
*
* http://localhost:9000?ns=test
*/
const FIREBASE_DATABASE_EMULATOR_HOST_VAR = 'FIREBASE_DATABASE_EMULATOR_HOST';
const DEFAULT_DATABASE_EMULATOR_PROJECT_ID = 'fake-server';

/**
* Internals of a Database instance.
Expand Down Expand Up @@ -55,6 +77,12 @@ export class DatabaseService implements FirebaseServiceInterface {
}

public getDatabase(url?: string): Database {
const emulatorUrl = process.env[FIREBASE_DATABASE_EMULATOR_HOST_VAR];
if (emulatorUrl) {
url = `${emulatorUrl}?ns=${this.appInternal.options[APP_OPTIONS_PROJECT_ID] ||
DEFAULT_DATABASE_EMULATOR_PROJECT_ID }`;
this.appInternal.options[APP_OPTIONS_CREDENTIAL] = new DatabaseEmulatorCredential();
}
const dbUrl: string = this.ensureUrl(url);
if (!validator.isNonEmptyString(dbUrl)) {
throw new FirebaseDatabaseError({
Expand Down