pcbjam/tests/kicad/symbol_editor.spec.ts

import type { Page } from '@playwright/test';
import { test, expect } from './fixtures';
import { clickByLabel } from '../e2e/utils/element-tracker';

/**
 * Symbol Editor WASM E2E Tests
 *
 * The symbol editor (FRAME_SCH_SYMBOL_EDITOR) is served by the eeschema kiface;
 * the standalone `symbol_editor` launcher opens that frame directly. It shares
 * the same first-run setup wizard as eeschema/pcbnew, so the launch flow mirrors
 * eeschema.spec.ts: wait for the canvas, click through the wizard, then assert the
 * editor chrome built. Scope is launch-only — the editor must start, paint a
 * canvas + toolbars, populate the element registry, and produce no WASM abort.
 * Library load/save and other features are intentionally out of scope here.
 */

async function completeWizard(page: Page): Promise<void> {
    await expect(page.locator('#canvas')).toBeVisible({ timeout: 90000 });
    await page.waitForFunction(() => !!window.wxElementRegistry, null, { timeout: 90000 });
    // The frame builds its UI a beat after the registry object appears; wait for
    // the registry to actually have entries (the wizard or the editor itself)
    // before driving it, otherwise we screenshot a blank canvas.
    await page.waitForFunction(() => {
        const registry = window.wxElementRegistry;
        return !!registry && registry.findAll({}).length > 0;
    }, null, { timeout: 90000 });
    await page.waitForTimeout(2000);

    await page.screenshot({ path: 'test-results/symbol_editor-wizard-00-initial.png', scale: 'css' });

    for (let i = 1; i <= 10; i++) {
        let clicked = await clickByLabel(page, 'Next >');

        if (!clicked) {
            clicked = await clickByLabel(page, 'Finish');

            if (clicked) {
                await page.waitForTimeout(500);
                await page.screenshot({
                    path: `test-results/symbol_editor-wizard-${String(i).padStart(2, '0')}-finish.png`,
                    scale: 'css'
                });
            }

            break;
        }

        await page.waitForTimeout(500);
        await page.screenshot({
            path: `test-results/symbol_editor-wizard-${String(i).padStart(2, '0')}.png`,
            scale: 'css'
        });
    }

    await page.waitForTimeout(2000);
}

function hasAbort(testLogger: { consoleLogs: string[]; errors: string[] }): boolean {
    return [...testLogger.consoleLogs, ...testLogger.errors].some(line => line.includes('Aborted('));
}

test.describe('symbol_editor WASM', () => {
    test.beforeEach(async ({ page }) => {
        await page.goto('/kicad/symbol_editor.html');
    });

    test('app loads, canvas visible, no WASM abort', async ({ page, testLogger }) => {
        await completeWizard(page);
        await page.screenshot({ path: 'test-results/symbol_editor-01-loaded.png', scale: 'css' });

        expect(hasAbort(testLogger), 'no WASM abort during load').toBe(false);

        const canvasCount = await page.locator('canvas').count();
        expect(canvasCount).toBeGreaterThan(0);
    });

    test('canvas + toolbar metrics look sane', async ({ page, testLogger }) => {
        await completeWizard(page);

        const metrics = await page.evaluate(() => {
            const registry = window.wxElementRegistry;
            const all = registry ? registry.findAll({ visible: true }) : [];
            const toolbars = all.filter((el: { typeName: string }) => /ToolBar/.test(el.typeName));
            const glCanvas = document.querySelector('canvas[id^="glcanvas-"]') as HTMLCanvasElement | null;

            return {
                registryTotal: all.length,
                toolbarCount: toolbars.length,
                mainCanvasOk: (() => {
                    const c = document.getElementById('canvas') as HTMLCanvasElement | null;
                    return !!c && c.width > 0 && c.height > 0;
                })(),
                glCanvasOk: !!glCanvas && glCanvas.width > 0 && glCanvas.height > 0,
            };
        });

        await page.screenshot({ path: 'test-results/symbol_editor-02-metrics.png', scale: 'css' });

        expect(metrics.registryTotal, 'registry should be populated').toBeGreaterThan(10);
        expect(metrics.toolbarCount, 'at least one toolbar should be visible').toBeGreaterThanOrEqual(1);
        expect(metrics.mainCanvasOk, 'main canvas has nonzero dimensions').toBe(true);
        expect(metrics.glCanvasOk, 'GL canvas has nonzero dimensions').toBe(true);
        expect(hasAbort(testLogger)).toBe(false);
    });
});