Templated converter DocSnapshot.fromJSON

Author: DellaBitta

common/api-review/firestore.api.md

@@ -175,7 +175,7 @@ export class DocumentSnapshot<AppModelType = DocumentData, DbModelType extends D
     data(options?: SnapshotOptions): AppModelType | undefined;
     exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>;
     // (undocumented)
-    static fromJSON(db: Firestore, json: object): object;
+    static fromJSON<AppModelType, DbModelType extends DocumentData = DocumentData>(db: Firestore, json: object, converter: FirestoreDataConverter<AppModelType, DbModelType>): DocumentSnapshot<AppModelType, DbModelType>;
     get(fieldPath: string | FieldPath, options?: SnapshotOptions): any;
     get id(): string;
     readonly metadata: SnapshotMetadata;

packages/firestore/src/api/snapshot.ts

@@ -548,7 +548,14 @@ export class DocumentSnapshot<
     return result;
   }
 
-  static fromJSON(db: Firestore, json: object): object {
+  static fromJSON<
+    AppModelType,
+    DbModelType extends DocumentData = DocumentData
+  >(
+    db: Firestore,
+    json: object,
+    converter: FirestoreDataConverter<AppModelType, DbModelType>
+  ): DocumentSnapshot<AppModelType, DbModelType> {
     const requiredFields = ['bundle', 'bundleName', 'bundleSource'];
     let error: string | undefined = undefined;
     let bundleString: string = '';
@@ -579,7 +586,10 @@ export class DocumentSnapshot<
     }
     // Parse the bundle data.
     const serializer = newSerializer(db._databaseId);
-    const elements = createBundleReaderSync(bundleString, serializer).getElements();
+    const elements = createBundleReaderSync(
+      bundleString,
+      serializer
+    ).getElements();
     if (elements.length === 0) {
       error = 'No snapshat data was found in the bundle.';
     }
@@ -588,14 +598,16 @@ export class DocumentSnapshot<
       !elements[0].payload.documentMetadata ||
       !elements[1].payload.document
     ) {
-      error = 'DocumentSnapshot bundle data must contain one document metadata and then one document.';
+      error =
+        'DocumentSnapshot bundle data must contain one metadata and then one document.';
     }
     if (error) {
       throw new FirestoreError(Code.INVALID_ARGUMENT, error);
     }
     // convert bundle data into the types that the DocumentSnapshot constructore requires.
     const bundleConverter = new BundleConverterImpl(serializer);
-    const documentSnapshotData = bundleConverter.toDocumentSnapshotData(elements);
+    const documentSnapshotData =
+      bundleConverter.toDocumentSnapshotData(elements);
     const liteUserDataWriter = new LiteUserDataWriter(db);
     return new DocumentSnapshot(
       db,
@@ -606,7 +618,7 @@ export class DocumentSnapshot<
         /* hasPendingWrites= */ false,
         /* fromCache= */ false
       ),
-      /* converter= */ null
+      converter
     );
   }
 }

packages/firestore/src/core/bundle_impl.ts

@@ -27,7 +27,6 @@ import { MutableDocument } from '../model/document';
 import { DocumentKey } from '../model/document_key';
 import { ResourcePath } from '../model/path';
 import {
-  BundledDocumentMetadata,
   BundleMetadata as ProtoBundleMetadata,
   NamedQuery as ProtoNamedQuery
 } from '../protos/firestore_bundle_proto';
@@ -54,7 +53,7 @@ import { SnapshotVersion } from './snapshot_version';
  * Helper to convert objects from bundles to model objects in the SDK.
  */
 export class BundleConverterImpl implements BundleConverter {
-  constructor(private readonly serializer: JsonProtoSerializer) { }
+  constructor(private readonly serializer: JsonProtoSerializer) {}
 
   toDocumentKey(name: string): DocumentKey {
     return fromName(this.serializer, name);
@@ -78,26 +77,28 @@ export class BundleConverterImpl implements BundleConverter {
     }
   }
 
-  toDocumentSnapshotData(
-    bundleElements: SizedBundleElement[]): {
-      documentKey: DocumentKey;
-      mutableDoc: MutableDocument;
-    } {
+  toDocumentSnapshotData(bundleElements: SizedBundleElement[]): {
+    documentKey: DocumentKey;
+    mutableDoc: MutableDocument;
+  } {
     const metadata = bundleElements[0]?.payload?.documentMetadata!;
     const document = bundleElements[1]?.payload?.document!;
-    let error : string | undefined = undefined;
-    if( !metadata || !document) {
-      error = 'DocumentSnapshot bundle data requires both document metadata and document data';      
-    } else if( metadata.name !== document.name ) {
-      error = 'DocumentSnapshot metadata is not related to the document in the bundle.';
+    let error: string | undefined = undefined;
+    if (!metadata || !document) {
+      error =
+        'DocumentSnapshot bundle data requires both document metadata and document data';
+    } else if (metadata.name !== document.name) {
+      error =
+        'DocumentSnapshot metadata is not related to the document in the bundle.';
     }
-    if ( error ) {
+    if (error) {
       throw new FirestoreError(Code.INVALID_ARGUMENT, error);
-    }   
+    }
     const bundleConverter = new BundleConverterImpl(this.serializer);
     const documentKey = bundleConverter.toDocumentKey(metadata.name!);
     const mutableDoc = bundleConverter.toMutableDocument({
-      metadata, document
+      metadata,
+      document
     });
     return {
       documentKey,
@@ -163,8 +164,8 @@ export class BundleLoader {
     } else if (element.payload.document) {
       debugAssert(
         this.documents.length > 0 &&
-        this.documents[this.documents.length - 1].metadata.name ===
-        element.payload.document.name,
+          this.documents[this.documents.length - 1].metadata.name ===
+            element.payload.document.name,
         'The document being added does not match the stored metadata.'
       );
       this.documents[this.documents.length - 1].document =
@@ -208,7 +209,7 @@ export class BundleLoader {
   async complete(): Promise<BundleLoadResult> {
     debugAssert(
       this.documents[this.documents.length - 1]?.metadata.exists !== true ||
-      !!this.documents[this.documents.length - 1].document,
+        !!this.documents[this.documents.length - 1].document,
       'Bundled documents end with a document metadata element instead of a document.'
     );
     debugAssert(!!this.bundleMetadata.id, 'Bundle ID must be set.');

packages/firestore/src/util/bundle_reader_sync_impl.ts

@@ -46,7 +46,7 @@ export class BundleReaderSyncImpl implements BundleReaderSync {
       element = this.nextElement();
       if (element !== null) {
         this.elements.push(element);
-      } 
+      }
     } while (element !== null);
   }