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] Make instanceOf infer type and check for undefineds #18694

Merged

Conversation

rickyrombo
Copy link
Contributor

@rickyrombo rickyrombo commented May 17, 2024

Fixes #18059

  • Makes the instanceOf check infer the type of the parameter
  • Adds undefined check for required fields in instanceOf

Prior to this fix, doing a fetch and then a toJSON on that fetched model would return unexpected results in oneOf models without a discriminator, as the oneOf model spreads all possible values resulting in keys for each of the oneOf types existing, but being undefined. Thus the toJSON would return true for instanceOf the first oneOf type despite the required fields being undefined.

Per instructions, tagging Typescript technical committee members:
@TiFu @taxpon @sebastianhaas @kenisteward @Vrolijkx @macjohnny @topce @akehir @petejohansonxo @amakhrov @davidgamero @mkusaka

First time contributor, please let me know if I made any blunders or if any additional info needed.

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.1.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.

Copy link
Member

@macjohnny macjohnny left a comment

Choose a reason for hiding this comment

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

LGTM

thanks for your contribution!

@macjohnny macjohnny merged commit 62238c6 into OpenAPITools:master May 17, 2024
14 checks passed
@wing328 wing328 added this to the 7.6.0 milestone May 20, 2024
@rickyrombo rickyrombo deleted the typescript-fetch-fix-instanceOf branch May 21, 2024 18:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[REQ] typescript-fetch-generator: Add helper function which returns an instance of an "oneOf"
3 participants