Skip to content

Commit c5b7f6a

Browse files
fix(check): retry system Chrome after managed launch crash (#3701)
1 parent 4a72a98 commit c5b7f6a

4 files changed

Lines changed: 193 additions & 20 deletions

File tree

‎packages/cli/src/browser/manager.test.ts‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,23 @@ describe("findBrowser — cache resolution", () => {
229229
);
230230
});
231231

232+
it("finds Chrome in the standard Windows Program Files location", async () => {
233+
Object.defineProperty(process, "platform", { value: "win32", configurable: true });
234+
const windowsChrome = join(
235+
"C:\\Program Files",
236+
"Google",
237+
"Chrome",
238+
"Application",
239+
"chrome.exe",
240+
);
241+
installFsMocks({ existing: new Set([windowsChrome]) });
242+
installPuppeteerBrowsersMock();
243+
244+
const { findSystemBrowser } = await import("./manager.js");
245+
246+
expect(findSystemBrowser()).toEqual({ executablePath: windowsChrome, source: "system" });
247+
});
248+
232249
it("does not resolve to a hyperframes-cache build from an older CHROME_VERSION pin", async () => {
233250
// A build downloaded by a prior hyperframes version (this pin has moved
234251
// 131 -> 151 -> 152 across releases) must not satisfy resolution, or an

‎packages/cli/src/browser/manager.ts‎

Lines changed: 29 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -240,12 +240,32 @@ function purgeStaleInstall(installPath: string): void {
240240
const SYSTEM_CHROME_PATHS: ReadonlyArray<string> =
241241
process.platform === "darwin"
242242
? ["/Applications/Google Chrome.app/Contents/MacOS/Google Chrome"]
243-
: [
244-
"/usr/bin/google-chrome",
245-
"/usr/bin/google-chrome-stable",
246-
"/usr/bin/chromium",
247-
"/usr/bin/chromium-browser",
248-
];
243+
: process.platform === "win32"
244+
? [
245+
join(
246+
process.env["ProgramW6432"] ?? process.env["PROGRAMFILES"] ?? "C:\\Program Files",
247+
"Google",
248+
"Chrome",
249+
"Application",
250+
"chrome.exe",
251+
),
252+
join(
253+
process.env["PROGRAMFILES(X86)"] ?? "C:\\Program Files (x86)",
254+
"Google",
255+
"Chrome",
256+
"Application",
257+
"chrome.exe",
258+
),
259+
...(process.env["LOCALAPPDATA"]
260+
? [join(process.env["LOCALAPPDATA"], "Google", "Chrome", "Application", "chrome.exe")]
261+
: []),
262+
]
263+
: [
264+
"/usr/bin/google-chrome",
265+
"/usr/bin/google-chrome-stable",
266+
"/usr/bin/chromium",
267+
"/usr/bin/chromium-browser",
268+
];
249269

250270
function whichBinary(name: string): string | undefined {
251271
try {
@@ -486,7 +506,7 @@ export function _resetSystemFallbackWarnForTests(): void {
486506
_warnedSystemFallback = false;
487507
}
488508

489-
function findFromSystem(): BrowserResult | undefined {
509+
export function findSystemBrowser(): BrowserResult | undefined {
490510
for (const p of SYSTEM_CHROME_PATHS) {
491511
if (existsSync(p)) {
492512
return { executablePath: p, source: "system" };
@@ -531,7 +551,7 @@ export async function findBrowser(): Promise<BrowserResult | undefined> {
531551
}
532552
}
533553

534-
const fromSystem = findFromSystem();
554+
const fromSystem = findSystemBrowser();
535555
if (fromSystem) {
536556
warnSystemFallbackOnce(fromSystem.executablePath);
537557
}
@@ -613,7 +633,7 @@ export async function ensureBrowser(options?: EnsureBrowserOptions): Promise<Bro
613633
}
614634

615635
if (!options?.preferManagedChrome) {
616-
const fromSystem = findFromSystem();
636+
const fromSystem = findSystemBrowser();
617637
if (fromSystem) {
618638
warnSystemFallbackOnce(fromSystem.executablePath);
619639
return fromSystem;
Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
2+
3+
const mocks = vi.hoisted(() => ({
4+
ensureBrowser: vi.fn(),
5+
findSystemBrowser: vi.fn(),
6+
launch: vi.fn(),
7+
buildChromeArgs: vi.fn(() => []),
8+
resolveBrowserGpuMode: vi.fn(async () => "software" as const),
9+
}));
10+
11+
vi.mock("../browser/manager.js", () => ({
12+
ensureBrowser: mocks.ensureBrowser,
13+
findSystemBrowser: mocks.findSystemBrowser,
14+
}));
15+
16+
vi.mock("puppeteer-core", () => ({ default: { launch: mocks.launch } }));
17+
18+
vi.mock("@hyperframes/engine", () => ({
19+
buildChromeArgs: mocks.buildChromeArgs,
20+
resolveBrowserGpuMode: mocks.resolveBrowserGpuMode,
21+
}));
22+
23+
import { openSettledCompositionPage } from "./captureCompositionFrame.js";
24+
25+
const HTML = '<div data-composition-id="main" data-width="1920" data-height="1080"></div>';
26+
const OPTIONS = {
27+
renderReadyTimeoutMs: 1000,
28+
renderReadyWarningSuffix: "test",
29+
browserGpuMode: "software" as const,
30+
};
31+
const BUNDLED = "C:\\hyperframes\\chrome-headless-shell.exe";
32+
const SYSTEM = "C:\\Program Files\\Google\\Chrome\\Application\\chrome.exe";
33+
34+
function launchCrash(): Error {
35+
return new Error("Failed to launch the browser process! Code: 3221225595");
36+
}
37+
38+
function fakeBrowser() {
39+
const page = {
40+
evaluateOnNewDocument: vi.fn(async () => undefined),
41+
setViewport: vi.fn(async () => undefined),
42+
goto: vi.fn(async () => undefined),
43+
waitForFunction: vi.fn(async () => undefined),
44+
evaluate: vi.fn(async () => undefined),
45+
};
46+
return {
47+
browser: {
48+
newPage: vi.fn(async () => page),
49+
close: vi.fn(async () => undefined),
50+
},
51+
page,
52+
};
53+
}
54+
55+
describe("openSettledCompositionPage Windows bundled-browser recovery", () => {
56+
const originalPlatform = Object.getOwnPropertyDescriptor(process, "platform");
57+
58+
beforeEach(() => {
59+
vi.resetAllMocks();
60+
Object.defineProperty(process, "platform", { value: "win32", configurable: true });
61+
mocks.ensureBrowser.mockResolvedValue({ executablePath: BUNDLED, source: "cache" });
62+
mocks.findSystemBrowser.mockReturnValue({ executablePath: SYSTEM, source: "system" });
63+
mocks.buildChromeArgs.mockReturnValue([]);
64+
mocks.resolveBrowserGpuMode.mockResolvedValue("software");
65+
});
66+
67+
afterEach(() => {
68+
vi.useRealTimers();
69+
if (originalPlatform) Object.defineProperty(process, "platform", originalPlatform);
70+
});
71+
72+
it("retries the known managed-shell crash once with system Chrome", async () => {
73+
const fallback = fakeBrowser();
74+
mocks.launch.mockRejectedValueOnce(launchCrash()).mockResolvedValueOnce(fallback.browser);
75+
76+
const session = await openSettledCompositionPage(HTML, "http://127.0.0.1:3000", OPTIONS);
77+
78+
expect(mocks.launch).toHaveBeenCalledTimes(2);
79+
expect(mocks.launch.mock.calls[0]?.[0]).toEqual(
80+
expect.objectContaining({ executablePath: BUNDLED }),
81+
);
82+
expect(mocks.launch.mock.calls[1]?.[0]).toEqual(
83+
expect.objectContaining({ executablePath: SYSTEM }),
84+
);
85+
expect(session.browser).toBe(fallback.browser);
86+
});
87+
88+
it("adds STATUS_STACK_BUFFER_OVERRUN and browser-path guidance when no system Chrome exists", async () => {
89+
mocks.findSystemBrowser.mockReturnValue(undefined);
90+
mocks.launch.mockRejectedValueOnce(launchCrash());
91+
92+
await expect(
93+
openSettledCompositionPage(HTML, "http://127.0.0.1:3000", OPTIONS),
94+
).rejects.toThrow(/STATUS_STACK_BUFFER_OVERRUN[\s\S]*HYPERFRAMES_BROWSER_PATH/);
95+
expect(mocks.launch).toHaveBeenCalledOnce();
96+
});
97+
98+
it("keeps unrelated launch errors unchanged", async () => {
99+
const error = new Error("Failed to launch the browser process! Code: 1");
100+
mocks.launch.mockRejectedValueOnce(error);
101+
102+
await expect(openSettledCompositionPage(HTML, "http://127.0.0.1:3000", OPTIONS)).rejects.toBe(
103+
error,
104+
);
105+
expect(mocks.findSystemBrowser).not.toHaveBeenCalled();
106+
expect(mocks.launch).toHaveBeenCalledOnce();
107+
});
108+
});

‎packages/cli/src/capture/captureCompositionFrame.ts‎

Lines changed: 39 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ import {
77
resolveLocalBrowserGpuMode,
88
type BrowserGpuMode,
99
} from "../browser/gpuPolicy.js";
10+
import { windowsChromeCrashRemediation } from "../browser/windowsCrash.js";
1011
import { resolveCompositionViewportFromHtml } from "../utils/compositionViewport.js";
12+
import { normalizeErrorMessage } from "../utils/errorMessage.js";
1113
import { resolveDiagnosticNavigationTimeoutMs } from "../utils/renderArgs.js";
1214

1315
const SHADER_TRANSITIONS_TIMEOUT_MS = 90_000;
@@ -167,27 +169,53 @@ export async function openSettledCompositionPage(
167169
options: OpenSettledCompositionPageOptions,
168170
): Promise<SettledCompositionPage> {
169171
const viewport = resolveCompositionViewportFromHtml(html);
170-
const { ensureBrowser } = await import("../browser/manager.js");
172+
const { ensureBrowser, findSystemBrowser } = await import("../browser/manager.js");
171173
const browser = await ensureBrowser();
172174
const puppeteer = await import("puppeteer-core");
173175
const { buildChromeArgs } = await import("@hyperframes/engine");
174176
const requestedGpuMode = options.browserGpuMode ?? resolveCliChromeGpuMode();
175-
const resolvedGpuMode = await resolveCaptureBrowserGpuMode(
176-
requestedGpuMode,
177-
browser.executablePath,
178-
);
179-
assertWebGpuRequirement(html, requestedGpuMode, resolvedGpuMode);
180-
181-
let chromeBrowser: Browser | undefined;
182-
try {
183-
chromeBrowser = await puppeteer.default.launch({
177+
const launch = async (executablePath: string): Promise<Browser> => {
178+
const resolvedGpuMode = await resolveCaptureBrowserGpuMode(requestedGpuMode, executablePath);
179+
assertWebGpuRequirement(html, requestedGpuMode, resolvedGpuMode);
180+
return puppeteer.default.launch({
184181
headless: true,
185-
executablePath: browser.executablePath,
182+
executablePath,
186183
args: buildChromeArgs(
187184
{ ...viewport, captureMode: "screenshot" },
188185
{ browserGpuMode: resolvedGpuMode },
189186
),
190187
});
188+
};
189+
190+
let chromeBrowser: Browser | undefined;
191+
try {
192+
try {
193+
chromeBrowser = await launch(browser.executablePath);
194+
} catch (launchError) {
195+
const message = normalizeErrorMessage(launchError);
196+
const remediation = windowsChromeCrashRemediation(message);
197+
if (!remediation) throw launchError;
198+
199+
const systemBrowser =
200+
browser.source === "cache" || browser.source === "download"
201+
? findSystemBrowser()
202+
: undefined;
203+
if (!systemBrowser || systemBrowser.executablePath === browser.executablePath) {
204+
throw new Error(`${message}\n\n${remediation}`, { cause: launchError });
205+
}
206+
207+
console.warn(
208+
`[hyperframes] Managed chrome-headless-shell crashed at launch; retrying once with system Chrome at ${systemBrowser.executablePath}.`,
209+
);
210+
try {
211+
chromeBrowser = await launch(systemBrowser.executablePath);
212+
} catch (fallbackError) {
213+
throw new Error(
214+
`System Chrome fallback also failed: ${normalizeErrorMessage(fallbackError)}\n\n${remediation}`,
215+
{ cause: fallbackError },
216+
);
217+
}
218+
}
191219

192220
const page = await chromeBrowser.newPage();
193221
await installPageFunctionGuard(page);

0 commit comments

Comments
 (0)