@gtkx/testing 0.20.0 → 1.0.0-rc.1

package/src/screen.ts

@@ -1,125 +1,32 @@
-import { existsSync, mkdirSync, writeFileSync } from "node:fs";
-import { tmpdir } from "node:os";
-import { join } from "node:path";
-import * as Gtk from "@gtkx/ffi/gtk";
-import { bindQueries } from "./bind-queries.js";
-import { prettyWidget } from "./pretty-widget.js";
-import { logRoles } from "./role-helpers.js";
-import { type ScreenshotOptions, screenshot as screenshotWidget } from "./screenshot.js";
-import type { ScreenshotResult } from "./types.js";
+import type { RenderResult, Screen } from "./bound-queries.js";
 
-const getScreenshotDir = (): string => {
-    const dir = join(tmpdir(), "gtkx-screenshots");
-    if (!existsSync(dir)) {
-        mkdirSync(dir, { recursive: true });
-    }
-    return dir;
-};
-
-const saveAndLogScreenshot = (result: ScreenshotResult): void => {
-    const dir = getScreenshotDir();
-    const filename = `${Date.now()}-screenshot.png`;
-    const filepath = join(dir, filename);
-    const buffer = Buffer.from(result.data, "base64");
-    writeFileSync(filepath, buffer);
-    console.log(`Screenshot saved: file://${filepath}`);
-};
-
-let currentRoot: Gtk.Application | null = null;
+const NO_RENDER_MESSAGE = "No render has been performed: call render() before using screen queries";
 
