Component framework implementation

packages/analytics/index.ts

@@ -16,6 +16,7 @@
  */
 import firebase from '@firebase/app';
 import { FirebaseAnalytics } from '@firebase/analytics-types';
+import { FirebaseAnalyticsInternal } from '@firebase/analytics-interop-types';
 import { _FirebaseNamespace } from '@firebase/app-types/private';
 import { factory, settings, resetGlobalVars } from './src/factory';
 import { EventName } from './src/constants';
@@ -39,7 +40,7 @@ export function registerAnalytics(instance: _FirebaseNamespace): void {
       ANALYTICS_TYPE,
       container => {
         // getImmediate for FirebaseApp will always succeed
-        const app = container.getProvider('app').getImmediate()!;
+        const app = container.getProvider('app').getImmediate();
         return factory(app);
       },
       ComponentType.PUBLIC
@@ -59,7 +60,7 @@ export function registerAnalytics(instance: _FirebaseNamespace): void {
             .getImmediate();
           return {
             logEvent: analytics.logEvent
-          };
+          } as FirebaseAnalyticsInternal;
         } catch (e) {
           throw ERROR_FACTORY.create(
             AnalyticsError.INTEROP_COMPONENT_REG_FAILED,
@@ -89,9 +90,7 @@ declare module '@firebase/app-types' {
 }
 
 declare module '@firebase/component' {
-  interface ComponentContainer {
-    getProvider(name: typeof ANALYTICS_TYPE): Provider<FirebaseAnalytics>;
+  interface NameServiceMapping {
+    'analytics': FirebaseAnalytics;
   }
-
-  interface Provider<T> {}
 }

packages/app/index.node.ts

@@ -18,7 +18,6 @@
 import { FirebaseNamespace, FirebaseApp } from '@firebase/app-types';
 import { _FirebaseNamespace } from '@firebase/app-types/private';
 import { firebase as _firebase } from './src/firebaseNamespace';
-import { Provider } from '@firebase/component';
 // Node specific packages.
 // @ts-ignore
 import Storage from 'dom-storage';
@@ -41,7 +40,7 @@ export const firebase = _firebase as FirebaseNamespace;
 export default firebase;
 
 declare module '@firebase/component' {
-  interface ComponentContainer {
-    getProvider(name: 'app'): Provider<FirebaseApp>;
+  interface NameServiceMapping {
+    'app': FirebaseApp;
   }
 }

packages/app/index.rn.ts

@@ -18,7 +18,6 @@
 import { FirebaseNamespace, FirebaseApp } from '@firebase/app-types';
 import { _FirebaseNamespace } from '@firebase/app-types/private';
 import { firebase as _firebase } from './src/firebaseNamespace';
-import { Provider } from '@firebase/component';
 /**
  * To avoid having to include the @types/react-native package, which breaks
  * some of our tests because of duplicate symbols, we are using require syntax
@@ -41,7 +40,7 @@ export const firebase = _firebase as FirebaseNamespace;
 export default firebase;
 
 declare module '@firebase/component' {
-  interface ComponentContainer {
-    getProvider(name: 'app'): Provider<FirebaseApp>;
+  interface NameServiceMapping {
+    'app': FirebaseApp;
   }
 }

packages/app/index.ts

@@ -18,7 +18,6 @@
 import { FirebaseNamespace, FirebaseApp } from '@firebase/app-types';
 import { firebase as firebaseNamespace } from './src/firebaseNamespace';
 import { isNode, isBrowser } from '@firebase/util';
-import { Provider } from '@firebase/component';
 import { logger } from './src/logger';
 
 // Firebase Lite detection
@@ -72,7 +71,7 @@ export const firebase = firebaseNamespace;
 export default firebase;
 
 declare module '@firebase/component' {
-  interface ComponentContainer {
-    getProvider(name: 'app'): Provider<FirebaseApp>;
+  interface NameServiceMapping {
+    'app': FirebaseApp;
   }
 }

packages/app/src/firebaseApp.ts

@@ -123,9 +123,14 @@ export class FirebaseAppImpl implements FirebaseApp {
     this.checkDestroyed_();
 
     // getImmediate will always succeed because _getService is only called for registered components.
-    return this.container
-      .getProvider(name)
-      .getImmediate(instanceIdentifier) as FirebaseService;
+    return (
+      (this.container
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        .getProvider(name as any)
+        .getImmediate({
+          identifier: instanceIdentifier
+        }) as unknown) as FirebaseService
+    );
   }
   /**
    * Remove a service instance from the cache, so we will create a new instance for this service
@@ -141,19 +146,16 @@ export class FirebaseAppImpl implements FirebaseApp {
     name: string,
     instanceIdentifier: string = DEFAULT_ENTRY_NAME
   ): void {
-    this.container.getProvider(name).clearInstance(instanceIdentifier);
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    this.container.getProvider(name as any).clearInstance(instanceIdentifier);
   }
 
   /**
-   *
    * @param component the component being added to this app's container
-   * @param overwrite When a component with the same name has already been registered,
-   * if overwrite is true: overwrite the existing component
-   * if overwrite is false: throw an expection
    */
-  _addComponent(component: Component, overwrite = false): void {
+  _addComponent(component: Component): void {
     try {
-      this.container.addComponent(component, overwrite);
+      this.container.addComponent(component);
     } catch (e) {
       logger.debug(
         `Component ${component.name} failed to register with FirebaseApp ${this.name}`,
@@ -162,6 +164,10 @@ export class FirebaseAppImpl implements FirebaseApp {
     }
   }
 
+  _addOrOverwriteComponent(component: Component): void {
+    this.container.addOrOverwriteComponent(component);
+  }
+
   /**
    * This function will throw an Error if the App has already been deleted -
    * use before performing API actions on the App.

packages/app/src/firebaseNamespaceCore.ts

@@ -47,7 +47,8 @@ export function createFirebaseNamespaceCore(
   firebaseAppImpl: typeof FirebaseAppImpl | typeof FirebaseAppLiteImpl
 ): FirebaseNamespace {
   const apps: { [name: string]: FirebaseApp } = {};
-  const components = new Map<string, Component>();
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  const components = new Map<string, Component<any>>();
 
   // A namespace is a plain JavaScript Object.
   const namespace: FirebaseNamespace = {

packages/app/src/lite/firebaseAppLite.ts

@@ -133,9 +133,14 @@ export class FirebaseAppLiteImpl implements FirebaseApp {
     this.checkDestroyed_();
 
     // getImmediate will always succeed because _getService is only called for registered components.
-    return this.container
-      .getProvider(name)
-      .getImmediate(instanceIdentifier) as FirebaseService;
+    return (
+      (this.container
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        .getProvider(name as any)
+        .getImmediate({
+          identifier: instanceIdentifier
+        }) as unknown) as FirebaseService
+    );
   }
 
   /**

packages/app/src/lite/firebaseNamespaceLite.ts

@@ -40,7 +40,8 @@ export function createFirebaseNamespaceLite(): FirebaseNamespace {
    * only allow performance SDK to register.
    */
   function registerComponentForLite(
-    component: Component
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    component: Component<any>
   ): FirebaseServiceNamespace<FirebaseService> | null {
     // only allow performance to register with firebase lite
     if (

packages/app/test/firebaseApp.test.ts

@@ -336,8 +336,9 @@ function createTestComponent(
   type = ComponentType.PUBLIC
 ): Component {
   const component = new Component(
-    name,
-    container => new TestService(container.getProvider('app').getImmediate()!),
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    name as any,
+    container => new TestService(container.getProvider('app').getImmediate()),
     type
   );
   component.setMultipleInstances(multiInstances);

packages/component/src/component.ts

@@ -25,7 +25,7 @@ import {
 /**
  * Component for service name T, e.g. `auth`, `auth-internal`
  */
-export class Component<T extends Name> {
+export class Component<T extends Name = Name> {
   multipleInstances = false;
   /**
    * Properties to be added to the service namespace

packages/component/src/component_container.ts

@@ -22,8 +22,8 @@ import { Name } from './types';
 /**
  * ComponentContainer that provides Providers for service name T, e.g. `auth`, `auth-internal`
  */
-export class ComponentContainer<T extends Name = Name> {
-  private readonly providers = new Map<string, Provider<T>>();
+export class ComponentContainer {
+  private readonly providers = new Map<string, Provider>();
 
   constructor(private readonly name: string) {}
 
@@ -36,7 +36,7 @@ export class ComponentContainer<T extends Name = Name> {
    * for different tests.
    * if overwrite is false: throw an exception
    */
-  addComponent(component: Component<T>): void {
+  addComponent<T extends Name>(component: Component<T>): void {
     const provider = this.getProvider(component.name);
     if (provider.isComponentSet()) {
       throw new Error(
@@ -47,7 +47,7 @@ export class ComponentContainer<T extends Name = Name> {
     provider.setComponent(component);
   }
 
-  addOrOverwriteComponent(component: Component<T>): void {
+  addOrOverwriteComponent<T extends Name>(component: Component<T>): void {
     const provider = this.getProvider(component.name);
     if (provider.isComponentSet()) {
       // delete the existing provider from the container, so we can register the new component
@@ -64,7 +64,7 @@ export class ComponentContainer<T extends Name = Name> {
    * Firebase SDKs providing services should extend NameServiceMapping interface to register
    * themselves.
    */
-  getProvider(name: T): Provider<T> {
+  getProvider<T extends Name>(name: T): Provider<T> {
     if (this.providers.has(name)) {
       return this.providers.get(name) as Provider<T>;
     }
@@ -76,7 +76,7 @@ export class ComponentContainer<T extends Name = Name> {
     return provider as Provider<T>;
   }
 
-  getProviders(): Array<Provider<T>> {
+  getProviders(): Provider[] {
     return Array.from(this.providers.values());
   }
 }

packages/component/src/provider.ts

@@ -25,7 +25,7 @@ import { Component } from './component';
  * Provider for instance for service name T, e.g. 'auth', 'auth-internal'
  * U is an alias for the type of the instance
  */
-export class Provider<T extends Name, U = NameServiceMapping[T]> {
+export class Provider<T extends Name = Name, U = NameServiceMapping[T]> {
   private component: Component<T> | null = null;
   private readonly instances: Map<string, U> = new Map();
   private readonly instancesDeferred: Map<string, Deferred<U>> = new Map();
@@ -64,18 +64,12 @@ export class Provider<T extends Name, U = NameServiceMapping[T]> {
    * the service is not immediately available.
    * If optional is true, the method returns null if the service is not immediately available.
    */
-  getImmediate(options: {
-    identifier?: string;
-    optional: true;
-  }): NameServiceMapping[T] | null;
-  getImmediate(options?: {
-    identifier?: string;
-    optional?: false;
-  }): NameServiceMapping[T];
+  getImmediate(options: { identifier?: string; optional: true }): U | null;
+  getImmediate(options?: { identifier?: string; optional?: false }): U;
   getImmediate(options?: {
     identifier?: string;
     optional?: boolean;
-  }): NameServiceMapping[T] | null {
+  }): U | null {
     const { identifier, optional } = {
       identifier: DEFAULT_ENTRY_NAME,
       optional: false,

packages/component/src/types.ts

@@ -56,7 +56,9 @@ export interface Dictionary {
  * This interface will be extended by Firebase SDKs to provide service name and service type mapping.
  * It is used as a generic constraint to ensure type safety.
  */
-export interface NameServiceMapping {}
+export interface NameServiceMapping {
+  'app': string;
+}
 
 export type Name = keyof NameServiceMapping;
 export type Service = NameServiceMapping[Name];