set up migration

Author: dconeybe

packages/firestore/src/local/indexeddb_schema.ts

@@ -211,16 +211,6 @@ export interface DbRemoteDocument {
   /** The document ID. */
   documentId: string;
 
-  /**
-   * The type of the remote document.
-   * 0: A normal document.
-   * 1: A document representing a bundle.
-   *
-   * This is a schema migration starting at version 19. Documents written
-   * prior to this version has this field unset.
-   */
-  documentType?: number;
-
   /** When the document was read from the backend. */
   readTime: DbTimestampKey;
 
@@ -247,6 +237,19 @@ export interface DbRemoteDocument {
    * the write's commit version as their document version.
    */
   hasCommittedMutations: boolean;
+  /**
+   * The type of the remote document.
+   * 0: The type has not been determined, likely due to a schema migration from
+   *    and older version that lacked this property.
+   * 1: NO_DOCUMENT: The `noDocument` property is set.
+   * 2: FOUND_DOCUMENT: The `document` property is set to a real document.
+   * 3: UNKNOWN_DOCUMENT: The `unknownDocument` property is set.
+   * 4: INVALID_DOCUMENT: Should never happen, but here for completeness.
+   *
+   * This property was added in a schema migration at version 19. Documents
+   * written prior to this version has this field set to 0 (zero).
+   */
+  documentType: number;
 }
 
 /**

packages/firestore/src/local/indexeddb_schema_converter.ts

@@ -74,6 +74,8 @@ import {
   DbGlobalsStore,
   DbIndexConfigurationCollectionGroupIndex,
   DbIndexConfigurationCollectionGroupIndexPath,
+  DbRemoteDocumentCollectionIndex,
+  DbRemoteDocumentCollectionIndexPath,
   DbIndexConfigurationKeyPath,
   DbIndexConfigurationStore,
   DbIndexEntryDocumentKeyIndex,
@@ -296,26 +298,15 @@ export class SchemaConverter implements SimpleDbSchemaConverter {
     }
 
     if (fromVersion < 19 && toVersion >= 19) {
-      p = p.next(() => this.backfillDocumentType(simpleDbTransaction));
+      p = p.next(() => {
+        createRemoteDocumentStoreDocumentTypeIndex(txn);
+        return backfillRemoteDocumentStoreDocumentType(simpleDbTransaction);
+      });
     }
 
     return p;
   }
 
-  private backfillDocumentType(
-    txn: SimpleDbTransaction
-  ): PersistencePromise<void> {
-    const remoteDocumentStore = txn.store<
-      DbRemoteDocumentKey,
-      DbRemoteDocument
-    >(DbRemoteDocumentStore);
-
-    return remoteDocumentStore.iterate((key, doc) => {
-      doc.documentType = 0;
-      return remoteDocumentStore.put(doc);
-    });
-  }
-
   private addDocumentGlobal(
     txn: SimpleDbTransaction
   ): PersistencePromise<void> {
@@ -519,7 +510,8 @@ export class SchemaConverter implements SimpleDbSchemaConverter {
           unknownDocument: legacyDocument.unknownDocument,
           noDocument: legacyDocument.noDocument,
           document: legacyDocument.document,
-          hasCommittedMutations: !!legacyDocument.hasCommittedMutations
+          hasCommittedMutations: !!legacyDocument.hasCommittedMutations,
+          documentType: 0
         };
         writes.push(remoteDocumentStore.put(dbRemoteDocument));
       })
@@ -813,3 +805,26 @@ function extractKey(remoteDoc: DbRemoteDocumentLegacy): DocumentKey {
     return fail(0x8faf, 'Unexpected DbRemoteDocument');
   }
 }
+
+function createRemoteDocumentStoreDocumentTypeIndex(txn: IDBTransaction): void {
+  txn
+    .objectStore(DbRemoteDocumentStore)
+    .createIndex(
+      DbRemoteDocumentCollectionIndex,
+      DbRemoteDocumentCollectionIndexPath,
+      { unique: false }
+    );
+}
+
+function backfillRemoteDocumentStoreDocumentType(
+  txn: SimpleDbTransaction
+): PersistencePromise<void> {
+  const remoteDocumentStore = txn.store<DbRemoteDocumentKey, DbRemoteDocument>(
+    DbRemoteDocumentStore
+  );
+
+  return remoteDocumentStore.iterate((key, doc) => {
+    doc.documentType = 0;
+    return remoteDocumentStore.put(doc);
+  });
+}

packages/firestore/src/local/indexeddb_sentinels.ts

@@ -172,6 +172,25 @@ export const DbRemoteDocumentCollectionGroupIndexPath = [
   'documentId'
 ];
 
+/**
+ * An index that provides access to documents by collection, read time, and
+ * document type.
+ *
+ * This index is used as an optimization in getDocumentsMatchingQuery() to
+ * avoid visiting "tombstone" entries which are impossible to be part of the
+ * query result anyway.
+ *
+ * See https://github.com/firebase/firebase-android-sdk/issues/7295.
+ */
+export const DbRemoteDocumentCollectionIndex = 'collectionIndex';
+
+export const DbRemoteDocumentCollectionIndexPath = [
+  'documentType',
+  'prefixPath',
+  'collectionGroup',
+  'readTime'
+];
+
 export const DbRemoteDocumentGlobalStore = 'remoteDocumentGlobal';
 
 export const DbRemoteDocumentGlobalKey = 'remoteDocumentGlobalKey';