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 empty URLSearchParams request body #4103

Merged
merged 3 commits into from
Oct 9, 2019

Conversation

tkrtmy
Copy link
Contributor

@tkrtmy tkrtmy commented Oct 9, 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

This pull-request is correction patch for #3934 . (related to #3920 )
URLSearchParams body is converted empty JSON Object by JSON.stringify since missing check.

Technical Committee

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

@@ -49,7 +49,7 @@ export class BaseAPI {
// do not handle correctly sometimes.
url += '?' + this.configuration.queryParamsStringify(context.query);
}
const body = (context.body instanceof FormData || isBlob(context.body))
const body = (context.body instanceof FormData || context.body instanceof URLSearchParams || isBlob(context.body))
? context.body
: JSON.stringify(context.body);
Copy link
Contributor Author

Choose a reason for hiding this comment

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

URLSearchParams has fallen this line

> console.log(JSON.stringify(new URLSearchParams('hoge=fuga&piyo=piyopiyo')));
{}

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

@tkrtmy
Copy link
Contributor Author

tkrtmy commented Oct 9, 2019

CI failed... It works well at local...
I wonder if I should add URLSearchParams to globals?

--- samples/client/petstore/typescript-fetch/tests/default/mocks.ts
+++ samples/client/petstore/typescript-fetch/tests/default/mocks.ts
@@ -1,5 +1,7 @@
 import * as FormData from 'form-data';
+import { URLSearchParams } from 'url';
 
 const globals = global as any;
 
 globals.FormData = FormData;
+globals.URLSearchParams = URLSearchParams;

@macjohnny
Copy link
Member

sounds reasonable

@macjohnny macjohnny added this to the 4.2.0 milestone Oct 9, 2019
@macjohnny macjohnny merged commit 4e47426 into OpenAPITools:master Oct 9, 2019
@tkrtmy tkrtmy deleted the fix_empty_request_body branch October 9, 2019 08:16
@wing328
Copy link
Member

wing328 commented Oct 31, 2019

@tkrtmy thanks for the PR, which has been included in v4.2.0 release: https://twitter.com/oas_generator/status/1189824932345069569

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