@gtkx/vitest 0.21.0 → 1.0.0-rc.2

package/src/resolve-executable.ts

@@ -0,0 +1,32 @@
+import { accessSync, constants } from "node:fs";
+import { delimiter, isAbsolute, join } from "node:path";
+
+const isExecutable = (path: string): boolean => {
+    try {
+        accessSync(path, constants.X_OK);
+
+        return true;
+    } catch {
+        return false;
+    }
+};
+
+const resolveExecutable = (command: string): string => {
+    if (isAbsolute(command)) {
+        return command;
+    }
+
+    const searchPaths = (process.env.PATH ?? "").split(delimiter).filter((entry) => entry.length > 0);
+
+    for (const directory of searchPaths) {
+        const candidate = join(directory, command);
+
+        if (isExecutable(candidate)) {
+            return candidate;
+        }
+    }
+
+    throw new Error(`Cannot find the "${command}" executable on PATH`);
+};
+
+export { resolveExecutable };

package/src/virtual-seat.ts

@@ -0,0 +1,214 @@
+import { connect, type Socket } from "node:net";
+
+type WireGlobal = { name: number; version: number };
+type PendingCallback = { resolve: () => void; reject: (error: Error) => void };
+
+type WireState = {
+    socket: Socket;
+    globals: Map<string, WireGlobal>;
+    pending: Map<number, PendingCallback>;
+    inbox: Buffer;
+    nextId: number;
+};
+
+const DISPLAY_ID = 1;
+const REGISTRY_ID = 2;
+const FIRST_CLIENT_ID = 3;
+const HEADER_SIZE = 8;
+const WORD_SIZE = 4;
+const OPCODE_MASK = 0xFF_FF;
+const DISPLAY_ERROR = 0;
+const DISPLAY_SYNC = 0;
+const DISPLAY_GET_REGISTRY = 1;
+const REGISTRY_GLOBAL = 0;
+const REGISTRY_BIND = 0;
+const CREATE_DEVICE = 0;
+const SEAT_INTERFACE = "wl_seat";
+const KEYBOARD_MANAGER_INTERFACE = "zwp_virtual_keyboard_manager_v1";
+const POINTER_MANAGER_INTERFACE = "zwlr_virtual_pointer_manager_v1";
+
+const align4 = (size: number): number => (size + 3) & ~3;
+
+const encodeString = (value: string): Buffer => {
+    const bytes = Buffer.from(`${value}\0`, "utf8");
+    const encoded = Buffer.alloc(WORD_SIZE + align4(bytes.length));
+    encoded.writeUInt32LE(bytes.length, 0);
+    bytes.copy(encoded, WORD_SIZE);
+
+    return encoded;
+};
+
+const encodeArgument = (argument: number | string): Buffer => {
+    if (typeof argument === "string") {
+        return encodeString(argument);
+    }
+
+    const encoded = Buffer.alloc(WORD_SIZE);
+    encoded.writeUInt32LE(argument, 0);
+
+    return encoded;
+};
+
+const sendRequest = (state: WireState, objectId: number, opcode: number, args: (number | string)[]): void => {
+    const body = Buffer.concat(args.map((argument) => encodeArgument(argument)));
+    const header = Buffer.alloc(HEADER_SIZE);
+    header.writeUInt32LE(objectId, 0);
+    header.writeUInt32LE(((body.length + HEADER_SIZE) << 16) | opcode, WORD_SIZE);
+    state.socket.write(Buffer.concat([header, body]));
+};
+
+const readString = (body: Buffer, offset: number): string => {
+    const length = body.readUInt32LE(offset);
+
+    return body.subarray(offset + WORD_SIZE, offset + WORD_SIZE + length - 1).toString("utf8");
+};
+
+const allocateId = (state: WireState): number => {
+    const id = state.nextId;
+    state.nextId += 1;
+
+    return id;
+};
+
+const storeGlobal = (state: WireState, body: Buffer): void => {
+    const name = body.readUInt32LE(0);
+    const interfaceName = readString(body, WORD_SIZE);
+    const versionOffset = WORD_SIZE + WORD_SIZE + align4(interfaceName.length + 1);
+    state.globals.set(interfaceName, { name, version: body.readUInt32LE(versionOffset) });
+};
+
+const rejectPending = (state: WireState, error: Error): void => {
+    for (const callback of state.pending.values()) {
+        callback.reject(error);
+    }
+
+    state.pending.clear();
+};
+
+const settlePending = (state: WireState, objectId: number): void => {
+    const callback = state.pending.get(objectId);
+
+    if (callback === undefined) {
+        return;
+    }
+
+    state.pending.delete(objectId);
+    callback.resolve();
+};
+
+const handleEvent = (state: WireState, objectId: number, opcode: number, body: Buffer): void => {
+    if (objectId === DISPLAY_ID && opcode === DISPLAY_ERROR) {
+        rejectPending(state, new Error(`virtual seat request rejected: ${readString(body, HEADER_SIZE)}`));
+
+        return;
+    }
+
+    if (objectId === REGISTRY_ID && opcode === REGISTRY_GLOBAL) {
+        storeGlobal(state, body);
+
+        return;
+    }
+
+    settlePending(state, objectId);
+};
+
+const consumeMessages = (state: WireState): void => {
+    while (state.inbox.length >= HEADER_SIZE) {
+        const objectId = state.inbox.readUInt32LE(0);
+        const word = state.inbox.readUInt32LE(WORD_SIZE);
+        const size = word >>> 16;
+
+        if (size < HEADER_SIZE || state.inbox.length < size) {
+            return;
+        }
+
+        handleEvent(state, objectId, word & OPCODE_MASK, state.inbox.subarray(HEADER_SIZE, size));
+        state.inbox = state.inbox.subarray(size);
+    }
+};
+
+const receive = (state: WireState, chunk: Buffer): void => {
+    state.inbox = Buffer.concat([state.inbox, chunk]);
+    consumeMessages(state);
+};
+
+const attachHandlers = (state: WireState, onOpen: () => void, onFailure: (error: Error) => void): void => {
+    state.socket.on("data", (chunk: Buffer) => {
+        receive(state, chunk);
+    });
+
+    state.socket.on("error", onFailure);
+
+    state.socket.on("close", () => {
+        onFailure(new Error("the compositor closed the virtual seat connection"));
+    });
+
+    state.socket.once("connect", onOpen);
+};
+
+const openConnection = (socketPath: string): Promise<WireState> =>
+    new Promise((resolve, reject) => {
+        const socket = connect(socketPath);
+
+        const state: WireState = {
+            socket,
+            globals: new Map(),
+            pending: new Map(),
+            inbox: Buffer.alloc(0),
+            nextId: FIRST_CLIENT_ID,
+        };
+
+        attachHandlers(
+            state,
+            () => {
+                resolve(state);
+            },
+            (error) => {
+                reject(error);
+                rejectPending(state, error);
+            },
+        );
+    });
+
+const roundtrip = (state: WireState): Promise<void> =>
+    new Promise((resolve, reject) => {
+        const callbackId = allocateId(state);
+        state.pending.set(callbackId, { resolve, reject });
+        sendRequest(state, DISPLAY_ID, DISPLAY_SYNC, [callbackId]);
+    });
+
+const bindGlobal = (state: WireState, interfaceName: string, version: number): number => {
+    const entry = state.globals.get(interfaceName);
+
+    if (entry === undefined) {
+        throw new Error(`the headless compositor does not implement ${interfaceName}`);
+    }
+
+    const id = allocateId(state);
+    sendRequest(state, REGISTRY_ID, REGISTRY_BIND, [entry.name, interfaceName, Math.min(version, entry.version), id]);
+
+    return id;
+};
+
+const createDevices = (state: WireState): void => {
+    const seat = bindGlobal(state, SEAT_INTERFACE, 1);
+    const keyboardManager = bindGlobal(state, KEYBOARD_MANAGER_INTERFACE, 1);
+    const pointerManager = bindGlobal(state, POINTER_MANAGER_INTERFACE, 1);
+    sendRequest(state, keyboardManager, CREATE_DEVICE, [seat, allocateId(state)]);
+    sendRequest(state, pointerManager, CREATE_DEVICE, [seat, allocateId(state)]);
+};
+
+const startVirtualSeat = async (socketPath: string): Promise<() => void> => {
+    const state = await openConnection(socketPath);
+    sendRequest(state, DISPLAY_ID, DISPLAY_GET_REGISTRY, [REGISTRY_ID]);
+    await roundtrip(state);
+    createDevices(state);
+    await roundtrip(state);
+    state.socket.unref();
+
+    return () => {
+        state.socket.destroy();
+    };
+};
+
+export { startVirtualSeat };

