implement Compat in firestore-compat

Author: Feiyang1

common/api-review/firestore-exp.api.md

@@ -53,6 +53,8 @@ export class CollectionReference<T = DocumentData> extends Query<T> {
     get path(): string;
     // (undocumented)
     readonly type = "collection";
+    withConverter(converter: null): CollectionReference<DocumentData>;
+    // (undocumented)
     withConverter<U>(converter: FirestoreDataConverter<U>): CollectionReference<U>;
 }
 
@@ -101,6 +103,8 @@ export class DocumentReference<T = DocumentData> {
     get parent(): CollectionReference<T>;
     get path(): string;
     readonly type = "document";
+    withConverter(converter: null): DocumentReference<DocumentData>;
+    // (undocumented)
     withConverter<U>(converter: FirestoreDataConverter<U>): DocumentReference<U>;
 }
 
@@ -318,6 +322,8 @@ export class Query<T = DocumentData> {
     protected constructor();
     readonly firestore: FirebaseFirestore;
     readonly type: 'query' | 'collection';
+    withConverter(converter: null): Query<DocumentData>;
+    // (undocumented)
     withConverter<U>(converter: FirestoreDataConverter<U>): Query<U>;
 }
 

common/api-review/firestore-lite.api.md

@@ -47,6 +47,8 @@ export class CollectionReference<T = DocumentData> extends Query<T> {
     get path(): string;
     // (undocumented)
     readonly type = "collection";
+    withConverter(converter: null): CollectionReference<DocumentData>;
+    // (undocumented)
     withConverter<U>(converter: FirestoreDataConverter<U>): CollectionReference<U>;
 }
 
@@ -81,6 +83,8 @@ export class DocumentReference<T = DocumentData> {
     get parent(): CollectionReference<T>;
     get path(): string;
     readonly type = "document";
+    withConverter(converter: null): DocumentReference<DocumentData>;
+    // (undocumented)
     withConverter<U>(converter: FirestoreDataConverter<U>): DocumentReference<U>;
 }
 
@@ -195,6 +199,8 @@ export class Query<T = DocumentData> {
     protected constructor();
     readonly firestore: FirebaseFirestore;
     readonly type: 'query' | 'collection';
+    withConverter(converter: null): Query<DocumentData>;
+    // (undocumented)
     withConverter<U>(converter: FirestoreDataConverter<U>): Query<U>;
 }
 

packages/firestore/exp/index.ts

@@ -133,5 +133,3 @@ export { CACHE_SIZE_UNLIMITED } from '../src/exp/database';
 export { FirestoreErrorCode, FirestoreError } from '../src/util/error';
 
 export { AbstractUserDataWriter } from '../src/lite/user_data_writer';
-
-export { Compat } from '../src/lite/compat';

packages/firestore/externs.json

@@ -27,6 +27,7 @@
     "packages/webchannel-wrapper/src/index.d.ts",
     "packages/util/dist/src/crypt.d.ts",
     "packages/util/dist/src/environment.d.ts",
+    "packages/util/dist/src/compat.d.ts",
     "packages/firestore/export.ts",
     "packages/firestore/src/protos/firestore_bundle_proto.ts",
     "packages/firestore/src/protos/firestore_proto_api.ts",

packages/firestore/src/api/blob.ts

@@ -15,7 +15,9 @@
  * limitations under the License.
  */
 
-import { Bytes, Compat } from '../../exp/index';
+import { Compat } from '@firebase/util';
+
+import { Bytes } from '../../exp/index';
 import { isBase64Available } from '../platform/base64';
 import { Code, FirestoreError } from '../util/error';
 
@@ -40,7 +42,8 @@ function assertBase64Available(): void {
 }
 
 /** Immutable class holding a blob (binary data) */
