Add Converter tests to Lite client (firebase#3199)

Author: schmidt-sebastian

packages/firestore/lite/src/api/reference.ts

@@ -303,6 +303,8 @@ export function collection(
   }
 }
 
+// TODO(firestorelite): Consider using ErrorFactory -
+// https://github.com/firebase/firebase-js-sdk/blob/0131e1f/packages/util/src/errors.ts#L106
 export function collectionGroup(
   firestore: firestore.FirebaseFirestore,
   collectionId: string
@@ -364,10 +366,10 @@ export function doc<T>(
 }
 
 export function parent(
-  reference: CollectionReference<unknown>
+  reference: firestore.CollectionReference<unknown>
 ): DocumentReference<firestore.DocumentData> | null;
 export function parent<T>(
-  reference: DocumentReference<T>
+  reference: firestore.DocumentReference<T>
 ): CollectionReference<T>;
 export function parent<T>(
   child: firestore.CollectionReference<unknown> | firestore.DocumentReference<T>

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

@@ -113,8 +113,8 @@ export class QueryDocumentSnapshot<T = firestore.DocumentData>
 export class QuerySnapshot<T = firestore.DocumentData>
   implements firestore.QuerySnapshot<T> {
   constructor(
-    public readonly query: firestore.Query<T>,
-    public readonly _docs: Array<QueryDocumentSnapshot<T>>
+    readonly query: firestore.Query<T>,
+    readonly _docs: Array<QueryDocumentSnapshot<T>>
   ) {}
 
   get docs(): Array<firestore.QueryDocumentSnapshot<T>> {

packages/firestore/lite/test/integration.test.ts

@@ -615,7 +615,6 @@ describe('DocumentSnapshot', () => {
   });
 });
 
-// TODO(firestorelite): Add converter tests
 describe('deleteDoc()', () => {
   it('can delete a non-existing document', () => {
     return withTestDoc(docRef => deleteDoc(docRef));
@@ -967,3 +966,83 @@ describe('equality', () => {
     );
   });
 });
+
+describe('withConverter() support', () => {
+  class Post {
+    constructor(readonly title: string, readonly author: string) {}
+    byline(): string {
+      return this.title + ', by ' + this.author;
+    }
+  }
+
+  const postConverter = {
+    toFirestore(post: Post): firestore.DocumentData {
+      return { title: post.title, author: post.author };
+    },
+    fromFirestore(snapshot: firestore.QueryDocumentSnapshot): Post {
+      const data = snapshot.data();
+      return new Post(data.title, data.author);
+    }
+  };
+
+  it('for DocumentReference.withConverter()', () => {
+    return withTestDoc(async docRef => {
+      docRef = docRef.withConverter(postConverter);
+      await setDoc(docRef, new Post('post', 'author'));
+      const postData = await getDoc(docRef);
+      const post = postData.data();
+      expect(post).to.not.equal(undefined);
+      expect(post!.byline()).to.equal('post, by author');
+    });
+  });
+
+  it('for CollectionReference.withConverter()', () => {
+    return withTestCollection(async coll => {
+      coll = coll.withConverter(postConverter);
+      const docRef = await addDoc(coll, new Post('post', 'author'));
+      const postData = await getDoc(docRef);
+      const post = postData.data();
+      expect(post).to.not.equal(undefined);
+      expect(post!.byline()).to.equal('post, by author');
+    });
+  });
+
+  it('for Query.withConverter()', () => {
+    return withTestCollection(async coll => {
+      coll = coll.withConverter(postConverter);
+      await setDoc(doc(coll, 'post1'), new Post('post1', 'author1'));
+      const posts = await getQuery(coll);
+      expect(posts.size).to.equal(1);
+      expect(posts.docs[0].data()!.byline()).to.equal('post1, by author1');
+    });
+  });
+
+  it('drops the converter when calling parent() with a CollectionReference', () => {
+    return withTestDb(async db => {
+      const coll = collection(db, 'root/doc/parent').withConverter(
+        postConverter
+      );
+      const untypedDoc = parent(coll)!;
+      expect(refEqual(untypedDoc, doc(db, 'root/doc'))).to.be.true;
+    });
+  });
+
+  it('checks converter when comparing with isEqual()', () => {
+    return withTestDb(async db => {
+      const postConverter2 = { ...postConverter };
+
+      const postsCollection = collection(db, 'users/user1/posts').withConverter(
+        postConverter
+      );
+      const postsCollection2 = collection(
+        db,
+        'users/user1/posts'
+      ).withConverter(postConverter2);
+      expect(refEqual(postsCollection, postsCollection2)).to.be.false;
+
+      const docRef = doc(db, 'some/doc').withConverter(postConverter);
+      const docRef2 = doc(db, 'some/doc').withConverter(postConverter2);
+      expect(refEqual(docRef, docRef2)).to.be.false;
+    });
+  });
+});

packages/firestore/src/api/user_data_reader.ts

@@ -63,9 +63,9 @@ export interface UntypedFirestoreDataConverter<T> {
  */
 export class DocumentKeyReference<T> {
   constructor(
-    public readonly _databaseId: DatabaseId,
-    public readonly _key: DocumentKey,
-    public readonly _converter: UntypedFirestoreDataConverter<T> | null
+    readonly _databaseId: DatabaseId,
+    readonly _key: DocumentKey,
+    readonly _converter: UntypedFirestoreDataConverter<T> | null
   ) {}
 }
 

packages/firestore/src/model/object_value.ts

@@ -49,7 +49,7 @@ export const enum TypeOrder {
  * ability to add and remove fields (via the ObjectValueBuilder).
  */
 export class ObjectValue {
-  constructor(public readonly proto: { mapValue: api.MapValue }) {
+  constructor(readonly proto: { mapValue: api.MapValue }) {
     debugAssert(
       !isServerTimestamp(proto),
       'ServerTimestamps should be converted to ServerTimestampValue'

packages/firestore/src/remote/datastore.ts

@@ -52,9 +52,9 @@ class DatastoreImpl extends Datastore {
   terminated = false;
 
   constructor(
-    public readonly connection: Connection,
-    public readonly credentials: CredentialsProvider,
-    public readonly serializer: JsonProtoSerializer
+    readonly connection: Connection,
+    readonly credentials: CredentialsProvider,
+    readonly serializer: JsonProtoSerializer
   ) {
     super();
   }