Merge

Author: schmidt-sebastian

packages/firestore-types/index.d.ts

@@ -68,13 +68,13 @@ export interface PersistenceSettings {
    * shared execution of queries and latency-compensated local document updates
    * across all connected instances.
    *
-   * To enable this mode, `synchronizeTabs:true` needs to be set globally in
-   * all active tabs. If omitted or set to 'false', `enablePersistence()` will
-   * fail in all but the first tab.
+   * To enable this mode, `experimentalTabSynchronization:true` needs to be set
+   * globally in all active tabs. If omitted or set to 'false',
+   * `enablePersistence()` will fail in all but the first tab.
    *
-   * NOTE: This mode is experimental and not yet recommended for production use.
+   * NOTE: This mode is not yet recommended for production use.
    */
-  synchronizeTabs?: boolean;
+  experimentalTabSynchronization?: boolean;
 }
 
 export type LogLevel = 'debug' | 'error' | 'silent';

packages/firestore/src/api/database.ts

@@ -208,7 +208,7 @@ class FirestoreConfig {
  */
 export class PersistenceSettings {
   /** Whether to enable multi-tab synchronization. */
-  synchronizeTabs: boolean;
+  experimentalTabSynchronization: boolean;
 
   constructor(
     readonly enabled: boolean,
@@ -219,16 +219,17 @@ export class PersistenceSettings {
       'Can only provide PersistenceSettings with persistence enabled'
     );
     settings = settings || {};
-    this.synchronizeTabs = objUtils.defaulted(
-      settings.synchronizeTabs,
+    this.experimentalTabSynchronization = objUtils.defaulted(
+      settings.experimentalTabSynchronization,
       DEFAULT_SYNCHRONIZE_TABS
     );
   }
 
   isEqual(other: PersistenceSettings): boolean {
     return (
       this.enabled === other.enabled &&
-      this.synchronizeTabs === other.synchronizeTabs
+      this.experimentalTabSynchronization ===
+        other.experimentalTabSynchronization
     );
   }
 }

packages/firestore/src/core/event_manager.ts

@@ -15,7 +15,7 @@
  */
 
 import { Query } from './query';
-import { SyncEngine } from './sync_engine';
+import { SyncEngine, SyncEngineListener } from './sync_engine';
 import { OnlineState, TargetId } from './types';
 import { DocumentViewChange } from './view_snapshot';
 import { ChangeType, ViewSnapshot } from './view_snapshot';
@@ -46,18 +46,15 @@ export interface Observer<T> {
  * It handles "fan-out". -- Identical queries will re-use the same watch on the
  * backend.
  */
-export class EventManager {
+export class EventManager implements SyncEngineListener {
   private queries = new ObjectMap<Query, QueryListenersInfo>(q =>
     q.canonicalId()
   );
 
   private onlineState: OnlineState = OnlineState.Unknown;
 
   constructor(private syncEngine: SyncEngine) {
-    this.syncEngine.subscribe(
-      this.onChange.bind(this),
-      this.onError.bind(this)
-    );
+    this.syncEngine.subscribe(this);
   }
 
   listen(listener: QueryListener): Promise<TargetId> {
@@ -105,7 +102,7 @@ export class EventManager {
     }
   }
 
-  onChange(viewSnaps: ViewSnapshot[]): void {
+  onWatchChange(viewSnaps: ViewSnapshot[]): void {
     for (const viewSnap of viewSnaps) {
       const query = viewSnap.query;
       const queryInfo = this.queries.get(query);
@@ -118,7 +115,7 @@ export class EventManager {
     }
   }
 
-  onError(query: Query, error: Error): void {
+  onWatchError(query: Query, error: Error): void {
     const queryInfo = this.queries.get(query);
     if (queryInfo) {
       for (const listener of queryInfo.listeners) {
@@ -131,7 +128,7 @@ export class EventManager {
     this.queries.delete(query);
   }
 
-  applyOnlineStateChange(onlineState: OnlineState): void {
+  onOnlineStateChange(onlineState: OnlineState): void {
     this.onlineState = onlineState;
     this.queries.forEach((_, queryInfo) => {
       for (const listener of queryInfo.listeners) {

packages/firestore/src/core/firestore_client.ts

@@ -51,7 +51,7 @@ import { Deferred } from '../util/promise';
 import { DatabaseId, DatabaseInfo } from './database_info';
 import { Query } from './query';
 import { Transaction } from './transaction';
-import { OnlineState } from './types';
+import { OnlineStateSource } from './types';
 import { ViewSnapshot } from './view_snapshot';
 import {
   MemorySharedClientState,
@@ -312,7 +312,7 @@ export class FirestoreClient {
       this.persistence = persistence;
 
       if (
-        settings.synchronizeTabs &&
+        settings.experimentalTabSynchronization &&
         !WebStorageSharedClientState.isAvailable(this.platform)
       ) {
         throw new FirestoreError(
@@ -321,7 +321,7 @@ export class FirestoreClient {
         );
       }
 
-      this.sharedClientState = settings.synchronizeTabs
+      this.sharedClientState = settings.experimentalTabSynchronization
         ? new WebStorageSharedClientState(
             this.asyncQueue,
             this.platform,
@@ -330,7 +330,7 @@ export class FirestoreClient {
             user
           )
         : new MemorySharedClientState();
-      return persistence.start(settings.synchronizeTabs);
+      return persistence.start(settings.experimentalTabSynchronization);
     });
   }
 
@@ -371,16 +371,22 @@ export class FirestoreClient {
           serializer
         );
 
-        const onlineStateChangedHandler = (onlineState: OnlineState) => {
-          this.syncEngine.applyOnlineStateChange(onlineState);
-          this.eventMgr.applyOnlineStateChange(onlineState);
-        };
+        const remoteStoreOnlineStateChangedHandler = onlineState =>
+          this.syncEngine.applyOnlineStateChange(
+            onlineState,
+            OnlineStateSource.RemoteStore
+          );
+        const sharedClientStateOnlineStateChangedHandler = onlineState =>
+          this.syncEngine.applyOnlineStateChange(
+            onlineState,
+            OnlineStateSource.SharedClientState
+          );
 
         this.remoteStore = new RemoteStore(
           this.localStore,
           datastore,
           this.asyncQueue,
-          onlineStateChangedHandler
+          remoteStoreOnlineStateChangedHandler
         );
 
         this.syncEngine = new SyncEngine(
@@ -390,7 +396,7 @@ export class FirestoreClient {
           user
         );
 
-        this.sharedClientState.onlineStateHandler = onlineStateChangedHandler;
+        this.sharedClientState.onlineStateHandler = sharedClientStateOnlineStateChangedHandler;
 
         // Set up wiring between sync engine and other components
         this.remoteStore.syncEngine = this.syncEngine;
@@ -404,7 +410,6 @@ export class FirestoreClient {
         await this.localStore.start();
         await this.sharedClientState.start();
         await this.remoteStore.start();
-        await this.syncEngine.start();
 
         // NOTE: This will immediately call the listener, so we make sure to
         // set it after localStore / remoteStore are started.
@@ -433,12 +438,11 @@ export class FirestoreClient {
   }): Promise<void> {
     return this.asyncQueue.enqueue(async () => {
       // PORTING NOTE: LocalStore does not need an explicit shutdown on web.
-      await this.syncEngine.shutdown();
+      await this.remoteStore.shutdown();
       await this.sharedClientState.shutdown();
       await this.persistence.shutdown(
         options && options.purgePersistenceWithDataLoss
       );
-      await this.remoteStore.shutdown();
 
       // `removeUserChangeListener` must be called after shutting down the
       // RemoteStore as it will prevent the RemoteStore from retrieving