Support lazy-loaded Auth

Author: schmidt-sebastian

common/api-review/database.api.md

@@ -7,7 +7,7 @@
 import { EmulatorMockTokenOptions } from '@firebase/util';
 import { FirebaseApp } from '@firebase/app';
 
-// @public
+// @public (undocumented)
 export function child(parent: Reference, path: string): Reference;
 
 // @public

packages/component/src/provider.ts

@@ -22,7 +22,8 @@ import {
   InitializeOptions,
   InstantiationMode,
   Name,
-  NameServiceMapping
+  NameServiceMapping,
+  OnInitCallBack
 } from './types';
 import { Component } from './component';
 
@@ -37,6 +38,7 @@ export class Provider<T extends Name> {
     string,
     Deferred<NameServiceMapping[T]>
   > = new Map();
+  private onInitCallbacks: Set<OnInitCallBack<T>> = new Set();
 
   constructor(
     private readonly name: T,
@@ -250,9 +252,45 @@ export class Provider<T extends Name> {
         instanceDeferred.resolve(instance);
       }
     }
+
+    this.invokeOnInitCallbacks(instance, normalizedIdentifier);
     return instance;
   }
 
+  /**
+   *
+   * @param callback - a function that will be invoked  after the provider has
+   * been initialized by calling provider.initialize().
+   * The function is invoked SYNCHRONOUSLY, so it should not execute any
+   * longrunning tasks in order to not block the program.
+   *
+   * @returns a function to unregister the callback
+   */
+  onInit(callback: (instance: NameServiceMapping[T]) => void): () => void {
+    this.onInitCallbacks.add(callback);
+
+    return () => {
+      this.onInitCallbacks.delete(callback);
+    };
+  }
+
+  /**
+   * Invoke onInit callbacks synchronously
+   * @param instance the service instance`
+   */
+  private invokeOnInitCallbacks(
+    instance: NameServiceMapping[T],
+    identifier: string
+  ): void {
+    for (const callback of this.onInitCallbacks) {
+      try {
+        callback(instance, identifier);
+      } catch {
+        // ignore errors in the onInit callback
+      }
+    }
+  }
+
   private getOrInitializeService({
     instanceIdentifier,
     options = {}

packages/component/src/types.ts

@@ -75,3 +75,8 @@ export interface NameServiceMapping {}
 
 export type Name = keyof NameServiceMapping;
 export type Service = NameServiceMapping[Name];
+
+export type OnInitCallBack<T extends Name> = (
+  instance: NameServiceMapping[T],
+  identifier: string
+) => void;

packages/database/index.ts

@@ -28,9 +28,8 @@ import { Database } from './src/api/Database';
 import * as INTERNAL from './src/api/internal';
 import { DataSnapshot, Query, Reference } from './src/api/Reference';
 import * as TEST_ACCESS from './src/api/test_access';
-import { enableLogging } from './src/core/util/util';
 import { setSDKVersion } from './src/core/version';
-import { repoManagerDatabaseFromApp } from './src/exp/Database';
+import { enableLogging, repoManagerDatabaseFromApp } from './src/exp/Database';
 
 const ServerValue = Database.ServerValue;
 

packages/database/src/api/Database.ts

@@ -25,6 +25,7 @@ import {
 } from '@firebase/util';
 
 import {
+  FirebaseDatabase as ExpDatabase,
   goOnline,
   useDatabaseEmulator,
   goOffline,
@@ -36,14 +37,6 @@ import {
 
 import { Reference } from './Reference';
 
-// TODO: revert to import {FirebaseDatabase as ExpDatabase} from '@firebase/database' once modular SDK goes GA
-/**
- * This is a workaround for an issue in the no-modular '@firebase/database' where its typings
- * reference types from `@firebase/app-exp`.
- */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-type ExpDatabase = any;
-
 /**
  * Class representing a firebase database.
  */

packages/database/src/api/Reference.ts

@@ -26,6 +26,7 @@ import {
 
 import {
   OnDisconnect as ExpOnDisconnect,
+  DataSnapshot as ExpDataSnapshot,
   off,
   onChildAdded,
   onChildChanged,
@@ -53,6 +54,8 @@ import {
   setPriority,
   push,
   runTransaction,
+  Query as ExpQuery,
+  Reference as ExpReference,
   _QueryImpl,
   _ReferenceImpl,
   child
@@ -72,19 +75,6 @@ import { Database } from './Database';
 import { OnDisconnect } from './onDisconnect';
 import { TransactionResult } from './TransactionResult';
 
-// TODO: revert to import {  DataSnapshot as ExpDataSnapshot, Query as ExpQuery,
-// Reference as ExpReference,} from '../../exp/index'; once the modular SDK goes GA
-/**
- * This is part of a workaround for an issue in the no-modular '@firebase/database' where its typings
- * reference types from `@firebase/app-exp`.
- */
-
-/* eslint-disable @typescript-eslint/no-explicit-any */
-type ExpDataSnapshot = any;
-type ExpQuery = any;
-type ExpReference = any;
-/* eslint-enable @typescript-eslint/no-explicit-any */
-
 /**
  * Class representing a firebase data snapshot.  It wraps a SnapshotNode and
  * surfaces the public methods (val, forEach, etc.) we want to expose.

packages/database/src/api/onDisconnect.ts

@@ -17,17 +17,10 @@
 
 import { validateArgCount, validateCallback, Compat } from '@firebase/util';
 
+import { OnDisconnect as ExpOnDisconnect } from '../../exp/index';
 import { Indexable } from '../core/util/misc';
 import { warn } from '../core/util/util';
 
-// TODO: revert to import { OnDisconnect as ExpOnDisconnect } from '../../exp/index'; once the modular SDK goes GA
-/**
- * This is a workaround for an issue in the no-modular '@firebase/database' where its typings
- * reference types from `@firebase/app-exp`.
- */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-type ExpOnDisconnect = any;
-
 export class OnDisconnect implements Compat<ExpOnDisconnect> {
   constructor(readonly _delegate: ExpOnDisconnect) {}
 

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

@@ -26,14 +26,8 @@ import {
 } from '@firebase/util';
 
 import { SessionStorage } from '../storage/storage';
+import { QueryContext } from '../view/EventRegistration';
 
-// TODO: revert to import { QueryContext } from '../view/EventRegistration'; once the modular SDK goes GA
-/**
- * This is part of a workaround for an issue in the no-modular '@firebase/database' where its typings
- * reference types from `@firebase/app-exp`.
- */
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-type QueryContext = any;
 declare const window: Window;
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 declare const Windows: any;