Remove timestampInSnapshots Setting

firebase-firestore/CHANGELOG.md

@@ -1,4 +1,7 @@
-# Unreleased
+# Unreleased (22.0.0)
+- [changed] Removed the deprecated `timestampsInSnapshotsEnabled` setting.
+  Any timestamps in Firestore documents are now returned as `Timestamps`. To
+  convert `Timestamp` classed to `java.util.Date`, use `Timestamp.toDate()`.
 
 # 21.6.1
 - [changed] Added new internal HTTP headers to the gRPC connection.

firebase-firestore/api.txt

@@ -184,7 +184,6 @@ package com.google.firebase.firestore {
   }
 
   public final class FirebaseFirestoreSettings {
-    method public boolean areTimestampsInSnapshotsEnabled();
     method public long getCacheSizeBytes();
     method @NonNull public String getHost();
     method public boolean isPersistenceEnabled();
@@ -204,7 +203,6 @@ package com.google.firebase.firestore {
     method @NonNull public com.google.firebase.firestore.FirebaseFirestoreSettings.Builder setHost(@NonNull String);
     method @NonNull public com.google.firebase.firestore.FirebaseFirestoreSettings.Builder setPersistenceEnabled(boolean);
     method @NonNull public com.google.firebase.firestore.FirebaseFirestoreSettings.Builder setSslEnabled(boolean);
-    method @Deprecated @NonNull public com.google.firebase.firestore.FirebaseFirestoreSettings.Builder setTimestampsInSnapshotsEnabled(boolean);
   }
 
   public class GeoPoint implements java.lang.Comparable<com.google.firebase.firestore.GeoPoint> {

firebase-firestore/src/androidTest/java/com/google/firebase/firestore/FieldsTest.java

@@ -15,25 +15,20 @@
 package com.google.firebase.firestore;
 
 import static com.google.common.truth.Truth.assertThat;
-import static com.google.firebase.firestore.testutil.IntegrationTestUtil.newTestSettingsWithSnapshotTimestampsEnabled;
 import static com.google.firebase.firestore.testutil.IntegrationTestUtil.querySnapshotToValues;
 import static com.google.firebase.firestore.testutil.IntegrationTestUtil.testCollection;
-import static com.google.firebase.firestore.testutil.IntegrationTestUtil.testFirestore;
 import static com.google.firebase.firestore.testutil.IntegrationTestUtil.waitFor;
 import static com.google.firebase.firestore.testutil.TestUtil.map;
-import static com.google.firebase.firestore.util.Util.autoId;
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertNull;
 
 import androidx.test.ext.junit.runners.AndroidJUnit4;
 import com.google.android.gms.tasks.Task;
 import com.google.android.gms.tasks.Tasks;
 import com.google.firebase.Timestamp;
-import com.google.firebase.firestore.DocumentSnapshot.ServerTimestampBehavior;
 import com.google.firebase.firestore.testutil.IntegrationTestUtil;
 import java.util.ArrayList;
 import java.util.Arrays;
-import java.util.Date;
 import java.util.List;
 import java.util.Map;
 import org.junit.After;
@@ -218,7 +213,7 @@ private static Map<String, Object> objectWithTimestamp(Timestamp timestamp) {
   }
 
   @Test
-  public void testTimestampsInSnapshots() {
+  public void testTimestampsAreTruncated() {
     Timestamp originalTimestamp = new Timestamp(100, 123456789);
     // Timestamps are currently truncated to microseconds after being written to the database.
     Timestamp truncatedTimestamp =
@@ -240,42 +235,4 @@ public void testTimestampsInSnapshots() {
     Map<String, Object> nestedObject = (Map<String, Object>) data.get("nested");
     assertThat(nestedObject.get("timestamp2")).isEqualTo(readNestedTimestamp);
   }
-
-  private static DocumentReference createDocWithTimestampsDisabled() {
-    FirebaseFirestoreSettings settings = newTestSettingsWithSnapshotTimestampsEnabled(false);
-    return testFirestore(settings).collection(autoId()).document();
-  }
-
-  @Test
-  public void testTimestampsInSnapshotsLegacyBehaviorForTimestamps() {
-    Timestamp timestamp = new Timestamp(100, 123456789);
-
-    DocumentReference docRef = createDocWithTimestampsDisabled();
-    waitFor(docRef.set(objectWithTimestamp(timestamp)));
-    DocumentSnapshot snapshot = waitFor(docRef.get());
-    Map<String, Object> data = snapshot.getData();
-
-    assertThat(snapshot.get("timestamp")).isInstanceOf(Date.class);
-    assertThat(data.get("timestamp")).isInstanceOf(Date.class);
-    assertThat(snapshot.get("timestamp")).isEqualTo(timestamp.toDate());
-    assertThat(data.get("timestamp")).isEqualTo(timestamp.toDate());
-
-    assertThat(snapshot.get("nested.timestamp2")).isInstanceOf(Date.class);
-    assertThat(snapshot.get("nested.timestamp2")).isEqualTo(timestamp.toDate());
-    @SuppressWarnings("unchecked")
-    Map<String, Object> nestedObject = (Map<String, Object>) data.get("nested");
-    assertThat(nestedObject).isNotNull();
-    assertThat(nestedObject.get("timestamp2")).isEqualTo(timestamp.toDate());
-  }
-
-  @Test
-  public void testTimestampsInSnapshotsLegacyBehaviorForServerTimestamps() {
-    DocumentReference docRef = createDocWithTimestampsDisabled();
-    waitFor(docRef.set(map("timestamp", FieldValue.serverTimestamp())));
-    DocumentSnapshot snapshot = waitFor(docRef.get());
-    assertThat(snapshot.get("timestamp", ServerTimestampBehavior.ESTIMATE))
-        .isInstanceOf(Date.class);
-    assertThat(snapshot.getData(ServerTimestampBehavior.ESTIMATE).get("timestamp"))
-        .isInstanceOf(Date.class);
-  }
 }

firebase-firestore/src/androidTest/java/com/google/firebase/firestore/testutil/IntegrationTestUtil.java

@@ -139,12 +139,6 @@ public static DatabaseInfo testEnvDatabaseInfo() {
   }
 
   public static FirebaseFirestoreSettings newTestSettings() {
-    return newTestSettingsWithSnapshotTimestampsEnabled(true);
-  }
-
-  @SuppressWarnings("deprecation") // for setTimestampsInSnapshotsEnabled()
-  public static FirebaseFirestoreSettings newTestSettingsWithSnapshotTimestampsEnabled(
-      boolean enabled) {
     FirebaseFirestoreSettings.Builder settings = new FirebaseFirestoreSettings.Builder();
 
     if (CONNECT_TO_EMULATOR) {
@@ -155,7 +149,6 @@ public static FirebaseFirestoreSettings newTestSettingsWithSnapshotTimestampsEna
     }
 
     settings.setPersistenceEnabled(true);
-    settings.setTimestampsInSnapshotsEnabled(enabled);
 
     return settings.build();
   }

firebase-firestore/src/main/java/com/google/firebase/firestore/DocumentSnapshot.java

@@ -144,11 +144,7 @@ public Map<String, Object> getData() {
   public Map<String, Object> getData(@NonNull ServerTimestampBehavior serverTimestampBehavior) {
     checkNotNull(
         serverTimestampBehavior, "Provided serverTimestampBehavior value must not be null.");
-    UserDataWriter userDataWriter =
-        new UserDataWriter(
-            firestore,
-            firestore.getFirestoreSettings().areTimestampsInSnapshotsEnabled(),
-            serverTimestampBehavior);
+    UserDataWriter userDataWriter = new UserDataWriter(firestore, serverTimestampBehavior);
     return doc == null ? null : userDataWriter.convertObject(doc.getData().getFieldsMap());
   }
 
@@ -260,10 +256,7 @@ public Object get(
     checkNotNull(fieldPath, "Provided field path must not be null.");
     checkNotNull(
         serverTimestampBehavior, "Provided serverTimestampBehavior value must not be null.");
-    return getInternal(
-        fieldPath.getInternalPath(),
-        serverTimestampBehavior,
-        firestore.getFirestoreSettings().areTimestampsInSnapshotsEnabled());
+    return getInternal(fieldPath.getInternalPath(), serverTimestampBehavior);
   }
 
   /**
@@ -396,9 +389,6 @@ public Date getDate(@NonNull String field) {
   /**
    * Returns the value of the field as a Date.
    *
-   * <p>This method ignores the global setting {@link
-   * FirebaseFirestoreSettings#areTimestampsInSnapshotsEnabled}.
-   *
    * @param field The path to the field.
    * @param serverTimestampBehavior Configures the behavior for server timestamps that have not yet
    *     been set to their final value.
@@ -411,20 +401,13 @@ public Date getDate(
     checkNotNull(field, "Provided field path must not be null.");
     checkNotNull(
         serverTimestampBehavior, "Provided serverTimestampBehavior value must not be null.");
-    Object maybeDate =
-        getInternal(
-            FieldPath.fromDotSeparatedPath(field).getInternalPath(),
-            serverTimestampBehavior,
-            /* timestampsInSnapshots= */ false);
-    return castTypedValue(maybeDate, field, Date.class);
+    @Nullable Timestamp timestamp = getTimestamp(field, serverTimestampBehavior);
+    return timestamp != null ? timestamp.toDate() : null;
   }
 
   /**
    * Returns the value of the field as a {@code com.google.firebase.Timestamp}.
    *
-   * <p>This method ignores the global setting {@link
-   * FirebaseFirestoreSettings#areTimestampsInSnapshotsEnabled}.
-   *
    * @param field The path to the field.
    * @throws RuntimeException if this is not a timestamp field.
    * @return The value of the field
@@ -437,9 +420,6 @@ public Timestamp getTimestamp(@NonNull String field) {
   /**
    * Returns the value of the field as a {@code com.google.firebase.Timestamp}.
    *
-   * <p>This method ignores the global setting {@link
-   * FirebaseFirestoreSettings#areTimestampsInSnapshotsEnabled}.
-   *
    * @param field The path to the field.
    * @param serverTimestampBehavior Configures the behavior for server timestamps that have not yet
    *     been set to their final value.
@@ -454,9 +434,7 @@ public Timestamp getTimestamp(
         serverTimestampBehavior, "Provided serverTimestampBehavior value must not be null.");
     Object maybeTimestamp =
         getInternal(
-            FieldPath.fromDotSeparatedPath(field).getInternalPath(),
-            serverTimestampBehavior,
-            /* timestampsInSnapshots= */ true);
+            FieldPath.fromDotSeparatedPath(field).getInternalPath(), serverTimestampBehavior);
     return castTypedValue(maybeTimestamp, field, Timestamp.class);
   }
 
