-
Notifications
You must be signed in to change notification settings - Fork 11
fix: URL-escape placeholder values in BuildLookasideURL and dist-git URL construction #74
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Copilot
wants to merge
7
commits into
main
Choose a base branch
from
copilot/fix-build-lookaside-url-substitution
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+202
−9
Open
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
3853364
Initial plan
Copilot ffa6756
fix: URL-escape placeholder values in BuildLookasideURL and add Build…
Copilot 9192372
fix: validate lowercased hashType against placeholders in BuildLookas…
Copilot 456d682
fix: validate scheme and host in constructed URLs
Copilot 8eb81c1
fix: normalize hashType once and use %#q for placeholders in errors
Copilot e6344c6
refactor: extract validateAbsoluteURL helper for URL validation
Copilot a5bda4c
fix: separate validateAbsoluteURL and BuildLookasideURL doc comments
Copilot File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -10,6 +10,7 @@ import ( | |||||
| "errors" | ||||||
| "fmt" | ||||||
| "log/slog" | ||||||
| "net/url" | ||||||
| "path/filepath" | ||||||
| "regexp" | ||||||
| "strings" | ||||||
|
|
@@ -314,13 +315,18 @@ const ( | |||||
| // [PlaceholderFilename], [PlaceholderHashType], and [PlaceholderHash]. | ||||||
| // Placeholders not present in the template are simply ignored. | ||||||
| // | ||||||
| // Substituted values are URL path-escaped via [url.PathEscape] so that reserved | ||||||
| // characters such as /, ?, #, and % do not alter the URL structure. | ||||||
| // | ||||||
| // Returns an error if any of the provided values contain a placeholder string, as this | ||||||
| // would cause ambiguous substitution results depending on replacement order. | ||||||
| // would cause ambiguous substitution results depending on replacement order, or if the | ||||||
| // resulting URL is not valid. | ||||||
| func BuildLookasideURL(template, packageName, fileName, hashType, hash string) (string, error) { | ||||||
| // allPlaceholders lists all supported lookaside URI template placeholders. | ||||||
| allPlaceholders := []string{PlaceholderPkg, PlaceholderFilename, PlaceholderHashType, PlaceholderHash} | ||||||
|
|
||||||
| for _, v := range []string{packageName, fileName, hashType, hash} { | ||||||
| // Check the normalized (lowercased) hashType since that is the form actually substituted. | ||||||
| for _, v := range []string{packageName, fileName, strings.ToLower(hashType), hash} { | ||||||
| for _, p := range allPlaceholders { | ||||||
| if strings.Contains(v, p) { | ||||||
| return "", fmt.Errorf("value %#q contains placeholder %s, which would cause ambiguous substitution", v, p) | ||||||
|
|
@@ -329,10 +335,47 @@ func BuildLookasideURL(template, packageName, fileName, hashType, hash string) ( | |||||
| } | ||||||
|
|
||||||
| uri := template | ||||||
| uri = strings.ReplaceAll(uri, PlaceholderPkg, packageName) | ||||||
| uri = strings.ReplaceAll(uri, PlaceholderFilename, fileName) | ||||||
| uri = strings.ReplaceAll(uri, PlaceholderHashType, strings.ToLower(hashType)) | ||||||
| uri = strings.ReplaceAll(uri, PlaceholderHash, hash) | ||||||
| uri = strings.ReplaceAll(uri, PlaceholderPkg, url.PathEscape(packageName)) | ||||||
| uri = strings.ReplaceAll(uri, PlaceholderFilename, url.PathEscape(fileName)) | ||||||
| uri = strings.ReplaceAll(uri, PlaceholderHashType, url.PathEscape(strings.ToLower(hashType))) | ||||||
|
dmcilvaney marked this conversation as resolved.
Outdated
|
||||||
| uri = strings.ReplaceAll(uri, PlaceholderHash, url.PathEscape(hash)) | ||||||
|
|
||||||
| u, err := url.Parse(uri) | ||||||
| if err != nil { | ||||||
| return "", fmt.Errorf("resulting lookaside URL is not valid:\n%w", err) | ||||||
| } | ||||||
|
|
||||||
| if u.Scheme == "" || u.Host == "" { | ||||||
| return "", fmt.Errorf("resulting lookaside URL %#q is missing scheme or host", uri) | ||||||
| } | ||||||
|
|
||||||
| return uri, nil | ||||||
| } | ||||||
|
|
||||||
| // BuildDistGitURL constructs a dist-git repository URL by substituting the | ||||||
| // [PlaceholderPkg] placeholder in the URI template with the provided package name. | ||||||
| // | ||||||
| // The package name is URL path-escaped via [url.PathEscape] so that reserved | ||||||
| // characters such as /, ?, #, and % do not alter the URL structure. | ||||||
| // | ||||||
| // Returns an error if the package name contains a placeholder string, or if the | ||||||
| // resulting URL is not valid. | ||||||
| func BuildDistGitURL(template, packageName string) (string, error) { | ||||||
| if strings.Contains(packageName, PlaceholderPkg) { | ||||||
| return "", fmt.Errorf("package name %#q contains placeholder %s, which would cause ambiguous substitution", | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
| packageName, PlaceholderPkg) | ||||||
| } | ||||||
|
|
||||||
| uri := strings.ReplaceAll(template, PlaceholderPkg, url.PathEscape(packageName)) | ||||||
|
dmcilvaney marked this conversation as resolved.
|
||||||
|
|
||||||
| u, err := url.Parse(uri) | ||||||
| if err != nil { | ||||||
| return "", fmt.Errorf("resulting dist-git URL is not valid:\n%w", err) | ||||||
| } | ||||||
|
|
||||||
| if u.Scheme == "" || u.Host == "" { | ||||||
| return "", fmt.Errorf("resulting dist-git URL %#q is missing scheme or host", uri) | ||||||
| } | ||||||
|
|
||||||
| return uri, nil | ||||||
| } | ||||||
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit-pick: we're doing
strings.ToLower(hashType)twice insideBuildLookasideURL. What do you think about doinghashType = strings.ToLower(hashType)at the beginning of the function to avoid repetition?