Skip to content
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.

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

[json] add datetime support #57063

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions pkg/json/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# 0.20.3

- Add support for DateTime, serializing it to an ISO-8601 String.

# 0.20.2

- Fix generated code syntax error when defining fields containing the dollar sign `$` by using raw strings.
Expand Down
2 changes: 2 additions & 0 deletions pkg/json/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ class Manager extends User {

All native JSON types are supported (`int`, `double`, `String`, `bool`, `Null`).

Supports `DateTime`, serializing it to an ISO-8601 String.

The core collection types `List`, `Set`, and `Map` are also supported, if their
elements are supported types. For elements which require more than just a cast,
the type must be statically provided through a generic type argument on the
Expand Down
12 changes: 12 additions & 0 deletions pkg/json/lib/json.dart
Original file line number Diff line number Diff line change
Expand Up @@ -378,6 +378,16 @@ mixin _FromJson on _Shared {
' as ',
type.code,
]);
case 'DateTime':
return RawCode.fromParts([
if (nullCheck != null) nullCheck,
await builder.resolveIdentifier(_dartCore, 'DateTime'),
'.parse(',
jsonReference,
' as ',
introspectionData.stringCode,
')'
]);
}
}

Expand Down Expand Up @@ -624,6 +634,8 @@ mixin _ToJson on _Shared {
]);
case 'int' || 'double' || 'num' || 'String' || 'bool':
return valueReference;
case 'DateTime':
return RawCode.fromParts([valueReference, '.toIso8601String()']);
}
}

Expand Down
2 changes: 1 addition & 1 deletion pkg/json/pubspec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: >
`toJson` encoding method.

repository: https://github.com/dart-lang/sdk/tree/main/pkg/json
version: 0.20.2
version: 0.20.3
environment:
sdk: ^3.6.0-edge
dependencies:
Expand Down
12 changes: 12 additions & 0 deletions pkg/json/test/json_codable_test.dart
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ void main() {
'intField': 10,
'doubleField': 12.5,
'numField': 11,
'dateTimeField': '2024-11-11T03:42:29.108308',
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't judge me, I need to fix my sleep schedule :S

'listOfSerializableField': [
{'x': 1},
],
Expand All @@ -33,6 +34,7 @@ void main() {
expect(a.intField, 10);
expect(a.doubleField, 12.5);
expect(a.numField, 11);
expect(a.dateTimeField, DateTime.parse('2024-11-11T03:42:29.108308'));
expect(a.listOfSerializableField.single.x, 1);
expect(a.setOfSerializableField.single.x, 2);
expect(a.mapOfSerializableField['c']!.x, 3);
Expand All @@ -47,6 +49,7 @@ void main() {
'nullableIntField': 9,
'nullableDoubleField': 11.5,
'nullableNumField': 11.1,
'nullableDateTimeField': '2024-11-11T03:42:29.108308',
'nullableListOfSerializableField': [
{'x': 1},
],
Expand All @@ -64,6 +67,8 @@ void main() {
expect(b.nullableIntField, 9);
expect(b.nullableDoubleField, 11.5);
expect(b.nullableNumField, 11.1);
expect(b.nullableDateTimeField,
DateTime.parse('2024-11-11T03:42:29.108308'));
expect(b.nullableListOfSerializableField!.single.x, 1);
expect(b.nullableSetOfSerializableField!.single.x, 2);
expect(b.nullableMapOfSerializableField!['d']!.x, 3);
Expand All @@ -78,6 +83,7 @@ void main() {
'nullableIntField': null,
'nullableDoubleField': null,
'nullableNumField': null,
'nullableDateTimeField': null,
'nullableListOfSerializableField': null,
'nullableSetOfSerializableField': null,
'nullableMapOfSerializableField': null,
Expand All @@ -87,6 +93,7 @@ void main() {
expect(b.nullableIntField, null);
expect(b.nullableDoubleField, null);
expect(b.nullableNumField, null);
expect(b.nullableDateTimeField, null);
expect(b.nullableListOfSerializableField, null);
expect(b.nullableMapOfSerializableField, null);
expect(b.nullableSetOfSerializableField, null);
Expand All @@ -101,6 +108,7 @@ void main() {
expect(b.nullableIntField, null);
expect(b.nullableDoubleField, null);
expect(b.nullableNumField, null);
expect(b.nullableDateTimeField, null);
expect(b.nullableListOfSerializableField, null);
expect(b.nullableMapOfSerializableField, null);
expect(b.nullableSetOfSerializableField, null);
Expand Down Expand Up @@ -223,6 +231,8 @@ class A {

final num numField;

final DateTime dateTimeField;

final List<C> listOfSerializableField;

final Set<C> setOfSerializableField;
Expand All @@ -242,6 +252,8 @@ class B {

final num? nullableNumField;

final DateTime? nullableDateTimeField;

final List<C>? nullableListOfSerializableField;

final Set<C>? nullableSetOfSerializableField;
Expand Down