package/src/worker-preload.ts

@@ -0,0 +1,8 @@
+import { readHeadlessOptions, resolveHeadlessOptions, startHeadlessDisplay } from "./headless-display.js";
+import { setHeadlessTeardown } from "./headless-globals.js";
+
+const options = readHeadlessOptions(new URL(import.meta.url).searchParams);
+const teardown = await startHeadlessDisplay(resolveHeadlessOptions(options));
+
+process.on("exit", teardown);
+setHeadlessTeardown(teardown);

package/src/worker-setup.ts

@@ -0,0 +1,3 @@
+import { installHeadlessShutdown } from "./install-headless-shutdown.js";
+
+installHeadlessShutdown();

package/dist/plugin.d.ts

@@ -1,22 +0,0 @@
-import type { Plugin } from "vitest/config";
-/**
- * Creates the GTKX Vitest plugin for running GTK tests.
- *
- * Each worker spawns its own Xvfb instance on a PID-based display number.
- *
- * @returns Vitest plugin configuration
- *
- * @example
- * ```ts
- * // vitest.config.ts
- * import { defineConfig } from "vitest/config";
- * import gtkx from "@gtkx/vitest";
- *
- * export default defineConfig({
- *   plugins: [gtkx()],
- * });
- * ```
- */
-declare const gtkx: () => Plugin;
-export default gtkx;
-//# sourceMappingURL=plugin.d.ts.map

