Migrate Database to component framework

Feiyang1 · Feiyang1 · commit 496ca880bba8 · 2019-11-04T17:27:20.000-08:00
diff --git a/packages/auth/src/exports_auth.js b/packages/auth/src/exports_auth.js
@@ -620,7 +620,7 @@ fireauth.exportlib.exportFunction(
   if (typeof firebase === 'undefined' || !firebase.INTERNAL ||
       !firebase.INTERNAL.registerService) {
     throw new Error('Cannot find the firebase namespace; be sure to include ' +
-        'firebase-app.js before this library.');
+      'firebase-app.js before this library.');
   } else {
     /** @type {!firebase.ServiceFactory} */
     var factory = function(app, extendApp) {
@@ -654,36 +654,36 @@ fireauth.exportlib.exportFunction(
       'Error': fireauth.AuthError
     };
     fireauth.exportlib.exportFunction(namespace,
-        'EmailAuthProvider', fireauth.EmailAuthProvider, []);
+      'EmailAuthProvider', fireauth.EmailAuthProvider, []);
     fireauth.exportlib.exportFunction(namespace,
-        'FacebookAuthProvider', fireauth.FacebookAuthProvider, []);
+      'FacebookAuthProvider', fireauth.FacebookAuthProvider, []);
     fireauth.exportlib.exportFunction(namespace,
-        'GithubAuthProvider', fireauth.GithubAuthProvider, []);
+      'GithubAuthProvider', fireauth.GithubAuthProvider, []);
     fireauth.exportlib.exportFunction(namespace,
-        'GoogleAuthProvider', fireauth.GoogleAuthProvider, []);
+      'GoogleAuthProvider', fireauth.GoogleAuthProvider, []);
     fireauth.exportlib.exportFunction(namespace,
-        'TwitterAuthProvider', fireauth.TwitterAuthProvider, []);
+      'TwitterAuthProvider', fireauth.TwitterAuthProvider, []);
     fireauth.exportlib.exportFunction(namespace,
-        'OAuthProvider', fireauth.OAuthProvider, [
-          fireauth.args.string('providerId')
-        ]);
+      'OAuthProvider', fireauth.OAuthProvider, [
+      fireauth.args.string('providerId')
+    ]);
     fireauth.exportlib.exportFunction(namespace,
-        'SAMLAuthProvider', fireauth.SAMLAuthProvider, [
-          fireauth.args.string('providerId')
-        ]);
+      'SAMLAuthProvider', fireauth.SAMLAuthProvider, [
+      fireauth.args.string('providerId')
+    ]);
     fireauth.exportlib.exportFunction(namespace,
-        'PhoneAuthProvider', fireauth.PhoneAuthProvider, [
-          fireauth.args.firebaseAuth(true)
-        ]);
+      'PhoneAuthProvider', fireauth.PhoneAuthProvider, [
+      fireauth.args.firebaseAuth(true)
+    ]);
     fireauth.exportlib.exportFunction(namespace,
-        'RecaptchaVerifier', fireauth.RecaptchaVerifier, [
-          fireauth.args.or(
-              fireauth.args.string(),
-              fireauth.args.element(),
-              'recaptchaContainer'),
-          fireauth.args.object('recaptchaParameters', true),
-          fireauth.args.firebaseApp(true)
-        ]);
+      'RecaptchaVerifier', fireauth.RecaptchaVerifier, [
+      fireauth.args.or(
+        fireauth.args.string(),
+        fireauth.args.element(),
+        'recaptchaContainer'),
+      fireauth.args.object('recaptchaParameters', true),
+      fireauth.args.firebaseApp(true)
+    ]);
     fireauth.exportlib.exportFunction(namespace,
         'ActionCodeURL', fireauth.ActionCodeURL, []);
 
diff --git a/packages/database/index.node.ts b/packages/database/index.node.ts
@@ -16,7 +16,7 @@
  */
 
 import { FirebaseNamespace, FirebaseApp } from '@firebase/app-types';
-import { _FirebaseNamespace } from '@firebase/app-types/private';
+import { _FirebaseNamespace, _FirebaseApp } from '@firebase/app-types/private';
 import { Database } from './src/api/Database';
 import { DataSnapshot } from './src/api/DataSnapshot';
 import { Query } from './src/api/Query';
@@ -30,6 +30,13 @@ import { setSDKVersion } from './src/core/version';
 import { CONSTANTS, isNodeSdk } from '@firebase/util';
 import { setWebSocketImpl } from './src/realtime/WebSocketConnection';
 import { Client } from 'faye-websocket';
+import {
+  Component,
+  ComponentType,
+  Provider,
+  ComponentContainer
+} from '@firebase/component';
+import { FirebaseAuthInternal } from '@firebase/auth-interop-types';
 
 setWebSocketImpl(Client);
 
