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

Better prerender crash message when error originates in node_modules/ #1426

Merged
merged 3 commits into from Apr 15, 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
5 changes: 5 additions & 0 deletions .changeset/twenty-cycles-tickle.md
@@ -0,0 +1,5 @@
---
'preact-cli': patch
---

Improves prerender error message when offending use of browser globals cannot be found
42 changes: 27 additions & 15 deletions packages/cli/lib/lib/webpack/prerender.js
Expand Up @@ -48,7 +48,7 @@ async function handlePrerenderError(err, env, stack, entry) {
let sourceMapContent, position, sourcePath, sourceLines, sourceCodeHighlight;

try {
sourceMapContent = JSON.parse(readFileSync(`${entry}.map`));
sourceMapContent = JSON.parse(readFileSync(`${entry}.map`, 'utf-8'));
} catch (err) {
process.stderr.write(red(`Unable to read sourcemap: ${entry}.map\n`));
}
Expand Down Expand Up @@ -100,39 +100,51 @@ async function handlePrerenderError(err, env, stack, entry) {

process.stderr.write('\n');
process.stderr.write(red(`${errorMessage}\n`));
process.stderr.write(`method: ${methodName}\n`);
if (sourceMapContent) {
// check if we have methodName (ie, the error originated in user code)
if (methodName) {
process.stderr.write(`method: ${methodName}\n`);
if (sourceMapContent & sourceCodeHighlight) {
process.stderr.write(
`at: ${sourcePath}:${position.line}:${position.column}\n`
);
process.stderr.write('\n');
process.stderr.write('Source code:\n\n');
process.stderr.write(sourceCodeHighlight);
process.stderr.write('\n');
} else {
process.stderr.write('\n');
process.stderr.write('Stack:\n\n');
process.stderr.write(JSON.stringify(stack, null, 4) + '\n');
}
} else {
process.stderr.write(
`at: ${sourcePath}:${position.line}:${position.column}\n`
yellow(
'Cannot determine error position. This most likely means it originated in node_modules.'
)
);
process.stderr.write('\n');
process.stderr.write('Source code:\n\n');
process.stderr.write(sourceCodeHighlight);
process.stderr.write('\n');
} else {
process.stderr.write(stack.toString() + '\n');
process.stderr.write('\n\n');
}
process.stderr.write(
`This ${
isReferenceError ? 'is most likely' : 'could be'
} caused by using DOM or Web APIs.\n`
);
process.stderr.write(
`Pre-render runs in node and has no access to globals available in browsers.\n\n`
'Pre-render runs in node and has no access to globals available in browsers.\n\n'
);
process.stderr.write(
`Consider wrapping code producing error in: 'if (typeof window !== "undefined") { ... }'\n`
'Consider wrapping code producing error in: "if (typeof window !== "undefined") { ... }"\n'
);

if (methodName === 'componentWillMount') {
process.stderr.write(`or place logic in 'componentDidMount' method.\n`);
process.stderr.write('or place logic in "componentDidMount" method.\n');
}
process.stderr.write('\n');
process.stderr.write(
`Alternatively use 'preact build --no-prerender' to disable prerendering.\n\n`
'Alternatively use "preact build --no-prerender" to disable prerendering.\n\n'
);
process.stderr.write(
'See https://github.com/developit/preact-cli#pre-rendering for further information.'
'See https://github.com/preactjs/preact-cli#pre-rendering for further information.\n\n'
rschristian marked this conversation as resolved.
Show resolved Hide resolved
);
process.exit(1);
}