Add _fieldsProto() method to snapshot and result classes for console support

Author: MarkDuckworth

packages/firestore/src/lite-api/aggregate_types.ts

@@ -16,8 +16,13 @@
  */
 
 import { AggregateType } from '../core/aggregate';
+import { ObjectValue } from '../model/object_value';
 import { FieldPath as InternalFieldPath } from '../model/path';
-import { ApiClientObjectMap, Value } from '../protos/firestore_proto_api';
+import {
+  ApiClientObjectMap,
+  firestoreV1ApiClientInterfaces,
+  Value
+} from '../protos/firestore_proto_api';
 
 import { average, count, sum } from './aggregate';
 import { DocumentData, Query } from './reference';
@@ -116,4 +121,22 @@ export class AggregateQuerySnapshot<
       this._data
     ) as AggregateSpecData<AggregateSpecType>;
   }
+
+  /**
+   * @internal
+   * @private
+   *
+   * Retrieves all fields in the snapshot as a proto value.
+   *
+   * @returns An `Object` containing all fields in the snapshot.
+   */
+  _fieldsProto(): { [key: string]: firestoreV1ApiClientInterfaces.Value } {
+    // Wrap data in an ObjectValue to clone it.
+    const dataClone = new ObjectValue({
+      mapValue: { fields: this._data }
+    }).clone();
+
+    // Return the cloned value to prevent manipulation of the Snapshot's data
+    return dataClone.value.mapValue.fields!;
+  }
 }

packages/firestore/src/lite-api/pipeline-result.ts

@@ -16,6 +16,7 @@
  */
 
 import { ObjectValue } from '../model/object_value';
+import { firestoreV1ApiClientInterfaces } from '../protos/firestore_proto_api';
 import { isOptionalEqual } from '../util/misc';
 
 import { Field, isField } from './expressions';
@@ -204,6 +205,19 @@ export class PipelineResult<AppModelType = DocumentData> {
     ) as AppModelType;
   }
 
+  /**
+   * @internal
+   * @private
+   *
+   * Retrieves all fields in the result as a proto value.
+   *
+   * @returns An `Object` containing all fields in the result.
+   */
+  _fieldsProto(): { [key: string]: firestoreV1ApiClientInterfaces.Value } {
+    // Return a cloned value to prevent manipulation of the Snapshot's data
+    return this._fields.clone().value.mapValue.fields!;
+  }
+
   /**
    * @beta
    * Retrieves the field specified by `field`.

packages/firestore/src/lite-api/snapshot.ts

@@ -19,6 +19,7 @@ import { getModularInstance } from '@firebase/util';
 
 import { Document } from '../model/document';
 import { DocumentKey } from '../model/document_key';
+import { firestoreV1ApiClientInterfaces } from '../protos/firestore_proto_api';
 import { arrayEquals } from '../util/misc';
 
 import { Firestore } from './database';
@@ -365,6 +366,23 @@ export class DocumentSnapshot<
     }
   }
 
+  /**
+   * @internal
+   * @private
+   *
+   * Retrieves all fields in the document as a proto Value. Returns `undefined` if
+   * the document doesn't exist.
+   *
+   * @returns An `Object` containing all fields in the document or `undefined`
+   * if the document doesn't exist.
+   */
+  _fieldsProto():
+    | { [key: string]: firestoreV1ApiClientInterfaces.Value }
+    | undefined {
+    // Return a cloned value to prevent manipulation of the Snapshot's data
+    return this._document?.data.clone().value.mapValue.fields ?? undefined;
+  }
+
   /**
    * Retrieves the field specified by `fieldPath`. Returns `undefined` if the
    * document or field doesn't exist.

packages/firestore/test/integration/api/console.test.ts

@@ -0,0 +1,51 @@
+import { expect } from 'chai';
+
+import {
+  count,
+  setDoc,
+  getAggregateFromServer,
+  getDoc,
+  average
+} from '../util/firebase_export';
+import { apiDescribe, withTestCollection, withTestDoc } from '../util/helpers';
+
+apiDescribe('console support', persistence => {
+  it('supports DocumentSnapshot serialization to proto', async () => {
+    await withTestDoc(persistence, async (docRef, firestore) => {
+      await setDoc(docRef, { foo: 3, bar: 3.5 });
+      const doc = await getDoc(docRef);
+      expect(doc._fieldsProto()).to.deep.equal({
+        'foo': {
+          'integerValue': '3'
+        },
+        'bar': {
+          'doubleValue': 3.5
+        }
+      });
+    });
+  });
+
+  it('supports AggregateSnapshot serialization to proto', async () => {
+    await withTestCollection(
+      persistence,
+      {
+        1: { foo: 1 },
+        2: { foo: 1 }
+      },
+      async collRef => {
+        const doc = await getAggregateFromServer(collRef, {
+          count: count(),
+          avg: average('foo')
+        });
+        expect(doc._fieldsProto()).to.deep.equal({
+          'count': {
+            'integerValue': '2'
+          },
+          'avg': {
+            'doubleValue': 1.0
+          }
+        });
+      }
+    );
+  });
+});

packages/firestore/test/integration/api/pipeline.test.ts

@@ -341,7 +341,7 @@ apiDescribe.skipClassic('Pipelines', persistence => {
   });
 
   describe('console support', () => {
-    it('supports internal serialization to proto', async () => {
+    it('supports pipeline query serialization to proto', async () => {
       // Perform the same test as the console
       const pipeline = firestore
         .pipeline()
@@ -357,6 +357,104 @@ apiDescribe.skipClassic('Pipelines', persistence => {
       );
     });
 
+    it('supports PipelineSnapshot serialization to proto', async () => {
+      // Perform the same test as the console
+      const pipeline = firestore
+        .pipeline()
+        .collection(randomCol)
+        .sort(field('title').ascending())
+        .limit(1);
+
+      const result = await execute(pipeline);
+
+      expect(result.results[0]._fieldsProto()).to.deep.equal({
+        'author': {
+          'stringValue': 'George Orwell'
+        },
+        'awards': {
+          'mapValue': {
+            'fields': {
+              'prometheus': {
+                'booleanValue': true
+              }
+            }
+          }
+        },
+        'embedding': {
+          'mapValue': {
+            'fields': {
+              '__type__': {
+                'stringValue': '__vector__'
+              },
+              'value': {
+                'arrayValue': {
+                  'values': [
+                    {
+                      'doubleValue': 1
+                    },
+                    {
+                      'doubleValue': 1
+                    },
+                    {
+                      'doubleValue': 1
+                    },
+                    {
+                      'doubleValue': 1
+                    },
+                    {
+                      'doubleValue': 1
+                    },
+                    {
+                      'doubleValue': 1
+                    },
+                    {
+                      'doubleValue': 1
+                    },
+                    {
+                      'doubleValue': 10
+                    },
+                    {
+                      'doubleValue': 1
+                    },
+                    {
+                      'doubleValue': 1
+                    }
+                  ]
+                }
+              }
+            }
+          }
+        },
+        'genre': {
+          'stringValue': 'Dystopian'
+        },
+        'published': {
+          'integerValue': '1949'
+        },
+        'rating': {
+          'doubleValue': 4.2
+        },
+        'tags': {
+          'arrayValue': {
+            'values': [
+              {
+                'stringValue': 'surveillance'
+              },
+              {
+                'stringValue': 'totalitarianism'
+              },
+              {
+                'stringValue': 'propaganda'
+              }
+            ]
+          }
+        },
+        'title': {
+          'stringValue': '1984'
+        }
+      });
+    });
+
     it('performs validation', async () => {
       expect(() => {
         const pipeline = firestore