system-testing 1.0.19 → 1.0.21

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "system-testing",
-  "version": "1.0.19",
+  "version": "1.0.21",
   "description": "System testing with Selenium and browsers.",
   "keywords": [
     "system",
@@ -29,6 +29,7 @@
     "htmlfy": "^1.0.0",
     "mime": "^4.0.7",
     "moment": "^2.30.1",
+    "scoundrel-remote-eval": "^1.0.6",
     "ws": "^8.18.3"
   },
   "peerDependencies": {

package/src/system-test-browser-helper.js

@@ -1,3 +1,5 @@
+import Client from "scoundrel-remote-eval/src/client/index.js"
+import ClientWebSocket from "scoundrel-remote-eval/src/client/connections/web-socket/index.js"
 import {digg} from "diggerize"
 import EventEmitter from "events"
 
@@ -20,6 +22,38 @@ export default class SystemTestBrowserHelper {
     this.events = new EventEmitter()
 
     shared.systemTestBrowserHelper = this
+
+    this.startScoundrel()
+  }
+
+  async startScoundrel() {
+    this.scoundrelWs = new WebSocket("http://localhost:8090")
+    this.scoundrelClientWebSocket = new ClientWebSocket(this.scoundrelWs)
+
+    await this.scoundrelClientWebSocket.waitForOpened()
+
+    this.scoundrelClient = new Client(this.scoundrelClientWebSocket)
+    this.events.emit("scoundrelStarted")
+  }
+
+  waitForScoundrelStarted() {
+    return new Promise((resolve) => {
+      if (this.scoundrelClient) {
+        resolve()
+      } else {
+        this.events.once("scoundrelStarted", () => {
+          resolve()
+        })
+      }
+    })
+  }
+
+  getScoundrel() {
+    if (!this.scoundrelClient) {
+      throw new Error("Scoundrel client is not started yet")
+    }
+
+    return this.scoundrelClient
   }
 
   connectOnError() {
@@ -83,8 +117,8 @@ export default class SystemTestBrowserHelper {
     this.overrideConsoleLog()
   }
 
-  getEnabled = () => this._enabled
-  getEvents = () => this.events
+  getEnabled() { return this._enabled }
+  getEvents() { return this.events }
 
   fakeConsoleError = (...args) => {
     this.communicator.sendCommand({type: "console.error", value: this.consoleLogMessage(args)})

package/src/system-test-communicator.js

@@ -63,6 +63,12 @@ export default class SystemTestCommunicator {
     }
   }
 
+  /**
+   * Sends a command and returns a promise that resolves with the response.
+   *
+   * @param {Object} data - The command data to send.
+   * @returns {Promise} A promise that resolves with the response data.
+   */
   sendCommand(data) {
     return new Promise((resolve, error) => {
       const id = this._sendQueueCount

package/src/system-test.js

@@ -5,9 +5,11 @@ import fs from "node:fs/promises"
 import logging from "selenium-webdriver/lib/logging.js"
 import moment from "moment"
 import {prettify} from "htmlfy"
+import Server from "scoundrel-remote-eval/src/server/index.js"
+import ServerWebSocket from "scoundrel-remote-eval/src/server/connections/web-socket/index.js"
 import SystemTestCommunicator from "./system-test-communicator.js"
 import SystemTestHttpServer from "./system-test-http-server.js"
-import {waitFor} from "awaitery"
+import {wait, waitFor} from "awaitery"
 import {WebSocketServer} from "ws"
 
 class ElementNotFoundError extends Error { }
@@ -62,11 +64,24 @@ export default class SystemTest {
       throw new Error(`Unknown arguments: ${restArgsKeys.join(", ")}`)
     }
 
-    this.communicator = new SystemTestCommunicator({onCommand: this.onCommandReceived})
     this._host = host
     this._port = port
     this._responses = {}
     this._sendCount = 0
+    this.startScoundrel()
+    this.communicator = new SystemTestCommunicator({onCommand: this.onCommandReceived})
+  }
+
+  /** Starts Scoundrel server which the browser connects to for remote evaluation in the browser */
+  startScoundrel() {
+    this.wss = new WebSocketServer({port: 8090})
+    this.serverWebSocket = new ServerWebSocket(this.wss)
+    this.server = new Server(this.serverWebSocket)
+  }
+
+  stopScoundrel() {
+    this.server?.close()
+    this.wss?.close()
   }
 
   /**
@@ -104,6 +119,10 @@ export default class SystemTest {
    * @param {import("selenium-webdriver").WebElement} element
    **/
   async click(element) {
+    if (typeof element == "string") {
+      element = await this.find(element)
+    }
+
     const actions = this.driver.actions({async: true})
 
     await actions.move({origin: element}).click().perform()
@@ -187,6 +206,10 @@ export default class SystemTest {
     return browserLogs
   }
 
+  async getCurrentUrl() {
+    return await this.driver.getCurrentUrl()
+  }
+
   /**
    * Interacts with an element by calling a method on it with the given arguments.
    * Retrying on ElementNotInteractableError.
@@ -221,6 +244,8 @@ export default class SystemTest {
           // Retry finding the element and interacting with it
           if (tries >= 3) {
             throw new Error(`${element.constructor.name} ${methodName} failed after ${tries} tries - ${error.constructor.name}: ${error.message}`)
+          } else {
+            await wait(100)
           }
         } else {
           // Re-throw with un-corrupted stack trace
@@ -484,6 +509,7 @@ export default class SystemTest {
    * Stops the system test
    */
   async stop() {
+    this.stopScoundrel()
     this.systemTestHttpServer?.close()
     this.wss?.close()
     await this.driver.quit()
@@ -521,6 +547,7 @@ export default class SystemTest {
     await fs.writeFile(logsPath, logsText.join("\n"))
     await fs.writeFile(screenshotPath, imageContent, "base64")
 
+    console.log("Current URL:", await this.getCurrentUrl())
     console.log("Logs:", logsPath)
     console.log("Screenshot:", screenshotPath)
     console.log("HTML:", htmlPath)