Skip to content

feat: add option to serialize DateTime values as UTC #3740

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MichaelDark wants to merge 1 commit into
base: develop
Choose a base branch
from
+32 −11
Open

feat: add option to serialize DateTime values as UTC #3740

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 18 additions & 7 deletions drift/lib/src/runtime/data_class.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -207,8 +207,10 @@ abstract class ValueSerializer {
/// timestamp ([DateTime.millisecondsSinceEpoch]) or a string
/// ([DateTime.toIso8601String]).
/// In either case, date time values can be _deserialized_ from both formats.
const factory ValueSerializer.defaults(
{bool serializeDateTimeValuesAsString}) = _DefaultValueSerializer;
const factory ValueSerializer.defaults({
bool serializeDateTimeAsUtc,
bool serializeDateTimeValuesAsString,
}) = _DefaultValueSerializer;

/// Converts the [value] to something that can be passed to
/// [JsonCodec.encode].
Expand All @@ -220,9 +222,13 @@ abstract class ValueSerializer {
}

class _DefaultValueSerializer extends ValueSerializer {
final bool serializeDateTimeAsUtc;
final bool serializeDateTimeValuesAsString;

const _DefaultValueSerializer({this.serializeDateTimeValuesAsString = false});
const _DefaultValueSerializer({
this.serializeDateTimeAsUtc = false,
this.serializeDateTimeValuesAsString = false,
});

@override
T fromJson<T>(dynamic json) {
Expand All @@ -234,7 +240,11 @@ class _DefaultValueSerializer extends ValueSerializer {

if (typeList is List<DateTime?>) {
if (json is int) {
return DateTime.fromMillisecondsSinceEpoch(json) as T;
return DateTime.fromMillisecondsSinceEpoch(
json,
isUtc: serializeDateTimeAsUtc,
)
as T;
} else {
return DateTime.parse(json.toString()) as T;
}
Expand All @@ -246,7 +256,7 @@ class _DefaultValueSerializer extends ValueSerializer {

// blobs are encoded as a regular json array, so we manually convert that to
// a Uint8List
if (typeList is List<Uint8List?> && json is! Uint8List) {
if (json is! Uint8List) {
final asList = (json as List).cast<int>();
return Uint8List.fromList(asList) as T;
}
Expand All @@ -257,9 +267,10 @@ class _DefaultValueSerializer extends ValueSerializer {
@override
dynamic toJson<T>(T value) {
if (value is DateTime) {
final dateTime = (serializeDateTimeAsUtc ? value.toUtc() : value);
return serializeDateTimeValuesAsString
? value.toIso8601String()
: value.millisecondsSinceEpoch;
? dateTime.toIso8601String()
: dateTime.millisecondsSinceEpoch;
}

return value;
Expand Down
18 changes: 14 additions & 4 deletions future/drift3/lib/src/database/data_class.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,7 @@ abstract class ValueSerializer {
/// ([DateTime.toIso8601String]).
/// In either case, date time values can be _deserialized_ from both formats.
const factory ValueSerializer.defaults({
bool serializeDateTimeAsUtc,
bool serializeDateTimeValuesAsString,
}) = _DefaultValueSerializer;

Expand All @@ -215,9 +216,13 @@ abstract class ValueSerializer {
}

class _DefaultValueSerializer extends ValueSerializer {
final bool serializeDateTimeAsUtc;
final bool serializeDateTimeValuesAsString;

const _DefaultValueSerializer({this.serializeDateTimeValuesAsString = false});
const _DefaultValueSerializer({
this.serializeDateTimeAsUtc = false,
this.serializeDateTimeValuesAsString = false,
});

@override
T fromJson<T>(dynamic json) {
Expand All @@ -229,7 +234,11 @@ class _DefaultValueSerializer extends ValueSerializer {

if (typeList is List<DateTime?>) {
if (json is int) {
return DateTime.fromMillisecondsSinceEpoch(json) as T;
return DateTime.fromMillisecondsSinceEpoch(
json,
isUtc: serializeDateTimeAsUtc,
)
as T;
} else {
return DateTime.parse(json.toString()) as T;
}
Expand All @@ -252,9 +261,10 @@ class _DefaultValueSerializer extends ValueSerializer {
@override
dynamic toJson<T>(T value) {
if (value is DateTime) {
final dateTime = (serializeDateTimeAsUtc ? value.toUtc() : value);
return serializeDateTimeValuesAsString
? value.toIso8601String()
: value.millisecondsSinceEpoch;
? dateTime.toIso8601String()
: dateTime.millisecondsSinceEpoch;
}

return value;
Expand Down
Loading