Adding basic functionality for TabNotificationChannel

Author: schmidt-sebastian

packages/firestore/src/core/firestore_client.ts

@@ -45,12 +45,6 @@ import { Query } from './query';
 import { Transaction } from './transaction';
 import { OnlineState } from './types';
 import { ViewSnapshot } from './view_snapshot';
-import {
-  LocalStorageNotificationChannel,
-  TabNotificationChannel
-} from '../local/tab_notification_channel';
-import { AutoId } from '../util/misc';
-import { WindowEventListener } from '../platform_browser/window_event_listener';
 
 const LOG_TAG = 'FirestoreClient';
 
@@ -71,9 +65,8 @@ export class FirestoreClient {
   private persistence: Persistence;
   private localStore: LocalStore;
   private remoteStore: RemoteStore;
-  private notificationChannel?: TabNotificationChannel;
-  private windowEventListener?: WindowEventListener;
   private syncEngine: SyncEngine;
+
   constructor(
     private platform: Platform,
     private databaseInfo: DatabaseInfo,
@@ -238,8 +231,6 @@ export class FirestoreClient {
    * @returns A promise indicating success or failure.
    */
   private startIndexedDbPersistence(): Promise<void> {
-    const ownerId = AutoId.newId();
-
     // TODO(http://b/33384523): For now we just disable garbage collection
     // when persistence is enabled.
     this.garbageCollector = new NoOpGarbageCollector();
@@ -250,26 +241,8 @@ export class FirestoreClient {
     const serializer = new JsonProtoSerializer(this.databaseInfo.databaseId, {
       useProto3Json: true
     });
-
-    this.persistence = new IndexedDbPersistence(
-      storagePrefix,
-      ownerId,
-      serializer
-    );
-
-    return this.persistence.start().then(() => {
-      this.notificationChannel = new LocalStorageNotificationChannel(
-        storagePrefix,
-        ownerId,
-        this.asyncQueue
-      );
-      this.notificationChannel.start();
-      this.windowEventListener = new WindowEventListener(
-        this.asyncQueue,
-        this.notificationChannel
-      );
-      this.windowEventListener.start();
-    });
+    this.persistence = new IndexedDbPersistence(storagePrefix, serializer);
+    return this.persistence.start();
   }
 
   /**
@@ -363,11 +336,6 @@ export class FirestoreClient {
       .then(() => {
         // PORTING NOTE: LocalStore does not need an explicit shutdown on web.
         return this.persistence.shutdown();
-      })
-      .then(() => {
-        if (this.notificationChannel) {
-          this.notificationChannel.shutdown();
-        }
       });
   }
 

packages/firestore/src/core/types.ts

@@ -26,6 +26,9 @@ export type BatchId = number;
  */
 export type TargetId = number;
 
+/**
+ * A randomly-generated key assigned to each Firestore instance at startup.
+ */
 export type InstanceKey = string;
 
 // TODO(b/35918695): In GRPC / node, tokens are Uint8Array. In WebChannel,
@@ -62,28 +65,3 @@ export enum OnlineState {
    */
   Failed
 }
-
-/**
- * Describes the foreground state of the tab that is hosting the Firestore
- * client. These values are determined on a best-effort basis and may (e.g. for
- * throttled tabs) not always reflect the tab's current visibility.
- */
-export enum VisibilityState {
-  /**
-   * It is not known what state the tab is in. This is usually the state used
-   * during the initial rendering phase.
-   */
-  Unknown,
-
-  /**
-   * The tab has received a notification from the browser that it is at least
-   * partially visible (in a foreground tab that is non-minimized).
-   */
-  Foreground,
-
-  /**
-   * The tab has received a notification from the browser that it is not visible
-   * (in a background tab or minimized).
-   */
-  Background
-}

packages/firestore/src/local/indexeddb_persistence.ts

@@ -94,6 +94,7 @@ export class IndexedDbPersistence implements Persistence {
   private started: boolean;
   private dbName: string;
   private localStoragePrefix: string;
+  private ownerId: string = this.generateOwnerId();
 
   /**
    * Set to an Error object if we encounter an unrecoverable error. All further
@@ -108,11 +109,7 @@ export class IndexedDbPersistence implements Persistence {
 
   private serializer: LocalSerializer;
 
-  constructor(
-    prefix: string,
-    private ownerId: string,
-    serializer: JsonProtoSerializer
-  ) {
+  constructor(prefix: string, serializer: JsonProtoSerializer) {
     this.dbName = prefix + IndexedDbPersistence.MAIN_DATABASE;
     this.serializer = new LocalSerializer(serializer);
     this.localStoragePrefix = prefix;
@@ -408,4 +405,9 @@ export class IndexedDbPersistence implements Persistence {
   private zombiedOwnerLocalStorageKey(): string {
     return this.localStoragePrefix + ZOMBIE_OWNER_LOCALSTORAGE_SUFFIX;
   }
+
+  private generateOwnerId(): string {
+    // For convenience, just use an AutoId.
+    return AutoId.newId();
+  }
 }