Skip to content

[csharp][generichost] Deserialize present-but-null nullable enums #23912

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
daberni wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[csharp][generichost] Deserialize present-but-null nullable enums #23912

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
11 changes: 11 additions & 0 deletions .../openapi-generator/src/main/resources/csharp/libraries/generichost/JsonConverter.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -230,13 +230,24 @@
{{/isNumeric}}
{{^isNumeric}}
string{{nrt?}} {{#lambda.camelcase_sanitize_param}}{{name}}{{/lambda.camelcase_sanitize_param}}RawValue = utf8JsonReader.GetString();
{{! A nullable enum may be explicitly null in the payload; still mark the Option as set so a present-but-null value is not rejected as missing. }}
{{^isInnerEnum}}
{{#isNullable}}
{{#lambda.camelcase_sanitize_param}}{{name}}{{/lambda.camelcase_sanitize_param}} = {{>OptionProperty}}{{#lambda.camelcase_sanitize_param}}{{name}}{{/lambda.camelcase_sanitize_param}}RawValue == null ? null : {{{datatypeWithEnum}}}ValueConverter.FromStringOrDefault({{#lambda.camelcase_sanitize_param}}{{name}}{{/lambda.camelcase_sanitize_param}}RawValue));
{{/isNullable}}
{{^isNullable}}
if ({{#lambda.camelcase_sanitize_param}}{{name}}{{/lambda.camelcase_sanitize_param}}RawValue != null)
{{#lambda.camelcase_sanitize_param}}{{name}}{{/lambda.camelcase_sanitize_param}} = {{>OptionProperty}}{{{datatypeWithEnum}}}ValueConverter.FromStringOrDefault({{#lambda.camelcase_sanitize_param}}{{name}}{{/lambda.camelcase_sanitize_param}}RawValue));
{{/isNullable}}
{{/isInnerEnum}}
{{#isInnerEnum}}
{{#isNullable}}
{{#lambda.camelcase_sanitize_param}}{{name}}{{/lambda.camelcase_sanitize_param}} = {{>OptionProperty}}{{#lambda.camelcase_sanitize_param}}{{name}}{{/lambda.camelcase_sanitize_param}}RawValue == null ? null : {{classname}}.{{{datatypeWithEnum}}}FromStringOrDefault({{#lambda.camelcase_sanitize_param}}{{name}}{{/lambda.camelcase_sanitize_param}}RawValue));
{{/isNullable}}
{{^isNullable}}
if ({{#lambda.camelcase_sanitize_param}}{{name}}{{/lambda.camelcase_sanitize_param}}RawValue != null)
{{#lambda.camelcase_sanitize_param}}{{name}}{{/lambda.camelcase_sanitize_param}} = {{>OptionProperty}}{{classname}}.{{{datatypeWithEnum}}}FromStringOrDefault({{#lambda.camelcase_sanitize_param}}{{name}}{{/lambda.camelcase_sanitize_param}}RawValue));
{{/isNullable}}
{{/isInnerEnum}}
{{/isNumeric}}
{{/isMap}}
Expand Down
33 changes: 33 additions & 0 deletions ...nerator/src/test/java/org/openapitools/codegen/csharpnetcore/CSharpClientCodegenTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,39 @@

public class CSharpClientCodegenTest {

@Test
public void testGenericHostNullableEnumDeserializesPresentNull() throws IOException {
// For a required + nullable enum, the generated generichost JsonConverter must assign
// the backing Option even when the JSON value is null; otherwise the required-property
// check rejects a present-but-null value with "Property is required". Non-nullable enums
// keep the original non-null guard, so their generated output is unchanged.
File output = Files.createTempDirectory("test").toFile().getCanonicalFile();
output.deleteOnExit();
final OpenAPI openAPI = TestUtils.parseFlattenSpec(
"src/test/resources/3_0/csharp/petstore-with-fake-endpoints-models-for-testing-with-http-signature.yaml");
final DefaultGenerator defaultGenerator = new DefaultGenerator();
final ClientOptInput clientOptInput = new ClientOptInput();
clientOptInput.openAPI(openAPI);
CSharpClientCodegen cSharpClientCodegen = new CSharpClientCodegen();
cSharpClientCodegen.setLibrary("generichost");
cSharpClientCodegen.setOutputDir(output.getAbsolutePath());
clientOptInput.config(cSharpClientCodegen);
defaultGenerator.opts(clientOptInput);

Map<String, File> files = defaultGenerator.generate().stream()
.collect(Collectors.toMap(File::getPath, Function.identity()));

File requiredClass = files.get(Paths.get(output.getAbsolutePath(),
"src", "Org.OpenAPITools", "Model", "RequiredClass.cs").toString());
assertNotNull(requiredClass);
// required + nullable enum: a null raw value still sets the Option (mapped to null)
assertFileContains(requiredClass.toPath(),
"requiredNullableEnumString = new Option<RequiredClass.RequiredNullableEnumStringEnum?>(requiredNullableEnumStringRawValue == null ? null :");
// required + non-nullable enum: keeps the original guard (unchanged behavior)
assertFileContains(requiredClass.toPath(),
"if (requiredNotnullableEnumStringRawValue != null)");
}

@Test
public void testToEnumVarName() {
final CSharpClientCodegen codegen = new CSharpClientCodegen();
Expand Down
3 changes: 1 addition & 2 deletions ...tstore/csharp/generichost/latest/UseDateTimeOffset/src/Org.OpenAPITools/Model/EnumTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -753,8 +753,7 @@ public override EnumTest Read(ref Utf8JsonReader utf8JsonReader, Type typeToConv
break;
case "outerEnum":
string? outerEnumRawValue = utf8JsonReader.GetString();
if (outerEnumRawValue != null)
outerEnum = new Option<OuterEnum?>(OuterEnumValueConverter.FromStringOrDefault(outerEnumRawValue));
outerEnum = new Option<OuterEnum?>(outerEnumRawValue == null ? null : OuterEnumValueConverter.FromStringOrDefault(outerEnumRawValue));
break;
case "outerEnumDefaultValue":
string? outerEnumDefaultValueRawValue = utf8JsonReader.GetString();
Expand Down
12 changes: 4 additions & 8 deletions ...e/csharp/generichost/latest/UseDateTimeOffset/src/Org.OpenAPITools/Model/RequiredClass.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1915,13 +1915,11 @@ public override RequiredClass Read(ref Utf8JsonReader utf8JsonReader, Type typeT
break;
case "notrequired_nullable_enum_string":
string? notrequiredNullableEnumStringRawValue = utf8JsonReader.GetString();
if (notrequiredNullableEnumStringRawValue != null)
notrequiredNullableEnumString = new Option<RequiredClass.NotrequiredNullableEnumStringEnum?>(RequiredClass.NotrequiredNullableEnumStringEnumFromStringOrDefault(notrequiredNullableEnumStringRawValue));
notrequiredNullableEnumString = new Option<RequiredClass.NotrequiredNullableEnumStringEnum?>(notrequiredNullableEnumStringRawValue == null ? null : RequiredClass.NotrequiredNullableEnumStringEnumFromStringOrDefault(notrequiredNullableEnumStringRawValue));
break;
case "notrequired_nullable_outerEnumDefaultValue":
string? notrequiredNullableOuterEnumDefaultValueRawValue = utf8JsonReader.GetString();
if (notrequiredNullableOuterEnumDefaultValueRawValue != null)
notrequiredNullableOuterEnumDefaultValue = new Option<OuterEnumDefaultValue?>(OuterEnumDefaultValueValueConverter.FromStringOrDefault(notrequiredNullableOuterEnumDefaultValueRawValue));
notrequiredNullableOuterEnumDefaultValue = new Option<OuterEnumDefaultValue?>(notrequiredNullableOuterEnumDefaultValueRawValue == null ? null : OuterEnumDefaultValueValueConverter.FromStringOrDefault(notrequiredNullableOuterEnumDefaultValueRawValue));
break;
case "notrequired_nullable_string_prop":
notrequiredNullableStringProp = new Option<string?>(utf8JsonReader.GetString());
Expand Down Expand Up @@ -1949,16 +1947,14 @@ public override RequiredClass Read(ref Utf8JsonReader utf8JsonReader, Type typeT
break;
case "required_nullable_enum_string":
string? requiredNullableEnumStringRawValue = utf8JsonReader.GetString();
if (requiredNullableEnumStringRawValue != null)
requiredNullableEnumString = new Option<RequiredClass.RequiredNullableEnumStringEnum?>(RequiredClass.RequiredNullableEnumStringEnumFromStringOrDefault(requiredNullableEnumStringRawValue));
requiredNullableEnumString = new Option<RequiredClass.RequiredNullableEnumStringEnum?>(requiredNullableEnumStringRawValue == null ? null : RequiredClass.RequiredNullableEnumStringEnumFromStringOrDefault(requiredNullableEnumStringRawValue));
break;
case "required_nullable_integer_prop":
requiredNullableIntegerProp = new Option<int?>(utf8JsonReader.TokenType == JsonTokenType.Null ? (int?)null : utf8JsonReader.GetInt32());
break;
case "required_nullable_outerEnumDefaultValue":
string? requiredNullableOuterEnumDefaultValueRawValue = utf8JsonReader.GetString();
if (requiredNullableOuterEnumDefaultValueRawValue != null)
requiredNullableOuterEnumDefaultValue = new Option<OuterEnumDefaultValue?>(OuterEnumDefaultValueValueConverter.FromStringOrDefault(requiredNullableOuterEnumDefaultValueRawValue));
requiredNullableOuterEnumDefaultValue = new Option<OuterEnumDefaultValue?>(requiredNullableOuterEnumDefaultValueRawValue == null ? null : OuterEnumDefaultValueValueConverter.FromStringOrDefault(requiredNullableOuterEnumDefaultValueRawValue));
break;
case "required_nullable_string_prop":
requiredNullableStringProp = new Option<string?>(utf8JsonReader.GetString());
Expand Down
3 changes: 1 addition & 2 deletions ...lient/petstore/csharp/generichost/net10/FormModels/src/Org.OpenAPITools/Model/EnumTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,8 +281,7 @@ public override EnumTest Read(ref Utf8JsonReader utf8JsonReader, Type typeToConv
break;
case "outerEnum":
string outerEnumRawValue = utf8JsonReader.GetString();
if (outerEnumRawValue != null)
outerEnum = new Option<OuterEnum?>(OuterEnumValueConverter.FromStringOrDefault(outerEnumRawValue));
outerEnum = new Option<OuterEnum?>(outerEnumRawValue == null ? null : OuterEnumValueConverter.FromStringOrDefault(outerEnumRawValue));
break;
case "outerEnumDefaultValue":
string outerEnumDefaultValueRawValue = utf8JsonReader.GetString();
Expand Down
24 changes: 8 additions & 16 deletions .../petstore/csharp/generichost/net10/FormModels/src/Org.OpenAPITools/Model/RequiredClass.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -845,23 +845,19 @@ public override RequiredClass Read(ref Utf8JsonReader utf8JsonReader, Type typeT
break;
case "notrequired_nullable_enum_integer":
string notrequiredNullableEnumIntegerRawValue = utf8JsonReader.GetString();
if (notrequiredNullableEnumIntegerRawValue != null)
notrequiredNullableEnumInteger = new Option<RequiredClassRequiredNullableEnumInteger?>(RequiredClassRequiredNullableEnumIntegerValueConverter.FromStringOrDefault(notrequiredNullableEnumIntegerRawValue));
notrequiredNullableEnumInteger = new Option<RequiredClassRequiredNullableEnumInteger?>(notrequiredNullableEnumIntegerRawValue == null ? null : RequiredClassRequiredNullableEnumIntegerValueConverter.FromStringOrDefault(notrequiredNullableEnumIntegerRawValue));
break;
case "notrequired_nullable_enum_integer_only":
string notrequiredNullableEnumIntegerOnlyRawValue = utf8JsonReader.GetString();
if (notrequiredNullableEnumIntegerOnlyRawValue != null)
notrequiredNullableEnumIntegerOnly = new Option<RequiredClassRequiredNullableEnumIntegerOnly?>(RequiredClassRequiredNullableEnumIntegerOnlyValueConverter.FromStringOrDefault(notrequiredNullableEnumIntegerOnlyRawValue));
notrequiredNullableEnumIntegerOnly = new Option<RequiredClassRequiredNullableEnumIntegerOnly?>(notrequiredNullableEnumIntegerOnlyRawValue == null ? null : RequiredClassRequiredNullableEnumIntegerOnlyValueConverter.FromStringOrDefault(notrequiredNullableEnumIntegerOnlyRawValue));
break;
case "notrequired_nullable_enum_string":
string notrequiredNullableEnumStringRawValue = utf8JsonReader.GetString();
if (notrequiredNullableEnumStringRawValue != null)
notrequiredNullableEnumString = new Option<RequiredClassRequiredNullableEnumString?>(RequiredClassRequiredNullableEnumStringValueConverter.FromStringOrDefault(notrequiredNullableEnumStringRawValue));
notrequiredNullableEnumString = new Option<RequiredClassRequiredNullableEnumString?>(notrequiredNullableEnumStringRawValue == null ? null : RequiredClassRequiredNullableEnumStringValueConverter.FromStringOrDefault(notrequiredNullableEnumStringRawValue));
break;
case "notrequired_nullable_outerEnumDefaultValue":
string notrequiredNullableOuterEnumDefaultValueRawValue = utf8JsonReader.GetString();
if (notrequiredNullableOuterEnumDefaultValueRawValue != null)
notrequiredNullableOuterEnumDefaultValue = new Option<OuterEnumDefaultValue?>(OuterEnumDefaultValueValueConverter.FromStringOrDefault(notrequiredNullableOuterEnumDefaultValueRawValue));
notrequiredNullableOuterEnumDefaultValue = new Option<OuterEnumDefaultValue?>(notrequiredNullableOuterEnumDefaultValueRawValue == null ? null : OuterEnumDefaultValueValueConverter.FromStringOrDefault(notrequiredNullableOuterEnumDefaultValueRawValue));
break;
case "notrequired_nullable_string_prop":
notrequiredNullableStringProp = new Option<string>(utf8JsonReader.GetString());
Expand All @@ -883,26 +879,22 @@ public override RequiredClass Read(ref Utf8JsonReader utf8JsonReader, Type typeT
break;
case "required_nullable_enum_integer":
string requiredNullableEnumIntegerRawValue = utf8JsonReader.GetString();
if (requiredNullableEnumIntegerRawValue != null)
requiredNullableEnumInteger = new Option<RequiredClassRequiredNullableEnumInteger?>(RequiredClassRequiredNullableEnumIntegerValueConverter.FromStringOrDefault(requiredNullableEnumIntegerRawValue));
requiredNullableEnumInteger = new Option<RequiredClassRequiredNullableEnumInteger?>(requiredNullableEnumIntegerRawValue == null ? null : RequiredClassRequiredNullableEnumIntegerValueConverter.FromStringOrDefault(requiredNullableEnumIntegerRawValue));
break;
case "required_nullable_enum_integer_only":
string requiredNullableEnumIntegerOnlyRawValue = utf8JsonReader.GetString();
if (requiredNullableEnumIntegerOnlyRawValue != null)
requiredNullableEnumIntegerOnly = new Option<RequiredClassRequiredNullableEnumIntegerOnly?>(RequiredClassRequiredNullableEnumIntegerOnlyValueConverter.FromStringOrDefault(requiredNullableEnumIntegerOnlyRawValue));
requiredNullableEnumIntegerOnly = new Option<RequiredClassRequiredNullableEnumIntegerOnly?>(requiredNullableEnumIntegerOnlyRawValue == null ? null : RequiredClassRequiredNullableEnumIntegerOnlyValueConverter.FromStringOrDefault(requiredNullableEnumIntegerOnlyRawValue));
break;
case "required_nullable_enum_string":
string requiredNullableEnumStringRawValue = utf8JsonReader.GetString();
if (requiredNullableEnumStringRawValue != null)
requiredNullableEnumString = new Option<RequiredClassRequiredNullableEnumString?>(RequiredClassRequiredNullableEnumStringValueConverter.FromStringOrDefault(requiredNullableEnumStringRawValue));
requiredNullableEnumString = new Option<RequiredClassRequiredNullableEnumString?>(requiredNullableEnumStringRawValue == null ? null : RequiredClassRequiredNullableEnumStringValueConverter.FromStringOrDefault(requiredNullableEnumStringRawValue));
break;
case "required_nullable_integer_prop":
requiredNullableIntegerProp = new Option<int?>(utf8JsonReader.TokenType == JsonTokenType.Null ? (int?)null : utf8JsonReader.GetInt32());
break;
case "required_nullable_outerEnumDefaultValue":
string requiredNullableOuterEnumDefaultValueRawValue = utf8JsonReader.GetString();
if (requiredNullableOuterEnumDefaultValueRawValue != null)
requiredNullableOuterEnumDefaultValue = new Option<OuterEnumDefaultValue?>(OuterEnumDefaultValueValueConverter.FromStringOrDefault(requiredNullableOuterEnumDefaultValueRawValue));
requiredNullableOuterEnumDefaultValue = new Option<OuterEnumDefaultValue?>(requiredNullableOuterEnumDefaultValueRawValue == null ? null : OuterEnumDefaultValueValueConverter.FromStringOrDefault(requiredNullableOuterEnumDefaultValueRawValue));
break;
case "required_nullable_string_prop":
requiredNullableStringProp = new Option<string>(utf8JsonReader.GetString());
Expand Down
3 changes: 1 addition & 2 deletions ...tstore/csharp/generichost/net10/NullReferenceTypes/src/Org.OpenAPITools/Model/EnumTest.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -761,8 +761,7 @@ public override EnumTest Read(ref Utf8JsonReader utf8JsonReader, Type typeToConv
break;
case "outerEnum":
string? outerEnumRawValue = utf8JsonReader.GetString();
if (outerEnumRawValue != null)
outerEnum = new Option<OuterEnum?>(OuterEnumValueConverter.FromStringOrDefault(outerEnumRawValue));
outerEnum = new Option<OuterEnum?>(outerEnumRawValue == null ? null : OuterEnumValueConverter.FromStringOrDefault(outerEnumRawValue));
break;
case "outerEnumDefaultValue":
string? outerEnumDefaultValueRawValue = utf8JsonReader.GetString();
Expand Down
Loading
Loading