@w-lfpup/jackrabbit 0.2.0 → 0.3.0

package/webdriver/dist/config.js

@@ -0,0 +1,57 @@
+import * as path from "path";
+export async function createConfig(args) {
+    let configFilepath = args[0];
+    let relPath = path.resolve(process.cwd(), configFilepath);
+    try {
+        // windows might need a "file://<relPath>" situation
+        let { default: json } = await import(`file://${relPath}`, {
+            with: { type: "json" },
+        });
+        let hostAndPort = URL.parse(json.host_and_port);
+        if (!hostAndPort)
+            throw new Error(`Config: invalid host_and_port json property`);
+        let { run_asynchronously: runAsynchronously } = json;
+        if (typeof runAsynchronously !== "boolean" &&
+            undefined !== runAsynchronously)
+            throw new Error("Config: the property runAsynchronously is not a boolean or undefined");
+        let webdrivers = [];
+        if (Array.isArray(json.webdrivers))
+            for (const [index, webdriverParams] of json.webdrivers.entries()) {
+                let params = createWebdriverParams(webdriverParams);
+                if (params instanceof Error)
+                    return params;
+                let session = Math.floor(Math.random() * Number.MAX_SAFE_INTEGER);
+                let jrId = `${index}:${session.toString(32)}`;
+                webdrivers.push({ ...params, jrId });
+            }
+        return {
+            hostAndPort,
+            runAsynchronously,
+            webdrivers,
+        };
+    }
+    catch (e) {
+        if (e instanceof Error)
+            return e;
+        return new Error("Config: failed to parse config params from string");
+    }
+}
+export function createWebdriverParams(json) {
+    let { command, url, title, timeout_ms, capabilities } = json;
+    if (typeof command !== "string")
+        return new Error("WebdriverParams: command is not a string");
+    let parsedUrl = URL.parse(url);
+    if (null === parsedUrl)
+        return new Error("WebdriverParams: url is not a valid URL");
+    if (typeof title !== "string")
+        return new Error("WebdriverParams: title is not a string");
+    if (typeof timeout_ms !== "number")
+        return new Error("WebdriverParams: timeout_ms is not a number");
+    return {
+        command,
+        url: parsedUrl,
+        title,
+        timeoutMs: timeout_ms,
+        capabilities,
+    };
+}

package/webdriver/dist/eventbus.js

@@ -0,0 +1,18 @@
+export class EventBus {
+    #eventMap = new Map();
+    addListener(type, cb) {
+        let listeners = this.#eventMap.get(type);
+        if (!listeners) {
+            listeners = [];
+            this.#eventMap.set(type, listeners);
+        }
+        listeners.push(cb);
+    }
+    dispatchAction(action) {
+        let listeners = this.#eventMap.get(action.type);
+        if (listeners)
+            for (const listener of listeners) {
+                listener(action);
+            }
+    }
+}

package/webdriver/dist/listeners.js

@@ -0,0 +1,21 @@
+export class Listeners {
+    #eventMap = new Map();
+    addEventListener(eventName, cb) {
+        let eventListeners = this.#eventMap.get(eventName);
+        if (!eventListeners) {
+            eventListeners = [];
+            this.#eventMap.set(eventName, eventListeners);
+        }
+        eventListeners.push(cb);
+    }
+    dispatchEvent(event) {
+        let eventListeners = this.#eventMap.get(event.type);
+        if (eventListeners)
+            for (const listener of eventListeners) {
+                listener instanceof Function
+                    ? listener(event)
+                    : listener.handleEvent(event);
+            }
+        return event.cancelable || event.defaultPrevented;
+    }
+}

package/webdriver/dist/logger.js

