Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

[JS] add parameter 'useURLSearchParams' to use JS build-in UrlSearchParams, instead of deprecated npm lib 'querystring' #19949

Merged
merged 1 commit into from
Oct 31, 2024

Conversation

tobifb
Copy link
Contributor

@tobifb tobifb commented Oct 22, 2024

Fixes #19947

  • Added a new parameter 'useURLSearchParams' to the JavaScript Client Codegen
  • If set to true, the deprecated npm 'querystring' is not generated anymore in the javascript code. Instead we use UrlSearchParams, which is a built-in function of javascript.
  • If set to false, the old behavior is still generated.
  • Default value is 'false'

Additional tests:

  • manual testing with openapi-generator-cli additional properties and configuration file

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.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    Commit all changed files.
    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*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@CodeNinjai @frol @cliffano

…, instead of deprecated npm lib 'querystring'
@wing328
Copy link
Member

wing328 commented Oct 23, 2024

@tobifb thanks for the PR

what about simply replacing the deprecated lib without an option?

from what I understand, this is not a breaking change (even without the option)

@wing328
Copy link
Member

wing328 commented Oct 31, 2024

tested the option with updated samples via #20002

and the result is good

i'll file another PR to make this option enabled by default

thanks again for the PR

@wing328 wing328 added Client: JavaScript/Node.js Enhancement: Code Cleanup General refactoring, removal of deprecated things, commenting, etc. labels Oct 31, 2024
@wing328 wing328 added this to the 7.10.0 milestone Oct 31, 2024
@wing328 wing328 merged commit ae4e251 into OpenAPITools:master Oct 31, 2024
14 of 15 checks passed
@wing328
Copy link
Member

wing328 commented Oct 31, 2024

To fallback, set useURLSearchParams to false, e.g. --additional-properties useURLSearchParams=true in the CLI

@wing328 wing328 changed the title [#19947] add parameter 'useURLSearchParams' to use JS build-in UrlSearchParams, instead of deprecated npm lib 'querystring' [JS] add parameter 'useURLSearchParams' to use JS build-in UrlSearchParams, instead of deprecated npm lib 'querystring' Oct 31, 2024
@tobifb
Copy link
Contributor Author

tobifb commented Nov 5, 2024

Sorry for the late reply. Thanks for the changes!

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
Breaking change (with fallback) Client: JavaScript/Node.js Enhancement: Code Cleanup General refactoring, removal of deprecated things, commenting, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[REQ] [JavascriptClientCodegen] Deprecated npm lib 'querystring'
2 participants