finish schema migration

Author: dconeybe

packages/firestore/src/local/indexeddb_schema.ts

@@ -185,6 +185,26 @@ export interface DbUnknownDocument {
   version: DbTimestamp;
 }
 
+/**
+ * The "type" of a document stored in a `DbRemoteDocument`.
+ */
+export enum DbRemoteDocumentType {
+  /**
+   * The `noDocument` property of the `DbRemoteDocument` is set.
+   */
+  NoDocument = 1,
+
+  /**
+   * The `document` property of the `DbRemoteDocument` is set.
+   */
+  FoundDocument = 2,
+
+  /**
+   * The `unknownDocument` property of the `DbRemoteDocument` is set.
+   */
+  UnknownDocument = 3
+}
+
 /**
  * An object to be stored in the 'remoteDocuments' store in IndexedDb.
  * It represents either:
@@ -238,18 +258,17 @@ export interface DbRemoteDocument {
    */
   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.
+   * The "type" of document stored in this object.
+   *
+   * The value of this property _must_ be consistent with the semantics of the
+   * `unknownDocument`, `noDocument`, and `document` properties. This property
+   * is provided as an optimization to allow skipping entries in result sets
+   * whose documents are not of the desired "type".
    *
    * 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;
+  documentType: DbRemoteDocumentType;
 }
 
 /**

packages/firestore/src/local/indexeddb_schema_converter.ts

@@ -44,15 +44,16 @@ import {
   DbMutationQueue,
   DbRemoteDocument,
   DbRemoteDocumentGlobal,
+  DbRemoteDocumentType,
   DbTarget,
   DbTargetDocument,
   DbTargetGlobal,
   SCHEMA_VERSION
 } from './indexeddb_schema';
 import {
   DbRemoteDocument as DbRemoteDocumentLegacy,
-  DbRemoteDocumentStore as DbRemoteDocumentStoreLegacy,
-  DbRemoteDocumentKey as DbRemoteDocumentKeyLegacy
+  DbRemoteDocumentKey as DbRemoteDocumentKeyLegacy,
+  DbRemoteDocumentStore as DbRemoteDocumentStoreLegacy
 } from './indexeddb_schema_legacy';
 import {
   DbBundleKeyPath,
@@ -74,8 +75,6 @@ import {
   DbGlobalsStore,
   DbIndexConfigurationCollectionGroupIndex,
   DbIndexConfigurationCollectionGroupIndexPath,
-  DbRemoteDocumentCollectionIndex,
-  DbRemoteDocumentCollectionIndexPath,
   DbIndexConfigurationKeyPath,
   DbIndexConfigurationStore,
   DbIndexEntryDocumentKeyIndex,
@@ -99,6 +98,8 @@ import {
   DbPrimaryClientStore,
   DbRemoteDocumentCollectionGroupIndex,
   DbRemoteDocumentCollectionGroupIndexPath,
+  DbRemoteDocumentCollectionIndex,
+  DbRemoteDocumentCollectionIndexPath,
   DbRemoteDocumentDocumentKeyIndex,
   DbRemoteDocumentDocumentKeyIndexPath,
   DbRemoteDocumentGlobalKey,
@@ -502,6 +503,9 @@ export class SchemaConverter implements SimpleDbSchemaConverter {
         >(DbRemoteDocumentStore);
 
         const path = extractKey(legacyDocument).path.toArray();
+
+        // Note: omit the "documentType" property because it will be populated
+        // by schema migration 19.
         const dbRemoteDocument = {
           prefixPath: path.slice(0, path.length - 2),
           collectionGroup: path[path.length - 2],
@@ -510,9 +514,8 @@ export class SchemaConverter implements SimpleDbSchemaConverter {
           unknownDocument: legacyDocument.unknownDocument,
           noDocument: legacyDocument.noDocument,
           document: legacyDocument.document,
-          hasCommittedMutations: !!legacyDocument.hasCommittedMutations,
-          documentType: 0
-        };
+          hasCommittedMutations: !!legacyDocument.hasCommittedMutations
+        } satisfies Omit<DbRemoteDocument, 'documentType'> as DbRemoteDocument;
         writes.push(remoteDocumentStore.put(dbRemoteDocument));
       })
       .next(() => PersistencePromise.waitFor(writes));
@@ -824,7 +827,12 @@ function backfillRemoteDocumentStoreDocumentType(
   );
 
   return remoteDocumentStore.iterate((key, doc) => {
-    doc.documentType = 0;
+    doc.documentType = doc.noDocument
+      ? DbRemoteDocumentType.NoDocument
+      : doc.unknownDocument
+      ? DbRemoteDocumentType.UnknownDocument
+      : DbRemoteDocumentType.FoundDocument;
+
     return remoteDocumentStore.put(doc);
   });
 }

packages/firestore/src/local/local_serializer.ts

@@ -66,6 +66,7 @@ import {
   DbNamedQuery,
   DbQuery,
   DbRemoteDocument,
+  DbRemoteDocumentType,
   DbTarget,
   DbTimestamp
 } from './indexeddb_schema';
@@ -117,30 +118,48 @@ export function toDbRemoteDocument(
   document: MutableDocument
 ): DbRemoteDocument {
   const key = document.key;
-  const remoteDoc: DbRemoteDocument = {
+  return {
     prefixPath: key.getCollectionPath().popLast().toArray(),
     collectionGroup: key.collectionGroup,
     documentId: key.path.lastSegment(),
     readTime: toDbTimestampKey(document.readTime),
-    hasCommittedMutations: document.hasCommittedMutations
+    hasCommittedMutations: document.hasCommittedMutations,
+    ...toDbRemoteDocumentDocumentSpecificComponents(localSerializer, document)
   };
+}
 
+function toDbRemoteDocumentDocumentSpecificComponents(
+  localSerializer: LocalSerializer,
+  document: MutableDocument
+): Pick<
+  DbRemoteDocument,
+  'documentType' | 'document' | 'noDocument' | 'unknownDocument'
+> {
   if (document.isFoundDocument()) {
-    remoteDoc.document = toDocument(localSerializer.remoteSerializer, document);
-  } else if (document.isNoDocument()) {
-    remoteDoc.noDocument = {
-      path: key.path.toArray(),
-      readTime: toDbTimestamp(document.version)
+    return {
+      documentType: DbRemoteDocumentType.FoundDocument,
+      document: toDocument(localSerializer.remoteSerializer, document)
     };
-  } else if (document.isUnknownDocument()) {
-    remoteDoc.unknownDocument = {
-      path: key.path.toArray(),
-      version: toDbTimestamp(document.version)
+  }
+  if (document.isNoDocument()) {
+    return {
+      documentType: DbRemoteDocumentType.NoDocument,
+      noDocument: {
+        path: document.key.path.toArray(),
+        readTime: toDbTimestamp(document.version)
+      }
+    };
+  }
+  if (document.isUnknownDocument()) {
+    return {
+      documentType: DbRemoteDocumentType.UnknownDocument,
+      unknownDocument: {
+        path: document.key.path.toArray(),
+        version: toDbTimestamp(document.version)
+      }
     };
-  } else {
-    return fail(0xe230, 'Unexpected Document', { document });
   }
-  return remoteDoc;
+  fail(0xe230, 'Unexpected Document', { document });
 }
 
 export function toDbTimestampKey(