FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Better Prerender Errors by ForsakenHarmony · Pull Request #754 · preactjs/preact-cli · GitHub

/ preact-cli Public

Better Prerender Errors #754

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

Draft
ForsakenHarmony wants to merge 3 commits into
base: master
Choose a base branch
Could not load branches
Branch not found: {{ refName }}

Are you sure you want to change the base?

Some commits from the old base branch may be removed from the timeline, and old review comments may become outdated.
from
Conversation 4 Commits 3 Checks 0 Files changed
Draft

Better Prerender Errors #754

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
71c1511
better prerender errors myb
ForsakenHarmony Feb 27, 2019
bb94b1e
feat: outdent error message
ForsakenHarmony Jul 12, 2019
b13829d
feat: use babel code frame
ForsakenHarmony Jul 26, 2019
File filter

Filter by extension

Filter by extension .js  (2) .json  (1) .lock  (1) All 3 file types selected
Only manifest files
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
5 changes: 4 additions & 1 deletion packages/cli/lib/lib/babel-config.js
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,10 @@ module.exports = function(env, options = {}) {
require.resolve('@babel/plugin-syntax-dynamic-import'),
require.resolve('@babel/plugin-transform-object-assign'),
[require.resolve('@babel/plugin-proposal-decorators'), { legacy: true }],
[require.resolve('@babel/plugin-proposal-class-properties'), { loose: true }],
[
require.resolve('@babel/plugin-proposal-class-properties'),
{ loose: true },
],
require.resolve('@babel/plugin-proposal-object-rest-spread'),
isProd &&
require.resolve('babel-plugin-transform-react-remove-prop-types'),
Expand Down
177 changes: 96 additions & 81 deletions packages/cli/lib/lib/webpack/prerender.js
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
const { red, yellow } = require('kleur');
const { red } = require('kleur');
const { resolve } = require('path');
const { readFileSync } = require('fs');
const stackTrace = require('stack-trace');
const { SourceMapConsumer } = require('source-map');
const { error, info } = require('../../util');
const outdent = require('outdent');
const { codeFrameColumns } = require('@babel/code-frame');

module.exports = function(env, params) {
module.exports = function prerender(env, params) {
params = params || {};

let entry = resolve(env.dest, './ssr-build/ssr-bundle.js');
Expand All @@ -14,8 +17,8 @@ module.exports = function(env, params) {
global.location = { href: url, pathname: url };

try {
let m = require(entry),
app = (m && m.default) || m;
const m = require(entry);
const app = (m && m.default) || m;

if (typeof app !== 'function') {
// eslint-disable-next-line no-console
Expand All @@ -32,105 +35,117 @@ module.exports = function(env, params) {
));
return renderToString(preact.h(app, { ...params, url }));
} catch (err) {
let stack = stackTrace.parse(err).filter(s => s.getFileName() === entry)[0];
const stack = stackTrace
.parse(err)
.filter(s => s.getFileName().includes('ssr-build'))[0];
if (!stack) {
throw err;
error(err);
return '';
}

handlePrerenderError(err, env, stack, entry);
return '';
}
};

async function handlePrerenderError(err, env, stack, entry) {
let errorMessage = err.toString();
let isReferenceError = errorMessage.startsWith('ReferenceError');
let methodName = stack.getMethodName();
let sourceMapContent, position, sourcePath, sourceLines, sourceCodeHighlight;

function getLines(env, position) {
let sourcePath;
try {
sourceMapContent = JSON.parse(readFileSync(`${entry}.map`));
sourcePath = resolve(env.src, position.source);
return readFileSync(sourcePath, 'utf-8').split('\n');
} catch (err) {
process.stderr.write(red(`Unable to read sourcemap: ${entry}.map\n`));
try {
sourcePath = resolve(env.cwd, position.source);
return readFileSync(sourcePath, 'utf-8').split('\n');
} catch (err) {
error(`Unable to read file: ${sourcePath} (${position.source})\n`);
}
}
}

if (sourceMapContent) {
await SourceMapConsumer.with(sourceMapContent, null, consumer => {
position = consumer.originalPositionFor({
line: stack.getLineNumber(),
column: stack.getColumnNumber(),
async function handlePrerenderError(err, env, stack, entry) {
const errorMessage = err.toString();
const isReferenceError = errorMessage.startsWith('ReferenceError');
const methodName = stack.getMethodName();
const fileName = stack.getFileName().replace(/\\/g, '/');

let position;

info(fileName);
if (/webpack:/.test(fileName)) {
position = {
source: fileName.replace(/.+webpack:/, 'webpack://'),
line: stack.getLineNumber(),
column: stack.getColumnNumber(),
};
} else {
try {
const sourceMapContent = JSON.parse(
readFileSync(`${entry}.map`, 'utf-8')
);

await SourceMapConsumer.with(sourceMapContent, null, consumer => {
position = consumer.originalPositionFor({
line: stack.getLineNumber(),
column: stack.getColumnNumber(),
});
});
});
} catch (err) {
error(`Unable to read sourcemap: ${entry}.map`);
}
}

if (position) {
info(JSON.stringify(position));
position.source = position.source
.replace('webpack://', '.')
.replace(/^.*~\/((?:@[^/]+\/)?[^/]+)/, (s, name) =>
require
.resolve(name)
.replace(/^(.*?\/node_modules\/(@[^/]+\/)?[^/]+)(\/.*)$/, '$1')
);

sourcePath = resolve(env.src, position.source);
sourceLines;
try {
sourceLines = readFileSync(sourcePath, 'utf-8').split('\n');
} catch (err) {
try {
sourceLines = readFileSync(
require.resolve(position.source),
'utf-8'
).split('\n');
} catch (err) {
process.stderr.write(red(`Unable to read file: ${sourcePath}\n`));
}
// process.stderr.write(red(`Unable to read file: ${sourcePath}\n`));
}
sourceCodeHighlight = '';

if (sourceLines) {
for (var i = -4; i <= 4; i++) {
let color = i === 0 ? red : yellow;
let line = position.line + i;
let sourceLine = sourceLines[line - 1];
sourceCodeHighlight += sourceLine ? `${color(sourceLine)}\n` : '';
}
}
}

process.stderr.write('\n');
process.stderr.write(red(`${errorMessage}\n`));
process.stderr.write(`method: ${methodName}\n`);
if (sourceMapContent) {
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(stack.toString() + '\n');
position = {
source: stack.getFileName(),
line: stack.getLineNumber(),
column: stack.getColumnNumber(),
};
}
process.stderr.write(
`This ${

const sourceLines = getLines(env, position);

let sourceCodeHighlight = sourceLines
? codeFrameColumns(
sourceLines.join('\n'),
{ start: { line: position.line, column: position.column } },
{ highlightCode: true }
)
: '';

const stderr = process.stderr.write.bind(process.stderr);

stderr('\n');
stderr(outdent`
[PrerenderError]: ${red(`${errorMessage}`)}
--> ${position.source}:${position.line}:${position.column} (${methodName ||
'<anonymous>'})
${sourceCodeHighlight}

${red(`${err.stack}`)}

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`
);
process.stderr.write(
`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('\n');
process.stderr.write(
`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.'
);
} caused by using DOM or Web APIs.
Pre-render runs in node and has no access to globals available in browsers.
Consider wrapping code producing error in: 'if (typeof window !== "undefined") { ... }\
${
methodName === 'componentWillMount'
? `\nor place logic in 'componentDidMount' method.`
: ''
}

Alternatively use \`preact build --no-prerender\` to disable prerendering.
See https://github.com/developit/preact-cli#pre-rendering for further information.
`);
process.exit(1);
}
2 changes: 2 additions & 0 deletions packages/cli/package.json
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@
"preact-render-to-string": "*"
},
"dependencies": {
"@babel/code-frame": "^7.5.5",
"@babel/core": "^7.4.5",
"@babel/plugin-proposal-class-properties": "^7.4.4",
"@babel/plugin-proposal-decorators": "^7.4.4",
Expand Down Expand Up @@ -105,6 +106,7 @@
"minimatch": "^3.0.3",
"optimize-css-assets-webpack-plugin": "^5.0.1",
"ora": "^3.4.0",
"outdent": "^0.7.0",
"postcss-load-config": "^2.1.0",
"postcss-loader": "^3.0.0",
"progress-bar-webpack-plugin": "^1.12.1",
Expand Down
14 changes: 13 additions & 1 deletion yarn.lock
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,13 @@
dependencies:
"@babel/highlight" "^7.0.0"

"@babel/code-frame@^7.5.5":
version "7.5.5"
resolved "https://registry.yarnpkg.com/@babel/code-frame/-/code-frame-7.5.5.tgz#bc0782f6d69f7b7d49531219699b988f669a8f9d"
integrity sha512-27d4lZoomVyo51VegxI20xZPuSHusqbQag/ztrBC7wegWoQ1nLREPVSKSW8byhTlzTKyNE4ifaTA6lCp7JjpFw==
dependencies:
"@babel/highlight" "^7.0.0"

"@babel/core@^7.1.0", "@babel/core@^7.4.0", "@babel/core@^7.4.5":
version "7.5.4"
resolved "https://registry.yarnpkg.com/@babel/core/-/core-7.5.4.tgz#4c32df7ad5a58e9ea27ad025c11276324e0b4ddd"
Expand Down Expand Up @@ -9653,6 +9660,11 @@ osenv@0, osenv@^0.1.4, osenv@^0.1.5:
os-homedir "^1.0.0"
os-tmpdir "^1.0.0"

outdent@^0.7.0:
version "0.7.0"
resolved "https://registry.yarnpkg.com/outdent/-/outdent-0.7.0.tgz#cfd1f1956305141e0cf3e898ada6547373c1997a"
integrity sha512-Ue462G+UIFoyQmOzapGIKWS3d/9NHeD/018WGEDZIhN2/VaQpVXbofMcZX0socv1fw4/tmEn7Vd3McOdPZfKzQ==

p-cancelable@^1.0.0:
version "1.1.0"
resolved "https://registry.yarnpkg.com/p-cancelable/-/p-cancelable-1.1.0.tgz#d078d15a3af409220c886f1d9a0ca2e441ab26cc"
Expand Down Expand Up @@ -10211,7 +10223,7 @@ postcss-discard-overridden@^4.0.1:
dependencies:
postcss "^7.0.0"

postcss-load-config@^2.0.0:
postcss-load-config@^2.0.0, postcss-load-config@^2.1.0:
version "2.1.0"
resolved "https://registry.yarnpkg.com/postcss-load-config/-/postcss-load-config-2.1.0.tgz#c84d692b7bb7b41ddced94ee62e8ab31b417b003"
integrity sha512-4pV3JJVPLd5+RueiVVB+gFOAa7GWc25XQcMp86Zexzke69mKf6Nx9LRcQywdz7yZI9n1udOxmLuAwTBypypF8Q==
Expand Down
Back | FazBrowse Home | New Git URL