[TS][Angular] Avoid strictNullChecks errors for apiKeys by grktsh · Pull Request #1611 · OpenAPITools/openapi-generator

grktsh · 2018-12-04T13:17:37Z

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 and ./bin/security/{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\.
Filed the PR against the correct branch: master~~, 3.4.x, 4.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

I'd like to add this.configuration.apiKeys && to the following conditions to avoid strictNullChecks errors for apiKeys:

from typescript-angular/api.service.mustache@master

{{#isKeyInHeader}}
if (this.configuration.apiKeys["{{keyParamName}}"]) {

from typescript-inversify/api.service.mustache@master

{{#isKeyInHeader}}
if (this.APIConfiguration.apiKeys["{{keyParamName}}"]) {

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

fixOpenAPITools#1607

- ./bin/typescript-angular-petstore-all.sh - ./bin/typescript-inversify-petstore.sh

- ./bin/security/typescript-angular.sh - ./bin/security/typescript-angular2.sh - ./bin/security/typescript-inversify.sh

macjohnny

looks good to me

macjohnny · 2018-12-04T13:27:58Z

- public testCodeInjectEndRnNR(testCodeInjectEndRnNR?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<any>>;
- public testCodeInjectEndRnNR(testCodeInjectEndRnNR?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<any>>;
- public testCodeInjectEndRnNR(testCodeInjectEndRnNR?: string, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {
+ public testCodeInjectEndRnNR(UNKNOWN_BASE_TYPE?: UNKNOWN_BASE_TYPE, observe?: 'body', reportProgress?: boolean): Observable<any>;


any idea why UNKNOWN_BASE_TYPE occurs here?

./bin/security/typescript-angular.sh had warned:
[main] WARN o.o.codegen.DefaultCodegen - The following schema has undefined (null) baseType. It could be due to form parameter defined in OpenAPI v2 spec with incorrect consumes. A correct 'consumes' for form parameters should be 'application/x-www-form-urlencoded' or 'mul tipart/form-data'
And I changed modules/openapi-generator/src/test/resources/2_0/petstore-security-test.yaml:
consumes: - - application/json- - "*/ ' \" =end -- \r\n \n \r"+ - application/x-www-form-urlencoded
But invalid identifier was generated:
- public testCodeInjectEndRnNR(UNKNOWN_BASE_TYPE?: UNKNOWN_BASE_TYPE, observe?: 'body', reportProgress?: boolean): Observable<any>;- public testCodeInjectEndRnNR(UNKNOWN_BASE_TYPE?: UNKNOWN_BASE_TYPE, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<any>>;- public testCodeInjectEndRnNR(UNKNOWN_BASE_TYPE?: UNKNOWN_BASE_TYPE, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<any>>;- public testCodeInjectEndRnNR(UNKNOWN_BASE_TYPE?: UNKNOWN_BASE_TYPE, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {+ public testCodeInjectEndRnNR(testCodeInject*#39;"=endRnNR?: string, observe?: 'body', reportProgress?: boolean): Observable<any>;+ public testCodeInjectEndRnNR(testCodeInject*'"=endRnNR?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<any>>;+ public testCodeInjectEndRnNR(testCodeInject*'"=endRnNR?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<any>>;+ public testCodeInjectEndRnNR(testCodeInject*'"=endRnNR?: string, observe: any = 'body', reportProgress: boolean = false ): Observable<any> {

I think AbstractTypeScriptClientCodegen#toParamName is broken:
- name = sanitizeName(name, "\\W-[\\$]");+ name = sanitizeName(name, "[^\\w$]");

@grktsh can you include this fix, too?

@macjohnny I will!

@macjohnny Done. Could you review again?

"*/ ' \" =end -- \r\n \n \r" is for detecting code injection (malicious input in consumes). I'll add it back with a separate PR.

Done via d57009d

wing328 · 2018-12-06T09:11:52Z

@grktsh @macjohnny Do we need the similar fix for other TS generators? (this is not to say either one of you will need to submit the fix or own the issue. Just want to know if other TS generators have a similar bug)

grktsh · 2018-12-06T11:52:23Z

@wing328 For sanitization, I think there is no need to do it because this fixes AbstractTypeScriptClientCodegen of #694. For strictNullChecks errors, I don't know...

wing328 · 2019-01-02T07:34:19Z

@grktsh thanks for the contribution, which has been included in the 4.0.0-beta release: https://twitter.com/oas_generator/status/1079727020374806529.

Happy New Year and looking forward to more collaboration and contributions in 2019!

…#1611) * [typescript] Avoid strictNullChecks errors for apiKeys fixOpenAPITools#1607 * Run ./bin/{LANG}-petstore.sh - ./bin/typescript-angular-petstore-all.sh - ./bin/typescript-inversify-petstore.sh * Run ./bin/security/{LANG}-petstore.sh - ./bin/security/typescript-angular.sh - ./bin/security/typescript-angular2.sh - ./bin/security/typescript-inversify.sh * [typescript] Fix parameter name sanitization * Fix invalid consumes of petstore-security-test.yaml * Run ./bin/security/typescript-*.sh

grktsh added 3 commits December 4, 2018 21:43

[typescript] Avoid strictNullChecks errors for apiKeys
453549d
fixOpenAPITools#1607

Run ./bin/{LANG}-petstore.sh
dbd4f4b
- ./bin/typescript-angular-petstore-all.sh - ./bin/typescript-inversify-petstore.sh

Run ./bin/security/{LANG}-petstore.sh
9a3f35e
- ./bin/security/typescript-angular.sh - ./bin/security/typescript-angular2.sh - ./bin/security/typescript-inversify.sh

macjohnny approved these changes Dec 4, 2018
View reviewed changes

grktsh added 3 commits December 5, 2018 10:29

[typescript] Fix parameter name sanitization
df5ccd6

Fix invalid consumes of petstore-security-test.yaml
170cd9d

Run ./bin/security/typescript-*.sh
28b06ff

grktsh force-pushed the null-check-api-keys branch from 50dc4f2 to 28b06ffCompare December 5, 2018 02:26

macjohnny approved these changes Dec 5, 2018
View reviewed changes

wing328 merged commit ced6e05 into OpenAPITools:masterDec 6, 2018

wing328 added Client: TypeScript Issue: Bug labels Dec 6, 2018

wing328 added this to the 4.0.0 milestone Dec 6, 2018

wing328 changed the title ~~[typescript] Avoid strictNullChecks errors for apiKeys~~ [TS][Angular] Avoid strictNullChecks errors for apiKeysDec 6, 2018

grktsh deleted the null-check-api-keys branch December 6, 2018 11:31

chncaption mentioned this pull request May 7, 2024
[Snyk] Upgrade node-fetch from 3.2.0 to 3.3.2 chncaption/openapi-generator#391
Open

Navigation Menu

Uh oh!

Uh oh!

[TS][Angular] Avoid strictNullChecks errors for apiKeys - #1611

[TS][Angular] Avoid strictNullChecks errors for apiKeys#1611
wing328 merged 6 commits into
OpenAPITools:masterfrom
grktsh:null-check-api-keys

grktsh commented Dec 4, 2018

Uh oh!

macjohnny left a comment

Uh oh!

macjohnnyDec 4, 2018

Uh oh!

grktshDec 4, 2018

Uh oh!

grktshDec 4, 2018

Uh oh!

macjohnnyDec 4, 2018

Uh oh!

grktshDec 5, 2018

Uh oh!

grktshDec 5, 2018

Uh oh!

wing328Dec 6, 2018

Uh oh!

wing328Dec 6, 2018

Uh oh!

wing328 commented Dec 6, 2018

Uh oh!

grktsh commented Dec 6, 2018

Uh oh!

wing328 commented Jan 2, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Uh oh!

Conversation

grktsh commented Dec 4, 2018

PR checklist

Description of the PR

Uh oh!

macjohnny left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wing328 commented Dec 6, 2018

Uh oh!

grktsh commented Dec 6, 2018

Uh oh!

wing328 commented Jan 2, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants