Extract Offline-only component provider (#3460)

Author: schmidt-sebastian

packages/firestore/exp/dependencies.json

@@ -23,8 +23,9 @@ import {
 } from '../../../src/core/firestore_client';
 import { Code, FirestoreError } from '../../../src/util/error';
 import {
-  ComponentProvider,
-  MemoryComponentProvider
+  MemoryOfflineComponentProvider,
+  OfflineComponentProvider,
+  OnlineComponentProvider
 } from '../../../src/core/component_provider';
 import { DEFAULT_HOST, DEFAULT_SSL } from '../../../lite/src/api/components';
 import { logDebug } from '../../../src/util/log';
@@ -58,9 +59,14 @@ export function getFirestoreClient(
   }
   if (!firestoreClientInstances.has(firestore)) {
     // eslint-disable-next-line @typescript-eslint/no-floating-promises
-    initializeFirestoreClient(firestore, new MemoryComponentProvider(), {
-      durable: false
-    });
+    initializeFirestoreClient(
+      firestore,
+      new MemoryOfflineComponentProvider(),
+      new OnlineComponentProvider(),
+      {
+        durable: false
+      }
+    );
   }
   return firestoreClientInstances.get(firestore)!;
 }
@@ -71,12 +77,16 @@ export function getFirestoreClient(
  *
  * @param firestore The Firestore instance for which to create the
  * FirestoreClient.
- * @param componentProvider The component provider to use.
+ * @param offlineComponentProvider Provider that returns all components required
+ * for memory-only or IndexedDB persistence.
+ * @param onlineComponentProvider Provider that returns all components required
+ * for online support.
  * @param persistenceSettings Settings for the component provider.
  */
 export function initializeFirestoreClient(
   firestore: Firestore,
-  componentProvider: ComponentProvider,
+  offlineComponentProvider: OfflineComponentProvider,
+  onlineComponentProvider: OnlineComponentProvider,
   persistenceSettings: PersistenceSettings
 ): Promise<void> {
   if (firestoreClientInstances.has(firestore)) {
@@ -102,7 +112,8 @@ export function initializeFirestoreClient(
   );
   const initializationPromise = firestoreClient.start(
     databaseInfo,
-    componentProvider,
+    offlineComponentProvider,
+    onlineComponentProvider,
     persistenceSettings
   );
   firestoreClientInstances.set(

packages/firestore/exp/src/api/components.ts

@@ -24,8 +24,9 @@ import { Provider } from '@firebase/component';
 import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
 import { AsyncQueue } from '../../../src/util/async_queue';
 import {
-  IndexedDbComponentProvider,
-  MultiTabIndexedDbComponentProvider
+  IndexedDbOfflineComponentProvider,
+  MultiTabOfflineComponentProvider,
+  OnlineComponentProvider
 } from '../../../src/core/component_provider';
 
 import { Firestore as LiteFirestore } from '../../../lite/src/api/database';
@@ -110,7 +111,8 @@ export function enableIndexedDbPersistence(
   const settings = firestoreImpl._getSettings();
   return initializeFirestoreClient(
     firestoreImpl,
-    new IndexedDbComponentProvider(),
+    new IndexedDbOfflineComponentProvider(),
+    new OnlineComponentProvider(),
     {
       durable: true,
       synchronizeTabs: false,
@@ -125,10 +127,15 @@ export function enableMultiTabIndexedDbPersistence(
   firestore: firestore.FirebaseFirestore
 ): Promise<void> {
   const firestoreImpl = cast(firestore, Firestore);
+  const onlineComponentProvider = new OnlineComponentProvider();
+  const offlineComponentProvider = new MultiTabOfflineComponentProvider(
+    onlineComponentProvider
+  );
   const settings = firestoreImpl._getSettings();
   return initializeFirestoreClient(
     firestoreImpl,
-    new MultiTabIndexedDbComponentProvider(),
+    offlineComponentProvider,
+    onlineComponentProvider,
     {
       durable: true,
       synchronizeTabs: true,

packages/firestore/exp/src/api/database.ts

@@ -19,7 +19,10 @@ import firebase from '@firebase/app';
 import { FirebaseNamespace } from '@firebase/app-types';
 
 import { Firestore } from './src/api/database';
-import { MemoryComponentProvider } from './src/core/component_provider';
+import {
+  MemoryOfflineComponentProvider,
+  OnlineComponentProvider
+} from './src/core/component_provider';
 import { configureForFirebase } from './src/config';
 
 import './register-module';
@@ -32,7 +35,13 @@ import { name, version } from './package.json';
 export function registerFirestore(instance: FirebaseNamespace): void {
   configureForFirebase(
     instance,
-    (app, auth) => new Firestore(app, auth, new MemoryComponentProvider())
+    (app, auth) =>
+      new Firestore(
+        app,
+        auth,
+        new MemoryOfflineComponentProvider(),
+        new OnlineComponentProvider()
+      )
   );
   instance.registerVersion(name, version);
 }

packages/firestore/index.memory.ts

@@ -19,7 +19,10 @@ import firebase from '@firebase/app';
 import { FirebaseNamespace } from '@firebase/app-types';
 
 import { Firestore } from './src/api/database';
-import { MemoryComponentProvider } from './src/core/component_provider';
+import {
+  MemoryOfflineComponentProvider,
+  OnlineComponentProvider
+} from './src/core/component_provider';
 import { configureForFirebase } from './src/config';
 import './register-module';
 
@@ -32,7 +35,13 @@ import { name, version } from './package.json';
 export function registerFirestore(instance: FirebaseNamespace): void {
   configureForFirebase(
     instance,
-    (app, auth) => new Firestore(app, auth, new MemoryComponentProvider())
+    (app, auth) =>
+      new Firestore(
+        app,
+        auth,
+        new MemoryOfflineComponentProvider(),
+        new OnlineComponentProvider()
+      )
   );
   instance.registerVersion(name, version, 'node');
 }

packages/firestore/index.node.memory.ts

@@ -18,7 +18,10 @@ import firebase from '@firebase/app';
 import { FirebaseNamespace } from '@firebase/app-types';
 
 import { Firestore } from './src/api/database';
-import { MultiTabIndexedDbComponentProvider } from './src/core/component_provider';
+import {
+  MultiTabOfflineComponentProvider,
+  OnlineComponentProvider
+} from './src/core/component_provider';
 import { configureForFirebase } from './src/config';
 
 import './register-module';
@@ -30,11 +33,18 @@ import { name, version } from './package.json';
  * Persistence can be enabled via `firebase.firestore().enablePersistence()`.
  */
 export function registerFirestore(instance: FirebaseNamespace): void {
-  configureForFirebase(
-    instance,
-    (app, auth) =>
-      new Firestore(app, auth, new MultiTabIndexedDbComponentProvider())
-  );
+  configureForFirebase(instance, (app, auth) => {
+    const onlineComponentProvider = new OnlineComponentProvider();
+    const offlineComponentProvider = new MultiTabOfflineComponentProvider(
+      onlineComponentProvider
+    );
+    return new Firestore(
+      app,
+      auth,
+      offlineComponentProvider,
+      onlineComponentProvider
+    );
+  });
   instance.registerVersion(name, version, 'node');
 }
 

packages/firestore/index.node.ts

@@ -19,7 +19,10 @@ import firebase from '@firebase/app';
 import { FirebaseNamespace } from '@firebase/app-types';
 
 import { Firestore } from './src/api/database';
-import { MemoryComponentProvider } from './src/core/component_provider';
+import {
+  MemoryOfflineComponentProvider,
+  OnlineComponentProvider
+} from './src/core/component_provider';
 import { configureForFirebase } from './src/config';
 
 import './register-module';
@@ -33,7 +36,13 @@ import { name, version } from './package.json';
 export function registerFirestore(instance: FirebaseNamespace): void {
   configureForFirebase(
     instance,
-    (app, auth) => new Firestore(app, auth, new MemoryComponentProvider())
+    (app, auth) =>
+      new Firestore(
+        app,
+        auth,
+        new MemoryOfflineComponentProvider(),
+        new OnlineComponentProvider()
+      )
   );
   instance.registerVersion(name, version, 'rn');
 }

packages/firestore/index.rn.memory.ts

@@ -18,7 +18,10 @@ import firebase from '@firebase/app';
 import { FirebaseNamespace } from '@firebase/app-types';
 
 import { Firestore } from './src/api/database';
-import { MultiTabIndexedDbComponentProvider } from './src/core/component_provider';
+import {
+  MultiTabOfflineComponentProvider,
+  OnlineComponentProvider
+} from './src/core/component_provider';
 import { configureForFirebase } from './src/config';
 
 import './register-module';
@@ -29,11 +32,18 @@ import { name, version } from './package.json';
  * Persistence can be enabled via `firebase.firestore().enablePersistence()`.
  */
 export function registerFirestore(instance: FirebaseNamespace): void {
-  configureForFirebase(
-    instance,
-    (app, auth) =>
-      new Firestore(app, auth, new MultiTabIndexedDbComponentProvider())
-  );
+  configureForFirebase(instance, (app, auth) => {
+    const onlineComponentProvider = new OnlineComponentProvider();
+    const offlineComponentProvider = new MultiTabOfflineComponentProvider(
+      onlineComponentProvider
+    );
+    return new Firestore(
+      app,
+      auth,
+      offlineComponentProvider,
+      onlineComponentProvider
+    );
+  });
   instance.registerVersion(name, version, 'rn');
 }
 

packages/firestore/index.rn.ts

@@ -19,7 +19,10 @@ import firebase from '@firebase/app';
 import { FirebaseNamespace } from '@firebase/app-types';
 
 import { Firestore } from './src/api/database';
-import { MultiTabIndexedDbComponentProvider } from './src/core/component_provider';
+import {
+  MultiTabOfflineComponentProvider,
+  OnlineComponentProvider
+} from './src/core/component_provider';
 import { configureForFirebase } from './src/config';
 import { name, version } from './package.json';
 
@@ -30,11 +33,18 @@ import './register-module';
  * Persistence can be enabled via `firebase.firestore().enablePersistence()`.
  */
 export function registerFirestore(instance: FirebaseNamespace): void {
-  configureForFirebase(
-    instance,
-    (app, auth) =>
-      new Firestore(app, auth, new MultiTabIndexedDbComponentProvider())
-  );
+  configureForFirebase(instance, (app, auth) => {
+    const onlineComponentProvider = new OnlineComponentProvider();
+    const offlineComponentProvider = new MultiTabOfflineComponentProvider(
+      onlineComponentProvider
+    );
+    return new Firestore(
+      app,
+      auth,
+      offlineComponentProvider,
+      onlineComponentProvider
+    );
+  });
   instance.registerVersion(name, version);
 }
 

packages/firestore/index.ts

@@ -861,7 +861,7 @@
             ],
             "variables": []
         },
-        "sizeInBytes": 55009
+        "sizeInBytes": 55128
     },
     "arrayRemove": {
         "dependencies": {
@@ -1170,7 +1170,7 @@
             ],
             "variables": []
         },
-        "sizeInBytes": 24918
+        "sizeInBytes": 25037
     },
     "deleteField": {
         "dependencies": {
@@ -1624,7 +1624,7 @@
             ],
             "variables": []
         },
-        "sizeInBytes": 45283
+        "sizeInBytes": 45402
     },
     "getDocs": {
         "dependencies": {
@@ -1778,7 +1778,7 @@
             ],
             "variables": []
         },
-        "sizeInBytes": 57551
+        "sizeInBytes": 57670
     },
     "getFirestore": {
         "dependencies": {
@@ -2357,7 +2357,7 @@
             ],
             "variables": []
         },
-        "sizeInBytes": 77137
+        "sizeInBytes": 77256
     },
     "serverTimestamp": {
         "dependencies": {
@@ -2530,7 +2530,7 @@
             ],
             "variables": []
         },
-        "sizeInBytes": 51372
+        "sizeInBytes": 51491
     },
     "setLogLevel": {
         "dependencies": {
@@ -3065,7 +3065,7 @@
             ],
             "variables": []
         },
-        "sizeInBytes": 54479
+        "sizeInBytes": 54598
     },
     "where": {
         "dependencies": {
@@ -3345,6 +3345,6 @@
             ],
             "variables": []
         },
-        "sizeInBytes": 58180
+        "sizeInBytes": 58299
     }
 }

packages/firestore/lite/dependencies.json

@@ -19,7 +19,7 @@
     "dev": "rollup -c -w",
     "lint": "eslint -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
     "lint:fix": "eslint --fix -c .eslintrc.js '**/*.ts' --ignore-path '../../.gitignore'",
-    "prettier": "prettier --write '*.js' '{,!(dist)}/**/*.ts'",
+    "prettier": "prettier --write '*.js' '*.ts' '@(lite|exp|src|test)/**/*.ts'",
     "pregendeps:exp": "node scripts/build-bundle.js --input ./exp/index.ts --output ./dist/exp/tmp.js",
     "gendeps:exp": "../../scripts/exp/extract-deps.sh --types ./exp-types/index.d.ts --bundle ./dist/exp/tmp.js --output ./exp/dependencies.json",
     "pregendeps:lite": "node scripts/build-bundle.js --input ./lite/index.ts --output ./dist/lite/tmp.js",