package/dist/plugin.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAE5C;;;;;;;;;;;;;;;;;GAiBG;AACH,QAAA,MAAM,IAAI,QAAO,MAgBhB,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/dist/plugin.js

@@ -1,36 +0,0 @@
-import { join } from "node:path";
-/**
- * Creates the GTKX Vitest plugin for running GTK tests.
- *
- * Each worker spawns its own Xvfb instance on a PID-based display number.
- *
- * @returns Vitest plugin configuration
- *
- * @example
- * ```ts
- * // vitest.config.ts
- * import { defineConfig } from "vitest/config";
- * import gtkx from "@gtkx/vitest";
- *
- * export default defineConfig({
- *   plugins: [gtkx()],
- * });
- * ```
- */
-const gtkx = () => {
-    const workerSetupPath = join(import.meta.dirname, "setup.js");
-    return {
-        name: "gtkx",
-        config(config) {
-            const setupFiles = config.test?.setupFiles ?? [];
-            return {
-                test: {
-                    setupFiles: [workerSetupPath, ...(Array.isArray(setupFiles) ? setupFiles : [setupFiles])],
-                    pool: "forks",
-                },
-            };
-        },
-    };
-};
-export default gtkx;
-//# sourceMappingURL=plugin.js.map

package/dist/plugin.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAIjC;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,IAAI,GAAG,GAAW,EAAE;IACtB,MAAM,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAE9D,OAAO;QACH,IAAI,EAAE,MAAM;QACZ,MAAM,CAAC,MAAM;YACT,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,EAAE,UAAU,IAAI,EAAE,CAAC;YAEjD,OAAO;gBACH,IAAI,EAAE;oBACF,UAAU,EAAE,CAAC,eAAe,EAAE,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;oBACzF,IAAI,EAAE,OAAO;iBAChB;aACJ,CAAC;QACN,CAAC;KACJ,CAAC;AACN,CAAC,CAAC;AAEF,eAAe,IAAI,CAAC"}

package/dist/setup.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=setup.d.ts.map

package/dist/setup.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"setup.d.ts","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":""}

package/dist/setup.js

@@ -1,44 +0,0 @@
-import { spawn } from "node:child_process";
-import { existsSync } from "node:fs";
-import { beforeAll } from "vitest";
-const display = 100 + (process.pid % 5000);
-const socketPath = `/tmp/.X11-unix/X${display}`;
-const xvfb = spawn("Xvfb", [`:${display}`, "-screen", "0", "1024x768x24"], {
-    stdio: "ignore",
-});
-xvfb.unref();
-process.env.GDK_BACKEND = "x11";
-process.env.GSK_RENDERER = "cairo";
-process.env.LIBGL_ALWAYS_SOFTWARE = "1";
-process.env.DISPLAY = `:${display}`;
-const killXvfb = () => {
-    if (xvfb.pid !== undefined) {
-        try {
-            process.kill(xvfb.pid, "SIGTERM");
-        }
-        catch { }
-    }
-};
-process.on("exit", killXvfb);
-process.on("SIGTERM", () => {
-    killXvfb();
-    process.exit(143);
-});
-process.on("SIGINT", () => {
-    killXvfb();
-    process.exit(130);
-});
-const waitForDisplay = async (timeout = 5000) => {
-    const start = Date.now();
-    while (Date.now() - start < timeout) {
-        if (existsSync(socketPath)) {
-            return;
-        }
-        await new Promise((resolve) => setTimeout(resolve, 50));
-    }
-    throw new Error(`Xvfb display :${display} did not become available within ${timeout}ms`);
-};
-beforeAll(async () => {
-    await waitForDisplay();
-});
-//# sourceMappingURL=setup.js.map

