Skip to content
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.

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

Jump to bottom

fix(core): ensure yarn patch and path versions are correct when pruning #13847

Merged
merged 1 commit into from Dec 15, 2022
Merged

fix(core): ensure yarn patch and path versions are correct when pruning #13847

merged 1 commit into from Dec 15, 2022

Conversation

meeroslav
Copy link
Contributor

Current Behavior

Expected Behavior

Related Issue(s)

Fixes #13835

@meeroslav meeroslav self-assigned this Dec 15, 2022
@vercel
Copy link

vercel bot commented Dec 15, 2022 •
edited

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated
nx-dev ✅ Ready (Inspect) Visit Preview Dec 15, 2022 at 2:16PM (UTC)

@meeroslav meeroslav added the scope: core core nx functionality label Dec 15, 2022
meeroslav
meeroslav commented Dec 15, 2022
View reviewed changes
packages/nx/src/lock-file/__fixtures__/yarn.lock.ts
@@ -1,3 +1,18 @@
/**
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updates to lock file fixtures + added copy of package.json that generates it

meeroslav
meeroslav commented Dec 15, 2022
View reviewed changes
packages/nx/src/lock-file/__snapshots__/lock-file.spec.ts.snap
@@ -1006,9 +1006,9 @@ Array [
exports[`lock-file mapLockFileDataToExternalNodes yarn should map lock file data to external nodes 1`] = `
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes caused by updated lock file fixtures

meeroslav
meeroslav commented Dec 15, 2022
View reviewed changes
packages/nx/src/lock-file/__snapshots__/yarn.spec.ts.snap
@@ -22,20 +22,20 @@ Object {

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes influenced by updated lock file fixtures

meeroslav
meeroslav commented Dec 15, 2022
View reviewed changes
packages/nx/src/lock-file/yarn.spec.ts
dependencies: {
'@nrwl/devkit': '15.0.13',
yargs: '17.6.2',
typescript: '4.8.4',
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typescript is erroneously mapped to ~4.8.2 so we want to explicitly test for this scenario

meeroslav
meeroslav commented Dec 15, 2022
View reviewed changes
packages/nx/src/lock-file/yarn.spec.ts
@@ -82,7 +86,7 @@ describe('yarn LockFile utility', () => {

it('should map various instances of the same version', () => {
const babelCoreDependency =
parsedLockFile.dependencies['@babel/core']['@babel/core@7.19.1'];
parsedLockFile.dependencies['@babel/core']['@babel/core@7.20.5'];
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixture update

meeroslav
meeroslav commented Dec 15, 2022
View reviewed changes
packages/nx/src/lock-file/yarn.spec.ts
@@ -46,7 +50,7 @@ describe('yarn LockFile utility', () => {

it('should parse lockfile correctly', () => {
expect(parsedLockFile.lockFileMetadata).toBeUndefined();
expect(Object.keys(parsedLockFile.dependencies).length).toEqual(324);
expect(Object.keys(parsedLockFile.dependencies).length).toEqual(339);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixture update

meeroslav
meeroslav commented Dec 15, 2022
View reviewed changes
packages/nx/src/lock-file/yarn.spec.ts
@@ -104,7 +108,7 @@ describe('yarn LockFile utility', () => {
Object.keys(
pruneYarnLockFile(parsedLockFile, YargsAndDevkitPackage).dependencies
).length
).toEqual(36);
).toEqual(37);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixture update

meeroslav
meeroslav commented Dec 15, 2022
View reviewed changes
packages/nx/src/lock-file/yarn.spec.ts
nx: '14.7.5',
'@nrwl/cli': '15.0.13',
'@nrwl/workspace': '15.0.13',
nx: '15.0.13',
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixture update

meeroslav
meeroslav commented Dec 15, 2022
View reviewed changes
packages/nx/src/lock-file/yarn.spec.ts
@@ -154,7 +158,7 @@ describe('yarn LockFile utility', () => {
},
},
});
expect(Object.keys(parsedLockFile.dependencies).length).toEqual(386);
expect(Object.keys(parsedLockFile.dependencies).length).toEqual(401);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixture update

meeroslav
meeroslav commented Dec 15, 2022
View reviewed changes
packages/nx/src/lock-file/yarn.spec.ts
@@ -180,7 +184,7 @@ describe('yarn LockFile utility', () => {

it('should map various instances of the same version', () => {
const babelCoreDependency =
parsedLockFile.dependencies['@babel/core']['@babel/core@7.19.1'];
parsedLockFile.dependencies['@babel/core']['@babel/core@7.20.5'];
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixture update

meeroslav
meeroslav commented Dec 15, 2022
View reviewed changes
packages/nx/src/lock-file/yarn.spec.ts
"@nrwl/devkit": "14.7.5",
"typescript": "~4.8.2",
"yargs": "^17.4.0",
"@nrwl/devkit": "15.0.13",
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixture update

meeroslav
meeroslav commented Dec 15, 2022
View reviewed changes
packages/nx/src/lock-file/yarn.ts
result[packageName] = result[packageName] || {};
result[packageName][key] = value;
pruneTransitiveDependencies(dependencies, result, value);
if (isBerry) {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For berry we also need to prune patch packages if exists

meeroslav
meeroslav commented Dec 15, 2022
View reviewed changes
packages/nx/src/lock-file/yarn.ts
} else {
value.packageMeta = [
value.resolution ||
`${packageName}@${getVersionFromPackageJson(
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Version from the package.json is the one we keep in the new key

meeroslav
meeroslav commented Dec 15, 2022
View reviewed changes
packages/nx/src/lock-file/yarn.ts
const originalPackageName = packageName.split('@patch:').pop();
const patchSuffix = value.packageMeta[0].split('#').pop();
value.packageMeta = [
`${packageName}@${getVersionFromPackageJson(
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For patch we take patch name + version of the original package in package.json + patch suffix

meeroslav
meeroslav commented Dec 15, 2022
View reviewed changes
packages/nx/src/lock-file/yarn.ts
@@ -299,7 +353,7 @@ function pruneTransitiveDependencies(
[
...Object.entries(value.dependencies ?? {}),
...Object.entries(value.optionalDependencies ?? {}),
].forEach(([packageName, version]) => {
].forEach(([packageName, version]: [string, string]) => {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Making VS Code happy

@nx-cloud
Copy link

nx-cloud bot commented Dec 15, 2022 •
edited

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 525d38d. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

✅ Successfully ran 11 targets

Sent with 💌 from NxCloud.

Coly010
Coly010 approved these changes Dec 15, 2022
View reviewed changes
Copy link
Contributor

@Coly010 Coly010 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

jaysoo
jaysoo reviewed Dec 15, 2022
View reviewed changes
packages/nx/src/lock-file/yarn.ts
normalizedPackageJson: PackageJsonDeps,
dependencies: LockFileData['dependencies'],
result: LockFileData['dependencies'],
isPatch = false
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could isPatch be inferred?

const isPatch = packageName.includes(`@patch:`)

Or

const patchMatch = packageName.match(/(.+)@patch:(.+)/);
// maybe `packageName.match(/(?<pkg>.+)@patch:(.+)/)` for named group
if (patchMatch) {
  const originalPackageName = patchMatch[1]; // patchMatch.groups['pkg'] for named group
  //...
} else {
  //...
}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could, but for performance reasons, it's easier just to pass the boolean, since we know at call whether it's a patch or not.

@jaysoo
Copy link
Member

jaysoo commented Dec 15, 2022

One comment, rest LGTM.

@meeroslav meeroslav merged commit 03be42e into nrwl:master Dec 15, 2022
@meeroslav meeroslav deleted the fix-yarn-lock-version-mapping branch December 15, 2022 15:07
@BugGambit
Copy link

When will this fix be released? I am still struggling with the error Your lockfile needs to be updated, but yarn was run with '--frozen-lockfile'. when run in the dist-folder on NX version 15.3.3.

@meeroslav
Copy link
Contributor Author

It will be released most likely tomorrow.

FrozenPandaz pushed a commit that referenced this pull request Dec 19, 2022
@meeroslav @FrozenPandaz
fix(core): ensure yarn patch and path versions are correct when pruni…
a6e5c88 
…ng (#13847)

Fixes #13835

(cherry picked from commit 03be42e)
@github-actions
Copy link

This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 16, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@jaysoo jaysoo jaysoo left review comments

@Coly010 Coly010 Coly010 approved these changes

@FrozenPandaz FrozenPandaz Awaiting requested review from FrozenPandaz

@AgentEnder AgentEnder Awaiting requested review from AgentEnder

Assignees

@meeroslav meeroslav

Labels
scope: core core nx functionality
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Running yarn install --frozen-lockfile in dist directory with yarn.lock errors
4 participants
@meeroslav @jaysoo @BugGambit @Coly010