Add equals methods (firebase#3176)

schmidt-sebastian · web-flow · commit 1bc2ccc1fdc4 · 2020-06-15T19:14:08.000-07:00
diff --git a/packages/firestore/exp/index.d.ts b/packages/firestore/exp/index.d.ts
@@ -286,6 +286,7 @@ export class Query<T = DocumentData> {
 }
 
 export class QuerySnapshot<T = DocumentData> {
+  private constructor();
   readonly query: Query<T>;
   readonly docs: Array<QueryDocumentSnapshot<T>>;
   readonly metadata: SnapshotMetadata;
@@ -308,6 +309,7 @@ export interface DocumentChange<T = DocumentData> {
 }
 
 export class CollectionReference<T = DocumentData> extends Query<T> {
+  private constructor();
   readonly id: string;
   readonly path: string;
   withConverter<U>(
@@ -448,14 +450,14 @@ export class FieldPath {
 
 export function documentId(): FieldPath;
 
-export function refEqual(
-  l: DocumentReference | CollectionReference,
-  r: DocumentReference | CollectionReference
+export function refEqual<T>(
+  left: DocumentReference<T> | CollectionReference<T>,
+  right: DocumentReference<T> | CollectionReference<T>
 ): boolean;
-export function queryEqual(l: Query, r: Query): boolean;
-export function snapshotEqual(
-  l: DocumentSnapshot | QuerySnapshot,
-  r: DocumentSnapshot | QuerySnapshot
+export function queryEqual<T>(left: Query<T>, right: Query<T>): boolean;
+export function snapshotEqual<T>(
+  left: DocumentSnapshot<T> | QuerySnapshot<T>,
+  right: DocumentSnapshot<T> | QuerySnapshot<T>
 ): boolean;
 
 export type FirestoreErrorCode =
diff --git a/packages/firestore/lite/index.d.ts b/packages/firestore/lite/index.d.ts
@@ -245,6 +245,7 @@ export class Query<T = DocumentData> {
 }
 
 export class QuerySnapshot<T = DocumentData> {
+  private constructor();
   readonly query: Query<T>;
   readonly docs: Array<QueryDocumentSnapshot<T>>;
   readonly size: number;
@@ -256,6 +257,7 @@ export class QuerySnapshot<T = DocumentData> {
 }
 
 export class CollectionReference<T = DocumentData> extends Query<T> {
+  private constructor();
   readonly id: string;
   readonly path: string;
   withConverter<U>(
@@ -311,14 +313,14 @@ export class FieldPath {
 
 export function documentId(): FieldPath;
 
-export function refEqual(
-  l: DocumentReference | CollectionReference,
-  r: DocumentReference | CollectionReference
+export function refEqual<T>(
+  left: DocumentReference<T> | CollectionReference<T>,
+  right: DocumentReference<T> | CollectionReference<T>
 ): boolean;
-export function queryEqual(l: Query, r: Query): boolean;
-export function snapshotEqual(
-  l: DocumentSnapshot | QuerySnapshot,
-  r: DocumentSnapshot | QuerySnapshot
+export function queryEqual<T>(left: Query<T>, right: Query<T>): boolean;
+export function snapshotEqual<T>(
+  left: DocumentSnapshot<T> | QuerySnapshot<T>,
+  right: DocumentSnapshot<T> | QuerySnapshot<T>
 ): boolean;
 
 export type FirestoreErrorCode =
diff --git a/packages/firestore/lite/index.node.ts b/packages/firestore/lite/index.node.ts
@@ -34,14 +34,17 @@ export {
   Query,
   CollectionReference,
   collection,
+  collectionGroup,
   doc,
   parent,
   getDoc,
   getQuery,
   deleteDoc,
   setDoc,
   updateDoc,
-  addDoc
+  addDoc,
+  refEqual,
+  queryEqual
 } from './src/api/reference';
 
 // TOOD(firestorelite): Add tests when Queries are usable
@@ -57,7 +60,11 @@ export {
   serverTimestamp
 } from './src/api/field_value';
 
-export { DocumentSnapshot, QueryDocumentSnapshot } from './src/api/snapshot';
+export {
+  DocumentSnapshot,
+  QueryDocumentSnapshot,
+  snapshotEqual
+} from './src/api/snapshot';
 
 export { WriteBatch, writeBatch } from './src/api/write_batch';
 
diff --git a/packages/firestore/lite/src/api/reference.ts b/packages/firestore/lite/src/api/reference.ts
@@ -61,6 +61,7 @@ import {
   validatePositiveNumber
 } from '../../../src/util/input_validation';
 import { FieldPath as ExternalFieldPath } from '../../../src/api/field_path';
+import { Code, FirestoreError } from '../../../src/util/error';
 
 /**
  * A reference to a particular document in a collection in the database.
@@ -302,6 +303,28 @@ export function collection(
   }
 }
 
+export function collectionGroup(
+  firestore: firestore.FirebaseFirestore,
+  collectionId: string
+): Query<firestore.DocumentData> {
+  const firestoreClient = cast(firestore, Firestore);
+
+  validateArgType('collectionGroup', 'non-empty string', 1, collectionId);
+  if (collectionId.indexOf('/') >= 0) {
+    throw new FirestoreError(
+      Code.INVALID_ARGUMENT,
+      `Invalid collection ID '${collectionId}' passed to function ` +
+        `collectionGroup(). Collection IDs must not contain '/'.`
+    );
+  }
+
+  return new Query(
+    firestoreClient,
+    new InternalQuery(ResourcePath.EMPTY_PATH, collectionId),
+    /* converter= */ null
+  );
+}
+
 export function doc(
   firestore: firestore.FirebaseFirestore,
   documentPath: string
@@ -533,6 +556,38 @@ export function addDoc<T>(
     .then(() => docRef);
 }
 
+export function refEqual<T>(
+  left: firestore.DocumentReference<T> | firestore.CollectionReference<T>,
+  right: firestore.DocumentReference<T> | firestore.CollectionReference<T>
+): boolean {
+  if (
+    (left instanceof DocumentReference ||
+      left instanceof CollectionReference) &&
+    (right instanceof DocumentReference || right instanceof CollectionReference)
+  ) {
+    return (
+      left.firestore === right.firestore &&
+      left.path === right.path &&
+      left._converter === right._converter
+    );
+  }
+  return false;
+}
+
+export function queryEqual<T>(
+  left: firestore.Query<T>,
+  right: firestore.Query<T>
+): boolean {
+  if (left instanceof Query && right instanceof Query) {
+    return (
+      left.firestore === right.firestore &&
+      left._query.isEqual(right._query) &&
+      left._converter === right._converter
+    );
+  }
+  return false;
+}
+
 export function newUserDataReader(firestore: Firestore): UserDataReader {
   const settings = firestore._getSettings();
   const serializer = PlatformSupport.getPlatform().newSerializer(
diff --git a/packages/firestore/lite/src/api/snapshot.ts b/packages/firestore/lite/src/api/snapshot.ts
@@ -18,14 +18,15 @@
 import * as firestore from '../../index';
 
 import { Firestore } from './database';
-import { DocumentReference } from './reference';
+import { DocumentReference, queryEqual } from './reference';
 import { FieldPath } from './field_path';
 import { cast } from './util';
 import { DocumentKey } from '../../../src/model/document_key';
 import { Document } from '../../../src/model/document';
 import { UserDataWriter } from '../../../src/api/user_data_writer';
 import { FieldPath as InternalFieldPath } from '../../../src/model/path';
 import { fieldPathFromDotSeparatedString } from '../../../src/api/user_data_reader';
+import { arrayEquals } from '../../../src/util/misc';
 
 export class DocumentSnapshot<T = firestore.DocumentData>
   implements firestore.DocumentSnapshot<T> {
@@ -35,10 +36,10 @@ export class DocumentSnapshot<T = firestore.DocumentData>
   // - No support for SnapshotOptions.
 
   constructor(
-    private _firestore: Firestore,
-    private _key: DocumentKey,
+    public _firestore: Firestore,
+    public _key: DocumentKey,
     public _document: Document | null,
-    private _converter: firestore.FirestoreDataConverter<T> | null
+    public _converter: firestore.FirestoreDataConverter<T> | null
   ) {}
 
   get id(): string {
@@ -112,8 +113,8 @@ export class QueryDocumentSnapshot<T = firestore.DocumentData>
 export class QuerySnapshot<T = firestore.DocumentData>
   implements firestore.QuerySnapshot<T> {
   constructor(
-    readonly query: firestore.Query<T>,
-    private readonly _docs: Array<QueryDocumentSnapshot<T>>
+    public readonly query: firestore.Query<T>,
+    public readonly _docs: Array<QueryDocumentSnapshot<T>>
   ) {}
 
   get docs(): Array<firestore.QueryDocumentSnapshot<T>> {
@@ -136,6 +137,29 @@ export class QuerySnapshot<T = firestore.DocumentData>
   }
 }
 
+export function snapshotEqual<T>(
+  left: firestore.DocumentSnapshot<T> | firestore.QuerySnapshot<T>,
+  right: firestore.DocumentSnapshot<T> | firestore.QuerySnapshot<T>
+): boolean {
+  if (left instanceof DocumentSnapshot && right instanceof DocumentSnapshot) {
+    return (
+      left._firestore === right._firestore &&
+      left._key.isEqual(right._key) &&
+      (left._document === null
+        ? right._document === null
+        : left._document.isEqual(right._document)) &&
+      left._converter === right._converter
+    );
+  } else if (left instanceof QuerySnapshot && right instanceof QuerySnapshot) {
+    return (
+      queryEqual(left.query, right.query) &&
+      arrayEquals(left.docs, right.docs, snapshotEqual)
+    );
+  }
+
+  return false;
+}
+
 /**
  * Helper that calls fromDotSeparatedString() but wraps any error thrown.
  */
diff --git a/packages/firestore/lite/test/helpers.ts b/packages/firestore/lite/test/helpers.ts
@@ -70,7 +70,7 @@ export function withTestDocAndInitialData(
 
 export function withTestCollectionAndInitialData(
   data: firestore.DocumentData[],
-  fn: (doc: firestore.CollectionReference) => void | Promise<void>
+  fn: (collRef: firestore.CollectionReference) => void | Promise<void>
 ): Promise<void> {
   return withTestDb(async db => {
     const coll = collection(db, AutoId.newId());
@@ -83,7 +83,7 @@ export function withTestCollectionAndInitialData(
 }
 
 export function withTestCollection(
-  fn: (doc: firestore.CollectionReference) => void | Promise<void>
+  fn: (collRef: firestore.CollectionReference) => void | Promise<void>
 ): Promise<void> {
   return withTestDb(db => {
     return fn(collection(db, AutoId.newId()));
diff --git a/packages/firestore/lite/test/integration.test.ts b/packages/firestore/lite/test/integration.test.ts