-/** @internal */
-export const setScreenRoot = (root: Gtk.Application | null): void => {
-    currentRoot = root;
+const throwNoRender = (): never => {
+    throw new Error(NO_RENDER_MESSAGE);
 };
 
-const getRoot = (): Gtk.Application => {
-    if (!currentRoot) {
-        throw new Error("No render has been performed: call render() before using screen queries");
-    }
-
-    return currentRoot;
-};
+const defaultScreen: RenderResult = new Proxy({} as RenderResult, {
+    get: (_target, property) => {
+        if (property === "baseElement" || property === "container") return throwNoRender();
+        return throwNoRender;
+    },
+});
 
-const boundQueries = bindQueries(getRoot);
+let activeScreen: RenderResult = defaultScreen;
 
 /**
- * Global query object for accessing rendered components.
- *
- * Provides the same query methods as render result, but automatically
- * uses the most recently rendered application as the container.
- *
- * @example
- * ```tsx
- * import { render, screen } from "@gtkx/testing";
- *
- * test("finds button", async () => {
- *   await render(<MyComponent />);
- *   const button = await screen.findByRole(Gtk.AccessibleRole.BUTTON);
- *   expect(button).toBeDefined();
- * });
- * ```
- *
- * @see {@link render} for rendering components
- * @see {@link within} for scoped queries
+ * Queries and debug utilities bound to the most recent render, scoped to the
+ * current toplevel windows. Accessing it before any render throws.
  */
-export const screen = {
-    ...boundQueries,
-    /** Print the widget tree to console for debugging */
-    debug: () => {
-        console.log(prettyWidget(getRoot()));
-    },
-    /** Log all accessible roles to console for debugging */
-    logRoles: () => {
-        logRoles(getRoot());
-    },
-    /**
-     * Capture a screenshot of the application window, saving it to a temporary file and logging the file path.
-     *
-     * @param selector - Window selector: index (number), title substring (string), or title pattern (RegExp).
-     *                   If omitted, captures the first window.
-     * @param options - Optional timeout and interval configuration for waiting on widget rendering.
-     * @returns Screenshot result containing base64-encoded PNG data
-     * @throws Error if no windows are available or no matching window is found
-     *
-     * @example
-     * ```tsx
-     * await screen.screenshot();              // First window
-     * await screen.screenshot(0);             // Window at index 0
-     * await screen.screenshot("Settings");    // Window with title containing "Settings"
-     * await screen.screenshot(/^My App/);     // Window with title matching regex
-     * ```
-     */
-    screenshot: async (selector?: number | string | RegExp, options?: ScreenshotOptions): Promise<ScreenshotResult> => {
-        const windows = Gtk.Window.listToplevels();
-
-        if (windows.length === 0) {
-            throw new Error("No windows available for screenshot");
-        }
-
-        let targetWindow: Gtk.Window | undefined;
+export const screen: Screen = new Proxy({} as Screen, {
+    get: (_target, property) => Reflect.get(activeScreen, property),
+});
 
-        if (selector === undefined) {
-            targetWindow = windows[0] as Gtk.Window;
-        } else if (typeof selector === "number") {
-            targetWindow = windows[selector] as Gtk.Window | undefined;
-            if (!targetWindow) {
-                throw new Error(`Window at index ${selector} not found`);
-            }
-        } else {
-            const isRegex = selector instanceof RegExp;
-            targetWindow = windows.find((w) => {
-                const title = (w as Gtk.Window).getTitle() ?? "";
-                return isRegex ? selector.test(title) : title.includes(selector);
-            }) as Gtk.Window | undefined;
-
-            if (!targetWindow) {
-                const pattern = isRegex ? selector.toString() : `"${selector}"`;
-                throw new Error(`No window found with title matching ${pattern}`);
-            }
-        }
+export const setScreen = (result: RenderResult): void => {
+    activeScreen = result;
+};
 
-        const result = await screenshotWidget(targetWindow, options);
-        saveAndLogScreenshot(result);
-        return result;
-    },
+export const clearScreen = (): void => {
+    activeScreen = defaultScreen;
 };

package/src/screenshot.ts

@@ -1,47 +1,47 @@
-import { createRef } from "@gtkx/ffi";
-import * as Gsk from "@gtkx/ffi/gsk";
-import * as Gtk from "@gtkx/ffi/gtk";
-import { tick } from "./timing.js";
-import type { ScreenshotResult, WaitForOptions } from "./types.js";
+import { existsSync, mkdirSync, writeFileSync } from "node:fs";
+import { tmpdir } from "node:os";
+import { join } from "node:path";
+import * as Gsk from "@gtkx/gi/gsk";
+import * as Gtk from "@gtkx/gi/gtk";
+import type { ScreenshotOptions, ScreenshotResult, WindowSelector } from "./types.js";
 import { waitFor } from "./wait-for.js";
 
 const bytesToBase64 = (bytes: number[]): string => {
     return Buffer.from(bytes).toString("base64");
 };
 
-const DEFAULT_SCREENSHOT_TIMEOUT = 100;
 const DEFAULT_SCREENSHOT_INTERVAL = 10;
 
-const captureSnapshot = (widget: Gtk.Widget): ScreenshotResult => {
-    const paintable = new Gtk.WidgetPaintable(widget);
+const describeWidgetState = (widget: Gtk.Widget): string =>
+    `realized=${widget.getRealized()} mapped=${widget.getMapped()} visible=${widget.getVisible()}`;
+
+const captureSnapshot = (widget: Gtk.Widget, scale: number): ScreenshotResult => {
+    const paintable = new Gtk.WidgetPaintable({ widget });
     const width = paintable.getIntrinsicWidth();
     const height = paintable.getIntrinsicHeight();
 
     if (width <= 0 || height <= 0) {
-        throw new Error("Widget has no size - ensure it is realized and visible");
+        throw new Error(`Widget has no size: ensure it is realized and visible (${describeWidgetState(widget)})`);
     }
 
     const snapshot = new Gtk.Snapshot();
+    snapshot.scale(scale, scale);
     paintable.snapshot(snapshot, width, height);
     const renderNode = snapshot.toNode();
 
     if (!renderNode) {
-        throw new Error("Widget produced no render content");
+        throw new Error(`Widget produced no render content (${describeWidgetState(widget)})`);
     }
 
     const display = widget.getDisplay();
-    if (!display) {
-        throw new Error("Widget has no display - ensure it is realized");
-    }
 
     const renderer = new Gsk.CairoRenderer();
     renderer.realizeForDisplay(display);
 
     try {
-        const texture = renderer.renderTexture(renderNode);
+        const texture = renderer.renderTexture(renderNode, null);
         const pngBytes = texture.saveToPngBytes();
-        const sizeRef = createRef(0);
-        const data = pngBytes.getData(sizeRef);
+        const data = pngBytes.getData();
 
         if (!data) {
             throw new Error("Failed to serialize screenshot to PNG");
@@ -50,8 +50,8 @@ const captureSnapshot = (widget: Gtk.Widget): ScreenshotResult => {
         return {
             data: bytesToBase64(data),
             mimeType: "image/png",
-            width,
-            height,
+            width: Math.round(width * scale),
+            height: Math.round(height * scale),
         };
     } finally {
         renderer.unrealize();
@@ -59,47 +59,96 @@ const captureSnapshot = (widget: Gtk.Widget): ScreenshotResult => {
 };
 
 /**
- * Options for capturing widget screenshots.
- */
-export type ScreenshotOptions = Pick<WaitForOptions, "timeout" | "interval">;
-
-/**
- * Captures a screenshot of a GTK widget as a PNG image.
+ * Captures a PNG snapshot of a widget, retrying until it has a paintable size.
  *
- * This function will retry multiple times if the widget hasn't finished
- * rendering, waiting for GTK to complete its paint cycle.
- *
- * @param widget - The widget to capture (typically a Window)
- * @param options - Optional timeout and interval configuration
- * @returns Screenshot result containing base64-encoded PNG data and dimensions
- * @throws Error if widget has no size, is not realized, or rendering fails after timeout
- *
- * @example
- * ```tsx
- * import { render, screenshot } from "@gtkx/testing";
- * import * as Gtk from "@gtkx/ffi/gtk";
- *
- * const { container } = await render(<MyApp />);
- * const window = container.getWindows()[0];
- * const result = await screenshot(window);
- * console.log(result.mimeType); // "image/png"
- * ```
+ * @param widget The widget to render to an image.
+ * @param options Optional scale, timeout, and retry interval.
+ * @returns The base64-encoded PNG data along with its mime type and dimensions.
  */
 export const screenshot = async (widget: Gtk.Widget, options?: ScreenshotOptions): Promise<ScreenshotResult> => {
-    await tick();
+    const scale = options?.scale ?? 1;
+
+    if (!Number.isFinite(scale) || scale <= 0) {
+        throw new Error(`Screenshot scale must be a positive number, got ${scale}`);
+    }
 
-    return waitFor(() => captureSnapshot(widget), {
-        timeout: options?.timeout ?? DEFAULT_SCREENSHOT_TIMEOUT,
+    return waitFor(() => captureSnapshot(widget, scale), {
+        timeout: options?.timeout,
         interval: options?.interval ?? DEFAULT_SCREENSHOT_INTERVAL,
-        onTimeout: (error) => {
-            const paintable = new Gtk.WidgetPaintable(widget);
-            const width = paintable.getIntrinsicWidth();
-            const height = paintable.getIntrinsicHeight();
-
-            if (width <= 0 || height <= 0) {
-                return new Error("Widget has no size - ensure it is realized and visible");
-            }
-            return new Error(`Widget produced no render content after waiting for paint cycle. ${error.message}`);
-        },
     });
 };
+
+const resolveWindow = (selector?: WindowSelector): Gtk.Window => {
+    const windows = Gtk.Window.listToplevels();
+
+    if (windows.length === 0) {
+        throw new Error("No windows available for screenshot");
+    }
+
+    if (selector === undefined) {
+        const [first] = windows;
+        if (!(first instanceof Gtk.Window)) {
+            throw new TypeError("First toplevel is not a Window");
+        }
+        return first;
+    }
+
+    if (typeof selector === "number") {
+        const indexed = windows[selector];
+        if (!(indexed instanceof Gtk.Window)) {
+            throw new TypeError(`Window at index ${selector} not found`);
+        }
+        return indexed;
+    }
+
+    const isRegex = selector instanceof RegExp;
+    const found = windows.find((w): w is Gtk.Window => {
+        if (!(w instanceof Gtk.Window)) return false;
+        const title = w.getTitle() ?? "";
+        return isRegex ? selector.test(title) : title.includes(selector);
+    });
+
+    if (!found) {
+        const pattern = isRegex ? selector.toString() : `"${selector}"`;
+        throw new Error(`No window found with title matching ${pattern}`);
+    }
+    return found;
+};
+
+const saveScreenshotToTempFile = (result: ScreenshotResult): string => {
+    const dir = join(tmpdir(), "gtkx-screenshots");
+    if (!existsSync(dir)) {
+        mkdirSync(dir, { recursive: true });
+    }
+    const filepath = join(dir, `${Date.now()}-screenshot.png`);
+    writeFileSync(filepath, Buffer.from(result.data, "base64"));
+    return filepath;
+};
+
+/**
+ * Prints a clickable file URL for a saved screenshot to the console.
+ *
+ * @param filepath Absolute path of the saved screenshot file.
+ */
+export const logScreenshotPath = (filepath: string): void => {
+    console.log(`Screenshot saved: file://${filepath}`);
+};
+
+/**
+ * Captures a screenshot of a toplevel window, writes it to a temporary file,
+ * logs its path, and returns the image data.
+ *
+ * @param selector Chooses the window by index, title substring, or regular
+ * expression; defaults to the first toplevel.
+ * @param options Optional scale, timeout, and retry interval.
+ * @returns The base64-encoded PNG data along with its mime type and dimensions.
+ */
+export const captureAndSaveScreenshot = async (
+    selector?: WindowSelector,
+    options?: ScreenshotOptions,
+): Promise<ScreenshotResult> => {
+    const target = resolveWindow(selector);
+    const result = await screenshot(target, options);
+    logScreenshotPath(saveScreenshotToTempFile(result));
+    return result;
+};

package/src/suggestions.ts

@@ -0,0 +1,87 @@
+import * as Gtk from "@gtkx/gi/gtk";
+import { formatRole } from "./role-helpers.js";
+import {
+    getWidgetAccessibleName,
+    getWidgetDisplayValue,
+    getWidgetLabelledByText,
+    getWidgetLabelText,
+    getWidgetName,
+    getWidgetOwnLabel,
+    getWidgetPlaceholderText,
+} from "./widget-accessible-properties.js";
+
+/** The query variant a suggestion targets. */
+export type Variant = "get" | "getAll" | "query" | "queryAll" | "find" | "findAll";
+
+/** The query family a suggestion targets. */
+export type Method = "Role" | "LabelText" | "PlaceholderText" | "Text" | "DisplayValue" | "Name";
+
+/** A suggested query for reaching a widget, including its family, variant, method name, and a `toString` that renders the full call. */
+export type Suggestion = {
+    queryName: Method;
+    /** The full query function name, such as `getByRole`. */
+    queryMethod: string;
+    variant: Variant;
+    toString: () => string;
+};
+
+const makeSuggestion = (queryName: Method, variant: Variant, argsText: string): Suggestion => {
+    const queryMethod = `${variant}By${queryName}`;
+    return {
+        queryName,
+        queryMethod,
+        variant,
+        toString: () => `${queryMethod}(${argsText})`,
+    };
+};
+
+const roleSuggestion = (widget: Gtk.Widget, variant: Variant): Suggestion | undefined => {
+    const role = widget.getAccessibleRole();
+    if (role === Gtk.AccessibleRole.NONE || role === Gtk.AccessibleRole.GENERIC) return undefined;
+
+    const roleText = `Gtk.AccessibleRole.${formatRole(role).toUpperCase()}`;
+    const name = getWidgetAccessibleName(widget);
+    if (name === null) {
+        return makeSuggestion("Role", variant, roleText);
+    }
+    return makeSuggestion("Role", variant, `${roleText}, { name: '${name}' }`);
+};
+
+const textSuggestion = (queryName: Method, variant: Variant, value: string | null): Suggestion | undefined => {
+    if (value === null) return undefined;
+    return makeSuggestion(queryName, variant, `'${value}'`);
+};
+
+/**
+ * Computes the recommended query for reaching the given widget, preferring role, then label text, placeholder text, text, display value, and name.
+ * @param widget Widget to build a suggestion for.
+ * @param variant Query variant the suggestion should use.
+ * @param method Restrict the suggestion to a specific query family instead of choosing by priority.
+ * @returns The best available suggestion, or undefined when no query applies.
+ */
+export const getSuggestedQuery = (
+    widget: Gtk.Widget,
+    variant: Variant = "get",
+    method?: Method,
+): Suggestion | undefined => {
+    const builders: Record<Method, () => Suggestion | undefined> = {
+        Role: () => roleSuggestion(widget, variant),
+        LabelText: () =>
+            textSuggestion("LabelText", variant, getWidgetOwnLabel(widget) ?? getWidgetLabelledByText(widget)),
+        PlaceholderText: () => textSuggestion("PlaceholderText", variant, getWidgetPlaceholderText(widget)),
+        Text: () => textSuggestion("Text", variant, getWidgetLabelText(widget)),
+        DisplayValue: () => textSuggestion("DisplayValue", variant, getWidgetDisplayValue(widget)),
+        Name: () => textSuggestion("Name", variant, getWidgetName(widget)),
+    };
+
+    if (method) {
+        return builders[method]();
+    }
+
+    const priority: Method[] = ["Role", "LabelText", "PlaceholderText", "Text", "DisplayValue", "Name"];
+    for (const candidate of priority) {
+        const suggestion = builders[candidate]();
+        if (suggestion) return suggestion;
+    }
+    return undefined;
+};

package/src/traversal.ts

@@ -1,16 +1,17 @@
-import * as Gtk from "@gtkx/ffi/gtk";
+import * as Gtk from "@gtkx/gi/gtk";
+
+export const TOPLEVELS: unique symbol = Symbol("gtkx.toplevels");
+
+type QueryContainer = Gtk.Widget | Gtk.EventController | Gtk.LayoutManager | Gtk.ListItem | Gtk.ListHeader;
 
 /**
- * Root element for scoping queries.
- *
- * When a `Gtk.Application` is provided, queries search across all toplevel
- * windows. When a `Gtk.Widget` is provided, queries are scoped to that
- * widget's subtree.
+ * A scope that queries and traversal can run against: a widget, an event
+ * controller, a layout manager, a list item or header, an application, or the
+ * sentinel representing all current toplevel windows.
  */
-export type Container = Gtk.Application | Gtk.Widget;
+export type Container = QueryContainer | Gtk.Application | typeof TOPLEVELS;
 
-export const isApplication = (container: Container): container is Gtk.Application =>
-    "getWindows" in container && typeof container.getWindows === "function";
+const isApplication = (container: Container): container is Gtk.Application => container instanceof Gtk.Application;
 
 const traverseWidgetTree = function* (root: Gtk.Widget): Generator<Gtk.Widget> {
     yield root;
@@ -22,25 +23,38 @@ const traverseWidgetTree = function* (root: Gtk.Widget): Generator<Gtk.Widget> {
     }
 };
 
-const traverseWindows = function* (): Generator<Gtk.Widget> {
-    const windows = Gtk.Window.listToplevels();
-    for (const window of windows) {
-        yield* traverseWidgetTree(window);
+export const descendants = function* (widget: Gtk.Widget): Generator<Gtk.Widget> {
+    const tree = traverseWidgetTree(widget);
+    tree.next();
+    yield* tree;
+};
+
+const resolveRoot = (container: QueryContainer): Gtk.Widget | null => {
+    if (container instanceof Gtk.Widget) return container;
+    if (container instanceof Gtk.EventController) return container.getWidget();
+    if (container instanceof Gtk.LayoutManager) return container.getWidget();
+    if (container instanceof Gtk.ListItem || container instanceof Gtk.ListHeader) return container.getChild();
+    return null;
+};
+
+export const roots = function* (container: Container): Generator<Gtk.Widget> {
+    if (container === TOPLEVELS || isApplication(container)) {
+        yield* Gtk.Window.listToplevels();
+        return;
     }
+    const root = resolveRoot(container);
+    if (root) yield root;
 };
 
 export const traverse = function* (container: Container): Generator<Gtk.Widget> {
-    if (isApplication(container)) {
-        yield* traverseWindows();
-    } else {
-        yield* traverseWidgetTree(container);
+    for (const root of roots(container)) {
+        yield* traverseWidgetTree(root);
     }
 };
 
 export const findAll = (container: Container, predicate: (node: Gtk.Widget) => boolean): Gtk.Widget[] => {
     const results: Gtk.Widget[] = [];
     for (const node of traverse(container)) {
-        if (node.getAccessibleRole?.() === Gtk.AccessibleRole.LABEL) continue;
         if (predicate(node)) {
             results.push(node);
         }