Properly escape multi-segment path parameters #869
Merged
Conversation
This file contains 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
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #869 +/- ##
========================================
+ Coverage 8.00% 8.01% +0.01%
========================================
Files 258 258
Lines 64416 64427 +11
========================================
+ Hits 5155 5166 +11
Misses 58966 58966
Partials 295 295 ☔ View full report in Codecov by Sentry. |
pietern
reviewed
Mar 26, 2024
| @@ -109,6 +109,18 @@ func makeQueryString(data interface{}) (string, error) { | |||
| return "", fmt.Errorf("unsupported query string data: %#v", data) | |||
| } | |||
|
|
|||
| func EncodeMultiSegmentPathParameter(p string) string { | |||
| segments := strings.Split(p, "/") | |||
| b := strings.Builder{} | |||
There was a problem hiding this comment.
This can be preallocated to at least len(p).
2 tasks
hectorcast-db
approved these changes
Mar 27, 2024
github-merge-queue bot
pushed a commit
to databricks/databricks-sdk-py
that referenced
this pull request
Mar 28, 2024
## Changes Ports databricks/databricks-sdk-go#869 to Python SDK. Subsumes #592. Currently, path parameters are directly interpolated into the request URL without escaping. This means that characters like /, ? and # will not be percent-encoded and will affect the semantics of the URL, starting a new path segment, query parameters, or fragment, respectively. This means that it is impossible for users of the Files API to upload/download objects that contain ? or # in their name. / is allowed in the path of the Files API, so it does not need to be escaped. The Files API is currently marked with x-databricks-multi-segment, indicating that it should be permitted to have / characters but other characters need to be percent-encoded. This PR implements this. ## Tests - [x] Unit test for multi-segment path escaping behavior. - [x] Updated integration test to use # and ? symbols in the file name. This failed on main but succeeded on this PR.
2 tasks
github-merge-queue bot
pushed a commit
to databricks/databricks-sdk-java
that referenced
this pull request
Mar 28, 2024
## Changes Ports databricks/databricks-sdk-go#869 to Java SDK. Currently, path parameters are directly interpolated into the request URL without escaping. This means that characters like `/`, `?` and `#` will not be percent-encoded and will affect the semantics of the URL, starting a new path segment, query parameters, or fragment, respectively. This means that it is impossible for users of the Files API to upload/download objects that contain `?` or `#` in their name. `/` is allowed in the path of the Files API, so it does not need to be escaped. The Files API is currently marked with `x-databricks-multi-segment`, indicating that it should be permitted to have `/` characters but other characters need to be percent-encoded. This PR implements this. ## Tests - [x] Unit test for multi-segment path escaping behavior. - [x] Updated integration test to use # and ? symbols in the file name.
vikrantpuppala
pushed a commit
to vikrantpuppala/databricks-sdk-java
that referenced
this pull request
Apr 23, 2024
## Changes Ports databricks/databricks-sdk-go#869 to Java SDK. Currently, path parameters are directly interpolated into the request URL without escaping. This means that characters like `/`, `?` and `#` will not be percent-encoded and will affect the semantics of the URL, starting a new path segment, query parameters, or fragment, respectively. This means that it is impossible for users of the Files API to upload/download objects that contain `?` or `#` in their name. `/` is allowed in the path of the Files API, so it does not need to be escaped. The Files API is currently marked with `x-databricks-multi-segment`, indicating that it should be permitted to have `/` characters but other characters need to be percent-encoded. This PR implements this. ## Tests - [x] Unit test for multi-segment path escaping behavior. - [x] Updated integration test to use # and ? symbols in the file name.
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.
Changes
Currently, path parameters are directly interpolated into the request URL without escaping. This means that characters like
/,?and#will not be percent-encoded and will affect the semantics of the URL, starting a new path segment, query parameters, or fragment, respectively. This means that it is impossible for users of the Files API to upload/download objects that contain?or#in their name./is allowed in the path of the Files API, so it does not need to be escaped.The Files API is currently marked with
x-databricks-multi-segment, indicating that it should be permitted to have/characters but other characters need to be percent-encoded. This PR implements this.This PR builds on #868, correcting the test names for UC files.
Tests
#and?symbols in the file name. This failed onmainbut succeeded on this PR.