chore!: remove deprecated FirestoreOptions#setTimestampsInSnapshotsEnabled (#308)

Author: BenWhitehead

google-cloud-firestore/clirr-ignored-differences.xml

@@ -17,7 +17,6 @@
 
 <!-- see http://www.mojohaus.org/clirr-maven-plugin/examples/ignored-differences.html -->
 <differences>
-
  <!-- v2.0.0 -->
  <difference>
  <differenceType>7002</differenceType>
@@ -29,6 +28,11 @@
  <className>com/google/cloud/firestore/Firestore</className>
  <method>java.lang.Iterable getCollections()</method>
  </difference>
+ <difference>
+ <differenceType>7002</differenceType>
+ <className>com/google/cloud/firestore/FirestoreOptions$Builder</className>
+ <method>com.google.cloud.firestore.FirestoreOptions$Builder setTimestampsInSnapshotsEnabled(boolean)</method>
+ </difference>
 
  <!--
  createIndex -> createIndexAsync

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

@@ -215,7 +215,6 @@ public Map<String, Object> getData() {
  Map<String, Object> decodedFields = new HashMap<>();
  for (Map.Entry<String, Value> entry : fields.entrySet()) {
  Object decodedValue = decodeValue(entry.getValue());
- decodedValue = convertToDateIfNecessary(decodedValue);
  decodedFields.put(entry.getKey(), decodedValue);
  }
  return decodedFields;
@@ -294,8 +293,7 @@ public Object get(@Nonnull FieldPath fieldPath) {
  return null;
  }
 
- Object decodedValue = decodeValue(value);
- return convertToDateIfNecessary(decodedValue);
+ return decodeValue(value);
  }
 
  /**
@@ -312,15 +310,6 @@ public <T> T get(@Nonnull FieldPath fieldPath, Class<T> valueType) {
  return data == null ? null : CustomClassMapper.convertToCustomClass(data, valueType, docRef);
  }
 
- private Object convertToDateIfNecessary(Object decodedValue) {
- if (decodedValue instanceof Timestamp) {
- if (!this.rpcContext.areTimestampsInSnapshotsEnabled()) {
- decodedValue = ((Timestamp) decodedValue).toDate();
- }
- }
- return decodedValue;
- }
-
  /** Returns the Value Proto at 'fieldPath'. Returns null if the field was not found. */
  @Nullable
  Value extractField(@Nonnull FieldPath fieldPath) {
@@ -394,9 +383,6 @@ public Long getLong(@Nonnull String field) {
  /**
  * Returns the value of the field as a Date.
  *
- * <p>This method ignores the global setting {@link
- * FirestoreOptions#areTimestampsInSnapshotsEnabled}.
- *
  * @param field The path to the field.
  * @throws RuntimeException if the value is not a Date.
  * @return The value of the field.
@@ -409,9 +395,6 @@ public Date getDate(@Nonnull String field) {
  /**
  * Returns the value of the field as a {@link Timestamp}.
  *
- * <p>This method ignores the global setting {@link
- * FirestoreOptions#areTimestampsInSnapshotsEnabled}.
- *
  * @param field The path to the field.
  * @throws RuntimeException if the value is not a Date.
  * @return The value of the field.

google-cloud-firestore/src/main/java/com/google/cloud/firestore/FirestoreImpl.java

@@ -310,12 +310,6 @@ public <T> ApiFuture<T> runAsyncTransaction(
  return transactionRunner.run();
  }
 
- /** Returns whether the user has opted into receiving dates as com.google.cloud.Timestamp. */
- @Override
- public boolean areTimestampsInSnapshotsEnabled() {
- return this.firestoreOptions.areTimestampsInSnapshotsEnabled();
- }
-
  /** Returns the name of the Firestore project associated with this client. */
  @Override
  public String getDatabaseName() {

google-cloud-firestore/src/main/java/com/google/cloud/firestore/FirestoreOptions.java

@@ -189,33 +189,6 @@ public Builder setDatabaseId(@Nonnull String databaseId) {
  return this;
  }
 
- /**
- * Specifies whether to use {@link com.google.cloud.Timestamp Timestamps} for timestamp fields
- * in {@link DocumentSnapshot DocumentSnapshots}. This is now enabled by default and should not
- * be disabled.
- *
- * <p>Previously, 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 Firestore returns {@link com.google.cloud.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 FirestoreOptions#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.cloud.Timestamp Timestamps}
- * instead of {@link java.util.Date Dates} and then remove the setting.
- */
- @Deprecated
- @Nonnull
- public Builder setTimestampsInSnapshotsEnabled(boolean value) {
- this.timestampsInSnapshotsEnabled = value;
- return this;
- }
-
  @Override
  @Nonnull
  public FirestoreOptions build() {

google-cloud-firestore/src/main/java/com/google/cloud/firestore/FirestoreRpcContext.java

@@ -31,8 +31,6 @@ interface FirestoreRpcContext<FS extends Firestore> {
 
  FS getFirestore();
 
- boolean areTimestampsInSnapshotsEnabled();
-
  String getDatabaseName();
 
  ResourcePath getResourcePath();

google-cloud-firestore/src/test/java/com/google/cloud/firestore/DocumentReferenceTest.java

@@ -211,8 +211,6 @@ public void deserializeBasicTypes() throws Exception {
  streamObserverCapture.capture(),
  Matchers.<ServerStreamingCallable>any());
 
- doReturn(true).when(firestoreMock).areTimestampsInSnapshotsEnabled();
-
  DocumentSnapshot snapshot = documentReference.get().get();
  assertEquals(snapshot.getData(), ALL_SUPPORTED_TYPES_MAP);
 
@@ -299,15 +297,6 @@ public void deserializesDates() throws Exception {
 
  DocumentSnapshot snapshot = documentReference.get().get();
 
- doReturn(false).when(firestoreMock).areTimestampsInSnapshotsEnabled();
-
- assertEquals(DATE, snapshot.get("dateValue"));
- assertEquals(TIMESTAMP.toDate(), snapshot.get("timestampValue"));
- assertEquals(DATE, snapshot.getData().get("dateValue"));
- assertEquals(TIMESTAMP.toDate(), snapshot.getData().get("timestampValue"));
-
- doReturn(true).when(firestoreMock).areTimestampsInSnapshotsEnabled();
-
  assertEquals(Timestamp.of(DATE), snapshot.get("dateValue"));
  assertEquals(TIMESTAMP, snapshot.get("timestampValue"));
  assertEquals(Timestamp.of(DATE), snapshot.getData().get("dateValue"));