system-testing 1.0.77 → 1.0.79

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -8,6 +8,34 @@ Rails inspired system testing for Expo apps.
8
8
  npm install --save-dev system-testing
9
9
  ```
10
10
 
11
+ ## Choose the right layer
12
+
13
+ This package has three main entry points:
14
+
15
+ - `SystemTest`: full app-oriented system testing with selector helpers, app bootstrapping, WebSocket communication, screenshots, logs, and Scoundrel support.
16
+ - `Browser`: lower-level driver session for opening URLs, taking screenshots, and reading HTML/logs without the rest of the system-test flow.
17
+ - `system-testing` CLI browser daemon: a long-running named browser process that can be controlled from CLI commands or WebSocket messages.
18
+ - `useSystemTest*` hooks: browser-side integration that lets your app respond to `visit` / `dismissTo` commands from `SystemTest`.
19
+
20
+ Use `SystemTest` if you are testing your app. Use `Browser` if you just want a Selenium/Appium-backed browser session.
21
+
22
+ ## Getting started
23
+
24
+ 1. Add one of the browser-side hooks to your app:
25
+ `useSystemTestExpo` for Expo Router, or `useSystemTest` / `useSystemTestReactNative` for your own navigation stack.
26
+ 2. Wrap your app in a root element with `testID="systemTestingComponent"`.
27
+ 3. Make sure your root test route renders an element with `testID="blankText"`, or change `SystemTest.rootPath`.
28
+ 4. Start tests with `SystemTest.run(...)` for app flows, or instantiate `Browser` directly for ordinary browsing/capture.
29
+
30
+ Minimal app-side requirements:
31
+
32
+ ```jsx
33
+ <View testID="systemTestingComponent" dataSet={{focussed: "true"}}>
34
+ <Text testID="blankText">Blank</Text>
35
+ {children}
36
+ </View>
37
+ ```
38
+
11
39
  ## Usage
12
40
 
13
41
  ```js
@@ -90,9 +118,147 @@ await SystemTest.run({
90
118
 
91
119
  If you already run an Appium server, provide `serverUrl` instead of `serverArgs`. By default, `findByTestID` uses the Appium `accessibility id` strategy. To use CSS instead (for web contexts), set `options.testIdStrategy` to `"css"` and optionally `options.testIdAttribute` (defaults to `"data-testid"`).
92
120
 
93
- ### Using `useSystemTest` in your Expo app
121
+ For local or CI web runs against Chrome, `npm run test:appium:web` now resolves and downloads a matching Chrome for Testing `chromedriver` binary before it starts Appium. That keeps the Appium web path reproducible even when the installed Chrome patch version changes.
122
+
123
+ ### Generic browser usage
124
+
125
+ `Browser` is the lower-level browser/session class behind `SystemTest`. Use it when you want driver-backed browsing, screenshots, logs, and HTML capture without the rest of the system-test bootstrapping.
126
+
127
+ ```js
128
+ import {Browser} from "system-testing/build/index.js"
129
+
130
+ const browser = new Browser()
131
+
132
+ browser.getDriverAdapter().setBaseUrl("https://example.com")
133
+ await browser.getDriverAdapter().start()
134
+ await browser.setTimeouts(10000)
135
+
136
+ await browser.visit("/")
137
+
138
+ const html = await browser.getHTML()
139
+ const logs = await browser.getBrowserLogs()
140
+ const screenshot = await browser.takeScreenshot()
141
+
142
+ await browser.stopDriver()
143
+ ```
144
+
145
+ If `visit()`/`dismissTo()` should drive in-app navigation through the browser-side helper instead of direct URL loads, inject a communicator when constructing `Browser`. Without one, it falls back to direct driver navigation, which makes it usable for ordinary website browsing as well.
146
+
147
+ Common `Browser` flow:
148
+
149
+ 1. Create the browser with the desired driver config.
150
+ 2. Set the base URL on the driver adapter.
151
+ 3. Start the driver and set timeouts.
152
+ 4. Call `visit()`.
153
+ 5. Read `getHTML()`, `getBrowserLogs()`, `getCurrentUrl()`, or `takeScreenshot()`.
154
+ 6. Call `stopDriver()` during teardown.
155
+
156
+ Useful browser methods:
157
+
158
+ - `visit(pathOrUrl)`: uses the helper communicator if present, otherwise loads directly through Selenium/Appium.
159
+ - `dismissTo(pathOrUrl)`: same fallback behavior as `visit()`.
160
+ - `getHTML()`: returns the current page source.
161
+ - `getBrowserLogs()`: returns collected browser logs, or Appium logcat output for Android native runs.
162
+ - `takeScreenshot()`: writes screenshot, HTML, and logs to disk and returns the artifact paths.
163
+
164
+ If you want app-level navigation instead of direct URL loads, keep `Browser` for the driver/session side and use one of the `useSystemTest*` hooks in the app so the communicator has something to talk to.
165
+
166
+ ### Browser daemon CLI
167
+
168
+ If you want an external agent to drive a reusable browser process, start the browser daemon:
169
+
170
+ ```bash
171
+ npx system-testing browser my-browser
172
+ ```
173
+
174
+ Optional arguments:
175
+
176
+ - `--port 1991`: use a fixed WebSocket port instead of an ephemeral one
177
+ - `--base-url https://example.com`: set the browser base URL so relative `visit` paths work
178
+ - `--driver selenium|appium`: choose the driver type
179
+ - `--debug`: enable browser debug logging
180
+
181
+ The process stays running until you stop it. On start it prints JSON with at least the browser `name`, `pid`, and `port`.
182
+
183
+ List running browser daemons:
184
+
185
+ ```bash
186
+ npx system-testing browser-list
187
+ ```
188
+
189
+ This prints one line per browser with the name and port. Use `--json` if you want machine-readable output.
94
190
 
95
- `useSystemTest` wires your Expo app to the system-testing runner: it listens for WebSocket commands, initializes the browser helper, and lets tests navigate or reset state. Add it near the root layout of your Expo Router app (for example in `_layout.tsx` or a top-level provider component).
191
+ Send commands from the CLI:
192
+
193
+ ```bash
194
+ npx system-testing browser-command --name my-browser --visit=https://example.com/path
195
+ npx system-testing browser-command --name my-browser --find-by-test-id saveButton
196
+ npx system-testing browser-command --name my-browser --click='[data-testid="saveButton"]'
197
+ npx system-testing browser-command --name my-browser --get-html
198
+ npx system-testing browser-command --name my-browser --get-browser-logs
199
+ npx system-testing browser-command --name my-browser --take-screenshot
200
+ ```
201
+
202
+ If only one browser daemon is running, `browser-command` can omit `--name`. Results are printed as JSON so automation tools can parse them easily.
203
+
204
+ Generic commands are also supported:
205
+
206
+ ```bash
207
+ npx system-testing browser-command \
208
+ --name my-browser \
209
+ --command=interact \
210
+ --selector='[data-testid="emailInput"]' \
211
+ --method=sendKeys \
212
+ --arg='user@example.com'
213
+ ```
214
+
215
+ The browser daemon is intended for agent-style development workflows where an AI or script needs to open the app, inspect HTML, locate elements, click controls, and read logs while validating layout or behavior changes.
216
+
217
+ ### Browser daemon WebSocket protocol
218
+
219
+ The daemon also accepts WebSocket commands on its configured port. Send JSON payloads like:
220
+
221
+ ```json
222
+ {"type":"browser-command","command":"visit","url":"https://example.com/path"}
223
+ ```
224
+
225
+ Another example:
226
+
227
+ ```json
228
+ {"type":"browser-command","command":"findByTestID","args":{"testID":"saveButton"}}
229
+ ```
230
+
231
+ The server responds with JSON:
232
+
233
+ ```json
234
+ {"ok":true,"requestId":"...","type":"browser-command-result","result":{"ok":true}}
235
+ ```
236
+
237
+ If the command fails:
238
+
239
+ ```json
240
+ {"ok":false,"requestId":"...","type":"browser-command-result","error":"..."}
241
+ ```
242
+
243
+ Supported daemon commands currently include:
244
+
245
+ - `visit`
246
+ - `dismissTo`
247
+ - `setBaseSelector`
248
+ - `getCurrentUrl`
249
+ - `getHTML`
250
+ - `getBrowserLogs`
251
+ - `takeScreenshot`
252
+ - `find`
253
+ - `findByTestID`
254
+ - `click`
255
+ - `waitForNoSelector`
256
+ - `expectNoElement`
257
+ - `interact`
258
+
259
+ ### Using `useSystemTestExpo` in your Expo app
260
+
261
+ `useSystemTestExpo` wires your Expo app to the system-testing runner: it listens for WebSocket commands, initializes the browser helper, and lets tests navigate or reset state. Add it near the root layout of your Expo Router app (for example in `_layout.tsx` or a top-level provider component).
96
262
 
97
263
  To enable system tests in native builds, set `EXPO_PUBLIC_SYSTEM_TEST=true` at build time (and optionally `EXPO_PUBLIC_SYSTEM_TEST_HOST` to reach the test runner from a device/emulator). For native Appium runs, set `SYSTEM_TEST_HOST=native` in the test environment and point Appium at your APK.
98
264
 
@@ -100,10 +266,12 @@ Minimal example:
100
266
 
101
267
  ```jsx
102
268
  import {Stack} from "expo-router"
103
- import useSystemTest from "system-testing/build/use-system-test.js"
269
+ import useSystemTestExpo from "system-testing/build/use-system-test-expo.js"
104
270
 
105
271
  export default function RootLayout() {
106
- const {enabled, systemTestBrowserHelper} = useSystemTest({
272
+ const {enabled, systemTestBrowserHelper} = useSystemTestExpo({
273
+ // Optional: inject your own helper instance instead of using the shared default
274
+ // browserHelper: mySystemTestBrowserHelper,
107
275
  onFirstInitialize: () => {
108
276
  // One-time setup the first time the helper initializes
109
277
  },
@@ -129,12 +297,51 @@ export default function RootLayout() {
129
297
 
130
298
  Notes:
131
299
  - The hook auto-connects when the page is opened with `?systemTest=true` (as the runner does).
300
+ - Pass `browserHelper` if you want to inject a prebuilt `SystemTestBrowserHelper`; otherwise the hook creates and enables a shared default instance.
132
301
  - `onFirstInitialize` runs only on the first `initialize` command; use it for one-time setup.
133
302
  - `onInitialize` is registered once when the helper is ready, but it runs on every `initialize` command (each `SystemTest.run`); use it to reset globals/session.
134
303
  - If you need scoundrel remote evaluation, wait for `systemTestBrowserHelper` and register your classes there, as shown in the commented snippet above.
135
304
  - Add a root wrapper with `testID="systemTestingComponent"` (and optionally `data-focussed="true"`) around your app so the runner has a stable element to detect and scope selectors against.
136
305
  - From your tests, use `await systemTest.getScoundrelClient()` to obtain the browser Scoundrel client for remote evaluation.
137
- - `useSystemTest` calls `useRouter()` from `expo-router`. If you are not using Expo Router, install `expo-router` or provide your own guard to avoid navigation errors.
306
+ - `useSystemTestExpo` calls `useRouter()` from `expo-router`.
307
+
308
+ ### Using `useSystemTest` or `useSystemTestReactNative` without Expo Router
309
+
310
+ `useSystemTest` is the generic runtime-agnostic hook. Provide `onNavigate` and `onDismissTo` callbacks for your own navigation stack. `useSystemTestReactNative` is a convenience wrapper around the same generic API for non-Expo React Native apps.
311
+
312
+ Use these when:
313
+
314
+ - you are not using Expo Router
315
+ - you want to inject your own navigation behavior
316
+ - you want to share the same app-side helper integration across different routing setups
317
+
318
+ ```js
319
+ import useSystemTestReactNative from "system-testing/build/use-system-test-react-native.js"
320
+
321
+ export default function App({navigation}) {
322
+ useSystemTestReactNative({
323
+ onDismissTo: ({path}) => {
324
+ navigation.reset({
325
+ index: 0,
326
+ routes: [{name: path}]
327
+ })
328
+ },
329
+ onNavigate: ({path}) => {
330
+ navigation.navigate(path)
331
+ }
332
+ })
333
+
334
+ return <Navigator />
335
+ }
336
+ ```
337
+
338
+ The generic hook options are:
339
+
340
+ - `browserHelper`: inject an existing `SystemTestBrowserHelper` instance instead of using the shared default
341
+ - `onFirstInitialize`: one-time setup callback
342
+ - `onInitialize`: callback that runs on every `initialize` command
343
+ - `onNavigate`: handler for `visit(...)`
344
+ - `onDismissTo`: handler for `dismissTo(...)`
138
345
 
139
346
  ### Root path and `blankText`
140
347
 
@@ -181,7 +388,7 @@ Use `useBaseSelector: false` only for modal or overlay content. Keep the default
181
388
  Most selector helpers accept the same options:
182
389
 
183
390
  - `timeout` (number): override how long the lookup should wait.
184
- - `visible` (boolean): require elements to be visible (`true`) or hidden (`false`).
391
+ - `visible` (boolean|null): require elements to be visible (`true`) or hidden (`false`), or disable visibility filtering with `null`.
185
392
  - `useBaseSelector` (boolean): scope the selector to the focused container.
186
393
 
187
394
  These options are supported by `find`, `findByTestID`, and `all`. `click` also accepts the same options when a selector string is used:
@@ -208,4 +415,10 @@ This tears down the browser, servers, and sockets, then starts them again so sub
208
415
 
209
416
  ## Dummy Expo app
210
417
 
211
- A ready-to-run Expo Router dummy app that uses `system-testing` lives in `spec/dummy`. Build the web bundle with `npm run export:web` and execute the sample system test with `npm run test:system` from that folder.
418
+ A ready-to-run Expo Router dummy app that uses `system-testing` lives in `spec/dummy`.
419
+
420
+ Useful commands from the package root:
421
+
422
+ - `npm run export:web`: build the dummy Expo app for web
423
+ - `SYSTEM_TEST_HOST=dist npx jasmine spec/system-test.spec.js`: run the sample system specs against the exported bundle
424
+ - `SYSTEM_TEST_HOST=dist npx jasmine spec/system-test-logging.spec.js`: run the browser-log capture spec
@@ -0,0 +1,19 @@
1
+ /** Sends browser commands to a running browser daemon. */
2
+ export default class BrowserCommandClient {
3
+ /**
4
+ * @param {object} args
5
+ * @param {string} [args.name]
6
+ * @param {number} [args.port]
7
+ */
8
+ constructor({ name, port }?: {
9
+ name?: string;
10
+ port?: number;
11
+ });
12
+ name: string;
13
+ port: number;
14
+ /**
15
+ * @param {Record<string, any>} payload
16
+ * @returns {Promise<any>}
17
+ */
18
+ send(payload: Record<string, any>): Promise<any>;
19
+ }
@@ -0,0 +1,39 @@
1
+ import BrowserRegistry from "./browser-registry.js";
2
+ import WebSocket from "ws";
3
+ /** Sends browser commands to a running browser daemon. */
4
+ export default class BrowserCommandClient {
5
+ /**
6
+ * @param {object} args
7
+ * @param {string} [args.name]
8
+ * @param {number} [args.port]
9
+ */
10
+ constructor({ name, port } = {}) {
11
+ this.name = name;
12
+ this.port = port;
13
+ }
14
+ /**
15
+ * @param {Record<string, any>} payload
16
+ * @returns {Promise<any>}
17
+ */
18
+ async send(payload) {
19
+ const resolvedPort = this.port ?? (await BrowserRegistry.resolve(this.name)).port;
20
+ const ws = new WebSocket(`ws://127.0.0.1:${resolvedPort}`);
21
+ return await new Promise((resolve, reject) => {
22
+ ws.on("open", () => {
23
+ ws.send(JSON.stringify(payload));
24
+ });
25
+ ws.on("message", (rawData) => {
26
+ const response = JSON.parse(rawData.toString());
27
+ ws.close();
28
+ if (response.ok) {
29
+ resolve(response.result);
30
+ }
31
+ else {
32
+ reject(new Error(response.error));
33
+ }
34
+ });
35
+ ws.on("error", reject);
36
+ });
37
+ }
38
+ }
39
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYnJvd3Nlci1jb21tYW5kLWNsaWVudC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9icm93c2VyLWNvbW1hbmQtY2xpZW50LmpzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUFBLE9BQU8sZUFBZSxNQUFNLHVCQUF1QixDQUFBO0FBQ25ELE9BQU8sU0FBUyxNQUFNLElBQUksQ0FBQTtBQUUxQiwwREFBMEQ7QUFDMUQsTUFBTSxDQUFDLE9BQU8sT0FBTyxvQkFBb0I7SUFDdkM7Ozs7T0FJRztJQUNILFlBQVksRUFBQyxJQUFJLEVBQUUsSUFBSSxFQUFDLEdBQUcsRUFBRTtRQUMzQixJQUFJLENBQUMsSUFBSSxHQUFHLElBQUksQ0FBQTtRQUNoQixJQUFJLENBQUMsSUFBSSxHQUFHLElBQUksQ0FBQTtJQUNsQixDQUFDO0lBRUQ7OztPQUdHO0lBQ0gsS0FBSyxDQUFDLElBQUksQ0FBQyxPQUFPO1FBQ2hCLE1BQU0sWUFBWSxHQUFHLElBQUksQ0FBQyxJQUFJLElBQUksQ0FBQyxNQUFNLGVBQWUsQ0FBQyxPQUFPLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsSUFBSSxDQUFBO1FBQ2pGLE1BQU0sRUFBRSxHQUFHLElBQUksU0FBUyxDQUFDLGtCQUFrQixZQUFZLEVBQUUsQ0FBQyxDQUFBO1FBRTFELE9BQU8sTUFBTSxJQUFJLE9BQU8sQ0FBQyxDQUFDLE9BQU8sRUFBRSxNQUFNLEVBQUUsRUFBRTtZQUMzQyxFQUFFLENBQUMsRUFBRSxDQUFDLE1BQU0sRUFBRSxHQUFHLEVBQUU7Z0JBQ2pCLEVBQUUsQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLFNBQVMsQ0FBQyxPQUFPLENBQUMsQ0FBQyxDQUFBO1lBQ2xDLENBQUMsQ0FBQyxDQUFBO1lBRUYsRUFBRSxDQUFDLEVBQUUsQ0FBQyxTQUFTLEVBQUUsQ0FBQyxPQUFPLEVBQUUsRUFBRTtnQkFDM0IsTUFBTSxRQUFRLEdBQUcsSUFBSSxDQUFDLEtBQUssQ0FBQyxPQUFPLENBQUMsUUFBUSxFQUFFLENBQUMsQ0FBQTtnQkFFL0MsRUFBRSxDQUFDLEtBQUssRUFBRSxDQUFBO2dCQUVWLElBQUksUUFBUSxDQUFDLEVBQUUsRUFBRSxDQUFDO29CQUNoQixPQUFPLENBQUMsUUFBUSxDQUFDLE1BQU0sQ0FBQyxDQUFBO2dCQUMxQixDQUFDO3FCQUFNLENBQUM7b0JBQ04sTUFBTSxDQUFDLElBQUksS0FBSyxDQUFDLFFBQVEsQ0FBQyxLQUFLLENBQUMsQ0FBQyxDQUFBO2dCQUNuQyxDQUFDO1lBQ0gsQ0FBQyxDQUFDLENBQUE7WUFFRixFQUFFLENBQUMsRUFBRSxDQUFDLE9BQU8sRUFBRSxNQUFNLENBQUMsQ0FBQTtRQUN4QixDQUFDLENBQUMsQ0FBQTtJQUNKLENBQUM7Q0FDRiIsInNvdXJjZXNDb250ZW50IjpbImltcG9ydCBCcm93c2VyUmVnaXN0cnkgZnJvbSBcIi4vYnJvd3Nlci1yZWdpc3RyeS5qc1wiXG5pbXBvcnQgV2ViU29ja2V0IGZyb20gXCJ3c1wiXG5cbi8qKiBTZW5kcyBicm93c2VyIGNvbW1hbmRzIHRvIGEgcnVubmluZyBicm93c2VyIGRhZW1vbi4gKi9cbmV4cG9ydCBkZWZhdWx0IGNsYXNzIEJyb3dzZXJDb21tYW5kQ2xpZW50IHtcbiAgLyoqXG4gICAqIEBwYXJhbSB7b2JqZWN0fSBhcmdzXG4gICAqIEBwYXJhbSB7c3RyaW5nfSBbYXJncy5uYW1lXVxuICAgKiBAcGFyYW0ge251bWJlcn0gW2FyZ3MucG9ydF1cbiAgICovXG4gIGNvbnN0cnVjdG9yKHtuYW1lLCBwb3J0fSA9IHt9KSB7XG4gICAgdGhpcy5uYW1lID0gbmFtZVxuICAgIHRoaXMucG9ydCA9IHBvcnRcbiAgfVxuXG4gIC8qKlxuICAgKiBAcGFyYW0ge1JlY29yZDxzdHJpbmcsIGFueT59IHBheWxvYWRcbiAgICogQHJldHVybnMge1Byb21pc2U8YW55Pn1cbiAgICovXG4gIGFzeW5jIHNlbmQocGF5bG9hZCkge1xuICAgIGNvbnN0IHJlc29sdmVkUG9ydCA9IHRoaXMucG9ydCA/PyAoYXdhaXQgQnJvd3NlclJlZ2lzdHJ5LnJlc29sdmUodGhpcy5uYW1lKSkucG9ydFxuICAgIGNvbnN0IHdzID0gbmV3IFdlYlNvY2tldChgd3M6Ly8xMjcuMC4wLjE6JHtyZXNvbHZlZFBvcnR9YClcblxuICAgIHJldHVybiBhd2FpdCBuZXcgUHJvbWlzZSgocmVzb2x2ZSwgcmVqZWN0KSA9PiB7XG4gICAgICB3cy5vbihcIm9wZW5cIiwgKCkgPT4ge1xuICAgICAgICB3cy5zZW5kKEpTT04uc3RyaW5naWZ5KHBheWxvYWQpKVxuICAgICAgfSlcblxuICAgICAgd3Mub24oXCJtZXNzYWdlXCIsIChyYXdEYXRhKSA9PiB7XG4gICAgICAgIGNvbnN0IHJlc3BvbnNlID0gSlNPTi5wYXJzZShyYXdEYXRhLnRvU3RyaW5nKCkpXG5cbiAgICAgICAgd3MuY2xvc2UoKVxuXG4gICAgICAgIGlmIChyZXNwb25zZS5vaykge1xuICAgICAgICAgIHJlc29sdmUocmVzcG9uc2UucmVzdWx0KVxuICAgICAgICB9IGVsc2Uge1xuICAgICAgICAgIHJlamVjdChuZXcgRXJyb3IocmVzcG9uc2UuZXJyb3IpKVxuICAgICAgICB9XG4gICAgICB9KVxuXG4gICAgICB3cy5vbihcImVycm9yXCIsIHJlamVjdClcbiAgICB9KVxuICB9XG59XG4iXX0=
@@ -0,0 +1,27 @@
1
+ /** Runs browser commands across CLI and WebSocket transports. */
2
+ export default class BrowserCommandRunner {
3
+ /**
4
+ * @param {object} args
5
+ * @param {import("./browser.js").default} args.browser
6
+ */
7
+ constructor({ browser }: {
8
+ browser: import("./browser.js").default;
9
+ });
10
+ browser: import("./browser.js").default;
11
+ /**
12
+ * @param {Record<string, any>} commandArgs
13
+ * @returns {Record<string, any>}
14
+ */
15
+ normalizeFindArgs(commandArgs: Record<string, any>): Record<string, any>;
16
+ /**
17
+ * @param {import("selenium-webdriver").WebElement} element
18
+ * @returns {Promise<Record<string, any>>}
19
+ */
20
+ serializeElement(element: import("selenium-webdriver").WebElement): Promise<Record<string, any>>;
21
+ /**
22
+ * @param {string} command
23
+ * @param {Record<string, any>} commandArgs
24
+ * @returns {Promise<any>}
25
+ */
26
+ run(command: string, commandArgs?: Record<string, any>): Promise<any>;
27
+ }
@@ -0,0 +1,144 @@
1
+ /** Runs browser commands across CLI and WebSocket transports. */
2
+ export default class BrowserCommandRunner {
3
+ /**
4
+ * @param {object} args
5
+ * @param {import("./browser.js").default} args.browser
6
+ */
7
+ constructor({ browser }) {
8
+ this.browser = browser;
9
+ }
10
+ /**
11
+ * @param {Record<string, any>} commandArgs
12
+ * @returns {Record<string, any>}
13
+ */
14
+ normalizeFindArgs(commandArgs) {
15
+ const findArgs = {};
16
+ if ("timeout" in commandArgs && commandArgs.timeout !== undefined) {
17
+ findArgs.timeout = Number(commandArgs.timeout);
18
+ }
19
+ if ("visible" in commandArgs && commandArgs.visible !== undefined) {
20
+ if (commandArgs.visible === null || commandArgs.visible === "null") {
21
+ findArgs.visible = null;
22
+ }
23
+ else if (typeof commandArgs.visible === "boolean") {
24
+ findArgs.visible = commandArgs.visible;
25
+ }
26
+ else {
27
+ findArgs.visible = commandArgs.visible === "true";
28
+ }
29
+ }
30
+ if ("useBaseSelector" in commandArgs && commandArgs.useBaseSelector !== undefined) {
31
+ if (typeof commandArgs.useBaseSelector === "boolean") {
32
+ findArgs.useBaseSelector = commandArgs.useBaseSelector;
33
+ }
34
+ else {
35
+ findArgs.useBaseSelector = commandArgs.useBaseSelector === "true";
36
+ }
37
+ }
38
+ return findArgs;
39
+ }
40
+ /**
41
+ * @param {import("selenium-webdriver").WebElement} element
42
+ * @returns {Promise<Record<string, any>>}
43
+ */
44
+ async serializeElement(element) {
45
+ const text = await element.getText();
46
+ const tagName = await element.getTagName();
47
+ const displayed = await element.isDisplayed();
48
+ return { displayed, tagName, text };
49
+ }
50
+ /**
51
+ * @param {string} command
52
+ * @param {Record<string, any>} commandArgs
53
+ * @returns {Promise<any>}
54
+ */
55
+ async run(command, commandArgs = {}) {
56
+ if (command === "visit") {
57
+ const path = commandArgs.path ?? commandArgs.url;
58
+ if (!path) {
59
+ throw new Error("visit requires path or url");
60
+ }
61
+ await this.browser.visit(path);
62
+ return { ok: true };
63
+ }
64
+ if (command === "dismissTo") {
65
+ const path = commandArgs.path ?? commandArgs.url;
66
+ if (!path) {
67
+ throw new Error("dismissTo requires path or url");
68
+ }
69
+ await this.browser.dismissTo(path);
70
+ return { ok: true };
71
+ }
72
+ if (command === "setBaseSelector") {
73
+ if (!commandArgs.selector) {
74
+ throw new Error("setBaseSelector requires selector");
75
+ }
76
+ this.browser.setBaseSelector(commandArgs.selector);
77
+ return { ok: true };
78
+ }
79
+ if (command === "getCurrentUrl") {
80
+ return { currentUrl: await this.browser.getCurrentUrl() };
81
+ }
82
+ if (command === "getHTML") {
83
+ return { html: await this.browser.getHTML() };
84
+ }
85
+ if (command === "getBrowserLogs") {
86
+ return { logs: await this.browser.getBrowserLogs() };
87
+ }
88
+ if (command === "takeScreenshot") {
89
+ return await this.browser.takeScreenshot();
90
+ }
91
+ if (command === "find") {
92
+ if (!commandArgs.selector) {
93
+ throw new Error("find requires selector");
94
+ }
95
+ const element = await this.browser.find(commandArgs.selector, this.normalizeFindArgs(commandArgs));
96
+ return { element: await this.serializeElement(element) };
97
+ }
98
+ if (command === "findByTestID") {
99
+ const testID = commandArgs.testID ?? commandArgs.testId;
100
+ if (!testID) {
101
+ throw new Error("findByTestID requires testID");
102
+ }
103
+ const element = await this.browser.findByTestID(testID, this.normalizeFindArgs(commandArgs));
104
+ return { element: await this.serializeElement(element) };
105
+ }
106
+ if (command === "click") {
107
+ const selector = commandArgs.selector;
108
+ if (!selector) {
109
+ throw new Error("click requires selector");
110
+ }
111
+ await this.browser.click(selector, this.normalizeFindArgs(commandArgs));
112
+ return { ok: true };
113
+ }
114
+ if (command === "waitForNoSelector") {
115
+ if (!commandArgs.selector) {
116
+ throw new Error("waitForNoSelector requires selector");
117
+ }
118
+ await this.browser.waitForNoSelector(commandArgs.selector, this.normalizeFindArgs(commandArgs));
119
+ return { ok: true };
120
+ }
121
+ if (command === "expectNoElement") {
122
+ if (!commandArgs.selector) {
123
+ throw new Error("expectNoElement requires selector");
124
+ }
125
+ await this.browser.expectNoElement(commandArgs.selector, this.normalizeFindArgs(commandArgs));
126
+ return { ok: true };
127
+ }
128
+ if (command === "interact") {
129
+ const selector = commandArgs.selector;
130
+ const methodName = commandArgs.methodName ?? commandArgs.method;
131
+ const methodArgs = Array.isArray(commandArgs.args) ? commandArgs.args : [];
132
+ if (!selector) {
133
+ throw new Error("interact requires selector");
134
+ }
135
+ if (!methodName) {
136
+ throw new Error("interact requires methodName");
137
+ }
138
+ const result = await this.browser.interact({ selector, ...this.normalizeFindArgs(commandArgs) }, methodName, ...methodArgs);
139
+ return { result };
140
+ }
141
+ throw new Error(`Unknown browser command: ${command}`);
142
+ }
143
+ }
144
+ //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"browser-command-runner.js","sourceRoot":"","sources":["../src/browser-command-runner.js"],"names":[],"mappings":"AAAA,iEAAiE;AACjE,MAAM,CAAC,OAAO,OAAO,oBAAoB;IACvC;;;OAGG;IACH,YAAY,EAAC,OAAO,EAAC;QACnB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;IAED;;;OAGG;IACH,iBAAiB,CAAC,WAAW;QAC3B,MAAM,QAAQ,GAAG,EAAE,CAAA;QAEnB,IAAI,SAAS,IAAI,WAAW,IAAI,WAAW,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAClE,QAAQ,CAAC,OAAO,GAAG,MAAM,CAAC,WAAW,CAAC,OAAO,CAAC,CAAA;QAChD,CAAC;QAED,IAAI,SAAS,IAAI,WAAW,IAAI,WAAW,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAClE,IAAI,WAAW,CAAC,OAAO,KAAK,IAAI,IAAI,WAAW,CAAC,OAAO,KAAK,MAAM,EAAE,CAAC;gBACnE,QAAQ,CAAC,OAAO,GAAG,IAAI,CAAA;YACzB,CAAC;iBAAM,IAAI,OAAO,WAAW,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;gBACpD,QAAQ,CAAC,OAAO,GAAG,WAAW,CAAC,OAAO,CAAA;YACxC,CAAC;iBAAM,CAAC;gBACN,QAAQ,CAAC,OAAO,GAAG,WAAW,CAAC,OAAO,KAAK,MAAM,CAAA;YACnD,CAAC;QACH,CAAC;QAED,IAAI,iBAAiB,IAAI,WAAW,IAAI,WAAW,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YAClF,IAAI,OAAO,WAAW,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;gBACrD,QAAQ,CAAC,eAAe,GAAG,WAAW,CAAC,eAAe,CAAA;YACxD,CAAC;iBAAM,CAAC;gBACN,QAAQ,CAAC,eAAe,GAAG,WAAW,CAAC,eAAe,KAAK,MAAM,CAAA;YACnE,CAAC;QACH,CAAC;QAED,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,gBAAgB,CAAC,OAAO;QAC5B,MAAM,IAAI,GAAG,MAAM,OAAO,CAAC,OAAO,EAAE,CAAA;QACpC,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,UAAU,EAAE,CAAA;QAC1C,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,WAAW,EAAE,CAAA;QAE7C,OAAO,EAAC,SAAS,EAAE,OAAO,EAAE,IAAI,EAAC,CAAA;IACnC,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,GAAG,CAAC,OAAO,EAAE,WAAW,GAAG,EAAE;QACjC,IAAI,OAAO,KAAK,OAAO,EAAE,CAAC;YACxB,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,IAAI,WAAW,CAAC,GAAG,CAAA;YAEhD,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAA;YAC/C,CAAC;YAED,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;YAC9B,OAAO,EAAC,EAAE,EAAE,IAAI,EAAC,CAAA;QACnB,CAAC;QAED,IAAI,OAAO,KAAK,WAAW,EAAE,CAAC;YAC5B,MAAM,IAAI,GAAG,WAAW,CAAC,IAAI,IAAI,WAAW,CAAC,GAAG,CAAA;YAEhD,IAAI,CAAC,IAAI,EAAE,CAAC;gBACV,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAA;YACnD,CAAC;YAED,MAAM,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;YAClC,OAAO,EAAC,EAAE,EAAE,IAAI,EAAC,CAAA;QACnB,CAAC;QAED,IAAI,OAAO,KAAK,iBAAiB,EAAE,CAAC;YAClC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC;gBAC1B,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAA;YACtD,CAAC;YAED,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,WAAW,CAAC,QAAQ,CAAC,CAAA;YAClD,OAAO,EAAC,EAAE,EAAE,IAAI,EAAC,CAAA;QACnB,CAAC;QAED,IAAI,OAAO,KAAK,eAAe,EAAE,CAAC;YAChC,OAAO,EAAC,UAAU,EAAE,MAAM,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE,EAAC,CAAA;QACzD,CAAC;QAED,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,OAAO,EAAC,IAAI,EAAE,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,EAAC,CAAA;QAC7C,CAAC;QAED,IAAI,OAAO,KAAK,gBAAgB,EAAE,CAAC;YACjC,OAAO,EAAC,IAAI,EAAE,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,EAAC,CAAA;QACpD,CAAC;QAED,IAAI,OAAO,KAAK,gBAAgB,EAAE,CAAC;YACjC,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAA;QAC5C,CAAC;QAED,IAAI,OAAO,KAAK,MAAM,EAAE,CAAC;YACvB,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC;gBAC1B,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAA;YAC3C,CAAC;YAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,CAAA;YAElG,OAAO,EAAC,OAAO,EAAE,MAAM,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAC,CAAA;QACxD,CAAC;QAED,IAAI,OAAO,KAAK,cAAc,EAAE,CAAC;YAC/B,MAAM,MAAM,GAAG,WAAW,CAAC,MAAM,IAAI,WAAW,CAAC,MAAM,CAAA;YAEvD,IAAI,CAAC,MAAM,EAAE,CAAC;gBACZ,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;YACjD,CAAC;YAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,MAAM,EAAE,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,CAAA;YAE5F,OAAO,EAAC,OAAO,EAAE,MAAM,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAC,CAAA;QACxD,CAAC;QAED,IAAI,OAAO,KAAK,OAAO,EAAE,CAAC;YACxB,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAA;YAErC,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAA;YAC5C,CAAC;YAED,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,CAAA;YACvE,OAAO,EAAC,EAAE,EAAE,IAAI,EAAC,CAAA;QACnB,CAAC;QAED,IAAI,OAAO,KAAK,mBAAmB,EAAE,CAAC;YACpC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC;gBAC1B,MAAM,IAAI,KAAK,CAAC,qCAAqC,CAAC,CAAA;YACxD,CAAC;YAED,MAAM,IAAI,CAAC,OAAO,CAAC,iBAAiB,CAAC,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,CAAA;YAC/F,OAAO,EAAC,EAAE,EAAE,IAAI,EAAC,CAAA;QACnB,CAAC;QAED,IAAI,OAAO,KAAK,iBAAiB,EAAE,CAAC;YAClC,IAAI,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC;gBAC1B,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAA;YACtD,CAAC;YAED,MAAM,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,WAAW,CAAC,QAAQ,EAAE,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,CAAA;YAC7F,OAAO,EAAC,EAAE,EAAE,IAAI,EAAC,CAAA;QACnB,CAAC;QAED,IAAI,OAAO,KAAK,UAAU,EAAE,CAAC;YAC3B,MAAM,QAAQ,GAAG,WAAW,CAAC,QAAQ,CAAA;YACrC,MAAM,UAAU,GAAG,WAAW,CAAC,UAAU,IAAI,WAAW,CAAC,MAAM,CAAA;YAC/D,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAA;YAE1E,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAA;YAC/C,CAAC;YAED,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChB,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;YACjD,CAAC;YAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAC,QAAQ,EAAE,GAAG,IAAI,CAAC,iBAAiB,CAAC,WAAW,CAAC,EAAC,EAAE,UAAU,EAAE,GAAG,UAAU,CAAC,CAAA;YAEzH,OAAO,EAAC,MAAM,EAAC,CAAA;QACjB,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,4BAA4B,OAAO,EAAE,CAAC,CAAA;IACxD,CAAC;CACF","sourcesContent":["/** Runs browser commands across CLI and WebSocket transports. */\nexport default class BrowserCommandRunner {\n  /**\n   * @param {object} args\n   * @param {import(\"./browser.js\").default} args.browser\n   */\n  constructor({browser}) {\n    this.browser = browser\n  }\n\n  /**\n   * @param {Record<string, any>} commandArgs\n   * @returns {Record<string, any>}\n   */\n  normalizeFindArgs(commandArgs) {\n    const findArgs = {}\n\n    if (\"timeout\" in commandArgs && commandArgs.timeout !== undefined) {\n      findArgs.timeout = Number(commandArgs.timeout)\n    }\n\n    if (\"visible\" in commandArgs && commandArgs.visible !== undefined) {\n      if (commandArgs.visible === null || commandArgs.visible === \"null\") {\n        findArgs.visible = null\n      } else if (typeof commandArgs.visible === \"boolean\") {\n        findArgs.visible = commandArgs.visible\n      } else {\n        findArgs.visible = commandArgs.visible === \"true\"\n      }\n    }\n\n    if (\"useBaseSelector\" in commandArgs && commandArgs.useBaseSelector !== undefined) {\n      if (typeof commandArgs.useBaseSelector === \"boolean\") {\n        findArgs.useBaseSelector = commandArgs.useBaseSelector\n      } else {\n        findArgs.useBaseSelector = commandArgs.useBaseSelector === \"true\"\n      }\n    }\n\n    return findArgs\n  }\n\n  /**\n   * @param {import(\"selenium-webdriver\").WebElement} element\n   * @returns {Promise<Record<string, any>>}\n   */\n  async serializeElement(element) {\n    const text = await element.getText()\n    const tagName = await element.getTagName()\n    const displayed = await element.isDisplayed()\n\n    return {displayed, tagName, text}\n  }\n\n  /**\n   * @param {string} command\n   * @param {Record<string, any>} commandArgs\n   * @returns {Promise<any>}\n   */\n  async run(command, commandArgs = {}) {\n    if (command === \"visit\") {\n      const path = commandArgs.path ?? commandArgs.url\n\n      if (!path) {\n        throw new Error(\"visit requires path or url\")\n      }\n\n      await this.browser.visit(path)\n      return {ok: true}\n    }\n\n    if (command === \"dismissTo\") {\n      const path = commandArgs.path ?? commandArgs.url\n\n      if (!path) {\n        throw new Error(\"dismissTo requires path or url\")\n      }\n\n      await this.browser.dismissTo(path)\n      return {ok: true}\n    }\n\n    if (command === \"setBaseSelector\") {\n      if (!commandArgs.selector) {\n        throw new Error(\"setBaseSelector requires selector\")\n      }\n\n      this.browser.setBaseSelector(commandArgs.selector)\n      return {ok: true}\n    }\n\n    if (command === \"getCurrentUrl\") {\n      return {currentUrl: await this.browser.getCurrentUrl()}\n    }\n\n    if (command === \"getHTML\") {\n      return {html: await this.browser.getHTML()}\n    }\n\n    if (command === \"getBrowserLogs\") {\n      return {logs: await this.browser.getBrowserLogs()}\n    }\n\n    if (command === \"takeScreenshot\") {\n      return await this.browser.takeScreenshot()\n    }\n\n    if (command === \"find\") {\n      if (!commandArgs.selector) {\n        throw new Error(\"find requires selector\")\n      }\n\n      const element = await this.browser.find(commandArgs.selector, this.normalizeFindArgs(commandArgs))\n\n      return {element: await this.serializeElement(element)}\n    }\n\n    if (command === \"findByTestID\") {\n      const testID = commandArgs.testID ?? commandArgs.testId\n\n      if (!testID) {\n        throw new Error(\"findByTestID requires testID\")\n      }\n\n      const element = await this.browser.findByTestID(testID, this.normalizeFindArgs(commandArgs))\n\n      return {element: await this.serializeElement(element)}\n    }\n\n    if (command === \"click\") {\n      const selector = commandArgs.selector\n\n      if (!selector) {\n        throw new Error(\"click requires selector\")\n      }\n\n      await this.browser.click(selector, this.normalizeFindArgs(commandArgs))\n      return {ok: true}\n    }\n\n    if (command === \"waitForNoSelector\") {\n      if (!commandArgs.selector) {\n        throw new Error(\"waitForNoSelector requires selector\")\n      }\n\n      await this.browser.waitForNoSelector(commandArgs.selector, this.normalizeFindArgs(commandArgs))\n      return {ok: true}\n    }\n\n    if (command === \"expectNoElement\") {\n      if (!commandArgs.selector) {\n        throw new Error(\"expectNoElement requires selector\")\n      }\n\n      await this.browser.expectNoElement(commandArgs.selector, this.normalizeFindArgs(commandArgs))\n      return {ok: true}\n    }\n\n    if (command === \"interact\") {\n      const selector = commandArgs.selector\n      const methodName = commandArgs.methodName ?? commandArgs.method\n      const methodArgs = Array.isArray(commandArgs.args) ? commandArgs.args : []\n\n      if (!selector) {\n        throw new Error(\"interact requires selector\")\n      }\n\n      if (!methodName) {\n        throw new Error(\"interact requires methodName\")\n      }\n\n      const result = await this.browser.interact({selector, ...this.normalizeFindArgs(commandArgs)}, methodName, ...methodArgs)\n\n      return {result}\n    }\n\n    throw new Error(`Unknown browser command: ${command}`)\n  }\n}\n"]}
@@ -0,0 +1,45 @@
1
+ /** Long-running browser daemon exposing browser commands over WebSocket. */
2
+ export default class BrowserProcess {
3
+ /**
4
+ * @param {object} args
5
+ * @param {string} args.name
6
+ * @param {Browser} [args.browser]
7
+ * @param {Record<string, any>} [args.browserArgs]
8
+ * @param {string} [args.baseUrl]
9
+ * @param {boolean} [args.debug]
10
+ * @param {number} [args.port]
11
+ */
12
+ constructor({ name, browser, browserArgs, baseUrl, debug, port }: {
13
+ name: string;
14
+ browser?: Browser;
15
+ browserArgs?: Record<string, any>;
16
+ baseUrl?: string;
17
+ debug?: boolean;
18
+ port?: number;
19
+ });
20
+ name: string;
21
+ browser: Browser;
22
+ baseUrl: string;
23
+ debug: boolean;
24
+ requestRunner: BrowserCommandRunner;
25
+ requestCount: number;
26
+ port: number;
27
+ /** @returns {Promise<void>} */
28
+ start(): Promise<void>;
29
+ wss: import("ws").Server<typeof import("ws").default, typeof import("node:http").IncomingMessage>;
30
+ /** @returns {Promise<void>} */
31
+ stop(): Promise<void>;
32
+ stopped: boolean;
33
+ /**
34
+ * @param {import("ws").WebSocket} ws
35
+ * @returns {void}
36
+ */
37
+ onConnection: (ws: import("ws").WebSocket) => void;
38
+ /**
39
+ * @param {Record<string, any>} payload
40
+ * @returns {Promise<any>}
41
+ */
42
+ handlePayload(payload: Record<string, any>): Promise<any>;
43
+ }
44
+ import Browser from "./browser.js";
45
+ import BrowserCommandRunner from "./browser-command-runner.js";