java records, using field annotations

Author: eranl

firebase-firestore-sdk34/src/main/java/com/google/firebase/firestore/sdk34/DocumentId.java

@@ -92,13 +92,13 @@ public record NestedRecord(
 
   public record ServerTimestamp (
 
-    @com.google.firebase.firestore.sdk34.ServerTimestamp Date foo,
+    @com.google.firebase.firestore.ServerTimestamp Date foo,
     Inner inner
 
   ){
     record Inner (
 
-      @com.google.firebase.firestore.sdk34.ServerTimestamp Date bar
+      @com.google.firebase.firestore.ServerTimestamp Date bar
     ){}
   }
 

firebase-firestore-sdk34/src/main/java/com/google/firebase/firestore/sdk34/PropertyName.java

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package com.google.firebase.firestore.util;
+package com.google.firebase.firestore.sdk34.util;
 
 import java.io.Serializable;
 import java.math.BigDecimal;
@@ -29,18 +29,19 @@
 import org.junit.Test;
 import org.robolectric.annotation.Config;
 
+import com.google.firebase.firestore.DocumentId;
 import com.google.firebase.firestore.DocumentReference;
+import com.google.firebase.firestore.PropertyName;
 import com.google.firebase.firestore.TestUtil;
 import com.google.firebase.firestore.ThrowOnExtraProperties;
-import com.google.firebase.firestore.sdk34.DocumentId;
-import com.google.firebase.firestore.sdk34.PropertyName;
+import com.google.firebase.firestore.util.CustomClassMapper;
 
 import static com.google.firebase.firestore.sdk34.LocalFirestoreHelper.fromSingleQuotedString;
 import static com.google.firebase.firestore.sdk34.LocalFirestoreHelper.mapAnyType;
 import static org.junit.Assert.*;
 
 @org.junit.runner.RunWith(org.robolectric.RobolectricTestRunner.class)
-@Config(manifest = Config.NONE, sdk = 34)
+@Config(manifest = Config.NONE, sdk = 33)
 @SuppressWarnings({"unused", "WeakerAccess", "SpellCheckingInspection"})
 public class RecordMapperTest {
   private static final double EPSILON = 0.0003;
@@ -347,6 +348,7 @@ public void primitiveDeserializeDouble() {
     }
   }
 
+  /*
   @Test
   public void primitiveDeserializeBigDecimal() {
     var beanBigdecimal = deserialize("{'value': 123}", BigDecimalBean.class);
@@ -390,6 +392,7 @@ public void primitiveDeserializeBigDecimal() {
     } catch (RuntimeException e) { // ignore
     }
   }
+  */
 
   @Test
   public void primitiveDeserializeFloat() {
@@ -515,15 +518,15 @@ public void primitiveDeserializeWrongTypeList() {
   public void noFieldDeserialize() {
     assertExceptionContains(
         "No properties to serialize found on class "
-            + "com.google.firebase.firestore.RecordMapperTest$NoFieldBean",
+            + "com.google.firebase.firestore.sdk34.util.RecordMapperTest$NoFieldBean",
         () -> deserialize("{'value': 'foo'}", NoFieldBean.class));
   }
 
   @Test
   public void throwOnUnknownProperties() {
     assertExceptionContains(
         "No accessor for unknown found on class "
-            + "com.google.firebase.firestore.RecordMapperTest$ThrowOnUnknownPropertiesBean",
+            + "com.google.firebase.firestore.sdk34.util.RecordMapperTest$ThrowOnUnknownPropertiesBean",
         () ->
             deserialize("{'value': 'foo', 'unknown': 'bar'}", ThrowOnUnknownPropertiesBean.class));
   }
@@ -673,6 +676,7 @@ public void serializeLongBean() {
         serialize(Collections.singletonMap("value", 1.234567890123E12)));
   }
 
+  /*
   @Test
   public void serializeBigDecimalBean() {
     var bean = new BigDecimalBean(BigDecimal.valueOf(1.1));
@@ -687,6 +691,7 @@ public void bigDecimalRoundTrip() {
     var b = convertToCustomClass(serialized, BigDecimalBean.class);
     assertEquals(a, b);
   }
+  */
 
   @Test
   public void serializeBooleanBean() {
@@ -707,7 +712,7 @@ public void serializePrivateFieldBean() {
     final var bean = new NoFieldBean();
     assertExceptionContains(
         "No properties to serialize found on class "
-            + "com.google.firebase.firestore.RecordMapperTest$NoFieldBean",
+            + "com.google.firebase.firestore.sdk34.util.RecordMapperTest$NoFieldBean",
         () -> serialize(bean));
   }
 
@@ -839,15 +844,15 @@ public void roundTripUnicodeBean() {
   public void shortsCantBeSerialized() {
     final var bean = new ShortBean((short) 1);
     assertExceptionContains(
-        "Numbers of type Short are not supported, please use an int, long, float, double or BigDecimal (found in field 'value')",
+        "Numbers of type Short are not supported, please use an int, long, float or double (found in field 'value')",
         () -> serialize(bean));
   }
 
   @Test
   public void bytesCantBeSerialized() {
     final var bean = new ByteBean((byte) 1);
     assertExceptionContains(
-        "Numbers of type Byte are not supported, please use an int, long, float, double or BigDecimal (found in field 'value')",
+        "Numbers of type Byte are not supported, please use an int, long, float or double (found in field 'value')",
         () -> serialize(bean));
   }
 
@@ -928,10 +933,8 @@ public void objectAcceptsAnyObject() {
 
   @Test
   public void passingInGenericBeanTopLevelThrows() {
-    assertExceptionContains(
-        "Class com.google.firebase.firestore.RecordMapperTest$GenericBean has generic type "
-            + "parameters, please use GenericTypeIndicator instead",
-        () -> deserialize("{'value': 'foo'}", GenericBean.class));
+    assertExceptionContains("Class com.google.firebase.firestore.sdk34.util.RecordMapperTest$GenericBean has generic type parameters",
+                            () -> deserialize("{'value': 'foo'}", GenericBean.class));
   }
 
   @Test

firebase-firestore-sdk34/src/main/java/com/google/firebase/firestore/sdk34/ServerTimestamp.java

@@ -16,14 +16,25 @@
 
 package com.google.firebase.firestore.util;
 
+import com.google.firebase.Timestamp;
+import com.google.firebase.firestore.DocumentId;
 import com.google.firebase.firestore.DocumentReference;
 import com.google.firebase.firestore.IgnoreExtraProperties;
+import com.google.firebase.firestore.PropertyName;
+import com.google.firebase.firestore.ServerTimestamp;
 import com.google.firebase.firestore.ThrowOnExtraProperties;
+
+import java.lang.reflect.AccessibleObject;
+import java.lang.reflect.Field;
 import java.lang.reflect.Type;
 import java.lang.reflect.TypeVariable;
 import java.util.Collection;
 import java.util.Collections;
+import java.util.Date;
+import java.util.HashSet;
 import java.util.Map;
+import java.util.Set;
+
 
 /** Base bean mapper class, providing common functionality for class and record serialization. */
 abstract class BeanMapper<T> {
@@ -34,11 +45,19 @@ abstract class BeanMapper<T> {
   // Whether to log a message if there are properties we don't know how to set to
   // custom object fields/setters or record components during deserialization.
   private final boolean warnOnUnknownProperties;
+  // A set of property names that were annotated with @ServerTimestamp.
+  final Set<String> serverTimestamps;
+  // A set of property names that were annotated with @DocumentId. These properties will be
+  // populated with document ID values during deserialization, and be skipped during
+  // serialization.
+  final Set<String> documentIdPropertyNames;
 
   BeanMapper(Class<T> clazz) {
     this.clazz = clazz;
     throwOnUnknownProperties = clazz.isAnnotationPresent(ThrowOnExtraProperties.class);
     warnOnUnknownProperties = !clazz.isAnnotationPresent(IgnoreExtraProperties.class);
+    serverTimestamps = new HashSet<>();
+    documentIdPropertyNames = new HashSet<>();
   }
 
   Class<T> getClazz() {
@@ -75,7 +94,38 @@ abstract T deserialize(
       Map<TypeVariable<Class<T>>, Type> types,
       DeserializeContext context);
 
-  void ensureValidDocumentIdType(String fieldDescription, String operation, Type type) {
+  void applyFieldAnnotations(Field field) {
+    if (field.isAnnotationPresent(ServerTimestamp.class)) {
+      Class<?> fieldType = field.getType();
+      if (fieldType != Date.class && fieldType != Timestamp.class) {
+        throw new IllegalArgumentException("Field " + field.getName() + " is annotated with @ServerTimestamp but is "
+                                                           + fieldType + " instead of Date or Timestamp.");
+      }
+      serverTimestamps.add(propertyName(field));
+    }
+
+    if (field.isAnnotationPresent(DocumentId.class)) {
+      Class<?> fieldType = field.getType();
+      ensureValidDocumentIdType("Field", "is", fieldType);
+      documentIdPropertyNames.add(propertyName(field));
+    }
+  }
+
+  static String propertyName(Field field) {
+    String annotatedName = annotatedName(field);
+    return annotatedName != null? annotatedName : field.getName();
+  }
+
+  static String annotatedName(AccessibleObject obj) {
+    if (obj.isAnnotationPresent(PropertyName.class)) {
+      PropertyName annotation = obj.getAnnotation(PropertyName.class);
+      return annotation.value();
+    }
+
+    return null;
+  }
+
+  static void ensureValidDocumentIdType(String fieldDescription, String operation, Type type) {
     if (type != String.class && type != DocumentReference.class) {
       throw new IllegalArgumentException(
           fieldDescription