QuerySnapshot toJSON impl, but it has bugs

name and parent fields aren't properly populated. Looks like we have extraneous "orderBy" fields, too, which might be harmless.

Author: DellaBitta

common/api-review/firestore.api.md

@@ -616,6 +616,8 @@ export class QuerySnapshot<AppModelType = DocumentData, DbModelType extends Docu
     readonly metadata: SnapshotMetadata;
     readonly query: Query<AppModelType, DbModelType>;
     get size(): number;
+    // (undocumented)
+    toJSON(): object;
 }
 
 // @public

packages/firestore/src/api/snapshot.ts

@@ -38,6 +38,7 @@ import { DocumentKey } from '../model/document_key';
 import { debugAssert, fail } from '../util/assert';
 import { BundleBuilder, DocumentBundleData } from '../util/bundle_builder_impl';
 import { Code, FirestoreError } from '../util/error';
+import { AutoId } from '../util/misc';
 
 import { Firestore } from './database';
 import { SnapshotListenOptions } from './reference_impl';
@@ -507,13 +508,23 @@ export class DocumentSnapshot<
       return { bundle: '' };
     }
 
-    const builder: BundleBuilder = new BundleBuilder(this._firestore, 'abc123');
+    const builder: BundleBuilder = new BundleBuilder(
+      this._firestore,
+      AutoId.newId()
+    );
     const documentData = this._userDataWriter.convertObjectMap(
       this._document.data.value.mapValue.fields,
       'previous'
     );
 
-    builder.addBundleDocument(DocumentToDocumentBundleData(this._firestore, this.ref.path, documentData, this._document));
+    builder.addBundleDocument(
+      DocumentToDocumentBundleData(
+        this._firestore,
+        this.ref.path,
+        documentData,
+        this._document
+      )
+    );
     return {
       bundle: builder.build()
     };
@@ -659,7 +670,7 @@ export class QuerySnapshot<
       throw new FirestoreError(
         Code.INVALID_ARGUMENT,
         'To include metadata changes with your document changes, you must ' +
-        'also pass { includeMetadataChanges:true } to onSnapshot().'
+          'also pass { includeMetadataChanges:true } to onSnapshot().'
       );
     }
 
@@ -673,6 +684,35 @@ export class QuerySnapshot<
 
     return this._cachedChanges;
   }
+
+  toJSON(): object {
+    const builder: BundleBuilder = new BundleBuilder(
+      this._firestore,
+      AutoId.newId()
+    );
+    const docBundleDataArray: DocumentBundleData[] = [];
+    const docArray = this.docs;
+    docArray.forEach(doc => {
+      if (doc._document === null) {
+        return;
+      }
+      const documentData = this._userDataWriter.convertObjectMap(
+        doc._document.data.value.mapValue.fields,
+        'previous'
+      );
+      docBundleDataArray.push(
+        DocumentToDocumentBundleData(
+          this._firestore,
+          doc.ref.path,
+          documentData,
+          doc._document
+        )
+      );
+    });
+
+    builder.addBundleQuery(this.query._query, docBundleDataArray);
+    return { bundle: builder.build() };
+  }
 }
 
 /** Calculates the array of `DocumentChange`s for a given `ViewSnapshot`. */
