Skip to content

Encode "+" as "%2B" since "+" is a valid SemVer character. #17

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.

Sign up for GitHub

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

Merged
wagoodman merged 2 commits into from
Mar 12, 2024
Merged

Encode "+" as "%2B" since "+" is a valid SemVer character. #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9bd4a32
Encode "+" as "%2B" since "+" is a valid SemVer character.
tiegz Jan 23, 2024
92cd379
Merge remote-tracking branch 'origin/master' into encode-plus-sign
wagoodman Mar 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packageurl.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -382,6 +382,10 @@ func pathEscape(s string) string {
switch {
case c == '@':
t.WriteString("%40")
case c == '+':
// url.PathEscape doesn't encode '+' since it's a valid query escape character for ' ' in application/x-www-form-urlencoded, but '+' is a
// valid character in semver so we don't want it to be unintentionally unescaped as ' ' by downstream parsers of the purl.
t.WriteString("%2B")
Copy link
Author

@tiegz tiegz Jan 23, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note that url.QueryEscape will encode +, but that method was replaced with PathEscape in #1

case c == '?' || c == '#' || c == ' ' || c > unicode.MaxASCII:
t.WriteString(url.PathEscape(string(c)))
default:
Expand Down
4 changes: 2 additions & 2 deletions packageurl_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -354,8 +354,8 @@ func TestEncoding(t *testing.T) {
},
{
name: "pre-encoded version is unchanged",
input: "pkg:type/name/space/name@versio%20n?key=value#sub/path",
expected: "pkg:type/name/space/name@versio%20n?key=value#sub/path",
input: "pkg:type/name/space/name@versio%20n%2Bbeta?key=value#sub/path",
expected: "pkg:type/name/space/name@versio%20n%2Bbeta?key=value#sub/path",
Copy link
Author

@tiegz tiegz Jan 23, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

before the fix in this PR, this test would fail as:

packageurl_test.go:389: expected pkg:type/name/space/name@versio%20n%2Bbeta?key=value#sub/path to parse as pkg:type/name/space/name@versio%20n%2Bbeta?key=value#sub/path but got pkg:type/name/space/name@versio%20n+beta?key=value#sub/path

},
{
name: "unencoded qualifier value is encoded",
Expand Down