tauri-plugin-debug-tools 0.1.0

package/examples/src-tauri/Cargo.toml

@@ -0,0 +1,25 @@
+[package]
+name = "examples-demo-app"
+version = "0.1.0"
+description = "A Tauri App"
+authors = ["you"]
+edition = "2021"
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[lib]
+# The `_lib` suffix may seem redundant but it is necessary
+# to make the lib name unique and wouldn't conflict with the bin name.
+# This seems to be only an issue on Windows, see https://github.com/rust-lang/cargo/issues/8519
+name = "examples_demo_app_lib"
+crate-type = ["staticlib", "cdylib", "rlib"]
+
+[build-dependencies]
+tauri-build = { version = "2", features = [] }
+
+[dependencies]
+tauri = { version = "2", features = [] }
+tauri-plugin-debug-tools = { path = "../.." }
+tauri-plugin-opener = "2"
+serde = { version = "1", features = ["derive"] }
+serde_json = "1"

package/examples/src-tauri/build.rs

@@ -0,0 +1,3 @@
+fn main() {
+    tauri_build::build()
+}

package/examples/src-tauri/capabilities/default.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "../gen/schemas/desktop-schema.json",
+  "identifier": "default",
+  "description": "Capability for the main window",
+  "windows": ["main"],
+  "permissions": ["core:default", "debug-tools:default", "opener:default"]
+}

package/examples/src-tauri/src/lib.rs

@@ -0,0 +1,15 @@
+// Learn more about Tauri commands at https://tauri.app/develop/calling-rust/
+#[tauri::command]
+fn greet(name: &str) -> String {
+    format!("Hello, {}! You've been greeted from Rust!", name)
+}
+
+#[cfg_attr(mobile, tauri::mobile_entry_point)]
+pub fn run() {
+    tauri::Builder::default()
+        .plugin(tauri_plugin_debug_tools::init())
+        .plugin(tauri_plugin_opener::init())
+        .invoke_handler(tauri::generate_handler![greet])
+        .run(tauri::generate_context!())
+        .expect("error while running tauri application");
+}

package/examples/src-tauri/src/main.rs

@@ -0,0 +1,6 @@
+// Prevents additional console window on Windows in release, DO NOT REMOVE!!
+#![cfg_attr(not(debug_assertions), windows_subsystem = "windows")]
+
+fn main() {
+    examples_demo_app_lib::run()
+}

package/examples/src-tauri/tauri.conf.json

@@ -0,0 +1,33 @@
+{
+  "$schema": "https://schema.tauri.app/config/2",
+  "productName": "examples-demo-app",
+  "version": "0.1.0",
+  "identifier": "com.komakisadao.examples-demo-app",
+  "build": {
+    "frontendDist": "../src"
+  },
+  "app": {
+    "withGlobalTauri": true,
+    "windows": [
+      {
+        "title": "examples-demo-app",
+        "width": 800,
+        "height": 600
+      }
+    ],
+    "security": {
+      "csp": null
+    }
+  },
+  "bundle": {
+    "active": true,
+    "targets": "all",
+    "icon": [
+      "icons/32x32.png",
+      "icons/128x128.png",
+      "icons/128x128@2x.png",
+      "icons/icon.icns",
+      "icons/icon.ico"
+    ]
+  }
+}

package/examples/tests/e2e.mac.test.ts