@@ -51,8 +58,28 @@ export function initStandalone(app: FirebaseApp, url: string, version: string) {
   CONSTANTS.NODE_ADMIN = true;
   setSDKVersion(version);
 
+  /**
+   * Create a 'auth-internal' component using firebase-admin-node's implementation
+   * that implements FirebaseAuthInternal.
+   * ComponentContainer('database-admin') is just a placeholder that doesn't perform
+   * any actual function.
+   */
+  const authProvider = new Provider<FirebaseAuthInternal>(
+    'auth-internal',
+    new ComponentContainer('database-admin')
+  );
+  authProvider.setComponent(
+    new Component(
+      'auth-internal',
+      // firebase-admin-node's app.INTERNAL implements FirebaseAuthInternal interface
+      // eslint-disable-next-line @eslint-tslint/no-explicit-any
+      () => (app as any).INTERNAL,
+      ComponentType.PRIVATE
+    )
+  );
+
   return {
-    instance: RepoManager.getInstance().databaseFromApp(app, url),
+    instance: RepoManager.getInstance().databaseFromApp(app, authProvider, url),
     namespace: {
       Reference,
       Query,
@@ -71,22 +98,37 @@ export function registerDatabase(instance: FirebaseNamespace) {
   setSDKVersion(instance.SDK_VERSION);
 
   // Register the Database Service with the 'firebase' namespace.
-  const namespace = (instance as _FirebaseNamespace).INTERNAL.registerService(
-    'database',
-    (app, unused, url) => RepoManager.getInstance().databaseFromApp(app, url),
-    // firebase.database namespace properties
-    {
-      Reference,
-      Query,
-      Database,
-      DataSnapshot,
-      enableLogging,
-      INTERNAL,
-      ServerValue,
-      TEST_ACCESS
-    },
-    null,
-    true
+  const namespace = (instance as _FirebaseNamespace).INTERNAL.registerComponent(
+    new Component(
+      'database',
+      (container, url) => {
+        /* Dependencies */
+        // getImmediate for FirebaseApp will always succeed
+        const app = container.getProvider('app').getImmediate();
+        const authProvider = container.getProvider('auth-internal');
+
+        return RepoManager.getInstance().databaseFromApp(
+          app,
+          authProvider,
+          url
+        );
+      },
+      ComponentType.PUBLIC
+    )
+      .setServiceProps(
+        // firebase.database namespace properties
+        {
+          Reference,
+          Query,
+          Database,
+          DataSnapshot,
+          enableLogging,
+          INTERNAL,
+          ServerValue,
+          TEST_ACCESS
+        }
+      )
+      .setMultipleInstances(true)
   );
 
   if (isNodeSdk()) {
diff --git a/packages/database/index.ts b/packages/database/index.ts
@@ -29,6 +29,7 @@ import * as TEST_ACCESS from './src/api/test_access';
 import { isNodeSdk } from '@firebase/util';
 import * as types from '@firebase/database-types';
 import { setSDKVersion } from './src/core/version';
+import { Component, ComponentType } from '@firebase/component';
 
 const ServerValue = Database.ServerValue;
 
@@ -37,22 +38,37 @@ export function registerDatabase(instance: FirebaseNamespace) {
   setSDKVersion(instance.SDK_VERSION);
 
   // Register the Database Service with the 'firebase' namespace.
-  const namespace = (instance as _FirebaseNamespace).INTERNAL.registerService(
-    'database',
-    (app, unused, url) => RepoManager.getInstance().databaseFromApp(app, url),
-    // firebase.database namespace properties
-    {
-      Reference,
-      Query,
-      Database,
-      DataSnapshot,
-      enableLogging,
-      INTERNAL,
-      ServerValue,
-      TEST_ACCESS
-    },
-    null,
-    true
+  const namespace = (instance as _FirebaseNamespace).INTERNAL.registerComponent(
+    new Component(
+      'database',
+      (container, url) => {
+        /* Dependencies */
+        // getImmediate for FirebaseApp will always succeed
+        const app = container.getProvider('app').getImmediate();
+        const authProvider = container.getProvider('auth-internal');
+
+        return RepoManager.getInstance().databaseFromApp(
+          app,
+          authProvider,
+          url
+        );
+      },
+      ComponentType.PUBLIC
+    )
+      .setServiceProps(
+        // firebase.database namespace properties
+        {
+          Reference,
+          Query,
+          Database,
+          DataSnapshot,
+          enableLogging,
+          INTERNAL,
+          ServerValue,
+          TEST_ACCESS
+        }
+      )
+      .setMultipleInstances(true)
   );
 
   if (isNodeSdk()) {
diff --git a/packages/database/package.json b/packages/database/package.json
@@ -16,7 +16,7 @@
     "test": "yarn test:emulator",
     "test:all": "run-p test:browser test:node",
     "test:browser": "karma start --single-run",
-    "test:node": "TS_NODE_CACHE=NO TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'test/{,!(browser)/**/}*.test.ts' --file index.node.ts --opts ../../config/mocha.node.opts",
+    "test:node": "TS_NODE_FILES=true TS_NODE_CACHE=NO TS_NODE_COMPILER_OPTIONS='{\"module\":\"commonjs\"}' nyc --reporter lcovonly -- mocha 'test/{,!(browser)/**/}*.test.ts' --file index.node.ts --opts ../../config/mocha.node.opts",
     "test:emulator": "ts-node --compiler-options='{\"module\":\"commonjs\"}' ../../scripts/emulator-testing/database-test-runner.ts",
     "prepare": "yarn build"
   },
diff --git a/packages/database/src/core/AuthTokenProvider.ts b/packages/database/src/core/AuthTokenProvider.ts
@@ -15,48 +15,65 @@
  * limitations under the License.
  */
 
-import { FirebaseApp } from '@firebase/app-types';
 import { FirebaseAuthTokenData } from '@firebase/app-types/private';
+import { FirebaseAuthInternal } from '@firebase/auth-interop-types';
+import { Provider } from '@firebase/component';
 import { log, warn } from './util/util';
+import { FirebaseApp } from '@firebase/app-types';
 
 /**
  * Abstraction around FirebaseApp's token fetching capabilities.
  */
 export class AuthTokenProvider {
-  /**
-   * @param {!FirebaseApp} app_
-   */
-  constructor(private app_: FirebaseApp) {}
+  private auth_: FirebaseAuthInternal | null = null;
+  constructor(
+    private app_: FirebaseApp,
+    private authProvider_: Provider<FirebaseAuthInternal>
+  ) {
+    this.auth_ = authProvider_.getImmediate({ optional: true });
+    if (!this.auth_) {
+      authProvider_.get().then(auth => (this.auth_ = auth));
+    }
+  }
 
   /**
    * @param {boolean} forceRefresh
    * @return {!Promise<FirebaseAuthTokenData>}
    */
   getToken(forceRefresh: boolean): Promise<FirebaseAuthTokenData> {
-    return this.app_['INTERNAL']['getToken'](forceRefresh).then(
-      null,
-      // .catch
-      function(error) {
-        // TODO: Need to figure out all the cases this is raised and whether
-        // this makes sense.
-        if (error && error.code === 'auth/token-not-initialized') {
-          log('Got auth/token-not-initialized error.  Treating as null token.');
-          return null;
-        } else {
-          return Promise.reject(error);
-        }
+    if (!this.auth_) {
+      return Promise.resolve(null);
+    }
+
+    return this.auth_.getToken(forceRefresh).catch(function(error) {
+      // TODO: Need to figure out all the cases this is raised and whether
+      // this makes sense.
+      if (error && error.code === 'auth/token-not-initialized') {
+        log('Got auth/token-not-initialized error.  Treating as null token.');
+        return null;
+      } else {
+        return Promise.reject(error);
       }
-    );
+    });
   }
 
   addTokenChangeListener(listener: (token: string | null) => void) {
     // TODO: We might want to wrap the listener and call it with no args to
     // avoid a leaky abstraction, but that makes removing the listener harder.
-    this.app_['INTERNAL']['addAuthTokenListener'](listener);
+    if (this.auth_) {
+      this.auth_.addAuthTokenListener(listener);
+    } else {
+      setTimeout(() => listener(null), 0);
+      this.authProvider_
+        .get()
+        .then(auth => auth.addAuthTokenListener(listener));
+    }
   }
 
   removeTokenChangeListener(listener: (token: string | null) => void) {
-    this.app_['INTERNAL']['removeAuthTokenListener'](listener);
+    this.authProvider_
+      .get()
+      .then(auth => auth.removeAuthTokenListener(listener));
   }
 
   notifyForInvalidToken() {
diff --git a/packages/database/src/core/Repo.ts b/packages/database/src/core/Repo.ts
@@ -44,6 +44,8 @@ import { EventRegistration } from './view/EventRegistration';
 import { StatsCollection } from './stats/StatsCollection';
 import { Event } from './view/Event';
 import { Node } from './snap/Node';
+import { FirebaseAuthInternal } from '@firebase/auth-interop-types';
+import { Provider } from '@firebase/component';
 
 const INTERRUPT_REASON = 'repo_interrupt';
 
@@ -79,9 +81,10 @@ export class Repo {
   constructor(
     public repoInfo_: RepoInfo,
     forceRestClient: boolean,
-    public app: FirebaseApp
+    public app: FirebaseApp,
+    authProvider: Provider<FirebaseAuthInternal>
   ) {
-    const authTokenProvider = new AuthTokenProvider(app);
+    const authTokenProvider = new AuthTokenProvider(app, authProvider);
 
     this.stats_ = StatsManager.getCollection(repoInfo_);
 
diff --git a/packages/database/src/core/RepoManager.ts b/packages/database/src/core/RepoManager.ts
diff --git a/packages/database/test/browser/crawler_support.test.ts b/packages/database/test/browser/crawler_support.test.ts
diff --git a/packages/database/test/helpers/util.ts b/packages/database/test/helpers/util.ts
