testplane 8.42.5 → 8.43.0

package/build/src/runner/suite-monitor.d.ts

@@ -1,5 +1,5 @@
 export = SuiteMonitor;
-declare class SuiteMonitor extends EventEmitter {
+declare class SuiteMonitor extends EventEmitter<[never]> {
     static create(): import("./suite-monitor");
     constructor();
     _suites: Map<any, any>;

package/build/src/test-reader/mocha-reader/mocha-event-bus.d.ts

@@ -1,4 +1,4 @@
-export class MochaEventBus extends EventEmitter {
+export class MochaEventBus extends EventEmitter<[never]> {
     static events: Mocha.SuiteConstants;
     static create(...args: any[]): MochaEventBus;
     constructor(rootSuite: any);

package/build/src/testplane.d.ts

@@ -23,7 +23,7 @@ interface RunOpts {
         enabled: boolean;
         beforeTest: boolean;
         onFail: boolean;
-        port: number;
+        port?: number;
     };
     devtools: boolean;
     local: boolean;

package/build/src/utils/eight-bit-rgba-to-png.d.ts

@@ -1,2 +1,3 @@
 /// <reference types="node" />
+/// <reference types="node" />
 export declare const convertRgbaToPng: (rgba: Buffer, width: number, height: number, compressionLevel?: number) => Buffer;

package/build/src/utils/workers-registry.d.ts

@@ -1,5 +1,5 @@
 export = WorkersRegistry;
-declare class WorkersRegistry extends EventEmitter {
+declare class WorkersRegistry extends EventEmitter<[never]> {
     static create(...args: any[]): import("./workers-registry");
     constructor(config: any);
     _config: any;
@@ -9,7 +9,7 @@ declare class WorkersRegistry extends EventEmitter {
     init(): void;
     end(): Promise<void>;
     isEnded(): boolean;
-    register(workerFilepath: any, exportedMethods: any): EventEmitter;
+    register(workerFilepath: any, exportedMethods: any): EventEmitter<[never]>;
     _createWorkerFarm(): workerFarm.Workers;
     _inspectParams(): {
         workerOptions: {

package/build/src/ws-connection/constants.d.ts

@@ -0,0 +1,13 @@
+export declare const WS_MAX_REQUEST_ID = 2147483647;
+export declare const WS_PING_INTERVAL = 15000;
+export declare const WS_PING_TIMEOUT = 10000;
+export declare const WS_PING_MAX_SUBSEQUENT_FAILS = 2;
+export declare const WS_ERROR_CODE: {
+    readonly MALFORMED_RESPONSE: -32810;
+    readonly SEND_FAILED: -32820;
+    readonly TIMEOUT: -32830;
+    readonly CONNECTION_TERMINATED: -32840;
+    readonly CONNECTION_ESTABLISHMENT: -32850;
+    readonly CONNECTION_BREAK: -32860;
+    readonly PROTOCOL_ERROR: -32680;
+};

package/build/src/ws-connection/constants.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WS_ERROR_CODE = exports.WS_PING_MAX_SUBSEQUENT_FAILS = exports.WS_PING_TIMEOUT = exports.WS_PING_INTERVAL = exports.WS_MAX_REQUEST_ID = void 0;
+exports.WS_MAX_REQUEST_ID = 2147483647; // INT32_MAX
+exports.WS_PING_INTERVAL = 15000; // 15 sec
+exports.WS_PING_TIMEOUT = 10000; // 10 sec
+exports.WS_PING_MAX_SUBSEQUENT_FAILS = 2;
+exports.WS_ERROR_CODE = {
+    MALFORMED_RESPONSE: -32810, // Custom error code
+    SEND_FAILED: -32820, // Custom error code
+    TIMEOUT: -32830, // Custom error code
+    CONNECTION_TERMINATED: -32840, // Custom error code
+    CONNECTION_ESTABLISHMENT: -32850, // Custom error code
+    CONNECTION_BREAK: -32860, // Custom error code
+    PROTOCOL_ERROR: -32680, // Custom error code
+};
+//# sourceMappingURL=constants.js.map

package/build/src/ws-connection/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/ws-connection/constants.ts"],"names":[],"mappings":";;;AAAa,QAAA,iBAAiB,GAAG,UAAU,CAAC,CAAC,YAAY;AAC5C,QAAA,gBAAgB,GAAG,KAAK,CAAC,CAAC,SAAS;AACnC,QAAA,eAAe,GAAG,KAAK,CAAC,CAAC,SAAS;AAClC,QAAA,4BAA4B,GAAG,CAAC,CAAC;AACjC,QAAA,aAAa,GAAG;IACzB,kBAAkB,EAAE,CAAC,KAAK,EAAE,oBAAoB;IAChD,WAAW,EAAE,CAAC,KAAK,EAAE,oBAAoB;IACzC,OAAO,EAAE,CAAC,KAAK,EAAE,oBAAoB;IACrC,qBAAqB,EAAE,CAAC,KAAK,EAAE,oBAAoB;IACnD,wBAAwB,EAAE,CAAC,KAAK,EAAE,oBAAoB;IACtD,gBAAgB,EAAE,CAAC,KAAK,EAAE,oBAAoB;IAC9C,cAAc,EAAE,CAAC,KAAK,EAAE,oBAAoB;CACtC,CAAC"}

package/build/src/ws-connection/error.d.ts

@@ -0,0 +1,51 @@
+export declare abstract class WsError extends Error {
+    code?: number;
+    requestId?: number;
+    constructor({ message, code, requestId }: {
+        message: string;
+        code?: number;
+        requestId?: number;
+    });
+    abstract isRetryable(): boolean;
+}
+export declare class WsConnectionEstablishmentError extends WsError {
+    constructor({ message, requestId }: {
+        message: string;
+        requestId?: number;
+    });
+    isRetryable(): boolean;
+}
+export declare class WsConnectionBreakError extends WsError {
+    constructor({ message, requestId }: {
+        message: string;
+        requestId?: number;
+    });
+    isRetryable(): boolean;
+}
+export declare class WsConnectionTerminatedError extends WsError {
+    constructor({ message, requestId, }?: {
+        message?: string;
+        requestId?: number;
+    });
+    isRetryable(): boolean;
+}
+export declare class WsTimeoutError extends WsError {
+    constructor({ message, requestId }: {
+        message: string;
+        requestId?: number;
+    });
+    isRetryable(): boolean;
+}
+export declare class WsConnectionTimeoutError extends WsTimeoutError {
+    constructor({ message }: {
+        message: string;
+    });
+    isRetryable(): boolean;
+}
+export declare class WsRequestTimeoutError extends WsTimeoutError {
+    constructor({ message, requestId }: {
+        message: string;
+        requestId?: number;
+    });
+    isRetryable(): boolean;
+}

package/build/src/ws-connection/error.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WsRequestTimeoutError = exports.WsConnectionTimeoutError = exports.WsTimeoutError = exports.WsConnectionTerminatedError = exports.WsConnectionBreakError = exports.WsConnectionEstablishmentError = exports.WsError = void 0;
+const constants_1 = require("./constants");
+class WsError extends Error {
+    constructor({ message, code, requestId }) {
+        let errorMessage = message;
+        if (code) {
+            errorMessage += `\n\tErrorCode: ${code}`;
+        }
+        if (requestId) {
+            errorMessage += `\n\tRequest ID: ${requestId}`;
+        }
+        super(errorMessage);
+        this.name = this.constructor.name;
+        this.code = code;
+        this.requestId = requestId;
+    }
+}
+exports.WsError = WsError;
+class WsConnectionEstablishmentError extends WsError {
+    constructor({ message, requestId }) {
+        super({ message, code: constants_1.WS_ERROR_CODE.CONNECTION_ESTABLISHMENT, requestId });
+        this.name = this.constructor.name;
+    }
+    isRetryable() {
+        return true;
+    }
+}
+exports.WsConnectionEstablishmentError = WsConnectionEstablishmentError;
+class WsConnectionBreakError extends WsError {
+    constructor({ message = "WS connection interrupted", requestId }) {
+        super({ message, code: constants_1.WS_ERROR_CODE.CONNECTION_BREAK, requestId });
+        this.name = this.constructor.name;
+    }
+    isRetryable() {
+        return true;
+    }
+}
+exports.WsConnectionBreakError = WsConnectionBreakError;
+class WsConnectionTerminatedError extends WsError {
+    constructor({ message = "WS connection was manually closed", requestId, } = {}) {
+        super({ message, code: constants_1.WS_ERROR_CODE.CONNECTION_TERMINATED, requestId });
+        this.name = this.constructor.name;
+    }
+    isRetryable() {
+        return false;
+    }
+}
+exports.WsConnectionTerminatedError = WsConnectionTerminatedError;
+class WsTimeoutError extends WsError {
+    constructor({ message, requestId }) {
+        super({ message, code: constants_1.WS_ERROR_CODE.TIMEOUT, requestId });
+        this.name = this.constructor.name;
+    }
+    isRetryable() {
+        return true;
+    }
+}
+exports.WsTimeoutError = WsTimeoutError;
+class WsConnectionTimeoutError extends WsTimeoutError {
+    constructor({ message }) {
+        super({ message });
+        this.name = this.constructor.name;
+    }
+    isRetryable() {
+        return true;
+    }
+}
+exports.WsConnectionTimeoutError = WsConnectionTimeoutError;
+class WsRequestTimeoutError extends WsTimeoutError {
+    constructor({ message, requestId }) {
+        super({ message, requestId });
+        this.name = this.constructor.name;
+    }
+    isRetryable() {
+        return true;
+    }
+}
+exports.WsRequestTimeoutError = WsRequestTimeoutError;
+//# sourceMappingURL=error.js.map

package/build/src/ws-connection/error.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error.js","sourceRoot":"","sources":["../../../src/ws-connection/error.ts"],"names":[],"mappings":";;;AAAA,2CAA4C;AAE5C,MAAsB,OAAQ,SAAQ,KAAK;IAIvC,YAAY,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAA0D;QAC5F,IAAI,YAAY,GAAG,OAAO,CAAC;QAE3B,IAAI,IAAI,EAAE,CAAC;YACP,YAAY,IAAI,kBAAkB,IAAI,EAAE,CAAC;QAC7C,CAAC;QAED,IAAI,SAAS,EAAE,CAAC;YACZ,YAAY,IAAI,mBAAmB,SAAS,EAAE,CAAC;QACnD,CAAC;QAED,KAAK,CAAC,YAAY,CAAC,CAAC;QAEpB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;QAClC,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC/B,CAAC;CAGJ;AAvBD,0BAuBC;AAED,MAAa,8BAA+B,SAAQ,OAAO;IACvD,YAAY,EAAE,OAAO,EAAE,SAAS,EAA2C;QACvE,KAAK,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,yBAAa,CAAC,wBAAwB,EAAE,SAAS,EAAE,CAAC,CAAC;QAE5E,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACtC,CAAC;IAED,WAAW;QACP,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AAVD,wEAUC;AAED,MAAa,sBAAuB,SAAQ,OAAO;IAC/C,YAAY,EAAE,OAAO,GAAG,2BAA2B,EAAE,SAAS,EAA2C;QACrG,KAAK,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,yBAAa,CAAC,gBAAgB,EAAE,SAAS,EAAE,CAAC,CAAC;QAEpE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACtC,CAAC;IAED,WAAW;QACP,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AAVD,wDAUC;AAED,MAAa,2BAA4B,SAAQ,OAAO;IACpD,YAAY,EACR,OAAO,GAAG,mCAAmC,EAC7C,SAAS,MACiC,EAAE;QAC5C,KAAK,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,yBAAa,CAAC,qBAAqB,EAAE,SAAS,EAAE,CAAC,CAAC;QAEzE,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACtC,CAAC;IAED,WAAW;QACP,OAAO,KAAK,CAAC;IACjB,CAAC;CACJ;AAbD,kEAaC;AAED,MAAa,cAAe,SAAQ,OAAO;IACvC,YAAY,EAAE,OAAO,EAAE,SAAS,EAA2C;QACvE,KAAK,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,yBAAa,CAAC,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC;QAE3D,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACtC,CAAC;IAED,WAAW;QACP,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AAVD,wCAUC;AAED,MAAa,wBAAyB,SAAQ,cAAc;IACxD,YAAY,EAAE,OAAO,EAAuB;QACxC,KAAK,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;QAEnB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACtC,CAAC;IAED,WAAW;QACP,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AAVD,4DAUC;AAED,MAAa,qBAAsB,SAAQ,cAAc;IACrD,YAAY,EAAE,OAAO,EAAE,SAAS,EAA2C;QACvE,KAAK,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC;QAE9B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;IACtC,CAAC;IAED,WAAW;QACP,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AAVD,sDAUC"}

package/build/src/ws-connection/index.d.ts

@@ -0,0 +1,83 @@
+/// <reference types="node" />
+import { IncomingMessage } from "node:http";
+import { type RawData } from "ws";
+import { WsConnectionTerminatedError, WsError, WsConnectionEstablishmentError, WsConnectionBreakError, WsConnectionTimeoutError, WsRequestTimeoutError } from "./error";
+interface WsConnectionRetries {
+    count: number;
+    baseDelay: number;
+    factor?: number;
+}
+interface WsConnectionTimeouts {
+    createSession: number;
+    request: number;
+}
+interface WsConnectionErrors {
+    ConnectionEstablishment: new (...args: ConstructorParameters<typeof WsConnectionEstablishmentError>) => WsConnectionEstablishmentError;
+    ConnectionTerminated: new (...args: ConstructorParameters<typeof WsConnectionTerminatedError>) => WsConnectionTerminatedError;
+    ConnectionBreak: new (...args: ConstructorParameters<typeof WsConnectionBreakError>) => WsConnectionBreakError;
+    ConnectionTimeout: new (...args: ConstructorParameters<typeof WsConnectionTimeoutError>) => WsConnectionTimeoutError;
+    RequestTimeout: new (...args: ConstructorParameters<typeof WsRequestTimeoutError>) => WsRequestTimeoutError;
+}
+interface WsConnectionOptions {
+    headers?: Record<string, string>;
+    debugFn?: (formatter: any, ...args: any[]) => void;
+    retries?: WsConnectionRetries;
+    timeouts: WsConnectionTimeouts;
+    errors: WsConnectionErrors;
+    onMessage: (data: RawData, isBinary: boolean) => void | Promise<void>;
+}
+export declare class WsConnection<ResponseMessageType = unknown, RequestMessageType extends string | RawData = string | RawData> {
+    private readonly _endpoint;
+    private readonly _requestHeaders?;
+    private readonly _debugFn;
+    private readonly _retries;
+    private readonly _timeouts;
+    private readonly _errors;
+    private readonly _onMessage;
+    private readonly _onResponseHeaders?;
+    private readonly _onReconnect?;
+    private readonly _onDisconnect?;
+    private readonly _onClose?;
+    private _onPong;
+    private _pingShouldSkip;
+    private _pingInterval;
+    private _pingSubsequentFails;
+    private _onConnectionCloseFn;
+    private _wsConnectionStatus;
+    private _wsConnection;
+    private _wsConnectionPromise;
+    private _requestId;
+    private _pendingRequests;
+    constructor(endpoint: string, options: WsConnectionOptions);
+    getConnectionProperties(): Promise<{
+        responseHeaders?: IncomingMessage["headers"];
+    }>;
+    private _responseHeaders?;
+    /** @description Tries to establish ws connection with timeout */
+    private _tryToEstablishWsConnection;
+    /**
+     * @description creates ws connection with retries or returns existing one
+     * @note Concurrent requests with same params produce same ws connection
+     */
+    private _getWsConnection;
+    /** @description Produces connection-"uniq" request ids */
+    getRequestId(): number;
+    /** @description Performs WS request with timeout */
+    makeRequest(requestId: number, requestMessage: RequestMessageType): Promise<ResponseMessageType | WsError>;
+    provideResponseFor(requestId: number, data: ResponseMessageType | WsError): void;
+    forceReconnect(sessionAbortMessage: string): void;
+    /** @description Used to abort all pending requests when connection is closed */
+    private _abortPendingRequests;
+    private _closeWsConnection;
+    /**
+     * @description Tries to re-establish connection after network drops
+     * @note Silently gives up after failed retries attempts
+     */
+    private _tryToReconnect;
+    /** @description Closes websocket connection, terminating all pending requests */
+    close(): void;
+    private _pingHealthCheckStop;
+    private _isWebSocketActive;
+    private _pingHealthCheckStart;
+}
+export {};