@@ -526,13 +504,11 @@ private <T> T castTypedValue(Object value, String field, Class<T> clazz) {
   @Nullable
   private Object getInternal(
       @NonNull com.google.firebase.firestore.model.FieldPath fieldPath,
-      @NonNull ServerTimestampBehavior serverTimestampBehavior,
-      boolean timestampsInSnapshots) {
+      @NonNull ServerTimestampBehavior serverTimestampBehavior) {
     if (doc != null) {
       Value val = doc.getField(fieldPath);
       if (val != null) {
-        UserDataWriter userDataWriter =
-            new UserDataWriter(firestore, timestampsInSnapshots, serverTimestampBehavior);
+        UserDataWriter userDataWriter = new UserDataWriter(firestore, serverTimestampBehavior);
         return userDataWriter.convertValue(val);
       }
     }

firebase-firestore/src/main/java/com/google/firebase/firestore/FirebaseFirestoreSettings.java

@@ -32,22 +32,19 @@ public final class FirebaseFirestoreSettings {
 
   private static final long MINIMUM_CACHE_BYTES = 1 * 1024 * 1024; // 1 MB
   private static final long DEFAULT_CACHE_SIZE_BYTES = 100 * 1024 * 1024; // 100 MB
-  private static final boolean DEFAULT_TIMESTAMPS_IN_SNAPSHOTS_ENABLED = true;
 
   /** A Builder for creating {@code FirebaseFirestoreSettings}. */
   public static final class Builder {
     private String host;
     private boolean sslEnabled;
     private boolean persistenceEnabled;
-    private boolean timestampsInSnapshotsEnabled;
     private long cacheSizeBytes;
 
     /** Constructs a new {@code FirebaseFirestoreSettings} Builder object. */
     public Builder() {
       host = DEFAULT_HOST;
       sslEnabled = true;
       persistenceEnabled = true;
-      timestampsInSnapshotsEnabled = DEFAULT_TIMESTAMPS_IN_SNAPSHOTS_ENABLED;
       cacheSizeBytes = DEFAULT_CACHE_SIZE_BYTES;
     }
 
@@ -60,7 +57,6 @@ public Builder(@NonNull FirebaseFirestoreSettings settings) {
       host = settings.host;
       sslEnabled = settings.sslEnabled;
       persistenceEnabled = settings.persistenceEnabled;
-      timestampsInSnapshotsEnabled = settings.timestampsInSnapshotsEnabled;
     }
 
     /**
@@ -98,33 +94,6 @@ public Builder setPersistenceEnabled(boolean value) {
       return this;
     }
 
-    /**
-     * Specifies whether to use {@link com.google.firebase.Timestamp Timestamps} for timestamp
-     * fields in {@link DocumentSnapshot DocumentSnapshots}. This is now enabled by default and
-     * should not be disabled.
-     *
-     * <p>Previously, Cloud Firestore returned timestamp fields as {@link java.util.Date} but {@link
-     * java.util.Date} only supports millisecond precision, which leads to truncation and causes
-     * unexpected behavior when using a timestamp from a snapshot as a part of a subsequent query.
-     *
-     * <p>So now Cloud Firestore returns {@link com.google.firebase.Timestamp Timestamp} values
-     * instead of {@link java.util.Date}, avoiding this kind of problem.
-     *
-     * <p>To opt into the old behavior of returning {@link java.util.Date Dates}, you can
-     * temporarily set {@link FirebaseFirestoreSettings#areTimestampsInSnapshotsEnabled} to false.
-     *
-     * @deprecated This setting now defaults to true and will be removed in a future release. If you
-     *     are already setting it to true, just remove the setting. If you are setting it to false,
-     *     you should update your code to expect {@link com.google.firebase.Timestamp Timestamps}
-     *     instead of {@link java.util.Date Dates} and then remove the setting.
-     */
-    @NonNull
-    @Deprecated
-    public Builder setTimestampsInSnapshotsEnabled(boolean value) {
-      this.timestampsInSnapshotsEnabled = value;
-      return this;
-    }
-
     /**
      * Sets an approximate cache size threshold for the on-disk data. If the cache grows beyond this
      * size, Cloud Firestore will start removing data that hasn't been recently used. The size is
@@ -180,15 +149,13 @@ public FirebaseFirestoreSettings build() {
   private final String host;
   private final boolean sslEnabled;
   private final boolean persistenceEnabled;
-  private final boolean timestampsInSnapshotsEnabled;
   private final long cacheSizeBytes;
 
   /** Constructs a {@code FirebaseFirestoreSettings} object based on the values in the Builder. */
   private FirebaseFirestoreSettings(Builder builder) {
     host = builder.host;
     sslEnabled = builder.sslEnabled;
     persistenceEnabled = builder.persistenceEnabled;
-    timestampsInSnapshotsEnabled = builder.timestampsInSnapshotsEnabled;
     cacheSizeBytes = builder.cacheSizeBytes;
   }
 
@@ -205,7 +172,6 @@ public boolean equals(@Nullable Object o) {
     return host.equals(that.host)
         && sslEnabled == that.sslEnabled
         && persistenceEnabled == that.persistenceEnabled
-        && timestampsInSnapshotsEnabled == that.timestampsInSnapshotsEnabled
         && cacheSizeBytes == that.cacheSizeBytes;
   }
 
@@ -214,7 +180,6 @@ public int hashCode() {
     int result = host.hashCode();
     result = 31 * result + (sslEnabled ? 1 : 0);
     result = 31 * result + (persistenceEnabled ? 1 : 0);
-    result = 31 * result + (timestampsInSnapshotsEnabled ? 1 : 0);
     result = 31 * result + (int) cacheSizeBytes;
     return result;
   }
@@ -229,8 +194,6 @@ public String toString() {
         + sslEnabled
         + ", persistenceEnabled="
         + persistenceEnabled
-        + ", timestampsInSnapshotsEnabled="
-        + timestampsInSnapshotsEnabled
         + ", cacheSizeBytes="
         + cacheSizeBytes
         + "}";
@@ -252,14 +215,6 @@ public boolean isPersistenceEnabled() {
     return persistenceEnabled;
   }
 
-  /**
-   * Returns whether or not {@link DocumentSnapshot DocumentSnapshots} return timestamp fields as
-   * {@link com.google.firebase.Timestamp Timestamps}.
-   */
-  public boolean areTimestampsInSnapshotsEnabled() {
-    return timestampsInSnapshotsEnabled;
-  }
-
   /**
    * Returns the threshold for the cache size above which the SDK will attempt to collect the least
    * recently used documents.

firebase-firestore/src/main/java/com/google/firebase/firestore/UserDataWriter.java

@@ -50,15 +50,12 @@
 @RestrictTo(RestrictTo.Scope.LIBRARY_GROUP)
 public class UserDataWriter {
   private final FirebaseFirestore firestore;
-  private final boolean timestampsInSnapshots;
   private final DocumentSnapshot.ServerTimestampBehavior serverTimestampBehavior;
 
   UserDataWriter(
       FirebaseFirestore firestore,
-      boolean timestampsInSnapshots,
       DocumentSnapshot.ServerTimestampBehavior serverTimestampBehavior) {
     this.firestore = firestore;
-    this.timestampsInSnapshots = timestampsInSnapshots;
     this.serverTimestampBehavior = serverTimestampBehavior;
   }
 
@@ -118,12 +115,7 @@ private Object convertServerTimestamp(Value serverTimestampValue) {
   }
 
   private Object convertTimestamp(com.google.protobuf.Timestamp value) {
-    Timestamp timestamp = new Timestamp(value.getSeconds(), value.getNanos());
-    if (timestampsInSnapshots) {
-      return timestamp;
-    } else {
-      return timestamp.toDate();
-    }
+    return new Timestamp(value.getSeconds(), value.getNanos());
   }
 
   private List<Object> convertArray(ArrayValue arrayValue) {

firebase-firestore/src/test/java/com/google/firebase/firestore/UserDataWriterTest.java

@@ -48,8 +48,7 @@
 public class UserDataWriterTest {
 
   private final UserDataWriter writer =
-      new UserDataWriter(
-          TestUtil.firestore(), true, DocumentSnapshot.ServerTimestampBehavior.DEFAULT);
+      new UserDataWriter(TestUtil.firestore(), DocumentSnapshot.ServerTimestampBehavior.DEFAULT);
 
   @Test
   public void testConvertsNullValue() {
@@ -156,16 +155,14 @@ public void testConvertsDoubleValue() {
   @Test
   public void testConvertsDateValue() {
     UserDataWriter dateWriter =
-        new UserDataWriter(
-            TestUtil.firestore(),
-            /* timestampsInSnapshots= */ false,
-            DocumentSnapshot.ServerTimestampBehavior.DEFAULT);
+        new UserDataWriter(TestUtil.firestore(), DocumentSnapshot.ServerTimestampBehavior.DEFAULT);
     List<Date> testCases = asList(new Date(0), new Date(1356048000000L));
     for (Date d : testCases) {
       Value value = wrap(d);
       assertValueType(Value.ValueTypeCase.TIMESTAMP_VALUE, value);
       Object convertedValue = dateWriter.convertValue(value);
-      assertEquals(d, convertedValue);
+      assertTrue(convertedValue instanceof Timestamp);
+      assertEquals(d, ((Timestamp) convertedValue).toDate());
     }
   }