Tauri WebDriver API

The Tauri plugin serves a subset of W3C WebDriver over HTTP from inside your app. BaseCase, sbrs and any other WebDriver client speak it for you; these pages document each route as the plugin’s code answers it, with raw HTTP requests you can send with cURL.

Base URL#

http://127.0.0.1:{port}/{token}/

Every path in this reference follows http://127.0.0.1:4445/{token}; a session command follows /session/{sessionId}. When the endpoint starts, the app prints the whole URL on stderr:

tauri-plugin-sbrs-automation: WebDriver at http://127.0.0.1:4445/secret/

The query string is ignored, and so are empty path segments (a doubled or a trailing slash).

Authentication#

There is no credential header. The endpoint is guarded instead:

• it is on in debug builds only, unless SBRS_AUTOMATION turns it on (or off);
• it listens on 127.0.0.1 only;
• every path must start with the token;
• a request with an Origin header is refused.

Requests#

• The body is read as JSON whatever its Content-Type; an empty body counts as {}. A body that is not JSON answers 400 invalid argument (the body is not JSON: ...), on any route. Bodies are cut at 16 MiB.
• The server answers one request at a time, on one thread: a long script or a navigation that waits for its page holds up the requests behind it.
• Most commands run as an operation of the page script (bridge.js) in the app’s window, which has 30 seconds to answer (500 timeout, the page did not answer ... in time). Scripts get the session’s script timeout instead. The window commands and screenshots ask the native window, not the page.

Replies#

Every reply is JSON, with Content-Type: application/json; charset=utf-8. A command that succeeds answers 200 and its result under value (null for commands that return nothing). A command that fails answers the HTTP status of its W3C error code and an error object under value:

Element references#

An element travels as the W3C web element reference: an object with one key, element-6066-11e4-a52e-4f735466cecf, whose value is the element’s id.

{ "element-6066-11e4-a52e-4f735466cecf": "e1-4fzyo82m" }

The page script makes the ids (e, a counter, -, up to eight random characters) and keeps them for as long as the document lives: the same element always gets the same id. An element removed from the page answers 404 stale element reference. Once the window loads another document, the old ids answer 404 no such element (no element ... in this page).

Errors#

The status is the one the W3C specification gives each code. The codes the plugin produces, and when:

Commands never fail with unexpected alert open: dialogs are answered when they open (see User prompts).

Not served#

Any other route answers 404 unknown command, {METHOD} {path} is not supported: among them cookies, shadow roots, and opening or closing windows. Cookies are left out on purpose: on macOS the app’s page is tauri://localhost, where WKWebView keeps no cookies at all (document.cookie reads back empty after a write).

Badges#

Every command was written against the W3C specification and is checked by the plugin’s unit tests. On the pages that follow, Verified on macOS marks a command driven in a real app (the tauri-profile-manager example, macOS, Tauri 3.0.0-alpha.4), and Not run on a real app yet one that only the unit tests check. Nothing has been run on Windows or Linux yet.

Command groups#