[typescript] Fix uncompilable output when using allOf (#8000)#9275
Merged
macjohnny merged 1 commit intoOpenAPITools:masterfrom Jun 4, 2021
Merged
[typescript] Fix uncompilable output when using allOf (#8000)#9275macjohnny merged 1 commit intoOpenAPITools:masterfrom
macjohnny merged 1 commit intoOpenAPITools:masterfrom
Conversation
`toModelImportMap` only accounts for union types and not intersection types, so I've combined those cases into `splitComposedType`. For `splitComposedType` I combined `replace(" ","").split("\\|")` and `split("( [|&] )|[<>]")` into `replace(" ","").split("[|&<>]")`.
I've added the `needToImport` check to `toModelImportMap`. This is the same check that happens in `addImport`.
Contributor
Author
|
Hey, just a gentle bump. If anyone has a few minutes to check this out I would greatly appreciate it. |
amakhrov
reviewed
Jun 4, 2021
|
|
||
| /* | ||
| #8000 | ||
| Test that primatives are not returned by toModelImportMap |
Contributor
There was a problem hiding this comment.
the comment is a bit too narrow - the actual test not only verifies that, but also checks that intersection/union type imports are properly handled in general. maybe reword this somehow?
amakhrov
approved these changes
Jun 4, 2021
Contributor
amakhrov
left a comment
There was a problem hiding this comment.
Thanks for your contribution! The fix looks good to me.
tiagoblackcode
added a commit
to tiagoblackcode/openapi-generator
that referenced
this pull request
Oct 27, 2021
…client The `AbstractTypeScriptClientCodegen` is very similar to the `TypeScriptClientCodegen`. However, they have been kept separate and some fixes brought to the former are not present on the latter. This change makes `TypescriptClientCodegen` extend from `AbstractTypeScriptClientCodegen` to re-use most of the common logic. Similar methods and CLI options were removed from `TypescriptClientCodegen`. The `NPM_REPOSITORY` flag was kept in the typescript client, although it might be sensible to move it to the abstract client and make other typescript-based generators benefit from it. In particular, this change fixes the issue OpenAPITools#8000 for the `typescript` generator which was merged by OpenAPITools#9275.
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.
Fixes #8000
Summary
When using
allOf, oroneOfwith an inline schema, a Union/Intersection type is generated with the primitiveobject. This results in an invalid import because the composed type of the schema is ignored.Approach
To fix this I used
needToImportto removes the language primitives from being imported. This same check already happens inaddImport, but not intoModelImportMap.toModelImportMapsplits union types but not intersection types, so I've combined those cases intosplitComposedType. ForsplitComposedTypeI combinedreplace(" ","").split("\\|")andsplit("( [|&] )|[<>]")intoreplace(" ","").split("[|&<>]"). These should be equivilant regex, and I think stripping the whitespace is good here.I added the warning in
toModelImportstrictly because there was already a warning for the union type and wanted to be consistent.Minimal Reproducible Example
PR checklist
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*.For Windows users, please run the script in Git BASH.
master,5.1.x,6.0.x@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)