Offline-only components

Author: schmidt-sebastian

packages/firestore/exp/dependencies.json

@@ -28,10 +28,11 @@ import {
 } from '../../../src/core/firestore_client';
 import { AsyncQueue } from '../../../src/util/async_queue';
 import {
-  ComponentProvider,
-  IndexedDbComponentProvider,
-  MemoryComponentProvider,
-  MultiTabIndexedDbComponentProvider
+  OnlineComponentProvider,
+  MemoryOfflineComponentProvider,
+  OfflineComponentProvider,
+  IndexedDbOfflineComponentProvider,
+  MultiTabOfflineComponentProvider
 } from '../../../src/core/component_provider';
 
 import {
@@ -60,7 +61,8 @@ export class Firestore extends LiteFirestore
   private readonly _queue = new AsyncQueue();
   private readonly _firestoreClient: FirestoreClient;
   private readonly _persistenceKey: string;
-  private _componentProvider: ComponentProvider = new MemoryComponentProvider();
+  private _offlineComponentProvider: OfflineComponentProvider = new MemoryOfflineComponentProvider();
+  private _onlineComponentProvider = new OnlineComponentProvider();
 
   // Assigned via _getFirestoreClient()
   private _deferredInitialization?: Promise<void>;
@@ -106,7 +108,8 @@ export class Firestore extends LiteFirestore
 
       this._deferredInitialization = this._firestoreClient.start(
         databaseInfo,
-        this._componentProvider,
+        this._offlineComponentProvider,
+        this._onlineComponentProvider,
         this._persistenceSettings
       );
     }
