Remove Multi-Tab overhead for non-multi-tab persistence (#3362)

schmidt-sebastian · web-flow · commit 13dfc2f3380b · 2020-07-08T20:13:39.000-07:00
diff --git a/.changeset/late-ladybugs-wash.md b/.changeset/late-ladybugs-wash.md
@@ -0,0 +1,2 @@
+---
+---
diff --git a/packages/firestore/exp/src/api/database.ts b/packages/firestore/exp/src/api/database.ts
@@ -30,7 +30,8 @@ import { AsyncQueue } from '../../../src/util/async_queue';
 import {
   ComponentProvider,
   IndexedDbComponentProvider,
-  MemoryComponentProvider
+  MemoryComponentProvider,
+  MultiTabIndexedDbComponentProvider
 } from '../../../src/core/component_provider';
 
 import {
@@ -237,8 +238,8 @@ export function enableMultiTabIndexedDbPersistence(
 ): Promise<void> {
   const firestoreImpl = cast(firestore, Firestore);
   return firestoreImpl._enablePersistence(
-    new IndexedDbComponentProvider(),
-    /*synchronizeTabs=*/ true
+    new MultiTabIndexedDbComponentProvider(),
+    /*synchronizeTabs=*/ false
   );
 }
 
diff --git a/packages/firestore/exp/test/deps/dependencies.json b/packages/firestore/exp/test/deps/dependencies.json
@@ -8866,11 +8866,6 @@
                 "createQueryCache",
                 "createRemoteDocumentCache",
                 "createRemoteDocumentReadTimeIndex",
-                "createWebStorageClientStateKey",
-                "createWebStorageMutationBatchKey",
-                "createWebStorageOnlineStateKey",
-                "createWebStorageQueryTargetMetadataKey",
-                "createWebStorageSequenceNumberKey",
                 "dbDocumentSize",
                 "dbKey",
                 "debugAssert",
@@ -8935,7 +8930,6 @@
                 "fromVersion",
                 "fromWatchChange",
                 "fromWatchTargetChangeState",
-                "fromWebStorageSequenceNumber",
                 "fromWriteResult",
                 "fromWriteResults",
                 "fullyQualifiedPrefixPath",
@@ -8969,7 +8963,6 @@
                 "isPermanentError",
                 "isPermanentWriteError",
                 "isReferenceValue",
-                "isSafeInteger",
                 "isServerTimestamp",
                 "isValidResourceName",
                 "loadProtos",
@@ -8988,8 +8981,6 @@
                 "newConnectivityMonitor",
                 "newDatastore",
                 "newLocalStore",
-                "newMultiTabLocalStore",
-                "newMultiTabSyncEngine",
                 "newPersistentWatchStream",
                 "newPersistentWriteStream",
                 "newQueryComparator",
@@ -9177,12 +9168,9 @@
                 "MemorySharedClientState",
                 "MemoryTargetCache",
                 "MemoryTransaction",
-                "MultiTabLocalStoreImpl",
-                "MultiTabSyncEngineImpl",
                 "Mutation",
                 "MutationBatch",
                 "MutationBatchResult",
-                "MutationMetadata",
                 "MutationResult",
                 "NoDocument",
                 "NoopConnectivityMonitor",
@@ -9203,10 +9191,8 @@
                 "Query",
                 "QueryListener",
                 "QueryListenersInfo",
-                "QueryTargetMetadata",
                 "QueryView",
                 "ReferenceSet",
-                "RemoteClientState",
                 "RemoteDocumentChangeBuffer",
                 "RemoteEvent",
                 "RemoteStore",
@@ -9216,7 +9202,6 @@
                 "SchemaConverter",
                 "ServerTimestampTransform",
                 "SetMutation",
-                "SharedOnlineState",
                 "SimpleDb",
                 "SimpleDbStore",
                 "SimpleDbTransaction",
@@ -9243,12 +9228,11 @@
                 "View",
                 "ViewSnapshot",
                 "WatchChangeAggregator",
-                "WatchTargetChange",
-                "WebStorageSharedClientState"
+                "WatchTargetChange"
             ],
             "variables": []
         },
-        "sizeInBytes": 335737
+        "sizeInBytes": 311847
     },
     "enableMultiTabIndexedDbPersistence": {
         "dependencies": {
@@ -9625,6 +9609,7 @@
                 "MemorySharedClientState",
                 "MemoryTargetCache",
                 "MemoryTransaction",
+                "MultiTabIndexedDbComponentProvider",
                 "MultiTabLocalStoreImpl",
                 "MultiTabSyncEngineImpl",
                 "Mutation",
@@ -9696,7 +9681,7 @@
             ],
             "variables": []
         },
