Skip to content

Commit e1f9ef3

Browse files
jahredhopejahredhope
authored
fix: Ensure render errors are caught before success messaging sent (#49)
1 parent 400c8bf commit e1f9ef3

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+1268
-1125
lines changed

‎.eslintrc.js

+7-7
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,18 @@ module.exports = {
77
files: ["**/*.js"],
88
rules: {
99
"@typescript-eslint/no-var-requires": "off",
10-
"@typescript-eslint/explicit-function-return-type": "off"
11-
}
12-
}
10+
"@typescript-eslint/explicit-function-return-type": "off",
11+
},
12+
},
1313
],
1414
parserOptions: {
1515
ecmaVersion: 2018,
16-
sourceType: "module"
16+
sourceType: "module",
1717
},
1818
env: {
1919
es6: true,
2020
jest: true,
21-
node: true
21+
node: true,
2222
},
2323
rules: {
2424
"@typescript-eslint/ban-ts-ignore": "warn",
@@ -27,6 +27,6 @@ module.exports = {
2727
"@typescript-eslint/no-non-null-assertion": "off",
2828
"@typescript-eslint/explicit-function-return-type": "off",
2929
"no-console": "off",
30-
"no-inner-declarations": "off"
31-
}
30+
"no-inner-declarations": "off",
31+
},
3232
};

‎jest.config.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@ module.exports = {
22
testEnvironment: "node",
33
transform: {},
44
watchPathIgnorePatterns: ["/dist/"],
5-
preset: "ts-jest"
5+
preset: "ts-jest",
66
};

‎package.json

