Skip to content

Do not set version to empty string in npm_api_url #3393 #3398

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
JonoYang merged 3 commits into from
May 16, 2023
Merged

Do not set version to empty string in npm_api_url #3393 #3398

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
795ee77
Do not set version to empty string in npm_api_url #3393
JonoYang May 9, 2023
74c4bf6
Update docstring and test for npm_api_url #3393
JonoYang May 12, 2023
71eb7ba
Update expected test results #3393
JonoYang May 16, 2023
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
11 changes: 5 additions & 6 deletions src/packagedcode/npm.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -794,16 +794,17 @@ def npm_api_url(namespace, name, version=None, registry='https://registry.npmjs.
Return a package API data URL given a namespace, name, version and a base
registry URL.

Note that for scoped packages (with a namespace), the URL is not version
specific but contains the data for all versions as the default behvior of
the registries is to return nothing in this case. Special quoting rules are
applied for scoped npms.
Special quoting rules are applied for scoped npms.

For example:
>>> result = npm_api_url('@invisionag', 'eslint-config-ivx', '0.1.4', 'https://registry.yarnpkg.com')
>>> assert result == 'https://registry.yarnpkg.com/@invisionag%2feslint-config-ivx/0.1.4'

>>> result = npm_api_url('@invisionag', 'eslint-config-ivx', registry='https://registry.yarnpkg.com')
>>> assert result == 'https://registry.yarnpkg.com/@invisionag%2feslint-config-ivx'

>>> assert npm_api_url(None, 'angular', '1.6.6') == 'https://registry.npmjs.org/angular/1.6.6'
>>> assert npm_api_url(None, 'angular') == 'https://registry.npmjs.org/angular'

>>> assert not npm_api_url(None, None, None)
"""
Expand All @@ -812,8 +813,6 @@ def npm_api_url(namespace, name, version=None, registry='https://registry.npmjs.
# this is a legacy wart: older registries used to always encode this /
# FIXME: do NOT encode and use plain / instead
ns_name = '%2f'.join([namespace, name])
# there is no version-specific URL for scoped packages
version = ''
else:
ns_name = name

Expand Down
2 changes: 1 addition & 1 deletion tests/packagedcode/data/npm/package-lock-v2-2/package-lock.json-expected
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion tests/packagedcode/data/npm/package-lock-v2/package-lock.json-expected
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

32 changes: 16 additions & 16 deletions tests/packagedcode/data/npm/private-and-yarn/scan.expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@
],
"repository_homepage_url": "https://www.npmjs.com/package/@babel/runtime",
"repository_download_url": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.2.0.tgz",
"api_data_url": "https://registry.npmjs.org/@babel%2fruntime",
"api_data_url": "https://registry.npmjs.org/@babel%2fruntime/7.2.0",
"datasource_id": "yarn_lock_v1",
"purl": "pkg:npm/%40babel/runtime@7.2.0"
},
Expand Down Expand Up @@ -197,7 +197,7 @@
],
"repository_homepage_url": "https://www.npmjs.com/package/@ballerina/api-designer",
"repository_download_url": "https://registry.npmjs.org/@ballerina/api-designer/-/api-designer-0.99.0-RC3.tgz",
"api_data_url": "https://registry.npmjs.org/@ballerina%2fapi-designer",
"api_data_url": "https://registry.npmjs.org/@ballerina%2fapi-designer/0.99.0-RC3",
"datasource_id": "yarn_lock_v1",
"purl": "pkg:npm/%40ballerina/api-designer@0.99.0-RC3"
},
Expand Down Expand Up @@ -313,7 +313,7 @@
],
"repository_homepage_url": "https://www.npmjs.com/package/@ballerina/ast-model",
"repository_download_url": "https://registry.npmjs.org/@ballerina/ast-model/-/ast-model-0.99.0-RC3.tgz",
"api_data_url": "https://registry.npmjs.org/@ballerina%2fast-model",
"api_data_url": "https://registry.npmjs.org/@ballerina%2fast-model/0.99.0-RC3",
"datasource_id": "yarn_lock_v1",
"purl": "pkg:npm/%40ballerina/ast-model@0.99.0-RC3"
},
Expand Down Expand Up @@ -379,7 +379,7 @@
],
"repository_homepage_url": "https://www.npmjs.com/package/@ballerina/ballerina-by-examples",
"repository_download_url": "https://registry.npmjs.org/@ballerina/ballerina-by-examples/-/ballerina-by-examples-0.99.0-RC3.tgz",
"api_data_url": "https://registry.npmjs.org/@ballerina%2fballerina-by-examples",
"api_data_url": "https://registry.npmjs.org/@ballerina%2fballerina-by-examples/0.99.0-RC3",
"datasource_id": "yarn_lock_v1",
"purl": "pkg:npm/%40ballerina/ballerina-by-examples@0.99.0-RC3"
},
Expand Down Expand Up @@ -505,7 +505,7 @@
],
"repository_homepage_url": "https://www.npmjs.com/package/@ballerina/diagram",
"repository_download_url": "https://registry.npmjs.org/@ballerina/diagram/-/diagram-0.99.0-RC3.tgz",
"api_data_url": "https://registry.npmjs.org/@ballerina%2fdiagram",
"api_data_url": "https://registry.npmjs.org/@ballerina%2fdiagram/0.99.0-RC3",
"datasource_id": "yarn_lock_v1",
"purl": "pkg:npm/%40ballerina/diagram@0.99.0-RC3"
},
Expand Down Expand Up @@ -621,7 +621,7 @@
],
"repository_homepage_url": "https://www.npmjs.com/package/@ballerina/distribution",
"repository_download_url": "https://registry.npmjs.org/@ballerina/distribution/-/distribution-0.99.0-RC3.tgz",
"api_data_url": "https://registry.npmjs.org/@ballerina%2fdistribution",
"api_data_url": "https://registry.npmjs.org/@ballerina%2fdistribution/0.99.0-RC3",
"datasource_id": "yarn_lock_v1",
"purl": "pkg:npm/%40ballerina/distribution@0.99.0-RC3"
},
Expand Down Expand Up @@ -717,7 +717,7 @@
],
"repository_homepage_url": "https://www.npmjs.com/package/@ballerina/documentation",
"repository_download_url": "https://registry.npmjs.org/@ballerina/documentation/-/documentation-0.99.0-RC3.tgz",
"api_data_url": "https://registry.npmjs.org/@ballerina%2fdocumentation",
"api_data_url": "https://registry.npmjs.org/@ballerina%2fdocumentation/0.99.0-RC3",
"datasource_id": "yarn_lock_v1",
"purl": "pkg:npm/%40ballerina/documentation@0.99.0-RC3"
},
Expand Down Expand Up @@ -772,7 +772,7 @@
"dependencies": [],
"repository_homepage_url": "https://www.npmjs.com/package/@ballerina/font",
"repository_download_url": "https://registry.npmjs.org/@ballerina/font/-/font-0.99.0-RC3.tgz",
"api_data_url": "https://registry.npmjs.org/@ballerina%2ffont",
"api_data_url": "https://registry.npmjs.org/@ballerina%2ffont/0.99.0-RC3",
"datasource_id": "yarn_lock_v1",
"purl": "pkg:npm/%40ballerina/font@0.99.0-RC3"
},
Expand Down Expand Up @@ -1024,7 +1024,7 @@
],
"repository_homepage_url": "https://www.npmjs.com/package/@babel/runtime",
"repository_download_url": "https://registry.npmjs.org/@babel/runtime/-/runtime-7.2.0.tgz",
"api_data_url": "https://registry.npmjs.org/@babel%2fruntime",
"api_data_url": "https://registry.npmjs.org/@babel%2fruntime/7.2.0",
"datasource_id": "yarn_lock_v1",
"purl": "pkg:npm/%40babel/runtime@7.2.0"
},
Expand Down Expand Up @@ -1146,7 +1146,7 @@
],
"repository_homepage_url": "https://www.npmjs.com/package/@ballerina/api-designer",
"repository_download_url": "https://registry.npmjs.org/@ballerina/api-designer/-/api-designer-0.99.0-RC3.tgz",
"api_data_url": "https://registry.npmjs.org/@ballerina%2fapi-designer",
"api_data_url": "https://registry.npmjs.org/@ballerina%2fapi-designer/0.99.0-RC3",
"datasource_id": "yarn_lock_v1",
"purl": "pkg:npm/%40ballerina/api-designer@0.99.0-RC3"
},
Expand Down Expand Up @@ -1258,7 +1258,7 @@
],
"repository_homepage_url": "https://www.npmjs.com/package/@ballerina/ast-model",
"repository_download_url": "https://registry.npmjs.org/@ballerina/ast-model/-/ast-model-0.99.0-RC3.tgz",
"api_data_url": "https://registry.npmjs.org/@ballerina%2fast-model",
"api_data_url": "https://registry.npmjs.org/@ballerina%2fast-model/0.99.0-RC3",
"datasource_id": "yarn_lock_v1",
"purl": "pkg:npm/%40ballerina/ast-model@0.99.0-RC3"
},
Expand Down Expand Up @@ -1320,7 +1320,7 @@
],
"repository_homepage_url": "https://www.npmjs.com/package/@ballerina/ballerina-by-examples",
"repository_download_url": "https://registry.npmjs.org/@ballerina/ballerina-by-examples/-/ballerina-by-examples-0.99.0-RC3.tgz",
"api_data_url": "https://registry.npmjs.org/@ballerina%2fballerina-by-examples",
"api_data_url": "https://registry.npmjs.org/@ballerina%2fballerina-by-examples/0.99.0-RC3",
"datasource_id": "yarn_lock_v1",
"purl": "pkg:npm/%40ballerina/ballerina-by-examples@0.99.0-RC3"
},
Expand Down Expand Up @@ -1442,7 +1442,7 @@
],
"repository_homepage_url": "https://www.npmjs.com/package/@ballerina/diagram",
"repository_download_url": "https://registry.npmjs.org/@ballerina/diagram/-/diagram-0.99.0-RC3.tgz",
"api_data_url": "https://registry.npmjs.org/@ballerina%2fdiagram",
"api_data_url": "https://registry.npmjs.org/@ballerina%2fdiagram/0.99.0-RC3",
"datasource_id": "yarn_lock_v1",
"purl": "pkg:npm/%40ballerina/diagram@0.99.0-RC3"
},
Expand Down Expand Up @@ -1554,7 +1554,7 @@
],
"repository_homepage_url": "https://www.npmjs.com/package/@ballerina/distribution",
"repository_download_url": "https://registry.npmjs.org/@ballerina/distribution/-/distribution-0.99.0-RC3.tgz",
"api_data_url": "https://registry.npmjs.org/@ballerina%2fdistribution",
"api_data_url": "https://registry.npmjs.org/@ballerina%2fdistribution/0.99.0-RC3",
"datasource_id": "yarn_lock_v1",
"purl": "pkg:npm/%40ballerina/distribution@0.99.0-RC3"
},
Expand Down Expand Up @@ -1646,7 +1646,7 @@
],
"repository_homepage_url": "https://www.npmjs.com/package/@ballerina/documentation",
"repository_download_url": "https://registry.npmjs.org/@ballerina/documentation/-/documentation-0.99.0-RC3.tgz",
"api_data_url": "https://registry.npmjs.org/@ballerina%2fdocumentation",
"api_data_url": "https://registry.npmjs.org/@ballerina%2fdocumentation/0.99.0-RC3",
"datasource_id": "yarn_lock_v1",
"purl": "pkg:npm/%40ballerina/documentation@0.99.0-RC3"
},
Expand Down Expand Up @@ -1697,7 +1697,7 @@
"dependencies": [],
"repository_homepage_url": "https://www.npmjs.com/package/@ballerina/font",
"repository_download_url": "https://registry.npmjs.org/@ballerina/font/-/font-0.99.0-RC3.tgz",
"api_data_url": "https://registry.npmjs.org/@ballerina%2ffont",
"api_data_url": "https://registry.npmjs.org/@ballerina%2ffont/0.99.0-RC3",
"datasource_id": "yarn_lock_v1",
"purl": "pkg:npm/%40ballerina/font@0.99.0-RC3"
},
Expand Down
2 changes: 1 addition & 1 deletion tests/packagedcode/data/npm/scoped1/package.json.expected
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -676,7 +676,7 @@
],
"repository_homepage_url": "https://www.npmjs.com/package/@ionic/app-scripts",
"repository_download_url": "https://registry.npmjs.org/@ionic/app-scripts/-/app-scripts-3.0.1-201710301651.tgz",
"api_data_url": "https://registry.npmjs.org/@ionic%2fapp-scripts",
"api_data_url": "https://registry.npmjs.org/@ionic%2fapp-scripts/3.0.1-201710301651",
"datasource_id": "npm_package_json",
"purl": "pkg:npm/%40ionic/app-scripts@3.0.1-201710301651"
}
Expand Down
2 changes: 1 addition & 1 deletion tests/packagedcode/data/npm/scoped2/package.json.expected
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,7 +186,7 @@
],
"repository_homepage_url": "https://www.npmjs.com/package/@invisionag/eslint-config-ivx",
"repository_download_url": "https://registry.npmjs.org/@invisionag/eslint-config-ivx/-/eslint-config-ivx-0.0.2.tgz",
"api_data_url": "https://registry.npmjs.org/@invisionag%2feslint-config-ivx",
"api_data_url": "https://registry.npmjs.org/@invisionag%2feslint-config-ivx/0.0.2",
"datasource_id": "npm_package_json",
"purl": "pkg:npm/%40invisionag/eslint-config-ivx@0.0.2"
}
Expand Down
6 changes: 3 additions & 3 deletions tests/packagedcode/data/npm/yarn-lock/v1-complex/yarn.lock-expected
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@
],
"repository_homepage_url": "https://www.npmjs.com/package/@babel/code-frame",
"repository_download_url": "https://registry.npmjs.org/@babel/code-frame/-/code-frame-7.0.0.tgz",
"api_data_url": "https://registry.npmjs.org/@babel%2fcode-frame",
"api_data_url": "https://registry.npmjs.org/@babel%2fcode-frame/7.0.0",
"datasource_id": "yarn_lock_v1",
"purl": "pkg:npm/%40babel/code-frame@7.0.0"
},
Expand Down Expand Up @@ -183,7 +183,7 @@
],
"repository_homepage_url": "https://www.npmjs.com/package/@babel/core",
"repository_download_url": "https://registry.npmjs.org/@babel/core/-/core-7.3.4.tgz",
"api_data_url": "https://registry.npmjs.org/@babel%2fcore",
"api_data_url": "https://registry.npmjs.org/@babel%2fcore/7.3.4",
"datasource_id": "yarn_lock_v1",
"purl": "pkg:npm/%40babel/core@7.3.4"
},
Expand Down Expand Up @@ -245,7 +245,7 @@
],
"repository_homepage_url": "https://www.npmjs.com/package/@babel/helper-annotate-as-pure",
"repository_download_url": "https://registry.npmjs.org/@babel/helper-annotate-as-pure/-/helper-annotate-as-pure-7.0.0.tgz",
"api_data_url": "https://registry.npmjs.org/@babel%2fhelper-annotate-as-pure",
"api_data_url": "https://registry.npmjs.org/@babel%2fhelper-annotate-as-pure/7.0.0",
"datasource_id": "yarn_lock_v1",
"purl": "pkg:npm/%40babel/helper-annotate-as-pure@7.0.0"
},
Expand Down
4 changes: 2 additions & 2 deletions tests/summarycode/data/score/basic-expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@
"extra_data": {},
"repository_homepage_url": "https://www.npmjs.com/package/@invisionag/eslint-config-ivx",
"repository_download_url": "https://registry.npmjs.org/@invisionag/eslint-config-ivx/-/eslint-config-ivx-0.0.10.tgz",
"api_data_url": "https://registry.npmjs.org/@invisionag%2feslint-config-ivx",
"api_data_url": "https://registry.npmjs.org/@invisionag%2feslint-config-ivx/0.0.10",
"package_uid": "pkg:npm/%40invisionag/eslint-config-ivx@0.0.10?uuid=fixed-uid-done-for-testing-5642512d1758",
"datafile_paths": [
"basic/package.json"
Expand Down Expand Up @@ -684,7 +684,7 @@
],
"repository_homepage_url": "https://www.npmjs.com/package/@invisionag/eslint-config-ivx",
"repository_download_url": "https://registry.npmjs.org/@invisionag/eslint-config-ivx/-/eslint-config-ivx-0.0.10.tgz",
"api_data_url": "https://registry.npmjs.org/@invisionag%2feslint-config-ivx",
"api_data_url": "https://registry.npmjs.org/@invisionag%2feslint-config-ivx/0.0.10",
"datasource_id": "npm_package_json",
"purl": "pkg:npm/%40invisionag/eslint-config-ivx@0.0.10"
}
Expand Down
4 changes: 2 additions & 2 deletions tests/summarycode/data/score/inconsistent_licenses_copyleft-expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@
"extra_data": {},
"repository_homepage_url": "https://www.npmjs.com/package/@invisionag/eslint-config-ivx",
"repository_download_url": "https://registry.npmjs.org/@invisionag/eslint-config-ivx/-/eslint-config-ivx-0.0.10.tgz",
"api_data_url": "https://registry.npmjs.org/@invisionag%2feslint-config-ivx",
"api_data_url": "https://registry.npmjs.org/@invisionag%2feslint-config-ivx/0.0.10",
"package_uid": "pkg:npm/%40invisionag/eslint-config-ivx@0.0.10?uuid=fixed-uid-done-for-testing-5642512d1758",
"datafile_paths": [
"inconsistent_licenses_copyleft/package.json"
Expand Down Expand Up @@ -689,7 +689,7 @@
],
"repository_homepage_url": "https://www.npmjs.com/package/@invisionag/eslint-config-ivx",
"repository_download_url": "https://registry.npmjs.org/@invisionag/eslint-config-ivx/-/eslint-config-ivx-0.0.10.tgz",
"api_data_url": "https://registry.npmjs.org/@invisionag%2feslint-config-ivx",
"api_data_url": "https://registry.npmjs.org/@invisionag%2feslint-config-ivx/0.0.10",
"datasource_id": "npm_package_json",
"purl": "pkg:npm/%40invisionag/eslint-config-ivx@0.0.10"
}
Expand Down
4 changes: 2 additions & 2 deletions tests/summarycode/data/score/no_license_or_copyright-expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
"extra_data": {},
"repository_homepage_url": "https://www.npmjs.com/package/@invisionag/eslint-config-ivx",
"repository_download_url": "https://registry.npmjs.org/@invisionag/eslint-config-ivx/-/eslint-config-ivx-0.0.10.tgz",
"api_data_url": "https://registry.npmjs.org/@invisionag%2feslint-config-ivx",
"api_data_url": "https://registry.npmjs.org/@invisionag%2feslint-config-ivx/0.0.10",
"package_uid": "pkg:npm/%40invisionag/eslint-config-ivx@0.0.10?uuid=fixed-uid-done-for-testing-5642512d1758",
"datafile_paths": [
"no_license_or_copyright/package.json"
Expand Down Expand Up @@ -571,7 +571,7 @@
],
"repository_homepage_url": "https://www.npmjs.com/package/@invisionag/eslint-config-ivx",
"repository_download_url": "https://registry.npmjs.org/@invisionag/eslint-config-ivx/-/eslint-config-ivx-0.0.10.tgz",
"api_data_url": "https://registry.npmjs.org/@invisionag%2feslint-config-ivx",
"api_data_url": "https://registry.npmjs.org/@invisionag%2feslint-config-ivx/0.0.10",
"datasource_id": "npm_package_json",
"purl": "pkg:npm/%40invisionag/eslint-config-ivx@0.0.10"
}
Expand Down
4 changes: 2 additions & 2 deletions tests/summarycode/data/score/no_license_text-expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@
"extra_data": {},
"repository_homepage_url": "https://www.npmjs.com/package/@invisionag/eslint-config-ivx",
"repository_download_url": "https://registry.npmjs.org/@invisionag/eslint-config-ivx/-/eslint-config-ivx-0.0.10.tgz",
"api_data_url": "https://registry.npmjs.org/@invisionag%2feslint-config-ivx",
"api_data_url": "https://registry.npmjs.org/@invisionag%2feslint-config-ivx/0.0.10",
"package_uid": "pkg:npm/%40invisionag/eslint-config-ivx@0.0.10?uuid=fixed-uid-done-for-testing-5642512d1758",
"datafile_paths": [
"no_license_text/package.json"
Expand Down Expand Up @@ -629,7 +629,7 @@
],
"repository_homepage_url": "https://www.npmjs.com/package/@invisionag/eslint-config-ivx",
"repository_download_url": "https://registry.npmjs.org/@invisionag/eslint-config-ivx/-/eslint-config-ivx-0.0.10.tgz",
"api_data_url": "https://registry.npmjs.org/@invisionag%2feslint-config-ivx",
"api_data_url": "https://registry.npmjs.org/@invisionag%2feslint-config-ivx/0.0.10",
"datasource_id": "npm_package_json",
"purl": "pkg:npm/%40invisionag/eslint-config-ivx@0.0.10"
}
Expand Down
4 changes: 2 additions & 2 deletions tests/summarycode/data/tallies/packages/expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,7 +211,7 @@
"extra_data": {},
"repository_homepage_url": "https://www.npmjs.com/package/@ionic/app-scripts",
"repository_download_url": "https://registry.npmjs.org/@ionic/app-scripts/-/app-scripts-3.0.1-201710301651.tgz",
"api_data_url": "https://registry.npmjs.org/@ionic%2fapp-scripts",
"api_data_url": "https://registry.npmjs.org/@ionic%2fapp-scripts/3.0.1-201710301651",
"package_uid": "pkg:npm/%40ionic/app-scripts@3.0.1-201710301651?uuid=fixed-uid-done-for-testing-5642512d1758",
"datafile_paths": [
"scan/scoped1/package.json"
Expand Down Expand Up @@ -1971,7 +1971,7 @@
],
"repository_homepage_url": "https://www.npmjs.com/package/@ionic/app-scripts",
"repository_download_url": "https://registry.npmjs.org/@ionic/app-scripts/-/app-scripts-3.0.1-201710301651.tgz",
"api_data_url": "https://registry.npmjs.org/@ionic%2fapp-scripts",
"api_data_url": "https://registry.npmjs.org/@ionic%2fapp-scripts/3.0.1-201710301651",
"datasource_id": "npm_package_json",
"purl": "pkg:npm/%40ionic/app-scripts@3.0.1-201710301651"
}
Expand Down