[BUG][csharp] Fix integer/numeric enum JSON converters using string operations instead of numeric #1
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| {{#allowableValues}}{{#enumVars}}{{#-first}}{{#isNumeric}}{{#isLong}}GetInt64{{/isLong}}{{#isFloat}}GetSingle{{/isFloat}}{{#isDouble}}GetDouble{{/isDouble}}{{#isDecimal}}GetDecimal{{/isDecimal}}{{^isLong}}{{^isFloat}}{{^isDouble}}{{^isDecimal}}GetInt32{{/isDecimal}}{{/isDouble}}{{/isFloat}}{{/isLong}}{{/isNumeric}}{{/-first}}{{/enumVars}}{{/allowableValues}} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -260,4 +260,82 @@ private List<String> getNames(List<CodegenProperty> props) { | |
| if (props == null) return null; | ||
| return props.stream().map(v -> v.name).collect(Collectors.toList()); | ||
| } | ||
|
|
||
| @Test | ||
| public void testIntegerEnumJsonConverterUsesNumericOperations() throws IOException { | ||
| File output = Files.createTempDirectory("test").toFile().getCanonicalFile(); | ||
| output.deleteOnExit(); | ||
| final OpenAPI openAPI = TestUtils.parseFlattenSpec("src/test/resources/3_0/csharp/integer-enum.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())); | ||
|
|
||
| // Verify integer enum uses numeric JSON reader with validation | ||
| File intEnumFile = files.get(Paths | ||
| .get(output.getAbsolutePath(), "src", "Org.OpenAPITools", "Model", "IntegerEnum.cs") | ||
| .toString() | ||
| ); | ||
| assertNotNull(intEnumFile, "Could not find file for model: IntegerEnum"); | ||
| assertFileContains(intEnumFile.toPath(), | ||
| "reader.GetInt32().ToString()", | ||
| "FromStringOrDefault(rawValue)", | ||
| "throw new JsonException()", | ||
| "writer.WriteNumberValue(", | ||
| "public static int ToJsonValue(IntegerEnum value)" | ||
| ); | ||
| assertFileNotContains(intEnumFile.toPath(), | ||
| "reader.GetString()", | ||
| "writer.WriteStringValue(", | ||
| ": long", | ||
| ": byte" | ||
| ); | ||
|
|
||
| // Verify long enum uses int64 reader with validation and actual int64 values | ||
| File longEnumFile = files.get(Paths | ||
| .get(output.getAbsolutePath(), "src", "Org.OpenAPITools", "Model", "LongEnum.cs") | ||
| .toString() | ||
| ); | ||
| assertNotNull(longEnumFile, "Could not find file for model: LongEnum"); | ||
| assertFileContains(longEnumFile.toPath(), | ||
| "enum LongEnum : long", | ||
| "reader.GetInt64().ToString()", | ||
| "FromStringOrDefault(rawValue)", | ||
| "throw new JsonException()", | ||
| "writer.WriteNumberValue(", | ||
| "public static long ToJsonValue(LongEnum value)", | ||
| "AboveInt32Max = 2147483648", | ||
| "Int64Max = 9223372036854775807" | ||
| ); | ||
| assertFileNotContains(longEnumFile.toPath(), | ||
| "reader.GetString()", | ||
| "writer.WriteStringValue(" | ||
| ); | ||
|
|
||
| // Verify double enum reads numeric value and converts to string for matching, writes as number | ||
| File doubleEnumFile = files.get(Paths | ||
| .get(output.getAbsolutePath(), "src", "Org.OpenAPITools", "Model", "DoubleEnum.cs") | ||
| .toString() | ||
| ); | ||
| assertNotNull(doubleEnumFile, "Could not find file for model: DoubleEnum"); | ||
| assertFileContains(doubleEnumFile.toPath(), | ||
| "reader.GetDouble().ToString()", | ||
| "writer.WriteNumberValue(", | ||
| "public static double ToJsonValue(DoubleEnum value)", | ||
| "return 1.1d;", | ||
| "return -1.2d;" | ||
| ); | ||
| assertFileNotContains(doubleEnumFile.toPath(), | ||
| "reader.GetString()", | ||
| "writer.WriteStringValue(", | ||
| "return (double) value" | ||
| ); | ||
|
Comment on lines
282
to
339
Owner
There was a problem hiding this comment. @copilot test the datatype of the generated enum as well. Long and byte should have |
||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| openapi: 3.0.1 | ||
| info: | ||
| title: Integer Enum Test | ||
| version: v1 | ||
| paths: | ||
| /some/api: | ||
| get: | ||
| tags: | ||
| - Example | ||
| operationId: ExampleApi | ||
| responses: | ||
| '200': | ||
| description: OK | ||
| content: | ||
| application/json: | ||
| schema: | ||
| $ref: '#/components/schemas/IntegerEnum' | ||
| components: | ||
| schemas: | ||
| IntegerEnum: | ||
| enum: | ||
| - 0 | ||
| - 1 | ||
| type: integer | ||
| format: int32 | ||
| x-enum-varnames: | ||
| - None | ||
| - Some | ||
| LongEnum: | ||
| enum: | ||
| - 2147483648 | ||
| - 9223372036854775807 | ||
| type: integer | ||
| format: int64 | ||
| x-enum-varnames: | ||
| - AboveInt32Max | ||
| - Int64Max | ||
| DoubleEnum: | ||
| enum: | ||
| - 1.1 | ||
| - -1.2 | ||
| type: number | ||
| format: double |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@copilot
In
@tools/openapi/templates/csharp/modelEnum.mustachearound lines 277 - 288,The NullableJsonConverter.Read implementation for string-backed enums should
detect a JSON null token before calling reader.GetString and return null rather
than throwing; update the isString branch in the NullableJsonConverter.Read
method to check reader.TokenType == JsonTokenType.Null (or check rawValue ==
null immediately after GetString) and return null when appropriate, then only
call ValueConverter.FromStringOrDefault(rawValue) for non-null rawValue so that
deserializing JSON null yields a null nullable enum instead of raising
JsonException.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed in
383ea387. TheJsonTokenType.Nullcheck is now applied to ALL enum types (including string) in the nullable converter Read method. Previously it was gated behind{{^isString}}, so string enums would fall through toreader.GetString()and then throwJsonExceptionwhen the result was null. Now it returnsnullimmediately for null tokens.