Skip to content

Conversation

@jakobw
Copy link
Contributor

@jakobw jakobw commented Mar 4, 2025

Prior to this commit, a JS client generated with skipDefaultUserAgent enabled results in a src/ApiClient.js file that doesn't define this.defaultHeaders. This breaks because this.defaultHeaders is later directly passed to a superagent request which expects an object and not undefined.

Fixes #20791.

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 || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (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.

Ping for NodeJS/Javascript technical committee members as suggested in the checklist: @CodeNinjai, @frol, @cliffano.

Prior to this commit, a JS client generated with skipDefaultUserAgent
enabled results in a src/ApiClient.js file that doesn't define
this.defaultHeaders. This breaks because this.defaultHeaders is later
directly passed to a superagent request which expects an object and not
undefined.

Fixes #20791.
@jakobw jakobw closed this Mar 5, 2025
@jakobw jakobw deleted the js-fix-skipDefaultUserAgent branch March 5, 2025 08:51
@jakobw jakobw restored the js-fix-skipDefaultUserAgent branch March 5, 2025 08:52
@jakobw jakobw reopened this Mar 5, 2025
@wing328 wing328 added this to the 7.13.0 milestone Mar 5, 2025
@wing328
Copy link
Member

wing328 commented Mar 5, 2025

looks good to me

will merge after tests pass

thanks for the fix

@jakobw
Copy link
Contributor Author

jakobw commented Mar 5, 2025

@wing328 Great, thanks! The two CircleCI checks that are still listed under "pending" here seem to have passed 13h ago if I click into the job details. Not sure what's going on there.

@wing328 wing328 merged commit efc53f5 into OpenAPITools:master Mar 5, 2025
14 of 16 checks passed
@wing328
Copy link
Member

wing328 commented Mar 5, 2025

agreed this pr is good to merge which i just did

thanks again for the quick fix

@jakobw jakobw deleted the js-fix-skipDefaultUserAgent branch March 5, 2025 09:51
kpy3 pushed a commit to kpy3/openapi-generator that referenced this pull request Mar 13, 2025
OpenAPITools#20792)

Prior to this commit, a JS client generated with skipDefaultUserAgent
enabled results in a src/ApiClient.js file that doesn't define
this.defaultHeaders. This breaks because this.defaultHeaders is later
directly passed to a superagent request which expects an object and not
undefined.

Fixes OpenAPITools#20791.
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.

[BUG][JavaScript] Default headers are undefined when skipDefaultUserAgent is used

2 participants