Skip to content

Warning log when an enum value cannot be parsed#23447

Open
Mattias-Sehlstedt wants to merge 1 commit intoOpenAPITools:masterfrom
Mattias-Sehlstedt:warning-log-when-enum-value-is-null
Open

Warning log when an enum value cannot be parsed#23447
Mattias-Sehlstedt wants to merge 1 commit intoOpenAPITools:masterfrom
Mattias-Sehlstedt:warning-log-when-enum-value-is-null

Conversation

@Mattias-Sehlstedt
Copy link
Copy Markdown
Contributor

@Mattias-Sehlstedt Mattias-Sehlstedt commented Apr 3, 2026

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

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    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.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

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.

  • Bug Fixes
    • Skip null values in numericEnumValuesToEnumTypeUnion and log a warning instead of calling toString.
    • Applies to AbstractTypeScriptClientCodegen and N4jsClientCodegen; avoids NPEs with schemas that include negative enums (e.g., TypeScriptAxios test).

Written for commit 48f464a. Summary will update on new commits.

Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant