tauri-plugin-wdio-webdriver

An embedded W3C WebDriver server for Tauri applications, providing the embedded driver provider for @wdio/tauri-service. This plugin embeds a WebDriver HTTP server directly inside your Tauri app, eliminating the need for external drivers like tauri-driver or CrabNebula.

This is a fork of Choochmeque/tauri-plugin-webdriver with changes for WebdriverIO compatibility.

When to Use This Plugin

This plugin is required when using the 'embedded' driver provider with @wdio/tauri-service:

• macOS — auto-detected, no configuration needed
• Windows/Linux — set driverProvider: 'embedded' or TAURI_WEBDRIVER_PORT env var

It is not needed if you use the 'official' or 'crabnebula' driver providers.

Features

• Full W3C WebDriver compliance — 47 endpoints implementing the W3C WebDriver specification
• Native platform integration — Uses native WebView APIs (WKWebView, WebView2, WebKitGTK)
• Zero configuration — Add the plugin, and @wdio/tauri-service handles the rest
• No external drivers — No need to install tauri-driver, msedgedriver, or webkit2gtk-driver

Supported Platforms

Installation

Warning: This plugin exposes automation capabilities via HTTP. Never include it in production builds.

Add to your Cargo.toml as a dev/test-only dependency:

[target.'cfg(debug_assertions)'.dependencies]
tauri-plugin-wdio-webdriver = "1"

Or use a feature flag for more control:

[features]
webdriver = ["tauri-plugin-wdio-webdriver"]

[dependencies]
tauri-plugin-wdio-webdriver = { version = "1", optional = true }

Usage with @wdio/tauri-service

1. Register the plugin

Use conditional compilation to exclude from release builds:

fn main() {
    let builder = tauri::Builder::default();

    #[cfg(debug_assertions)]
    let builder = builder.plugin(tauri_plugin_wdio_webdriver::init());

    builder
        .run(tauri::generate_context!())
        .expect("error while running tauri application");
}

2. Configure WebdriverIO

// wdio.conf.ts
export const config = {
  services: [['@wdio/tauri-service', {
    driverProvider: 'embedded',  // Auto-detected on macOS
  }]],

  capabilities: [{
    browserName: 'tauri',
    'tauri:options': {
      application: './src-tauri/target/release/my-app',
    },
  }],
};

The service spawns your Tauri app with TAURI_WEBDRIVER_PORT set, the plugin starts the WebDriver server on that port, and WebdriverIO connects directly — no external driver process needed.

3. Add permissions

Add to your src-tauri/capabilities/default.json:

{
  "permissions": [
    "wdio-webdriver:default"
  ]
}

Standalone Usage

The plugin also works with any W3C WebDriver client independently of @wdio/tauri-service:

# Start your app with the WebDriver port configured
TAURI_WEBDRIVER_PORT=4445 cargo tauri dev

Then connect with any client:

// WebdriverIO
const browser = await remote({
    hostname: '127.0.0.1',
    port: 4445,
    capabilities: {}
});

# Selenium
driver = webdriver.Remote(
    command_executor="http://127.0.0.1:4445",
    options=webdriver.ChromeOptions()
)

Configuration

The WebDriver server runs on port 4445 by default, bound to 127.0.0.1.

Custom Port

1. Environment variable (used by @wdio/tauri-service automatically):

TAURI_WEBDRIVER_PORT=9515 cargo tauri dev

2. Programmatically:

#[cfg(debug_assertions)]
let builder = builder.plugin(tauri_plugin_wdio_webdriver::init_with_port(9515));

Port resolution order:

1. init_with_port(port) — uses the specified port (ignores env var)
2. init() — checks TAURI_WEBDRIVER_PORT env var, falls back to 4445

W3C WebDriver Endpoints

Session Management

Timeouts

Navigation

Elements

Shadow DOM

Windows

Frames

Scripts

Cookies

Alerts

Actions

Document

Locator Strategies

See Also

• Plugin Setup Guide — Full setup instructions including this plugin
• Platform Support — Per-platform details
• Upstream repository — Original project

License

MIT