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.

Sign up for GitHub

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): catch all lock file parsing/pruning errors and provide fallback #15158

Merged
merged 4 commits into from
Mar 7, 2023
Merged

fix(core): catch all lock file parsing/pruning errors and provide fallback #15158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7d0ca22
feat(core): replace pruning error with notification
meeroslav Feb 21, 2023
bc2ffe9
chore(core): Update packages/nx/src/lock-file/npm-parser.ts
meeroslav Feb 27, 2023
91c9f00
fix(core): catch all parse/prune errors are provide fallback
meeroslav Feb 28, 2023
492bf0c
fix(core): set it to be error
meeroslav Mar 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
87 changes: 62 additions & 25 deletions packages/nx/src/lock-file/lock-file.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import { parsePnpmLockfile, stringifyPnpmLockfile } from './pnpm-parser';
import { parseYarnLockfile, stringifyYarnLockfile } from './yarn-parser';
import { pruneProjectGraph } from './project-graph-pruning';
import { normalizePackageJson } from './utils/package-json';
import { output } from '../utils/output';

const YARN_LOCK_FILE = 'yarn.lock';
const NPM_LOCK_FILE = 'package-lock.json';
Expand Down Expand Up @@ -77,17 +78,25 @@ export function lockFileHash(
export function parseLockFile(
packageManager: PackageManager = detectPackageManager(workspaceRoot)
): ProjectGraph {
if (packageManager === 'yarn') {
const content = readFileSync(YARN_LOCK_PATH, 'utf8');
return parseYarnLockfile(content);
}
if (packageManager === 'pnpm') {
const content = readFileSync(PNPM_LOCK_PATH, 'utf8');
return parsePnpmLockfile(content);
}
if (packageManager === 'npm') {
const content = readFileSync(NPM_LOCK_PATH, 'utf8');
return parseNpmLockfile(content);
try {
if (packageManager === 'yarn') {
const content = readFileSync(YARN_LOCK_PATH, 'utf8');
return parseYarnLockfile(content);
}
if (packageManager === 'pnpm') {
const content = readFileSync(PNPM_LOCK_PATH, 'utf8');
return parsePnpmLockfile(content);
}
if (packageManager === 'npm') {
const content = readFileSync(NPM_LOCK_PATH, 'utf8');
return parseNpmLockfile(content);
}
} catch (e) {
output.error({
title: `Failed to parse ${packageManager} lockfile`,
bodyLines: errorBodyLines(e),
});
return;
}
throw new Error(`Unknown package manager: ${packageManager}`);
}
Expand Down Expand Up @@ -127,19 +136,47 @@ export function createLockFile(
const normalizedPackageJson = normalizePackageJson(packageJson);
const content = readFileSync(getLockFileName(packageManager), 'utf8');

if (packageManager === 'yarn') {
const graph = parseYarnLockfile(content);
const prunedGraph = pruneProjectGraph(graph, packageJson);
return stringifyYarnLockfile(prunedGraph, content, normalizedPackageJson);
}
if (packageManager === 'pnpm') {
const graph = parsePnpmLockfile(content);
const prunedGraph = pruneProjectGraph(graph, packageJson);
return stringifyPnpmLockfile(prunedGraph, content, normalizedPackageJson);
}
if (packageManager === 'npm') {
const graph = parseNpmLockfile(content);
const prunedGraph = pruneProjectGraph(graph, packageJson);
return stringifyNpmLockfile(prunedGraph, content, normalizedPackageJson);
try {
if (packageManager === 'yarn') {
const graph = parseYarnLockfile(content);
const prunedGraph = pruneProjectGraph(graph, packageJson);
return stringifyYarnLockfile(prunedGraph, content, normalizedPackageJson);
}
if (packageManager === 'pnpm') {
const graph = parsePnpmLockfile(content);
const prunedGraph = pruneProjectGraph(graph, packageJson);
return stringifyPnpmLockfile(prunedGraph, content, normalizedPackageJson);
}
if (packageManager === 'npm') {
const graph = parseNpmLockfile(content);
const prunedGraph = pruneProjectGraph(graph, packageJson);
return stringifyNpmLockfile(prunedGraph, content, normalizedPackageJson);
}
} catch (e) {
const additionalInfo = [
'To prevent the build from breaking we are returning the root lock file.',
];
if (packageManager === 'npm') {
additionalInfo.push(
'If you run `npm install --package-lock-only` in your output folder it will regenerate the correct pruned lockfile.'
);
}
output.error({
title: 'An error occured while creating pruned lockfile',
bodyLines: errorBodyLines(e, additionalInfo),
});
return content;
}
}

// generate body lines for error message
function errorBodyLines(originalError: Error, additionalInfo: string[] = []) {
return [
'Please open an issue at `https://github.com/nrwl/nx/issues/new?template=1-bug.yml` and provide a reproduction.',

...additionalInfo,

`\nOriginal error: ${originalError.message}\n\n`,
originalError.stack,
];
}
7 changes: 6 additions & 1 deletion packages/nx/src/lock-file/npm-parser.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -524,7 +524,12 @@ function nestMappedPackages(
});

if (initialSize === nestedNodes.size) {
throw Error('Loop detected while pruning. Please report this issue.');
throw new Error(
[
'Following packages could not be mapped to the NPM lockfile:',
...Array.from(nestedNodes).map((n) => `- ${n.name}`),
].join('\n')
);
} else {
nestMappedPackages(
invertedGraph,
Expand Down