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] Fix uncompilable output when using allOf (#8000) #9275

Merged
merged 1 commit into from
Jun 4, 2021

Conversation

ralphpig
Copy link
Contributor

Fixes #8000

Summary

When using allOf, or oneOf with an inline schema, a Union/Intersection type is generated with the primitive object. This results in an invalid import because the composed type of the schema is ignored.

import { BaseObject & object }

Approach

To fix this I used needToImport to removes the language primitives from being imported. This same check already happens in addImport, but not in toModelImportMap.

toModelImportMap splits union types but not intersection types, so I've combined those cases into splitComposedType. For splitComposedType I combined replace(" ","").split("\\|") and split("( [|&] )|[<>]") into replace(" ","").split("[|&<>]"). These should be equivilant regex, and I think stripping the whitespace is good here.

I added the warning in toModelImport strictly because there was already a warning for the union type and wanted to be consistent.

Minimal Reproducible Example

-g typescript-axios --additional-properties=withSeparateModelsAndApi=true,apiPackage=api,modelPackage=models
openapi: 3.0.3

info:
  title: Issue 8000
  version: 1.0.0
  description: Issue 8000 Minimal Reproducible Example

paths:
  /resource:
    get:
      operationId: get_resource
      responses:
        200:
          description: resource
          content:
            application/json:
              schema:
                type: object
                allOf:
                  - $ref: '#/components/schemas/BaseObject'
                  - type: object
                    properties:
                      field:
                        type: string

components:
  schemas:
    BaseObject:
      type: object
      properties:
        id:
          type: integer

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/utils/export_docs_generators.sh
    
    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*.
    For Windows users, please run the script in Git BASH.
    • No changes
  • File the PR against the correct branch: master, 5.1.x, 6.0.x
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

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

`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`.
@ralphpig ralphpig changed the title [typescript] Insure imports are checked by needToImport [typescript] Ensure imports are checked by needToImport Apr 16, 2021
@ralphpig ralphpig changed the title [typescript] Ensure imports are checked by needToImport [typescript] Fix uncompilable output when using allOf (#8000) Jun 4, 2021
@ralphpig
Copy link
Contributor Author

ralphpig commented Jun 4, 2021

Hey, just a gentle bump. If anyone has a few minutes to check this out I would greatly appreciate it.


/*
#8000
Test that primatives are not returned by toModelImportMap
Copy link
Contributor

Choose a reason for hiding this comment

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

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?

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 for your contribution! The fix looks good to me.

@macjohnny macjohnny merged commit c5fefa9 into OpenAPITools:master Jun 4, 2021
@macjohnny macjohnny added this to the 5.2.0 milestone Jun 4, 2021
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.
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.

[BUG] [typescript-angular] AllOf hierarchy produces api that doesn't compile
3 participants