Add terminate() and snapshotEqual() to firestore-exp (#3313)

Author: schmidt-sebastian

.changeset/many-lamps-bake.md

@@ -0,0 +1,2 @@
+---
+---

packages/firestore/exp/index.node.ts

@@ -25,10 +25,15 @@ export { FieldPath, documentId } from '../lite/src/api/field_path';
 export {
   Firestore,
   initializeFirestore,
-  getFirestore
+  getFirestore,
+  terminate
 } from './src/api/database';
 
-export { DocumentSnapshot, QueryDocumentSnapshot } from './src/api/snapshot';
+export {
+  DocumentSnapshot,
+  QueryDocumentSnapshot,
+  snapshotEqual
+} from './src/api/snapshot';
 
 export { SnapshotMetadata } from '../src/api/database';
 

packages/firestore/exp/src/api/database.ts

@@ -17,7 +17,7 @@
 
 import * as firestore from '../../index';
 
-import { _getProvider } from '@firebase/app-exp';
+import { _getProvider, _removeServiceInstance } from '@firebase/app-exp';
 import { FirebaseApp, _FirebaseService } from '@firebase/app-types-exp';
 import { Provider } from '@firebase/component';
 
@@ -30,6 +30,7 @@ import {
 } from '../../../src/core/component_provider';
 
 import { Firestore as LiteFirestore } from '../../../lite/src/api/database';
+import { cast } from '../../../lite/src/api/util';
 
 /**
  * The root reference to the Firestore database and the entry point for the
@@ -86,8 +87,8 @@ export class Firestore extends LiteFirestore
     return this._firestoreClientPromise;
   }
 
-  async delete(): Promise<void> {
-    // TODO(firestoreexp): Call terminate() once implemented
+  delete(): Promise<void> {
+    return terminate(this);
   }
 }
 
@@ -106,3 +107,13 @@ export function initializeFirestore(
 export function getFirestore(app: FirebaseApp): Firestore {
   return _getProvider(app, 'firestore-exp').getImmediate() as Firestore;
 }
+
+export function terminate(
+  firestore: firestore.FirebaseFirestore
+): Promise<void> {
+  _removeServiceInstance(firestore.app, 'firestore/lite');
+  const firestoreImpl = cast(firestore, Firestore);
+  return firestoreImpl
+    ._getFirestoreClient()
+    .then(firestoreClient => firestoreClient.terminate());
+}

packages/firestore/exp/src/api/snapshot.ts

@@ -29,7 +29,11 @@ import {
 } from '../../../lite/src/api/snapshot';
 import { Firestore } from './database';
 import { cast } from '../../../lite/src/api/util';
-import { DocumentReference, Query } from '../../../lite/src/api/reference';
+import {
+  DocumentReference,
+  Query,
+  queryEqual
+} from '../../../lite/src/api/reference';
 import {
   changesFromSnapshot,
   SnapshotMetadata
@@ -121,9 +125,9 @@ export class QuerySnapshot<T = firestore.DocumentData>
   private _cachedChangesIncludeMetadataChanges?: boolean;
 
   constructor(
-    private readonly _firestore: Firestore,
+    readonly _firestore: Firestore,
     readonly query: Query<T>,
-    private readonly _snapshot: ViewSnapshot,
+    readonly _snapshot: ViewSnapshot,
     readonly metadata: SnapshotMetadata
   ) {}
 
@@ -199,3 +203,30 @@ export class QuerySnapshot<T = firestore.DocumentData>
     );
   }
 }
+
+// TODO(firestoreexp): Add tests for snapshotEqual with different snapshot
+// metadata
+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 (
+      left._firestore === right._firestore &&
+      queryEqual(left.query, right.query) &&
+      left.metadata.isEqual(right.metadata) &&
+      left._snapshot.isEqual(right._snapshot)
+    );
+  }
+
+  return false;
+}