Skip to content

feat: Don't encode : in the name component #83

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
merged 1 commit into from
Mar 11, 2025
Merged

feat: Don't encode : in the name component #83

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions src/encode.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ const { isNonEmptyString } = require('./strings')

const { encodeURIComponent } = globalThis

function encodeName(name) {
return isNonEmptyString(name)
? encodeURIComponent(name).replace(/%3A/g, ':')
: ''
}

function encodeNamespace(namespace) {
return isNonEmptyString(namespace)
? encodeURIComponent(namespace)
Expand Down Expand Up @@ -63,6 +69,7 @@ function replacePlusSignWithPercentEncodedSpace(str) {
}

module.exports = {
encodeName,
encodeNamespace,
encodeVersion,
encodeQualifiers,
Expand Down
2 changes: 2 additions & 0 deletions src/purl-component.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
'use strict'

const {
encodeName,
encodeNamespace,
encodeVersion,
encodeQualifiers,
Expand Down Expand Up @@ -66,6 +67,7 @@ module.exports = {
PurlComponent: createHelpersNamespaceObject(
{
encode: {
name: encodeName,
namespace: encodeNamespace,
version: encodeVersion,
qualifiers: encodeQualifiers,
Expand Down
82 changes: 47 additions & 35 deletions test/data/contrib-tests.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
[
{
"description": "scheme is lowercased",
"purl": "PkG:type/foo/bar@1.0.0",
"canonical_purl": "pkg:type/foo/bar@1.0.0",
"type": "type",
"namespace": "foo",
"name": "bar",
"version": "1.0.0",
"qualifiers": null,
"description": "debian can have debian versions as part of version with plus sign",
"purl": "pkg:deb/debian/libssl1.1@1.1.1n-0+deb10u3?arch=amd64&distro=debian-10",
"canonical_purl": "pkg:deb/debian/libssl1.1@1.1.1n-0+deb10u3?arch=amd64&distro=debian-10",
"type": "deb",
"namespace": "debian",
"name": "libssl1.1",
"version": "1.1.1n-0+deb10u3",
"qualifiers": {"arch": "amd64", "distro": "debian-10"},
"subpath": null,
"is_invalid": false
},
Expand All @@ -23,18 +23,6 @@
"subpath": null,
"is_invalid": false
},
{
"description": "debian can have debian versions as part of version with plus sign",
"purl": "pkg:deb/debian/[email protected]+deb10u3?arch=amd64&distro=debian-10",
"canonical_purl": "pkg:deb/debian/[email protected]+deb10u3?arch=amd64&distro=debian-10",
"type": "deb",
"namespace": "debian",
"name": "libssl1.1",
"version": "1.1.1n-0+deb10u3",
"qualifiers": {"arch": "amd64", "distro": "debian-10"},
"subpath": null,
"is_invalid": false
},
{
"description": "valid go purl with namespace that has more than one forward slash",
"purl": "pkg:golang/github.com/cncf/xds/[email protected]",
Expand All @@ -47,6 +35,18 @@
"subpath": null,
"is_invalid": false
},
{
"description": "maven requires a namespace",
"purl": "pkg:maven/[email protected]",
"canonical_purl": "pkg:maven/[email protected]",
"type": "maven",
"namespace": null,
"name": null,
"version": null,
"qualifiers": null,
"subpath": null,
"is_invalid": true
},
{
"description": "validates pub name (valid)",
"purl": "pkg:pub/[email protected]",
Expand All @@ -59,6 +59,18 @@
"subpath": null,
"is_invalid": false
},
{
"description": "scheme is lowercased",
"purl": "PkG:type/foo/[email protected]",
"canonical_purl": "pkg:type/foo/[email protected]",
"type": "type",
"namespace": "foo",
"name": "bar",
"version": "1.0.0",
"qualifiers": null,
"subpath": null,
"is_invalid": false
},
{
"description": "namespace can contain special characters",
"purl": "pkg:type/%40namespace%40%3F%23/[email protected]",
Expand Down Expand Up @@ -108,25 +120,25 @@
"is_invalid": false
},
{
"description": "maven requires a namespace",
"purl": "pkg:maven/[email protected]",
"canonical_purl": "pkg:maven/[email protected]",
"type": "maven",
"namespace": null,
"name": null,
"version": null,
"description": "leading and trailing slashes '/' are not significant and should be stripped in the canonical form",
"purl": "pkg:type//github.com///ll////[email protected]",
"canonical_purl": "pkg:type/github.com/ll/[email protected]",
"type": "type",
"namespace": "github.com/ll",
"name": "xlog",
"version": "v1.0.0",
"qualifiers": null,
"subpath": null,
"is_invalid": true
"is_invalid": false
},
{
"description": "leading and trailing slashes '/' are not significant and should be stripped in the canonical form",
"purl": "pkg:golang//github.com///ll////xlog@v2.0.0",
"canonical_purl": "pkg:golang/github.com/ll/xlog@v2.0.0",
"type": "golang",
"namespace": "github.com/ll",
"name": "xlog",
"version": "v2.0.0",
"description": "the colon ':' does not need to be encoded as '%3A'",
"purl": "pkg:type/fo:o/ba:r@v1.0.0",
"canonical_purl": "pkg:type/fo:o/ba:r@v1.0.0",
"type": "type",
"namespace": "fo:o",
"name": "ba:r",
"version": "v1.0.0",
"qualifiers": null,
"subpath": null,
"is_invalid": false
Expand Down