Only allow plugin update functionality when installed from npm #2356
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
BenSurgisonGDS
changed the title
BenSurgisonGDS
force-pushed
the
only-allow-update-functionality-when-possible
branch
from
fac2ce1
to
fbc819a
Compare
BenSurgisonGDS
force-pushed
the
only-allow-update-functionality-when-possible
branch
from
fbc819a
to
487d7ff
Compare
BenSurgisonGDS
force-pushed
the
only-allow-update-functionality-when-possible
branch
from
487d7ff
to
b062961
Compare
| @@ -87,6 +87,7 @@ async function refreshPackageInfo (packageName, version) { | |||
| const installedPackageVersion = packageJson && projectPackage.dependencies[packageName] | |||
There was a problem hiding this comment.
@BenSurgisonGDS Might be a good idea to use .packages[packageName]
The legacy dependencies[packageName] entry is dropped in newer npm versions and only exists for compatibility in older projects created before "lockfileVersion": 3 was the default
You can use the CLI to switch lockfile version:
npm install --lockfile-version 2
npm install --lockfile-version 3Which will show the legacy dependencies no longer exists in v3:
{
"name": "test-prototype",
"lockfileVersion": 3,
"packages": {
"../../../../../../../path/to/govuk-prototype-kit": {
"version": "13.13.4",
"dependencies": {}
}
- },
- "dependencies": {
- "govuk-prototype-kit": {
- "version": "file:../../../../../../../Users/colin/Sites/GDS/govuk-prototype-kit",
- "requires": {}
- }
+ }
}There was a problem hiding this comment.
I think it would be great to do this in a future ticket
lib/plugins/packages.js
Outdated
| @@ -87,6 +87,7 @@ async function refreshPackageInfo (packageName, version) { | |||
| const installedPackageVersion = packageJson && projectPackage.dependencies[packageName] | |||
| const installed = !!installedPackageVersion | |||
| const installedLocally = installedPackageVersion?.startsWith('file:') | |||
| const installedFromGithub = installedPackageVersion?.startsWith('github') | |||
There was a problem hiding this comment.
Probably want to run resolved through new URL() confirming hostname as registry.npmjs.org?
{
"name": "test-prototype",
"lockfileVersion": 3,
"packages": {
"node_modules/govuk-prototype-kit": {
"version": "13.13.4",
"resolved": "https://registry.npmjs.org/govuk-prototype-kit/-/govuk-prototype-kit-13.13.4.tgz",
"integrity": "sha512-P4HfYXIAUpjWe5NIfTEYxOkg0iE9GuQBmJ0KO+KoFVkFre2yPlAoa3kQA30UjjvtT2+c+Sc70Abkx424rwaiAg==",
"dependencies": {}
}
}
}There was a problem hiding this comment.
For now though, shall we prefer github: (with a colon) consistent with file:?
Suggested change
| const installedFromGithub = installedPackageVersion?.startsWith('github') | |
| const installedFromGithub = installedPackageVersion?.startsWith('github:') |
There was a problem hiding this comment.
Done as suggested
| @@ -87,6 +87,7 @@ async function refreshPackageInfo (packageName, version) { | |||
| const installedPackageVersion = packageJson && projectPackage.dependencies[packageName] | |||
| const installed = !!installedPackageVersion | |||
| const installedLocally = installedPackageVersion?.startsWith('file:') | |||
There was a problem hiding this comment.
For another PR, but this will be "link": true in the new lockfile format too
colinrotherham
previously approved these changes
Oct 9, 2023
There was a problem hiding this comment.
Does what it says ✅
Related but not blocking, could do with writing up an issue for:
- Compatibility with npm v9
"lockfileVersion": 3 - Suppressing link "New version available" for linked kit package (see below)
nataliecarey
previously approved these changes
Oct 10, 2023
BenSurgisonGDS
dismissed stale reviews from nataliecarey and colinrotherham
via
4fe2805
BenSurgisonGDS
force-pushed
the
only-allow-update-functionality-when-possible
branch
from
74b94e9
to
4fe2805
Compare
colinrotherham
approved these changes
Oct 11, 2023
BenSurgisonGDS
deleted the
only-allow-update-functionality-when-possible
branch
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.
The kit had wrongly indicated that a plugin installed directly from github could be updated. This caused a user's prototype to crash when they attempted this. As the kit was only designed to allow updates from the npm registry, this change prevents the update button to appear for those plugins installed locally or from github. If the user wants to update their plugin installed from github, they'll have to upgrade it manually from the command line as they had installed it in the first place.