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

feat(npm): add detection for overrides block #15351

Merged
merged 19 commits into from
May 17, 2022
Merged
Show file tree
Hide file tree
Changes from 3 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
63 changes: 63 additions & 0 deletions lib/modules/manager/npm/extract/__snapshots__/index.spec.ts.snap
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,69 @@ Object {
}
`;

exports[`modules/manager/npm/extract/index .extractPackageFile() extracts dependencies from overrides 1`] = `
Object {
"constraints": Object {},
"deps": Array [
Object {
"currentValue": "18.0.5",
"datasource": "npm",
"depName": "@types/react",
"depType": "devDependencies",
"prettyDepType": "devDependency",
},
Object {
"commitMessageTopic": "Node.js",
"currentValue": "8.9.2",
"datasource": "npm",
"depName": "node",
"depType": "overrides",
"prettyDepType": "overrides",
},
Object {
"currentValue": "18.0.5",
"datasource": "npm",
"depName": "@types/react",
"depType": "overrides",
"prettyDepType": "overrides",
},
Object {
"currentValue": "1.0.0",
"datasource": "npm",
"depType": "overrides",
"prettyDepType": "overrides",
},
Object {
"currentValue": "1.0.0",
"datasource": "npm",
"depType": "overrides",
"prettyDepType": "overrides",
},
Object {
"currentValue": "1.0.0",
"datasource": "npm",
"depType": "overrides",
"prettyDepType": "overrides",
},
],
"lernaClient": undefined,
"lernaPackages": undefined,
"managerData": Object {
"lernaJsonFile": undefined,
"yarnZeroInstall": false,
},
"npmLock": undefined,
"npmrc": undefined,
"packageFileVersion": undefined,
"packageJsonName": undefined,
"packageJsonType": "app",
"pnpmShrinkwrap": undefined,
"skipInstalls": true,
"yarnLock": undefined,
"yarnWorkspacesPackages": undefined,
}
`;

exports[`modules/manager/npm/extract/index .extractPackageFile() extracts engines 1`] = `
Object {
"constraints": Object {
Expand Down
70 changes: 70 additions & 0 deletions lib/modules/manager/npm/extract/index.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -669,6 +669,76 @@ describe('modules/manager/npm/extract/index', () => {
],
});
});

it('extracts dependencies from overrides', async () => {
const content = `{
"devDependencies": {
"@types/react": "18.0.5"
},
"overrides": {
"node": "8.9.2",
"@types/react": "18.0.5",
"baz": {
"bar": {
"foo": "1.0.0"
}
},
"foo2": {
hasanwhitesource marked this conversation as resolved.
Show resolved Hide resolved
".": "1.0.0",
"bar2": "1.0.0"
}
}
}`;
const res = await npmExtract.extractPackageFile(
content,
'package.json',
defaultConfig
);
expect(res).toMatchSnapshot({
hasanwhitesource marked this conversation as resolved.
Show resolved Hide resolved
deps: [
{
depType: 'devDependencies',
depName: '@types/react',
currentValue: '18.0.5',
datasource: 'npm',
prettyDepType: 'devDependency',
},
{
depType: 'overrides',
depName: 'node',
currentValue: '8.9.2',
datasource: 'npm',
commitMessageTopic: 'Node.js',
prettyDepType: 'overrides',
},
{
depType: 'overrides',
depName: '@types/react',
currentValue: '18.0.5',
datasource: 'npm',
prettyDepType: 'overrides',
},
{
prettyDepType: 'overrides',
depType: 'overrides',
currentValue: '1.0.0',
datasource: 'npm',
},
{
prettyDepType: 'overrides',
depType: 'overrides',
currentValue: '1.0.0',
datasource: 'npm',
},
{
prettyDepType: 'overrides',
depType: 'overrides',
currentValue: '1.0.0',
datasource: 'npm',
},
],
});
});
});

