fix: 🐛 raytrace deadlock - pre-warm 2N+8 pthread Workers
This commit is contained in:
parent
b4cb10b1c6
commit
7630c7e521
8 changed files with 745 additions and 155 deletions
190
tests/kicad/3d-viewer-deadlock.spec.ts
Normal file
190
tests/kicad/3d-viewer-deadlock.spec.ts
Normal file
|
|
@ -0,0 +1,190 @@
|
|||
import { test, expect } from './fixtures';
|
||||
import { waitForPcbnew } from './utils/pcbnew-ready';
|
||||
import { countGlCanvases, loadBoard, openThreeDViewer } from './utils/threed-viewer';
|
||||
|
||||
/**
|
||||
* Regression for the camera-move-on-canvas raytrace DEADLOCK.
|
||||
*
|
||||
* The 3D viewer's EDA_3D_CANVAS is a wxGLCanvas whose paint runs the multi-threaded CPU
|
||||
* raytracer. Moving the camera makes the raytracer spawn raw std::thread workers; with no
|
||||
* PROXY_TO_PTHREAD its join runs on the browser main thread, and KiCad's own thread pool has
|
||||
* already drained emscripten's pre-warmed Worker pool — so those threads fall back to on-demand
|
||||
* `new Worker()`, whose boot handshake needs the main thread back in the JS event loop, which it
|
||||
* can't reach while blocked in the render's busy-wait join. That circular wait is the freeze the
|
||||
* user hit ("move the model → tab freezes"). The fix pre-warms PTHREAD_POOL_SIZE =
|
||||
* hardwareConcurrency*2+8 for 3D-viewer builds (scripts/kicad/build-kicad-target.sh) so on-demand
|
||||
* creation never happens; a wxwidgets wasm-layer change (src/wasm/app.cpp) additionally defers the
|
||||
* 3D viewer's synchronous mouse-button Paint to the yielding pump (jank + defense, mirroring the
|
||||
* resize-deadlock fix).
|
||||
*
|
||||
* Drives the REAL viewer with two camera-rotate drags (mirroring "move the model … move it
|
||||
* again"), each followed by a settle for the raytrace to converge, asserting after every step that
|
||||
* (a) the wasm main thread stays responsive (a deadlock hangs it) and (b) nothing aborted. Pre-fix
|
||||
* a camera drag freezes or aborts; post-fix both stay live and the board keeps rendering. Frame
|
||||
* drag/resize of the viewer are covered by 3d-viewer.spec.ts.
|
||||
*
|
||||
* ISOLATED in its own spec file (own Playwright worker → own browser process → a SINGLE heavy
|
||||
* pcbnew load). The pre-warmed pool is ~2x hardwareConcurrency Workers PER load; running several
|
||||
* 3D-viewer loads in one process (a serial describe) accumulates enough Workers that a later
|
||||
* load's pool is short and the raytracer deadlocks anyway — so this test must not share a worker
|
||||
* with the other 3D-viewer tests.
|
||||
*
|
||||
* Notes: the glcanvas client area is pointer-events:none, so a page.mouse drag over it falls
|
||||
* through to the main #canvas whose Emscripten mousedown/up callback dispatches into
|
||||
* wxApp::HandleMouseEvent — the deadlock path. WebGL pixels are read via drawImage→2D→getImageData
|
||||
* (preserveDrawingBuffer=true), since a CDP screenshot of a WebGL canvas is blank on swiftshader.
|
||||
*/
|
||||
test.describe('3D viewer camera-move deadlock', () => {
|
||||
// One 187 MB wasm runtime is already heavy; keep this serial and generous.
|
||||
test.describe.configure({ mode: 'serial' });
|
||||
test.setTimeout(240000);
|
||||
|
||||
test('camera-move drag on the 3D canvas does not deadlock the raytracer (regression)',
|
||||
async ({ page, testLogger }) => {
|
||||
await page.goto('/kicad/pcbnew.html');
|
||||
await waitForPcbnew(page);
|
||||
await loadBoard(page, testLogger);
|
||||
|
||||
const winsBefore = await page.evaluate(() =>
|
||||
Array.from(document.querySelectorAll('#window-container [id^="window-"]')).map((e) => e.id));
|
||||
const glBefore = await countGlCanvases(page);
|
||||
await openThreeDViewer(page, glBefore);
|
||||
|
||||
const winId = await page.evaluate((before: string[]) => {
|
||||
const all = Array.from(document.querySelectorAll('#window-container [id^="window-"]')).map((e) => e.id);
|
||||
return all.find((id) => !before.includes(id)) ?? all[all.length - 1] ?? null;
|
||||
}, winsBefore);
|
||||
expect(winId, 'the 3D viewer should open a new top-level window').toBeTruthy();
|
||||
|
||||
// Let the INITIAL raytrace settle through the safe per-frame pump (Workers boot here).
|
||||
await page.waitForTimeout(5000);
|
||||
|
||||
// Read the newest glcanvas-* (the 3D viewer) client rect in viewport coords.
|
||||
const canvasRect = () => page.evaluate(() => {
|
||||
const list = document.querySelectorAll('canvas[id^="glcanvas-"]');
|
||||
const el = list[list.length - 1] as HTMLCanvasElement;
|
||||
const r = el.getBoundingClientRect();
|
||||
return { x: r.x, y: r.y, w: r.width, h: r.height };
|
||||
});
|
||||
|
||||
// Sample the viewer canvas backing store: distinct colours (board rendered?) plus a
|
||||
// coarse pixel signature (did the render change after the camera moved?).
|
||||
const sampleCanvas = () => page.evaluate(() => {
|
||||
const list = document.querySelectorAll('canvas[id^="glcanvas-"]');
|
||||
const el = list[list.length - 1] as HTMLCanvasElement;
|
||||
const tmp = document.createElement('canvas');
|
||||
tmp.width = el.width; tmp.height = el.height;
|
||||
const ctx = tmp.getContext('2d')!;
|
||||
ctx.drawImage(el, 0, 0);
|
||||
const colors = new Set<string>();
|
||||
let sig = '';
|
||||
for (let i = 0; i < 16; i++) {
|
||||
for (let j = 0; j < 16; j++) {
|
||||
const d = ctx.getImageData(Math.floor(el.width * i / 16),
|
||||
Math.floor(el.height * j / 16), 1, 1).data;
|
||||
colors.add(`${d[0]},${d[1]},${d[2]}`);
|
||||
sig += `${d[0]}.${d[1]}.${d[2]}|`;
|
||||
}
|
||||
}
|
||||
return { distinctColors: colors.size, sig };
|
||||
});
|
||||
|
||||
// Main-thread liveness probe. A pthread-join deadlock hangs the wasm main thread → the
|
||||
// browser main JS thread is blocked → in-page polling can't run → this times out.
|
||||
// Returns false on a freeze rather than throwing.
|
||||
const mainThreadAlive = () => page.waitForFunction(() => {
|
||||
const r = (window as unknown as { wxElementRegistry?: { findAll: (o: unknown) => unknown[] } })
|
||||
.wxElementRegistry;
|
||||
return !!r && r.findAll({ visible: true }).length > 0;
|
||||
}, null, { timeout: 15000 }).then(() => true).catch(() => false);
|
||||
|
||||
const abortLines = () => [...testLogger.consoleLogs, ...testLogger.errors].filter((l) =>
|
||||
l.includes('Aborted(')
|
||||
|| l.toLowerCase().includes('invalid state')
|
||||
|| l.toLowerCase().includes('uncaught exception: unwind')
|
||||
|| l.toLowerCase().includes('indirect call to null'));
|
||||
|
||||
// Run an interaction with a hard wall-clock bound: a hard freeze can also hang the CDP
|
||||
// input dispatch, so this fails fast instead of at the 240s test timeout.
|
||||
const bounded = async (fn: () => Promise<void>, ms: number): Promise<boolean> => {
|
||||
let froze = false;
|
||||
await Promise.race([
|
||||
fn().catch(() => { /* an in-wasm abort surfaces via abortLines(), not here */ }),
|
||||
new Promise<void>((r) => setTimeout(() => { froze = true; r(); }, ms)),
|
||||
]);
|
||||
return froze;
|
||||
};
|
||||
|
||||
// Rotate the camera: left-drag inside the GL region (below the ~28px titlebar).
|
||||
const rotate = async () => {
|
||||
const c = await canvasRect();
|
||||
const cx = c.x + c.w / 2;
|
||||
const cy = c.y + c.h / 2 + 40;
|
||||
await page.mouse.move(cx, cy);
|
||||
await page.mouse.down();
|
||||
await page.mouse.move(cx + 140, cy + 70, { steps: 14 });
|
||||
await page.mouse.move(cx - 90, cy + 20, { steps: 10 });
|
||||
await page.mouse.up();
|
||||
};
|
||||
// Wait for the raytrace kicked by a camera move to CONVERGE (canvas signature stable
|
||||
// across two samples) before the next move, so successive renders don't overlap and
|
||||
// momentarily demand more pthread Workers than the pool holds. On the fixed build this
|
||||
// returns in a few polls; a mid-render deadlock is caught by the assertLive that follows.
|
||||
const settleRender = async (maxMs: number) => {
|
||||
let prev = '';
|
||||
const start = Date.now();
|
||||
while (Date.now() - start < maxMs) {
|
||||
await page.waitForTimeout(1500);
|
||||
const s = (await sampleCanvas()).sig;
|
||||
if (s === prev) return;
|
||||
prev = s;
|
||||
}
|
||||
};
|
||||
|
||||
// After each step: nothing aborted, main thread still live.
|
||||
const assertLive = async (step: string) => {
|
||||
expect(abortLines(), `raytrace aborted during "${step}":\n${abortLines().join('\n\n')}`)
|
||||
.toEqual([]);
|
||||
expect(await mainThreadAlive(),
|
||||
`wasm main thread unresponsive after "${step}" → deadlock`).toBe(true);
|
||||
};
|
||||
|
||||
const before = await sampleCanvas();
|
||||
console.log(`[TEST] 3D render before interaction: ${before.distinctColors} distinct colours`);
|
||||
|
||||
// THE deadlock path: a left-drag on the 3D canvas rotates the model; the terminating
|
||||
// mouse button events drive wxApp::HandleMouseEvent's synchronous Paint() of the
|
||||
// wxGLCanvas, running the multi-threaded CPU raytracer. Pre-fix its on-demand pthread
|
||||
// Worker boot deadlocks the main thread; post-fix the pre-warmed pool covers it and each
|
||||
// move stays live. Two moves with a settle between mirror the user's "move the model …
|
||||
// move it again".
|
||||
let froze = await bounded(rotate, 30000);
|
||||
expect(froze, 'the first camera-rotate drag froze the wasm main thread (deadlock)').toBe(false);
|
||||
await assertLive('camera rotate');
|
||||
await settleRender(25000);
|
||||
await assertLive('camera rotate settle');
|
||||
|
||||
// Validity: the render changed → the synthetic mouse actually reached the 3D canvas
|
||||
// (guards against a false green where the drag missed the canvas entirely).
|
||||
const mid = await sampleCanvas();
|
||||
expect(mid.sig,
|
||||
'the 3D render did not change after the first camera move — the synthetic mouse '
|
||||
+ 'likely never reached the 3D canvas (invalid repro), or the render stalled')
|
||||
.not.toBe(before.sig);
|
||||
|
||||
froze = await bounded(rotate, 30000);
|
||||
expect(froze, 'the second camera-rotate drag froze the main thread').toBe(false);
|
||||
await assertLive('camera rotate again');
|
||||
await settleRender(25000);
|
||||
await assertLive('camera rotate again settle');
|
||||
|
||||
await page.screenshot({ path: 'test-results/3d-viewer-deadlock.png', scale: 'device' });
|
||||
|
||||
// Sanity: the board still renders (not blank / crashed) after both moves.
|
||||
const after = await sampleCanvas();
|
||||
console.log(`[TEST] 3D render after interaction: ${after.distinctColors} distinct colours`);
|
||||
expect(after.distinctColors,
|
||||
'the 3D viewer should still render the board (many colours) after the camera moves')
|
||||
.toBeGreaterThan(8);
|
||||
});
|
||||
});
|
||||
|
|
@ -1,9 +1,6 @@
|
|||
import type { Page } from '@playwright/test';
|
||||
import { test, expect } from './fixtures';
|
||||
import { clickMenuBarItem, clickMenuItem } from '../e2e/utils/element-tracker';
|
||||
import { injectFromSubmodule } from './utils/fs-inject';
|
||||
import { waitForBoardLoaded } from './utils/board-ready';
|
||||
import { waitForPcbnew } from './utils/pcbnew-ready';
|
||||
import { DEMO, loadBoard, countGlCanvases, openThreeDViewer } from './utils/threed-viewer';
|
||||
|
||||
/**
|
||||
* 3D viewer e2e: load a real board in pcbnew, open the native 3D viewer
|
||||
|
|
@ -21,93 +18,6 @@ import { waitForPcbnew } from './utils/pcbnew-ready';
|
|||
* models — deferred), the viewer shows copper/silk/mask/edge geometry in 3D.
|
||||
*/
|
||||
|
||||
// KiCad 10 stores projects under /home/kicad/documents/kicad/10.0/projects.
|
||||
const KICAD_VERSION_DIR = '10.0';
|
||||
const PROJECT_DIR_MEMFS = `/home/kicad/documents/kicad/${KICAD_VERSION_DIR}/projects`;
|
||||
|
||||
// pic_programmer frames correctly in the default 3D camera (the microwave demo
|
||||
// has a known board-bounding-box scale bug that projects it off-screen — a
|
||||
// separate follow-up). Loads cleanly in this harness (see 2D load tests).
|
||||
const DEMO = { name: 'pic_programmer', dir: 'pic_programmer', stem: 'pic_programmer' } as const;
|
||||
|
||||
async function loadBoard(page: Page, testLogger: { consoleLogs: string[]; errors: string[] }): Promise<void> {
|
||||
const pcbFilename = `${DEMO.stem}.kicad_pcb`;
|
||||
const proFilename = `${DEMO.stem}.kicad_pro`;
|
||||
|
||||
await injectFromSubmodule(page, `kicad/demos/${DEMO.dir}/${pcbFilename}`,
|
||||
`${PROJECT_DIR_MEMFS}/${pcbFilename}`);
|
||||
await injectFromSubmodule(page, `kicad/demos/${DEMO.dir}/${proFilename}`,
|
||||
`${PROJECT_DIR_MEMFS}/${proFilename}`);
|
||||
|
||||
expect(await clickMenuBarItem(page, 'File'), 'File menu should be findable').toBe(true);
|
||||
await page.waitForTimeout(400);
|
||||
expect(await clickMenuItem(page, 'Open...'), 'Open… menu item should be findable').toBe(true);
|
||||
|
||||
await page.waitForFunction(() => {
|
||||
const registry = window.wxElementRegistry;
|
||||
return !!registry && registry.findAll({ visible: true })
|
||||
.some((el) => el.typeName === 'wxFileDialog');
|
||||
}, null, { timeout: 15000 });
|
||||
await page.waitForTimeout(1000);
|
||||
|
||||
const filenameInput = await page.evaluate(() => {
|
||||
const registry = window.wxElementRegistry;
|
||||
if (!registry) return null;
|
||||
const text = registry.findAll({ visible: true })
|
||||
.find((el) => el.typeName === 'wxTextCtrl' && el.name === 'text');
|
||||
return text ? { x: text.centerX, y: text.centerY } : null;
|
||||
});
|
||||
expect(filenameInput, 'filename text input should be visible').not.toBeNull();
|
||||
if (!filenameInput) throw new Error('filename text input not found');
|
||||
|
||||
await page.mouse.click(filenameInput.x, filenameInput.y);
|
||||
await page.waitForTimeout(200);
|
||||
await page.keyboard.type(pcbFilename);
|
||||
await page.waitForTimeout(300);
|
||||
await page.keyboard.press('Enter');
|
||||
await page.waitForTimeout(1000);
|
||||
|
||||
const result = await waitForBoardLoaded(page, testLogger, 60000);
|
||||
console.log(`[TEST] ${DEMO.name} board-ready result: ${result}`);
|
||||
}
|
||||
|
||||
function countGlCanvases(page: Page): Promise<number> {
|
||||
return page.evaluate(() => document.querySelectorAll('canvas[id^="glcanvas-"]').length);
|
||||
}
|
||||
|
||||
// Open the 3D viewer (View → 3D Viewer, with an Alt+3 fallback) and wait for the
|
||||
// secondary frame + its NEW `glcanvas-*` to appear. The main pcbnew board view is
|
||||
// itself a wxGLCanvas, so the viewer is detected by the GL-canvas COUNT increasing.
|
||||
// Returns the glcanvas count after opening. `glBefore` is the count beforehand.
|
||||
async function openThreeDViewer(page: Page, glBefore: number): Promise<number> {
|
||||
let opened = false;
|
||||
if (await clickMenuBarItem(page, 'View')) {
|
||||
await page.waitForTimeout(400);
|
||||
opened = await clickMenuItem(page, '3D Viewer');
|
||||
}
|
||||
if (!opened) {
|
||||
console.log('[TEST] View → 3D Viewer not found via menu; trying Alt+3');
|
||||
await page.keyboard.press('Escape');
|
||||
await page.waitForTimeout(200);
|
||||
await page.keyboard.press('Alt+3');
|
||||
}
|
||||
|
||||
await page.waitForFunction(() => {
|
||||
// A new top-level window div beyond the main pcbnew frame.
|
||||
return !!document.querySelector('#window-container [id^="window-"]')
|
||||
|| document.querySelectorAll('canvas[id^="glcanvas-"]').length > 0;
|
||||
}, null, { timeout: 60000 });
|
||||
|
||||
await page.waitForFunction((before: number) =>
|
||||
document.querySelectorAll('canvas[id^="glcanvas-"]').length > before,
|
||||
glBefore, { timeout: 60000 });
|
||||
|
||||
const glAfter = await countGlCanvases(page);
|
||||
console.log(`[TEST] glcanvas count after opening 3D viewer: ${glAfter}`);
|
||||
expect(glAfter, 'a new WebGL canvas should appear for the 3D viewer').toBeGreaterThan(glBefore);
|
||||
return glAfter;
|
||||
}
|
||||
|
||||
test.describe('3D viewer from pcbnew', () => {
|
||||
// One 187 MB wasm runtime is already heavy; keep this serial and generous.
|
||||
test.describe.configure({ mode: 'serial' });
|
||||
|
|
|
|||
97
tests/kicad/utils/threed-viewer.ts
Normal file
97
tests/kicad/utils/threed-viewer.ts
Normal file
|
|
@ -0,0 +1,97 @@
|
|||
import type { Page } from '@playwright/test';
|
||||
import { expect } from '@playwright/test';
|
||||
import { clickMenuBarItem, clickMenuItem } from '../../e2e/utils/element-tracker';
|
||||
import { injectFromSubmodule } from './fs-inject';
|
||||
import { waitForBoardLoaded } from './board-ready';
|
||||
|
||||
// Shared helpers for the 3D-viewer specs (3d-viewer.spec.ts + 3d-viewer-deadlock.spec.ts).
|
||||
|
||||
// KiCad 10 stores projects under /home/kicad/documents/kicad/10.0/projects.
|
||||
export const KICAD_VERSION_DIR = '10.0';
|
||||
export const PROJECT_DIR_MEMFS = `/home/kicad/documents/kicad/${KICAD_VERSION_DIR}/projects`;
|
||||
|
||||
// pic_programmer frames correctly in the default 3D camera (the microwave demo
|
||||
// has a known board-bounding-box scale bug that projects it off-screen — a
|
||||
// separate follow-up). Loads cleanly in this harness (see 2D load tests).
|
||||
export const DEMO = { name: 'pic_programmer', dir: 'pic_programmer', stem: 'pic_programmer' } as const;
|
||||
|
||||
export async function loadBoard(
|
||||
page: Page,
|
||||
testLogger: { consoleLogs: string[]; errors: string[] },
|
||||
): Promise<void> {
|
||||
const pcbFilename = `${DEMO.stem}.kicad_pcb`;
|
||||
const proFilename = `${DEMO.stem}.kicad_pro`;
|
||||
|
||||
await injectFromSubmodule(page, `kicad/demos/${DEMO.dir}/${pcbFilename}`,
|
||||
`${PROJECT_DIR_MEMFS}/${pcbFilename}`);
|
||||
await injectFromSubmodule(page, `kicad/demos/${DEMO.dir}/${proFilename}`,
|
||||
`${PROJECT_DIR_MEMFS}/${proFilename}`);
|
||||
|
||||
expect(await clickMenuBarItem(page, 'File'), 'File menu should be findable').toBe(true);
|
||||
await page.waitForTimeout(400);
|
||||
expect(await clickMenuItem(page, 'Open...'), 'Open… menu item should be findable').toBe(true);
|
||||
|
||||
await page.waitForFunction(() => {
|
||||
const registry = window.wxElementRegistry;
|
||||
return !!registry && registry.findAll({ visible: true })
|
||||
.some((el) => el.typeName === 'wxFileDialog');
|
||||
}, null, { timeout: 15000 });
|
||||
await page.waitForTimeout(1000);
|
||||
|
||||
const filenameInput = await page.evaluate(() => {
|
||||
const registry = window.wxElementRegistry;
|
||||
if (!registry) return null;
|
||||
const text = registry.findAll({ visible: true })
|
||||
.find((el) => el.typeName === 'wxTextCtrl' && el.name === 'text');
|
||||
return text ? { x: text.centerX, y: text.centerY } : null;
|
||||
});
|
||||
expect(filenameInput, 'filename text input should be visible').not.toBeNull();
|
||||
if (!filenameInput) throw new Error('filename text input not found');
|
||||
|
||||
await page.mouse.click(filenameInput.x, filenameInput.y);
|
||||
await page.waitForTimeout(200);
|
||||
await page.keyboard.type(pcbFilename);
|
||||
await page.waitForTimeout(300);
|
||||
await page.keyboard.press('Enter');
|
||||
await page.waitForTimeout(1000);
|
||||
|
||||
const result = await waitForBoardLoaded(page, testLogger, 60000);
|
||||
console.log(`[TEST] ${DEMO.name} board-ready result: ${result}`);
|
||||
}
|
||||
|
||||
export function countGlCanvases(page: Page): Promise<number> {
|
||||
return page.evaluate(() => document.querySelectorAll('canvas[id^="glcanvas-"]').length);
|
||||
}
|
||||
|
||||
// Open the 3D viewer (View → 3D Viewer, with an Alt+3 fallback) and wait for the
|
||||
// secondary frame + its NEW `glcanvas-*` to appear. The main pcbnew board view is
|
||||
// itself a wxGLCanvas, so the viewer is detected by the GL-canvas COUNT increasing.
|
||||
// Returns the glcanvas count after opening. `glBefore` is the count beforehand.
|
||||
export async function openThreeDViewer(page: Page, glBefore: number): Promise<number> {
|
||||
let opened = false;
|
||||
if (await clickMenuBarItem(page, 'View')) {
|
||||
await page.waitForTimeout(400);
|
||||
opened = await clickMenuItem(page, '3D Viewer');
|
||||
}
|
||||
if (!opened) {
|
||||
console.log('[TEST] View → 3D Viewer not found via menu; trying Alt+3');
|
||||
await page.keyboard.press('Escape');
|
||||
await page.waitForTimeout(200);
|
||||
await page.keyboard.press('Alt+3');
|
||||
}
|
||||
|
||||
await page.waitForFunction(() => {
|
||||
// A new top-level window div beyond the main pcbnew frame.
|
||||
return !!document.querySelector('#window-container [id^="window-"]')
|
||||
|| document.querySelectorAll('canvas[id^="glcanvas-"]').length > 0;
|
||||
}, null, { timeout: 60000 });
|
||||
|
||||
await page.waitForFunction((before: number) =>
|
||||
document.querySelectorAll('canvas[id^="glcanvas-"]').length > before,
|
||||
glBefore, { timeout: 60000 });
|
||||
|
||||
const glAfter = await countGlCanvases(page);
|
||||
console.log(`[TEST] glcanvas count after opening 3D viewer: ${glAfter}`);
|
||||
expect(glAfter, 'a new WebGL canvas should appear for the 3D viewer').toBeGreaterThan(glBefore);
|
||||
return glAfter;
|
||||
}
|
||||
|
|
@ -1,9 +1,9 @@
|
|||
import { defineConfig, devices } from '@playwright/test';
|
||||
import { execSync } from 'child_process';
|
||||
import * as fs from 'fs';
|
||||
import * as path from 'path';
|
||||
import { defineConfig, devices } from "@playwright/test";
|
||||
import { execSync } from "child_process";
|
||||
import * as fs from "fs";
|
||||
import * as path from "path";
|
||||
|
||||
const PORT_FILE = path.join(__dirname, '.test-port');
|
||||
const PORT_FILE = path.join(__dirname, ".test-port");
|
||||
|
||||
// NOTE: Chrome headless crashes on ARM Mac due to SwiftShader WebGL bug
|
||||
// (Chromium issues #1416283, #338414704). Firefox headless works reliably.
|
||||
|
|
@ -30,10 +30,10 @@ const PORT_FILE = path.join(__dirname, '.test-port');
|
|||
// forked with an empty argv), and it imports this config — and so writes the
|
||||
// file — before any worker is spawned.
|
||||
function resolvePort(): number {
|
||||
const isMainRunner = process.argv.slice(2).includes('test');
|
||||
const isMainRunner = process.argv.slice(2).includes("test");
|
||||
if (!isMainRunner) {
|
||||
try {
|
||||
const existing = parseInt(fs.readFileSync(PORT_FILE, 'utf-8').trim(), 10);
|
||||
const existing = parseInt(fs.readFileSync(PORT_FILE, "utf-8").trim(), 10);
|
||||
if (existing > 0 && existing < 65536) {
|
||||
return existing;
|
||||
}
|
||||
|
|
@ -51,8 +51,8 @@ function resolvePort(): number {
|
|||
function findFreePort(): number {
|
||||
try {
|
||||
const result = execSync(
|
||||
'python3 -c "import socket; s=socket.socket(); s.bind((\'\',0)); print(s.getsockname()[1]); s.close()"',
|
||||
{ encoding: 'utf-8' }
|
||||
"python3 -c \"import socket; s=socket.socket(); s.bind(('',0)); print(s.getsockname()[1]); s.close()\"",
|
||||
{ encoding: "utf-8" }
|
||||
);
|
||||
return parseInt(result.trim());
|
||||
} catch {
|
||||
|
|
@ -68,44 +68,47 @@ const port = resolvePort();
|
|||
// on arm64, whose denser code fits). V8 handles it, so on CI these specs run
|
||||
// on bundled Chromium (the 'chromium-ci' project) and firefox skips them.
|
||||
const PCBNEW_FAMILY_SPECS = [
|
||||
'**/pcbnew.spec.ts',
|
||||
'**/pcbnew-collab.spec.ts',
|
||||
'**/load-pcb.spec.ts',
|
||||
'**/load-pcb-probe.spec.ts',
|
||||
"**/pcbnew.spec.ts",
|
||||
"**/pcbnew-collab.spec.ts",
|
||||
"**/load-pcb.spec.ts",
|
||||
"**/load-pcb-probe.spec.ts",
|
||||
// Specs added 2026-06-11..06-13 that boot pcbnew (pcbnew.html /
|
||||
// pcbnew-collab.html). Without routing here they ran on Firefox in CI and
|
||||
// timed out at instantiation (the SpiderMonkey/x86 code-budget OOM above).
|
||||
// The last three are parametrized across pl_editor/eeschema/pcbnew; routing
|
||||
// the whole file moves those variants to chromium-ci too (they boot fine on
|
||||
// V8) — only the browser exercising them changes, not whether they run.
|
||||
'**/appearance.spec.ts',
|
||||
'**/contextmenu-scrollbar-pcbnew.spec.ts',
|
||||
'**/dark-mode.spec.ts',
|
||||
'**/items-bridge.spec.ts',
|
||||
'**/roundtrip.spec.ts',
|
||||
'**/save-hook.spec.ts',
|
||||
"**/appearance.spec.ts",
|
||||
"**/contextmenu-scrollbar-pcbnew.spec.ts",
|
||||
"**/dark-mode.spec.ts",
|
||||
"**/items-bridge.spec.ts",
|
||||
"**/roundtrip.spec.ts",
|
||||
"**/save-hook.spec.ts",
|
||||
// boots pcbnew.html — must run on V8 (chromium-ci); on Firefox/x86 CI the
|
||||
// ~190M module OOMs at instantiation and #canvas never appears (run 27626037849).
|
||||
'**/pcbnew-move.spec.ts',
|
||||
"**/pcbnew-move.spec.ts",
|
||||
// 3D viewer specs boot pcbnew.html (3D-enabled build) — same V8 routing.
|
||||
'**/3d-viewer.spec.ts',
|
||||
'**/3d-viewer-models.spec.ts',
|
||||
'**/footprint-3d-preview.spec.ts',
|
||||
"**/3d-viewer.spec.ts",
|
||||
// Isolated (own file → own worker) so its heavy single load isn't degraded by the
|
||||
// Worker accumulation of the other 3D-viewer tests sharing a process (see the file header).
|
||||
"**/3d-viewer-deadlock.spec.ts",
|
||||
"**/3d-viewer-models.spec.ts",
|
||||
"**/footprint-3d-preview.spec.ts",
|
||||
];
|
||||
|
||||
// Runtime-perf specs run ONLY on the Chromium 'perf' project below: they need
|
||||
// CDP CPU throttling (Chromium-only) and pcbnew needs V8. Excluded from the
|
||||
// firefox/chromium projects so they don't double-run there.
|
||||
const PERF_SPECS = ['**/*-perf.spec.ts'];
|
||||
const PERF_SPECS = ["**/*-perf.spec.ts"];
|
||||
|
||||
const appsDir = 'apps';
|
||||
const appsDir = "apps";
|
||||
|
||||
export default defineConfig({
|
||||
globalSetup: './global-setup.ts',
|
||||
testDir: './kicad',
|
||||
globalSetup: "./global-setup.ts",
|
||||
testDir: "./kicad",
|
||||
// See playwright.config.ts: keep CI's outputDir cleanup off test-results/ so the kicad +
|
||||
// perf runs don't wipe the accumulated screenshots.
|
||||
outputDir: process.env.CI ? 'pw-artifacts/kicad' : 'test-results',
|
||||
outputDir: process.env.CI ? "pw-artifacts/kicad" : "test-results",
|
||||
fullyParallel: true,
|
||||
forbidOnly: !!process.env.CI,
|
||||
// 1 local retry absorbs the known under-parallel-load flakes (same rationale
|
||||
|
|
@ -116,47 +119,52 @@ export default defineConfig({
|
|||
// local — the serial CI run was the dominant wall-clock cost. Cap (e.g. '50%'
|
||||
// or a fixed count) if contention OOMs/flakes; retries:2 covers transient.
|
||||
workers: undefined,
|
||||
reporter: 'html',
|
||||
timeout: 180000, // KiCad WASM needs more time to load (3 minutes)
|
||||
reporter: "html",
|
||||
timeout: 180000, // KiCad WASM needs more time to load (3 minutes)
|
||||
|
||||
use: {
|
||||
baseURL: `http://localhost:${port}`,
|
||||
trace: 'retain-on-failure',
|
||||
screenshot: 'only-on-failure',
|
||||
trace: "retain-on-failure",
|
||||
screenshot: "only-on-failure",
|
||||
},
|
||||
|
||||
projects: [
|
||||
{
|
||||
// Firefox is the default for headless testing (works on ARM Mac)
|
||||
name: 'firefox',
|
||||
name: "firefox",
|
||||
// Perf specs always run on the dedicated 'perf' project, never here. On CI
|
||||
// the pcbnew-family specs also move to chromium-ci (see PCBNEW_FAMILY_SPECS).
|
||||
testIgnore: [...PERF_SPECS, ...(process.env.CI ? PCBNEW_FAMILY_SPECS : [])],
|
||||
testIgnore: [
|
||||
...PERF_SPECS,
|
||||
...(process.env.CI ? PCBNEW_FAMILY_SPECS : []),
|
||||
],
|
||||
use: {
|
||||
...devices['Desktop Firefox'],
|
||||
...devices["Desktop Firefox"],
|
||||
viewport: { width: 1280, height: 720 },
|
||||
// CI-only prefs: GPU-less CI VMs hit two Firefox blockers (identical on
|
||||
// Hetzner ccx53 and ubicloud-standard-30, runs 27329612719/27330989479).
|
||||
// Gated on CI so local runs keep stock Firefox behavior.
|
||||
...(process.env.CI ? {
|
||||
// Headless Firefox cannot create any GL context on the GPU-less CI
|
||||
// VMs (blocklist bypass still ends in FEATURE_FAILURE_WEBGL_EXHAUSTED_
|
||||
// DRIVERS) — run headed under Xvfb instead, where GLX + Mesa llvmpipe
|
||||
// provides software WebGL. CI invokes the suite via `xvfb-run`.
|
||||
headless: false,
|
||||
launchOptions: {
|
||||
firefoxUserPrefs: {
|
||||
// Skip the no-GPU blocklist ("AllowWebgl2:false restricts
|
||||
// context creation") so the GAL canvas gets a WebGL context.
|
||||
'webgl.force-enabled': true,
|
||||
// pcbnew.wasm (~190M) OOMs the optimizing wasm JIT at compile
|
||||
// time ("InternalError: out of memory") and the app never boots.
|
||||
// Baseline-only compilation trades runtime speed for a compile
|
||||
// that fits in memory.
|
||||
'javascript.options.wasm_optimizingjit': false,
|
||||
},
|
||||
},
|
||||
} : {}),
|
||||
...(process.env.CI
|
||||
? {
|
||||
// Headless Firefox cannot create any GL context on the GPU-less CI
|
||||
// VMs (blocklist bypass still ends in FEATURE_FAILURE_WEBGL_EXHAUSTED_
|
||||
// DRIVERS) — run headed under Xvfb instead, where GLX + Mesa llvmpipe
|
||||
// provides software WebGL. CI invokes the suite via `xvfb-run`.
|
||||
headless: false,
|
||||
launchOptions: {
|
||||
firefoxUserPrefs: {
|
||||
// Skip the no-GPU blocklist ("AllowWebgl2:false restricts
|
||||
// context creation") so the GAL canvas gets a WebGL context.
|
||||
"webgl.force-enabled": true,
|
||||
// pcbnew.wasm (~190M) OOMs the optimizing wasm JIT at compile
|
||||
// time ("InternalError: out of memory") and the app never boots.
|
||||
// Baseline-only compilation trades runtime speed for a compile
|
||||
// that fits in memory.
|
||||
"javascript.options.wasm_optimizingjit": false,
|
||||
},
|
||||
},
|
||||
}
|
||||
: {}),
|
||||
},
|
||||
},
|
||||
{
|
||||
|
|
@ -165,10 +173,10 @@ export default defineConfig({
|
|||
// The bundled Chromium fails with canvas hidden on ARM Mac because of
|
||||
// Chromium issues #1416283, #338414704 (SwiftShader WebGL bug).
|
||||
// Run via: npm run test:kicad:headed
|
||||
name: 'chromium',
|
||||
name: "chromium",
|
||||
testIgnore: PERF_SPECS,
|
||||
use: {
|
||||
channel: 'chrome',
|
||||
channel: "chrome",
|
||||
viewport: { width: 1280, height: 720 },
|
||||
},
|
||||
},
|
||||
|
|
@ -178,13 +186,13 @@ export default defineConfig({
|
|||
// (fine on x86 Linux; the SwiftShader bug above is ARM-Mac-specific).
|
||||
// --enable-unsafe-swiftshader: newer Chromium refuses software WebGL in
|
||||
// headless without it.
|
||||
name: 'chromium-ci',
|
||||
name: "chromium-ci",
|
||||
testMatch: PCBNEW_FAMILY_SPECS,
|
||||
use: {
|
||||
...devices['Desktop Chrome'],
|
||||
...devices["Desktop Chrome"],
|
||||
viewport: { width: 1280, height: 720 },
|
||||
launchOptions: {
|
||||
args: ['--enable-unsafe-swiftshader'],
|
||||
args: ["--enable-unsafe-swiftshader"],
|
||||
},
|
||||
},
|
||||
},
|
||||
|
|
@ -194,12 +202,12 @@ export default defineConfig({
|
|||
// throttle (FPS rose with throttle). --enable-unsafe-swiftshader lets it use
|
||||
// software WebGL headless on CI; harmless with a real GPU locally. Add --headed
|
||||
// locally for real-GPU FPS numbers.
|
||||
name: 'perf',
|
||||
name: "perf",
|
||||
testMatch: PERF_SPECS,
|
||||
use: {
|
||||
...devices['Desktop Chrome'],
|
||||
...devices["Desktop Chrome"],
|
||||
viewport: { width: 1280, height: 720 },
|
||||
launchOptions: { args: ['--enable-unsafe-swiftshader'] },
|
||||
launchOptions: { args: ["--enable-unsafe-swiftshader"] },
|
||||
},
|
||||
},
|
||||
],
|
||||
|
|
|
|||
Loading…
Reference in a new issue