let factory accept options

Author: Feiyang1

packages-exp/analytics-compat/src/index.ts

@@ -41,16 +41,13 @@ declare module '@firebase/component' {
 }
 
 const factory: InstanceFactory<'analytics-compat'> = (
-  container: ComponentContainer,
-  regionOrCustomDomain?: string
+  container: ComponentContainer
 ) => {
   // Dependencies
   const app = container.getProvider('app-compat').getImmediate();
   const analyticsServiceExp = container
     .getProvider('analytics-exp')
-    .getImmediate({
-      identifier: regionOrCustomDomain
-    });
+    .getImmediate();
 
   return new AnalyticsService(app as FirebaseApp, analyticsServiceExp);
 };

packages-exp/functions-exp/src/config.ts

@@ -30,7 +30,7 @@ export const DEFAULT_REGION = 'us-central1';
 export function registerFunctions(fetchImpl: typeof fetch): void {
   const factory: InstanceFactory<'functions'> = (
     container: ComponentContainer,
-    regionOrCustomDomain?: string
+    { instanceIdentifier: regionOrCustomDomain }
   ) => {
     // Dependencies
     const app = container.getProvider('app-exp').getImmediate();

packages-exp/remote-config-compat/src/index.ts

@@ -19,7 +19,8 @@ import firebase, { _FirebaseNamespace } from '@firebase/app-compat';
 import {
   Component,
   ComponentContainer,
-  ComponentType
+  ComponentType,
+  InstanceFactoryOptions
 } from '@firebase/component';
 import { RemoteConfigCompatImpl } from './remoteConfig';
 import { name as packageName, version } from '../package.json';
@@ -48,7 +49,7 @@ function registerRemoteConfigCompat(
 
 function remoteConfigFactory(
   container: ComponentContainer,
-  namespace?: string
+  { instanceIdentifier: namespace }: InstanceFactoryOptions
 ): RemoteConfigCompatImpl {
   const app = container.getProvider('app-compat').getImmediate();
   // The following call will always succeed because rc `import {...} from '@firebase/remote-config-exp'`

packages-exp/remote-config-exp/src/register.ts

@@ -22,7 +22,8 @@ import {
 import {
   Component,
   ComponentType,
-  ComponentContainer
+  ComponentContainer,
+  InstanceFactoryOptions
 } from '@firebase/component';
 import { Logger, LogLevel as FirebaseLogLevel } from '@firebase/logger';
 import { RemoteConfig } from './public_types';
@@ -53,7 +54,7 @@ export function registerRemoteConfig(): void {
 
   function remoteConfigFactory(
     container: ComponentContainer,
-    namespace?: string
+    { instanceIdentifier: namespace }: InstanceFactoryOptions
   ): RemoteConfig {
     /* Dependencies */
     // getImmediate for FirebaseApp will always succeed

packages/component/index.ts

@@ -23,5 +23,6 @@ export {
   InstanceFactory,
   InstantiationMode,
   NameServiceMapping,
-  Name
+  Name,
+  InstanceFactoryOptions
 } from './src/types';

packages/component/src/provider.ts

@@ -195,10 +195,9 @@ export class Provider<T extends Name> {
   ): NameServiceMapping[T] | null {
     let instance = this.instances.get(identifier);
     if (!instance && this.component) {
-      instance = this.component.instanceFactory(
-        this.container,
-        normalizeIdentifierForFactory(identifier)
-      ) as NameServiceMapping[T];
+      instance = this.component.instanceFactory(this.container, {
+        instanceIdentifier: normalizeIdentifierForFactory(identifier)
+      }) as NameServiceMapping[T];
       this.instances.set(identifier, instance);
     }
 

packages/component/src/types.ts

@@ -36,6 +36,11 @@ export const enum ComponentType {
   VERSION = 'VERSION'
 }
 
+export interface InstanceFactoryOptions {
+  instanceIdentifier?: string;
+  options?: Record<string, unknown>;
+}
+
 /**
  * Factory to create an instance of type T, given a ComponentContainer.
  * ComponentContainer is the IOC container that provides {@link Provider}
@@ -46,7 +51,7 @@ export const enum ComponentType {
  */
 export type InstanceFactory<T extends Name> = (
   container: ComponentContainer,
-  instanceIdentifier?: string
+  options: InstanceFactoryOptions
 ) => NameServiceMapping[T];
 
 export interface Dictionary {

packages/database/exp/index.ts

@@ -35,7 +35,7 @@ function registerDatabase(): void {
   _registerComponent(
     new Component(
       'database-exp',
-      (container, url) => {
+      (container, { instanceIdentifier: url }) => {
         const app = container.getProvider('app-exp').getImmediate()!;
         const authProvider = container.getProvider('auth-internal');
         return new FirebaseDatabase(app, authProvider, url);

packages/database/index.ts

@@ -44,7 +44,7 @@ export function registerDatabase(instance: FirebaseNamespace) {
   const namespace = (instance as _FirebaseNamespace).INTERNAL.registerComponent(
     new Component(
       'database',
-      (container, url) => {
+      (container, { instanceIdentifier: url }) => {
         /* Dependencies */
         // getImmediate for FirebaseApp will always succeed
         const app = container.getProvider('app').getImmediate();

packages/firestore/src/exp/database.ts

@@ -128,6 +128,9 @@ export function initializeFirestore(
     );
   }
 
+  /**
+   * create a firestore instance with the default settings
+   */
   const firestore = provider.getImmediate() as FirebaseFirestore;
   if (
     settings.cacheSizeBytes !== undefined &&
@@ -140,6 +143,9 @@ export function initializeFirestore(
     );
   }
 
+  /**
+   * update settings with the user supplied values on the firestore instance
+   */
   firestore._setSettings(settings);
   return firestore;
 }

packages/functions/src/config.ts

@@ -19,7 +19,8 @@ import { Service } from './api/service';
 import {
   Component,
   ComponentType,
-  ComponentContainer
+  ComponentContainer,
+  InstanceFactoryOptions
 } from '@firebase/component';
 import { _FirebaseNamespace } from '@firebase/app-types/private';
 
@@ -39,7 +40,7 @@ export function registerFunctions(
 
   function factory(
     container: ComponentContainer,
-    regionOrCustomDomain?: string
+    { instanceIdentifier: regionOrCustomDomain }: InstanceFactoryOptions
   ): Service {
     // Dependencies
     const app = container.getProvider('app').getImmediate();

packages/remote-config/index.ts

@@ -31,7 +31,8 @@ import { name as packageName, version } from './package.json';
 import {
   Component,
   ComponentType,
-  ComponentContainer
+  ComponentContainer,
+  InstanceFactoryOptions
 } from '@firebase/component';
 
 // Facilitates debugging by enabling settings changes without rebuilding asset.
@@ -59,7 +60,7 @@ export function registerRemoteConfig(
 
   function remoteConfigFactory(
     container: ComponentContainer,
-    namespace?: string
+    { instanceIdentifier: namespace }: InstanceFactoryOptions
   ): RemoteConfig {
     /* Dependencies */
     // getImmediate for FirebaseApp will always succeed

packages/storage/compat/index.ts

@@ -28,7 +28,8 @@ import * as types from '@firebase/storage-types';
 import {
   Component,
   ComponentType,
-  ComponentContainer
+  ComponentContainer,
+  InstanceFactoryOptions
 } from '@firebase/component';
 
 import { name, version } from '../package.json';
@@ -40,7 +41,7 @@ const STORAGE_TYPE = 'storage';
 
 function factory(
   container: ComponentContainer,
-  url?: string
+  { instanceIdentifier: url }: InstanceFactoryOptions
 ): types.FirebaseStorage {
   // Dependencies
   // TODO: This should eventually be 'app-compat'

packages/storage/exp/index.ts

@@ -33,7 +33,8 @@ import {
   Component,
   ComponentType,
   ComponentContainer,
-  Provider
+  Provider,
+  InstanceFactoryOptions
 } from '@firebase/component';
 
 import { name, version } from '../package.json';
@@ -295,7 +296,10 @@ export function getStorage(
   return storageInstance;
 }
 
-function factory(container: ComponentContainer, url?: string): StorageService {
+function factory(
+  container: ComponentContainer,
+  { instanceIdentifier: url }: InstanceFactoryOptions
+): StorageService {
   const app = container.getProvider('app-exp').getImmediate();
   const authProvider = container.getProvider('auth-internal');