describe('.postExtract()', () => {
Expand Down
66 changes: 60 additions & 6 deletions lib/modules/manager/npm/extract/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -172,6 +172,7 @@ export async function extractPackageFile(
volta: 'volta',
resolutions: 'resolutions',
packageManager: 'packageManager',
overrides: 'overrides',
};

const constraints: Record<string, any> = {};
Expand Down Expand Up @@ -337,6 +338,55 @@ export async function extractPackageFile(
return dep;
}

/**
hasanwhitesource marked this conversation as resolved.
Show resolved Hide resolved
* Used when there is a json object in override block.
* i.e :
* "overrides": {
"foo": {
".": "1.0.0", // override parent (foo) to be "1.0.0"
"bar": "1.0.0" // override bar to be 1.0.0 when its a child of foo
}
}
* object can be nested. i.e:
"overrides": {
"baz": {
"bar": {
"foo": "1.0.0"
}
}
}
* @param depType
* @param parentDep
* @param children
* @returns PackageDependency array
*/
function extractOverrideDeps(
depType: string,
parentDep: string,
children: NpmPackageDependency
): PackageDependency[] {
const deps: PackageDependency[] = [];
// istanbul ignore if
if (is.nullOrUndefined(depType) || is.nullOrUndefined(children)) {
hasanwhitesource marked this conversation as resolved.
Show resolved Hide resolved
return deps; // extra safe check
}

for (const [key, val] of Object.entries(children)) {
if (is.string(val)) {
let dep: PackageDependency = {};
dep.prettyDepType = depType;
hasanwhitesource marked this conversation as resolved.
Show resolved Hide resolved
dep.depType = depType;
hasanwhitesource marked this conversation as resolved.
Show resolved Hide resolved
const depName = key === '.' ? parentDep : key;
dep = { ...dep, ...extractDependency(depType, depName, val) };
deps.push(dep);
} else {
const depsOfObject = extractOverrideDeps(depType, parentDep, val);
deps.push(...depsOfObject);
}
}
return deps;
}

for (const depType of Object.keys(depTypes) as (keyof typeof depTypes)[]) {
let dependencies = packageJson[depType];
if (dependencies) {
Expand All @@ -362,13 +412,17 @@ export async function extractPackageFile(
if (depName !== key) {
dep.managerData = { key };
}
dep = { ...dep, ...extractDependency(depType, depName, val) };
if (depName === 'node') {
// This is a special case for Node.js to group it together with other managers
dep.commitMessageTopic = 'Node.js';
if (depType === 'overrides' && !is.string(val)) {
deps.push(...extractOverrideDeps(depType, depName, val));
} else {
dep = { ...dep, ...extractDependency(depType, depName, val) };
if (depName === 'node') {
// This is a special case for Node.js to group it together with other managers
dep.commitMessageTopic = 'Node.js';
}
dep.prettyDepType = depTypes[depType];
deps.push(dep);
}
dep.prettyDepType = depTypes[depType];
deps.push(dep);
}
} catch (err) /* istanbul ignore next */ {
logger.debug({ fileName, depType, err }, 'Error parsing package.json');
Expand Down
4 changes: 3 additions & 1 deletion lib/modules/manager/npm/extract/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export interface NpmPackage extends PackageJson {
_id?: any;
dependenciesMeta?: DependenciesMeta;
packageManager?: string;

overrides?: OverrideDependency;
volta?: PackageJson.Dependency;
}

Expand All @@ -31,3 +31,5 @@ export interface LockFile {
export interface PnpmWorkspaceFile {
packages: string[];
}

export type OverrideDependency = Record<string, string | any>;
hasanwhitesource marked this conversation as resolved.
Show resolved Hide resolved
3 changes: 2 additions & 1 deletion lib/modules/manager/npm/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -68,4 +68,5 @@ export type NpmDepType =
| 'devDependencies'
| 'optionalDependencies'
| 'peerDependencies'
| 'resolutions';
| 'resolutions'
| 'overrides';
viceice marked this conversation as resolved.
Show resolved Hide resolved
hasanwhitesource marked this conversation as resolved.
Show resolved Hide resolved