Serializing enums explicitly references types unless nullable (issue … (#1146)

Before this change, serializing non-nullable enums in a subtype was incorrectly producing nullable string types.

For example, serializing a class member of type Map<enum, String> produced a type Map<String?, dynamic> where Map<String, dynamic> should have been produced.

Nullable enums should still produce nullable types, eg. serializing List<enum?> should produce List<String?>

fixes #1145

Author: ssabdb

_test_yaml/test/src/build_config.g.dart

@@ -4,6 +4,8 @@
   of type `MyClass?`. ([#822](https://github.com/google/json_serializable.dart/issues/822))
 - Added support for `JsonSerializable(converters: <JsonConverter>[])`
   ([#1072](https://github.com/google/json_serializable.dart/issues/1072))
+- Fix issue with serialization of non-nullable enumerations emitting a nullable
+  type ([#1146](https://github.com/google/json_serializable.dart/pull/1146))
 
 ## 6.2.0
 

json_serializable/CHANGELOG.md

@@ -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

json_serializable/lib/src/type_helpers/enum_helper.dart

@@ -304,6 +304,23 @@ void main() {
     expect(dayTypeEnumValues, ['no-good', 'rotten', 'very-bad']);
   });
 
+  test(
+      'serializing a non-nullable enum as a key in a map should produce a '
+      'non-nullable string key', () {
+    final cls =
+        Issue1145RegressionA(status: {Issue1145RegressionEnum.gamma: true});
+    // Due to issue 1145 this resulted in Map<String?, dynamic>
+    expect(cls.toJson()['status'], const TypeMatcher<Map<String, dynamic>>());
+  });
+
+  test(
+      'serializing a nullable enum in a list should produce a list with'
+      ' nullable entries', () {
+    final cls = Issue1145RegressionB(status: [Issue1145RegressionEnum.gamma]);
+    // Issue 1145 should not have affected nullable enums
+    expect(cls.toJson()['status'], const TypeMatcher<List<String?>>());
+  });
+
   test('unknown as null for enum', () {
     expect(
       () => Issue559Regression.fromJson({}).status,

json_serializable/test/default_value/default_value.g.dart

@@ -49,3 +49,35 @@ enum Issue559RegressionEnum {
   beta,
   gamma,
 }
+
+enum Issue1145RegressionEnum {
+  alpha,
+  beta,
+  gamma,
+}
+
+@JsonSerializable(
+  createFactory: false,
+)
+class Issue1145RegressionA {
+  Issue1145RegressionA({
+    required this.status,
+  });
+
+  Map<String, dynamic> toJson() => _$Issue1145RegressionAToJson(this);
+
+  final Map<Issue1145RegressionEnum, bool> status;
+}
+
+@JsonSerializable(
+  createFactory: false,
+)
+class Issue1145RegressionB {
+  Issue1145RegressionB({
+    required this.status,
+  });
+
+  Map<String, dynamic> toJson() => _$Issue1145RegressionBToJson(this);
+
+  final List<Issue1145RegressionEnum?> status;
+}