[Multi-Tab] Using WebStorage Mock with all IndexedDB tests (#1034)

Author: schmidt-sebastian

packages/firestore/test/unit/local/persistence_test_helpers.ts

@@ -29,7 +29,6 @@ import {
   OnlineState,
   TargetId
 } from '../../../src/core/types';
-import { BrowserPlatform } from '../../../src/platform_browser/browser_platform';
 import { AsyncQueue } from '../../../src/util/async_queue';
 import { User } from '../../../src/auth/user';
 import {
@@ -122,7 +121,7 @@ export async function populateWebStorage(
   // NOTE: We don't call shutdown() on it because that would delete the data.
   const secondaryClientState = new WebStorageSharedClientState(
     new AsyncQueue(),
-    new BrowserPlatform(),
+    PlatformSupport.getPlatform(),
     TEST_PERSISTENCE_PREFIX,
     existingClientId,
     user

packages/firestore/test/unit/local/web_storage_shared_client_state.test.ts

@@ -42,7 +42,6 @@ import {
   clearWebStorage,
   TEST_PERSISTENCE_PREFIX
 } from './persistence_test_helpers';
-import { BrowserPlatform } from '../../../src/platform_browser/browser_platform';
 import { PlatformSupport } from '../../../src/platform/platform';
 import * as objUtils from '../../../src/util/obj';
 import { targetIdSet } from '../../../src/model/collections';
@@ -174,6 +173,7 @@ describe('WebStorageSharedClientState', () => {
   let clientSyncer: TestSharedClientSyncer;
 
   let previousAddEventListener;
+  let previousRemoveEventListener;
 
   let localStorageCallbacks = [];
 
@@ -192,6 +192,7 @@ describe('WebStorageSharedClientState', () => {
     localStorageCallbacks = [];
 
     previousAddEventListener = window.addEventListener;
+    previousRemoveEventListener = window.removeEventListener;
 
     // We capture the listener here so that we can invoke it from the local
     // client. If we directly relied on LocalStorage listeners, we would not
@@ -200,12 +201,13 @@ describe('WebStorageSharedClientState', () => {
       expect(type).to.equal('storage');
       localStorageCallbacks.push(callback);
     };
+    window.removeEventListener = () => {};
 
     primaryClientId = AutoId.newId();
     queue = new AsyncQueue();
     sharedClientState = new WebStorageSharedClientState(
       queue,
-      new BrowserPlatform(),
+      PlatformSupport.getPlatform(),
       TEST_PERSISTENCE_PREFIX,
       primaryClientId,
       AUTHENTICATED_USER
@@ -220,6 +222,7 @@ describe('WebStorageSharedClientState', () => {
   afterEach(() => {
     sharedClientState.shutdown();
     window.addEventListener = previousAddEventListener;
+    window.removeEventListener = previousRemoveEventListener;
   });
 
   function assertClientState(

packages/firestore/test/util/node_persistence.ts

@@ -18,6 +18,8 @@ import * as registerIndexedDBShim from 'indexeddbshim';
 import * as fs from 'fs';
 import * as os from 'os';
 
+import { FakeWindow, SharedFakeWebStorage } from './test_platform';
+
 // WARNING: The `indexeddbshim` installed via this module should only ever be
 // used during initial development. Always validate your changes via
 // `yarn test:browser` (which uses a browser-based IndexedDB implementation)
@@ -36,9 +38,13 @@ if (process.env.USE_MOCK_PERSISTENCE === 'YES') {
     databaseBasePath: dbDir,
     deleteDatabaseFiles: true
   });
-  globalAny.window = Object.assign(globalAny.window || {}, {
-    indexedDB: globalAny.indexedDB
-  });
+
+  const fakeWindow = new FakeWindow(
+    new SharedFakeWebStorage(),
+    globalAny.indexedDB
+  );
+
+  globalAny.window = fakeWindow;
 
   // We need to define the `Event` type as it is used in Node to send events to
   // WebStorage when using both the IndexedDB mock and the WebStorage mock.

packages/firestore/test/util/test_platform.ts

@@ -27,27 +27,36 @@ import { assert, fail } from '../../src/util/assert';
  * Firestore.
  */
 export class FakeWindow {
-  private readonly storageArea: Storage;
-  private storageListener: EventListener = () => {};
+  private readonly fakeStorageArea: Storage;
+  private readonly fakeIndexedDb: IDBFactory;
 
-  constructor(sharedMockStorage: SharedFakeWebStorage) {
-    this.storageArea = sharedMockStorage.getStorageArea(event =>
-      this.storageListener(event)
-    );
+  private storageListeners: EventListener[] = [];
+
+  constructor(
+    sharedFakeStorage: SharedFakeWebStorage,
+    fakeIndexedDb?: IDBFactory
+  ) {
+    this.fakeStorageArea = sharedFakeStorage.getStorageArea(event => {
+      for (const listener of this.storageListeners) {
+        listener(event);
+      }
+    });
+    this.fakeIndexedDb =
+      fakeIndexedDb || (typeof window !== 'undefined' && window.indexedDB);
   }
 
   get localStorage(): Storage {
-    return this.storageArea;
+    return this.fakeStorageArea;
   }
 
   get indexedDB(): IDBFactory {
-    return window.indexedDB;
+    return this.fakeIndexedDb;
   }
 
   addEventListener(type: string, listener: EventListener): void {
     switch (type) {
       case 'storage':
-        this.storageListener = listener;
+        this.storageListeners.push(listener);
         break;
       case 'unload':
         // The spec tests currently do not rely on 'unload' listeners.
@@ -59,11 +68,15 @@ export class FakeWindow {
 
   removeEventListener(type: string, listener: EventListener): void {
     if (type === 'storage') {
+      const oldCount = this.storageListeners.length;
+      this.storageListeners = this.storageListeners.filter(
+        registeredListener => listener !== registeredListener
+      );
+      const newCount = this.storageListeners.length;
       assert(
-        this.storageListener === listener,
-        "Listener passed to 'removeEventListener' doesn't match the current listener."
+        newCount === oldCount - 1,
+        "Listener passed to 'removeEventListener' doesn't match any registered listener."
       );
-      this.storageListener = () => {};
     }
   }
 }
@@ -150,7 +163,8 @@ export class SharedFakeWebStorage {
   }
 
   private key(index: number): string | null {
-    return Array.from(this.data.keys())[index];
+    const key = Array.from(this.data.keys())[index];
+    return key !== undefined ? key : null;
   }
 
   private removeItem(key: string): void {