Encode "+" as "%2B" since "+" is a valid SemVer character. #17
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
tiegz
commented
Jan 23, 2024
| 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") |
There was a problem hiding this comment.
note that url.QueryEscape will encode +, but that method was replaced with PathEscape in #1
tiegz
commented
Jan 23, 2024
| 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", |
There was a problem hiding this comment.
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
|
another example where not-escaping |
|
Has the anchor community looked into merging this code? |
Signed-off-by: Tieg Zaharia <tieg@tidelift.com>
tiegz
force-pushed
the
encode-plus-sign
branch
from
b9d97ca
to
9bd4a32
Compare
|
I'll work on getting CI passing -- thanks for the fix! 🙌 |
Signed-off-by: Alex Goodman <wagoodman@users.noreply.github.com>
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.
Currently this library is generating PURLs like
pkg:golang/github.com/azure/azure-sdk-for-go@v56.3.0+incompatible.The PURL spec says that versions should be a "percent-encoded string", and while the
+character is fine to use while escaping+to escapeI think it's preferable to escape
+because downstream parsers of the URL will likely unescape the+aspkg:golang/github.com/azure/azure-sdk-for-go@v56.3.0 incompatible.There's a good analysis of this problem in package-url/purl-spec#261 as well.