Repository navigation
fix: Escape file paths in contents methods - #4721
Open
ranjithguggilla wants to merge 1 commit into
Open
ranjithguggilla wants to merge 1 commit into
ranjithguggilla wants to merge 1 commit into
Conversation
CreateFile, UpdateFile, and DeleteFile put the file path into the request URL without escaping it, unlike GetContents. A path containing '#' or '?' was cut at that character, so the request targeted a different file, and a path containing a bare '%' failed with a URL parse error. Escape the path the same way GetContents does and add a table test covering the three methods.
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #4721 +/- ##
=======================================
Coverage 98.64% 98.64%
=======================================
Files 204 204
Lines 19159 19162 +3
=======================================
+ Hits 18899 18902 +3
Misses 260 260 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
gmlewis
requested changes
Nov 17, 2026
Comment on lines
+269
to
+270
| escapedPath := (&url.URL{Path: path}).String() | ||
| u := fmt.Sprintf("repos/%v/%v/contents/%v", owner, repo, escapedPath) |
Collaborator
There was a problem hiding this comment.
Please add a comment that path is now escaped just like we do for the other endpoints.
Here and everywhere else:
Suggested change
| escapedPath := (&url.URL{Path: path}).String() | |
| u := fmt.Sprintf("repos/%v/%v/contents/%v", owner, repo, escapedPath) | |
| u := fmt.Sprintf("repos/%v/%v/contents/%v", owner, repo, url.QueryEscape(path)) |
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 #4720.
CreateFile,UpdateFileandDeleteFileinsert the file path into the request URL without escaping it, unlikeGetContents. A path containing#or?is cut at that character, so the request goes to a different file (docs/C#.mdbecomesdocs/C), and a path with a bare%fails with a URL parse error.This escapes the path the same way
GetContentsalready does.I added
TestRepositoriesService_filePath_isEscaped, which covers the three methods. Without the source change 12 of its 18 subtests fail; with it they all pass.script/fmt.sh,script/lint.shandscript/test.shpass.Note: a caller that pre-escaped the path as a workaround will now have it escaped twice.