-        "sizeInBytes": 335752
+        "sizeInBytes": 336213
     },
     "enableNetwork": {
         "dependencies": {
diff --git a/packages/firestore/index.node.ts b/packages/firestore/index.node.ts
@@ -18,7 +18,7 @@ import firebase from '@firebase/app';
 import { FirebaseNamespace } from '@firebase/app-types';
 
 import { Firestore } from './src/api/database';
-import { IndexedDbComponentProvider } from './src/core/component_provider';
+import { MultiTabIndexedDbComponentProvider } from './src/core/component_provider';
 import { configureForFirebase } from './src/config';
 
 import './register-module';
@@ -32,7 +32,8 @@ import { name, version } from './package.json';
 export function registerFirestore(instance: FirebaseNamespace): void {
   configureForFirebase(
     instance,
-    (app, auth) => new Firestore(app, auth, new IndexedDbComponentProvider())
+    (app, auth) =>
+      new Firestore(app, auth, new MultiTabIndexedDbComponentProvider())
   );
   instance.registerVersion(name, version, 'node');
 }
diff --git a/packages/firestore/index.rn.ts b/packages/firestore/index.rn.ts
@@ -18,7 +18,7 @@ import firebase from '@firebase/app';
 import { FirebaseNamespace } from '@firebase/app-types';
 
 import { Firestore } from './src/api/database';
-import { IndexedDbComponentProvider } from './src/core/component_provider';
+import { MultiTabIndexedDbComponentProvider } from './src/core/component_provider';
 import { configureForFirebase } from './src/config';
 
 import './register-module';
@@ -31,7 +31,8 @@ import { name, version } from './package.json';
 export function registerFirestore(instance: FirebaseNamespace): void {
   configureForFirebase(
     instance,
-    (app, auth) => new Firestore(app, auth, new IndexedDbComponentProvider())
+    (app, auth) =>
+      new Firestore(app, auth, new MultiTabIndexedDbComponentProvider())
   );
   instance.registerVersion(name, version, 'rn');
 }
diff --git a/packages/firestore/index.ts b/packages/firestore/index.ts
@@ -19,7 +19,7 @@ import firebase from '@firebase/app';
 import { FirebaseNamespace } from '@firebase/app-types';
 
 import { Firestore } from './src/api/database';
-import { IndexedDbComponentProvider } from './src/core/component_provider';
+import { MultiTabIndexedDbComponentProvider } from './src/core/component_provider';
 import { configureForFirebase } from './src/config';
 import { name, version } from './package.json';
 
@@ -32,7 +32,8 @@ import './register-module';
 export function registerFirestore(instance: FirebaseNamespace): void {
   configureForFirebase(
     instance,
-    (app, auth) => new Firestore(app, auth, new IndexedDbComponentProvider())
+    (app, auth) =>
+      new Firestore(app, auth, new MultiTabIndexedDbComponentProvider())
   );
   instance.registerVersion(name, version);
 }
diff --git a/packages/firestore/src/core/component_provider.ts b/packages/firestore/src/core/component_provider.ts
@@ -196,52 +196,23 @@ export class MemoryComponentProvider implements ComponentProvider {
 export class IndexedDbComponentProvider extends MemoryComponentProvider {
   persistence!: IndexedDbPersistence;
 
-  // TODO(tree-shaking): Create an IndexedDbComponentProvider and a
-  // MultiTabComponentProvider. The IndexedDbComponentProvider should depend
-  // on LocalStore and SyncEngine.
-  localStore!: MultiTabLocalStore;
-  syncEngine!: MultiTabSyncEngine;
-
-  async initialize(cfg: ComponentConfiguration): Promise<void> {
-    await super.initialize(cfg);
-
-    // NOTE: This will immediately call the listener, so we make sure to
-    // set it after localStore / remoteStore are started.
-    await this.persistence.setPrimaryStateListener(async isPrimary => {
-      await (this.syncEngine as MultiTabSyncEngine).applyPrimaryState(
-        isPrimary
-      );
-      if (this.gcScheduler) {
-        if (isPrimary && !this.gcScheduler.started) {
-          this.gcScheduler.start(this.localStore);
-        } else if (!isPrimary) {
-          this.gcScheduler.stop();
-        }
-      }
-    });
-  }
-
   createLocalStore(cfg: ComponentConfiguration): LocalStore {
-    return newMultiTabLocalStore(
+    return newLocalStore(
       this.persistence,
       new IndexFreeQueryEngine(),
       cfg.initialUser
     );
   }
 
   createSyncEngine(cfg: ComponentConfiguration): SyncEngine {
-    const syncEngine = newMultiTabSyncEngine(
+    return newSyncEngine(
       this.localStore,
       this.remoteStore,
       cfg.datastore,
       this.sharedClientState,
       cfg.initialUser,
       cfg.maxConcurrentLimboResolutions
     );
-    if (this.sharedClientState instanceof WebStorageSharedClientState) {
-      this.sharedClientState.syncEngine = syncEngine;
-    }
-    return syncEngine;
   }
 
   createGarbageCollectionScheduler(
@@ -276,6 +247,72 @@ export class IndexedDbComponentProvider extends MemoryComponentProvider {
     );
   }
 
+  createSharedClientState(cfg: ComponentConfiguration): SharedClientState {
+    return new MemorySharedClientState();
+  }
+
+  clearPersistence(databaseInfo: DatabaseInfo): Promise<void> {
+    const persistenceKey = IndexedDbPersistence.buildStoragePrefix(
+      databaseInfo
+    );
+    return IndexedDbPersistence.clearPersistence(persistenceKey);
+  }
+}
+
+/**
+ * Provides all components needed for Firestore with multi-tab IndexedDB
+ * persistence.
+ *
+ * In the legacy client, this provider is used to provide both multi-tab and
+ * non-multi-tab persistence since we cannot tell at build time whether
+ * `synchronizeTabs` will be enabled.
+ */
+export class MultiTabIndexedDbComponentProvider extends IndexedDbComponentProvider {
+  localStore!: MultiTabLocalStore;
+  syncEngine!: MultiTabSyncEngine;
+
+  async initialize(cfg: ComponentConfiguration): Promise<void> {
+    await super.initialize(cfg);
+
+    // NOTE: This will immediately call the listener, so we make sure to
+    // set it after localStore / remoteStore are started.
+    await this.persistence.setPrimaryStateListener(async isPrimary => {
+      await (this.syncEngine as MultiTabSyncEngine).applyPrimaryState(
+        isPrimary
+      );
+      if (this.gcScheduler) {
+        if (isPrimary && !this.gcScheduler.started) {
+          this.gcScheduler.start(this.localStore);
+        } else if (!isPrimary) {
+          this.gcScheduler.stop();
+        }
+      }
+    });
+  }
+
+  createLocalStore(cfg: ComponentConfiguration): LocalStore {
+    return newMultiTabLocalStore(
+      this.persistence,
+      new IndexFreeQueryEngine(),
+      cfg.initialUser
+    );
+  }
+
+  createSyncEngine(cfg: ComponentConfiguration): SyncEngine {
+    const syncEngine = newMultiTabSyncEngine(
+      this.localStore,
+      this.remoteStore,
+      cfg.datastore,
+      this.sharedClientState,
+      cfg.initialUser,
+      cfg.maxConcurrentLimboResolutions
+    );
+    if (this.sharedClientState instanceof WebStorageSharedClientState) {
+      this.sharedClientState.syncEngine = syncEngine;
+    }
+    return syncEngine;
+  }
+
   createSharedClientState(cfg: ComponentConfiguration): SharedClientState {
     if (
       cfg.persistenceSettings.durable &&
@@ -301,11 +338,4 @@ export class IndexedDbComponentProvider extends MemoryComponentProvider {
     }
     return new MemorySharedClientState();
   }
-
-  clearPersistence(databaseInfo: DatabaseInfo): Promise<void> {
-    const persistenceKey = IndexedDbPersistence.buildStoragePrefix(
-      databaseInfo
-    );
-    return IndexedDbPersistence.clearPersistence(persistenceKey);
-  }
 }
diff --git a/packages/firestore/test/unit/specs/spec_test_components.ts b/packages/firestore/test/unit/specs/spec_test_components.ts
@@ -17,8 +17,8 @@
 
 import {
   ComponentConfiguration,
-  IndexedDbComponentProvider,
-  MemoryComponentProvider
+  MemoryComponentProvider,
+  MultiTabIndexedDbComponentProvider
 } from '../../../src/core/component_provider';
 import {
   GarbageCollectionScheduler,
@@ -114,7 +114,7 @@ function failTransactionIfNeeded(
   }
 }
 
-export class MockIndexedDbComponentProvider extends IndexedDbComponentProvider {
+export class MockIndexedDbComponentProvider extends MultiTabIndexedDbComponentProvider {
   persistence!: MockIndexedDbPersistence;
 
   constructor(
diff --git a/packages/firestore/test/util/api_helpers.ts b/packages/firestore/test/util/api_helpers.ts
@@ -26,7 +26,7 @@ import {
   Query,
   QuerySnapshot
 } from '../../src/api/database';
-import { IndexedDbComponentProvider } from '../../src/core/component_provider';
+import { MultiTabIndexedDbComponentProvider } from '../../src/core/component_provider';
 import { Query as InternalQuery } from '../../src/core/query';
 import {
   ChangeType,
@@ -49,7 +49,7 @@ export const FIRESTORE = new Firestore(
     database: '(default)'
   },
   new Provider('auth-internal', new ComponentContainer('default')),
-  new IndexedDbComponentProvider()
+  new MultiTabIndexedDbComponentProvider()
 );
 
 export function firestore(): Firestore {
