Skip to content

Commit

Permalink
Better prerender crash message when error originates in node_modules/ (
Browse files Browse the repository at this point in the history
…#1426)

* Better prerender crash message when error originates in node_modules/

* chore: Formatting

* docs: Adding changeset

Co-authored-by: Ryan Christian <ryanchristian4427@gmail.com>
  • Loading branch information
VanTanev and rschristian committed Apr 15, 2022
1 parent 7afd8bb commit 7d33cd1
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 15 deletions.
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'
);
process.exit(1);
}

0 comments on commit 7d33cd1

Please sign in to comment.