Encode supplied URL path parameters - #203
Merged
Merged
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 28406818d3
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
### Motivation - Path parameter values supplied via `--urlParams` (and ref-data replacements) containing characters like `/` or `&` were inserted verbatim into paths causing incorrect requests and mismatches. - The change ensures path placeholders are replaced with URL-encoded values so special characters are safely transmitted in paths. ### Description - Use `URLEncoder.encode(..., StandardCharsets.UTF_8)` when replacing supplied URL/path params in `FilesArguments.replacePathWithUrlParams` to encode values before substituting placeholders. - Added a unit test `shouldUrlEncodeSuppliedUrlParams` in `FilesArgumentsTest` to cover encoding of supplied `--urlParams` values. - Added a parameterized test `shouldUrlEncodeRefDataPathParamsForBodyMethods` in `ServiceCallerTest` to assert ref-data path parameters are encoded for body methods (`POST`, `PUT`, `PATCH`). - Added the required `import java.net.URLEncoder;` and updated expectations in tests where appropriate. ### Testing - Attempted to run `mvn -q -Dtest=ServiceCallerTest,FilesArgumentsTest test`; automated test execution was blocked because Maven dependency resolution failed with `403 Forbidden` from Maven Central for Quarkus/Jackson artifacts, so tests could not complete. - The new unit tests were added and committed, but CI/local execution is currently blocked by the repository dependency resolution issue described above.
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.
Motivation
--urlParams(and ref-data replacements) containing characters like/or&were inserted verbatim into paths causing incorrect requests and mismatches.Description
URLEncoder.encode(..., StandardCharsets.UTF_8)when replacing supplied URL/path params inFilesArguments.replacePathWithUrlParamsto encode values before substituting placeholders.shouldUrlEncodeSuppliedUrlParamsinFilesArgumentsTestto cover encoding of supplied--urlParamsvalues.shouldUrlEncodeRefDataPathParamsForBodyMethodsinServiceCallerTestto assert ref-data path parameters are encoded for body methods (POST,PUT,PATCH).import java.net.URLEncoder;and updated expectations in tests where appropriate.Testing
mvn -q -Dtest=ServiceCallerTest,FilesArgumentsTest test; automated test execution was blocked because Maven dependency resolution failed with403 Forbiddenfrom Maven Central for Quarkus/Jackson artifacts, so tests could not complete.Codex Task