-export class Blob extends Compat<Bytes> {
+export class Blob implements Compat<Bytes> {
+  constructor(readonly _delegate: Bytes) {}
   static fromBase64String(base64: string): Blob {
     assertBase64Available();
     return new Blob(Bytes.fromBase64String(base64));

packages/firestore/src/api/database.ts

@@ -44,6 +44,7 @@ import {
   WhereFilterOp as PublicWhereFilterOp,
   WriteBatch as PublicWriteBatch
 } from '@firebase/firestore-types';
+import { Compat, getModularInstance } from '@firebase/util';
 
 import {
   LoadBundleTask,
@@ -98,8 +99,7 @@ import {
   runTransaction,
   Transaction as ExpTransaction,
   WriteBatch as ExpWriteBatch,
-  AbstractUserDataWriter,
-  Compat
+  AbstractUserDataWriter
 } from '../../exp/index'; // import from the exp public API
 import { DatabaseId } from '../core/database_info';
 import { UntypedFirestoreDataConverter } from '../lite/user_data_reader';
@@ -195,16 +195,13 @@ export class IndexedDbPersistenceProvider implements PersistenceProvider {
  * to the functional API of firestore-exp.
  */
 export class Firestore
-  extends Compat<ExpFirebaseFirestore>
-  implements PublicFirestore, FirebaseService {
+  implements PublicFirestore, FirebaseService, Compat<ExpFirebaseFirestore> {
   _appCompat?: FirebaseApp;
   constructor(
     databaseIdOrApp: DatabaseId | FirebaseApp,
-    delegate: ExpFirebaseFirestore,
+    readonly _delegate: ExpFirebaseFirestore,
     private _persistenceProvider: PersistenceProvider
   ) {
-    super(delegate);
-
     if (!(databaseIdOrApp instanceof DatabaseId)) {
       this._appCompat = databaseIdOrApp as FirebaseApp;
     }
@@ -386,16 +383,13 @@ export function setLogLevel(level: PublicLogLevel): void {
 /**
  * A reference to a transaction.
  */
-export class Transaction
-  extends Compat<ExpTransaction>
-  implements PublicTransaction {
+export class Transaction implements PublicTransaction, Compat<ExpTransaction> {
   private _userDataWriter: UserDataWriter;
 
   constructor(
     private readonly _firestore: Firestore,
-    delegate: ExpTransaction
+    readonly _delegate: ExpTransaction
   ) {
-    super(delegate);
     this._userDataWriter = new UserDataWriter(_firestore);
   }
 
@@ -480,9 +474,8 @@ export class Transaction
   }
 }
 
-export class WriteBatch
-  extends Compat<ExpWriteBatch>
-  implements PublicWriteBatch {
+export class WriteBatch implements PublicWriteBatch, Compat<ExpWriteBatch> {
+  constructor(readonly _delegate: ExpWriteBatch) {}
   set<T>(
     documentRef: DocumentReference<T>,
     data: Partial<T>,
@@ -551,17 +544,16 @@ export class WriteBatch
  * them to the wrapped converter.
  */
 class FirestoreDataConverter<U>
-  extends Compat<PublicFirestoreDataConverter<U>>
-  implements UntypedFirestoreDataConverter<U> {
+  implements
+    UntypedFirestoreDataConverter<U>,
+    Compat<PublicFirestoreDataConverter<U>> {
   private static readonly INSTANCES = new WeakMap();
 
   private constructor(
     private readonly _firestore: Firestore,
     private readonly _userDataWriter: UserDataWriter,
-    delegate: PublicFirestoreDataConverter<U>
-  ) {
-    super(delegate);
-  }
+    readonly _delegate: PublicFirestoreDataConverter<U>
+  ) {}
 
   fromFirestore(
     snapshot: ExpQueryDocumentSnapshot,
@@ -629,15 +621,13 @@ class FirestoreDataConverter<U>
  * A reference to a particular document in a collection in the database.
  */
 export class DocumentReference<T = PublicDocumentData>
-  extends Compat<ExpDocumentReference<T>>
-  implements PublicDocumentReference<T> {
+  implements PublicDocumentReference<T>, Compat<ExpDocumentReference<T>> {
   private _userDataWriter: UserDataWriter;
 
   constructor(
     readonly firestore: Firestore,
-    delegate: ExpDocumentReference<T>
+    readonly _delegate: ExpDocumentReference<T>
   ) {
-    super(delegate);
     this._userDataWriter = new UserDataWriter(firestore);
   }
 
@@ -705,9 +695,7 @@ export class DocumentReference<T = PublicDocumentData>
   }
 
   isEqual(other: PublicDocumentReference<T>): boolean {
-    if (other instanceof Compat) {
-      other = other._delegate;
-    }
+    other = getModularInstance<PublicDocumentReference<T>>(other);
 
     if (!(other instanceof ExpDocumentReference)) {
       return false;
@@ -917,14 +905,11 @@ export function wrapObserver<CompatType, ExpType>(
 export interface SnapshotOptions extends PublicSnapshotOptions {}
 
 export class DocumentSnapshot<T = PublicDocumentData>
-  extends Compat<ExpDocumentSnapshot<T>>
-  implements PublicDocumentSnapshot<T> {
+  implements PublicDocumentSnapshot<T>, Compat<ExpDocumentSnapshot<T>> {
   constructor(
     private readonly _firestore: Firestore,
-    delegate: ExpDocumentSnapshot<T>
-  ) {
-    super(delegate);
-  }
+    readonly _delegate: ExpDocumentSnapshot<T>
+  ) {}
 
   get ref(): DocumentReference<T> {
     return new DocumentReference<T>(this._firestore, this._delegate.ref);
@@ -974,12 +959,10 @@ export class QueryDocumentSnapshot<T = PublicDocumentData>
 }
 
 export class Query<T = PublicDocumentData>
-  extends Compat<ExpQuery<T>>
-  implements PublicQuery<T> {
+  implements PublicQuery<T>, Compat<ExpQuery<T>> {
   private readonly _userDataWriter: UserDataWriter;
 
-  constructor(readonly firestore: Firestore, delegate: ExpQuery<T>) {
-    super(delegate);
+  constructor(readonly firestore: Firestore, readonly _delegate: ExpQuery<T>) {
     this._userDataWriter = new UserDataWriter(firestore);
   }
 
@@ -1154,14 +1137,11 @@ export class Query<T = PublicDocumentData>
 }
 
 export class DocumentChange<T = PublicDocumentData>
-  extends Compat<ExpDocumentChange<T>>
-  implements PublicDocumentChange<T> {
+  implements PublicDocumentChange<T>, Compat<ExpDocumentChange<T>> {
   constructor(
     private readonly _firestore: Firestore,
-    delegate: ExpDocumentChange<T>
-  ) {
-    super(delegate);
-  }
+    readonly _delegate: ExpDocumentChange<T>
+  ) {}
 
   get type(): PublicDocumentChangeType {
     return this._delegate.type;
@@ -1181,11 +1161,11 @@ export class DocumentChange<T = PublicDocumentData>
 }
 
 export class QuerySnapshot<T = PublicDocumentData>
-  extends Compat<ExpQuerySnapshot<T>>
-  implements PublicQuerySnapshot<T> {
-  constructor(readonly _firestore: Firestore, delegate: ExpQuerySnapshot<T>) {
-    super(delegate);
-  }
+  implements PublicQuerySnapshot<T>, Compat<ExpQuerySnapshot<T>> {
+  constructor(
+    readonly _firestore: Firestore,
+    readonly _delegate: ExpQuerySnapshot<T>
+  ) {}
 
   get query(): Query<T> {
     return new Query(this._firestore, this._delegate.query);
@@ -1306,8 +1286,5 @@ export class CollectionReference<T = PublicDocumentData>
 function castReference<T>(
   documentRef: PublicDocumentReference<T>
 ): ExpDocumentReference<T> {
-  if (documentRef instanceof Compat) {
-    documentRef = documentRef._delegate;
-  }
   return cast<ExpDocumentReference<T>>(documentRef, ExpDocumentReference);
 }

packages/firestore/src/api/field_path.ts

@@ -16,8 +16,9 @@
  */
 
 import { FieldPath as PublicFieldPath } from '@firebase/firestore-types';
+import { Compat, getModularInstance } from '@firebase/util';
 
-import { FieldPath as ExpFieldPath, Compat } from '../../exp/index';
+import { FieldPath as ExpFieldPath } from '../../exp/index';
 import { FieldPath as InternalFieldPath } from '../model/path';
 
 // The objects that are a part of this API are exposed to third-parties as
@@ -29,15 +30,16 @@ import { FieldPath as InternalFieldPath } from '../model/path';
  * single field name (referring to a top-level field in the document), or a list
  * of field names (referring to a nested field in the document).
  */
-export class FieldPath extends Compat<ExpFieldPath> implements PublicFieldPath {
+export class FieldPath implements PublicFieldPath, Compat<ExpFieldPath> {
+  readonly _delegate: ExpFieldPath;
   /**
    * Creates a FieldPath from the provided field names. If more than one field
    * name is provided, the path will point to a nested field in a document.
    *
    * @param fieldNames - A list of field names.
    */
   constructor(...fieldNames: string[]) {
-    super(new ExpFieldPath(...fieldNames));
+    this._delegate = new ExpFieldPath(...fieldNames);
   }
 
   static documentId(): FieldPath {
@@ -51,9 +53,7 @@ export class FieldPath extends Compat<ExpFieldPath> implements PublicFieldPath {
   }
 
   isEqual(other: PublicFieldPath): boolean {
-    if (other instanceof Compat) {
-      other = other._delegate;
-    }
+    other = getModularInstance(other);
 
     if (!(other instanceof ExpFieldPath)) {
       return false;

packages/firestore/src/api/field_value.ts

@@ -16,20 +16,18 @@
  */
 
 import { FieldValue as PublicFieldValue } from '@firebase/firestore-types';
+import { Compat } from '@firebase/util';
 
 import {
   arrayRemove,
   arrayUnion,
   deleteField,
   FieldValue as FieldValue1,
   increment,
-  serverTimestamp,
-  Compat
+  serverTimestamp
 } from '../../exp/index';
 
-export class FieldValue
-  extends Compat<FieldValue1>
-  implements PublicFieldValue {
+export class FieldValue implements PublicFieldValue, Compat<FieldValue1> {
   static serverTimestamp(): FieldValue {
     const delegate = serverTimestamp();
     delegate._methodName = 'FieldValue.serverTimestamp';
@@ -60,6 +58,8 @@ export class FieldValue
     return new FieldValue(delegate);
   }
 
+  constructor(readonly _delegate: FieldValue1) {}
+
   isEqual(other: FieldValue): boolean {
     return this._delegate.isEqual(other._delegate);
   }

packages/firestore/src/exp/reference_impl.ts

@@ -15,6 +15,8 @@
  * limitations under the License.
  */
 
+import { getModularInstance } from '@firebase/util';
+
 import {
   CompleteFn,
   ErrorFn,
@@ -34,7 +36,6 @@ import {
 import { newQueryForPath, Query as InternalQuery } from '../core/query';
 import { ViewSnapshot } from '../core/view_snapshot';
 import { Bytes } from '../lite/bytes';
-import { Compat } from '../lite/compat';
 import { FieldPath } from '../lite/field_path';
 import { validateHasExplicitOrderByForLimitToLast } from '../lite/query';
 import {
@@ -338,9 +339,7 @@ export function updateDoc(
 
   // For Compat types, we have to "extract" the underlying types before
   // performing validation.
-  if (fieldOrUpdateData instanceof Compat) {
-    fieldOrUpdateData = fieldOrUpdateData._delegate;
-  }
+  fieldOrUpdateData = getModularInstance(fieldOrUpdateData);
 
   let parsed: ParsedUpdateData;
   if (
@@ -622,9 +621,7 @@ export function onSnapshot<T>(
   reference: Query<T> | DocumentReference<T>,
   ...args: unknown[]
 ): Unsubscribe {
-  if (reference instanceof Compat) {
-    reference = reference._delegate;
-  }
+  reference = getModularInstance(reference);
 
   let options: SnapshotListenOptions = {
     includeMetadataChanges: false