package/dist/setup.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"setup.js","sourceRoot":"","sources":["../src/setup.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AAEnC,MAAM,OAAO,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,GAAG,IAAI,CAAC,CAAC;AAC3C,MAAM,UAAU,GAAG,mBAAmB,OAAO,EAAE,CAAC;AAEhD,MAAM,IAAI,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,IAAI,OAAO,EAAE,EAAE,SAAS,EAAE,GAAG,EAAE,aAAa,CAAC,EAAE;IACvE,KAAK,EAAE,QAAQ;CAClB,CAAC,CAAC;AAEH,IAAI,CAAC,KAAK,EAAE,CAAC;AAEb,OAAO,CAAC,GAAG,CAAC,WAAW,GAAG,KAAK,CAAC;AAChC,OAAO,CAAC,GAAG,CAAC,YAAY,GAAG,OAAO,CAAC;AACnC,OAAO,CAAC,GAAG,CAAC,qBAAqB,GAAG,GAAG,CAAC;AACxC,OAAO,CAAC,GAAG,CAAC,OAAO,GAAG,IAAI,OAAO,EAAE,CAAC;AAEpC,MAAM,QAAQ,GAAG,GAAS,EAAE;IACxB,IAAI,IAAI,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;QACzB,IAAI,CAAC;YACD,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;QACtC,CAAC;QAAC,MAAM,CAAC,CAAA,CAAC;IACd,CAAC;AACL,CAAC,CAAC;AAEF,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AAE7B,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE;IACvB,QAAQ,EAAE,CAAC;IACX,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACtB,CAAC,CAAC,CAAC;AAEH,OAAO,CAAC,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE;IACtB,QAAQ,EAAE,CAAC;IACX,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACtB,CAAC,CAAC,CAAC;AAEH,MAAM,cAAc,GAAG,KAAK,EAAE,OAAO,GAAG,IAAI,EAAiB,EAAE;IAC3D,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACzB,OAAO,IAAI,CAAC,GAAG,EAAE,GAAG,KAAK,GAAG,OAAO,EAAE,CAAC;QAClC,IAAI,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;YACzB,OAAO;QACX,CAAC;QACD,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC;IAC5D,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,iBAAiB,OAAO,oCAAoC,OAAO,IAAI,CAAC,CAAC;AAC7F,CAAC,CAAC;AAEF,SAAS,CAAC,KAAK,IAAI,EAAE;IACjB,MAAM,cAAc,EAAE,CAAC;AAC3B,CAAC,CAAC,CAAC"}

package/src/plugin.ts

@@ -1,41 +0,0 @@
-import { join } from "node:path";
-
-import type { Plugin } from "vitest/config";
-
-/**
- * Creates the GTKX Vitest plugin for running GTK tests.
- *
- * Each worker spawns its own Xvfb instance on a PID-based display number.
- *
- * @returns Vitest plugin configuration
- *
- * @example
- * ```ts
- * // vitest.config.ts
- * import { defineConfig } from "vitest/config";
- * import gtkx from "@gtkx/vitest";
- *
- * export default defineConfig({
- *   plugins: [gtkx()],
- * });
- * ```
- */
-const gtkx = (): Plugin => {
-    const workerSetupPath = join(import.meta.dirname, "setup.js");
-
-    return {
-        name: "gtkx",
-        config(config) {
-            const setupFiles = config.test?.setupFiles ?? [];
-
-            return {
-                test: {
-                    setupFiles: [workerSetupPath, ...(Array.isArray(setupFiles) ? setupFiles : [setupFiles])],
-                    pool: "forks",
-                },
-            };
-        },
-    };
-};
-
-export default gtkx;

package/src/setup.ts

@@ -1,52 +0,0 @@
-import { spawn } from "node:child_process";
-import { existsSync } from "node:fs";
-import { beforeAll } from "vitest";
-
-const display = 100 + (process.pid % 5000);
-const socketPath = `/tmp/.X11-unix/X${display}`;
-
-const xvfb = spawn("Xvfb", [`:${display}`, "-screen", "0", "1024x768x24"], {
-    stdio: "ignore",
-});
-
-xvfb.unref();
-
-process.env.GDK_BACKEND = "x11";
-process.env.GSK_RENDERER = "cairo";
-process.env.LIBGL_ALWAYS_SOFTWARE = "1";
-process.env.DISPLAY = `:${display}`;
-
-const killXvfb = (): void => {
-    if (xvfb.pid !== undefined) {
-        try {
-            process.kill(xvfb.pid, "SIGTERM");
-        } catch {}
-    }
-};
-
-process.on("exit", killXvfb);
-
-process.on("SIGTERM", () => {
-    killXvfb();
-    process.exit(143);
-});
-
-process.on("SIGINT", () => {
-    killXvfb();
-    process.exit(130);
-});
-
-const waitForDisplay = async (timeout = 5000): Promise<void> => {
-    const start = Date.now();
-    while (Date.now() - start < timeout) {
-        if (existsSync(socketPath)) {
-            return;
-        }
-        await new Promise((resolve) => setTimeout(resolve, 50));
-    }
-    throw new Error(`Xvfb display :${display} did not become available within ${timeout}ms`);
-};
-
-beforeAll(async () => {
-    await waitForDisplay();
-});