Skip to content

Turn any idea, plan, or codebase into a beautiful interactive diagram. An agent skill for Claude Code, Codex, and more.

fix(showcase): bound Chrome shutdown and cancel failed navigation

杨嘉伟a599feb550e2
diff --git a/scripts/build-readme-showcase.mjs b/scripts/build-readme-showcase.mjs
index 906ebe93..5bfc042f 100644
--- a/scripts/build-readme-showcase.mjs
+++ b/scripts/build-readme-showcase.mjs
@@ -56,7 +56,11 @@ function sha256(file) {
}
function sleep(ms) {
- return new Promise(resolve => setTimeout(resolve, ms));
+ let timer;
+ const promise = new Promise(resolve => {
+ timer = setTimeout(resolve, ms);
+ });
+ return { promise, cancel: () => clearTimeout(timer) };
}
function executable(file) {
@@ -198,14 +202,21 @@ class PipeCdp {
}
waitFor(method, sessionId, timeoutMs = 15000) {
- return new Promise((resolve, reject) => {
- const waiter = { method, sessionId, resolve, reject, timer: null };
+ let waiter;
+ const promise = new Promise((resolve, reject) => {
+ waiter = { method, sessionId, resolve, reject, timer: null };
waiter.timer = setTimeout(() => {
this.waiters.splice(this.waiters.indexOf(waiter), 1);
reject(new Error(`${method}: event timed out after ${timeoutMs}ms`));
}, timeoutMs);
this.waiters.push(waiter);
});
+ promise.cancel = () => {
+ const index = this.waiters.indexOf(waiter);
+ if (index >= 0) this.waiters.splice(index, 1);
+ clearTimeout(waiter.timer);
+ };
+ return promise;
}
failAll(error) {
@@ -234,19 +245,44 @@ async function evaluate(cdp, sessionId, expression, awaitPromise = false) {
return result.result?.value;
}
-async function stopChrome(chrome) {
- if (chrome.exitCode !== null || chrome.signalCode !== null) return;
- const closed = new Promise(resolve => chrome.once('close', resolve));
+function releaseChildStreams(chrome) {
+ for (const stream of [chrome.stderr, chrome.stdout, ...(chrome.stdio || [])]) {
+ stream?.destroy?.();
+ }
+}
+
+async function stopChrome(chrome, profileRoot, timeoutMs = 5000) {
+ if (chrome.exitCode !== null || chrome.signalCode !== null) {
+ releaseChildStreams(chrome);
+ return;
+ }
+ let settled = false;
+ const closed = new Promise(resolve => {
+ chrome.once('close', () => {
+ settled = true;
+ resolve(true);
+ });
+ });
+ const gracefulDelay = sleep(timeoutMs);
chrome.kill('SIGTERM');
- const graceful = await Promise.race([
- closed.then(() => true),
- sleep(5000).then(() => false),
- ]);
- if (graceful) return;
+ const graceful = await Promise.race([closed, gracefulDelay.promise.then(() => false)]);
+ gracefulDelay.cancel();
+ if (graceful) {
+ releaseChildStreams(chrome);
+ return;
+ }
chrome.kill('SIGKILL');
- await closed;
+ const forcedDelay = sleep(timeoutMs);
+ const forced = await Promise.race([closed, forcedDelay.promise.then(() => false)]);
+ forcedDelay.cancel();
+ releaseChildStreams(chrome);
+ if (!forced && !settled) {
+ throw new Error(`Chrome did not exit; profile retained at ${profileRoot}`);
+ }
}
+export { PipeCdp, stopChrome, releaseChildStreams };
+
async function captureFrames(chromePath, tempRoot) {
const profileRoot = path.join(tempRoot, 'profile');
const framesRoot = path.join(tempRoot, 'frames');
@@ -289,15 +325,24 @@ async function captureFrames(chromePath, tempRoot) {
const wrapperPath = path.join(tempRoot, `showcase-${scene.id}.html`);
fs.writeFileSync(wrapperPath, wrapperHtml(scene, sceneIndex));
const loaded = cdp.waitFor('Page.loadEventFired', sessionId);
- const navigation = await cdp.send('Page.navigate', { url: pathToFileURL(wrapperPath).href }, sessionId);
- if (navigation.errorText) throw new Error(`${scene.id}: ${navigation.errorText}`);
+ let navigation;
+ try {
+ navigation = await cdp.send('Page.navigate', { url: pathToFileURL(wrapperPath).href }, sessionId);
+ } catch (error) {
+ loaded.cancel();
+ throw error;
+ }
+ if (navigation.errorText) {
+ loaded.cancel();
+ throw new Error(`${scene.id}: ${navigation.errorText}`);
+ }
await loaded;
await evaluate(cdp, sessionId, `new Promise((resolve,reject)=>{const end=Date.now()+12000;const poll=()=>window.__archifyShowcaseReady?resolve(true):Date.now()>end?reject(new Error('artifact load timeout')):setTimeout(poll,40);poll()})`, true);
for (let i = 0; i < framesPerScene; i += 1) {
const fade = i === 0 ? 0.82 : i === 1 ? 0.38 : i === framesPerScene - 1 ? 0.42 : 0;
await evaluate(cdp, sessionId, `document.documentElement.style.setProperty('--fade','${fade}')`);
- if (i > 0) await sleep(88);
+ if (i > 0) await sleep(88).promise;
const screenshot = await cdp.send('Page.captureScreenshot', {
format: 'png', fromSurface: true, captureBeyondViewport: false,
}, sessionId, 20000);
@@ -312,7 +357,7 @@ async function captureFrames(chromePath, tempRoot) {
throw error;
} finally {
cdp.failAll(new Error('capture finished'));
- await stopChrome(chrome);
+ await stopChrome(chrome, profileRoot);
}
}
@@ -373,7 +418,10 @@ async function main() {
}
}
-main().catch(error => {
- console.error(error.stack || error.message);
- process.exitCode = 1;
-});
+const invokedDirectly = process.argv[1] && path.resolve(process.argv[1]) === fileURLToPath(import.meta.url);
+if (invokedDirectly) {
+ main().catch(error => {
+ console.error(error.stack || error.message);
+ process.exitCode = 1;
+ });
+}
diff --git a/test/readme-showcase.test.mjs b/test/readme-showcase.test.mjs
index 668c1faf..d095dd28 100644
--- a/test/readme-showcase.test.mjs
+++ b/test/readme-showcase.test.mjs
@@ -1,11 +1,13 @@
import { test } from 'node:test';
import assert from 'node:assert/strict';
import { execFileSync } from 'node:child_process';
+import { EventEmitter } from 'node:events';
+import { PassThrough } from 'node:stream';
import crypto from 'node:crypto';
import fs from 'node:fs';
import os from 'node:os';
import path from 'node:path';
-import { fileURLToPath } from 'node:url';
+import { fileURLToPath, pathToFileURL } from 'node:url';
const __dirname = path.dirname(fileURLToPath(import.meta.url));
const skillRoot = path.resolve(__dirname, '..', 'archify');
@@ -142,9 +144,6 @@ test('README motion proof is compact, looping, and backed by current gallery art
assert.match(builder, /\?embed=1&theme=dark\$\{scene\.hash\}/);
assert.doesNotMatch(builder, /play=1|#view=/);
assert.match(builder, /path\.relative\(from, to\)\.split\(path\.sep\)\.join\('\/'\)/);
- assert.match(builder, /async function stopChrome\(chrome\)/);
- assert.match(builder, /await stopChrome\(chrome\)/);
- assert.match(builder, /chrome\.kill\('SIGKILL'\)/);
const buffer = fs.readFileSync(assetPath);
const receipt = JSON.parse(fs.readFileSync(receiptPath, 'utf8'));
const inspected = inspectGif(buffer);
@@ -170,6 +169,70 @@ test('README motion proof is compact, looping, and backed by current gallery art
}
});
+function fakeChrome({ exitBeforeStop = false, closeOn = null } = {}) {
+ const child = new EventEmitter();
+ child.exitCode = null;
+ child.signalCode = null;
+ child.stderr = new PassThrough();
+ child.stdout = new PassThrough();
+ child.stdio = [null, child.stdout, child.stderr, new PassThrough(), new PassThrough()];
+ child.kill = (signal) => {
+ child.signalCode = signal;
+ if (closeOn === signal) {
+ child.exitCode = null;
+ queueMicrotask(() => child.emit('close', null, signal));
+ }
+ return true;
+ };
+ if (exitBeforeStop) {
+ child.exitCode = 0;
+ child.emit('close', 0, null);
+ }
+ return child;
+}
+
+test('showcase shutdown clears its timer and bounds a forced stop', async () => {
+ const showcase = await import(pathToFileURL(path.join(repoRoot, 'scripts', 'build-readme-showcase.mjs')).href);
+ const profile = fs.mkdtempSync(path.join(os.tmpdir(), 'archify-showcase-profile-'));
+ const started = Date.now();
+ await showcase.stopChrome(fakeChrome({ exitBeforeStop: true }), profile);
+ assert.ok(Date.now() - started < 1000, 'an already exited browser must not wait for the losing timer');
+ fs.rmSync(profile, { recursive: true, force: true });
+
+ const retained = fs.mkdtempSync(path.join(os.tmpdir(), 'archify-showcase-profile-'));
+ const forced = fakeChrome();
+ await assert.rejects(
+ () => showcase.stopChrome(forced, retained, 20),
+ new RegExp(`Chrome did not exit; profile retained at ${retained.replace(/[.*+?^${}()|[\]\\]/g, '\\$&')}`),
+ );
+ assert.equal(forced.signalCode, 'SIGKILL');
+ assert.equal(fs.existsSync(retained), true);
+ fs.rmSync(retained, { recursive: true, force: true });
+
+ const graceful = fakeChrome({ closeOn: 'SIGTERM' });
+ const gracefulStarted = Date.now();
+ await showcase.stopChrome(graceful, profile);
+ assert.equal(graceful.signalCode, 'SIGTERM');
+ assert.ok(Date.now() - gracefulStarted < 1000, 'a prompt close must cancel the shutdown timer');
+});
+
+test('showcase navigation failure cancels its unused load waiter', async () => {
+ const showcase = await import(pathToFileURL(path.join(repoRoot, 'scripts', 'build-readme-showcase.mjs')).href);
+ const child = fakeChrome();
+ const cdp = new showcase.PipeCdp(child);
+ const loaded = cdp.waitFor('Page.loadEventFired', 'session');
+ let rejected = false;
+ loaded.catch(() => { rejected = true; });
+ const originalWrite = child.stdio[3].write.bind(child.stdio[3]);
+ child.stdio[3].write = () => { throw new Error('navigation pipe closed'); };
+ await assert.rejects(() => cdp.send('Page.navigate', { url: 'about:blank' }, 'session'), /navigation pipe closed/);
+ loaded.cancel();
+ await new Promise(resolve => setImmediate(resolve));
+ assert.equal(rejected, false);
+ child.stdio[3].write = originalWrite;
+ cdp.failAll(new Error('test finished'));
+});
+
test('every README header links to the other languages', () => {
const languageLinks = [];
for (const { href, label } of readmeLanguages) {