+14-14
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@
1515
"build": "tsc --declaration",
1616
"commit": "git-cz",
1717
"lint.eslint": "eslint src/**/*.ts",
18-
"lint.prettier": "prettier --list-different \"**/*.js\"",
18+
"lint.prettier": "prettier --check \"**/*.(js|ts)\"",
1919
"lint": "npm run lint.eslint && npm run lint.prettier",
2020
"jest": "jest",
2121
"prepublishOnly": "npm run build",
2222
"test": "npm run lint && npm run jest",
23-
"format": "prettier --write \"**/*.js\"",
23+
"format": "prettier --write \"**/*.(js|ts)\"",
2424
"release": "semantic-release"
2525
},
2626
"repository": {
@@ -32,29 +32,29 @@
3232
},
3333
"devDependencies": {
3434
"@types/debug": "^4.1.5",
35-
"@types/express": "^4.17.2",
36-
"@types/jest": "^25.1.3",
35+
"@types/express": "^4.17.3",
36+
"@types/jest": "^25.1.4",
3737
"@types/memory-fs": "^0.3.2",
3838
"@types/schema-utils": "^2.4.0",
39-
"@types/webpack": "^4.41.6",
40-
"@typescript-eslint/eslint-plugin": "^2.20.0",
41-
"@typescript-eslint/parser": "^2.20.0",
39+
"@types/webpack": "^4.41.8",
40+
"@typescript-eslint/eslint-plugin": "^2.25.0",
41+
"@typescript-eslint/parser": "^2.25.0",
4242
"commitizen": "4.0.3",
4343
"cz-conventional-changelog": "3.1.0",
4444
"eslint": "6.8.0",
4545
"exception-formatter": "^2.1.2",
4646
"express": "^4.17.1",
47-
"jest": "25.1.0",
47+
"jest": "25.2.3",
4848
"memoizee": "^0.4.14",
4949
"memory-fs": "^0.5.0",
50-
"prettier": "1.19.1",
51-
"react": "^16.12.0",
52-
"react-dom": "^16.12.0",
50+
"prettier": "2.0.2",
51+
"react": "^16.13.1",
52+
"react-dom": "^16.13.1",
5353
"semantic-release": "17.0.4",
5454
"ts-jest": "^25.2.1",
55-
"ts-node": "^8.6.2",
56-
"typescript": "^3.8.2",
57-
"webpack": "4.41.6",
55+
"ts-node": "^8.8.1",
56+
"typescript": "^3.8.3",
57+
"webpack": "4.42.1",
5858
"webpack-merge": "4.2.2"
5959
},
6060
"dependencies": {

‎src/common-types.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ export type Specifier = string;
1717
export type ExtraGlobals = object;
1818
export type RenderConcurrency = "parallel" | "serial";
1919
export type MapStatsToParams = ({
20-
webpackStats
20+
webpackStats,
2121
}: {
2222
webpackStats: WebpackStats;
2323
}) => object;

‎src/createDevRouter.ts

+7-6
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ import {
66
BaseRoute,
77
WebpackStats,
88
TransformExpressPath,
9-
GetRouteFromRequest
9+
GetRouteFromRequest,
1010
} from "common-types";
1111
import { Stats } from "webpack";
1212

@@ -23,7 +23,7 @@ export = <Route extends BaseRoute>({
2323
getRouteFromRequest,
2424
onRendererReady,
2525
transformExpressPath,
26-
getClientStats
26+
getClientStats,
2727
}: Params<Route>) => {
2828
log("Create dev server");
2929
const formatErrorResponse = (
@@ -36,7 +36,8 @@ export = <Route extends BaseRoute>({
3636
const devServerAssets = webpackStats.entrypoints.main.assets;
3737

3838
devServerScripts = devServerAssets.map(
39-
asset => `<script src="${webpackStats.publicPath}${asset}"></script>`
39+
(asset) =>
40+
`<script src="${webpackStats.publicPath}${asset}"></script>`
4041
);
4142
} catch (err) {
4243
console.error("Unable to load Dev Server Scripts. Error: ", err);
@@ -51,7 +52,7 @@ export = <Route extends BaseRoute>({
5152
const routesByExpressPath: Record<string, Route> = {};
5253

5354
// Deduplicate paths to avoid duplicated processing in Express
54-
routes.forEach(route => {
55+
routes.forEach((route) => {
5556
const expressPath = transformExpressPath(route);
5657
if (expressPath) {
5758
routesByExpressPath[expressPath] = route;
@@ -62,7 +63,7 @@ export = <Route extends BaseRoute>({
6263
devServerRouter.get(
6364
expressPath,
6465
async (req: Request, res: Response, next: NextFunction) => {
65-
onRendererReady(async render => {
66+
onRendererReady(async (render) => {
6667
const route = getRouteFromRequest
6768
? getRouteFromRequest(req, routes)
6869
: defaultRoute;
@@ -84,7 +85,7 @@ export = <Route extends BaseRoute>({
8485
exceptionFormatter(error, {
8586
format: "html",
8687
inlineStyle: true,
87-
basepath: "webpack://static/./"
88+
basepath: "webpack://static/./",
8889
}),
8990
getClientStats().toJson()
9091
)

‎src/createRenderer.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ import { SourceModules, ExtraGlobals } from "common-types";
44
export = function createRenderer({
55
fileName,
66
source,
7-
extraGlobals
7+
extraGlobals,
88
}: {
99
fileName: string;
1010
source: SourceModules;

‎src/evalutateFromSource.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ function evalutateFromSource(
2828
console,
2929
process,
3030
...(extraGlobals || {}),
31-
require: createLinker(specifier, sourceModules, extraGlobals)
31+
require: createLinker(specifier, sourceModules, extraGlobals),
3232
},
3333
/* includeGlobals: */ true
3434
);

‎src/index.ts

+17-15
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ import {
1818
TransformExpressPath,
1919
TransformPath,
2020
WebpackStats,
21-
GetRouteFromRequest
21+
GetRouteFromRequest,
2222
} from "./common-types";
2323
import { Compiler, compilation, Stats } from "webpack";
2424
import getSourceFromCompilation from "./getSourceFromCompilation";
@@ -64,10 +64,10 @@ export = class HtmlRenderPlugin<Route extends BaseRoute = BaseRoute> {
6464
getRouteFromRequest,
6565
transformFilePath = defaultTransform,
6666
transformExpressPath = defaultTransform,
67-
renderConcurrency = "serial"
67+
renderConcurrency = "serial",
6868
} = options;
6969

70-
const routes: Route[] = (options.routes || [""]).map(route =>
70+
const routes: Route[] = (options.routes || [""]).map((route) =>
7171
typeof route === "string" ? ({ route } as Route) : route
7272
);
7373

@@ -82,7 +82,9 @@ export = class HtmlRenderPlugin<Route extends BaseRoute = BaseRoute> {
8282
const isBuildReady = () =>
8383
rendererCompilation &&
8484
rendererCompilation.isReady &&
85-
clientCompilations.every(compilationStatus => compilationStatus.isReady);
85+
clientCompilations.every(
86+
(compilationStatus) => compilationStatus.isReady
87+
);
8688
const isRendererReady = () => isBuildReady() && renderer;
8789

8890
const renderQueue: Array<() => void> = [];
@@ -101,11 +103,11 @@ export = class HtmlRenderPlugin<Route extends BaseRoute = BaseRoute> {
101103
...route,
102104
...mapStatsToParams({
103105
...route,
104-
webpackStats
105-
})
106+
webpackStats,
107+
}),
106108
};
107109
try {
108-
const result = renderer(renderParams);
110+
const result = await renderer(renderParams);
109111

110112
log(
111113
`Successfully rendered ${route.route} (${timeSince(startRenderTime)})`
@@ -134,7 +136,7 @@ export = class HtmlRenderPlugin<Route extends BaseRoute = BaseRoute> {
134136
renderDirectory,
135137
renderEntry,
136138
routes,
137-
transformFilePath
139+
transformFilePath,
138140
});
139141
} catch (error) {
140142
logError("An error occured rendering HTML", error);
@@ -177,9 +179,9 @@ export = class HtmlRenderPlugin<Route extends BaseRoute = BaseRoute> {
177179
? clientCompilations[0].compilation!.getStats()
178180
: new MultiStats(
179181
clientCompilations
180-
.map(compilationStatus => compilationStatus.compilation)
182+
.map((compilationStatus) => compilationStatus.compilation)
181183
.filter(Boolean)
182-
.map(compilation => compilation!.getStats())
184+
.map((compilation) => compilation!.getStats())
183185
);
184186

185187
lastClientStats = clientStats;
@@ -193,7 +195,7 @@ export = class HtmlRenderPlugin<Route extends BaseRoute = BaseRoute> {
193195
}
194196
};
195197

196-
const onRendererReady: OnRendererReady<Route> = cb => {
198+
const onRendererReady: OnRendererReady<Route> = (cb) => {
197199
if (isRendererReady()) {
198200
cb(render);
199201
} else {
@@ -214,7 +216,7 @@ export = class HtmlRenderPlugin<Route extends BaseRoute = BaseRoute> {
214216
renderer = createRenderer({
215217
source,
216218
fileName: renderEntry,
217-
extraGlobals
219+
extraGlobals,
218220
});
219221

220222
if (typeof renderer !== "function") {
@@ -234,7 +236,7 @@ export = class HtmlRenderPlugin<Route extends BaseRoute = BaseRoute> {
234236

235237
const compilationStatus: CompilationStatus = {
236238
compilation: null,
237-
isReady: false
239+
isReady: false,
238240
};
239241

240242
if (isRenderer) {
@@ -257,7 +259,7 @@ export = class HtmlRenderPlugin<Route extends BaseRoute = BaseRoute> {
257259
compilationStatus.isReady = false;
258260
});
259261

260-
compiler.hooks.afterEmit.tapPromise(pluginName, async compilation => {
262+
compiler.hooks.afterEmit.tapPromise(pluginName, async (compilation) => {
261263
log(`Assets emitted for ${compilerName}.`);
262264
compilationStatus.compilation = compilation;
263265
lastClientStats = null;
@@ -289,7 +291,7 @@ export = class HtmlRenderPlugin<Route extends BaseRoute = BaseRoute> {
289291
getRouteFromRequest,
290292
onRendererReady,
291293
getClientStats,
292-
routes
294+
routes,
293295
});
294296

295297
this.renderWhenReady = (route: Route) =>

‎src/renderRoutes.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ export default async function renderRoutes<Route>({
2020
routes,
2121
renderDirectory,
2222
renderCompilation,
23-
transformFilePath
23+
transformFilePath,
2424
}: Params<Route>) {
2525
log(`Starting render of ${routes.length} routes`);
2626
async function emitFile(dir: string, content: string) {
@@ -40,7 +40,7 @@ export default async function renderRoutes<Route>({
4040
renderCompilation.compiler.outputFileSystem.writeFile(
4141
dir,
4242
content,
43-
error => {
43+
(error) => {
4444
if (error) {
4545
reject(error);
4646
}

‎tests/test-cases/async/async.test.js

+4-4
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ const getDirContentsSync = require("../../utils/getDirContentsSync");
99
describe("Render asyncronously", () => {
1010
const renderDirectory = path.join(process.cwd(), "dist", "render");
1111

12-
it("should render a HTML once resolved", async done => {
12+
it("should render a HTML once resolved", async (done) => {
1313
const compiler = webpack(
1414
config(
1515
new HtmlRenderPlugin({ mapStatsToParams: () => ({}), renderDirectory })
@@ -25,23 +25,23 @@ describe("Render asyncronously", () => {
2525
done();
2626
});
2727
});
28-
it("should render a multiple files at once", async done => {
28+
it("should render a multiple files at once", async (done) => {
2929
jest.setTimeout(1000);
3030
const compiler = webpack(
3131
config(
3232
new HtmlRenderPlugin({
3333
mapStatsToParams: () => ({}),
3434
renderConcurrency: "parallel",
3535
routes: new Array(20).fill(null).map((_, i) => `page${i}`),
36-
renderDirectory
36+
renderDirectory,
3737
})
3838
)
3939
);
4040

4141
const memoryFs = new MemoryFS();
4242
compiler.outputFileSystem = memoryFs;
4343

44-
compiler.run(error => {
44+
compiler.run((error) => {
4545
expect(error).toBe(null);
4646
const contents = getDirContentsSync(renderDirectory, { fs: memoryFs });
4747
expect(contents).toMatchSnapshot();

‎tests/test-cases/async/src/render.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
export default async function exampleRender(...params) {
2-
await new Promise(resolve => setTimeout(resolve, 300));
2+
await new Promise((resolve) => setTimeout(resolve, 300));
33
return `<html>
44
<body>
55
Rendered with:&nbsp;

‎tests/test-cases/async/webpack.config.js

+7-7
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,19 @@ const path = require("path");
33
const srcPath = path.resolve(__dirname, "./src");
44
const paths = {
55
renderEntry: path.resolve(srcPath, "render.js"),
6-
clientEntry: path.resolve(srcPath, "client.js")
6+
clientEntry: path.resolve(srcPath, "client.js"),
77
};
88

9-
module.exports = plugin => [
9+
module.exports = (plugin) => [
1010
{
1111
name: "client",
1212
target: "web",
1313
mode: "production",
1414
entry: paths.clientEntry,
1515
output: {
16-
filename: "client-[name]-[contenthash].js"
16+
filename: "client-[name]-[contenthash].js",
1717
},
18-
plugins: [plugin]
18+
plugins: [plugin],
1919
},
2020
{
2121
dependencies: ["client"],
@@ -27,8 +27,8 @@ module.exports = plugin => [
2727
libraryExport: "default",
2828
library: "static",
2929
libraryTarget: "umd2",
30-
filename: "render-[name]-[contenthash].js"
30+
filename: "render-[name]-[contenthash].js",
3131
},
32-
plugins: [plugin.render()]
33-
}
32+
plugins: [plugin.render()],
33+
},
3434
];

‎tests/test-cases/errors/errors.test.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ const MemoryFS = require("memory-fs");
22
const webpack = require("webpack");
33

44
describe("Render HTML from in-config Plugin", () => {
5-
it("should render a HTML file", async done => {
5+
it("should render a HTML file", async (done) => {
66
const compiler = webpack(require("./webpack.errors.config"));
77

88
const memoryFs = new MemoryFS();

0 commit comments

Comments
 (0)