@@ -0,0 +1,203 @@
+import { getResultsAsString } from "./results_str.js";
+export class Logger {
+    #eventbus;
+    #sessionResults = {
+        fails: 0,
+        errors: 0,
+        runs: new Map(),
+    };
+    constructor(config, eventbus) {
+        this.#eventbus = eventbus;
+        this.#eventbus.addListener("log", this.#boundLog);
+        this.#eventbus.addListener("session_error", this.#boundError);
+        for (let webdriverParams of config.webdrivers) {
+            this.#sessionResults.runs.set(webdriverParams.jrId, {
+                startTime: 0,
+                fails: 0,
+                errors: 0,
+                expectedTests: 0,
+                expectedModules: 0,
+                endTime: 0,
+                testTime: 0,
+                errorLogs: [],
+                completedTests: 0,
+                completedModules: 0,
+                expectedCollections: 0,
+                completedCollections: 0,
+                webdriverParams,
+                collections: [],
+            });
+        }
+    }
+    get failed() {
+        return this.#sessionResults.fails !== 0;
+    }
+    get errored() {
+        return this.#sessionResults.errors !== 0;
+    }
+    get compeleted() {
+        return false;
+    }
+    get results() {
+        return getResultsAsString(this.#sessionResults);
+    }
+    // get output
+    // output being a array of a string
+    #boundError = this.#onError.bind(this);
+    #onError(action) {
+        let runResults = this.#sessionResults.runs.get(action.id);
+        if (runResults) {
+            this.#sessionResults.errors += 1;
+            runResults.errors += 1;
+            runResults.errorLogs.push(action);
+        }
+    }
+    #boundLog = this.#onLog.bind(this);
+    #onLog(action) {
+        let { loggerAction, id } = action;
+        let runResults = this.#sessionResults.runs.get(id);
+        if (!runResults)
+            return;
+        if ("start_run" === loggerAction.type) {
+            runResults.startTime = loggerAction.time;
+            runResults.expectedCollections = loggerAction.expected_collection_count;
+        }
+        if ("end_run" === loggerAction.type) {
+            runResults.endTime = loggerAction.time;
+            this.#eventbus.dispatchAction({
+                type: "run_complete",
+                id,
+            });
+        }
+        if ("run_error" === loggerAction.type) {
+            this.#sessionResults.errors += 1;
+            runResults.errors += 1;
+            runResults.errorLogs.push(action);
+        }
+        if ("start_collection" === loggerAction.type) {
+            runResults.collections[loggerAction.collection_id] = {
+                completedModules: 0,
+                completedTests: 0,
+                errorLogs: [],
+                errors: 0,
+                expectedModules: loggerAction.expected_module_count,
+                expectedTests: 0,
+                fails: 0,
+                loggerAction,
+                modules: [],
+            };
+            runResults.expectedModules += loggerAction.expected_module_count;
+        }
+        if ("end_collection" === loggerAction.type) {
+            let collection = runResults.collections[loggerAction.collection_id];
+            if (!collection)
+                return;
+            runResults.completedCollections += 1;
+        }
+        if ("collection_error" === loggerAction.type) {
+            let collection = runResults.collections[loggerAction.collection_id];
+            if (!collection)
+                return;
+            this.#sessionResults.errors += 1;
+            runResults.errors += 1;
+            collection.errors += 1;
+            collection.errorLogs.push(loggerAction);
+        }
+        if ("start_module" === loggerAction.type) {
+            let collection = runResults.collections[loggerAction.collection_id];
+            if (!collection)
+                return;
+            collection.modules[loggerAction.module_id] = {
+                completedTests: 0,
+                errorLogs: [],
+                errors: 0,
+                expectedTests: loggerAction.expected_test_count,
+                fails: 0,
+                loggerAction,
+                testResults: [],
+            };
+            collection.expectedTests += loggerAction.expected_test_count;
+            runResults.expectedTests += loggerAction.expected_test_count;
+        }
+        if ("end_module" === loggerAction.type) {
+            let collection = runResults.collections[loggerAction.collection_id];
+            if (!collection)
+                return;
+            let module = collection.modules[loggerAction.module_id];
+            if (!module)
+                return;
+            runResults.completedModules += 1;
+            collection.completedModules += 1;
+        }
+        if ("module_error" === loggerAction.type) {
+            let collection = runResults.collections[loggerAction.collection_id];
+            if (!collection)
+                return;
+            let module = collection.modules[loggerAction.module_id];
+            if (!module)
+                return;
+            this.#sessionResults.errors += 1;
+            runResults.errors += 1;
+            collection.errors += 1;
+            module.errors += 1;
+            module.errorLogs.push(loggerAction);
+        }
+        if ("start_test" === loggerAction.type) {
+            let collection = runResults.collections[loggerAction.collection_id];
+            if (!collection)
+                return;
+            let module = collection.modules[loggerAction.module_id];
+            if (!module)
+                return;
+            module.testResults[loggerAction.test_id] = {
+                loggerStartAction: loggerAction,
+                loggerEndAction: undefined,
+            };
+        }
+        if ("end_test" === loggerAction.type) {
+            endTest(this.#sessionResults, runResults, loggerAction);
+        }
+        if ("test_error" === loggerAction.type) {
+            let collection = runResults.collections[loggerAction.collection_id];
+            if (!collection)
+                return;
+            let module = collection.modules[loggerAction.module_id];
+            if (!module)
+                return;
+            let testResult = module.testResults[loggerAction.test_id];
+            if (!testResult)
+                return;
+            testResult.loggerEndAction = loggerAction;
+            this.#sessionResults.errors += 1;
+            runResults.errors += 1;
+            collection.errors += 1;
+            module.errors += 1;
+        }
+    }
+}
+function endTest(sessionResults, runResults, loggerAction) {
+    let collection = runResults.collections[loggerAction.collection_id];
+    if (!collection)
+        return;
+    let module = collection.modules[loggerAction.module_id];
+    if (!module)
+        return;
+    let testResult = module.testResults[loggerAction.test_id];
+    if (!testResult)
+        return;
+    testResult.loggerEndAction = loggerAction;
+    runResults.completedTests += 1;
+    collection.completedTests += 1;
+    module.completedTests += 1;
+    let { assertions } = loggerAction;
+    const isAssertionArray = Array.isArray(assertions) && assertions.length;
+    // might be worth just sticking with language standard "none" like "" or 0 or false
+    const isAssertion = !Array.isArray(assertions) && undefined !== assertions;
+    if (isAssertion || isAssertionArray) {
+        sessionResults.fails += 1;
+        runResults.fails += 1;
+        collection.fails += 1;
+        module.fails += 1;
+    }
+    runResults.testTime += Math.max(0, loggerAction.end_time - loggerAction.start_time);
+}