@@ -695,10 +735,10 @@ export function changesFromSnapshot<
       );
       debugAssert(
         !lastDoc ||
-        newQueryComparator(querySnapshot._snapshot.query)(
-          lastDoc,
-          change.doc
-        ) < 0,
+          newQueryComparator(querySnapshot._snapshot.query)(
+            lastDoc,
+            change.doc
+          ) < 0,
         'Got added events in wrong order'
       );
       const doc = new QueryDocumentSnapshot<AppModelType, DbModelType>(
@@ -813,7 +853,12 @@ export function snapshotEqual<AppModelType, DbModelType extends DocumentData>(
   return false;
 }
 
-function DocumentToDocumentBundleData(firestore: Firestore, path: string, documentData: DocumentData, document: Document): DocumentBundleData {
+function DocumentToDocumentBundleData(
+  firestore: Firestore,
+  path: string,
+  documentData: DocumentData,
+  document: Document
+): DocumentBundleData {
   return {
     documentData,
     documentKey: document.mutableCopy().key,
@@ -823,4 +868,4 @@ function DocumentToDocumentBundleData(firestore: Firestore, path: string, docume
     readTime: document.readTime.toTimestamp(),
     versionTime: document.version.toTimestamp()
   };
-}
+}

packages/firestore/src/util/bundle_builder_impl.ts

@@ -18,11 +18,13 @@
 import {
   JsonProtoSerializer,
   toName,
+  toQueryTarget,
   toTimestamp
 } from '../../src/remote/serializer';
 import { encoder } from '../../test/unit/util/bundle_data';
 import { Firestore } from '../api/database';
 import { DatabaseId } from '../core/database_info';
+import { Query, queryToTarget } from '../core/query';
 import { DocumentData } from '../lite-api/reference';
 import { Timestamp } from '../lite-api/timestamp';
 import {
@@ -103,7 +105,10 @@ export class BundleBuilder {
     };
   }
 
-  addBundleDocument(docBundleData: DocumentBundleData): void {
+  addBundleDocument(
+    docBundleData: DocumentBundleData,
+    queryName?: string
+  ): void {
     const originalDocument = this.documents.get(docBundleData.documentPath);
     const originalQueries = originalDocument?.metadata.queries;
 
@@ -127,32 +132,32 @@ export class BundleBuilder {
     }
 
     // Update `queries` to include both original and `queryName`.
-    const newDocument = this.documents.get(docBundleData.documentPath)!;
-    newDocument.metadata.queries = originalQueries || [];
-    if (docBundleData.queryName) {
-      newDocument.metadata.queries!.push(docBundleData.queryName);
+    if (queryName) {
+      const newDocument = this.documents.get(docBundleData.documentPath)!;
+      newDocument.metadata.queries = originalQueries || [];
+      if (queryName) {
+        newDocument.metadata.queries!.push(queryName);
+      }
     }
     if (readTime && readTime > this.latestReadTime) {
       this.latestReadTime = readTime;
     }
   }
 
-  /*private addNamedQuery(name: string, querySnap: QuerySnapshot): void {
+  addBundleQuery(query: Query, docBundleDataArray: DocumentBundleData[]): void {
+    const queryTarget = toQueryTarget(this.serializer, queryToTarget(query));
+    const name = queryTarget.parent.canonicalString();
+
     if (this.namedQueries.has(name)) {
       throw new Error(`Query name conflict: ${name} has already been added.`);
     }
-    const queryTarget = toQueryTarget(
-      this.serializer,
-      queryToTarget(querySnap.query._query)
-    );
 
     let latestReadTime = new Timestamp(0, 0);
-    for (const snap of querySnap.docs) {
-      const readTime = snap.readTime;
-      if (readTime && readTime > latestReadTime) {
-        latestReadTime = readTime;
+    for (const docBundleData of docBundleDataArray) {
+      this.addBundleDocument(docBundleData, name);
+      if (docBundleData.readTime && docBundleData.readTime > latestReadTime) {
+        latestReadTime = docBundleData.readTime;
       }
-      this.addBundledDocument(snap, name);
     }
 
     const bundledQuery = {
@@ -166,7 +171,7 @@ export class BundleBuilder {
       bundledQuery,
       readTime: toTimestamp(this.serializer, latestReadTime)
     });
-  } */
+  }
 
   /**
    * Converts a IBundleElement to a Buffer whose content is the length prefixed JSON representation
@@ -234,7 +239,6 @@ export interface DocumentBundleData {
   readonly createdTime: Timestamp;
   readonly readTime?: Timestamp;
   readonly versionTime: Timestamp;
-  readonly queryName?: string;
 }
 
 /**