Serializing non-nullable enums should lead to non-nullable JSON types

fixes 1145
google · May 30, 2022 · fa7e302 · fa7e302
1 parent d5d73b8
commit fa7e302
Show file tree

Hide file tree

Showing 15 changed files with 144 additions and 83 deletions.
diff --git a/_test_yaml/test/src/build_config.g.dart b/_test_yaml/test/src/build_config.g.dart
diff --git a/json_serializable/lib/src/type_helpers/enum_helper.dart b/json_serializable/lib/src/type_helpers/enum_helper.dart
@@ -29,7 +29,11 @@ class EnumHelper extends TypeHelper<TypeHelperContextWithConfig> {
 
     context.addMember(memberContent);
 
-    return '${constMapName(targetType)}[$expression]';
+    if (targetType.isNullableType) {
+      return '${constMapName(targetType)}[$expression]';
+    } else {
+      return '${constMapName(targetType)}[$expression]!';
+    }
   }
 
   @override

diff --git a/json_serializable/test/default_value/default_value.g.dart b/json_serializable/test/default_value/default_value.g.dart
diff --git a/json_serializable/test/default_value/default_value.g_any_map__checked.g.dart b/json_serializable/test/default_value/default_value.g_any_map__checked.g.dart
diff --git a/json_serializable/test/default_value/implicit_default_value.g.dart b/json_serializable/test/default_value/implicit_default_value.g.dart
diff --git a/json_serializable/test/integration/integration_test.dart b/json_serializable/test/integration/integration_test.dart
@@ -304,6 +304,15 @@ void main() {
     expect(dayTypeEnumValues, ['no-good', 'rotten', 'very-bad']);
   });
 
+  test(
+      'serializing an enum as a key in a map should produce a non-nullable '
+      'string key', () {
+    final cls =
+        Issue1145Regression(status: {Issue1145RegressionEnum.gamma: true});
+    // Prior to issue 1145 resulted in Map<String?, dynamic>
+    expect(cls.toJson()['status'], const TypeMatcher<Map<String, dynamic>>());
+  });
+
   test('unknown as null for enum', () {
     expect(
       () => Issue559Regression.fromJson({}).status,

diff --git a/json_serializable/test/integration/json_enum_example.dart b/json_serializable/test/integration/json_enum_example.dart
@@ -49,3 +49,22 @@ enum Issue559RegressionEnum {
   beta,
   gamma,
 }
+
+enum Issue1145RegressionEnum {
+  alpha,
+  beta,
+  gamma,
+}
+
+@JsonSerializable(
+  createFactory: false,
+)
+class Issue1145Regression {
+  Issue1145Regression({
+    required this.status,
+  });
+
+  Map<String, dynamic> toJson() => _$Issue1145RegressionToJson(this);
+
+  final Map<Issue1145RegressionEnum, bool> status;
+}
diff --git a/json_serializable/test/integration/json_enum_example.g.dart b/json_serializable/test/integration/json_enum_example.g.dart
diff --git a/json_serializable/test/integration/json_test_example.g.dart b/json_serializable/test/integration/json_test_example.g.dart
diff --git a/json_serializable/test/integration/json_test_example.g_any_map.g.dart b/json_serializable/test/integration/json_test_example.g_any_map.g.dart
diff --git a/json_serializable/test/supported_types/input.type_enumtype.g.dart b/json_serializable/test/supported_types/input.type_enumtype.g.dart
diff --git a/json_serializable/test/supported_types/input.type_iterable.g.dart b/json_serializable/test/supported_types/input.type_iterable.g.dart
diff --git a/json_serializable/test/supported_types/input.type_list.g.dart b/json_serializable/test/supported_types/input.type_list.g.dart