chore: fail early on impossible shrinkwrap #13899
Merged
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
If the **resolved** version of a package (the one we force using Yarn) does not match the **required** version of a package (the one in `package.json`), then NPM ignores the resolved version and installs the package from the `requires` list anyway, *even* if it's processing a shrinkwrap file. Unfortunately, sometimes we have to force this situation, such as with the `netmask` issue, where the required version is declared at `^1.0.6` but we need to force it to be resolved to `2.0.1`. Put simply, if resolved does not match required: * NPM assumes *resolved* is wrong and will install *required*. * We need it to just install *resolved* and not think too much. We achieve this by overwriting what's in *required* in the shrinkwrap file if we encounter this situation.
|
|
nija-at
previously approved these changes
Mar 31, 2021
tools/yarn-cling/lib/index.ts
Outdated
| // On the root, 'requires' is the value 'true', for God knows what reason. Don't care about those. | ||
| if (typeof entry.requires === 'object') { | ||
|
|
||
| // For every 'reuqires' dependency, find the version it actually got resolved to and compare. |
There was a problem hiding this comment.
Suggested change
| // For every 'reuqires' dependency, find the version it actually got resolved to and compare. | |
| // For every 'requires' dependency, find the version it actually got resolved to and compare. |
tools/yarn-cling/lib/index.ts
Outdated
|
|
||
| if (!semver.satisfies(resolvedPackage.version, range)) { | ||
| // NPM would not like this. Make sure it does. | ||
| entry.requires[name] = `^${resolvedPackage.version}`; |
There was a problem hiding this comment.
will caret interfere when we are force-downgrading? Should it just be the specific version rather than caret?
|
Our tests show that while an |
rix0rrr
changed the title
iliapolo
approved these changes
Mar 31, 2021
Co-authored-by: Eli Polonsky <epolon@amazon.com>
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
|
Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
hollanddd
pushed a commit
to hollanddd/aws-cdk
that referenced
this pull request
Mar 31, 2021
If the **resolved** version of a package (the one we force using Yarn) does not match the **required** version of a package (the one in `package.json`), then NPM ignores the resolved version and installs the package from the `requires` list anyway, *even* if it's processing a shrinkwrap file. Unfortunately, sometimes we have to force this situation, such as with the `netmask` issue, where the required version is declared at `^1.0.6` but we need to force it to be resolved to `2.0.1`. Detect this situation early and bail out, so that we don't try to ship something that doesn't have the version resolution we expected to ship. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
hollanddd
pushed a commit
to hollanddd/aws-cdk
that referenced
this pull request
Aug 26, 2021
If the **resolved** version of a package (the one we force using Yarn) does not match the **required** version of a package (the one in `package.json`), then NPM ignores the resolved version and installs the package from the `requires` list anyway, *even* if it's processing a shrinkwrap file. Unfortunately, sometimes we have to force this situation, such as with the `netmask` issue, where the required version is declared at `^1.0.6` but we need to force it to be resolved to `2.0.1`. Detect this situation early and bail out, so that we don't try to ship something that doesn't have the version resolution we expected to ship. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
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.
If the resolved version of a package (the one we force using Yarn)
does not match the required version of a package (the one in
package.json), then NPM ignores the resolved version and installsthe package from the
requireslist anyway, even if it's processinga shrinkwrap file.
Unfortunately, sometimes we have to force this situation, such as with
the
netmaskissue, where the required version is declared at^1.0.6but we need to force it to be resolved to
2.0.1.Detect this situation early and bail out, so that we don't try to ship something
that doesn't have the version resolution we expected to ship.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license