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

[FIX][typescript-fetch] Fix duplicate imports for models with a discriminator #19195

Merged

Conversation

Digirik
Copy link
Contributor

@Digirik Digirik commented Jul 18, 2024

This PR will Fix Issue#15636 by continuing stale PR#15638.

After generating the client some imports where duplicated and the generated files with a discriminator have a self import.

Examining the problem further lead me to the conclusion that when the legacyDiscriminatorBehaviour isn't set the DefaultCodegen will add the MappedModels of the discriminator to the imports. As both imports and mappedModels are specified in the mustache file the import will be duplicated.
The import for the discriminators can't be removed from the mustache file as that would break the generator when legacyDiscriminatorBehaviour is set. Thus I opted for filtering out the mappedModels that are already included in the imports.

I might have formatted the changes poorly, I'd be glad if one of the maintainers could format over it.

@TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @topce (2018/10) @akehir (2019/07) @petejohansonxo (2019/11) @amakhrov (2020/02) @davidgamero (2022/03) @mkusaka (2022/04)

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.

@Digirik
Copy link
Contributor Author

Digirik commented Jul 18, 2024

I just noticed that in the generated AbstractUserDto.ts the AbstractUserDtoFromJSONTyped method is incomplete now. I'm off to fix that.

@Digirik
Copy link
Contributor Author

Digirik commented Jul 18, 2024

Okay, so I have now filtered the imports instead of the MappedModels of the discriminator so the *fromJSONTyped is properly created again.

I'm not too versed in typescript, so I'm not sure if I'm right /the other imports are needed, but this now also gets rid of most of the unused imports in the base type.

@macjohnny macjohnny merged commit aaf3ea2 into OpenAPITools:master Jul 18, 2024
15 checks passed
@macjohnny
Copy link
Member

@Digirik thanks for your contribution!

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

[BUG][typescript-fetch] duplicate imports for models with a discriminator
4 participants