@@ -0,0 +1,203 @@
+import { spawn } from "node:child_process";
+import { existsSync } from "node:fs";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+
+import { Builder, By } from "selenium-webdriver";
+import { describe, it } from "vitest";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const projectRoot = path.resolve(__dirname, "..");
+const appName = "examples-demo-app";
+const appBundlePath = path.join(
+  projectRoot,
+  "src-tauri",
+  "target",
+  "debug",
+  "bundle",
+  "macos",
+  `${appName}.app`,
+);
+const appBundleId =
+  process.env.APP_BUNDLE_ID ?? "com.komakisadao.examples-demo-app";
+
+const isMac = process.platform === "darwin";
+const serverUrl = process.env.APPIUM_SERVER_URL ?? "http://127.0.0.1:4723";
+const dumpSourceEnabled = process.env.MAC2_DUMP_SOURCE === "1";
+
+const suite = isMac ? describe : describe.skip;
+
+suite("Tauri E2E (Appium Mac2)", () => {
+  it("launches the app and can access the window", async () => {
+    if (!existsSync(appBundlePath)) {
+      throw new Error(
+        `App bundle not found: ${appBundlePath}\n` +
+          "Run `bun run build` first.",
+      );
+    }
+
+    const driver = await new Builder()
+      .usingServer(serverUrl)
+      .forBrowser("safari")
+      .withCapabilities({
+        browserName: "safari",
+        platformName: "mac",
+        "appium:automationName": "mac2",
+        "appium:app": appBundlePath,
+        "appium:bundleId": appBundleId,
+        "appium:newCommandTimeout": 120,
+      })
+      .build();
+
+    try {
+      const queryAppState = async () => {
+        try {
+          const state = await driver.executeScript("macos: queryAppState", {
+            bundleId: appBundleId,
+          });
+          return typeof state === "number" ? state : state ? 1 : 0;
+        } catch {
+          return 0;
+        }
+      };
+
+      const openApp = () => {
+        spawn("open", ["-n", appBundlePath], { stdio: "ignore" });
+      };
+
+      const state = await queryAppState();
+      if (state === 0) {
+        openApp();
+      }
+
+      await driver.wait(async () => (await queryAppState()) > 0, 20_000);
+      await driver.executeScript("macos: activateApp", {
+        bundleId: appBundleId,
+      });
+
+      const dumpSource = async (label: string) => {
+        if (!dumpSourceEnabled) return;
+        try {
+          const source = await driver.executeScript("macos: source");
+          console.error(`[mac2] ${label} source:\n${source}`);
+        } catch (error) {
+          console.error(`[mac2] ${label} source failed`, error);
+        }
+      };
+
+      const waitForLocator = async (
+        label: string,
+        locator: By,
+        timeoutMs = 10_000,
+      ) => {
+        try {
+          return await driver.wait(async () => {
+            try {
+              return await driver.findElement(locator);
+            } catch {
+              return false;
+            }
+          }, timeoutMs);
+        } catch (error) {
+          await dumpSource(`${label} not found`);
+          throw error;
+        }
+      };
+
+      const waitForSourceIncludes = async (text: string, timeoutMs = 15_000) =>
+        await driver.wait(async () => {
+          try {
+            const source = await driver.executeScript("macos: source");
+            return typeof source === "string" && source.includes(text);
+          } catch {
+            return false;
+          }
+        }, timeoutMs);
+
+      const byA11y = (value: string) => new By("accessibility id", value);
+
+      await waitForSourceIncludes("Welcome to Tauri");
+      await waitForSourceIncludes("greet-input");
+
+      const input = await waitForLocator("input", byA11y("greet-input"));
+      if (!input) {
+        throw new Error("greet-input not found");
+      }
+      await input.click();
+      await input.sendKeys("Tauri");
+
+      const button = await waitForLocator("button", byA11y("greet-button"));
+      if (!button) {
+        throw new Error("greet-button not found");
+      }
+      await button.click();
+
+      await waitForSourceIncludes("Hello, Tauri!", 20_000);
+
+      const capture = await waitForLocator(
+        "debug-capture",
+        byA11y("debug-capture"),
+      );
+      if (!capture) {
+        throw new Error("debug-capture not found");
+      }
+      await capture.click();
+      await waitForSourceIncludes("debug-webview-output", 20_000);
+      await waitForSourceIncludes("Tauri App", 20_000);
+
+      const getLogs = await waitForLocator(
+        "debug-get-logs",
+        byA11y("debug-get-logs"),
+      );
+      if (!getLogs) {
+        throw new Error("debug-get-logs not found");
+      }
+      await getLogs.click();
+      await waitForSourceIncludes("debug-logs-output", 20_000);
+
+      const sendCommand = await waitForLocator(
+        "debug-send-command",
+        byA11y("debug-send-command"),
+      );
+      if (!sendCommand) {
+        throw new Error("debug-send-command not found");
+      }
+      await sendCommand.click();
+      await waitForSourceIncludes("debug-command-output", 20_000);
+      await waitForSourceIncludes("ping", 20_000);
+
+      const resetLogs = await waitForLocator(
+        "debug-reset-logs",
+        byA11y("debug-reset-logs"),
+      );
+      if (!resetLogs) {
+        throw new Error("debug-reset-logs not found");
+      }
+      await resetLogs.click();
+      await waitForSourceIncludes("tauri_console_logs.jsonl", 20_000);
+
+      const appendLogs = await waitForLocator(
+        "debug-append-logs",
+        byA11y("debug-append-logs"),
+      );
+      if (!appendLogs) {
+        throw new Error("debug-append-logs not found");
+      }
+      await appendLogs.click();
+      await waitForSourceIncludes("tauri_console_logs.jsonl", 20_000);
+
+      const snapshot = await waitForLocator(
+        "debug-write-snapshot",
+        byA11y("debug-write-snapshot"),
+      );
+      if (!snapshot) {
+        throw new Error("debug-write-snapshot not found");
+      }
+      await snapshot.click();
+      await waitForSourceIncludes("tauri_debug_snapshot_", 20_000);
+    } finally {
+      await driver.quit();
+    }
+  }, 120_000);
+});

