Ensure consistent JSON Serialization of DocumentKeys

Author: schmidt-sebastian

packages/firestore/src/core/sync_engine.ts

@@ -204,7 +204,7 @@ export class SyncEngine implements RemoteSyncer, SharedClientStateSyncer {
 
     const queryView = this.queryViewsByQuery.get(query);
     if (queryView) {
-      // PORTING NOTE: With Mult-Tab Web, it is possible that a query view
+      // PORTING NOTE: With Multi-Tab Web, it is possible that a query view
       // already exists when EventManager calls us for the first time. This
       // happens when the primary tab is already listening to this query on
       // behalf of another tab and the user of the primary also starts listening

packages/firestore/src/model/path.ts

@@ -73,6 +73,10 @@ export abstract class Path {
     return this.len;
   }
 
+  toJSON(): string[] {
+    return this.segments.slice(this.offset, this.limit());
+  }
+
   isEqual(other: Path): boolean {
     return Path.comparator(this, other) === 0;
   }

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

@@ -32,8 +32,10 @@ import {
   withTestDb
 } from '../util/helpers';
 
-const Timestamp = firebase.firestore!.Timestamp;
+const Blob = firebase.firestore!.Blob;
 const FieldPath = firebase.firestore!.FieldPath;
+const GeoPoint = firebase.firestore!.GeoPoint;
+const Timestamp = firebase.firestore!.Timestamp;
 
 // TODO(b/116617988): Use public API.
 interface FirestoreInternal extends firestore.FirebaseFirestore {
@@ -694,4 +696,35 @@ apiDescribe('Queries', persistence => {
       expect(querySnapshot.docs.map(d => d.id)).to.deep.equal(['cg-doc2']);
     });
   });
+
+  it('can query custom types', () => {
+    return withTestCollection(persistence, {}, async ref => {
+      const data = {
+        ref: ref.firestore.doc('f/c'),
+        geoPoint: new GeoPoint(0, 0),
+        buffer: Blob.fromBase64String('Zm9v'),
+        time: Timestamp.now()
+      };
+      await ref.add({ data });
+
+      // In https://github.com/firebase/firebase-js-sdk/issues/1524, a
+      // customer was not able to unlisten from a query that contained a
+      // nested object with a DocumentReference. The cause of it was that our
+      // serialization of nested references via JSON.stringify() was different
+      // for Queries created via the API layer versus Queries read from
+      // persistence. To simulate this issue, we have to listen and unlisten
+      // to the same query twice.
+      const query = ref.where('data', '==', data);
+
+      for (let i = 0; i < 2; ++i) {
+        const deferred = new Deferred();
+        const unsubscribe = query.onSnapshot(snapshot => {
+          expect(snapshot.size).to.equal(1);
+          deferred.resolve();
+        });
+        await deferred.promise;
+        unsubscribe();
+      }
+    });
+  });
 });

packages/firestore/test/unit/model/path.test.ts

@@ -171,6 +171,12 @@ describe('Path', () => {
     expect(abc.isPrefixOf(ba)).to.equal(false);
   });
 
+  it('respects offset during JSON serialization', () => {
+    const path1 = new ResourcePath(['c']);
+    const path2 = new ResourcePath(['a', 'b', 'c'], 2);
+    expect(JSON.stringify(path1)).to.equal(JSON.stringify(path2));
+  });
+
   it('can be constructed from field path.', () => {
     const path = FieldPath.fromServerFormat('foo\\..bar\\\\.baz');
     expect(path.toArray()).to.deep.equal(['foo.', 'bar\\', 'baz']);

packages/firestore/test/util/helpers.ts

@@ -565,8 +565,8 @@ export function expectNotEqual(left: any, right: any, message?: string): void {
 }
 
 export function expectEqualArrays(
-  left: unknown[],
-  right: unknown[],
+  left: Array<unknown>,
+  right: Array<unknown>,
   message?: string
 ): void {
   message = message ? ' ' + message : '';