diff --git a/packages/engine/src/services/browserManager.ts b/packages/engine/src/services/browserManager.ts index 9d91a29998..915b1b6d92 100644 --- a/packages/engine/src/services/browserManager.ts +++ b/packages/engine/src/services/browserManager.ts @@ -65,17 +65,19 @@ interface WebGlProbeInfo { renderer: string; } +export const SOFTWARE_WEBGL_RENDERER_TOKENS: readonly string[] = [ + "swiftshader", + "llvmpipe", + "lavapipe", + "softpipe", + "mesa offscreen", + "microsoft basic render driver", + "software rasterizer", +]; + function isSoftwareWebGlRenderer(rendererInfo: string): boolean { const renderer = rendererInfo.trim().toLowerCase(); - return ( - renderer.includes("swiftshader") || - renderer.includes("llvmpipe") || - renderer.includes("lavapipe") || - renderer.includes("softpipe") || - renderer.includes("mesa offscreen") || - renderer.includes("microsoft basic render driver") || - renderer.includes("software rasterizer") - ); + return SOFTWARE_WEBGL_RENDERER_TOKENS.some((token) => renderer.includes(token)); } async function getPuppeteer(): Promise { diff --git a/packages/engine/src/services/drawElementService.test.ts b/packages/engine/src/services/drawElementService.test.ts index 3645425079..586175d000 100644 --- a/packages/engine/src/services/drawElementService.test.ts +++ b/packages/engine/src/services/drawElementService.test.ts @@ -1,11 +1,13 @@ -import { describe, expect, it, vi } from "vitest"; +import { afterEach, describe, expect, it, vi } from "vitest"; import type { Page } from "puppeteer-core"; import { classifyGpuRenderer, detectGpuBackend, detectSwiftShader, + drawElementGate, resolveDrawElementCaptureMode, } from "./drawElementService.js"; +import { SOFTWARE_WEBGL_RENDERER_TOKENS } from "./browserManager.js"; // ── detectGpuBackend / detectSwiftShader ─────────────────────────────────────── @@ -19,19 +21,16 @@ describe("detectGpuBackend", () => { it("carries the raw renderer string alongside the SwiftShader verdict", async () => { const page = makePage({ isSwiftShader: false, + webglAvailable: true, renderer: "ANGLE (NVIDIA, D3D11 vs_5_0 ps_5_0, D3D11)", }); expect(await detectGpuBackend(page)).toEqual({ isSwiftShader: false, + webglAvailable: true, renderer: "ANGLE (NVIDIA, D3D11 vs_5_0 ps_5_0, D3D11)", }); }); - it("reports null renderer when WebGL is unavailable", async () => { - const page = makePage({ isSwiftShader: false, renderer: null }); - expect(await detectGpuBackend(page)).toEqual({ isSwiftShader: false, renderer: null }); - }); - it("detectSwiftShader wrapper returns true when renderer is SwiftShader", async () => { const page = makePage({ isSwiftShader: true, renderer: "Google SwiftShader" }); expect(await detectSwiftShader(page)).toBe(true); @@ -43,9 +42,88 @@ describe("detectGpuBackend", () => { }); it("passes a function to page.evaluate", async () => { - const page = makePage({ isSwiftShader: false, renderer: null }); + const page = makePage({ isSwiftShader: false, webglAvailable: false, renderer: null }); await detectGpuBackend(page); - expect(page.evaluate).toHaveBeenCalledWith(expect.any(Function)); + expect(page.evaluate).toHaveBeenCalledWith( + expect.any(Function), + SOFTWARE_WEBGL_RENDERER_TOKENS, + ); + }); +}); + +// ── detectGpuBackend: the in-page probe itself ──────────────────────────────── +// The mocks above hand back a canned verdict, so none of them exercise the probe that +// produces it. These run the real in-page function against a stand-in `document`. + +describe("detectGpuBackend in-page probe", () => { + afterEach(() => vi.unstubAllGlobals()); + + /** A page whose evaluate runs the probe against a fake canvas. */ + function pageWithCanvas(getContext: (type: string) => unknown): Page { + vi.stubGlobal("document", { createElement: () => ({ getContext }) }); + return { + evaluate: async (fn: (...args: unknown[]) => unknown, ...args: unknown[]) => fn(...args), + } as unknown as Page; + } + + /** The gate for a screenshot launch, where only the backend can close it. */ + const gateFor = (backend: Awaited>) => + drawElementGate({ backend, launchCaptureMode: "screenshot", forceDE: false }); + + const glWithRenderer = (renderer: string) => ({ + getExtension: () => ({ UNMASKED_RENDERER_WEBGL: 0x9246 }), + getParameter: () => renderer, + }); + + it("reads a host with no WebGL context as unavailable, not as a real GPU", async () => { + const backend = await detectGpuBackend(pageWithCanvas(() => null)); + expect(backend).toEqual({ isSwiftShader: false, webglAvailable: false, renderer: null }); + expect(gateFor(backend)).toBe("webgl_unavailable"); + }); + + it("reads a getContext that throws as unavailable too", async () => { + const backend = await detectGpuBackend( + pageWithCanvas(() => { + throw new Error("GPU process crashed"); + }), + ); + expect(backend.webglAvailable).toBe(false); + expect(gateFor(backend)).toBe("webgl_unavailable"); + }); + + it("leaves a real GPU unchanged: WebGL available, not software, gate open", async () => { + const renderer = "ANGLE (Apple, ANGLE Metal Renderer: Apple M4 Pro, Unspecified Version)"; + const backend = await detectGpuBackend(pageWithCanvas(() => glWithRenderer(renderer))); + expect(backend).toEqual({ isSwiftShader: false, webglAvailable: true, renderer }); + expect(gateFor(backend)).toBeNull(); + }); + + it("leaves real SwiftShader unchanged: software, gated as swiftshader", async () => { + const renderer = + "ANGLE (Google, Vulkan 1.3.0 (SwiftShader Device (Subzero)), SwiftShader driver)"; + const backend = await detectGpuBackend(pageWithCanvas(() => glWithRenderer(renderer))); + expect(backend).toEqual({ isSwiftShader: true, webglAvailable: true, renderer }); + expect(gateFor(backend)).toBe("swiftshader"); + }); + + it.each([ + ["llvmpipe", "ANGLE (Mesa, llvmpipe (LLVM 15.0.7, 256 bits), OpenGL 4.5)"], + [ + "Microsoft Basic Render Driver", + "ANGLE (Microsoft, Microsoft Basic Render Driver Direct3D11 vs_5_0 ps_5_0)", + ], + ])("reads %s as software GL, gated like SwiftShader", async (_name, renderer) => { + const backend = await detectGpuBackend(pageWithCanvas(() => glWithRenderer(renderer))); + expect(backend).toEqual({ isSwiftShader: true, webglAvailable: true, renderer }); + expect(gateFor(backend)).toBe("swiftshader"); + }); + + it("keeps a context whose renderer string is hidden as available (a real GL context)", async () => { + const backend = await detectGpuBackend( + pageWithCanvas(() => ({ getExtension: () => null, getParameter: () => "" })), + ); + expect(backend).toEqual({ isSwiftShader: false, webglAvailable: true, renderer: null }); + expect(gateFor(backend)).toBeNull(); }); }); @@ -85,6 +163,45 @@ describe("classifyGpuRenderer", () => { }); }); +// ── drawElementGate ──────────────────────────────────────────────────────────── + +describe("drawElementGate", () => { + const gpu = { isSwiftShader: false, webglAvailable: true }; + + it("gates an opaque drawElement session launched for BeginFrame, even with a GPU backend", () => { + expect(drawElementGate({ backend: gpu, launchCaptureMode: "beginframe", forceDE: false })).toBe( + "beginframe_no_self_verify", + ); + }); + + it("lets a screenshot launch with a GPU backend engage", () => { + expect( + drawElementGate({ backend: gpu, launchCaptureMode: "screenshot", forceDE: false }), + ).toBeNull(); + }); + + it("names the backend before the launch mode, so a GPU-less BeginFrame host reads as webgl_unavailable", () => { + const none = { isSwiftShader: false, webglAvailable: false }; + expect( + drawElementGate({ backend: none, launchCaptureMode: "beginframe", forceDE: false }), + ).toBe("webgl_unavailable"); + const soft = { isSwiftShader: true, webglAvailable: true }; + expect( + drawElementGate({ backend: soft, launchCaptureMode: "beginframe", forceDE: false }), + ).toBe("swiftshader"); + }); + + it("lets HF_FORCE_DRAWELEMENT past the launch gate only, for R&D", () => { + expect( + drawElementGate({ backend: gpu, launchCaptureMode: "beginframe", forceDE: true }), + ).toBeNull(); + const soft = { isSwiftShader: true, webglAvailable: true }; + expect(drawElementGate({ backend: soft, launchCaptureMode: "beginframe", forceDE: true })).toBe( + "swiftshader", + ); + }); +}); + // ── resolveDrawElementCaptureMode ────────────────────────────────────────────── describe("resolveDrawElementCaptureMode", () => { diff --git a/packages/engine/src/services/drawElementService.ts b/packages/engine/src/services/drawElementService.ts index 8f95e956eb..db080dec33 100644 --- a/packages/engine/src/services/drawElementService.ts +++ b/packages/engine/src/services/drawElementService.ts @@ -15,6 +15,8 @@ */ import type { Page } from "puppeteer-core"; +import { SOFTWARE_WEBGL_RENDERER_TOKENS } from "./browserManager.js"; +import type { CaptureMode } from "./browserLeasePool.js"; /** * Discriminant prefix embedded in every "capture canvas isn't set up yet" @@ -56,24 +58,45 @@ export const DE_CANVAS_NOT_INITIALIZED_CODE = "HF_DE_CANVAS_NOT_INITIALIZED"; * destination additionally drops promoted sub-layers (Chromium bug * 521434899). The speedup is real only on a hardware GPU (macOS 1.6×), so * SwiftShader always routes to the platform baseline. - * - * The former