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] Fix null typing errors #3919

Merged
merged 3 commits into from Sep 20, 2019

Conversation

@allejo
Copy link
Contributor

allejo commented Sep 20, 2019

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\. If contributing template-only or documentation-only changes which will change sample output, be sure to build the project first.
  • Filed the PR against the correct branch: master, 4.1.x, 5.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

The current typescript-fetch template generates some invalid Typescript where the typing for the function is either undefined or the model. However, in the other generated code it can also be null and the function itself is generating a null check.

Additionally, for each nullable entity in the return statement, checking against == null will essentially check for both undefined and null since in JS, null == undefined is true.

Current

export function ModelToJSON(value?: Model): any {
    if (value === undefined) {
        return undefined;
    }
    if (value === null) {
        return null;
    }
    return {
        
        'primitive_value': value.primitiveValue,
        'nullable_date': value.nullableDate === undefined ? undefined : value.nullableDate.toISOString(),
        'regular_date': value.regularDate.toISOString(),
    }
}

After PR

export function ModelToJSON(value?: Model | null): any {
    if (value === undefined) {
        return undefined;
    }
    if (value === null) {
        return null;
    }
    return {
        
        'primitive_value': value.primitiveValue,
        'nullable_date': value.nullableDate == null ? undefined : value.nullableDate.toISOString(),
        'regular_date': value.regularDate.toISOString(),
    }
}

Additionally, the indentation of a generated comment is wrong, so that fix is included in here as well.

I don't currently have a Java dev environment setup on my computer but I've tested these template changes through the -t flag and would appreciate any early feedback while I get Java set up to check that last box.

@TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @nicokoenig (2018/09) @topce (2018/10) @akehir (2019/07)

allejo and others added 3 commits Sep 20, 2019
Copy link
Contributor

macjohnny left a comment

LGTM

@macjohnny macjohnny added this to the 4.1.3 milestone Sep 20, 2019
@macjohnny macjohnny merged commit b793a95 into OpenAPITools:master Sep 20, 2019
5 checks passed
5 checks passed
Shippable Run 10660 status is SUCCESS.
Details
ci/circleci Your tests passed on CircleCI!
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/drone/pr Build is passing
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@allejo allejo deleted the allejo:ts-fix-null-typing branch Sep 20, 2019
@wing328

This comment has been minimized.

Copy link
Member

wing328 commented Oct 4, 2019

@allejo thanks for the PR, which has been included in the v4.1.3 release: https://twitter.com/oas_generator/status/1180123829626003456

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.