@decaf-ts/utils 0.9.5 → 0.10.0

package/lib/esm/index.d.ts

@@ -26,7 +26,7 @@ export * from "./writers";
  * @const VERSION
  * @memberOf module:utils
  */
-export declare const VERSION = "0.9.4";
+export declare const VERSION = "0.9.6";
 /**
  * @description Represents the current version of the module.
  * @summary Stores the version for the @decaf-ts/utils package. The build replaces

package/lib/esm/index.js

@@ -26,7 +26,7 @@ export * from "./writers/index.js";
  * @const VERSION
  * @memberOf module:utils
  */
-export const VERSION = "0.9.4";
+export const VERSION = "0.9.6";
 /**
  * @description Represents the current version of the module.
  * @summary Stores the version for the @decaf-ts/utils package. The build replaces

package/lib/esm/tests/Consumer.d.ts

@@ -0,0 +1,39 @@
+import { LoggedClass } from "@decaf-ts/logging";
+import { TestReporter } from "./TestReporter";
+type LogStore = Record<number, string[]>;
+export interface ParsedLog {
+    timestamp: number;
+    child: string;
+    action: string;
+}
+export interface ComparerResult {
+    consumer: ParsedLog[];
+    producer: ParsedLog[];
+}
+type Comparer = (consumerData: LogStore, producerData: LogStore) => Promise<ComparerResult>;
+type ConsumerHandler = (identifier: number, ...args: unknown[]) => unknown | Promise<unknown>;
+export declare const defaultComparer: Comparer;
+export interface ReportingComparerOptions {
+    reporter?: TestReporter;
+    testCase?: string;
+    referencePrefix?: string;
+}
+export declare const reportingComparer: (consumerData: LogStore, producerData: LogStore, options?: ReportingComparerOptions) => Promise<ComparerResult>;
+export declare class ConsumerRunner extends LoggedClass {
+    private readonly action;
+    private readonly handler;
+    private readonly comparerHandle;
+    private forkedCache;
+    private consumerResults;
+    private producerResults;
+    private completionTriggered;
+    constructor(action: string, consumerHandler: ConsumerHandler, compareHandler?: Comparer);
+    private reset;
+    private store;
+    private recordConsumer;
+    private isProducerComplete;
+    private isConsumerComplete;
+    private terminateChildren;
+    run(count: number, timeout: number | undefined, times: number, random: boolean | undefined): Promise<ComparerResult>;
+}
+export {};

package/lib/esm/tests/Consumer.js

@@ -0,0 +1,250 @@
+import { fork } from "node:child_process";
+import { join } from "node:path";
+import { LoggedClass } from "@decaf-ts/logging";
+import { TestReporter } from "./TestReporter.js";
+const parseData = (data) => {
+    const [timestamp, , child, action] = data.split(" - ");
+    return {
+        timestamp: parseInt(timestamp, 10),
+        child,
+        action,
+    };
+};
+export const defaultComparer = async (consumerData, producerData) => {
+    const sortedConsumerData = Object.keys(consumerData)
+        .reduce((accum, key) => {
+        const identifier = Number(key);
+        const entries = consumerData[identifier] ?? [];
+        accum.push(...entries.map((entry) => parseData(entry)));
+        return accum;
+    }, [])
+        .sort((a, b) => a.timestamp - b.timestamp);
+    const sortedProducerData = Object.keys(producerData)
+        .reduce((accum, key) => {
+        const identifier = Number(key);
+        const entries = producerData[identifier] ?? [];
+        accum.push(...entries.map((entry) => parseData(entry)));
+        return accum;
+    }, [])
+        .sort((a, b) => a.timestamp - b.timestamp);
+    if (sortedProducerData.length !== sortedConsumerData.length) {
+        throw new Error("Producer data and consumer data does not match in length");
+    }
+    let counter = -1;
+    const isMatching = sortedProducerData.every((producer, index) => {
+        counter = index;
+        const consumer = sortedConsumerData[index];
+        return (producer.child === consumer.child && producer.action === consumer.action);
+    });
+    if (!isMatching) {
+        const errorLines = [
+            `Producer data and consumer data do not sort the same way as of record ${counter}:`,
+            "    |             CONSUMER            |              PRODUCER            |",
+            "    | id | action    | timestamp      | id | action    | timestamp       |",
+        ];
+        sortedProducerData.forEach((producer, index) => {
+            if (index < counter || index > counter + 15) {
+                return;
+            }
+            const consumer = sortedConsumerData[index];
+            errorLines.push(`  ${index < 10 ? `0${index}` : index}|  ${consumer.child} | ${consumer.action}    | ${consumer.timestamp}  | ${producer.child}  | ${producer.action}    | ${producer.timestamp}   |`);
+        });
+        throw new Error(errorLines.join("\n"));
+    }
+    return {
+        consumer: sortedConsumerData,
+        producer: sortedProducerData,
+    };
+};
+const formatTimestamp = (value) => new Date(value).toISOString();
+export const reportingComparer = async (consumerData, producerData, options) => {
+    const reporter = options?.reporter ??
+        new TestReporter(options?.testCase ?? "consumer-producer");
+    const referencePrefix = options?.referencePrefix ?? "consumer-producer";
+    try {
+        const comparison = await defaultComparer(consumerData, producerData);
+        const rows = comparison.consumer.map((consumerEntry, index) => {
+            const producerEntry = comparison.producer[index];
+            return {
+                Index: `${index}`,
+                "Consumer Child": consumerEntry.child,
+                "Consumer Action": consumerEntry.action,
+                "Consumer Timestamp": formatTimestamp(consumerEntry.timestamp),
+                "Producer Child": producerEntry?.child ?? "N/A",
+                "Producer Action": producerEntry?.action ?? "N/A",
+                "Producer Timestamp": producerEntry
+                    ? formatTimestamp(producerEntry.timestamp)
+                    : "N/A",
+            };
+        });
+        await Promise.allSettled([
+            reporter.reportMessage(`${referencePrefix}-comparison`, `Consumer and producer logs matched (${comparison.consumer.length} entries).`),
+            reporter.reportTable(`${referencePrefix}-logs`, {
+                headers: [
+                    "Index",
+                    "Consumer Child",
+                    "Consumer Action",
+                    "Consumer Timestamp",
+                    "Producer Child",
+                    "Producer Action",
+                    "Producer Timestamp",
+                ],
+                rows,
+            }),
+        ]);
+        return comparison;
+    }
+    catch (error) {
+        const message = error instanceof Error ? error.message : String(error ?? "Unknown error");
+        await Promise.allSettled([
+            reporter.reportMessage(`${referencePrefix}-mismatch`, message),
+            reporter.reportObject(`${referencePrefix}-consumer`, consumerData),
+            reporter.reportObject(`${referencePrefix}-producer`, producerData),
+        ]);
+        throw error;
+    }
+};
+export class ConsumerRunner extends LoggedClass {
+    constructor(action, consumerHandler, compareHandler) {
+        super();
+        this.forkedCache = [];
+        this.consumerResults = {};
+        this.producerResults = {};
+        this.completionTriggered = false;
+        this.action = action;
+        this.handler = consumerHandler;
+        this.comparerHandle = compareHandler ?? defaultComparer;
+        this.reset();
+    }
+    reset() {
+        this.forkedCache = [];
+        this.consumerResults = {};
+        this.producerResults = {};
+        this.completionTriggered = false;
+    }
+    store(identifier, action, timeout, times, count, random) {
+        const logParts = [
+            Date.now(),
+            "PRODUCER",
+            identifier,
+            action,
+        ];
+        if (timeout) {
+            logParts.push(timeout);
+        }
+        if (times && count) {
+            logParts.push(`${count}/${times}`, random ?? false);
+        }
+        const log = logParts.join(" - ");
+        if (!this.producerResults[identifier]) {
+            this.producerResults[identifier] = [];
+        }
+        this.producerResults[identifier].push(log);
+    }
+    recordConsumer(identifier) {
+        const logParts = [
+            Date.now(),
+            "CONSUMER",
+            identifier,
+            this.action,
+        ];
+        const log = logParts.join(" - ");
+        if (!this.consumerResults[identifier]) {
+            this.consumerResults[identifier] = [];
+        }
+        this.consumerResults[identifier].push(log);
+    }
+    isProducerComplete(count, times) {
+        const producerKeys = Object.keys(this.producerResults);
+        if (producerKeys.length !== count) {
+            return false;
+        }
+        return producerKeys.every((key) => this.producerResults[Number(key)]?.length === times);
+    }
+    isConsumerComplete(count, times) {
+        const consumerKeys = Object.keys(this.consumerResults);
+        if (consumerKeys.length !== count) {
+            return false;
+        }
+        return consumerKeys.every((key) => this.consumerResults[Number(key)]?.length === times);
+    }
+    terminateChildren() {
+        if (!this.forkedCache) {
+            return;
+        }
+        this.forkedCache.forEach((forked, index) => {
+            forked.send({
+                identifier: index,
+                terminate: true,
+            });
+        });
+        this.forkedCache = undefined;
+    }
+    async run(count, timeout, times, random) {
+        this.reset();
+        const childPath = join(__dirname, "ProducerChildProcess.cjs");
+        return new Promise((resolve, reject) => {
+            const handleError = (error) => {
+                if (this.completionTriggered) {
+                    return;
+                }
+                this.completionTriggered = true;
+                this.terminateChildren();
+                reject(error);
+            };
+            const finalizeIfComplete = () => {
+                if (this.completionTriggered) {
+                    return;
+                }
+                if (!this.isProducerComplete(count, times) ||
+                    !this.isConsumerComplete(count, times)) {
+                    return;
+                }
+                this.terminateChildren();
+                this.completionTriggered = true;
+                try {
+                    Promise.resolve(this.comparerHandle(this.consumerResults, this.producerResults))
+                        .then(resolve)
+                        .catch(reject);
+                }
+                catch (error) {
+                    reject(error);
+                }
+            };
+            const checkProducerCompletion = () => {
+                if (this.isProducerComplete(count, times)) {
+                    this.terminateChildren();
+                }
+            };
+            for (let identifier = 1; identifier < count + 1; identifier += 1) {
+                const forked = fork(childPath);
+                this.forkedCache?.push(forked);
+                forked.on("error", handleError);
+                forked.on("message", async (message) => {
+                    const { identifier: childId, args, action, timeout: childTimeout, times: childTimes, random: childRandom, } = message;
+                    try {
+                        this.store(childId, action, childTimeout, childTimes, count, childRandom);
+                        checkProducerCompletion();
+                        const handlerArgs = Array.isArray(args) ? args : [];
+                        await Promise.resolve(this.handler(childId, ...handlerArgs));
+                        this.recordConsumer(childId);
+                        finalizeIfComplete();
+                    }
+                    catch (error) {
+                        handleError(error);
+                    }
+                });
+            }
+            this.forkedCache?.forEach((forked, index) => {
+                forked.send({
+                    identifier: index,
+                    action: this.action,
+                    timeout,
+                    times,
+                    random,
+                });
+            });
+        });
+    }
+}
+//# sourceMappingURL=Consumer.js.map

package/lib/esm/tests/Consumer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Consumer.js","sourceRoot":"","sources":["../../../src/tests/Consumer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,IAAI,EAAE,MAAM,oBAAoB,CAAC;AACxD,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,0BAAuB;AAmC9C,MAAM,SAAS,GAAG,CAAC,IAAY,EAAa,EAAE;IAC5C,MAAM,CAAC,SAAS,EAAE,AAAD,EAAG,KAAK,EAAE,MAAM,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACvD,OAAO;QACL,SAAS,EAAE,QAAQ,CAAC,SAAS,EAAE,EAAE,CAAC;QAClC,KAAK;QACL,MAAM;KACP,CAAC;AACJ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,eAAe,GAAa,KAAK,EAAE,YAAY,EAAE,YAAY,EAAE,EAAE;IAC5E,MAAM,kBAAkB,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC;SACjD,MAAM,CAAc,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;QAClC,MAAM,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAC/B,MAAM,OAAO,GAAG,YAAY,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;QAC/C,KAAK,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACxD,OAAO,KAAK,CAAC;IACf,CAAC,EAAE,EAAE,CAAC;SACL,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC;IAE7C,MAAM,kBAAkB,GAAG,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC;SACjD,MAAM,CAAc,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE;QAClC,MAAM,UAAU,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QAC/B,MAAM,OAAO,GAAG,YAAY,CAAC,UAAU,CAAC,IAAI,EAAE,CAAC;QAC/C,KAAK,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACxD,OAAO,KAAK,CAAC;IACf,CAAC,EAAE,EAAE,CAAC;SACL,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC;IAE7C,IAAI,kBAAkB,CAAC,MAAM,KAAK,kBAAkB,CAAC,MAAM,EAAE,CAAC;QAC5D,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAC;IAC9E,CAAC;IAED,IAAI,OAAO,GAAG,CAAC,CAAC,CAAC;IACjB,MAAM,UAAU,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE;QAC9D,OAAO,GAAG,KAAK,CAAC;QAChB,MAAM,QAAQ,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAC3C,OAAO,CACL,QAAQ,CAAC,KAAK,KAAK,QAAQ,CAAC,KAAK,IAAI,QAAQ,CAAC,MAAM,KAAK,QAAQ,CAAC,MAAM,CACzE,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,MAAM,UAAU,GAAG;YACjB,yEAAyE,OAAO,GAAG;YACnF,4EAA4E;YAC5E,4EAA4E;SAC7E,CAAC;QAEF,kBAAkB,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE;YAC7C,IAAI,KAAK,GAAG,OAAO,IAAI,KAAK,GAAG,OAAO,GAAG,EAAE,EAAE,CAAC;gBAC5C,OAAO;YACT,CAAC;YACD,MAAM,QAAQ,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC3C,UAAU,CAAC,IAAI,CACb,KAAK,KAAK,GAAG,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,KAAK,MAAM,QAAQ,CAAC,KAAK,MAAM,QAAQ,CAAC,MAAM,SAAS,QAAQ,CAAC,SAAS,OAAO,QAAQ,CAAC,KAAK,OAAO,QAAQ,CAAC,MAAM,SAAS,QAAQ,CAAC,SAAS,MAAM,CACtL,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,MAAM,IAAI,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IACzC,CAAC;IAED,OAAO;QACL,QAAQ,EAAE,kBAAkB;QAC5B,QAAQ,EAAE,kBAAkB;KAC7B,CAAC;AACJ,CAAC,CAAC;AAQF,MAAM,eAAe,GAAG,CAAC,KAAa,EAAU,EAAE,CAChD,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;AAEhC,MAAM,CAAC,MAAM,iBAAiB,GAAG,KAAK,EACpC,YAAsB,EACtB,YAAsB,EACtB,OAAkC,EACT,EAAE;IAC3B,MAAM,QAAQ,GACZ,OAAO,EAAE,QAAQ;QACjB,IAAI,YAAY,CAAC,OAAO,EAAE,QAAQ,IAAI,mBAAmB,CAAC,CAAC;IAC7D,MAAM,eAAe,GAAG,OAAO,EAAE,eAAe,IAAI,mBAAmB,CAAC;IAExE,IAAI,CAAC;QACH,MAAM,UAAU,GAAG,MAAM,eAAe,CAAC,YAAY,EAAE,YAAY,CAAC,CAAC;QAErE,MAAM,IAAI,GAAG,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,aAAa,EAAE,KAAK,EAAE,EAAE;YAC5D,MAAM,aAAa,GAAG,UAAU,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YACjD,OAAO;gBACL,KAAK,EAAE,GAAG,KAAK,EAAE;gBACjB,gBAAgB,EAAE,aAAa,CAAC,KAAK;gBACrC,iBAAiB,EAAE,aAAa,CAAC,MAAM;gBACvC,oBAAoB,EAAE,eAAe,CAAC,aAAa,CAAC,SAAS,CAAC;gBAC9D,gBAAgB,EAAE,aAAa,EAAE,KAAK,IAAI,KAAK;gBAC/C,iBAAiB,EAAE,aAAa,EAAE,MAAM,IAAI,KAAK;gBACjD,oBAAoB,EAAE,aAAa;oBACjC,CAAC,CAAC,eAAe,CAAC,aAAa,CAAC,SAAS,CAAC;oBAC1C,CAAC,CAAC,KAAK;aACV,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,UAAU,CAAC;YACvB,QAAQ,CAAC,aAAa,CACpB,GAAG,eAAe,aAAa,EAC/B,uCAAuC,UAAU,CAAC,QAAQ,CAAC,MAAM,YAAY,CAC9E;YACD,QAAQ,CAAC,WAAW,CAAC,GAAG,eAAe,OAAO,EAAE;gBAC9C,OAAO,EAAE;oBACP,OAAO;oBACP,gBAAgB;oBAChB,iBAAiB;oBACjB,oBAAoB;oBACpB,gBAAgB;oBAChB,iBAAiB;oBACjB,oBAAoB;iBACrB;gBACD,IAAI;aACL,CAAC;SACH,CAAC,CAAC;QAEH,OAAO,UAAU,CAAC;IACpB,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,OAAO,GACX,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,IAAI,eAAe,CAAC,CAAC;QAE5E,MAAM,OAAO,CAAC,UAAU,CAAC;YACvB,QAAQ,CAAC,aAAa,CAAC,GAAG,eAAe,WAAW,EAAE,OAAO,CAAC;YAC9D,QAAQ,CAAC,YAAY,CAAC,GAAG,eAAe,WAAW,EAAE,YAAY,CAAC;YAClE,QAAQ,CAAC,YAAY,CAAC,GAAG,eAAe,WAAW,EAAE,YAAY,CAAC;SACnE,CAAC,CAAC;QAEH,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,OAAO,cAAe,SAAQ,WAAW;IAS7C,YACE,MAAc,EACd,eAAgC,EAChC,cAAyB;QAEzB,KAAK,EAAE,CAAC;QAVF,gBAAW,GAA+B,EAAE,CAAC;QAC7C,oBAAe,GAAa,EAAE,CAAC;QAC/B,oBAAe,GAAa,EAAE,CAAC;QAC/B,wBAAmB,GAAG,KAAK,CAAC;QAQlC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,eAAe,CAAC;QAC/B,IAAI,CAAC,cAAc,GAAG,cAAc,IAAI,eAAe,CAAC;QACxD,IAAI,CAAC,KAAK,EAAE,CAAC;IACf,CAAC;IAEO,KAAK;QACX,IAAI,CAAC,WAAW,GAAG,EAAE,CAAC;QACtB,IAAI,CAAC,eAAe,GAAG,EAAE,CAAC;QAC1B,IAAI,CAAC,eAAe,GAAG,EAAE,CAAC;QAC1B,IAAI,CAAC,mBAAmB,GAAG,KAAK,CAAC;IACnC,CAAC;IAEO,KAAK,CACX,UAAkB,EAClB,MAAc,EACd,OAA2B,EAC3B,KAAa,EACb,KAAa,EACb,MAAgB;QAEhB,MAAM,QAAQ,GAAqC;YACjD,IAAI,CAAC,GAAG,EAAE;YACV,UAAU;YACV,UAAU;YACV,MAAM;SACP,CAAC;QACF,IAAI,OAAO,EAAE,CAAC;YACZ,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzB,CAAC;QACD,IAAI,KAAK,IAAI,KAAK,EAAE,CAAC;YACnB,QAAQ,CAAC,IAAI,CAAC,GAAG,KAAK,IAAI,KAAK,EAAE,EAAE,MAAM,IAAI,KAAK,CAAC,CAAC;QACtD,CAAC;QAED,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACjC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,EAAE,CAAC;YACtC,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC;QACxC,CAAC;QACD,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC7C,CAAC;IAEO,cAAc,CAAC,UAAkB;QACvC,MAAM,QAAQ,GAA2B;YACvC,IAAI,CAAC,GAAG,EAAE;YACV,UAAU;YACV,UAAU;YACV,IAAI,CAAC,MAAM;SACZ,CAAC;QACF,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAEjC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,EAAE,CAAC;YACtC,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,GAAG,EAAE,CAAC;QACxC,CAAC;QACD,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC7C,CAAC;IAEO,kBAAkB,CAAC,KAAa,EAAE,KAAa;QACrD,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QACvD,IAAI,YAAY,CAAC,MAAM,KAAK,KAAK,EAAE,CAAC;YAClC,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,YAAY,CAAC,KAAK,CACvB,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,KAAK,KAAK,CAC7D,CAAC;IACJ,CAAC;IAEO,kBAAkB,CAAC,KAAa,EAAE,KAAa;QACrD,MAAM,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QACvD,IAAI,YAAY,CAAC,MAAM,KAAK,KAAK,EAAE,CAAC;YAClC,OAAO,KAAK,CAAC;QACf,CAAC;QACD,OAAO,YAAY,CAAC,KAAK,CACvB,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,MAAM,KAAK,KAAK,CAC7D,CAAC;IACJ,CAAC;IAEO,iBAAiB;QACvB,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;YACtB,OAAO;QACT,CAAC;QACD,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;YACzC,MAAM,CAAC,IAAI,CAAC;gBACV,UAAU,EAAE,KAAK;gBACjB,SAAS,EAAE,IAAI;aAChB,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;IAC/B,CAAC;IAED,KAAK,CAAC,GAAG,CACP,KAAa,EACb,OAA2B,EAC3B,KAAa,EACb,MAA2B;QAE3B,IAAI,CAAC,KAAK,EAAE,CAAC;QACb,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,EAAE,0BAA0B,CAAC,CAAC;QAE9D,OAAO,IAAI,OAAO,CAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrD,MAAM,WAAW,GAAG,CAAC,KAAc,EAAE,EAAE;gBACrC,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;oBAC7B,OAAO;gBACT,CAAC;gBACD,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC;gBAChC,IAAI,CAAC,iBAAiB,EAAE,CAAC;gBACzB,MAAM,CAAC,KAAK,CAAC,CAAC;YAChB,CAAC,CAAC;YAEF,MAAM,kBAAkB,GAAG,GAAG,EAAE;gBAC9B,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;oBAC7B,OAAO;gBACT,CAAC;gBACD,IACE,CAAC,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,KAAK,CAAC;oBACtC,CAAC,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,KAAK,CAAC,EACtC,CAAC;oBACD,OAAO;gBACT,CAAC;gBAED,IAAI,CAAC,iBAAiB,EAAE,CAAC;gBACzB,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAC;gBAEhC,IAAI,CAAC;oBACH,OAAO,CAAC,OAAO,CACb,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,eAAe,EAAE,IAAI,CAAC,eAAe,CAAC,CAChE;yBACE,IAAI,CAAC,OAAO,CAAC;yBACb,KAAK,CAAC,MAAM,CAAC,CAAC;gBACnB,CAAC;gBAAC,OAAO,KAAK,EAAE,CAAC;oBACf,MAAM,CAAC,KAAK,CAAC,CAAC;gBAChB,CAAC;YACH,CAAC,CAAC;YAEF,MAAM,uBAAuB,GAAG,GAAG,EAAE;gBACnC,IAAI,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,CAAC;oBAC1C,IAAI,CAAC,iBAAiB,EAAE,CAAC;gBAC3B,CAAC;YACH,CAAC,CAAC;YAEF,KAAK,IAAI,UAAU,GAAG,CAAC,EAAE,UAAU,GAAG,KAAK,GAAG,CAAC,EAAE,UAAU,IAAI,CAAC,EAAE,CAAC;gBACjE,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC;gBAC/B,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;gBAE/B,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;gBAEhC,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,OAAwB,EAAE,EAAE;oBACtD,MAAM,EACJ,UAAU,EAAE,OAAO,EACnB,IAAI,EACJ,MAAM,EACN,OAAO,EAAE,YAAY,EACrB,KAAK,EAAE,UAAU,EACjB,MAAM,EAAE,WAAW,GACpB,GAAG,OAAO,CAAC;oBAEZ,IAAI,CAAC;wBACH,IAAI,CAAC,KAAK,CACR,OAAO,EACP,MAAM,EACN,YAAY,EACZ,UAAU,EACV,KAAK,EACL,WAAW,CACZ,CAAC;wBACF,uBAAuB,EAAE,CAAC;wBAE1B,MAAM,WAAW,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;wBACpD,MAAM,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,GAAG,WAAW,CAAC,CAAC,CAAC;wBAE7D,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;wBAC7B,kBAAkB,EAAE,CAAC;oBACvB,CAAC;oBAAC,OAAO,KAAK,EAAE,CAAC;wBACf,WAAW,CAAC,KAAK,CAAC,CAAC;oBACrB,CAAC;gBACH,CAAC,CAAC,CAAC;YACL,CAAC;YAED,IAAI,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;gBAC1C,MAAM,CAAC,IAAI,CAAC;oBACV,UAAU,EAAE,KAAK;oBACjB,MAAM,EAAE,IAAI,CAAC,MAAM;oBACnB,OAAO;oBACP,KAAK;oBACL,MAAM;iBACP,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF"}

package/lib/esm/tests/ProducerChildProcess.d.ts

@@ -0,0 +1,17 @@
+type ParentMessage = {
+    identifier: number;
+    action: string;
+    timeout?: number;
+    times: number;
+    random?: boolean;
+    terminate?: boolean;
+};
+type ProducerResponse = {
+    identifier: number;
+    action: string;
+    timeout?: number;
+    times: number;
+    random?: boolean;
+    result?: string[];
+};
+declare const result: string[];

package/lib/esm/tests/ProducerChildProcess.js

@@ -0,0 +1,49 @@
+"use strict";
+const result = [];
+process.on('message', (args) => {
+    const { identifier, action, timeout, times, random, terminate } = args;
+    const tick = (count) => {
+        const logParts = [Date.now(), 'PRODUCER', identifier, action];
+        if (timeout) {
+            logParts.push(timeout);
+        }
+        if (times && count) {
+            logParts.push(`${count}/${times}`, random ?? false);
+        }
+        const log = logParts.join(' - ');
+        result.push(log);
+        const response = { identifier, action, timeout, times, random };
+        if (result.length === times) {
+            response.result = [...result];
+        }
+        process.send?.(response);
+    };
+    if (terminate) {
+        const log = [Date.now(), 'PRODUCER', identifier, action, 'Quitting!'].join(' - ');
+        console.log(log);
+        process.exit(0);
+    }
+    if (!timeout) {
+        tick(times);
+        return;
+    }
+    const getTimeout = () => {
+        if (!random) {
+            return timeout;
+        }
+        return Math.floor(Math.random() * timeout);
+    };
+    let actionCount = 0;
+    const iterator = () => {
+        const currentTimeout = getTimeout();
+        setTimeout(() => {
+            actionCount += 1;
+            tick(actionCount);
+            if (actionCount < times) {
+                iterator();
+            }
+        }, currentTimeout);
+    };
+    iterator();
+});
+//# sourceMappingURL=ProducerChildProcess.js.map

package/lib/esm/tests/ProducerChildProcess.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ProducerChildProcess.js","sourceRoot":"","sources":["../../../src/tests/ProducerChildProcess.ts"],"names":[],"mappings":";AAkBA,MAAM,MAAM,GAAa,EAAE,CAAC;AAE5B,OAAO,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,IAAmB,EAAE,EAAE;IAC5C,MAAM,EAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAC,GAAG,IAAI,CAAC;IAErE,MAAM,IAAI,GAAG,CAAC,KAAa,EAAE,EAAE;QAC7B,MAAM,QAAQ,GAAqC,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,CAAC,CAAC;QAChG,IAAI,OAAO,EAAE,CAAC;YACZ,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACzB,CAAC;QACD,IAAI,KAAK,IAAI,KAAK,EAAE,CAAC;YACnB,QAAQ,CAAC,IAAI,CAAC,GAAG,KAAK,IAAI,KAAK,EAAE,EAAE,MAAM,IAAI,KAAK,CAAC,CAAC;QACtD,CAAC;QAED,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACjC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAEjB,MAAM,QAAQ,GAAqB,EAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAC,CAAC;QAChF,IAAI,MAAM,CAAC,MAAM,KAAK,KAAK,EAAE,CAAC;YAC5B,QAAQ,CAAC,MAAM,GAAG,CAAC,GAAG,MAAM,CAAC,CAAC;QAChC,CAAC;QAED,OAAO,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,CAAC;IAC3B,CAAC,CAAC;IAEF,IAAI,SAAS,EAAE,CAAC;QACd,MAAM,GAAG,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,EAAE,WAAW,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAClF,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACjB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;IAED,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,IAAI,CAAC,KAAK,CAAC,CAAC;QACZ,OAAO;IACT,CAAC;IAED,MAAM,UAAU,GAAG,GAAG,EAAE;QACtB,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,OAAO,OAAO,CAAC;QACjB,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,EAAE,GAAG,OAAO,CAAC,CAAC;IAC7C,CAAC,CAAC;IAEF,IAAI,WAAW,GAAG,CAAC,CAAC;IAEpB,MAAM,QAAQ,GAAG,GAAG,EAAE;QACpB,MAAM,cAAc,GAAG,UAAU,EAAE,CAAC;QACpC,UAAU,CAAC,GAAG,EAAE;YACd,WAAW,IAAI,CAAC,CAAC;YACjB,IAAI,CAAC,WAAW,CAAC,CAAC;YAClB,IAAI,WAAW,GAAG,KAAK,EAAE,CAAC;gBACxB,QAAQ,EAAE,CAAC;YACb,CAAC;QACH,CAAC,EAAE,cAAc,CAAC,CAAC;IACrB,CAAC,CAAC;IAEF,QAAQ,EAAE,CAAC;AACb,CAAC,CAAC,CAAC"}

package/lib/esm/tests/TestReporter.d.ts

@@ -0,0 +1,193 @@
+import { MdTableDefinition } from "../utils/md";
+/**
+ * @interface AddAttachParams
+ * @description Parameters for adding an attachment to a report
+ * @summary Interface for attachment parameters
+ * @memberOf module:utils
+ */
+export interface AddAttachParams {
+    attach: string | Buffer;
+    description: string | object;
+    context?: any;
+    bufferFormat?: string;
+}
+/**
+ * @interface AddMsgParams
+ * @description Parameters for adding a message to a report
+ * @summary Interface for message parameters
+ * @memberOf module:utils
+ */
+export interface AddMsgParams {
+    message: string | object;
+    context?: any;
+}
+/**
+ * @typedef {("json"|"image"|"text"|"md")} PayloadType
+ * @description Types of payloads that can be handled
+ * @summary Union type for payload types
+ * @memberOf module:utils
+ */
+export type PayloadType = "json" | "image" | "text" | "md";
+/**
+ * @description Environment variable key for Jest HTML reporters temporary directory path
+ * @summary Constant defining the environment variable key for Jest HTML reporters
+ * @const JestReportersTempPathEnvKey
+ * @memberOf module:utils
+ */
+export declare const JestReportersTempPathEnvKey = "JEST_HTML_REPORTERS_TEMP_DIR_PATH";
+/**
+ * @description Test reporting utility class for managing test results and evidence
+ * @summary A comprehensive test reporter that handles various types of test artifacts including messages,
+ * attachments, data, images, tables, and graphs. It provides methods to report and store test evidence
+ * in different formats and manages dependencies for reporting functionality.
+ *
+ * @template T - Type of data being reported
+ * @param {string} [testCase="tests"] - Name of the test case
+ * @param {string} [basePath] - Base path for storing test reports
+ * @class
+ *
+ * @example
+ * ```typescript
+ * const reporter = new TestReporter('login-test');
+ *
+ * // Report test messages
+ * await reporter.reportMessage('Test Started', 'Login flow initiated');
+ *
+ * // Report test data
+ * await reporter.reportData('user-credentials', { username: 'test' }, 'json');
+ *
+ * // Report test results table
+ * await reporter.reportTable('test-results', {
+ *   headers: ['Step', 'Status'],
+ *   rows: [
+ *     { Step: 'Login', Status: 'Pass' },
+ *     { Step: 'Validation', Status: 'Pass' }
+ *   ]
+ * });
+ *
+ * // Report test evidence
+ * await reporter.reportAttachment('Screenshot', screenshotBuffer);
+ * ```
+ *
+ * @mermaid
+ * sequenceDiagram
+ *   participant Client
+ *   participant TestReporter
+ *   participant FileSystem
+ *   participant Dependencies
+ *
+ *   Client->>TestReporter: new TestReporter(testCase, basePath)
+ *   TestReporter->>FileSystem: Create report directory
+ *
+ *   alt Report Message
+ *     Client->>TestReporter: reportMessage(title, message)
+ *     TestReporter->>Dependencies: Import helpers
+ *     TestReporter->>FileSystem: Store message
+ *   else Report Data
+ *     Client->>TestReporter: reportData(reference, data, type)
+ *     TestReporter->>Dependencies: Process data
+ *     TestReporter->>FileSystem: Store formatted data
+ *   else Report Table
+ *     Client->>TestReporter: reportTable(reference, tableDef)
+ *     TestReporter->>Dependencies: Convert to MD format
+ *     TestReporter->>FileSystem: Store table
+ *   end
+ */
+export declare class TestReporter {
+    protected testCase: string;
+    protected basePath: string;
+    /**
+     * @description Function for adding messages to the test report
+     * @summary Static handler for processing and storing test messages
+     * @type {function(AddMsgParams): Promise<void>}
+     */
+    protected static addMsgFunction: (params: AddMsgParams) => Promise<void>;
+    /**
+     * @description Function for adding attachments to the test report
+     * @summary Static handler for processing and storing test attachments
+     * @type {function(AddAttachParams): Promise<void>}
+     */
+    protected static addAttachFunction: (params: AddAttachParams) => Promise<void>;
+    /**
+     * @description Map of dependencies required by the reporter
+     * @summary Stores the current state of dependencies
+     * @type {SimpleDependencyMap}
+     */
+    private deps?;
+    constructor(testCase?: string, basePath?: string);
+    /**
+     * @description Imports required helper functions
+     * @summary Ensures all necessary dependencies are available and imports helper functions
+     * @return {Promise<void>} Promise that resolves when helpers are imported
+     */
+    private importHelpers;
+    /**
+     * @description Reports a message to the test report
+     * @summary Adds a formatted message to the test report with an optional title
+     * @param {string} title - Title of the message
+     * @param {string | object} message - Content of the message
+     * @return {Promise<void>} Promise that resolves when the message is reported
+     */
+    reportMessage(title: string, message: string | object): Promise<void>;
+    /**
+     * @description Reports an attachment to the test report
+     * @summary Adds a formatted message to the test report with an optional title
+     * @param {string} title - Title of the message
+     * @param {string | Buffer} attachment - Content of the message
+     * @return {Promise<void>} Promise that resolves when the message is reported
+     */
+    reportAttachment(title: string, attachment: string | Buffer): Promise<void>;
+    /**
+     * @description Reports data with specified type
+     * @summary Processes and stores data in the test report with formatting
+     * @param {string} reference - Reference identifier for the data
+     * @param {string | number | object} data - Data to be reported
+     * @param {PayloadType} type - Type of the payload
+     * @param {boolean} [trim=false] - Whether to trim the data
+     * @return {Promise<void>} Promise that resolves when data is reported
+     */
+    protected report(reference: string, data: string | number | object | Buffer, type: PayloadType, trim?: boolean): Promise<void>;
+    /**
+     * @description Reports data with a specified type
+     * @summary Wrapper method for reporting various types of data
+     * @param {string} reference - Reference identifier for the data
+     * @param {string | number | object} data - Data to be reported
+     * @param {PayloadType} [type="json"] - Type of the payload
+     * @param {boolean} [trim=false] - Whether to trim the data
+     * @return {Promise<void>} Promise that resolves when data is reported
+     */
+    reportData(reference: string, data: string | number | object, type?: PayloadType, trim?: boolean): Promise<void>;
+    /**
+     * @description Reports a JSON object
+     * @summary Convenience method for reporting JSON objects
+     * @param {string} reference - Reference identifier for the object
+     * @param {object} json - JSON object to be reported
+     * @param {boolean} [trim=false] - Whether to trim the object
+     * @return {Promise<void>} Promise that resolves when object is reported
+     */
+    reportObject(reference: string, json: object, trim?: boolean): Promise<void>;
+    /**
+     * @description Reports a table in markdown format
+     * @summary Converts and stores a table definition in markdown format
+     * @param {string} reference - Reference identifier for the table
+     * @param {MdTableDefinition} tableDef - Table definition object
+     * @return {Promise<void>} Promise that resolves when table is reported
+     */
+    reportTable(reference: string, tableDef: MdTableDefinition): Promise<void>;
+    /**
+     * @description Reports a graph using Chart.js
+     * @summary Generates and stores a graph visualization
+     * @param {string} reference - Reference identifier for the graph
+     * @param {any} config - Chart.js configuration object
+     * @return {Promise<void>} Promise that resolves when graph is reported
+     */
+    reportGraph(reference: string, config: any): Promise<void>;
+    /**
+     * @description Reports an image to the test report
+     * @summary Stores an image buffer in the test report
+     * @param {string} reference - Reference identifier for the image
+     * @param {Buffer} buffer - Image data buffer
+     * @return {Promise<void>} Promise that resolves when image is reported
+     */
+    reportImage(reference: string, buffer: Buffer): Promise<void>;
+}