use fake "owner" credential when rtdb emulator env var is set

packages/database/src/core/AuthTokenProvider.ts

@@ -19,7 +19,7 @@ import { FirebaseApp } from '@firebase/app-types';
 import { FirebaseAuthTokenData } from '@firebase/app-types/private';
 import { log, warn } from './util/util';
 
-export interface TokenProvider {
+export interface AuthTokenProvider {
   /**
    * @param {boolean} forceRefresh
    * @return {!Promise<FirebaseAuthTokenData>}
@@ -36,7 +36,7 @@ export interface TokenProvider {
 /**
  * Abstraction around FirebaseApp's token fetching capabilities.
  */
-export class AuthTokenProvider implements TokenProvider {
+export class FirebaseAuthTokenProvider implements AuthTokenProvider {
   /**
    * @param {!FirebaseApp} app_
    */

packages/database/src/core/EmulatorAuthTokenProvider.ts

@@ -18,14 +18,14 @@
 import { FirebaseApp } from '@firebase/app-types';
 import { FirebaseAuthTokenData } from '@firebase/app-types/private';
 
-import { TokenProvider } from './AuthTokenProvider';
+import { AuthTokenProvider } from './AuthTokenProvider';
 import { log, warn } from './util/util';
 
 class EmulatorAuthToken implements FirebaseAuthTokenData {
   constructor(public accessToken: string) {}
 }
 
-export class EmulatorAuthTokenProvider implements TokenProvider {
+export class EmulatorAuthTokenProvider implements AuthTokenProvider {
   constructor(private app_: FirebaseApp) {}
 
   getToken(forceRefresh: boolean): Promise<FirebaseAuthTokenData> {

packages/database/src/core/PersistentConnection.ts

@@ -26,7 +26,7 @@ import { isAdmin, isValidFormat } from '@firebase/util';
 import { Connection } from '../realtime/Connection';
 import { isMobileCordova, isReactNative, isNodeSdk } from '@firebase/util';
 import { ServerActions } from './ServerActions';
-import { TokenProvider } from './AuthTokenProvider';
+import { AuthTokenProvider } from './AuthTokenProvider';
 import { RepoInfo } from './RepoInfo';
 import { Query } from '../api/Query';
 import { SDK_VERSION } from './version';
@@ -133,7 +133,7 @@ export class PersistentConnection extends ServerActions {
     ) => void,
     private onConnectStatus_: (a: boolean) => void,
     private onServerInfoUpdate_: (a: any) => void,
-    private authTokenProvider_: TokenProvider,
+    private authTokenProvider_: AuthTokenProvider,
     private authOverride_?: Object | null
   ) {
     super();

packages/database/src/core/ReadonlyRestClient.ts

@@ -22,7 +22,10 @@ import { safeGet } from '@firebase/util';
 import { querystring } from '@firebase/util';
 import { ServerActions } from './ServerActions';
 import { RepoInfo } from './RepoInfo';
-import { TokenProvider } from './AuthTokenProvider';
+import {
+  FirebaseAuthTokenProvider,
+  AuthTokenProvider
+} from './AuthTokenProvider';
 import { Query } from '../api/Query';
 
 /**
@@ -67,7 +70,7 @@ export class ReadonlyRestClient extends ServerActions {
   /**
    * @param {!RepoInfo} repoInfo_ Data about the namespace we are connecting to
    * @param {function(string, *, boolean, ?number)} onDataUpdate_ A callback for new data from the server
-   * @param {TokenProvider} authTokenProvider_
+   * @param {FirebaseAuthTokenProvider} authTokenProvider_
    * @implements {ServerActions}
    */
   constructor(
@@ -78,7 +81,7 @@ export class ReadonlyRestClient extends ServerActions {
       c: boolean,
       d: number | null
     ) => void,
-    private authTokenProvider_: TokenProvider
+    private authTokenProvider_: AuthTokenProvider
   ) {
     super();
   }

packages/database/src/core/Repo.ts

@@ -26,9 +26,19 @@ import { SparseSnapshotTree } from './SparseSnapshotTree';
 import { SyncTree } from './SyncTree';
 import { SnapshotHolder } from './SnapshotHolder';
 import { stringify } from '@firebase/util';
-import { beingCrawled, each, exceptionGuard, warn, log } from './util/util';
+import {
+  beingCrawled,
+  each,
+  exceptionGuard,
+  warn,
+  log,
+  FIREBASE_DATABASE_EMULATOR_HOST_VAR
+} from './util/util';
 import { map, isEmpty } from '@firebase/util';
-import { AuthTokenProvider, TokenProvider } from './AuthTokenProvider';
+import {
+  FirebaseAuthTokenProvider,
+  AuthTokenProvider
+} from './AuthTokenProvider';
 import { EmulatorAuthTokenProvider } from './EmulatorAuthTokenProvider';
 import { StatsManager } from './stats/StatsManager';
 import { StatsReporter } from './stats/StatsReporter';
@@ -38,7 +48,6 @@ import { PersistentConnection } from './PersistentConnection';
 import { ReadonlyRestClient } from './ReadonlyRestClient';
 import { FirebaseApp } from '@firebase/app-types';
 import { RepoInfo } from './RepoInfo';
-import { FIREBASE_DATABASE_EMULATOR_HOST_VAR } from './Constants';
 import { Database } from '../api/Database';
 import { ServerActions } from './ServerActions';
 import { Query } from '../api/Query';
@@ -83,14 +92,14 @@ export class Repo {
     forceRestClient: boolean,
     public app: FirebaseApp
   ) {
-    let authTokenProvider: TokenProvider;
+    let authTokenProvider: AuthTokenProvider;
     if (
       typeof process !== 'undefined' &&
       process.env[FIREBASE_DATABASE_EMULATOR_HOST_VAR]
     ) {
       authTokenProvider = new EmulatorAuthTokenProvider(app);
     } else {
-      authTokenProvider = new AuthTokenProvider(app);
+      authTokenProvider = new FirebaseAuthTokenProvider(app);
     }
 
     this.stats_ = StatsManager.getCollection(repoInfo_);

packages/database/src/core/RepoManager.ts

@@ -17,9 +17,8 @@
 
 import { FirebaseApp } from '@firebase/app-types';
 import { safeGet } from '@firebase/util';
-import { FIREBASE_DATABASE_EMULATOR_HOST_VAR } from './Constants';
 import { Repo } from './Repo';
-import { fatal } from './util/util';
+import { fatal, FIREBASE_DATABASE_EMULATOR_HOST_VAR } from './util/util';
 import { parseRepoInfo, parseURL } from './util/libs/parser';
 import { validateUrl } from './util/validation';
 import './Repo_transaction';

packages/database/src/core/util/util.ts

@@ -31,6 +31,17 @@ import { Logger, LogLevel } from '@firebase/logger';
 
 const logClient = new Logger('@firebase/database');
 
+/**
+ * Environment variable for enabling interaction with the Firebase Realtime Database
+ * emulator. If set, the module will present the endpoint with a fake "owner" credential
+ * (see EmulatorAuthTokenProvider) instead of one belonging to a real account.
+ *
+ * The expected format for this variable is '<HOST>:<PORT>'. The transfer protocol must be
+ * omitted and will default to 'http'.
+ */
+export const FIREBASE_DATABASE_EMULATOR_HOST_VAR =
+  'FIREBASE_DATABASE_EMULATOR_HOST';
+
 /**
  * Returns a locally-unique ID (generated by just incrementing up from 0 each time its called).
  * @type {function(): number} Generated ID.