package/examples/tests/e2e.test.ts

@@ -0,0 +1,131 @@
+import assert from "node:assert/strict";
+import { spawn } from "node:child_process";
+import { existsSync } from "node:fs";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+
+import { Builder, By, until, type WebDriver } from "selenium-webdriver";
+import { afterAll, beforeAll, describe, it } from "vitest";
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+const projectRoot = path.resolve(__dirname, "..");
+const appDir = path.join(projectRoot, "src-tauri");
+const appName = "examples-demo-app";
+const binaryName = process.platform === "win32" ? `${appName}.exe` : appName;
+const appPath = path.join(appDir, "target", "debug", binaryName);
+const isMac = process.platform === "darwin";
+
+const suite = isMac ? describe.skip : describe;
+
+suite("Tauri E2E (tauri-driver)", () => {
+  let driver: WebDriver;
+  let tauriDriver: ReturnType<typeof spawn> | undefined;
+
+  beforeAll(async () => {
+    if (!existsSync(appPath)) {
+      throw new Error(`App binary not found: ${appPath}`);
+    }
+
+    tauriDriver = spawn(
+      "tauri-driver",
+      ["--port", "4444", "--native-port", "4445"],
+      {
+        stdio: "inherit",
+      },
+    );
+
+    const capabilities = {
+      // Linux: requires webkitgtk runtime; Windows: uses WebView2 runtime.
+      browserName: process.platform === "linux" ? "webkitgtk" : "webview2",
+      "tauri:options": {
+        application: appPath,
+        args: [],
+      },
+    };
+
+    driver = await new Builder()
+      .usingServer("http://127.0.0.1:4444")
+      .withCapabilities(capabilities)
+      .build();
+  }, 60_000);
+
+  afterAll(async () => {
+    if (driver) {
+      await driver.quit();
+    }
+    if (tauriDriver && !tauriDriver.killed) {
+      tauriDriver.kill("SIGTERM");
+    }
+  });
+
+  it("shows greet UI", async () => {
+    await driver.wait(until.elementLocated(By.css("body")), 10_000);
+    const title = await driver.getTitle();
+    assert.equal(title, "Tauri App");
+
+    const input = await driver.findElement(By.id("greet-input"));
+    await input.clear();
+    await input.sendKeys("Tauri");
+
+    const button = await driver.findElement(By.css("button[type='submit']"));
+    await button.click();
+
+    const message = await driver.wait(
+      until.elementLocated(By.id("greet-msg")),
+      5_000,
+    );
+    await driver.wait(
+      until.elementTextContains(message, "Hello, Tauri!"),
+      5_000,
+    );
+  });
+
+  it("debug tools work", async () => {
+    const capture = await driver.findElement(By.id("debug-capture"));
+    await capture.click();
+    const webviewOutput = await driver.findElement(
+      By.id("debug-webview-output"),
+    );
+    await driver.wait(
+      until.elementTextContains(webviewOutput, "Tauri App"),
+      10_000,
+    );
+
+    const getLogs = await driver.findElement(By.id("debug-get-logs"));
+    await getLogs.click();
+    const logsOutput = await driver.findElement(By.id("debug-logs-output"));
+    await driver.wait(until.elementTextContains(logsOutput, "[]"), 10_000);
+
+    const sendCommand = await driver.findElement(By.id("debug-send-command"));
+    await sendCommand.click();
+    const commandOutput = await driver.findElement(
+      By.id("debug-command-output"),
+    );
+    await driver.wait(until.elementTextContains(commandOutput, "ping"), 10_000);
+
+    const resetLogs = await driver.findElement(By.id("debug-reset-logs"));
+    await resetLogs.click();
+    await driver.wait(
+      until.elementTextContains(logsOutput, "tauri_console_logs.jsonl"),
+      10_000,
+    );
+
+    const appendLogs = await driver.findElement(By.id("debug-append-logs"));
+    await appendLogs.click();
+    await driver.wait(
+      until.elementTextContains(logsOutput, "tauri_console_logs.jsonl"),
+      10_000,
+    );
+
+    const snapshot = await driver.findElement(By.id("debug-write-snapshot"));
+    await snapshot.click();
+    const snapshotOutput = await driver.findElement(
+      By.id("debug-snapshot-output"),
+    );
+    await driver.wait(
+      until.elementTextContains(snapshotOutput, "tauri_debug_snapshot_"),
+      10_000,
+    );
+  });
+});

package/examples/vitest.config.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from "vitest/config";
+
+export default defineConfig({
+  test: {
+    environment: "node",
+    include: ["tests/**/*.test.ts"],
+    testTimeout: 60_000,
+    hookTimeout: 60_000,
+  },
+});