test(firestore): serverTimestamps integration + unit tests

Author: russellwheatley

packages/firestore/__tests__/firestore.test.ts

@@ -1314,6 +1314,90 @@ describe('Firestore', function () {
       );
     });
 
+    it('FirestoreDocumentSnapshot.data() respects SnapshotOptions.serverTimestamps', function () {
+      const firestore = getFirestore();
+      const snapshot = new FirestoreDocumentSnapshot(
+        // @ts-expect-error calling a private constructor directly which expects FirestoreInternal type
+        firestore,
+        {
+          data: { createdAt: [3] },
+          dataEstimate: { createdAt: [13, [123, 456]] },
+          dataPrevious: { createdAt: [13, [42, 0]] },
+          dataNone: { createdAt: [3] },
+          metadata: [false, true],
+          path: 'foo/bar',
+          exists: true,
+        },
+        null,
+      );
+
+      expect(snapshot.data()).toEqual({ createdAt: null });
+      expect(snapshot.data({ serverTimestamps: 'estimate' })?.createdAt).toBeInstanceOf(Timestamp);
+      expect(snapshot.data({ serverTimestamps: 'estimate' })?.createdAt).toMatchObject({
+        seconds: 123,
+        nanoseconds: 456,
+      });
+      expect(snapshot.data({ serverTimestamps: 'previous' })?.createdAt).toMatchObject({
+        seconds: 42,
+        nanoseconds: 0,
+      });
+      expect(snapshot.data({ serverTimestamps: 'none' })).toEqual({ createdAt: null });
+    });
+
+    it('FirestoreDocumentSnapshot.get() respects SnapshotOptions.serverTimestamps', function () {
+      const firestore = getFirestore();
+      const snapshot = new FirestoreDocumentSnapshot(
+        // @ts-expect-error calling a private constructor directly which expects FirestoreInternal type
+        firestore,
+        {
+          data: { nested: [16, { createdAt: [3] }] },
+          dataEstimate: { nested: [16, { createdAt: [13, [123, 456]] }] },
+          dataPrevious: { nested: [16, { createdAt: [13, [42, 0]] }] },
+          dataNone: { nested: [16, { createdAt: [3] }] },
+          metadata: [false, true],
+          path: 'foo/bar',
+          exists: true,
+        },
+        null,
+      );
+
+      expect(snapshot.get('nested.createdAt')).toBeNull();
+      expect(snapshot.get('nested.createdAt', { serverTimestamps: 'estimate' })).toMatchObject({
+        seconds: 123,
+        nanoseconds: 456,
+      });
+      expect(snapshot.get('nested.createdAt', { serverTimestamps: 'previous' })).toMatchObject({
+        seconds: 42,
+        nanoseconds: 0,
+      });
+      expect(snapshot.get('nested.createdAt', { serverTimestamps: 'none' })).toBeNull();
+    });
+
+    it('FirestoreDocumentSnapshot.data() passes SnapshotOptions through converter snapshots', function () {
+      const firestore = getFirestore();
+      const snapshot = new FirestoreDocumentSnapshot(
+        // @ts-expect-error calling a private constructor directly which expects FirestoreInternal type
+        firestore,
+        {
+          data: { createdAt: [3] },
+          dataEstimate: { createdAt: [13, [123, 456]] },
+          metadata: [false, true],
+          path: 'foo/bar',
+          exists: true,
+        },
+        {
+          toFirestore: data => data,
+          fromFirestore: converterSnapshot =>
+            converterSnapshot.data({ serverTimestamps: 'estimate' }),
+        },
+      );
+
+      expect(snapshot.data()?.createdAt).toMatchObject({
+        seconds: 123,
+        nanoseconds: 456,
+      });
+    });
+
     describe('FieldValue', function () {
       it('FieldValue.delete()', function () {
         const fieldValue = firestore.FieldValue;

packages/firestore/consumer-type-test.ts

@@ -348,9 +348,12 @@ nsQuery.get().then((snap: FirebaseFirestoreTypes.QuerySnapshot) => {
 nsDocRef.get().then((snap: FirebaseFirestoreTypes.DocumentSnapshot) => {
   if (snap.exists()) {
     const d = snap.data();
+    const estimate = snap.data({ serverTimestamps: 'estimate' });
     void d;
+    void estimate;
   }
   void snap.get('field');
+  void snap.get('field', { serverTimestamps: 'previous' });
   void snap.metadata.isEqual(snap.metadata);
 });
 
@@ -638,6 +641,8 @@ getAggregateFromServer(modQuery1, aggSpec).then(
 
 // ----- getDoc, getDocFromCache, getDocFromServer -----
 getDoc(modDoc).then(snap => snap.data());
+getDoc(modDoc).then(snap => snap.data({ serverTimestamps: 'estimate' }));
+getDoc(modDoc).then(snap => snap.get('field', { serverTimestamps: 'previous' }));
 getDocFromCache(modDoc).then(snap => snap.data());
 getDocFromServer(modDoc).then(snap => snap.data());
 

packages/firestore/e2e/withConverter.e2e.js

@@ -25,11 +25,14 @@ const {
   addDoc,
   setDoc,
   getDoc,
+  onSnapshot,
   query,
   where,
   getDocs,
   writeBatch,
   increment,
+  serverTimestamp,
+  Timestamp,
   initializeFirestore,
 } = firestoreModular;
 
@@ -590,6 +593,52 @@ describe('firestore.withConverter', function () {
       });
     });
 
+    it("passes data() serverTimestamps options through converter snapshots", function () {
+      const timestampConverter = {
+        toFirestore() {
+          return {
+            createdAt: serverTimestamp(),
+            updatedAt: serverTimestamp(),
+          };
+        },
+        fromFirestore(snapshot) {
+          return snapshot.data({ serverTimestamps: 'estimate' });
+        },
+      };
+
+      return withTestCollection(async coll => {
+        const ref = doc(coll, 'timestampConverter').withConverter(timestampConverter);
+        await new Promise((resolve, reject) => {
+          const unsubscribe = onSnapshot(
+            ref,
+            { includeMetadataChanges: true },
+            snapshot => {
+              try {
+                if (!snapshot.exists() || !snapshot.metadata.hasPendingWrites) {
+                  return;
+                }
+
+                const data = snapshot.data();
+                data.createdAt.should.be.an.instanceOf(Timestamp);
+                data.updatedAt.should.be.an.instanceOf(Timestamp);
+                unsubscribe();
+                resolve();
+              } catch (error) {
+                unsubscribe();
+                reject(error);
+              }
+            },
+            reject,
+          );
+
+          setDoc(ref, {}).catch(error => {
+            unsubscribe();
+            reject(error);
+          });
+        });
+      });
+    });
+
     it('supports partials with merge', async function () {
       return withTestCollection(async coll => {
         const ref = doc(coll, 'post').withConverter(postConverterMerge);

packages/firestore/type-test.ts

@@ -342,9 +342,12 @@ nsQuery.get().then((snap: FirebaseFirestoreTypes.QuerySnapshot) => {
 nsDocRef.get().then((snap: FirebaseFirestoreTypes.DocumentSnapshot) => {
   if (snap.exists()) {
     const d = snap.data();
+    const estimate = snap.data({ serverTimestamps: 'estimate' });
     console.log(d);
+    console.log(estimate);
   }
   console.log(snap.get('field'));
+  console.log(snap.get('field', { serverTimestamps: 'previous' }));
   console.log(snap.metadata.isEqual(snap.metadata));
 });
 
@@ -642,6 +645,8 @@ getAggregateFromServer(modQuery1, aggSpec).then(
 
 // ----- getDoc, getDocFromCache, getDocFromServer -----
 getDoc(modDoc).then(snap => snap.data());
+getDoc(modDoc).then(snap => snap.data({ serverTimestamps: 'estimate' }));
+getDoc(modDoc).then(snap => snap.get('field', { serverTimestamps: 'previous' }));
 getDocFromCache(modDoc).then(snap => snap.data());
 getDocFromServer(modDoc).then(snap => snap.data());