Skip to content
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.

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

[typescript-fetch] Fix code generation for oneOf cases without discriminator #19219

Merged
merged 3 commits into from
Jul 23, 2024

Conversation

odiak
Copy link
Contributor

@odiak odiak commented Jul 22, 2024

TL;DR

  • Fix type error on generated model code using oneOf without discriminator.
  • Add a sample case to verify this fix.

Detail

I improved code generation for model with oneOf without discriminator on #18702.
But later I found generated code cause type error. (But there is no problem on runtime.)
ref: comment

The cause of the problem is lack of return statement at the end of functions like MyModelFromJSONTyped.
So I added return json at the end of these functions.

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 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    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.6.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@odiak
Copy link
Contributor Author

odiak commented Jul 22, 2024

Dear technical committee members of TypeScript, could you check this? 🙇
@TiFu @taxpon @sebastianhaas @kenisteward @Vrolijkx @macjohnny @topce @akehir @petejohansonxo @amakhrov @davidgamero @mkusaka

@@ -36,6 +36,8 @@ export function {{classname}}FromJSONTyped(json: any, ignoreDiscriminator: boole
return {{{.}}}FromJSONTyped(json, true);
}
{{/oneOf}}

return json;
Copy link
Contributor

Choose a reason for hiding this comment

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

thought (non-blocking):
Here, the fallback case returns the raw json. But a similar fallback in the xxxToJSON (below) returns {}.

I don't think it makes a huge practical difference (if this happens for real, one should go and fix the code to be compatible with the spec, instead of finding smart ways around it).

Just looks a bit inconsistent.

Copy link
Contributor Author

@odiak odiak Jul 23, 2024

Choose a reason for hiding this comment

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

Indeed. I change it to return {} as any.

(I needed to add type-assertion because {} is not compatible with the return type.
Since json is also any, there is no big difference.)

Copy link
Contributor

@amakhrov amakhrov left a comment

Choose a reason for hiding this comment

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

Thanks @odiak - looks good to me!

@macjohnny macjohnny merged commit fef84d9 into OpenAPITools:master Jul 23, 2024
15 checks passed
@odiak odiak deleted the fix-typescript-fetch-oneof branch July 23, 2024 07:56
@wing328 wing328 added this to the 7.8.0 milestone Aug 18, 2024
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.

4 participants