Skip to content

[typescript][fetch] Fix null typing errors - #3919

Merged
macjohnny merged 3 commits into
OpenAPITools:masterfrom
allejo:ts-fix-null-typing
Sep 20, 2019
Merged

[typescript][fetch] Fix null typing errors#3919
macjohnny merged 3 commits into
OpenAPITools:masterfrom
allejo:ts-fix-null-typing

Conversation

@allejo

@allejoallejo commented Sep 20, 2019

Copy link
Copy Markdown
Contributor

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

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

After PR

exportfunctionModelToJSON(value?: Model|null): any{if(value===undefined){returnundefined;}if(value===null){returnnull;}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)

@macjohnnymacjohnny left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@macjohnnymacjohnny added this to the 4.1.3 milestone Sep 20, 2019
@macjohnny
macjohnny merged commit b793a95 into OpenAPITools:masterSep 20, 2019
@allejo
allejo deleted the ts-fix-null-typing branch September 20, 2019 15:13
@wing328

Copy link
Copy Markdown
Member

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

@allejo@wing328@macjohnny