Use interfaces for IndexedDB (#6029)

Author: schmidt-sebastian

packages/firestore/src/local/indexeddb_bundle_cache.ts

@@ -22,12 +22,13 @@ import {
 } from '../protos/firestore_bundle_proto';
 
 import { BundleCache } from './bundle_cache';
+import { DbBundle, DbNamedQuery } from './indexeddb_schema';
 import {
-  DbBundle,
   DbBundlesKey,
+  DbBundleStore,
   DbNamedQueriesKey,
-  DbNamedQuery
-} from './indexeddb_schema';
+  DbNamedQueryStore
+} from './indexeddb_sentinels';
 import { getStore } from './indexeddb_transaction';
 import {
   fromDbBundle,
@@ -89,7 +90,7 @@ export class IndexedDbBundleCache implements BundleCache {
 function bundlesStore(
   txn: PersistenceTransaction
 ): SimpleDbStore<DbBundlesKey, DbBundle> {
-  return getStore<DbBundlesKey, DbBundle>(txn, DbBundle.store);
+  return getStore<DbBundlesKey, DbBundle>(txn, DbBundleStore);
 }
 
 /**
@@ -98,5 +99,5 @@ function bundlesStore(
 function namedQueriesStore(
   txn: PersistenceTransaction
 ): SimpleDbStore<DbNamedQueriesKey, DbNamedQuery> {
-  return getStore<DbNamedQueriesKey, DbNamedQuery>(txn, DbNamedQuery.store);
+  return getStore<DbNamedQueriesKey, DbNamedQuery>(txn, DbNamedQueryStore);
 }

packages/firestore/src/local/indexeddb_document_overlay_cache.ts

@@ -24,7 +24,13 @@ import { ResourcePath } from '../model/path';
 
 import { DocumentOverlayCache } from './document_overlay_cache';
 import { encodeResourcePath } from './encoded_resource_path';
-import { DbDocumentOverlay, DbDocumentOverlayKey } from './indexeddb_schema';
+import { DbDocumentOverlay } from './indexeddb_schema';
+import {
+  DbDocumentOverlayCollectionGroupOverlayIndex,
+  DbDocumentOverlayCollectionPathOverlayIndex,
+  DbDocumentOverlayKey,
+  DbDocumentOverlayStore
+} from './indexeddb_sentinels';
 import { getStore } from './indexeddb_transaction';
 import {
   fromDbDocumentOverlay,
@@ -106,7 +112,7 @@ export class IndexedDbDocumentOverlayCache implements DocumentOverlayCache {
       );
       promises.push(
         documentOverlayStore(transaction).deleteAll(
-          DbDocumentOverlay.collectionPathOverlayIndex,
+          DbDocumentOverlayCollectionPathOverlayIndex,
           range
         )
       );
@@ -129,7 +135,7 @@ export class IndexedDbDocumentOverlayCache implements DocumentOverlayCache {
       /*lowerOpen=*/ true
     );
     return documentOverlayStore(transaction)
-      .loadAll(DbDocumentOverlay.collectionPathOverlayIndex, range)
+      .loadAll(DbDocumentOverlayCollectionPathOverlayIndex, range)
       .next(dbOverlays => {
         for (const dbOverlay of dbOverlays) {
           const overlay = fromDbDocumentOverlay(this.serializer, dbOverlay);
@@ -157,7 +163,7 @@ export class IndexedDbDocumentOverlayCache implements DocumentOverlayCache {
     return documentOverlayStore(transaction)
       .iterate(
         {
-          index: DbDocumentOverlay.collectionGroupOverlayIndex,
+          index: DbDocumentOverlayCollectionGroupOverlayIndex,
           range
         },
         (_, dbOverlay, control) => {
@@ -198,6 +204,6 @@ function documentOverlayStore(
 ): SimpleDbStore<DbDocumentOverlayKey, DbDocumentOverlay> {
   return getStore<DbDocumentOverlayKey, DbDocumentOverlay>(
     txn,
-    DbDocumentOverlay.store
+    DbDocumentOverlayStore
   );
 }

packages/firestore/src/local/indexeddb_index_manager.ts

@@ -64,14 +64,23 @@ import {
 import { IndexManager } from './index_manager';
 import {
   DbCollectionParent,
-  DbCollectionParentKey,
   DbIndexConfiguration,
-  DbIndexConfigurationKey,
   DbIndexEntry,
-  DbIndexEntryKey,
-  DbIndexState,
-  DbIndexStateKey
+  DbIndexState
 } from './indexeddb_schema';
+import {
+  DbCollectionParentKey,
+  DbCollectionParentStore,
+  DbIndexConfigurationCollectionGroupIndex,
+  DbIndexConfigurationKey,
+  DbIndexConfigurationStore,
+  DbIndexEntryDocumentKeyIndex,
+  DbIndexEntryKey,
+  DbIndexEntryStore,
+  DbIndexStateKey,
+  DbIndexStateSequenceNumberIndex,
+  DbIndexStateStore
+} from './indexeddb_sentinels';
 import { getStore } from './indexeddb_transaction';
 import {
   fromDbIndexConfiguration,
@@ -311,7 +320,7 @@ export class IndexedDbIndexManager implements IndexManager {
   }
 
   /**
-   * Constructs a key range query on `DbIndexEntry.store` that unions all
+   * Constructs a key range query on `DbIndexEntryStore` that unions all
    * bounds.
    */
   private generateIndexRanges(
@@ -586,7 +595,7 @@ export class IndexedDbIndexManager implements IndexManager {
     return (
       collectionGroup
         ? indexes.loadAll(
-            DbIndexConfiguration.collectionGroupIndex,
+            DbIndexConfigurationCollectionGroupIndex,
             IDBKeyRange.bound(collectionGroup, collectionGroup)
           )
         : indexes.loadAll()
@@ -632,7 +641,7 @@ export class IndexedDbIndexManager implements IndexManager {
     return this.getNextSequenceNumber(transaction).next(nextSequenceNumber =>
       indexes
         .loadAll(
-          DbIndexConfiguration.collectionGroupIndex,
+          DbIndexConfigurationCollectionGroupIndex,
           IDBKeyRange.bound(collectionGroup, collectionGroup)
         )
         .next(configs =>
@@ -701,15 +710,13 @@ export class IndexedDbIndexManager implements IndexManager {
     indexEntry: IndexEntry
   ): PersistencePromise<void> {
     const indexEntries = indexEntriesStore(transaction);
-    return indexEntries.put(
-      new DbIndexEntry(
-        indexEntry.indexId,
-        this.uid,
-        indexEntry.arrayValue,
-        indexEntry.directionalValue,
-        encodeResourcePath(document.key.path)
-      )
-    );
+    return indexEntries.put({
+      indexId: indexEntry.indexId,
+      uid: this.uid,
+      arrayValue: indexEntry.arrayValue,
+      directionalValue: indexEntry.directionalValue,
+      documentKey: encodeResourcePath(document.key.path)
+    });
   }
 
   private deleteIndexEntry(
@@ -737,7 +744,7 @@ export class IndexedDbIndexManager implements IndexManager {
     return indexEntries
       .iterate(
         {
-          index: DbIndexEntry.documentKeyIndex,
+          index: DbIndexEntryDocumentKeyIndex,
           range: IDBKeyRange.only([
             fieldIndex.indexId,
             this.uid,
@@ -839,7 +846,7 @@ export class IndexedDbIndexManager implements IndexManager {
     return states
       .iterate(
         {
-          index: DbIndexState.sequenceNumberIndex,
+          index: DbIndexStateSequenceNumberIndex,
           reverse: true,
           range: IDBKeyRange.upperBound([this.uid, Number.MAX_SAFE_INTEGER])
         },
@@ -924,7 +931,7 @@ function collectionParentsStore(
 ): SimpleDbStore<DbCollectionParentKey, DbCollectionParent> {
   return getStore<DbCollectionParentKey, DbCollectionParent>(
     txn,
-    DbCollectionParent.store
+    DbCollectionParentStore
   );
 }
 
@@ -934,7 +941,7 @@ function collectionParentsStore(
 function indexEntriesStore(
   txn: PersistenceTransaction
 ): SimpleDbStore<DbIndexEntryKey, DbIndexEntry> {
-  return getStore<DbIndexEntryKey, DbIndexEntry>(txn, DbIndexEntry.store);
+  return getStore<DbIndexEntryKey, DbIndexEntry>(txn, DbIndexEntryStore);
 }
 
 /**
@@ -945,7 +952,7 @@ function indexConfigurationStore(
 ): SimpleDbStore<DbIndexConfigurationKey, DbIndexConfiguration> {
   return getStore<DbIndexConfigurationKey, DbIndexConfiguration>(
     txn,
-    DbIndexConfiguration.store
+    DbIndexConfigurationStore
   );
 }
 
@@ -955,5 +962,5 @@ function indexConfigurationStore(
 function indexStateStore(
   txn: PersistenceTransaction
 ): SimpleDbStore<DbIndexStateKey, DbIndexState> {
-  return getStore<DbIndexStateKey, DbIndexState>(txn, DbIndexState.store);
+  return getStore<DbIndexStateKey, DbIndexState>(txn, DbIndexStateStore);
 }

packages/firestore/src/local/indexeddb_lru_delegate_impl.ts

@@ -28,6 +28,7 @@ import {
 import { IndexedDbLruDelegate } from './indexeddb_lru_delegate';
 import { mutationQueuesContainKey } from './indexeddb_mutation_queue';
 import { DbTargetDocument } from './indexeddb_schema';
+import { DbTargetDocumentDocumentTargetsIndex } from './indexeddb_sentinels';
 import {
   documentTargetStore,
   IndexedDbTargetCache
@@ -201,7 +202,7 @@ export class IndexedDbLruDelegateImpl implements IndexedDbLruDelegate {
     return store
       .iterate(
         {
-          index: DbTargetDocument.documentTargetsIndex
+          index: DbTargetDocumentDocumentTargetsIndex
         },
         ([targetId, docKey], { path, sequenceNumber }) => {
           if (targetId === 0) {
@@ -250,7 +251,7 @@ function sentinelRow(
   key: DocumentKey,
   sequenceNumber: ListenSequenceNumber
 ): DbTargetDocument {
-  return new DbTargetDocument(0, encodeResourcePath(key.path), sequenceNumber);
+  return { targetId: 0, path: encodeResourcePath(key.path), sequenceNumber };
 }
 
 function writeSentinelKey(

packages/firestore/src/local/indexeddb_mutation_batch_impl.ts

@@ -20,11 +20,16 @@ import { fail, hardAssert } from '../util/assert';
 
 import {
   DbDocumentMutation,
-  DbDocumentMutationKey,
   DbMutationBatch,
-  DbMutationBatchKey,
   DbRemoteDocument
 } from './indexeddb_schema';
+import {
+  DbDocumentMutationKey,
+  DbDocumentMutationStore,
+  DbMutationBatchKey,
+  DbMutationBatchStore,
+  newDbDocumentMutationKey
+} from './indexeddb_sentinels';
 import { PersistencePromise } from './persistence_promise';
 import { SimpleDbTransaction } from './simple_db';
 
@@ -38,10 +43,10 @@ export function removeMutationBatch(
   batch: { batchId: number; mutations: Array<{ key: DocumentKey }> }
 ): PersistencePromise<DocumentKey[]> {
   const mutationStore = txn.store<DbMutationBatchKey, DbMutationBatch>(
-    DbMutationBatch.store
+    DbMutationBatchStore
   );
   const indexTxn = txn.store<DbDocumentMutationKey, DbDocumentMutation>(
-    DbDocumentMutation.store
+    DbDocumentMutationStore
   );
   const promises: Array<PersistencePromise<void>> = [];
 
@@ -65,7 +70,7 @@ export function removeMutationBatch(
   );
   const removedDocuments: DocumentKey[] = [];
   for (const mutation of batch.mutations) {
-    const indexKey = DbDocumentMutation.key(
+    const indexKey = newDbDocumentMutationKey(
       userId,
       mutation.key.path,
       batch.batchId