package/webdriver/dist/mod.js

@@ -0,0 +1,36 @@
+#!/usr/bin/env node
+import * as http from "http";
+import { createConfig } from "./config.js";
+import { Logger } from "./logger.js";
+import { Router } from "./routes.js";
+import { WebDrivers } from "./webdriver.js";
+import { EventBus } from "./eventbus.js";
+let args = process.argv.slice(2);
+const config = await createConfig(args);
+if (config instanceof Error) {
+    console.log(config);
+    process.exit(1);
+}
+let eventbus = new EventBus();
+let logger = new Logger(config, eventbus);
+let router = new Router(config, eventbus);
+let webdrivers = new WebDrivers(config, eventbus);
+// setup server
+let server = http.createServer();
+server.addListener("request", router.route);
+server.addListener("close", function () {
+    console.log(logger.results);
+    logger.errored || logger.failed ? process.exit(1) : process.exit(0);
+});
+eventbus.addListener("end", function () {
+    server.closeAllConnections();
+    server.close();
+});
+// run server
+let { port, hostname } = config.hostAndPort;
+server.listen({
+    port,
+    hostname,
+});
+// start test run
+config.runAsynchronously ? webdrivers.runAll() : webdrivers.run();

package/webdriver/dist/results_str.js

@@ -0,0 +1,167 @@
+const SPACE = "  ";
+export function getResultsAsString(sessionResults) {
+    const output = [];
+    // Lots of nested loops because results a nested structure.
+    // I'd rather see composition nested in one function
+    // than have for loops spread across each function.
+    logSessionErrors(output, sessionResults);
+    for (let [, result] of sessionResults.runs) {
+        if (logRunResults(output, result))
+            continue;
+        for (const collection of result.collections) {
+            if (logCollectionResult(output, collection))
+                continue;
+            if (collection)
+                for (const moduleResult of collection.modules) {
+                    if (logModuleResult(output, moduleResult))
+                        continue;
+                    if (moduleResult)
+                        for (const testResult of moduleResult.testResults) {
+                            logTest(output, testResult);
+                        }
+                }
+        }
+    }
+    logSummary(output, sessionResults);
+    return output.join("\n");
+}
+function logSessionErrors(output, sessionResults) {
+    for (let [, result] of sessionResults.runs) {
+        for (let errorAction of result.errorLogs) {
+            if ("session_error" === errorAction.type) {
+                output.push(`\n[${result.webdriverParams.title}:session_error] ${errorAction.error}`);
+            }
+        }
+    }
+}
+function logRunResults(output, result) {
+    output.push(`
+${result.webdriverParams.title}`);
+    for (let errorAction of result.errorLogs) {
+        if ("log" === errorAction.type) {
+            if ("run_error" === errorAction.loggerAction.type) {
+                output.push(`${SPACE}[run_error] ${errorAction.loggerAction.error}`);
+            }
+        }
+    }
+    if (!result.expectedTests) {
+        output.push(`  No test runs occured.`);
+    }
+    // When everything goes right :3
+    if (!result.fails &&
+        !result.errors &&
+        result.expectedTests === result.completedTests &&
+        result.expectedModules === result.completedModules &&
+        result.expectedCollections === result.completedCollections) {
+        output.push(`${SPACE}${result.completedTests} tests
+${SPACE}${result.completedModules} modules
+${SPACE}${result.completedCollections} collections`);
+        return true;
+    }
+    return false;
+}
+function logCollectionResult(output, collection) {
+    if (!collection)
+        return true;
+    let { loggerAction } = collection;
+    if ("start_collection" !== loggerAction.type)
+        return true;
+    output.push(`${SPACE}${loggerAction.collection_url}`);
+    // when everything in the collection goes right
+    if (!collection.fails &&
+        !collection.errors &&
+        collection.expectedTests === collection.completedTests &&
+        collection.expectedModules === collection.completedModules) {
+        output.push(`${SPACE.repeat(2)}${collection.expectedTests} tests
+${SPACE.repeat(2)}${loggerAction.expected_module_count} modules`);
+        return true;
+    }
+    for (let errorAction of collection.errorLogs) {
+        if ("collection_error" !== errorAction.type)
+            continue;
+        output.push(`${SPACE.repeat(2)}[collection_error] ${errorAction.error}`);
+    }
+    return false;
+}
+function logModuleResult(output, module) {
+    if (!module)
+        return true;
+    let { loggerAction } = module;
+    if ("start_module" !== loggerAction.type)
+        return true;
+    output.push(`${SPACE.repeat(2)}${loggerAction.module_name}`);
+    // when everything in the module goes right
+    if (!module.fails &&
+        !module.errors &&
+        module.expectedTests === module.completedTests) {
+        output.push(`${SPACE.repeat(3)}${module.expectedTests} tests`);
+        return true;
+    }
+    for (let errorAction of module.errorLogs) {
+        if ("collection_error" !== errorAction.type)
+            continue;
+        output.push(`${SPACE.repeat(2)}[module_error] ${errorAction.error}`);
+    }
+    return false;
+}
+function logTest(output, test) {
+    if (!test)
+        return;
+    let { loggerStartAction, loggerEndAction } = test;
+    if ("start_test" !== loggerStartAction.type)
+        return;
+    if ("test_error" === loggerEndAction?.type) {
+        let { test_name } = loggerStartAction;
+        output.push(`${SPACE.repeat(3)}${test_name}
+${SPACE.repeat(4)}[error] ${loggerEndAction.error}`);
+    }
+    if ("end_test" === loggerEndAction?.type) {
+        let { assertions } = loggerEndAction;
+        const isAssertionArray = Array.isArray(assertions) && assertions.length;
+        const isAssertion = !Array.isArray(assertions) &&
+            undefined !== assertions &&
+            null !== assertions;
+        if (isAssertion || isAssertionArray) {
+            let { test_name } = loggerStartAction;
+            output.push(`${SPACE.repeat(3)}${test_name}`);
+        }
+        if (isAssertion) {
+            output.push(`${SPACE.repeat(4)}- ${assertions}`);
+        }
+        if (isAssertionArray) {
+            for (const assertion of assertions) {
+                output.push(`${SPACE.repeat(4)}- ${assertion}`);
+            }
+        }
+    }
+}
+function logSummary(output, sessionResults) {
+    let status_with_color = blue("\u{2714} passed");
+    if (sessionResults.fails)
+        status_with_color = yellow("\u{2717} failed");
+    if (sessionResults.errors)
+        status_with_color = gray("\u{2717} errored");
+    // expected tests
+    let totalTime = 0;
+    let testTime = 0;
+    for (let [, run] of sessionResults.runs) {
+        totalTime += run.endTime - run.startTime;
+        testTime += run.testTime;
+    }
+    output.push(`
+${status_with_color}
+duration: ${testTime.toFixed(4)} mS
+total: ${totalTime.toFixed(4)} mS
+`);
+}
+// 39 - default foreground color
+// 49 - default background color
+function blue(text) {
+    return `\x1b[44m\x1b[97m${text}\x1b[0m`;
+}
+function yellow(text) {
+    return `\x1b[43m\x1b[97m${text}\x1b[0m`;
+}
+function gray(text) {
+    return `\x1b[100m\x1b[97m${text}\x1b[0m`;
+}

package/webdriver/dist/routes.js

@@ -0,0 +1,172 @@
+import * as fs from "fs";
+import * as path from "path";
+import { testHanger } from "./test_hangar.js";
+let cwd = process.cwd();
+// better done with URL? feels weird
+let corePath = path.join(import.meta.url.substring(5), "../../../core/dist/");
+let browserPath = path.join(import.meta.url.substring(5), "../../../browser/dist/");
+const MIME_TYPES = {
+    octet: "application/octet-stream",
+    html: "text/html; charset=UTF-8",
+    js: "text/javascript",
+    json: "application/json",
+    css: "text/css",
+    png: "image/png",
+    jpg: "image/jpeg",
+    ico: "image/x-icon",
+    svg: "image/svg+xml",
+};
+export class Router {
+    #config;
+    #eventbus;
+    constructor(config, eventbus) {
+        this.#config = config;
+        this.#eventbus = eventbus;
+    }
+    get route() {
+        return this.#boundRoute;
+    }
+    #boundRoute = this.#route.bind(this);
+    async #route(req, res) {
+        if (serveBadRequest(req, res))
+            return;
+        if (servePing(req, res))
+            return;
+        if (serveTestPage(req, res, this.#config))
+            return;
+        if (logAction(req, res, this.#eventbus))
+            return;
+        await serveFile(req, res);
+    }
+}
+function serveBadRequest(req, res) {
+    let { url } = req;
+    if (url)
+        return false;
+    res.setHeader("Content-Type", "text/html");
+    res.writeHead(400);
+    res.end();
+    return true;
+}
+function servePing(req, res) {
+    let { url, method } = req;
+    if (url !== "/ping" || "GET" !== method)
+        return false;
+    res.setHeader("Content-Type", "text/html");
+    res.writeHead(200);
+    res.end("The cookie train has arrived!");
+    return true;
+}
+function serveTestPage(req, res, config) {
+    let { url, method } = req;
+    if (url !== "/" || "GET" !== method)
+        return false;
+    let hangar = testHanger({
+        jackrabbit_url: config.hostAndPort,
+        test_collections: process.argv.slice(3),
+    });
+    res.setHeader("Content-Type", "text/html");
+    res.writeHead(200);
+    res.end(hangar);
+    return true;
+}
+function logAction(req, res, eventbus) {
+    let { url, method } = req;
+    if (!url?.startsWith("/log/") || "POST" !== method)
+        return false;
+    let id;
+    let cookies = req.headers.cookie?.split(";") ?? [];
+    for (const cookieLine of cookies) {
+        if (cookieLine.startsWith("jackrabbit=")) {
+            let [_name, value] = cookieLine.split("=");
+            id = value;
+        }
+    }
+    if (id) {
+        getLoggerActionFromRequestBody(req)
+            .then(function (loggerAction) {
+            eventbus.dispatchAction({
+                type: "log",
+                loggerAction,
+                id,
+            });
+            res.writeHead(201);
+        })
+            .catch(function () {
+            res.writeHead(401);
+        })
+            .finally(function () {
+            res.end();
+        });
+    }
+    else {
+        res.writeHead(401);
+        res.end();
+    }
+    return true;
+}
+async function serveFile(req, res) {
+    let { url, method } = req;
+    if (!url) {
+        res.setHeader("Content-Type", MIME_TYPES["html"]);
+        res.writeHead(400);
+        res.end();
+        return;
+    }
+    let ext = "";
+    if (url.endsWith("/"))
+        ext = "index.html";
+    let urlNoPrefix = url;
+    if (url.startsWith("/jackrabbit"))
+        urlNoPrefix = url.substring(11);
+    let filePath = path.join(cwd, urlNoPrefix, ext);
+    let stream;
+    if (url.startsWith("/jackrabbit/core/") && "GET" === method) {
+        stream = await getDirectoryScopedFile(filePath, corePath);
+    }
+    if (url.startsWith("/jackrabbit/browser/") && "GET" === method) {
+        stream = await getDirectoryScopedFile(filePath, browserPath);
+    }
+    if (!url.startsWith("/jackrabbit") && "GET" === method) {
+        stream = await getDirectoryScopedFile(filePath, cwd);
+    }
+    if (stream) {
+        // throws errors if not a string
+        // filepath is always a string
+        const ext = path.extname(filePath).substring(1).toLowerCase();
+        let mimeType = MIME_TYPES[ext] ?? MIME_TYPES["octet"];
+        res.setHeader("Content-Type", mimeType);
+        res.writeHead(200);
+        stream.pipe(res);
+    }
+    else {
+        res.setHeader("Content-Type", MIME_TYPES["html"]);
+        res.writeHead(404);
+        res.end();
+    }
+}
+function getLoggerActionFromRequestBody(req) {
+    return new Promise(function (resolve, reject) {
+        let data = [];
+        req.addListener("data", function (chunk) {
+            data.push(chunk);
+        });
+        req.addListener("end", function () {
+            let actionStr = Buffer.concat(data).toString();
+            let action = JSON.parse(actionStr);
+            resolve(action);
+        });
+        req.addListener("error", function (err) {
+            reject(err);
+        });
+    });
+}
+async function getDirectoryScopedFile(filePath, basePath) {
+    if (!filePath.startsWith(basePath))
+        return;
+    try {
+        await fs.promises.access(filePath);
+        return fs.createReadStream(filePath);
+    }
+    catch { }
+}