Warning log when an enum value cannot be parsed#23447
Open
Mattias-Sehlstedt wants to merge 1 commit intoOpenAPITools:masterfrom
Open
Warning log when an enum value cannot be parsed#23447Mattias-Sehlstedt wants to merge 1 commit intoOpenAPITools:masterfrom
Mattias-Sehlstedt wants to merge 1 commit intoOpenAPITools:masterfrom
Conversation
Contributor
There was a problem hiding this comment.
1 issue found across 2 files
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/N4jsClientCodegen.java">
<violation number="1" location="modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/N4jsClientCodegen.java:598">
P2: Skipping null numeric enum values can leave `stringValues` empty, causing `enumValuesToEnumTypeUnion` to return an empty string and generate an invalid/empty enum type when all values are null. Add a fallback when the list is empty.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
...es/openapi-generator/src/main/java/org/openapitools/codegen/languages/N4jsClientCodegen.java
Show resolved
Hide resolved
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I face issues back and forth with how negative enums are treated. The cause of it is due to my locale, and the exact cause is described here. A recent PR made so that a TypeScriptAxios test references a schema with a negative enum, which means that a developer with a "bad locale" will have an unexpected nullpointer when running the tests.
This PR changes so that this case is handled with a warning log and that processing continues, as per the behavior of most other enum interpreters. This change makes it so someone encountering this issue is less like to suffer from it and makes it clearer to them why it is occurring.
PR checklist
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)"fixes #123"present in the PR description)Summary by cubic
Log a warning and continue when a numeric enum value is null to prevent crashes caused by locale-specific parsing of negative enums. This stabilizes TypeScript and N4JS client generation and avoids unexpected NPEs in tests.
numericEnumValuesToEnumTypeUnionand log a warning instead of callingtoString.AbstractTypeScriptClientCodegenandN4jsClientCodegen; avoids NPEs with schemas that include negative enums (e.g., TypeScriptAxios test).Written for commit 48f464a. Summary will update on new commits.