fix(request_builder): encode unresolved path string prior to path parameter insertion #219
Conversation
…ameter insertion This commit modifies RequestBuilder.ResolveRequestURL() slightly so that the passed-in path string (unresolved, potentially containing special characters and path parameter references) is URL-encoded prior to replacing path param references with their corresponding encoded path param values. This ensures that the URL string passed to http.NewRequest() by RequestBuilder.Build() will be properly encoded (escaped) such that all special characters appearing in path segments are converted to their %nn equivalents, but yet any escaped characters within the encoded path param values are NOT decoded. This avoids a quirk in the url.Parse() method that is invoked by the http.NewRequest() method. This change is needed in order to properly support a scenario where: 1. a path parameter value contains one or more embedded slashes and is therefore escaped AND 2. the unresolved path string ALSO contains other special characters needing to be escaped Signed-off-by: Phil Adams <phil_adams@us.ibm.com>
| @@ -19,7 +19,7 @@ test: | |||
|
|
|||
| lint: | |||
| ${LINT} run --build-tags=all | |||
| DIFF=$$(${FORMATTER} -d core); if [[ -n "$$DIFF" ]]; then printf "\n$$DIFF" && exit 1; fi | |||
| DIFF=$$(${FORMATTER} -d core); if [ -n "$$DIFF" ]; then printf "\n$$DIFF\n" && exit 1; fi | |||
There was a problem hiding this comment.
It turns out that this statement was always failing on Travis but yet it did not cause the build to stop due to a difference between "bash" and "sh" (the default shell on a Travis build agent is "sh").
Example build hiccup:
https://app.travis-ci.com/github/IBM/go-sdk-core/jobs/621470281
$ make lint
golangci-lint run --build-tags=all
DIFF=$(goimports -d core); if [[ -n "$DIFF" ]]; then printf "\n$DIFF" && exit 1; fi
/bin/sh: 1: [[: not found
The command "make lint" exited with 0.
There was a problem hiding this comment.
I verified that any formatting type differences will now cause the build to fail and "make" will return a non-zero exit status.
There was a problem hiding this comment.
Wow, good catch! I think I was the one who wrote that line and... I never thought about the shell difference to be honest - since we use Ubuntu images that usually use bash by default.
| @@ -239,7 +239,7 @@ func TestSDKErrorfNoSummary(t *testing.T) { | |||
| } | |||
|
|
|||
| func TestSDKErrorfDoesntUseSDKCausedBy(t *testing.T) { | |||
| sdkProb := getPopulatedSDKProblem(); | |||
| sdkProb := getPopulatedSDKProblem() | |||
There was a problem hiding this comment.
change by "make format"
| @@ -108,13 +108,13 @@ func formatFrames(pcs []uintptr, componentName string) []sdkStackFrame { | |||
| } | |||
|
|
|||
| type sparseSDKProblem struct { | |||
| ID string | |||
| ID string | |||
There was a problem hiding this comment.
changes by "make format"
| @@ -19,7 +19,7 @@ test: | |||
|
|
|||
| lint: | |||
| ${LINT} run --build-tags=all | |||
| DIFF=$$(${FORMATTER} -d core); if [[ -n "$$DIFF" ]]; then printf "\n$$DIFF" && exit 1; fi | |||
| DIFF=$$(${FORMATTER} -d core); if [ -n "$$DIFF" ]; then printf "\n$$DIFF\n" && exit 1; fi | |||
There was a problem hiding this comment.
Wow, good catch! I think I was the one who wrote that line and... I never thought about the shell difference to be honest - since we use Ubuntu images that usually use bash by default.
## [5.17.3](v5.17.2...v5.17.3) (2024-05-16) ### Bug Fixes * **request_builder:** encode unresolved path string prior to path parameter insertion ([#219](#219)) ([5f567da](5f567da))
|
🎉 This PR is included in version 5.17.3 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
This commit modifies RequestBuilder.ResolveRequestURL() slightly so that the passed-in path string (unresolved, potentially containing special characters and path parameter references) is URL-encoded prior to replacing path param references with their corresponding encoded path param values. This ensures that the URL string passed to http.NewRequest() by RequestBuilder.Build() will be properly encoded (escaped) such that all special characters appearing in path segments are converted to their %nn equivalents, but yet any escaped characters within the encoded path param values are NOT decoded. This avoids a quirk in the url.Parse() method that is invoked by the http.NewRequest() method.
This change is needed in order to properly support a scenario where: