system-testing 1.0.0 → 1.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "system-testing",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "description": "System testing with Selenium and browsers.",
   "keywords": [
     "system",
@@ -24,6 +24,7 @@
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "dependencies": {
+    "awaitery": "^1.0.1",
     "diggerize": "^1.0.9",
     "htmlfy": "^0.8.1",
     "mime": "^4.0.7",

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

@@ -124,6 +124,10 @@ export default class SystemTestBrowserHelper {
     if (data.type == "initialize") {
       this.events.emit("initialize")
 
+      if (this._onInitializeCallback) {
+        await this._onInitializeCallback()
+      }
+
       return {result: "initialized"}
     } else if (data.type == "visit") {
       this.events.emit("navigate", {path: data.path})
@@ -132,6 +136,10 @@ export default class SystemTestBrowserHelper {
     }
   }
 
+  onInitialize(callback) {
+    this._onInitializeCallback = callback
+  }
+
   overrideConsoleLog() {
     if (this.originalConsoleError || this.originalConsoleLog) {
       throw new Error("Console methods has already been overridden!")

package/src/system-test-http-server.js

@@ -10,7 +10,7 @@ export default class SystemTestHttpServer {
 
   onHttpServerRequest = async (request, response) => {
     const parsedUrl = url.parse(request.url)
-    let filePath = `${this.basePath}/dist${parsedUrl.pathname}`
+    let filePath = `${process.cwd()}/dist${parsedUrl.pathname}`
 
     if (filePath.endsWith("/")) {
       filePath += "index.html"
@@ -26,11 +26,11 @@ export default class SystemTestHttpServer {
     }
 
     if (!fileExists) {
-      filePath = `${this.basePath}/dist/index.html`
+      filePath = `${process.cwd()}/dist/index.html`
     }
 
     const fileContent = await fs.readFile(filePath)
-    const mimeType = mime.lookup(filePath)
+    const mimeType = mime.getType(filePath)
 
     response.statusCode = 200
     response.setHeader("Content-Type", mimeType)

package/src/system-test.js

@@ -1,12 +1,13 @@
 import {Builder, By} from "selenium-webdriver"
-import chrome from "selenium-webdriver/chrome"
+import chrome from "selenium-webdriver/chrome.js"
 import {digg} from "diggerize"
 import fs from "node:fs/promises"
-import logging from "selenium-webdriver/lib/logging"
+import logging from "selenium-webdriver/lib/logging.js"
 import moment from "moment"
 import {prettify} from "htmlfy"
-import SystemTestCommunicator from "./system-test-communicator"
-import SystemTestHttpServer from "./system-test-http-server"
+import SystemTestCommunicator from "./system-test-communicator.js"
+import SystemTestHttpServer from "./system-test-http-server.js"
+import {wait} from "awaitery"
 import {WebSocketServer} from "ws"
 
 class ElementNotFoundError extends Error { }
@@ -37,7 +38,7 @@ export default class SystemTest {
   }
 
   constructor() {
-    this.communicator = new SystemTestCommunicator({onCommand: this.onCommand})
+    this.communicator = new SystemTestCommunicator({onCommand: this.onCommandReceived})
     this._responses = {}
     this._sendCount = 0
   }
@@ -185,10 +186,19 @@ export default class SystemTest {
     // Web socket server to communicate with browser
     await this.startWebSocketServer()
 
+    // await wait(360000)
+
     // Visit the root page and wait for Expo to be loaded and the app to appear
     await this.driverVisit("/?systemTest=true")
-    await this.find("body > #root")
-    await this.find("[data-component='flash-notifications-container']", {visible: null})
+
+    try {
+      await this.find("body > #root")
+      await this.find("[data-testid='systemTestingComponent']", {visible: null})
+    } catch (error) {
+      await systemTest.takeScreenshot()
+
+      throw error
+    }
 
     // Wait for client to connect
     await this.waitForClientWebSocket()
@@ -229,7 +239,11 @@ export default class SystemTest {
     this.wss.on("close", this.onWebSocketClose)
   }
 
-  onCommand = async ({data}) => {
+  onCommand(callback) {
+    this._onCommandCallback = callback
+  }
+
+  onCommandReceived = async ({data}) => {
     const type = data.type
     let result
 
@@ -248,10 +262,8 @@ export default class SystemTest {
       console.log("Browser log", ...data.value)
     } else if (type == "error" || data.type == "unhandledrejection") {
       this.handleError(data)
-    } else if (type == "query") {
-      await Configuration.current().getDatabasePool().withConnection(async (db) => {
-        result = await db.query(data.sql)
-      })
+    } else if (this._onCommandCallback) {
+      result = await this._onCommandCallback({data, type})
     } else {
       console.error(`onWebSocketClientMessage unknown data (type ${type})`, data)
     }
@@ -283,17 +295,15 @@ export default class SystemTest {
       return
     }
 
-    setTimeout(() => { // eslint-disable-line no-undef
-      const error = new Error(`Browser error: ${data.message}`)
+    const error = new Error(`Browser error: ${data.message}`)
 
-      if (data.trace) {
-        const errorTrace = error.trace
+    if (data.trace) {
+      const errorTrace = error.trace
 
-        error.trace = `${data.trace}${errorTrace}`
-      }
+      error.trace = `${data.trace}${errorTrace}`
+    }
 
-      throw error
-    }, 0)
+    console.error(error)
   }
 
   async stop() {
@@ -309,8 +319,7 @@ export default class SystemTest {
   }
 
   async takeScreenshot() {
-    const basePath = await fs.realpath(`${__dirname}/../..`) // eslint-disable-line no-undef
-    const path = `${basePath}/tmp/screenshots`
+    const path = `${process.cwd()}/tmp/screenshots`
 
     await fs.mkdir(path, {recursive: true})
 

package/src/use-system-test.js

@@ -0,0 +1,65 @@
+import qs from "qs"
+import SystemTestBrowserHelper from "./system-test-browser-helper"
+import {useCallback, useEffect, useMemo, useState} from "react"
+import useEventEmitter from "@kaspernj/api-maker/build/use-event-emitter.js"
+import {useRouter} from "expo-router"
+
+export default function useSystemTest({onInitialize, ...restArgs} = {}) {
+  const router = useRouter()
+  const shared = useMemo(() => ({}), [])
+  const [enabled, setEnabled] = useState(undefined)
+  const [systemTestBrowserHelper, setSystemTestBrowserHelper] = useState()
+
+  const calculateEnabled = useCallback(() => {
+    const initialUrl = globalThis.location?.href
+    let enabled = false
+
+    if (initialUrl) {
+      const queryString = initialUrl.substring(initialUrl.indexOf("?") + 1, initialUrl.length)
+      const queryParams = qs.parse(queryString)
+
+      if (queryParams.systemTest == "true") {
+        if (!shared.systemTestBrowserHelper) {
+          console.log("Spawn SystemTestBrowserHelper")
+
+          shared.systemTestBrowserHelper = new SystemTestBrowserHelper()
+          shared.systemTestBrowserHelper.enableOnBrowser()
+
+          setSystemTestBrowserHelper(shared.systemTestBrowserHelper)
+        }
+
+        enabled = true
+      }
+    }
+
+    shared.enabled = enabled
+    setEnabled(enabled)
+  }, [])
+
+  const result = useMemo(() => ({
+    enabled,
+    systemTestBrowserHelper: systemTestBrowserHelper
+  }), [enabled, systemTestBrowserHelper])
+
+  const onSystemTestBrowserHelperNavigate = useCallback(({path}) => {
+    if (shared.enabled) {
+      router.navigate(path)
+    }
+  }, [])
+
+  useEffect(() => {
+    calculateEnabled()
+  }, [])
+
+  useEventEmitter(shared.systemTestBrowserHelper?.getEvents(), "navigate", onSystemTestBrowserHelperNavigate)
+
+  useMemo(() => {
+    shared.systemTestBrowserHelper?.onInitialize(onInitialize)
+  }, [onInitialize, shared.systemTestBrowserHelper])
+
+  const restArgsKeys = Object.keys(restArgs)
+
+  if (restArgsKeys.length > 0) throw new Error(`Unknown arguments given to useSystemTest: ${restArgsKeys.join(", ")}`)
+
+  return result
+}