@@ -117,7 +120,8 @@ export class Firestore extends LiteFirestore
   // TODO(firestorexp): Factor out MultiTabComponentProvider and remove
   // `synchronizeTabs` argument
   _enablePersistence(
-    persistenceProvider: ComponentProvider,
+    offlineComponentProvider: OfflineComponentProvider,
+    onlineComponentProvider: OnlineComponentProvider,
     synchronizeTabs: boolean
   ): Promise<void> {
     if (this._deferredInitialization) {
@@ -137,7 +141,7 @@ export class Firestore extends LiteFirestore
       cacheSizeBytes:
         settings.cacheSizeBytes ?? LruParams.DEFAULT_CACHE_SIZE_BYTES
     };
-    this._componentProvider = persistenceProvider;
+    this._offlineComponentProvider = offlineComponentProvider;
 
     // TODO(firestorexp): Add support for Persistence fallback
     return this._getFirestoreClient().then(() => {});
@@ -235,7 +239,8 @@ export function enableIndexedDbPersistence(
 ): Promise<void> {
   const firestoreImpl = cast(firestore, Firestore);
   return firestoreImpl._enablePersistence(
-    new IndexedDbComponentProvider(),
+    new IndexedDbOfflineComponentProvider(),
+    new OnlineComponentProvider(),
     /*synchronizeTabs=*/ false
   );
 }
@@ -244,8 +249,13 @@ export function enableMultiTabIndexedDbPersistence(
   firestore: firestore.FirebaseFirestore
 ): Promise<void> {
   const firestoreImpl = cast(firestore, Firestore);
+  const onlineComponentProvider = new OnlineComponentProvider();
+  const offlineComponentProvider = new MultiTabOfflineComponentProvider(
+    onlineComponentProvider
+  );
   return firestoreImpl._enablePersistence(
-    new MultiTabIndexedDbComponentProvider(),
+    offlineComponentProvider,
+    onlineComponentProvider,
     /*synchronizeTabs=*/ false
   );
 }

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,10 +33,19 @@ import { name, version } from './package.json';
  * Persistence can be enabled via `firebase.firestore().enablePersistence()`.
  */
 export function registerFirestore(instance: FirebaseNamespace): void {
+  const onlineComponentProvider = new OnlineComponentProvider();
+  const offlineComponentProvider = new MultiTabOfflineComponentProvider(
+    onlineComponentProvider
+  );
   configureForFirebase(
     instance,
     (app, auth) =>
-      new Firestore(app, auth, new MultiTabIndexedDbComponentProvider())
+      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,10 +32,19 @@ import { name, version } from './package.json';
  * Persistence can be enabled via `firebase.firestore().enablePersistence()`.
  */
 export function registerFirestore(instance: FirebaseNamespace): void {
+  const onlineComponentProvider = new OnlineComponentProvider();
+  const offlineComponentProvider = new MultiTabOfflineComponentProvider(
+    onlineComponentProvider
+  );
   configureForFirebase(
     instance,
     (app, auth) =>
-      new Firestore(app, auth, new MultiTabIndexedDbComponentProvider())
+      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,10 +33,19 @@ import './register-module';
  * Persistence can be enabled via `firebase.firestore().enablePersistence()`.
  */
 export function registerFirestore(instance: FirebaseNamespace): void {
+  const onlineComponentProvider = new OnlineComponentProvider();
+  const offlineComponentProvider = new MultiTabOfflineComponentProvider(
+    onlineComponentProvider
+  );
   configureForFirebase(
     instance,
     (app, auth) =>
-      new Firestore(app, auth, new MultiTabIndexedDbComponentProvider())
+      new Firestore(
+        app,
+        auth,
+        offlineComponentProvider,
+        onlineComponentProvider
+      )
   );
   instance.registerVersion(name, version);
 }

packages/firestore/index.ts

@@ -526,7 +526,11 @@ export function parent<T>(
     if (parentPath.isEmpty()) {
       return null;
     } else {
-      return new DocumentReference(child.firestore,  /* converter= */ null, parentPath);
+      return new DocumentReference(
+        child.firestore,
+        /* converter= */ null,
+        parentPath
+      );
     }
   } else {
     const doc = cast<DocumentReference<T>>(child, DocumentReference);

packages/firestore/lite/src/api/reference.ts

@@ -18,7 +18,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' '{,!(dist)}/**/*.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",

packages/firestore/package.json

@@ -24,8 +24,9 @@ import { _FirebaseApp, FirebaseService } from '@firebase/app-types/private';
 import { DatabaseId, DatabaseInfo } from '../core/database_info';
 import { ListenOptions } from '../core/event_manager';
 import {
-  ComponentProvider,
-  MemoryComponentProvider
+  OnlineComponentProvider,
+  MemoryOfflineComponentProvider,
+  OfflineComponentProvider
 } from '../core/component_provider';
 import { FirestoreClient, PersistenceSettings } from '../core/firestore_client';
 import {
@@ -290,7 +291,6 @@ export class Firestore implements firestore.FirebaseFirestore, FirebaseService {
   // underscore to discourage their use.
   readonly _databaseId: DatabaseId;
   private readonly _persistenceKey: string;
-  private readonly _componentProvider: ComponentProvider;
   private _credentials: CredentialsProvider;
   private readonly _firebaseApp: FirebaseApp | null = null;
   private _settings: FirestoreSettings;
@@ -315,7 +315,8 @@ export class Firestore implements firestore.FirebaseFirestore, FirebaseService {
   constructor(
     databaseIdOrApp: FirestoreDatabase | FirebaseApp,
     authProvider: Provider<FirebaseAuthInternalName>,
-    componentProvider: ComponentProvider = new MemoryComponentProvider()
+    private _offlineComponentProvider: OfflineComponentProvider = new MemoryOfflineComponentProvider(),
+    private _onlineComponentProvider = new OnlineComponentProvider()
   ) {
     if (typeof (databaseIdOrApp as FirebaseApp).options === 'object') {
       // This is very likely a Firebase app object
@@ -340,7 +341,6 @@ export class Firestore implements firestore.FirebaseFirestore, FirebaseService {
       this._credentials = new EmptyCredentialsProvider();
     }
 
-    this._componentProvider = componentProvider;
     this._settings = new FirestoreSettings({});
   }
 
@@ -425,12 +425,16 @@ export class Firestore implements firestore.FirebaseFirestore, FirebaseService {
       }
     }
 
-    return this.configureClient(this._componentProvider, {
-      durable: true,
-      cacheSizeBytes: this._settings.cacheSizeBytes,
-      synchronizeTabs,
-      forceOwningTab: experimentalForceOwningTab
-    });
+    return this.configureClient(
+      this._offlineComponentProvider,
+      this._onlineComponentProvider,
+      {
+        durable: true,
+        cacheSizeBytes: this._settings.cacheSizeBytes,
+        synchronizeTabs,
+        forceOwningTab: experimentalForceOwningTab
+      }
+    );
   }
 
   async clearPersistence(): Promise<void> {
@@ -448,7 +452,7 @@ export class Firestore implements firestore.FirebaseFirestore, FirebaseService {
     const deferred = new Deferred<void>();
     this._queue.enqueueAndForgetEvenAfterShutdown(async () => {
       try {
-        await this._componentProvider.clearPersistence(
+        await this._offlineComponentProvider.clearPersistence(
           this._databaseId,
           this._persistenceKey
         );
@@ -498,9 +502,13 @@ export class Firestore implements firestore.FirebaseFirestore, FirebaseService {
     if (!this._firestoreClient) {
       // Kick off starting the client but don't actually wait for it.
       // eslint-disable-next-line @typescript-eslint/no-floating-promises
-      this.configureClient(new MemoryComponentProvider(), {
-        durable: false
-      });
+      this.configureClient(
+        new MemoryOfflineComponentProvider(),
+        new OnlineComponentProvider(),
+        {
+          durable: false
+        }
+      );
     }
     return this._firestoreClient as FirestoreClient;
   }
@@ -516,7 +524,8 @@ export class Firestore implements firestore.FirebaseFirestore, FirebaseService {
   }
 
   private configureClient(
-    componentProvider: ComponentProvider,
+    offlineComponentProvider: OfflineComponentProvider,
+    onlineComponentProvider: OnlineComponentProvider,
     persistenceSettings: PersistenceSettings
   ): Promise<void> {
     debugAssert(!!this._settings.host, 'FirestoreSettings.host is not set');
@@ -532,7 +541,8 @@ export class Firestore implements firestore.FirebaseFirestore, FirebaseService {
 
     return this._firestoreClient.start(
       databaseInfo,
-      componentProvider,
+      offlineComponentProvider,
+      onlineComponentProvider,
       persistenceSettings
     );
   }