[Multi-Tab] Adding Schema Migration

packages/firestore/src/local/indexeddb_persistence.ts

@@ -30,7 +30,7 @@ import {
   createOrUpgradeDb,
   DbOwner,
   DbOwnerKey,
-  DEFAULT_SCHEMA_VERSION
+  SCHEMA_VERSION
 } from './indexeddb_schema';
 import { LocalSerializer } from './local_serializer';
 import { MutationQueue } from './mutation_queue';
@@ -132,11 +132,7 @@ export class IndexedDbPersistence implements Persistence {
     assert(!this.started, 'IndexedDbPersistence double-started!');
     this.started = true;
 
-    return SimpleDb.openOrCreate(
-      this.dbName,
-      DEFAULT_SCHEMA_VERSION,
-      createOrUpgradeDb
-    )
+    return SimpleDb.openOrCreate(this.dbName, SCHEMA_VERSION, createOrUpgradeDb)
       .then(db => {
         this.simpleDb = db;
       })

packages/firestore/src/local/indexeddb_schema.ts

@@ -23,16 +23,16 @@ import { assert } from '../util/assert';
 import { encode, EncodedResourcePath } from './encoded_resource_path';
 
 /**
- * Default Schema Version for the Web client (containing the Mutation Queue, the
- * Query and the Remote Document Cache).
+ * Schema Version for the Web client (containing the Mutation Queue, the Query
+ * and the Remote Document Cache) and Multi-Tab Support.
  */
-export const DEFAULT_SCHEMA_VERSION = 1;
+export const SCHEMA_VERSION = 2;
 
 /**
  * Performs database creation and schema upgrades.
  *
  * Note that in production, this method is only ever used to upgrade the schema
- * to DEFAULT_SCHEMA_VERSION. Different versions are only used for testing and
+ * to SCHEMA_VERSION. Different versions are only used for testing and
  * local feature development.
  */
 export function createOrUpgradeDb(
@@ -563,7 +563,8 @@ function createClientMetadataStore(db: IDBDatabase): void {
   });
 }
 
-const V1_STORES = [
+// Visible for testing
+export const V1_STORES = [
   DbMutationQueue.store,
   DbMutationBatch.store,
   DbDocumentMutation.store,
@@ -581,10 +582,4 @@ const V2_STORES = [DbClientMetadata.store, DbTargetChange.store];
  * used when creating transactions so that access across all stores is done
  * atomically.
  */
-export const DEFAULT_STORES = V1_STORES;
-
-/**
- * The list of all IndexedDb stores. This is only available in multi-tab enabled
- * clients with the schema version 2.
- */
-export const ALL_STORES = [...V1_STORES, ...V2_STORES];
+export const DEFAULT_STORES = [...V1_STORES, ...V2_STORES];

packages/firestore/src/local/simple_db.ts

@@ -19,7 +19,7 @@ import { debug } from '../util/log';
 import { AnyDuringMigration } from '../util/misc';
 
 import { PersistencePromise } from './persistence_promise';
-import { DEFAULT_SCHEMA_VERSION } from './indexeddb_schema';
+import { SCHEMA_VERSION } from './indexeddb_schema';
 
 const LOG_TAG = 'SimpleDb';
 
@@ -75,7 +75,7 @@ export class SimpleDb {
         // cheating and just passing the raw IndexedDB in, since
         // createObjectStore(), etc. are synchronous.
         const db = (event.target as IDBOpenDBRequest).result;
-        runUpgrade(db, event.oldVersion, DEFAULT_SCHEMA_VERSION);
+        runUpgrade(db, event.oldVersion, SCHEMA_VERSION);
       };
     }).toPromise();
   }

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

@@ -19,7 +19,7 @@ import { IndexedDbPersistence } from '../../../src/local/indexeddb_persistence';
 import {
   DEFAULT_STORES,
   createOrUpgradeDb,
-  ALL_STORES
+  V1_STORES
 } from '../../../src/local/indexeddb_schema';
 import { Deferred } from '../../../src/util/promise';
 import { SimpleDb } from '../../../src/local/simple_db';
@@ -42,14 +42,10 @@ function withDb(schemaVersion, fn: (db: IDBDatabase) => void): Promise<void> {
     request.onerror = (event: ErrorEvent) => {
       reject((event.target as IDBOpenDBRequest).error);
     };
-  })
-    .then(db => {
-      fn(db);
-      return db;
-    })
-    .then(db => {
-      db.close();
-    });
+  }).then(db => {
+    fn(db);
+    db.close();
+  });
 }
 
 function getAllObjectStores(db: IDBDatabase): String[] {
@@ -72,22 +68,22 @@ describe('IndexedDbSchema: createOrUpgradeDb', () => {
   it('can install schema version 1', () => {
     return withDb(1, db => {
       expect(db.version).to.be.equal(1);
-      expect(getAllObjectStores(db)).to.have.members(DEFAULT_STORES);
+      expect(getAllObjectStores(db)).to.have.members(V1_STORES);
     });
   });
 
   it('can install schema version 2', () => {
     return withDb(2, db => {
       expect(db.version).to.be.equal(2);
-      expect(getAllObjectStores(db)).to.have.members(ALL_STORES);
+      expect(getAllObjectStores(db)).to.have.members(DEFAULT_STORES);
     });
   });
 
   it('can upgrade from schema version 1 to 2', () => {
     return withDb(1, () => {}).then(() =>
       withDb(2, db => {
         expect(db.version).to.be.equal(2);
-        expect(getAllObjectStores(db)).to.have.members(ALL_STORES);
+        expect(getAllObjectStores(db)).to.have.members(DEFAULT_STORES);
       })
     );
   });