Migrate FSTTimestampValue to FSTDelegateValue (#3170)

Author: wilhuff

Firestore/Example/Tests/API/FSTUserDataConverterTests.mm

@@ -109,7 +109,7 @@ - (void)testConvertsDates {
   NSArray *values = @[ FSTTestDate(1900, 12, 1, 1, 20, 30), FSTTestDate(2017, 4, 24, 13, 20, 30) ];
   for (id value in values) {
     FSTFieldValue *wrapped = FSTTestFieldValue(value);
-    XCTAssertEqualObjects([wrapped class], [FSTTimestampValue class]);
+    XCTAssertEqualObjects([wrapped class], [FSTDelegateValue class]);
     XCTAssertEqualObjects([[wrapped value] class], [FIRTimestamp class]);
     XCTAssertEqualObjects([wrapped value], [FIRTimestamp timestampWithDate:value]);
     XCTAssertEqual(wrapped.type, FieldValue::Type::Timestamp);

Firestore/Example/Tests/Model/FSTFieldValueTests.mm

@@ -307,7 +307,7 @@ - (void)testValueEquality {
     @[ FSTTestFieldValue(@"strin") ],
     @[ FSTTestFieldValue(@"e\u0301b") ],  // latin small letter e + combining acute accent
     @[ FSTTestFieldValue(@"\u00e9a") ],   // latin small letter e with acute accent
-    @[ FSTTestFieldValue(date1), [FSTTimestampValue timestampValue:MakeTimestamp(date1)] ],
+    @[ FSTTestFieldValue(date1), FieldValue::FromTimestamp(MakeTimestamp(date1)).Wrap() ],
     @[ FSTTestFieldValue(date2) ],
     @[
       // NOTE: ServerTimestampValues can't be parsed via FSTTestFieldValue().

Firestore/Example/Tests/Model/FSTMutationTests.mm

@@ -443,9 +443,9 @@ - (void)testAppliesServerAckedServerTimestampTransformToDocuments {
   FSTMutation *transform = FSTTestTransformMutation(
       @"collection/key", @{@"foo.bar" : [FIRFieldValue fieldValueForServerTimestamp]});
 
-  FSTMutationResult *mutationResult = [[FSTMutationResult alloc]
-       initWithVersion:testutil::Version(1)
-      transformResults:@[ [FSTTimestampValue timestampValue:_timestamp] ]];
+  FSTMutationResult *mutationResult =
+      [[FSTMutationResult alloc] initWithVersion:testutil::Version(1)
+                                transformResults:@[ FieldValue::FromTimestamp(_timestamp).Wrap() ]];
 
   FIRTimestamp *publicTimestamp = api::MakeFIRTimestamp(_timestamp);
   FSTMaybeDocument *transformedDoc = [transform applyToRemoteDocument:baseDoc

Firestore/Source/API/FSTUserDataConverter.mm

@@ -453,12 +453,12 @@ - (nullable FSTFieldValue *)parseScalarValue:(nullable id)input context:(ParseCo
 
   } else if ([input isKindOfClass:[NSDate class]]) {
     NSDate *inputDate = input;
-    return [FSTTimestampValue timestampValue:api::MakeTimestamp(inputDate)];
+    return FieldValue::FromTimestamp(api::MakeTimestamp(inputDate)).Wrap();
 
   } else if ([input isKindOfClass:[FIRTimestamp class]]) {
     FIRTimestamp *inputTimestamp = input;
     Timestamp timestamp = TimestampInternal::Truncate(api::MakeTimestamp(inputTimestamp));
-    return [FSTTimestampValue timestampValue:timestamp];
+    return FieldValue::FromTimestamp(timestamp).Wrap();
 
   } else if ([input isKindOfClass:[FIRGeoPoint class]]) {
     return FieldValue::FromGeoPoint(api::MakeGeoPoint(input)).Wrap();

Firestore/Source/Model/FSTFieldValue.h

@@ -103,13 +103,6 @@ typedef NS_ENUM(NSInteger, FSTTypeOrder) {
 
 @end
 
-/**
- * A timestamp value stored in Firestore.
- */
-@interface FSTTimestampValue : FSTFieldValue <FIRTimestamp *>
-+ (instancetype)timestampValue:(const firebase::Timestamp &)value;
-@end
-
 /**
  * Represents a locally-applied Server Timestamp.
  *

Firestore/Source/Model/FSTFieldValue.mm

@@ -23,6 +23,7 @@
 #import "FIRTimestamp.h"
 
 #import "Firestore/Source/API/FIRGeoPoint+Internal.h"
+#import "Firestore/Source/API/FIRTimestamp+Internal.h"
 #import "Firestore/Source/API/converters.h"
 #import "Firestore/Source/Model/FSTDocumentKey.h"
 #import "Firestore/Source/Util/FSTClasses.h"
@@ -127,66 +128,6 @@ - (double)doubleValue {
 
 @end
 
-#pragma mark - FSTTimestampValue
-
-@implementation FSTTimestampValue {
-  Timestamp _internalValue;
-}
-
-+ (instancetype)timestampValue:(const Timestamp &)value {
-  return [[FSTTimestampValue alloc] initWithValue:value];
-}
-
-- (id)initWithValue:(const Timestamp &)value {
-  self = [super init];
-  if (self) {
-    _internalValue = value;
-  }
-  return self;
-}
-
-- (FieldValue::Type)type {
-  return FieldValue::Type::Timestamp;
-}
-
-- (FSTTypeOrder)typeOrder {
-  return FSTTypeOrderTimestamp;
-}
-
-- (id)value {
-  return MakeFIRTimestamp(_internalValue);
-}
-
-- (id)valueWithOptions:(const FieldValueOptions &)options {
-  if (options.timestamps_in_snapshots_enabled()) {
-    return self.value;
-  } else {
-    return [self.value dateValue];
-  }
-}
-
-- (BOOL)isEqual:(id)other {
-  return [other isKindOfClass:[FSTFieldValue class]] &&
-         ((FSTFieldValue *)other).type == FieldValue::Type::Timestamp &&
-         _internalValue == ((FSTTimestampValue *)other)->_internalValue;
-}
-
-- (NSUInteger)hash {
-  return TimestampInternal::Hash(_internalValue);
-}
-
-- (NSComparisonResult)compare:(FSTFieldValue *)other {
-  if (other.type == FieldValue::Type::Timestamp) {
-    return WrapCompare(_internalValue, ((FSTTimestampValue *)other)->_internalValue);
-  } else if (other.type == FieldValue::Type::ServerTimestamp) {
-    // Concrete timestamps come before server timestamps.
-    return NSOrderedAscending;
-  } else {
-    return [self defaultCompare:other];
-  }
-}
-
-@end
 #pragma mark - FSTServerTimestampValue
 
 @implementation FSTServerTimestampValue {
@@ -226,7 +167,7 @@ - (id)valueWithOptions:(const FieldValueOptions &)options {
     case ServerTimestampBehavior::kNone:
       return [NSNull null];
     case ServerTimestampBehavior::kEstimate:
-      return [[FSTTimestampValue timestampValue:self.localWriteTime] valueWithOptions:options];
+      return [FieldValue::FromTimestamp(self.localWriteTime).Wrap() valueWithOptions:options];
     case ServerTimestampBehavior::kPrevious:
       return self.previousValue ? [self.previousValue valueWithOptions:options] : [NSNull null];
     default:
@@ -683,7 +624,11 @@ - (id)value {
       return @(self.internalValue.integer_value());
     case FieldValue::Type::Double:
       return @(self.internalValue.double_value());
-    case FieldValue::Type::Timestamp:
+    case FieldValue::Type::Timestamp: {
+      auto timestamp = self.internalValue.timestamp_value();
+      return [[FIRTimestamp alloc] initWithSeconds:timestamp.seconds()
+                                       nanoseconds:timestamp.nanoseconds()];
+    }
     case FieldValue::Type::ServerTimestamp:
       HARD_FAIL("TODO(rsgowman): implement");
     case FieldValue::Type::String:
@@ -701,6 +646,20 @@ - (id)value {
   UNREACHABLE();
 }
 
+- (id)valueWithOptions:(const model::FieldValueOptions &)options {
+  switch (self.internalValue.type()) {
+    case FieldValue::Type::Timestamp:
+      if (options.timestamps_in_snapshots_enabled()) {
+        return [self value];
+      } else {
+        return [[self value] dateValue];
+      }
+
+    default:
+      return [self value];
+  }
+}
+
 - (NSComparisonResult)compare:(FSTFieldValue *)other {
   // TODO(rsgowman): Port the other FST*Value's, and then remove this comment:
   //
@@ -710,8 +669,14 @@ - (NSComparisonResult)compare:(FSTFieldValue *)other {
   // FSTDelegateValue handles (eg) booleans to ensure this case never occurs.
 
   if (FieldValue::Comparable(self.type, other.type)) {
-    HARD_ASSERT([other isKindOfClass:[FSTDelegateValue class]]);
-    return WrapCompare<FieldValue>(self.internalValue, ((FSTDelegateValue *)other).internalValue);
+    if ([other isKindOfClass:[FSTServerTimestampValue class]]) {
+      HARD_ASSERT(self.type == FieldValue::Type::Timestamp);
+      // Server timestamps come after all concrete timestamps.
+      return NSOrderedAscending;
+    } else {
+      HARD_ASSERT([other isKindOfClass:[FSTDelegateValue class]]);
+      return WrapCompare<FieldValue>(self.internalValue, ((FSTDelegateValue *)other).internalValue);
+    }
   } else {
     return [self defaultCompare:other];
   }

Firestore/Source/Remote/FSTSerializerBeta.mm

@@ -264,7 +264,7 @@ - (FSTFieldValue *)decodedFieldValue:(GCFSValue *)valueProto {
 
     case GCFSValue_ValueType_OneOfCase_TimestampValue: {
       Timestamp value = [self decodedTimestamp:valueProto.timestampValue];
-      return [FSTTimestampValue timestampValue:value];
+      return FieldValue::FromTimestamp(value).Wrap();
     }
 
     case GCFSValue_ValueType_OneOfCase_GeoPointValue:

Firestore/core/test/firebase/firestore/testutil/xcgmock.h

@@ -192,7 +192,6 @@ OBJC_PRINT_TO(FSTSetMutation);
 OBJC_PRINT_TO(FSTSortOrder);
 OBJC_PRINT_TO(FSTStringValue);
 OBJC_PRINT_TO(FSTSyncEngine);
-OBJC_PRINT_TO(FSTTimestampValue);
 OBJC_PRINT_TO(FSTTransformMutation);
 OBJC_PRINT_TO(FSTUnknownDocument);
 OBJC_PRINT_TO(FSTUserDataConverter);