Repository navigation
Expand file tree
/
Copy pathprerender-crawl.mjs
More file actions
268 lines (243 loc) · 8.33 KB
/
Copy pathprerender-crawl.mjs
File metadata and controls
268 lines (243 loc) · 8.33 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
import { readFile, writeFile } from 'node:fs/promises';
import { existsSync } from 'node:fs';
import { join } from 'node:path';
import { preview } from 'vite';
import puppeteer from 'puppeteer';
import { discoverAllRoutes } from '../pages/discoverRoutes.js';
const allRoutes = discoverAllRoutes();
const DIST = 'dist/client';
const CONCURRENCY = Number(process.env.PRERENDER_CONCURRENCY) || 6;
const PAGE_TIMEOUT = 30000;
const RENDER_SETTLE_MS = 300;
const SELECTOR_TIMEOUT = 8000;
const RETRY =
process.env.PRERENDER_RETRY === '1' || process.argv.includes('--retry');
function routeToFile(route) {
if (route === '/') return join(DIST, 'index.html');
return join(DIST, route.replace(/^\//, ''), 'index.html');
}
function fmtMs(ms) {
if (ms < 1000) return `${ms}ms`;
return `${(ms / 1000).toFixed(2)}s`;
}
function fmtSec(ms) {
const s = ms / 1000;
if (s < 60) return `${s.toFixed(2)}s`;
const m = Math.floor(s / 60);
return `${m}m ${(s - m * 60).toFixed(1)}s`;
}
async function crawlOne(browser, baseUrl, route) {
const t0 = Date.now();
const target = baseUrl + route;
const file = routeToFile(route);
if (!existsSync(file))
return { route, skipped: 'no prerendered shell', ms: Date.now() - t0 };
const page = await browser.newPage();
try {
const consoleErrors = [];
// Images, fonts and media are aborted below to keep the crawl fast. The
// browser reports every one of those as a failed load, so counting them
// would just be counting our own optimisation — track what we blocked and
// drop those messages, or the tally is pure noise that swings run to run.
const blocked = new Set();
page.on('console', (m) => {
if (m.type() !== 'error') return;
const url = m.location()?.url;
if (url && blocked.has(url)) return;
consoleErrors.push(m.text());
});
page.on('pageerror', (e) => consoleErrors.push(`page error: ${e.message}`));
await page.setRequestInterception(true);
page.on('request', (req) => {
const t = req.resourceType();
if (t === 'image' || t === 'font' || t === 'media') {
blocked.add(req.url());
return req.abort();
}
req.continue();
});
await page.goto(target, {
waitUntil: 'domcontentloaded',
timeout: PAGE_TIMEOUT,
});
try {
await page.waitForSelector('#react-root > *', {
timeout: SELECTOR_TIMEOUT,
});
} catch {
return {
route,
skipped: `no children rendered within ${SELECTOR_TIMEOUT}ms`,
ms: Date.now() - t0,
};
}
await new Promise((r) => setTimeout(r, RENDER_SETTLE_MS));
const rendered = await page.evaluate(() => {
const root = document.getElementById('react-root');
return root ? root.innerHTML : '';
});
if (!rendered)
return { route, skipped: 'empty root after render', ms: Date.now() - t0 };
const shell = await readFile(file, 'utf8');
const replaced = shell.replace(
/<div id="react-root"><\/div>/,
`<div id="react-root">${rendered}</div>`,
);
if (replaced === shell) {
return {
route,
skipped: 'root placeholder not found',
ms: Date.now() - t0,
};
}
await writeFile(file, replaced, 'utf8');
return {
route,
bytes: rendered.length,
errors: consoleErrors.length,
messages: consoleErrors,
ms: Date.now() - t0,
};
} catch (e) {
return { route, error: e.message, ms: Date.now() - t0 };
} finally {
await page.close().catch(() => {});
}
}
async function warmUp(baseUrl) {
const deadline = Date.now() + 10000;
while (Date.now() < deadline) {
try {
const res = await fetch(baseUrl + '/');
if (res.ok) return Date.now();
} catch {}
await new Promise((r) => setTimeout(r, 200));
}
throw new Error('preview server did not respond within 10s');
}
function logRoute(r) {
const t = fmtMs(r.ms ?? 0);
if (r.error) {
console.log(` x ${r.route}: ${r.error} (${t})`);
} else if (r.skipped) {
console.log(` - ${r.route}: ${r.skipped} (${t})`);
} else {
console.log(
` . ${r.route} (${r.bytes} bytes, ${r.errors} console errors, ${t})`,
);
}
}
async function main() {
const tStart = Date.now();
console.log(
`prerender-crawl: ${allRoutes.length} routes, concurrency ${CONCURRENCY}`,
);
const server = await preview({
preview: { port: 4287, strictPort: true, host: '127.0.0.1' },
});
const url =
server.resolvedUrls?.local?.[0]?.replace(/\/$/, '') ||
'http://127.0.0.1:4287';
console.log(`preview up at ${url}`);
const warmStart = Date.now();
await warmUp(url);
console.log(`warm-up: preview responded in ${fmtMs(Date.now() - warmStart)}`);
const browser = await puppeteer.launch({
args: ['--no-sandbox', '--disable-setuid-sandbox'],
});
const results = [];
const queue = [...allRoutes];
const workers = Array.from({ length: CONCURRENCY }, async () => {
while (queue.length) {
const route = queue.shift();
const r = await crawlOne(browser, url, route);
results.push(r);
logRoute(r);
}
});
await Promise.all(workers);
if (RETRY) {
const flaky = results
.filter((r) => r.skipped && /within \d+ms|empty root/.test(r.skipped))
.map((r) => r.route);
if (flaky.length) {
console.log(
`\nprerender-crawl: retrying ${flaky.length} flaky route(s) sequentially...`,
);
const retryResults = new Map();
for (const route of flaky) {
const r = await crawlOne(browser, url, route);
retryResults.set(route, r);
logRoute({ ...r, route: `${route} [retry]` });
}
for (let i = 0; i < results.length; i++) {
const r = results[i];
if (retryResults.has(r.route)) {
const next = retryResults.get(r.route);
if (next.bytes || next.error) results[i] = next;
}
}
}
}
await browser.close();
await new Promise((resolve) => server.httpServer.close(resolve));
const total = results.length;
const ok = results.filter((r) => r.bytes).length;
const errs = results.filter((r) => r.error).length;
const skipped = results.filter((r) => r.skipped).length;
const routeTimes = results.map((r) => r.ms || 0);
const avgMs = routeTimes.length
? routeTimes.reduce((a, b) => a + b, 0) / routeTimes.length
: 0;
const maxMs = routeTimes.length ? Math.max(...routeTimes) : 0;
const pct = total ? ((ok / total) * 100).toFixed(1) : '0.0';
const elapsed = Date.now() - tStart;
console.log(
`\nprerender-crawl: ${ok}/${total} rendered (${pct}% success), ${skipped} skipped, ${errs} errored`,
);
console.log(
`prerender-crawl: per-route avg ${fmtMs(Math.round(avgMs))}, max ${fmtMs(maxMs)}`,
);
console.log(`prerender-crawl: total elapsed ${fmtSec(elapsed)}`);
// Say what the errors actually were. A bare count sends anyone reading this
// log guessing, which is exactly how the blocked-resource noise above went
// unexplained for so long.
const byMessage = new Map();
for (const r of results) {
for (const m of r.messages || []) {
const key = m.slice(0, 140);
const hit = byMessage.get(key) || { n: 0, routes: [] };
hit.n += 1;
if (hit.routes.length < 5 && !hit.routes.includes(r.route)) {
hit.routes.push(r.route);
}
byMessage.set(key, hit);
}
}
const noisy = results.filter((r) => (r.errors || 0) > 0).length;
if (byMessage.size) {
console.log(`
prerender-crawl: ${noisy} route(s) logged console errors`);
[...byMessage.entries()]
.sort((a, b) => b[1].n - a[1].n)
.slice(0, 12)
.forEach(([msg, hit]) => {
console.log(` ${String(hit.n).padStart(4)}x ${msg}`);
console.log(` on ${hit.routes.join(', ')}`);
});
} else {
console.log('prerender-crawl: no console errors');
}
try {
const home = await readFile(join(DIST, 'index.html'), 'utf8');
await writeFile(join(DIST, '404.html'), home, 'utf8');
} catch {}
// Exit explicitly instead of waiting for the event loop to drain. Puppeteer
// can leave an orphaned renderer or crashpad handler holding the pipe it
// inherited, and build.mjs then blocks forever on a crawl that has already
// written every page. Flush stdout first so the summary above is not cut off.
const code = errs > 0 ? 1 : 0;
await new Promise((resolve) => process.stdout.write('', resolve));
process.exit(code);
}
await main();