@w-lfpup/jackrabbit 0.2.0 → 0.3.1

package/.github/workflows/browsers.json

@@ -0,0 +1,55 @@
+{
+	"host_and_port": "http://127.0.0.1:4000",
+	"runAsynchronusly": false,
+	"webdrivers": [
+		{
+			"title": "Firefox",
+			"command": "$GECKOWEBDRIVER/geckodriver -p 4001",
+			"timeout_ms": 30000,
+			"url": "http://localhost:4001",
+			"capabilities": {
+				"alwaysMatch": {
+					"moz:firefoxOptions": {
+						"args": ["-headless"]
+					}
+				}
+			}
+		},
+		{
+			"title": "Chrome",
+			"command": "$CHROMEWEBDRIVER/chromedriver --port=4005",
+			"timeout_ms": 30000,
+			"url": "http://localhost:4005",
+			"capabilities": {
+				"alwaysMatch": {
+					"goog:chromeOptions": {
+						"args": [
+							"--headless",
+							"--disbale-gpu",
+							"--disable-dev-shm-usage",
+							"--start-maximized"
+						]
+					}
+				}
+			}
+		},
+		{
+			"title": "Edge",
+			"command": "$EDGEWEBDRIVER/msedgedriver --port=4010",
+			"timeout_ms": 30000,
+			"url": "http://localhost:4010",
+			"capabilities": {
+				"alwaysMatch": {
+					"ms:edgeOptions": {
+						"args": [
+							"--headless",
+							"--disbale-gpu",
+							"--disable-dev-shm-usage",
+							"--start-maximized"
+						]
+					}
+				}
+			}
+		}
+	]
+}

package/.github/workflows/browsers.macos.json

@@ -0,0 +1,51 @@
+{
+	"host_and_port": "http://127.0.0.1:4000",
+	"runAsynchronusly": false,
+	"webdrivers": [
+		{
+			"command": "safaridriver -p 4001",
+			"title": "Safari",
+			"timeout_ms": 30000,
+			"url": "http://localhost:4001"
+		},
+		{
+			"command": "$GECKOWEBDRIVER/geckodriver -p 4001",
+			"title": "Firefox",
+			"timeout_ms": 30000,
+			"url": "http://127.0.0.1:4001",
+			"capabilities": {
+				"alwaysMatch": {
+					"moz:firefoxOptions": {
+						"args": ["-headless"]
+					}
+				}
+			}
+		},
+		{
+			"command": "$CHROMEWEBDRIVER/chromedriver --port=4001",
+			"title": "Chrome",
+			"timeout_ms": 30000,
+			"url": "http://localhost:4001",
+			"capabilities": {
+				"alwaysMatch": {
+					"goog:chromeOptions": {
+						"args": ["--headless"]
+					}
+				}
+			}
+		},
+		{
+			"command": "$EDGEWEBDRIVER/msedgedriver --port=4001",
+			"title": "Edge",
+			"timeout_ms": 30000,
+			"url": "http://localhost:4001",
+			"capabilities": {
+				"alwaysMatch": {
+					"ms:edgeOptions": {
+						"args": ["--headless"]
+					}
+				}
+			}
+		}
+	]
+}

package/.github/workflows/browsers.windows.json

@@ -0,0 +1,19 @@
+{
+	"host_and_port": "http://127.0.0.1:4000",
+	"runAsynchronusly": false,
+	"webdrivers": [
+		{
+			"command": "$Env:GECKOWEBDRIVER\\geckodriver.exe -p 4001",
+			"title": "Firefox",
+			"timeout_ms": 20000,
+			"url": "http://127.0.0.1:4001",
+			"capabilities": {
+				"alwaysMatch": {
+					"moz:firefoxOptions": {
+						"args": ["-headless"]
+					}
+				}
+			}
+		}
+	]
+}

package/.github/workflows/tests.yml

@@ -16,3 +16,16 @@ jobs:
         run: npm ci
       - name: Test
         run: npm run test
+      - name: Test browsers
+        run: npx jackrabbit_webdriver .github/workflows/browsers.json ./tests/dist/mod.js
+  build_and_test_macos:
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: actions/setup-node@v6
+      - name: Install
+        run: npm ci
+      - name: Test
+        run: npm run test
+      - name: Test browsers
+        run: npx jackrabbit_webdriver .github/workflows/browsers.macos.json ./tests/dist/mod.js

package/README.md

@@ -119,7 +119,9 @@ export const testModules = [
 
 ## Run Test Collections
 
-Run the following command and to log the results of a test collection.
+### NodeJS
+
+Run the following command to log the results of a test collection in nodejs.
 
 ```sh
 npx jackrabbit ./mod.tests.ts
@@ -131,6 +133,44 @@ To run multiple test collections, add more filepaths as commandline arguments:
 npx jackrabbit ./mod.tests.ts ./another_mod.tests.ts
 ```
 
+### Webdrivers
+
+Run the following command to log the results of a test collection from a browser.
+
+```sh
+npx jackrabbit_webdriver ./config.json ./mod.tests.ts
+```
+
+To run multiple test collections, add more filepaths as commandline arguments:
+
+```sh
+npx jackrabbit_webdriver ./config.json ./mod.tests.ts ./another_mod.tests.ts
+```
+
+An example `jackrabbit_webdriver` config is as follows:
+
+```JSON
+{
+	"host_and_port": "http://localhost:4000",
+	"run_asynchronously": false,
+	"webdrivers": [
+		{
+			"title": "Firefox",
+			"command": "geckodriver -p 4001",
+			"timeout_ms": 20000,
+			"url": "http://localhost:4001",
+			"capabilities": {
+				"alwaysMatch": {
+					"moz:firefoxOptions": {
+						"args": ["-headless"]
+					}
+				}
+			}
+		}
+	]
+}
+```
+
 ## License
 
 `Jackrabbit-js` is released under the BSD 3-Clause License.

package/browser/dist/logger.js

@@ -0,0 +1,43 @@
+export class Logger {
+    #fetchQueue = new FetchQueue();
+    #cancelled = false;
+    get cancelled() {
+        return this.#cancelled;
+    }
+    log(action) {
+        this.#fetchQueue.enqueue(function () {
+            return fetch(`/log/${action.type}`, {
+                body: JSON.stringify(action),
+                headers: new Headers([["Content-Type", "application/json"]]),
+                method: "POST",
+            });
+        });
+    }
+}
+class FetchQueue {
+    #inbound = [];
+    #outbound = [];
+    #inRoute;
+    enqueue(queueable) {
+        this.#inbound.push(queueable);
+        if (!this.#inRoute)
+            this.#queueAtom();
+    }
+    #queueAtom() {
+        if (!this.#outbound.length) {
+            while (this.#inbound.length) {
+                let pip = this.#inbound.pop();
+                if (pip)
+                    this.#outbound.push(pip);
+            }
+        }
+        this.#inRoute = this.#outbound.pop();
+        this.#execAtom();
+    }
+    async #execAtom() {
+        if (this.#inRoute) {
+            await this.#inRoute();
+            this.#queueAtom();
+        }
+    }
+}

package/browser/dist/mod.js

@@ -0,0 +1,25 @@
+import { Logger } from "./logger.js";
+import { run } from "./runner.js";
+let logger = new Logger();
+try {
+    let jackrabbitMap = document.querySelector("script[type=jackrabbit_config]");
+    if (null === jackrabbitMap)
+        throw new Error("Failed to query jackrabbit_config script");
+    let config = JSON.parse(jackrabbitMap.textContent);
+    logger.log({
+        type: "start_run",
+        time: performance.now(),
+        expected_collection_count: config?.test_collections?.length ?? 0,
+    });
+    await run(logger, config.test_collections, config.jackrabbit_url);
+    logger.log({
+        type: "end_run",
+        time: performance.now(),
+    });
+}
+catch (e) {
+    logger.log({
+        type: "run_error",
+        error: e?.toString() ?? "wild horses error",
+    });
+}

package/browser/dist/queue.js

@@ -0,0 +1,27 @@
+export class FetchQueue {
+    #inbound = [];
+    #outbound = [];
+    #inRoute;
+    enqueue(queueable) {
+        this.#inbound.push(queueable);
+        if (!this.#inRoute)
+            this.#queueAtom();
+    }
+    #queueAtom() {
+        if (!this.#outbound.length) {
+            while (this.#inbound.length) {
+                let pip = this.#inbound.pop();
+                if (pip)
+                    this.#outbound.push(pip);
+            }
+        }
+        this.#inRoute = this.#outbound.pop();
+        this.#execAtom();
+    }
+    async #execAtom() {
+        if (this.#inRoute) {
+            await this.#inRoute();
+            this.#queueAtom();
+        }
+    }
+}

package/browser/dist/runner.js

@@ -0,0 +1,20 @@
+import { runCollection } from "jackrabbit/core/dist/mod.js";
+export async function run(logger, files, baseUrl) {
+    for (const [collection_id, url] of files.entries()) {
+        try {
+            let filepath = URL.parse(url, baseUrl);
+            if (null === filepath)
+                throw new Error("Failed to import url: " + url);
+            let filepathStr = filepath.toString();
+            const { testModules } = await import(filepath.toString());
+            await runCollection(logger, testModules, collection_id, filepathStr);
+        }
+        catch (e) {
+            logger.log({
+                type: "collection_error",
+                collection_id,
+                error: e?.toString() ?? "wild horses error",
+            });
+        }
+    }
+}

package/{cli → browser}/package.json

@@ -1,5 +1,5 @@
 {
-	"name": "cli",
+	"name": "browser",
 	"type": "module",
 	"main": "dist/mod.js",
 	"scripts": {

package/browser/src/logger.ts

@@ -0,0 +1,57 @@
+import type {
+	LoggerAction,
+	LoggerInterface,
+} from "jackrabbit/core/dist/mod.js";
+
+interface Queueable {
+	(): Promise<unknown>;
+}
+
+export class Logger implements LoggerInterface {
+	#fetchQueue = new FetchQueue();
+	#cancelled = false;
+
+	get cancelled() {
+		return this.#cancelled;
+	}
+
+	log(action: LoggerAction) {
+		this.#fetchQueue.enqueue(function () {
+			return fetch(`/log/${action.type}`, {
+				body: JSON.stringify(action),
+				headers: new Headers([["Content-Type", "application/json"]]),
+				method: "POST",
+			});
+		});
+	}
+}
+
+class FetchQueue {
+	#inbound: Queueable[] = [];
+	#outbound: Queueable[] = [];
+	#inRoute: Queueable | undefined;
+
+	enqueue(queueable: Queueable) {
+		this.#inbound.push(queueable);
+		if (!this.#inRoute) this.#queueAtom();
+	}
+
+	#queueAtom() {
+		if (!this.#outbound.length) {
+			while (this.#inbound.length) {
+				let pip = this.#inbound.pop();
+				if (pip) this.#outbound.push(pip);
+			}
+		}
+
+		this.#inRoute = this.#outbound.pop();
+		this.#execAtom();
+	}
+
+	async #execAtom() {
+		if (this.#inRoute) {
+			await this.#inRoute();
+			this.#queueAtom();
+		}
+	}
+}

package/browser/src/mod.ts

@@ -0,0 +1,30 @@
+import { Logger } from "./logger.js";
+import { run } from "./runner.js";
+
+let logger = new Logger();
+
+try {
+	let jackrabbitMap = document.querySelector("script[type=jackrabbit_config]");
+	if (null === jackrabbitMap)
+		throw new Error("Failed to query jackrabbit_config script");
+
+	// should be it's own verification and then throw
+	let config = JSON.parse(jackrabbitMap.textContent);
+
+	logger.log({
+		type: "start_run",
+		time: performance.now(),
+		expected_collection_count: config?.test_collections?.length ?? 0,
+	});
+
+	await run(logger, config.test_collections, config.jackrabbit_url);
+	logger.log({
+		type: "end_run",
+		time: performance.now(),
+	});
+} catch (e: unknown) {
+	logger.log({
+		type: "run_error",
+		error: e?.toString() ?? "wild horses error",
+	});
+}

package/browser/src/runner.ts

@@ -0,0 +1,22 @@
+import type { Logger } from "./logger.js";
+
+import { runCollection } from "jackrabbit/core/dist/mod.js";
+
+export async function run(logger: Logger, files: string[], baseUrl: string) {
+	for (const [collection_id, url] of files.entries()) {
+		try {
+			let filepath = URL.parse(url, baseUrl);
+			if (null === filepath) throw new Error("Failed to import url: " + url);
+
+			let filepathStr = filepath.toString();
+			const { testModules } = await import(filepath.toString());
+			await runCollection(logger, testModules, collection_id, filepathStr);
+		} catch (e: unknown) {
+			logger.log({
+				type: "collection_error",
+				collection_id,
+				error: e?.toString() ?? "wild horses error",
+			});
+		}
+	}
+}

package/browser/tsconfig.json

@@ -0,0 +1,11 @@
+{
+	"extends": "../tsconfig.json",
+	"compilerOptions": {
+		"declaration": false,
+		"rootDir": "./src",
+		"outDir": "./dist",
+		"paths": {
+			"jackrabbit/core/*": ["../core/*"]
+		}
+	}
+}

package/browser/tsconfig.tsbuildinfo

@@ -0,0 +1 @@
+{"root":["./src/logger.ts","./src/mod.ts","./src/runner.ts"],"version":"5.9.3"}

package/browsers.json

@@ -0,0 +1,38 @@
+{
+	"host_and_port": "http://localhost:4000",
+	"run_asynchronously": false,
+	"webdrivers": [
+		{
+			"command": "safaridriver -p 4001",
+			"title": "Safari",
+			"timeout_ms": 20000,
+			"url": "http://localhost:4001"
+		},
+		{
+			"command": "geckodriver -p 4001",
+			"title": "Firefox",
+			"timeout_ms": 20000,
+			"url": "http://localhost:4001",
+			"capabilities": {
+				"alwaysMatch": {
+					"moz:firefoxOptions": {
+						"args": ["-headless"]
+					}
+				}
+			}
+		},
+		{
+			"command": "/Users/taylor/workspace/chromedriver-mac-arm64/chromedriver --port=4001",
+			"title": "Chrome",
+			"timeout_ms": 20000,
+			"url": "http://localhost:4001",
+			"capabilities": {
+				"alwaysMatch": {
+					"goog:chromeOptions": {
+						"args": ["--headless"]
+					}
+				}
+			}
+		}
+	]
+}

