Skip to content

[typescript-fetch] Allow to generate client without runtime checks#7894

Merged
macjohnny merged 4 commits intoOpenAPITools:masterfrom
acote-coveo:feature/typescript-fetch-fix-union-types
Nov 16, 2020
Merged

[typescript-fetch] Allow to generate client without runtime checks#7894
macjohnny merged 4 commits intoOpenAPITools:masterfrom
acote-coveo:feature/typescript-fetch-fix-union-types

Conversation

@acote-coveo
Copy link
Contributor

@acote-coveo acote-coveo commented Nov 6, 2020

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.
  • If contributing template-only or documentation-only changes which will change sample output, build the project beforehand.
  • Run the shell script ./bin/generate-samples.shto update all Petstore samples related to your fix. 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.
  • File the PR against the correct branch: master
  • Copy the technical committee to review the pull request if your PR is targeting a particular programming language.

I tried to use the typescript-fetch client with a spec that use union and saw that the types were good but the serialization/deserialization wasn't working pretty well.

The main problems are:

  • Lack of information about oneOf (it only contains a list of data types. A datatype can be OneType or Array<Type1 | Type2 | string | boolean>)
  • Difficulty to implement imports due to the nested levels of typing.

Example of what was badly generated

Below, we have a list of oneOf data types to map. Thus, to serialize them, we call dataType[ToJson]. We then end up with something like boolean | AdvancedGenerateQueryFieldParameter ToJson

export function ToIncludeParametersToJSON(value?: ToIncludeParameters | null): any {
    if (value === undefined) {
        return undefined;
    }
    if (value === null) {
        return null;
    }
    return {
        
        'fields': value.fields === undefined ? undefined : ((value.fields as Array<any>).map(string | AdvancedQueryFieldParametersToJSON)),
        'summary': boolean | AdvancedGeneratedQueryFieldParameterToJSON(value.summary),
        'excerpt': boolean | AdvancedGeneratedQueryFieldParameterToJSON(value.excerpt),
        'highlighting': HighlightingSettingsToJSON(value.highlighting),
    };
}

Simple solution

A bit like what has been done with the Axios client,I added a flag that allows to generate a client without any runtime checks.

So we simplify the client to only generate the interfaces and cast the input/output to these.
For a small effort, we now are able to have a simple client that compiles.

On a subsequent pull request, I would like to address the problem of unions by also providing serialization/deserialization (runtime checks).

@acote-coveo
Copy link
Contributor Author

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

@acote-coveo acote-coveo changed the title [Typescript-fetch] Allow to generate client without runtime checks [typescript-fetch] Allow to generate client without runtime checks Nov 6, 2020
@acote-coveo
Copy link
Contributor Author

If anyone can tell me if that's normal but the Java11 tests failed on drone and I can't see the results for circle ci

- Generates all the models in a same file to avoid import complexity
- Extract interfaces creator templates to reuse them
@acote-coveo acote-coveo force-pushed the feature/typescript-fetch-fix-union-types branch from a81ba2b to 20b2f15 Compare November 10, 2020 18:20
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

@macjohnny macjohnny added this to the 5.0.0 milestone Nov 16, 2020
@macjohnny macjohnny merged commit 36aba26 into OpenAPITools:master Nov 16, 2020
@macjohnny
Copy link
Member

@acote-coveo thanks for your contribution

@ffMathy
Copy link
Contributor

ffMathy commented Feb 23, 2021

This doesn't work for me. Has it regressed?

@macjohnny
Copy link
Member

@ffMathy did you set the withoutRuntimeChecks option?

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.

3 participants

Comments