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

fix(devkit): incorrect conditional to decide if package should be added #12749

Merged
merged 1 commit into from Oct 21, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
33 changes: 33 additions & 0 deletions packages/devkit/src/utils/package-json.spec.ts
Expand Up @@ -275,4 +275,37 @@ describe('addDependenciesToPackageJson', () => {
});
expect(installTask).toBeDefined();
});

it('should not overwrite dependencies when they exist in devDependencies or vice versa and the new version is tilde', () => {
// ARRANGE
writeJson(tree, 'package.json', {
dependencies: {
tslib: '2.4.0',
},
devDependencies: {
nx: '15.0.0',
},
});

// ACT
const installTask = addDependenciesToPackageJson(
tree,
{
tslib: '~2.3.0',
},
{
nx: '15.0.0',
}
);

// ASSERT
const { dependencies, devDependencies } = readJson(tree, 'package.json');
expect(dependencies).toEqual({
tslib: '2.4.0',
});
expect(devDependencies).toEqual({
nx: '15.0.0',
});
expect(installTask).toBeDefined();
});
});
80 changes: 51 additions & 29 deletions packages/devkit/src/utils/package-json.ts
Expand Up @@ -5,6 +5,7 @@ import { GeneratorCallback } from 'nx/src/config/misc-interfaces';
import { coerce, gt } from 'semver';

const NON_SEMVER_TAGS = {
'*': 2,
next: 1,
latest: 0,
previous: -1,
Expand All @@ -24,6 +25,27 @@ function filterExistingDependencies(
.reduce((acc, d) => ({ ...acc, [d]: dependencies[d] }), {});
}

function isIncomingVersionGreater(
incomingVersion: string,
existingVersion: string
) {
if (
incomingVersion in NON_SEMVER_TAGS &&
existingVersion in NON_SEMVER_TAGS
) {
return NON_SEMVER_TAGS[incomingVersion] > NON_SEMVER_TAGS[existingVersion];
}

if (
incomingVersion in NON_SEMVER_TAGS ||
existingVersion in NON_SEMVER_TAGS
) {
return true;
}

return gt(coerce(incomingVersion), coerce(existingVersion));
}

function updateExistingDependenciesVersion(
dependencies: Record<string, string>,
existingAltDependencies: Record<string, string>
Expand All @@ -37,23 +59,7 @@ function updateExistingDependenciesVersion(
const incomingVersion = dependencies[d];
const existingVersion = existingAltDependencies[d];

if (
incomingVersion in NON_SEMVER_TAGS &&
existingVersion in NON_SEMVER_TAGS
) {
return (
NON_SEMVER_TAGS[incomingVersion] > NON_SEMVER_TAGS[existingVersion]
);
}

if (
incomingVersion in NON_SEMVER_TAGS ||
existingVersion in NON_SEMVER_TAGS
) {
return true;
}

return gt(coerce(incomingVersion), coerce(existingVersion));
return isIncomingVersionGreater(incomingVersion, existingVersion);
})
.reduce((acc, d) => ({ ...acc, [d]: dependencies[d] }), {});
}
Expand Down Expand Up @@ -205,21 +211,37 @@ function requiresAddingOfPackages(packageJsonFile, deps, devDeps): boolean {
packageJsonFile.devDependencies = packageJsonFile.devDependencies || {};

if (Object.keys(deps).length > 0) {
needsDepsUpdate =
Object.keys(deps).some((entry) => !packageJsonFile.dependencies[entry]) ||
Object.keys(deps).some(
(entry) => !packageJsonFile.devDependencies[entry]
);
needsDepsUpdate = Object.keys(deps).some((entry) => {
const incomingVersion = deps[entry];
if (packageJsonFile.dependencies[entry]) {
const existingVersion = packageJsonFile.dependencies[entry];
return isIncomingVersionGreater(incomingVersion, existingVersion);
}

if (packageJsonFile.devDependencies[entry]) {
const existingVersion = packageJsonFile.devDependencies[entry];
return isIncomingVersionGreater(incomingVersion, existingVersion);
}

return true;
});
}

if (Object.keys(devDeps).length > 0) {
needsDevDepsUpdate =
Object.keys(devDeps).some(
(entry) => !packageJsonFile.devDependencies[entry]
) ||
Object.keys(devDeps).some(
(entry) => !packageJsonFile.dependencies[entry]
);
needsDevDepsUpdate = Object.keys(devDeps).some((entry) => {
const incomingVersion = devDeps[entry];
if (packageJsonFile.devDependencies[entry]) {
const existingVersion = packageJsonFile.devDependencies[entry];
return isIncomingVersionGreater(incomingVersion, existingVersion);
}
if (packageJsonFile.dependencies[entry]) {
const existingVersion = packageJsonFile.dependencies[entry];

return isIncomingVersionGreater(incomingVersion, existingVersion);
}

return true;
});
}

return needsDepsUpdate || needsDevDepsUpdate;
Expand Down