package/core/dist/jackrabbit_types.d.ts

@@ -1,56 +1,90 @@
 interface Stringable {
     toString: Object["toString"];
 }
-export type Assertions = Stringable | Stringable[] | undefined;
+export type Assertions = Stringable | Stringable[] | undefined | null;
 type SyncTest = () => Assertions;
 type AsyncTest = () => Promise<Assertions>;
 export type Test = SyncTest | AsyncTest;
-export interface Options {
+export interface TestOptions {
     runAsynchronously?: boolean;
     timeoutMs?: number;
     title?: string;
 }
 export interface TestModule {
+    options?: TestOptions;
     tests: Test[];
-    options: Options;
 }
-interface StartRun {
-    type: "start_run";
+export interface StartRun {
+    expected_collection_count: number;
     time: number;
+    type: "start_run";
 }
-interface EndRun {
-    type: "end_run";
+export interface EndRun {
     time: number;
+    type: "end_run";
 }
-interface CancelRun {
-    type: "cancel_run";
-    time: number;
+export interface RunError {
+    error: string;
+    type: "run_error";
+}
+export interface StartTestCollection {
+    collection_id: number;
+    collection_url: string;
+    expected_module_count: number;
+    type: "start_collection";
 }
-interface StartModule {
+export interface EndTestCollection {
+    collection_id: number;
+    type: "end_collection";
+}
+export interface TestCollectionError {
+    collection_id: number;
+    error: string;
+    type: "collection_error";
+}
+export interface StartModule {
+    collection_id: number;
+    expected_test_count: number;
+    module_id: number;
+    module_name: string;
     type: "start_module";
-    moduleId: number;
 }
-interface EndModule {
+export interface EndModule {
+    collection_id: number;
+    module_id: number;
     type: "end_module";
-    moduleId: number;
 }
-interface StartTest {
+export interface ModuleError {
+    collection_id: number;
+    error: string;
+    module_id: number;
+    type: "module_error";
+}
+export interface StartTest {
+    collection_id: number;
+    module_id: number;
+    test_id: number;
+    test_name: string;
     type: "start_test";
-    testId: number;
-    moduleId: number;
 }
-interface EndTest {
-    type: "end_test";
-    testId: number;
-    moduleId: number;
-    startTime: number;
-    endTime: number;
+export interface EndTest {
     assertions: Assertions;
+    collection_id: number;
+    module_id: number;
+    test_id: number;
+    start_time: number;
+    end_time: number;
+    type: "end_test";
+}
+export interface TestError {
+    collection_id: number;
+    error: string;
+    module_id: number;
+    test_id: number;
+    type: "test_error";
 }
-export type LoggerAction = StartRun | EndRun | CancelRun | StartModule | EndModule | StartTest | EndTest;
+export type LoggerAction = StartRun | EndRun | RunError | StartTestCollection | EndTestCollection | TestCollectionError | StartModule | ModuleError | EndModule | StartTest | EndTest | TestError;
 export interface LoggerInterface {
-    readonly failed: boolean;
-    readonly cancelled: boolean;
-    log(testModules: TestModule[], action: LoggerAction): void;
+    log(action: LoggerAction): void;
 }
 export {};

package/core/dist/mod.d.ts

@@ -1,2 +1,2 @@
-export type { LoggerAction, LoggerInterface, Test, Options, TestModule, } from "./jackrabbit_types.ts";
-export { startRun, cancelRun } from "./run_steps.js";
+export type * from "./jackrabbit_types.ts";
+export { runCollection, sleep } from "./run_steps.js";

package/core/dist/mod.js

@@ -1 +1 @@
-export { startRun, cancelRun } from "./run_steps.js";
+export { runCollection, sleep } from "./run_steps.js";

package/core/dist/run_steps.d.ts

@@ -1,3 +1,3 @@
 import type { LoggerInterface, TestModule } from "./jackrabbit_types.ts";
-export declare function startRun(logger: LoggerInterface, testModules: TestModule[]): Promise<void>;
-export declare function cancelRun(logger: LoggerInterface, testModules: TestModule[]): void;
+export declare function sleep(time: number): Promise<void>;
+export declare function runCollection(logger: LoggerInterface, testModules: TestModule[], collection_id: number, collection_url: string): Promise<void>;