fix: escape everything with modified QueryEscape #58
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
|
See #54 for a lot of background and investigation notes. |
This commit switches to using `QueryEscape` for escaping all components. However, because `QueryEscape` escapes ` ` (space) to `+`, we actually change that to a `%20`, that is the percent-encoded equivalent. `QueryEscape` was built for HTTP Query parameters, and although there is [some discussion](https://stackoverflow.com/questions/2678551/when-should-space-be-encoded-to-plus-or-20) around it, escaping ` ` to a `+` is completely valid. Sadly, other languages like Javascript don't handle that properly, so if we simply used `QueryEscape`, the purl couldn't be parsed by other implementations. By using the universally supported `%20` instead, we restore compatibility.
shibumi
approved these changes
Aug 12, 2023
|
LGTM. Sorry for the delay @tommyknows :) I am looking through the other PRs right now. |
another-rex
referenced
this pull request
in google/osv-scanner
Oct 11, 2023
[](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [github.com/google/go-cmp](https://togithub.com/google/go-cmp) | require | minor | `v0.5.9` -> `v0.6.0` | | [github.com/jedib0t/go-pretty/v6](https://togithub.com/jedib0t/go-pretty) | require | patch | `v6.4.7` -> `v6.4.8` | | [github.com/package-url/packageurl-go](https://togithub.com/package-url/packageurl-go) | require | patch | `v0.1.1` -> `v0.1.2` | | golang.org/x/exp | require | digest | `9212866` -> `7918f67` | | golang.org/x/mod | require | minor | `v0.12.0` -> `v0.13.0` | | golang.org/x/sync | require | minor | `v0.3.0` -> `v0.4.0` | | golang.org/x/term | require | minor | `v0.12.0` -> `v0.13.0` | --- ### Release Notes <details> <summary>google/go-cmp (github.com/google/go-cmp)</summary> ### [`v0.6.0`](https://togithub.com/google/go-cmp/releases/tag/v0.6.0) [Compare Source](https://togithub.com/google/go-cmp/compare/v0.5.9...v0.6.0) New API: - ([#​340](https://togithub.com/google/go-cmp/issues/340)) Add `cmpopts.EquateComparable` Documentation changes: - ([#​337](https://togithub.com/google/go-cmp/issues/337)) Use of hotlinking of Go identifiers Build changes: - ([#​325](https://togithub.com/google/go-cmp/issues/325)) Remove purego fallbacks Testing changes: - ([#​322](https://togithub.com/google/go-cmp/issues/322)) Run tests for Go 1.20 version - ([#​332](https://togithub.com/google/go-cmp/issues/332)) Pin GitHub action versions - ([#​327](https://togithub.com/google/go-cmp/issues/327)) set workflow permission to read-only </details> <details> <summary>jedib0t/go-pretty (github.com/jedib0t/go-pretty/v6)</summary> ### [`v6.4.8`](https://togithub.com/jedib0t/go-pretty/releases/tag/v6.4.8) [Compare Source](https://togithub.com/jedib0t/go-pretty/compare/v6.4.7...v6.4.8) ### Features - **table** - `RenderTSV()` to render table in TSV format ([#​277](https://togithub.com/jedib0t/go-pretty/issues/277)) // thanks [@​rafiramadhana](https://togithub.com/rafiramadhana) </details> <details> <summary>package-url/packageurl-go (github.com/package-url/packageurl-go)</summary> ### [`v0.1.2`](https://togithub.com/package-url/packageurl-go/releases/tag/v0.1.2) [Compare Source](https://togithub.com/package-url/packageurl-go/compare/v0.1.1...v0.1.2) #### What's Changed - Add Julia by [@​Octogonapus](https://togithub.com/Octogonapus) in [/~https://github.com/package-url/packageurl-go/pull/44](https://togithub.com/package-url/packageurl-go/pull/44) - feat: add missing purl types by [@​mcombuechen](https://togithub.com/mcombuechen) in [/~https://github.com/package-url/packageurl-go/pull/43](https://togithub.com/package-url/packageurl-go/pull/43) - Pull test data from upstream instead of maintaining a local copy by [@​Octogonapus](https://togithub.com/Octogonapus) in [/~https://github.com/package-url/packageurl-go/pull/49](https://togithub.com/package-url/packageurl-go/pull/49) - Add simple fuzz test by [@​imjasonh](https://togithub.com/imjasonh) in [/~https://github.com/package-url/packageurl-go/pull/34](https://togithub.com/package-url/packageurl-go/pull/34) - Test using supported Go versions by [@​imjasonh](https://togithub.com/imjasonh) in [/~https://github.com/package-url/packageurl-go/pull/50](https://togithub.com/package-url/packageurl-go/pull/50) - Remove deprecated usage of ioutil by [@​noqcks](https://togithub.com/noqcks) in [/~https://github.com/package-url/packageurl-go/pull/40](https://togithub.com/package-url/packageurl-go/pull/40) - fix: use url.URL to encode and decode PURLs by [@​tommyknows](https://togithub.com/tommyknows) in [/~https://github.com/package-url/packageurl-go/pull/52](https://togithub.com/package-url/packageurl-go/pull/52) - fix: escape and unescape name by [@​tommyknows](https://togithub.com/tommyknows) in [/~https://github.com/package-url/packageurl-go/pull/55](https://togithub.com/package-url/packageurl-go/pull/55) - fix: escape everything with modified QueryEscape by [@​tommyknows](https://togithub.com/tommyknows) in [/~https://github.com/package-url/packageurl-go/pull/58](https://togithub.com/package-url/packageurl-go/pull/58) - Add `pub` and `bitnami` types by [@​antgamdia](https://togithub.com/antgamdia) in [/~https://github.com/package-url/packageurl-go/pull/60](https://togithub.com/package-url/packageurl-go/pull/60) - Add known types and candidate types by [@​antgamdia](https://togithub.com/antgamdia) in [/~https://github.com/package-url/packageurl-go/pull/61](https://togithub.com/package-url/packageurl-go/pull/61) - Add PackageURL.Normalize by [@​wetterjames4](https://togithub.com/wetterjames4) in [/~https://github.com/package-url/packageurl-go/pull/65](https://togithub.com/package-url/packageurl-go/pull/65) #### New Contributors - [@​mcombuechen](https://togithub.com/mcombuechen) made their first contribution in [/~https://github.com/package-url/packageurl-go/pull/43](https://togithub.com/package-url/packageurl-go/pull/43) - [@​imjasonh](https://togithub.com/imjasonh) made their first contribution in [/~https://github.com/package-url/packageurl-go/pull/34](https://togithub.com/package-url/packageurl-go/pull/34) - [@​noqcks](https://togithub.com/noqcks) made their first contribution in [/~https://github.com/package-url/packageurl-go/pull/40](https://togithub.com/package-url/packageurl-go/pull/40) - [@​tommyknows](https://togithub.com/tommyknows) made their first contribution in [/~https://github.com/package-url/packageurl-go/pull/52](https://togithub.com/package-url/packageurl-go/pull/52) - [@​antgamdia](https://togithub.com/antgamdia) made their first contribution in [/~https://github.com/package-url/packageurl-go/pull/60](https://togithub.com/package-url/packageurl-go/pull/60) - [@​wetterjames4](https://togithub.com/wetterjames4) made their first contribution in [/~https://github.com/package-url/packageurl-go/pull/65](https://togithub.com/package-url/packageurl-go/pull/65) **Full Changelog**: package-url/packageurl-go@v0.1.1...v0.1.2 </details> --- ### Configuration 📅 **Schedule**: Branch creation - "before 6am on monday" in timezone Australia/Sydney, Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 👻 **Immortal**: This PR will be recreated if closed unmerged. Get [config help](https://togithub.com/renovatebot/renovate/discussions) if that's undesired. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/google/osv-scanner). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4wLjMiLCJ1cGRhdGVkSW5WZXIiOiIzNy44LjEiLCJ0YXJnZXRCcmFuY2giOiJtYWluIn0=-->
](https://renovatebot.com){kind=link}
Pull Request Test Coverage Report for Build 5589112670Warning: This coverage report may be inaccurate.This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.
Details
💛 - Coveralls |
1 similar comment
Pull Request Test Coverage Report for Build 5589112670Warning: This coverage report may be inaccurate.This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.
Details
💛 - Coveralls |
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.
This commit switches to using
QueryEscapefor escaping all components. However, becauseQueryEscapeescapes+, we actually change that to a%20, that is the percent-encoded equivalent.QueryEscapewas built for HTTP Query parameters, and although there is some discussion around it, escaping+is completely valid. Sadly, other languages / implementations like the Javascript one don't handle that properly, so if we simply usedQueryEscape, the purl couldn't be parsed by other implementations.By using the universally supported
%20instead, we restore compatibility.