[typescript-nestjs] Use paramName for URL path substitution (fixes #16668)#23868
Open
reichhartd wants to merge 1 commit into
Open
[typescript-nestjs] Use paramName for URL path substitution (fixes #16668)#23868reichhartd wants to merge 1 commit into
reichhartd wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #16668. Same change as #16669, which never got merged because the original author's commits weren't linked to a GitHub account.
The bug: when a path parameter is declared with hyphens or underscores in the spec (e.g.
{payment_method_id}), the typescript-nestjs generator emits a function signature with the camelCase identifier but a URL template that still references the raw spec name:TypeScript then fails with
TS2304: Cannot find name 'payment_method_id'.paramNaming=originaldoesn't help, it only changes the signature, not the URL template.The fix: in
postProcessOperationsWithModelsthe existingfindPathParameterByNamelookup result is now also used for the URL template substitution. When the parameter resolves, its already-normalisedparamNameis appended. Falls back to the previoustoVarNamebehaviour otherwise.New unit test
testPathPropertyNamecovers a snake_case and a camelCase path parameter. I verified it fails on master without the fix and passes with it../bin/generate-samples.sh ./bin/configs/typescript-nestjs*.yamlproduces no sample drift because the petstore specs only use camelCase path parameters./cc @macjohnny from the TypeScript technical committee, and @wing328 who reviewed the original #16669.
PR checklist
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.
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)"fixes #123"present in the PR description)Summary by cubic
Fixes incorrect path param substitution in the
typescript-nestjsgenerator by using the normalizedparamNamein URL templates. Fixes #16668 and prevents TS2304 errors when specs use snake_case or kebab-case path params.paramNamefor URL template substitution inpostProcessOperationsWithModels, falling back totoVarNameif not found.testPathPropertyNameto verify correct substitution for both snake_case and camelCase path parameters.Written for commit 2c42049. Summary will update on new commits. Review in cubic