From f91bbf0dac486f85de195621092014c02bf0a6a5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miguel=20=C3=81ngel?= Date: Tue, 17 Nov 2026 07:43:53 +0000 Subject: [PATCH] fix(inspector): the inspector's Chrome starts as root or in a container (#8050) * test(inspector): the inspector's Chrome follows the host sandbox rule, and probes retry without it * fix(inspector): the inspector's Chrome starts as root or in a container * test(producer): the page check and the inspector retry Chrome without the sandbox when it refuses * fix(producer): the page check retries Chrome without the sandbox when it refuses, like the inspector * chore(inspector): raise the packed size budget for the shared sandbox rule --- packages/core/package-subpaths.json | 6 +++ packages/core/package.json | 10 ++++ .../services => core/src}/chromeSandbox.ts | 0 packages/engine/src/index.ts | 2 +- ...owserManager-sandboxRetryDiagnosis.test.ts | 2 +- .../src/services/browserManager.test.ts | 22 ++++++++ .../engine/src/services/browserManager.ts | 2 +- .../engine/src/services/chromeHostCeiling.ts | 2 +- .../engine/src/services/chromeSandbox.test.ts | 2 +- packages/engine/src/services/hdrCapture.ts | 2 +- packages/inspector/src/chromeArgs.test.ts | 41 +++++++++++++++ packages/inspector/src/service.ts | 50 +++++++++++++++---- .../producer/src/verifyStaticPage.test.ts | 21 ++++++++ packages/producer/src/verifyStaticPage.ts | 19 ++++--- scripts/package-size-budgets.json | 2 +- 15 files changed, 160 insertions(+), 23 deletions(-) rename packages/{engine/src/services => core/src}/chromeSandbox.ts (100%) create mode 100644 packages/inspector/src/chromeArgs.test.ts create mode 100644 packages/producer/src/verifyStaticPage.test.ts diff --git a/packages/core/package-subpaths.json b/packages/core/package-subpaths.json index 0de85626b2..9addcf3143 100644 --- a/packages/core/package-subpaths.json +++ b/packages/core/package-subpaths.json @@ -74,6 +74,12 @@ "types": "./dist/chromeEnv.d.ts", "environments": ["bun", "node"] }, + "./chrome-sandbox": { + "source": "./src/chromeSandbox.ts", + "runtime": "./dist/chromeSandbox.js", + "types": "./dist/chromeSandbox.d.ts", + "environments": ["bun", "node"] + }, "./atomic-file": { "source": "./src/atomicFile.ts", "runtime": "./dist/atomicFile.js", diff --git a/packages/core/package.json b/packages/core/package.json index 0689c5a5ac..f173a9e2b5 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -86,6 +86,12 @@ "import": "./src/chromeEnv.ts", "types": "./src/chromeEnv.ts" }, + "./chrome-sandbox": { + "bun": "./src/chromeSandbox.ts", + "node": "./dist/chromeSandbox.js", + "import": "./src/chromeSandbox.ts", + "types": "./src/chromeSandbox.ts" + }, "./atomic-file": { "bun": "./src/atomicFile.ts", "node": "./dist/atomicFile.js", @@ -714,6 +720,10 @@ "import": "./dist/chromeEnv.js", "types": "./dist/chromeEnv.d.ts" }, + "./chrome-sandbox": { + "import": "./dist/chromeSandbox.js", + "types": "./dist/chromeSandbox.d.ts" + }, "./atomic-file": { "import": "./dist/atomicFile.js", "types": "./dist/atomicFile.d.ts" diff --git a/packages/engine/src/services/chromeSandbox.ts b/packages/core/src/chromeSandbox.ts similarity index 100% rename from packages/engine/src/services/chromeSandbox.ts rename to packages/core/src/chromeSandbox.ts diff --git a/packages/engine/src/index.ts b/packages/engine/src/index.ts index 68fa72069c..a76a4a32a2 100644 --- a/packages/engine/src/index.ts +++ b/packages/engine/src/index.ts @@ -591,7 +591,7 @@ export { chromeSandboxEnabled, launchWithChromeSandboxFallback, type ChromeSandboxHost, -} from "./services/chromeSandbox.js"; +} from "@hyperframes/core/chrome-sandbox"; export { VariablesInvalidError, type VariablesIssue, diff --git a/packages/engine/src/services/browserManager-sandboxRetryDiagnosis.test.ts b/packages/engine/src/services/browserManager-sandboxRetryDiagnosis.test.ts index cc2462e301..ef846ae85a 100644 --- a/packages/engine/src/services/browserManager-sandboxRetryDiagnosis.test.ts +++ b/packages/engine/src/services/browserManager-sandboxRetryDiagnosis.test.ts @@ -6,7 +6,7 @@ import { acquireBrowser, drainBrowserPool, } from "./browserManager.js"; -import { _resetChromeSandboxFallbackForTests } from "./chromeSandbox.js"; +import { _resetChromeSandboxFallbackForTests } from "@hyperframes/core/chrome-sandbox"; const explained = vi.hoisted(() => [] as (readonly string[] | undefined)[]); const explainedEnvs = vi.hoisted(() => [] as (NodeJS.ProcessEnv | undefined)[]); diff --git a/packages/engine/src/services/browserManager.test.ts b/packages/engine/src/services/browserManager.test.ts index 14798e8429..ae8f15629c 100644 --- a/packages/engine/src/services/browserManager.test.ts +++ b/packages/engine/src/services/browserManager.test.ts @@ -1,4 +1,5 @@ // fallow-ignore-file code-duplication +import { _resetChromeSandboxFallbackForTests } from "@hyperframes/core/chrome-sandbox"; import { afterEach, beforeEach, describe, expect, it, vi } from "vitest"; import { execFileSync } from "node:child_process"; import { EventEmitter } from "node:events"; @@ -777,6 +778,27 @@ describe("resolveBrowserGpuMode", () => { expect(args).not.toContain(flag); }); + it.skipIf(process.platform !== "linux")( + "retries the GPU probe without the sandbox when Chrome refuses it, as the render does", + async () => { + const { launch } = setMockWebGlProbe({ + hasWebGL: true, + vendor: "NVIDIA", + renderer: "NVIDIA", + }); + const browser = await launch(); + launch.mockReset(); + launch.mockRejectedValueOnce(new Error("No usable sandbox!")).mockResolvedValue(browser); + try { + await resolveBrowserGpuMode("auto", { sandbox: true }); + const args = launch.mock.calls.map(([options]) => options.args.includes("--no-sandbox")); + expect(args).toEqual([false, true]); + } finally { + _resetChromeSandboxFallbackForTests(); + } + }, + ); + it("lets a host own GPU probe launch and cleanup", async () => { const { launch } = setMockWebGlProbe({ hasWebGL: true, vendor: "NVIDIA", renderer: "NVIDIA" }); const close = vi.fn(async (browser: Browser) => { diff --git a/packages/engine/src/services/browserManager.ts b/packages/engine/src/services/browserManager.ts index f53bbec57e..1e35539bcd 100644 --- a/packages/engine/src/services/browserManager.ts +++ b/packages/engine/src/services/browserManager.ts @@ -45,7 +45,7 @@ import { chromeSandboxArgs, chromeSandboxEnabled, launchWithChromeSandboxFallback, -} from "./chromeSandbox.js"; +} from "@hyperframes/core/chrome-sandbox"; import { describeWslGpuAccess, detectWsl, type WslHostFacts } from "./wslHost.js"; import { BrowserLeasePool, diff --git a/packages/engine/src/services/chromeHostCeiling.ts b/packages/engine/src/services/chromeHostCeiling.ts index 2b2bd28af8..5ca19b6657 100644 --- a/packages/engine/src/services/chromeHostCeiling.ts +++ b/packages/engine/src/services/chromeHostCeiling.ts @@ -9,7 +9,7 @@ import { chromeSandboxArgs, chromeSandboxEnabled, startsWithChromeSandboxFallback, -} from "./chromeSandbox.js"; +} from "@hyperframes/core/chrome-sandbox"; /** Chrome 151 dropped macOS 12 and older (Darwin < 22); 150 is the last major that launches there. */ const MACOS_12_LAST_CHROME_MAJOR = 150; diff --git a/packages/engine/src/services/chromeSandbox.test.ts b/packages/engine/src/services/chromeSandbox.test.ts index b18c36d204..f936b7714a 100644 --- a/packages/engine/src/services/chromeSandbox.test.ts +++ b/packages/engine/src/services/chromeSandbox.test.ts @@ -9,7 +9,7 @@ import { NO_SANDBOX_ARGS, startsWithChromeSandboxFallback, type ChromeSandboxHost, -} from "./chromeSandbox.js"; +} from "@hyperframes/core/chrome-sandbox"; import { shellStarts } from "./chromeHostCeiling.js"; import { buildChromeArgs } from "./browserManager.js"; import { buildHdrChromeArgs } from "./hdrCapture.js"; diff --git a/packages/engine/src/services/hdrCapture.ts b/packages/engine/src/services/hdrCapture.ts index 54da8099f6..ea6597b360 100644 --- a/packages/engine/src/services/hdrCapture.ts +++ b/packages/engine/src/services/hdrCapture.ts @@ -27,7 +27,7 @@ import { chromeSandboxArgs, chromeSandboxEnabled, launchWithChromeSandboxFallback, -} from "./chromeSandbox.js"; +} from "@hyperframes/core/chrome-sandbox"; // ── PQ (SMPTE 2084) OETF ───────────────────────────────────────────────────── diff --git a/packages/inspector/src/chromeArgs.test.ts b/packages/inspector/src/chromeArgs.test.ts new file mode 100644 index 0000000000..b46a8f5f27 --- /dev/null +++ b/packages/inspector/src/chromeArgs.test.ts @@ -0,0 +1,41 @@ +import { afterEach, describe, expect, it, vi } from "vitest"; +import { _resetChromeSandboxFallbackForTests, NO_SANDBOX_ARGS } from "../../core/src/chromeSandbox"; +import { inspectorChromeArgs, launchInspectorChrome } from "./service"; + +const launch = vi.hoisted(() => vi.fn()); +vi.mock("puppeteer-core", () => ({ default: { launch } })); + +afterEach(() => { + launch.mockReset(); + _resetChromeSandboxFallbackForTests(); +}); + +describe("the inspector's Chrome", () => { + it("drops the sandbox where the host can't give one, so it starts as root or in a container", () => { + expect(inspectorChromeArgs(["--proxy-server=x"], false)).toEqual( + expect.arrayContaining([...NO_SANDBOX_ARGS, "--proxy-server=x"]), + ); + }); + + it("keeps the sandbox where the host allows it", () => { + const args = inspectorChromeArgs([], true); + for (const flag of NO_SANDBOX_ARGS) expect(args).not.toContain(flag); + }); + + it.skipIf(process.platform !== "linux")( + "starts without the sandbox when Chrome refuses it, as the render does", + async () => { + launch.mockRejectedValueOnce(new Error("No usable sandbox!")).mockResolvedValue({}); + await launchInspectorChrome({ + executablePath: "/chrome", + userDataDir: "/profile", + proxyArgs: [], + sandbox: true, + }); + const sandboxOff = launch.mock.calls.map(([options]) => + options.args.includes("--no-sandbox"), + ); + expect(sandboxOff).toEqual([false, true]); + }, + ); +}); diff --git a/packages/inspector/src/service.ts b/packages/inspector/src/service.ts index ce8b009906..47179eb4bd 100644 --- a/packages/inspector/src/service.ts +++ b/packages/inspector/src/service.ts @@ -1,6 +1,11 @@ import type { TimelineRequest } from "../../core/src/runtime/timelineInspection"; import { withHyperframesBrowserMarker } from "../../core/src/browserMarker"; import { buildChromeLaunchEnv } from "../../core/src/chromeEnv"; +import { + chromeSandboxArgs, + chromeSandboxEnabled, + launchWithChromeSandboxFallback, +} from "../../core/src/chromeSandbox"; import { inspectComponents, inspectElementMap, @@ -72,6 +77,39 @@ async function releaseEach(steps: ReadonlyArray<() => unknown>): Promise { } } +export function inspectorChromeArgs( + proxyArgs: readonly string[], + sandbox = chromeSandboxEnabled(), +): string[] { + return [ + ...chromeSandboxArgs(sandbox), + "--disable-dev-shm-usage", + "--enable-webgl", + "--use-gl=angle", + "--use-angle=swiftshader", + ...proxyArgs, + ]; +} + +export function launchInspectorChrome(options: { + executablePath: string; + userDataDir: string; + proxyArgs: readonly string[]; + sandbox?: boolean; +}): Promise { + return launchWithChromeSandboxFallback( + inspectorChromeArgs(options.proxyArgs, options.sandbox), + (args) => + puppeteer.launch({ + executablePath: options.executablePath, + env: buildChromeLaunchEnv(), + headless: true, + userDataDir: options.userDataDir, + args: withHyperframesBrowserMarker(args), + }), + ); +} + export interface InspectorOptions { executablePath?: string; idleMs?: number; @@ -148,18 +186,10 @@ export class Inspector { const started = await startCaptureProxy(); proxy = started; profile = await createPublicOnlyProfile("hf-inspect-profile-"); - const browser = await puppeteer.launch({ + const browser = await launchInspectorChrome({ executablePath: this.options.executablePath ?? chromePath(), - env: buildChromeLaunchEnv(), - headless: true, userDataDir: profile, - args: withHyperframesBrowserMarker([ - "--disable-dev-shm-usage", - "--enable-webgl", - "--use-gl=angle", - "--use-angle=swiftshader", - ...browserProxyArgs(started.url, `127.0.0.1:${address.port}`), - ]), + proxyArgs: browserProxyArgs(started.url, `127.0.0.1:${address.port}`), }); this.stats.browserStarts++; this.host = { browser, server, port: address.port, proxy: started, profile }; diff --git a/packages/producer/src/verifyStaticPage.test.ts b/packages/producer/src/verifyStaticPage.test.ts new file mode 100644 index 0000000000..6bb91c5465 --- /dev/null +++ b/packages/producer/src/verifyStaticPage.test.ts @@ -0,0 +1,21 @@ +import { afterEach, expect, it, vi } from "vitest"; +import { _resetChromeSandboxFallbackForTests } from "@hyperframes/core/chrome-sandbox"; +import { launchVerifyBrowser } from "./verifyStaticPage.js"; + +const launch = vi.hoisted(() => vi.fn()); +vi.mock("puppeteer", () => ({ default: { launch } })); + +afterEach(() => { + launch.mockReset(); + _resetChromeSandboxFallbackForTests(); +}); + +it.skipIf(process.platform !== "linux")( + "the page check starts without the sandbox when Chrome refuses it, as the render does", + async () => { + launch.mockRejectedValueOnce(new Error("No usable sandbox!")).mockResolvedValue({}); + await launchVerifyBrowser(true); + const sandboxOff = launch.mock.calls.map(([options]) => options.args.includes("--no-sandbox")); + expect(sandboxOff).toEqual([false, true]); + }, +); diff --git a/packages/producer/src/verifyStaticPage.ts b/packages/producer/src/verifyStaticPage.ts index 4c3c80735d..5aa8882cb9 100644 --- a/packages/producer/src/verifyStaticPage.ts +++ b/packages/producer/src/verifyStaticPage.ts @@ -3,6 +3,11 @@ import puppeteer, { type Browser } from "puppeteer"; import { withHyperframesBrowserMarker } from "@hyperframes/core/browser-marker"; +import { + chromeSandboxArgs, + chromeSandboxEnabled, + launchWithChromeSandboxFallback, +} from "@hyperframes/core/chrome-sandbox"; import { injectScriptsAtHeadStart } from "@hyperframes/core/compiler"; import { getVerifiedHyperframeRuntimeSource } from "./services/hyperframeRuntimeLoader.js"; @@ -10,12 +15,14 @@ export interface PageCheckResult { failures: string[]; } -export async function launchVerifyBrowser(): Promise { - return puppeteer.launch({ - headless: true, - executablePath: process.env.PUPPETEER_EXECUTABLE_PATH || undefined, - args: withHyperframesBrowserMarker(["--no-sandbox", "--disable-setuid-sandbox"]), - }); +export async function launchVerifyBrowser(sandbox = chromeSandboxEnabled()): Promise { + return launchWithChromeSandboxFallback(chromeSandboxArgs(sandbox), (args) => + puppeteer.launch({ + headless: true, + executablePath: process.env.PUPPETEER_EXECUTABLE_PATH || undefined, + args: withHyperframesBrowserMarker(args), + }), + ); } export async function checkPageLoads( diff --git a/scripts/package-size-budgets.json b/scripts/package-size-budgets.json index fed6ff0afa..9a279e0192 100644 --- a/scripts/package-size-budgets.json +++ b/scripts/package-size-budgets.json @@ -20,7 +20,7 @@ "unpacked": 170124 }, "@hyperframes/inspector": { - "packed": 880000, + "packed": 933584, "unpacked": 3830000 }, "@hyperframes/lint": {