fix issue #144 Date's timezones with intl converter

sachaarbonel · sachaarbonel · commit 7501418194d3 · 2021-11-01T11:09:09.000-04:00
diff --git a/packages/stream_feed/lib/src/core/models/activity.dart b/packages/stream_feed/lib/src/core/models/activity.dart
@@ -2,6 +2,7 @@ import 'package:equatable/equatable.dart';
 import 'package:json_annotation/json_annotation.dart';
 import 'package:stream_feed/src/core/models/feed_id.dart';
 import 'package:stream_feed/src/core/util/serializer.dart';
+import 'package:stream_feed/src/core/util/utc_converter.dart';
 
 part 'activity.g.dart';
 
@@ -15,6 +16,7 @@ part 'activity.g.dart';
 ///
 /// Read more about Activities [here](https://getstream.io/activity-feeds/docs/flutter-dart/adding_activities/?language=dart) and [here](https://activitystrea.ms/specs/json/1.0/).
 @JsonSerializable()
+@DateTimeUTCConverter()
 class Activity extends Equatable {
   /// Builds an [Activity].
   const Activity({
diff --git a/packages/stream_feed/lib/src/core/models/activity_update.dart b/packages/stream_feed/lib/src/core/models/activity_update.dart
@@ -1,11 +1,13 @@
 import 'package:equatable/equatable.dart';
 import 'package:json_annotation/json_annotation.dart';
+import 'package:stream_feed/src/core/util/utc_converter.dart';
 
 part 'activity_update.g.dart';
 
 /// For updating only parts of one or more activities by changing,
 /// adding, or removing fields.
 @JsonSerializable()
+@DateTimeUTCConverter()
 class ActivityUpdate extends Equatable {
   /// Builds an [ActivityUpdate].
   const ActivityUpdate({
diff --git a/packages/stream_feed/lib/src/core/models/collection_entry.dart b/packages/stream_feed/lib/src/core/models/collection_entry.dart
@@ -1,5 +1,6 @@
 import 'package:equatable/equatable.dart';
 import 'package:json_annotation/json_annotation.dart';
+import 'package:stream_feed/src/core/util/utc_converter.dart';
 import 'package:stream_feed/stream_feed.dart';
 
 part 'collection_entry.g.dart';
@@ -20,6 +21,7 @@ part 'collection_entry.g.dart';
 /// Collection endpoints can be used both client-side and server-side except
 /// the batch methods that are only available server-side.
 @JsonSerializable()
+@DateTimeUTCConverter()
 class CollectionEntry extends Equatable {
   /// Builds a [CollectionEntry].
   const CollectionEntry({
diff --git a/packages/stream_feed/lib/src/core/models/enriched_activity.dart b/packages/stream_feed/lib/src/core/models/enriched_activity.dart
@@ -5,6 +5,7 @@ import 'package:stream_feed/src/core/models/collection_entry.dart';
 import 'package:stream_feed/src/core/models/reaction.dart';
 import 'package:stream_feed/src/core/models/user.dart';
 import 'package:stream_feed/src/core/util/serializer.dart';
+import 'package:stream_feed/src/core/util/utc_converter.dart';
 
 part 'enriched_activity.g.dart';
 
@@ -30,9 +31,10 @@ part 'enriched_activity.g.dart';
 /// * T = [target]
 /// * Or = [origin]
 @JsonSerializable(genericArgumentFactories: true)
+@DateTimeUTCConverter()
 class GenericEnrichedActivity<A, Ob, T, Or> extends Equatable {
   //TODO: improve this
-  // when type parameter to can a default type in Dart
+  // when type parameter can have a default type in Dart
   //i.e. https://github.com/dart-lang/language/issues/283#issuecomment-839603127
   /// Builds an [GenericEnrichedActivity].
   const GenericEnrichedActivity({
@@ -263,6 +265,7 @@ class GenericEnrichedActivity<A, Ob, T, Or> extends Equatable {
     Object? Function(Or value) toJsonOr,
   ) =>
       Serializer.moveKeysToMapInPlace(
-          _$GenericEnrichedActivityToJson(this, toJsonA, toJsonOb, toJsonT, toJsonOr),
+          _$GenericEnrichedActivityToJson(
+              this, toJsonA, toJsonOb, toJsonT, toJsonOr),
           topLevelFields);
 }
diff --git a/packages/stream_feed/lib/src/core/models/follow.dart b/packages/stream_feed/lib/src/core/models/follow.dart
@@ -1,12 +1,14 @@
 import 'package:equatable/equatable.dart';
 import 'package:json_annotation/json_annotation.dart';
+import 'package:stream_feed/src/core/util/utc_converter.dart';
 
 part 'follow.g.dart';
 
 /// {@template follow}
 /// Model for the follower of a feed
 /// {@endtemplate}
 @JsonSerializable()
+@DateTimeUTCConverter()
 class Follow extends Equatable {
   /// Builds a [Follow]
   const Follow({
diff --git a/packages/stream_feed/lib/src/core/models/follow.g.dart b/packages/stream_feed/lib/src/core/models/follow.g.dart
diff --git a/packages/stream_feed/lib/src/core/models/foreign_id_time_pair.dart b/packages/stream_feed/lib/src/core/models/foreign_id_time_pair.dart
@@ -1,11 +1,14 @@
 import 'package:equatable/equatable.dart';
 import 'package:stream_feed/src/core/util/extension.dart';
+import 'package:stream_feed/src/core/util/utc_converter.dart';
 
 /// A model that wraps [foreignID] and [time]
 class ForeignIdTimePair extends Equatable {
   /// Builds a [ForeignIdTimePair].
   const ForeignIdTimePair(this.foreignID, this.time);
 
+  static const _converter = DateTimeUTCConverter();
+
   /// The foreign id of an activity
   final String foreignID;
 
@@ -19,7 +22,7 @@ class ForeignIdTimePair extends Equatable {
       final pair = it as List;
       checkArgument(pair.length == 2, 'Invalid foreignIdTime pair');
       final foreignId = pair[0] as String;
-      final time = DateTime.parse(pair[1] as String);
+      final time = _converter.fromJson(pair[1] as String);
       return ForeignIdTimePair(foreignId, time);
     }).toList(growable: false);
   }
diff --git a/packages/stream_feed/lib/src/core/models/group.dart b/packages/stream_feed/lib/src/core/models/group.dart
@@ -1,10 +1,12 @@
 import 'package:equatable/equatable.dart';
 import 'package:json_annotation/json_annotation.dart';
+import 'package:stream_feed/src/core/util/utc_converter.dart';
 
 part 'group.g.dart';
 
 /// An aggregated group type.
 @JsonSerializable(createToJson: true, genericArgumentFactories: true)
+@DateTimeUTCConverter()
 class Group<T> extends Equatable {
   /// [Group] constructor
   const Group({
diff --git a/packages/stream_feed/lib/src/core/models/reaction.dart b/packages/stream_feed/lib/src/core/models/reaction.dart
@@ -3,6 +3,7 @@ import 'package:json_annotation/json_annotation.dart';
 import 'package:stream_feed/src/core/models/feed_id.dart';
 import 'package:stream_feed/src/core/models/user.dart';
 import 'package:stream_feed/src/core/util/serializer.dart';
+import 'package:stream_feed/src/core/util/utc_converter.dart';
 import 'package:stream_feed/stream_feed.dart';
 
 part 'reaction.g.dart';
@@ -15,6 +16,7 @@ part 'reaction.g.dart';
 /// Reactions are automatically returned to feeds' activities at read time
 /// when the reactions parameters are used.
 @JsonSerializable()
+@DateTimeUTCConverter()
 class Reaction extends Equatable {
   /// Builds a [Reaction].
   const Reaction({
diff --git a/packages/stream_feed/lib/src/core/models/realtime_message.dart b/packages/stream_feed/lib/src/core/models/realtime_message.dart
@@ -4,6 +4,7 @@ import 'package:json_annotation/json_annotation.dart';
 import 'package:stream_feed/src/core/models/feed_id.dart';
 
 import 'package:stream_feed/src/core/models/foreign_id_time_pair.dart';
+import 'package:stream_feed/src/core/util/utc_converter.dart';
 import 'package:stream_feed/stream_feed.dart';
 
 part 'realtime_message.g.dart';
@@ -23,6 +24,7 @@ part 'realtime_message.g.dart';
 /// The only thing you don’t get is the enriched reactions like `own_reaction`
 /// or `latest_reactions`
 @JsonSerializable(genericArgumentFactories: true)
+@DateTimeUTCConverter()
 class RealtimeMessage<A, Ob, T, Or> extends Equatable {
   /// Builds a [RealtimeMessage].
   const RealtimeMessage({
diff --git a/packages/stream_feed/lib/src/core/models/user.dart b/packages/stream_feed/lib/src/core/models/user.dart
@@ -1,6 +1,7 @@
 import 'package:equatable/equatable.dart';
 import 'package:json_annotation/json_annotation.dart';
 import 'package:stream_feed/src/core/util/serializer.dart';
+import 'package:stream_feed/src/core/util/utc_converter.dart';
 
 part 'user.g.dart';
 
@@ -11,6 +12,7 @@ part 'user.g.dart';
 /// When stored in activities, users are automatically enriched by Stream.
 /// {@endtemplate}
 @JsonSerializable()
+@DateTimeUTCConverter()
 class User extends Equatable {
   /// Builds a [User].
   const User({
diff --git a/packages/stream_feed/lib/src/core/util/utc_converter.dart b/packages/stream_feed/lib/src/core/util/utc_converter.dart
@@ -0,0 +1,25 @@
+import 'package:intl/intl.dart';
+import 'package:json_annotation/json_annotation.dart';
+
+class DateTimeUTCConverter implements JsonConverter<DateTime, String> {
+  const DateTimeUTCConverter();
+  static final DateFormat FORMAT = DateFormat('yyyy-MM-ddTHH:mm:ssZ');
+
+  @override
+  DateTime fromJson(String json) => FORMAT.parse(json, true);
+
+  @override
+  String toJson(DateTime json) => formatDateWithOffset(json);
+}
+
+
+String formatDateWithOffset(DateTime date) {
+  String twoDigits(int n) => n >= 10 ? '$n' : '0$n';
+
+  final hours = twoDigits(date.timeZoneOffset.inHours.abs());
+  final minutes = twoDigits(date.timeZoneOffset.inMinutes.remainder(60));
+  final sign = date.timeZoneOffset.inHours > 0 ? '+' : '-';
+  final formattedDate = DateFormat('yyyy-MM-ddTHH:mm:ss').format(date);
+
+  return '$formattedDate$sign$hours:$minutes';
+}
diff --git a/packages/stream_feed/pubspec.yaml b/packages/stream_feed/pubspec.yaml
@@ -13,6 +13,7 @@ dependencies:
   equatable: ^2.0.0
   faye_dart: ^0.1.0
   http_parser: ^4.0.0
+  intl: ^0.17.0
   jose: ^0.3.2
   json_annotation: ^4.0.1
   logging: ^1.0.1
diff --git a/packages/stream_feed/test/models_test.dart b/packages/stream_feed/test/models_test.dart
@@ -12,6 +12,7 @@ import 'package:stream_feed/src/core/models/paginated_reactions.dart';
 import 'package:stream_feed/src/core/models/personalized_feed.dart';
 import 'package:stream_feed/src/core/models/thumbnail.dart';
 import 'package:stream_feed/src/core/models/user.dart';
+import 'package:stream_feed/src/core/util/utc_converter.dart';
 import 'package:stream_feed/stream_feed.dart';
 import 'package:test/test.dart';
 
@@ -797,6 +798,7 @@ void main() {
   });
 
   test('Follow', () {
+    const converter = DateTimeUTCConverter();
     final followJson = {
       'feed_id': 'timeline:feedId',
       'target_id': 'user:userId',
@@ -806,15 +808,15 @@ void main() {
     final follow = Follow(
         feedId: 'timeline:feedId',
         targetId: 'user:userId',
-        createdAt: DateTime.parse('2021-05-14T19:58:27.274792063Z'),
-        updatedAt: DateTime.parse('2021-05-14T19:58:27.274792063Z'));
+        createdAt: converter.fromJson('2021-05-14T19:58:27.274792063Z'),
+        updatedAt: converter.fromJson('2021-05-14T19:58:27.274792063Z'));
 
     expect(follow, Follow.fromJson(followJson));
     expect(follow.toJson(), {
       'feed_id': 'timeline:feedId',
       'target_id': 'user:userId',
-      'created_at': '2021-05-14T19:58:27.274792Z',
-      'updated_at': '2021-05-14T19:58:27.274792Z'
+      'created_at': '2021-05-14T19:58:27-00:00',
+      'updated_at': '2021-05-14T19:58:27-00:00'
     });
   });
 
diff --git a/packages/stream_feed/test/utils_test.dart b/packages/stream_feed/test/utils_test.dart
@@ -1,5 +1,6 @@
 import 'package:stream_feed/src/core/util/extension.dart';
 import 'package:stream_feed/src/core/util/serializer.dart';
+import 'package:stream_feed/src/core/util/utc_converter.dart';
 import 'package:test/test.dart';
 
 void main() {
@@ -57,4 +58,19 @@ void main() {
       expect(serializer, {'test': 'test', 'extra_data': {}});
     });
   });
+
+  group('DateTimeUTConverter', () {
+    const converter = DateTimeUTCConverter();
+    test('fromJson sample 1', () {
+      const rawDate = '2021-05-26T14:23:33.918391';
+      final convertedDate = converter.fromJson(rawDate);
+      expect(convertedDate.isUtc, true);
+    });
+
+    test('fromJson sample 2', () {
+      const rawDate = '2021-05-14T19:58:27.274792063Z';
+      final convertedDate = converter.fromJson(rawDate);
+      expect(convertedDate.isUtc, true); //
+    });
+  });
 }
