@adapt-toolkit/sdk 0.6.0 → 0.6.2

package/dist/utilities/common/web_socket_client.js

@@ -0,0 +1,214 @@
+import { AsyncQueueAdapter } from './async_queue_adapter.js';
+import WebSocket from 'isomorphic-ws';
+import { WebSocketConnection, AdaptProtocolWSConnection } from './web_socket_connection.js';
+import { logging } from './logger/logger.js';
+export const NetworkTimings = {
+    RECONNECT_BASE_DELAY_MS: 500,
+    RECONNECT_MAX_DELAY_MS: 30_000,
+    HEARTBEAT_INTERVAL_MS: 10_000,
+    HEARTBEAT_TIMEOUT_MS: 35_000,
+};
+/*
+    This class is generic client for web socket connection. It connects to server via web socket, and create async queue to process messages from and to server
+
+*/
+class GenericWebSocketClient {
+    server_address;
+    ws;
+    wsconnection;
+    #generation = 0;
+    #reconnect_attempts = 0;
+    #reconnect_timer;
+    #stopped = false;
+    _queue;
+    constructor(server_address, wsconnection) {
+        this._queue = new AsyncQueueAdapter(this.worker.bind(this));
+        this.server_address = server_address;
+        this.wsconnection = wsconnection;
+    }
+    get queue() {
+        return this._queue;
+    }
+    get connected() {
+        return this.ws !== undefined && !this.ws.closed;
+    }
+    /**
+     * Async queue worker. Override this method in child class to create custom behavior of the worker
+     *
+     * @param e Event
+     * @param cb callback to call after event processing done
+     */
+    worker(e, cb) {
+        cb();
+    }
+    ws_start() {
+        if (this.#stopped)
+            return;
+        if (this.#reconnect_timer) {
+            clearTimeout(this.#reconnect_timer);
+            this.#reconnect_timer = undefined;
+        }
+        logging.debug("Attempting to establish web socket connection with: ", this.server_address);
+        const generation = ++this.#generation;
+        let socket;
+        try {
+            socket = new WebSocket(this.server_address);
+        }
+        catch (e) {
+            logging.error("Failed to create web socket for ", this.server_address, ": ", e instanceof Error ? e.message : e);
+            this.#schedule_reconnect();
+            return;
+        }
+        const connection = new this.wsconnection(socket);
+        this.ws = connection;
+        connection.on('open', () => {
+            if (generation !== this.#generation)
+                return;
+            this.#reconnect_attempts = 0;
+            this.queue.resume();
+            this.start_heartbeat();
+            this.on_open();
+        });
+        connection.on('close', (code, reason) => {
+            if (generation !== this.#generation)
+                return;
+            this.stop_heartbeat();
+            this.on_close(code, reason);
+            this.#schedule_reconnect();
+        });
+        connection.on('error', (error) => {
+            if (generation !== this.#generation)
+                return;
+            this.on_error(error);
+        });
+        connection.on('message', (data) => {
+            if (generation !== this.#generation)
+                return;
+            this.on_message(data);
+        });
+    }
+    #schedule_reconnect() {
+        if (this.#stopped || this.#reconnect_timer)
+            return;
+        const backoff = Math.min(NetworkTimings.RECONNECT_MAX_DELAY_MS, NetworkTimings.RECONNECT_BASE_DELAY_MS * 2 ** this.#reconnect_attempts);
+        this.#reconnect_attempts++;
+        const delay = Math.round(backoff * (0.75 + Math.random() * 0.5));
+        logging.debug("Scheduling web socket reconnect to ", this.server_address, " in ", delay, "ms");
+        this.#reconnect_timer = setTimeout(() => {
+            this.#reconnect_timer = undefined;
+            this.ws_start();
+        }, delay);
+    }
+    force_reconnect(reason) {
+        if (this.#stopped)
+            return;
+        logging.warning("Forcing web socket reconnect to ", this.server_address, ": ", reason);
+        const old = this.ws;
+        this.#generation++;
+        this.stop_heartbeat();
+        this.ws = undefined;
+        try {
+            old?.terminate();
+        }
+        catch (e) {
+            logging.debug("Error while terminating web socket: ", e instanceof Error ? e.message : e);
+        }
+        this.on_close(4000, Buffer.from(reason));
+        this.#schedule_reconnect();
+    }
+    stop() {
+        this.#stopped = true;
+        this.#generation++;
+        if (this.#reconnect_timer) {
+            clearTimeout(this.#reconnect_timer);
+            this.#reconnect_timer = undefined;
+        }
+        this.stop_heartbeat();
+        const old = this.ws;
+        this.ws = undefined;
+        try {
+            old?.close();
+        }
+        catch (e) {
+            logging.debug("Error while closing web socket: ", e instanceof Error ? e.message : e);
+        }
+    }
+    start_heartbeat() { }
+    stop_heartbeat() { }
+    /**
+     * Override this method in child class to create 'open' event listener.
+     */
+    on_open() {
+        logging.warning("You forgot to override the on_open method? We have obtained the message in the parent class and don't know what to do with it.");
+    }
+    /**
+     * Override this method in child class to create 'close' event listener.
+     * Reconnection is scheduled by the base class; the override only needs to reset its own state.
+     */
+    on_close(code, reason) {
+        this.queue.pause();
+    }
+    /**
+     * Override this method in child class to create 'error' event listener.
+     */
+    on_error(e) {
+        logging.warning("You forgot to override the on_error method? We have obtained the message in the parent class and don't know what to do with it.");
+    }
+    /**
+     * Override this method in child class to create 'message' event listener.
+     * @param data Data received from socket
+     */
+    on_message(data) {
+        logging.warning("You forgot to override the on_mesasge method? We have obtained the message in the parent class and don't know what to do with it.");
+    }
+}
+export class WebSocketClient extends GenericWebSocketClient {
+    constructor(server_address) {
+        super(server_address, WebSocketConnection);
+    }
+}
+export class AdaptProtocolWebSocketClient extends GenericWebSocketClient {
+    heartbeat_enabled = false;
+    #heartbeat_timer;
+    constructor(server_address) {
+        super(server_address, AdaptProtocolWSConnection);
+    }
+    start_heartbeat() {
+        if (!this.heartbeat_enabled || !this.ws)
+            return;
+        this.stop_heartbeat();
+        const connection = this.ws;
+        connection.touch();
+        try {
+            connection.send_heartbeat_ping();
+        }
+        catch (e) {
+            logging.debug("Failed to send heartbeat ping: ", e instanceof Error ? e.message : e);
+        }
+        this.#heartbeat_timer = setInterval(() => {
+            if (this.ws !== connection) {
+                this.stop_heartbeat();
+                return;
+            }
+            if (Date.now() - connection.last_activity_ms > NetworkTimings.HEARTBEAT_TIMEOUT_MS) {
+                this.force_reconnect("no data received within heartbeat timeout");
+                return;
+            }
+            try {
+                connection.send_heartbeat_ping();
+            }
+            catch (e) {
+                logging.debug("Failed to send heartbeat ping: ", e instanceof Error ? e.message : e);
+            }
+        }, NetworkTimings.HEARTBEAT_INTERVAL_MS);
+        if (typeof this.#heartbeat_timer?.unref === 'function')
+            this.#heartbeat_timer.unref();
+    }
+    stop_heartbeat() {
+        if (this.#heartbeat_timer) {
+            clearInterval(this.#heartbeat_timer);
+            this.#heartbeat_timer = undefined;
+        }
+    }
+}
+//# sourceMappingURL=web_socket_client.js.map

package/dist/utilities/common/web_socket_client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web_socket_client.js","sourceRoot":"","sources":["../../../src/utilities/common/web_socket_client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAA;AAC5D,OAAO,SAAS,MAAM,eAAe,CAAA;AACrC,OAAO,EAAE,mBAAmB,EAAE,yBAAyB,EAAiB,MAAM,4BAA4B,CAAA;AAG1G,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAC;AAE7C,MAAM,CAAC,MAAM,cAAc,GAAG;IAC1B,uBAAuB,EAAE,GAAG;IAC5B,sBAAsB,EAAE,MAAM;IAC9B,qBAAqB,EAAE,MAAM;IAC7B,oBAAoB,EAAE,MAAM;CAC/B,CAAA;AAED;;;EAGE;AACF,MAAM,sBAAsB;IACd,cAAc,CAAS;IACvB,EAAE,CAAK;IACjB,YAAY,CAA+B;IAE3C,WAAW,GAAW,CAAC,CAAA;IACvB,mBAAmB,GAAW,CAAC,CAAA;IAC/B,gBAAgB,CAAgC;IAChD,QAAQ,GAAY,KAAK,CAAA;IAEjB,MAAM,CAA+B;IAE7C,YAAY,cAAsB,EAAE,YAA2C;QAC3E,IAAI,CAAC,MAAM,GAAG,IAAI,iBAAiB,CAAY,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACvE,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,YAAY,GAAG,YAAY,CAAA;IACpC,CAAC;IAED,IAAI,KAAK;QACL,OAAO,IAAI,CAAC,MAAM,CAAC;IACvB,CAAC;IAED,IAAI,SAAS;QACT,OAAO,IAAI,CAAC,EAAE,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAA;IACnD,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,CAAY,EAAE,EAAuB;QACxC,EAAE,EAAE,CAAC;IACT,CAAC;IAED,QAAQ;QACJ,IAAI,IAAI,CAAC,QAAQ;YACb,OAAM;QACV,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACxB,YAAY,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;YACnC,IAAI,CAAC,gBAAgB,GAAG,SAAS,CAAA;QACrC,CAAC;QAED,OAAO,CAAC,KAAK,CAAC,sDAAsD,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAE3F,MAAM,UAAU,GAAG,EAAE,IAAI,CAAC,WAAW,CAAA;QAErC,IAAI,MAAiB,CAAA;QACrB,IAAI,CAAC;YACD,MAAM,GAAG,IAAI,SAAS,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;QAC/C,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACT,OAAO,CAAC,KAAK,CAAC,kCAAkC,EAAE,IAAI,CAAC,cAAc,EAAE,IAAI,EAAE,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;YAChH,IAAI,CAAC,mBAAmB,EAAE,CAAA;YAC1B,OAAM;QACV,CAAC;QAED,MAAM,UAAU,GAAG,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,CAAC,CAAA;QAChD,IAAI,CAAC,EAAE,GAAG,UAAU,CAAA;QAEpB,UAAU,CAAC,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE;YACvB,IAAI,UAAU,KAAK,IAAI,CAAC,WAAW;gBAAE,OAAM;YAC3C,IAAI,CAAC,mBAAmB,GAAG,CAAC,CAAA;YAC5B,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,CAAA;YACnB,IAAI,CAAC,eAAe,EAAE,CAAA;YACtB,IAAI,CAAC,OAAO,EAAE,CAAA;QAClB,CAAC,CAAC,CAAA;QACF,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,IAAY,EAAE,MAAc,EAAE,EAAE;YACpD,IAAI,UAAU,KAAK,IAAI,CAAC,WAAW;gBAAE,OAAM;YAC3C,IAAI,CAAC,cAAc,EAAE,CAAA;YACrB,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;YAC3B,IAAI,CAAC,mBAAmB,EAAE,CAAA;QAC9B,CAAC,CAAC,CAAA;QACF,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAY,EAAE,EAAE;YACpC,IAAI,UAAU,KAAK,IAAI,CAAC,WAAW;gBAAE,OAAM;YAC3C,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAA;QACxB,CAAC,CAAC,CAAA;QACF,UAAU,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,IAAmB,EAAE,EAAE;YAC7C,IAAI,UAAU,KAAK,IAAI,CAAC,WAAW;gBAAE,OAAM;YAC3C,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;QACzB,CAAC,CAAC,CAAA;IACN,CAAC;IAED,mBAAmB;QACf,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,gBAAgB;YACtC,OAAM;QACV,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CACpB,cAAc,CAAC,sBAAsB,EACrC,cAAc,CAAC,uBAAuB,GAAG,CAAC,IAAI,IAAI,CAAC,mBAAmB,CACzE,CAAA;QACD,IAAI,CAAC,mBAAmB,EAAE,CAAA;QAC1B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,GAAG,CAAC,IAAI,GAAG,IAAI,CAAC,MAAM,EAAE,GAAG,GAAG,CAAC,CAAC,CAAA;QAChE,OAAO,CAAC,KAAK,CAAC,qCAAqC,EAAE,IAAI,CAAC,cAAc,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAA;QAC9F,IAAI,CAAC,gBAAgB,GAAG,UAAU,CAAC,GAAG,EAAE;YACpC,IAAI,CAAC,gBAAgB,GAAG,SAAS,CAAA;YACjC,IAAI,CAAC,QAAQ,EAAE,CAAA;QACnB,CAAC,EAAE,KAAK,CAAC,CAAA;IACb,CAAC;IAES,eAAe,CAAC,MAAc;QACpC,IAAI,IAAI,CAAC,QAAQ;YACb,OAAM;QACV,OAAO,CAAC,OAAO,CAAC,kCAAkC,EAAE,IAAI,CAAC,cAAc,EAAE,IAAI,EAAE,MAAM,CAAC,CAAA;QACtF,MAAM,GAAG,GAAG,IAAI,CAAC,EAAE,CAAA;QACnB,IAAI,CAAC,WAAW,EAAE,CAAA;QAClB,IAAI,CAAC,cAAc,EAAE,CAAA;QACrB,IAAI,CAAC,EAAE,GAAG,SAAS,CAAA;QACnB,IAAI,CAAC;YACD,GAAG,EAAE,SAAS,EAAE,CAAA;QACpB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACT,OAAO,CAAC,KAAK,CAAC,sCAAsC,EAAE,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QAC7F,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAA;QACxC,IAAI,CAAC,mBAAmB,EAAE,CAAA;IAC9B,CAAC;IAED,IAAI;QACA,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;QACpB,IAAI,CAAC,WAAW,EAAE,CAAA;QAClB,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACxB,YAAY,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;YACnC,IAAI,CAAC,gBAAgB,GAAG,SAAS,CAAA;QACrC,CAAC;QACD,IAAI,CAAC,cAAc,EAAE,CAAA;QACrB,MAAM,GAAG,GAAG,IAAI,CAAC,EAAE,CAAA;QACnB,IAAI,CAAC,EAAE,GAAG,SAAS,CAAA;QACnB,IAAI,CAAC;YACD,GAAG,EAAE,KAAK,EAAE,CAAA;QAChB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACT,OAAO,CAAC,KAAK,CAAC,kCAAkC,EAAE,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QACzF,CAAC;IACL,CAAC;IAES,eAAe,KAAK,CAAC;IAErB,cAAc,KAAK,CAAC;IAE9B;;OAEG;IACH,OAAO;QACH,OAAO,CAAC,OAAO,CAAC,gIAAgI,CAAC,CAAA;IACrJ,CAAC;IAED;;;OAGG;IACH,QAAQ,CAAC,IAAY,EAAE,MAAc;QACjC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAA;IACtB,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,CAAQ;QACb,OAAO,CAAC,OAAO,CAAC,iIAAiI,CAAC,CAAA;IACtJ,CAAC;IAED;;;OAGG;IACH,UAAU,CAAC,IAAmB;QAC1B,OAAO,CAAC,OAAO,CAAC,mIAAmI,CAAC,CAAA;IACxJ,CAAC;CAEJ;AAED,MAAM,OAAO,eAA2B,SAAQ,sBAA2D;IACvG,YAAY,cAAsB;QAC9B,KAAK,CAAC,cAAc,EAAE,mBAAmB,CAAC,CAAA;IAC9C,CAAC;CACJ;AAED,MAAM,OAAO,4BAAwC,SAAQ,sBAA2E;IAE1H,iBAAiB,GAAY,KAAK,CAAA;IAC5C,gBAAgB,CAAiC;IAEjD,YAAY,cAAsB;QAC9B,KAAK,CAAC,cAAc,EAAE,yBAAyB,CAAC,CAAC;IACrD,CAAC;IAEkB,eAAe;QAC9B,IAAI,CAAC,IAAI,CAAC,iBAAiB,IAAI,CAAC,IAAI,CAAC,EAAE;YACnC,OAAM;QACV,IAAI,CAAC,cAAc,EAAE,CAAA;QACrB,MAAM,UAAU,GAAG,IAAI,CAAC,EAAE,CAAA;QAC1B,UAAU,CAAC,KAAK,EAAE,CAAA;QAClB,IAAI,CAAC;YACD,UAAU,CAAC,mBAAmB,EAAE,CAAA;QACpC,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACT,OAAO,CAAC,KAAK,CAAC,iCAAiC,EAAE,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;QACxF,CAAC;QACD,IAAI,CAAC,gBAAgB,GAAG,WAAW,CAAC,GAAG,EAAE;YACrC,IAAI,IAAI,CAAC,EAAE,KAAK,UAAU,EAAE,CAAC;gBACzB,IAAI,CAAC,cAAc,EAAE,CAAA;gBACrB,OAAM;YACV,CAAC;YACD,IAAI,IAAI,CAAC,GAAG,EAAE,GAAG,UAAU,CAAC,gBAAgB,GAAG,cAAc,CAAC,oBAAoB,EAAE,CAAC;gBACjF,IAAI,CAAC,eAAe,CAAC,2CAA2C,CAAC,CAAA;gBACjE,OAAM;YACV,CAAC;YACD,IAAI,CAAC;gBACD,UAAU,CAAC,mBAAmB,EAAE,CAAA;YACpC,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACT,OAAO,CAAC,KAAK,CAAC,iCAAiC,EAAE,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;YACxF,CAAC;QACL,CAAC,EAAE,cAAc,CAAC,qBAAqB,CAAC,CAAA;QACxC,IAAI,OAAQ,IAAI,CAAC,gBAAwB,EAAE,KAAK,KAAK,UAAU;YAC1D,IAAI,CAAC,gBAAwB,CAAC,KAAK,EAAE,CAAA;IAC9C,CAAC;IAEkB,cAAc;QAC7B,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACxB,aAAa,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAA;YACpC,IAAI,CAAC,gBAAgB,GAAG,SAAS,CAAA;QACrC,CAAC;IACL,CAAC;CACJ"}

package/dist/utilities/common/web_socket_connection.d.ts

@@ -0,0 +1,58 @@
+import WebSocket from 'isomorphic-ws';
+import { AdaptValue } from '@adapt-toolkit/sdk/backend';
+import type { Protocol } from '../../wrapper/protocol/protocol.js';
+/**
+ * A decoded inbound transport frame handed to the message callback. The payload
+ * is left unparsed so the broker relay path can forward it verbatim; consumers
+ * that need the inner message call parsePayload().
+ */
+export interface IncomingFrame {
+    type: Protocol.MessageName;
+    toHex: string;
+    frame: Uint8Array;
+    payload: Uint8Array;
+    parsePayload(): AdaptValue;
+}
+declare class GenericWebSocketConnection<OnMessageType> {
+    protected socket: WebSocket;
+    constructor(socket: WebSocket);
+    send(data: any): void;
+    pause(): void;
+    resume(): void;
+    close(): void;
+    terminate(): void;
+    get closed(): boolean;
+    protected on_message(cb: (data: any) => void): void;
+    protected on_close(cb: (code: number, reason: string) => void): void;
+    protected on_error(cb: (error: Error) => void): void;
+    protected on_open(cb: () => void): void;
+    private event_to_function_map;
+    on(event: 'message', cb: (data: OnMessageType) => void): void;
+    on(event: 'close', cb: (code: number, reason: Buffer) => void): void;
+    on(event: 'error', cb: (error: Error) => void): void;
+    on(event: 'open', cb: () => void): void;
+    on<A extends OnMessageType | Error | undefined | number, B extends (A extends undefined ? undefined : (A extends number ? Buffer : undefined))>(event: 'message' | 'close' | 'error' | 'open', cb: (a?: A, b?: B) => void): void;
+}
+export declare class WebSocketConnection extends GenericWebSocketConnection<any> {
+}
+export declare class AdaptProtocolWSConnection extends GenericWebSocketConnection<IncomingFrame> {
+    #private;
+    constructor(socket: WebSocket, validate_incoming?: boolean);
+    get last_activity_ms(): number;
+    get heartbeat_received(): boolean;
+    get bytes_in(): number;
+    get bytes_out(): number;
+    get messages_in(): number;
+    get messages_out(): number;
+    touch(): void;
+    /** Serialize an inner message and send it wrapped in a transport frame. */
+    send_message(type: Protocol.MessageName, to: Uint8Array | null, payload: AdaptValue): void;
+    /** Send an already-encoded frame verbatim (broker relay forward path). */
+    send_frame(frame: Uint8Array): void;
+    send_heartbeat_ping(): void;
+    private normalize;
+    private parse_payload;
+    on_message(cb: (frame: IncomingFrame) => void): void;
+}
+export {};
+//# sourceMappingURL=web_socket_connection.d.ts.map

package/dist/utilities/common/web_socket_connection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"web_socket_connection.d.ts","sourceRoot":"","sources":["../../../src/utilities/common/web_socket_connection.ts"],"names":[],"mappings":"AACA,OAAO,SAAS,MAAM,eAAe,CAAA;AACrC,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAErC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,oCAAoC,CAAA;AAMlE;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC1B,IAAI,EAAE,QAAQ,CAAC,WAAW,CAAA;IAC1B,KAAK,EAAE,MAAM,CAAA;IACb,KAAK,EAAE,UAAU,CAAA;IACjB,OAAO,EAAE,UAAU,CAAA;IACnB,YAAY,IAAI,UAAU,CAAA;CAC7B;AAiBD,cAAM,0BAA0B,CAAC,aAAa;IAC9B,SAAS,CAAC,MAAM,EAAE,SAAS;gBAAjB,MAAM,EAAE,SAAS;IAEvC,IAAI,CAAC,IAAI,EAAE,GAAG;IAId,KAAK;IAML,MAAM;IAMN,KAAK;IAKL,SAAS;IAQT,IAAI,MAAM,IAAI,OAAO,CAEpB;IAED,SAAS,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC,IAAI,EAAE,GAAG,KAAK,IAAI;IAM5C,SAAS,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI;IAM7D,SAAS,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI;IAM7C,SAAS,CAAC,OAAO,CAAC,EAAE,EAAE,MAAM,IAAI;IAMhC,OAAO,CAAC,qBAAqB,CAK5B;IAED,EAAE,CAAC,KAAK,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,IAAI,EAAE,aAAa,KAAK,IAAI,GAAG,IAAI;IAC7D,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI;IACpE,EAAE,CAAC,KAAK,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,GAAG,IAAI;IACpD,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,IAAI,GAAG,IAAI;IACvC,EAAE,CAAC,CAAC,SAAS,aAAa,GAAG,KAAK,GAAG,SAAS,GAAG,MAAM,EACnD,CAAC,SACD,CAAC,CAAC,SAAS,SAAS,GAChB,SAAS,GACT,CAAC,CAAC,SAAS,MAAM,GACb,MAAM,GACN,SAAS,CAAC,CAAC,EAClB,KAAK,EAAE,SAAS,GAAG,OAAO,GAAG,OAAO,GAAG,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,IAAI,GAAG,IAAI;CAIxF;AAED,qBAAa,mBAAoB,SAAQ,0BAA0B,CAAC,GAAG,CAAC;CAAI;AAE5E,qBAAa,yBAA0B,SAAQ,0BAA0B,CAAC,aAAa,CAAC;;gBAWxE,MAAM,EAAE,SAAS,EAAE,iBAAiB,GAAE,OAAc;IAKhE,IAAI,gBAAgB,IAAI,MAAM,CAE7B;IAED,IAAI,kBAAkB,IAAI,OAAO,CAEhC;IAED,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED,IAAI,SAAS,IAAI,MAAM,CAEtB;IAED,IAAI,WAAW,IAAI,MAAM,CAExB;IAED,IAAI,YAAY,IAAI,MAAM,CAEzB;IAED,KAAK;IAIL,2EAA2E;IAC3E,YAAY,CAAC,IAAI,EAAE,QAAQ,CAAC,WAAW,EAAE,EAAE,EAAE,UAAU,GAAG,IAAI,EAAE,OAAO,EAAE,UAAU;IAQnF,0EAA0E;IAC1E,UAAU,CAAC,KAAK,EAAE,UAAU;IAM5B,mBAAmB;YAIL,SAAS;IAevB,OAAO,CAAC,aAAa;IAoBZ,UAAU,CAAC,EAAE,EAAE,CAAC,KAAK,EAAE,aAAa,KAAK,IAAI;CAgCzD"}

package/dist/utilities/common/web_socket_connection.js

@@ -0,0 +1,204 @@
+import * as addon_wrapper from '../../wrapper/index.js';
+import { encodeFrame, decodeFrame } from '../../wrapper/protocol/broker_frame.js';
+import { AdaptProtocolError, AdaptProtocolErrorType } from './errors/adapt_protocol_error.js';
+import { logging } from './logger/logger.js';
+const HEARTBEAT_MAGIC = new Uint8Array([0x41, 0x44, 0x50, 0x54, 0x2d, 0x48, 0x42, 0x31]); // "ADPT-HB1"
+const HEARTBEAT_PING_FRAME = new Uint8Array([...HEARTBEAT_MAGIC, 0x01]);
+const HEARTBEAT_PONG_FRAME = new Uint8Array([...HEARTBEAT_MAGIC, 0x02]);
+function heartbeat_frame_type(data) {
+    if (data.length !== HEARTBEAT_PING_FRAME.length)
+        return undefined;
+    for (let i = 0; i < HEARTBEAT_MAGIC.length; i++)
+        if (data[i] !== HEARTBEAT_MAGIC[i])
+            return undefined;
+    if (data[HEARTBEAT_MAGIC.length] === 0x01)
+        return 'ping';
+    if (data[HEARTBEAT_MAGIC.length] === 0x02)
+        return 'pong';
+    return undefined;
+}
+class GenericWebSocketConnection {
+    socket;
+    constructor(socket) {
+        this.socket = socket;
+    }
+    send(data) {
+        this.socket.send(data);
+    }
+    pause() {
+        const socket = this.socket;
+        if (typeof socket.pause === 'function')
+            socket.pause();
+    }
+    resume() {
+        const socket = this.socket;
+        if (typeof socket.resume === 'function')
+            socket.resume();
+    }
+    close() {
+        if (this.socket.readyState != this.socket.CLOSED)
+            this.socket.close();
+    }
+    terminate() {
+        const socket = this.socket;
+        if (typeof socket.terminate === 'function')
+            socket.terminate();
+        else
+            this.close();
+    }
+    get closed() {
+        return this.socket.readyState === this.socket.CLOSED;
+    }
+    on_message(cb) {
+        this.socket.addEventListener('message', (event) => {
+            cb(event.data);
+        });
+    }
+    on_close(cb) {
+        this.socket.addEventListener('close', (event) => {
+            cb(event.code, event.reason);
+        });
+    }
+    on_error(cb) {
+        this.socket.addEventListener('error', (event) => {
+            cb(event.error);
+        });
+    }
+    on_open(cb) {
+        this.socket.addEventListener('open', (event) => {
+            cb();
+        });
+    }
+    event_to_function_map = {
+        'message': this.on_message.bind(this),
+        'close': this.on_close.bind(this),
+        'error': this.on_error.bind(this),
+        'open': this.on_open.bind(this)
+    };
+    on(event, cb) {
+        this.event_to_function_map[event](cb);
+    }
+}
+export class WebSocketConnection extends GenericWebSocketConnection {
+}
+export class AdaptProtocolWSConnection extends GenericWebSocketConnection {
+    #last_activity_ms = Date.now();
+    #heartbeat_received = false;
+    #bytes_in = 0;
+    #bytes_out = 0;
+    #messages_in = 0;
+    #messages_out = 0;
+    #validate_incoming;
+    constructor(socket, validate_incoming = true) {
+        super(socket);
+        this.#validate_incoming = validate_incoming;
+    }
+    get last_activity_ms() {
+        return this.#last_activity_ms;
+    }
+    get heartbeat_received() {
+        return this.#heartbeat_received;
+    }
+    get bytes_in() {
+        return this.#bytes_in;
+    }
+    get bytes_out() {
+        return this.#bytes_out;
+    }
+    get messages_in() {
+        return this.#messages_in;
+    }
+    get messages_out() {
+        return this.#messages_out;
+    }
+    touch() {
+        this.#last_activity_ms = Date.now();
+    }
+    /** Serialize an inner message and send it wrapped in a transport frame. */
+    send_message(type, to, payload) {
+        const inner = payload.Serialize();
+        const frame = encodeFrame(type, to, inner instanceof Uint8Array ? inner : new Uint8Array(inner));
+        this.#bytes_out += frame.length;
+        this.#messages_out += 1;
+        super.send(frame);
+    }
+    /** Send an already-encoded frame verbatim (broker relay forward path). */
+    send_frame(frame) {
+        this.#bytes_out += frame.length;
+        this.#messages_out += 1;
+        super.send(frame);
+    }
+    send_heartbeat_ping() {
+        super.send(HEARTBEAT_PING_FRAME);
+    }
+    async normalize(data) {
+        if (data.data) {
+            data = data.data;
+            if (data.arrayBuffer)
+                data = new Uint8Array(await data.arrayBuffer()); // TODO: ensure, that data has type window.Blob
+        }
+        if (addon_wrapper.determine_environment() === "wasm" && data instanceof globalThis.Blob) {
+            data = new Uint8Array(await data.arrayBuffer());
+        }
+        if (!(data instanceof Uint8Array)) {
+            throw new AdaptProtocolError(AdaptProtocolErrorType.INVALID_MESSAGE, "Invalid type of the message. Expected subclass of Uint8Array, but observed: " + data);
+        }
+        return data;
+    }
+    parse_payload(payload) {
+        let value;
+        try {
+            value = addon_wrapper.Protocol.GetProtocolContainer().ParseValue(Buffer.from(payload));
+            value.Detach();
+        }
+        catch (e) {
+            const message = e instanceof Error ? e.message : e;
+            throw new AdaptProtocolError(AdaptProtocolErrorType.INVALID_MESSAGE, `Failed to parse value: ${message}`);
+        }
+        if (this.#validate_incoming) {
+            try {
+                addon_wrapper.Protocol.Validate(value);
+            }
+            catch (e) {
+                const message = e instanceof Error ? e.message : e;
+                throw new AdaptProtocolError(AdaptProtocolErrorType.INVALID_MESSAGE, `Protocol message validation failure: ${message}`);
+            }
+        }
+        return value;
+    }
+    on_message(cb) {
+        super.on_message(async (data) => {
+            try {
+                const bytes = await this.normalize(data);
+                this.touch();
+                const heartbeat = heartbeat_frame_type(bytes);
+                if (heartbeat) {
+                    if (heartbeat === 'ping') {
+                        this.#heartbeat_received = true;
+                        try {
+                            super.send(HEARTBEAT_PONG_FRAME);
+                        }
+                        catch (e) {
+                            logging.debug("Failed to respond to heartbeat ping:", e instanceof Error ? e.message : e);
+                        }
+                    }
+                    return;
+                }
+                this.#bytes_in += bytes.length;
+                this.#messages_in += 1;
+                const decoded = decodeFrame(bytes);
+                cb({
+                    type: decoded.type,
+                    toHex: decoded.toHex,
+                    frame: bytes,
+                    payload: decoded.payload,
+                    parsePayload: () => this.parse_payload(decoded.payload),
+                });
+            }
+            catch (e) {
+                logging.error("Failed to process incoming web socket message:", e instanceof Error ? e.message : e);
+            }
+        });
+    }
+}
+//# sourceMappingURL=web_socket_connection.js.map

package/dist/utilities/common/web_socket_connection.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"web_socket_connection.js","sourceRoot":"","sources":["../../../src/utilities/common/web_socket_connection.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,aAAa,MAAM,wBAAwB,CAAA;AAEvD,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,wCAAwC,CAAA;AACjF,OAAO,EAAE,kBAAkB,EAAE,sBAAsB,EAAE,MAAM,kCAAkC,CAAA;AAC7F,OAAO,EAAE,OAAO,EAAE,MAAM,oBAAoB,CAAA;AAgB5C,MAAM,eAAe,GAAG,IAAI,UAAU,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA,CAAC,aAAa;AACtG,MAAM,oBAAoB,GAAG,IAAI,UAAU,CAAC,CAAC,GAAG,eAAe,EAAE,IAAI,CAAC,CAAC,CAAA;AACvE,MAAM,oBAAoB,GAAG,IAAI,UAAU,CAAC,CAAC,GAAG,eAAe,EAAE,IAAI,CAAC,CAAC,CAAA;AAEvE,SAAS,oBAAoB,CAAC,IAAgB;IAC1C,IAAI,IAAI,CAAC,MAAM,KAAK,oBAAoB,CAAC,MAAM;QAC3C,OAAO,SAAS,CAAA;IACpB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,eAAe,CAAC,MAAM,EAAE,CAAC,EAAE;QAC3C,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,eAAe,CAAC,CAAC,CAAC;YAC9B,OAAO,SAAS,CAAA;IACxB,IAAI,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,KAAK,IAAI;QAAE,OAAO,MAAM,CAAA;IACxD,IAAI,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,KAAK,IAAI;QAAE,OAAO,MAAM,CAAA;IACxD,OAAO,SAAS,CAAA;AACpB,CAAC;AAED,MAAM,0BAA0B;IACN;IAAtB,YAAsB,MAAiB;QAAjB,WAAM,GAAN,MAAM,CAAW;IAAI,CAAC;IAE5C,IAAI,CAAC,IAAS;QACV,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAC1B,CAAC;IAED,KAAK;QACD,MAAM,MAAM,GAAG,IAAI,CAAC,MAAa,CAAA;QACjC,IAAI,OAAO,MAAM,CAAC,KAAK,KAAK,UAAU;YAClC,MAAM,CAAC,KAAK,EAAE,CAAA;IACtB,CAAC;IAED,MAAM;QACF,MAAM,MAAM,GAAG,IAAI,CAAC,MAAa,CAAA;QACjC,IAAI,OAAO,MAAM,CAAC,MAAM,KAAK,UAAU;YACnC,MAAM,CAAC,MAAM,EAAE,CAAA;IACvB,CAAC;IAED,KAAK;QACD,IAAI,IAAI,CAAC,MAAM,CAAC,UAAU,IAAI,IAAI,CAAC,MAAM,CAAC,MAAM;YAC5C,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAA;IAC3B,CAAC;IAED,SAAS;QACL,MAAM,MAAM,GAAG,IAAI,CAAC,MAAa,CAAA;QACjC,IAAI,OAAO,MAAM,CAAC,SAAS,KAAK,UAAU;YACtC,MAAM,CAAC,SAAS,EAAE,CAAA;;YAElB,IAAI,CAAC,KAAK,EAAE,CAAA;IACpB,CAAC;IAED,IAAI,MAAM;QACN,OAAO,IAAI,CAAC,MAAM,CAAC,UAAU,KAAK,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;IACzD,CAAC;IAES,UAAU,CAAC,EAAuB;QACxC,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,KAA6B,EAAE,EAAE;YACtE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QAClB,CAAC,CAAC,CAAA;IACN,CAAC;IAES,QAAQ,CAAC,EAA0C;QACzD,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,KAA2B,EAAE,EAAE;YAClE,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QACjC,CAAC,CAAC,CAAA;IACN,CAAC;IAES,QAAQ,CAAC,EAA0B;QACzC,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,KAA2B,EAAE,EAAE;YAClE,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;QACnB,CAAC,CAAC,CAAA;IACN,CAAC;IAES,OAAO,CAAC,EAAc;QAC5B,IAAI,CAAC,MAAM,CAAC,gBAAgB,CAAC,MAAM,EAAE,CAAC,KAAsB,EAAE,EAAE;YAC5D,EAAE,EAAE,CAAA;QACR,CAAC,CAAC,CAAA;IACN,CAAC;IAEO,qBAAqB,GAAG;QAC5B,SAAS,EAAE,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC;QACrC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;QACjC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC;QACjC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;KAClC,CAAA;IAcD,EAAE,CAAC,KAA6C,EAAE,EAAO;QACrD,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAA;IACzC,CAAC;CACJ;AAED,MAAM,OAAO,mBAAoB,SAAQ,0BAA+B;CAAI;AAE5E,MAAM,OAAO,yBAA0B,SAAQ,0BAAyC;IAEpF,iBAAiB,GAAW,IAAI,CAAC,GAAG,EAAE,CAAA;IACtC,mBAAmB,GAAY,KAAK,CAAA;IACpC,SAAS,GAAW,CAAC,CAAA;IACrB,UAAU,GAAW,CAAC,CAAA;IACtB,YAAY,GAAW,CAAC,CAAA;IACxB,aAAa,GAAW,CAAC,CAAA;IAEzB,kBAAkB,CAAS;IAE3B,YAAY,MAAiB,EAAE,oBAA6B,IAAI;QAC5D,KAAK,CAAC,MAAM,CAAC,CAAA;QACb,IAAI,CAAC,kBAAkB,GAAG,iBAAiB,CAAA;IAC/C,CAAC;IAED,IAAI,gBAAgB;QAChB,OAAO,IAAI,CAAC,iBAAiB,CAAA;IACjC,CAAC;IAED,IAAI,kBAAkB;QAClB,OAAO,IAAI,CAAC,mBAAmB,CAAA;IACnC,CAAC;IAED,IAAI,QAAQ;QACR,OAAO,IAAI,CAAC,SAAS,CAAA;IACzB,CAAC;IAED,IAAI,SAAS;QACT,OAAO,IAAI,CAAC,UAAU,CAAA;IAC1B,CAAC;IAED,IAAI,WAAW;QACX,OAAO,IAAI,CAAC,YAAY,CAAA;IAC5B,CAAC;IAED,IAAI,YAAY;QACZ,OAAO,IAAI,CAAC,aAAa,CAAA;IAC7B,CAAC;IAED,KAAK;QACD,IAAI,CAAC,iBAAiB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;IACvC,CAAC;IAED,2EAA2E;IAC3E,YAAY,CAAC,IAA0B,EAAE,EAAqB,EAAE,OAAmB;QAC/E,MAAM,KAAK,GAAG,OAAO,CAAC,SAAS,EAAE,CAAA;QACjC,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,EAAE,EAAE,EAAE,KAAK,YAAY,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC,CAAA;QAChG,IAAI,CAAC,UAAU,IAAI,KAAK,CAAC,MAAM,CAAA;QAC/B,IAAI,CAAC,aAAa,IAAI,CAAC,CAAA;QACvB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACrB,CAAC;IAED,0EAA0E;IAC1E,UAAU,CAAC,KAAiB;QACxB,IAAI,CAAC,UAAU,IAAI,KAAK,CAAC,MAAM,CAAA;QAC/B,IAAI,CAAC,aAAa,IAAI,CAAC,CAAA;QACvB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACrB,CAAC;IAED,mBAAmB;QACf,KAAK,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAA;IACpC,CAAC;IAEO,KAAK,CAAC,SAAS,CAAC,IAAS;QAC7B,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACZ,IAAI,GAAG,IAAI,CAAC,IAAI,CAAA;YAChB,IAAI,IAAI,CAAC,WAAW;gBAChB,IAAI,GAAG,IAAI,UAAU,CAAC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,+CAA+C;QACxG,CAAC;QACD,IAAI,aAAa,CAAC,qBAAqB,EAAE,KAAK,MAAM,IAAI,IAAI,YAAa,UAAkB,CAAC,IAAI,EAAE,CAAC;YAC/F,IAAI,GAAG,IAAI,UAAU,CAAC,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC,CAAA;QACnD,CAAC;QACD,IAAI,CAAC,CAAC,IAAI,YAAY,UAAU,CAAC,EAAE,CAAC;YAChC,MAAM,IAAI,kBAAkB,CAAC,sBAAsB,CAAC,eAAe,EAAE,8EAA8E,GAAG,IAAI,CAAC,CAAA;QAC/J,CAAC;QACD,OAAO,IAAI,CAAA;IACf,CAAC;IAEO,aAAa,CAAC,OAAmB;QACrC,IAAI,KAAiB,CAAA;QACrB,IAAI,CAAC;YACD,KAAK,GAAG,aAAa,CAAC,QAAQ,CAAC,oBAAoB,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAA;YACtF,KAAK,CAAC,MAAM,EAAE,CAAC;QACnB,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACT,MAAM,OAAO,GAAG,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;YACnD,MAAM,IAAI,kBAAkB,CAAC,sBAAsB,CAAC,eAAe,EAAE,0BAA0B,OAAO,EAAE,CAAC,CAAA;QAC7G,CAAC;QACD,IAAI,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAC1B,IAAI,CAAC;gBACD,aAAa,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAC3C,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACT,MAAM,OAAO,GAAG,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;gBACnD,MAAM,IAAI,kBAAkB,CAAC,sBAAsB,CAAC,eAAe,EAAE,wCAAwC,OAAO,EAAE,CAAC,CAAA;YAC3H,CAAC;QACL,CAAC;QACD,OAAO,KAAK,CAAA;IAChB,CAAC;IAEQ,UAAU,CAAC,EAAkC;QAClD,KAAK,CAAC,UAAU,CAAC,KAAK,EAAC,IAAI,EAAC,EAAE;YAC1B,IAAI,CAAC;gBACD,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;gBACxC,IAAI,CAAC,KAAK,EAAE,CAAA;gBACZ,MAAM,SAAS,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAA;gBAC7C,IAAI,SAAS,EAAE,CAAC;oBACZ,IAAI,SAAS,KAAK,MAAM,EAAE,CAAC;wBACvB,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAA;wBAC/B,IAAI,CAAC;4BACD,KAAK,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAA;wBACpC,CAAC;wBAAC,OAAO,CAAC,EAAE,CAAC;4BACT,OAAO,CAAC,KAAK,CAAC,sCAAsC,EAAE,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;wBAC7F,CAAC;oBACL,CAAC;oBACD,OAAM;gBACV,CAAC;gBACD,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC,MAAM,CAAA;gBAC9B,IAAI,CAAC,YAAY,IAAI,CAAC,CAAA;gBACtB,MAAM,OAAO,GAAG,WAAW,CAAC,KAAK,CAAC,CAAA;gBAClC,EAAE,CAAC;oBACC,IAAI,EAAE,OAAO,CAAC,IAAI;oBAClB,KAAK,EAAE,OAAO,CAAC,KAAK;oBACpB,KAAK,EAAE,KAAK;oBACZ,OAAO,EAAE,OAAO,CAAC,OAAO;oBACxB,YAAY,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,OAAO,CAAC;iBAC1D,CAAC,CAAA;YACN,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACT,OAAO,CAAC,KAAK,CAAC,gDAAgD,EAAE,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;YACvG,CAAC;QACL,CAAC,CAAC,CAAA;IACN,CAAC;CACJ"}

package/dist/utilities/evaluator/common.d.ts

@@ -0,0 +1,10 @@
+import { AdaptValue } from '@adapt-toolkit/sdk/backend';
+export declare class Evaluator {
+    #private;
+    constructor(test_mode?: boolean);
+    create_packet(code_object_hash: string, seed_phrase: string): void;
+    load_packet(packet_hash: string, unit_loc_prefix?: string): void;
+    execute_transaction(name: string, arg: string): void;
+    parse_mufl_value(value: string): AdaptValue;
+}
+//# sourceMappingURL=common.d.ts.map

package/dist/utilities/evaluator/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../../src/utilities/evaluator/common.ts"],"names":[],"mappings":"AAGA,OAAO,EAAkF,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtH,qBAAa,SAAS;;gBAsCN,SAAS,GAAE,OAAc;IAarC,aAAa,CAAC,gBAAgB,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM;IAU3D,WAAW,CAAC,WAAW,EAAE,MAAM,EAAE,eAAe,GAAE,MAAa;IAO/D,mBAAmB,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM;IAqD7C,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU;CA0B9C"}

package/dist/utilities/evaluator/common.js

@@ -0,0 +1,128 @@
+import { AdaptObjectBuilder, object_to_adapt_value } from '../../wrapper/index.js';
+import { execSync } from "child_process";
+import { unlinkSync, writeFileSync } from "fs";
+import { AdaptEnvironment, AdaptEvaluationUnit, AdaptPacketContext } from '@adapt-toolkit/sdk/backend';
+export class Evaluator {
+    #packet;
+    #test_mode = true;
+    #print_list_of_available_transactions(packet) {
+        console.log("Here is a list of available transactions.");
+        packet.TransactionsList().forEach(trn => {
+            console.log(`-- ${trn}`);
+        });
+    }
+    #update_packet_state(packet) {
+        writeFileSync(packet.GetHash().Visualize().substring(2) + ".muflp", packet.Serialize());
+        const old_packet_state_id = this.#packet?.GetHash().Visualize().substring(2);
+        this.#packet = packet;
+        if (!old_packet_state_id) {
+            console.log("Packet created.");
+            console.log("Packet ID: ", this.#packet.GetContainerID().Visualize());
+            console.log("Packet state ID: ", this.#packet.GetHash().Visualize().substring(2));
+            this.#print_list_of_available_transactions(this.#packet);
+        }
+        else {
+            console.log("Packet state updated.");
+            console.log("Packet ID: ", this.#packet.GetContainerID().Visualize());
+            console.log("Old packet state ID: ", old_packet_state_id);
+            console.log("New packet state ID: ", this.#packet.GetHash().Visualize().substring(2));
+        }
+    }
+    #validate_packet_is_set() {
+        if (!this.#packet) {
+            throw new Error("Error: please set the packet before proceeding.");
+        }
+        return this.#packet;
+    }
+    constructor(test_mode = true) {
+        try {
+            AdaptEnvironment.Check();
+        }
+        catch (e) {
+            AdaptEnvironment.Initialize(test_mode);
+        }
+        this.#test_mode = test_mode;
+    }
+    #load_unit(code_object_hash) {
+        return AdaptEvaluationUnit.LoadFromFile(undefined, code_object_hash.endsWith(".muflo") ? code_object_hash : code_object_hash + ".muflo");
+    }
+    create_packet(code_object_hash, seed_phrase) {
+        const unit = this.#load_unit(code_object_hash);
+        // generate random entropy in non-test mode
+        const entropy = this.#test_mode ? "" : AdaptEnvironment.GetRandomBytes(undefined, 256).Visualize().substring(2);
+        const packet = AdaptEnvironment.CreatePacket(undefined, unit, seed_phrase, entropy, true);
+        this.#update_packet_state(packet);
+    }
+    load_packet(packet_hash, unit_loc_prefix = "./") {
+        // const unit = this.#load_unit(code_object_hash);
+        const packet = AdaptPacketContext.LoadFromFile(undefined, packet_hash.endsWith(".muflp") ? packet_hash : packet_hash + ".muflp");
+        this.#load_unit(unit_loc_prefix + packet.GetCodeID().Visualize().substring(2));
+        this.#update_packet_state(packet);
+    }
+    execute_transaction(name, arg) {
+        AdaptObjectBuilder.execute_and_collect_garbage(builder => {
+            const packet = this.#validate_packet_is_set();
+            let arg_adapt_value;
+            try {
+                arg_adapt_value = builder.Attach(this.parse_mufl_value(arg));
+            }
+            catch (e) {
+                console.error("Error while parsing MUFL value: ", e instanceof Error ? e.message : e);
+                return;
+            }
+            const available_transcations = packet.TransactionsList();
+            if (!available_transcations.includes(name)) {
+                console.log(`Transaction with given name (${name}) not found in the packet.`);
+                this.#print_list_of_available_transactions(packet);
+                return;
+            }
+            console.log("\n\n");
+            console.log("Executing transaction in the packet.");
+            console.log("Transaction name: ", name);
+            console.log("Transaction argument: ", arg_adapt_value.Visualize());
+            const envelope = builder.Attach(object_to_adapt_value({
+                name: name,
+                targ: arg_adapt_value
+            }));
+            const entropy = this.#test_mode ? "" : AdaptEnvironment.GetRandomBytes(builder.lifetime, 256).Visualize().substring(2);
+            const result = builder.Attach(packet.ExecuteTransaction(envelope, entropy, AdaptEnvironment.SystemTime(undefined)));
+            console.log("\n\n================TRANSACTION RESULT===================\n\n");
+            console.log("Transaction result:", result.Visualize());
+            console.log("\n\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^");
+            console.log("\n\n========TRANSACTION OUTPUT (STDOUT)==================\n\n");
+            console.log("Transaction output(stdout):");
+            console.log(AdaptEnvironment.getStdoutContents());
+            console.log("\n\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^");
+            console.log("\n\n========TRANSACTION OUTPUT (STDERR)==================\n\n");
+            console.log("Transaction output(stderr):");
+            console.log(AdaptEnvironment.getStderrContents());
+            console.log("\n\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\n");
+            const new_packet = result.GetPacket();
+            this.#update_packet_state(new_packet.Detach());
+        });
+    }
+    parse_mufl_value(value) {
+        return AdaptObjectBuilder.execute_and_collect_garbage(builder => {
+            let tempFilePath;
+            try {
+                tempFilePath = execSync('mktemp XXXXXX.mufl').toString().trim();
+                const fileContent = `script { _print << _write ${value}. }`;
+                writeFileSync(tempFilePath, fileContent);
+                const muflReplPath = process.env.MUFL_REPL_PATH;
+                if (!muflReplPath) {
+                    throw new Error('MUFL_REPL_PATH environment variable is not defined');
+                }
+                const output = execSync(`${muflReplPath} -no-meta ${tempFilePath}`).toString().substring(2);
+                const result = AdaptEnvironment.EmptyPacket(builder.lifetime, false).ParseValue(Buffer.from(output, 'hex'));
+                return result.Detach();
+            }
+            finally {
+                // Clean up: Remove the temporary file
+                if (tempFilePath)
+                    unlinkSync(tempFilePath);
+            }
+        });
+    }
+}
+;
+//# sourceMappingURL=common.js.map

package/dist/utilities/evaluator/common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../../../src/utilities/evaluator/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AACnF,OAAO,EAAQ,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,IAAI,CAAC;AAC/C,OAAO,EAAE,gBAAgB,EAAE,mBAAmB,EAAuB,kBAAkB,EAAc,MAAM,UAAU,CAAC;AAEtH,MAAM,OAAO,SAAS;IAElB,OAAO,CAAqB;IAC5B,UAAU,GAAY,IAAI,CAAA;IAE1B,qCAAqC,CAAC,MAA0B;QAC5D,OAAO,CAAC,GAAG,CAAC,2CAA2C,CAAC,CAAC;QACzD,MAAM,CAAC,gBAAgB,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACpC,OAAO,CAAC,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;QAC5B,CAAC,CAAC,CAAA;IACN,CAAC;IAED,oBAAoB,CAAC,MAA0B;QAC3C,aAAa,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,SAAS,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,QAAQ,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;QACxF,MAAM,mBAAmB,GAAG,IAAI,CAAC,OAAO,EAAE,OAAO,EAAE,CAAC,SAAS,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAC7E,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;QACtB,IAAI,CAAC,mBAAmB,EAAE,CAAC;YACvB,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;YAC/B,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC;YACtE,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,SAAS,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;YAClF,IAAI,CAAC,qCAAqC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7D,CAAC;aACI,CAAC;YACF,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;YACrC,OAAO,CAAC,GAAG,CAAC,aAAa,EAAE,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC,SAAS,EAAE,CAAC,CAAC;YACtE,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,mBAAmB,CAAC,CAAA;YACzD,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,SAAS,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QAC1F,CAAC;IACL,CAAC;IAED,uBAAuB;QACnB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAChB,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAA;QACtE,CAAC;QACD,OAAO,IAAI,CAAC,OAAQ,CAAC;IACzB,CAAC;IAGD,YAAY,YAAqB,IAAI;QACjC,IAAI,CAAC;YACD,gBAAgB,CAAC,KAAK,EAAE,CAAA;QAC5B,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACT,gBAAgB,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;QAC3C,CAAC;QACD,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAChC,CAAC;IAED,UAAU,CAAC,gBAAwB;QAC/B,OAAO,mBAAmB,CAAC,YAAY,CAAC,SAAS,EAAE,gBAAgB,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,gBAAgB,GAAG,QAAQ,CAAC,CAAC;IAC7I,CAAC;IAED,aAAa,CAAC,gBAAwB,EAAE,WAAmB;QACvD,MAAM,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC,gBAAgB,CAAC,CAAC;QAE/C,2CAA2C;QAC3C,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC,cAAc,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,SAAS,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;QAEhH,MAAM,MAAM,GAAG,gBAAgB,CAAC,YAAY,CAAC,SAAS,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;QAC1F,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;IACtC,CAAC;IAED,WAAW,CAAC,WAAmB,EAAE,kBAA0B,IAAI;QAC3D,kDAAkD;QAClD,MAAM,MAAM,GAAG,kBAAkB,CAAC,YAAY,CAAC,SAAS,EAAE,WAAW,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,GAAG,QAAQ,CAAC,CAAC;QACjI,IAAI,CAAC,UAAU,CAAC,eAAe,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC,SAAS,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;QAC/E,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC;IACtC,CAAC;IAED,mBAAmB,CAAC,IAAY,EAAE,GAAW;QACzC,kBAAkB,CAAC,2BAA2B,CAAC,OAAO,CAAC,EAAE;YACrD,MAAM,MAAM,GAAG,IAAI,CAAC,uBAAuB,EAAE,CAAC;YAE9C,IAAI,eAA2B,CAAA;YAC/B,IAAI,CAAC;gBACD,eAAe,GAAG,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,CAAC;YACjE,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACT,OAAO,CAAC,KAAK,CAAC,kCAAkC,EAAE,CAAC,YAAY,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;gBACrF,OAAO;YACX,CAAC;YAED,MAAM,sBAAsB,GAAG,MAAM,CAAC,gBAAgB,EAAE,CAAC;YAEzD,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;gBACzC,OAAO,CAAC,GAAG,CAAC,gCAAgC,IAAI,4BAA4B,CAAC,CAAA;gBAC7E,IAAI,CAAC,qCAAqC,CAAC,MAAM,CAAC,CAAC;gBACnD,OAAO;YACX,CAAC;YAED,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACpB,OAAO,CAAC,GAAG,CAAC,sCAAsC,CAAC,CAAC;YACpD,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,IAAI,CAAC,CAAC;YACxC,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,eAAe,CAAC,SAAS,EAAE,CAAC,CAAC;YAEnE,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,CAAC,qBAAqB,CAAC;gBAClD,IAAI,EAAE,IAAI;gBACV,IAAI,EAAE,eAAe;aACxB,CAAC,CAAC,CAAC;YAEJ,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC,cAAc,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC,SAAS,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YAEvH,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,QAAQ,EAAE,OAAO,EAAE,gBAAgB,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;YAGpH,OAAO,CAAC,GAAG,CAAC,+DAA+D,CAAC,CAAC;YAC7E,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC;YACvD,OAAO,CAAC,GAAG,CAAC,2DAA2D,CAAC,CAAA;YACxE,OAAO,CAAC,GAAG,CAAC,+DAA+D,CAAC,CAAC;YAC7E,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;YAC3C,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAClD,OAAO,CAAC,GAAG,CAAC,2DAA2D,CAAC,CAAA;YACxE,OAAO,CAAC,GAAG,CAAC,+DAA+D,CAAC,CAAC;YAC7E,OAAO,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAC;YAC3C,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,iBAAiB,EAAE,CAAC,CAAC;YAClD,OAAO,CAAC,GAAG,CAAC,+DAA+D,CAAC,CAAA;YAE5E,MAAM,UAAU,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC;YAEtC,IAAI,CAAC,oBAAoB,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC;QACnD,CAAC,CAAC,CAAA;IACN,CAAC;IAED,gBAAgB,CAAC,KAAa;QAC1B,OAAO,kBAAkB,CAAC,2BAA2B,CAAC,OAAO,CAAC,EAAE;YAC5D,IAAI,YAAgC,CAAA;YACpC,IAAI,CAAC;gBACD,YAAY,GAAG,QAAQ,CAAC,oBAAoB,CAAC,CAAC,QAAQ,EAAE,CAAC,IAAI,EAAE,CAAC;gBAChE,MAAM,WAAW,GAAG,6BAA6B,KAAK,KAAK,CAAC;gBAC5D,aAAa,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;gBAEzC,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC;gBAChD,IAAI,CAAC,YAAY,EAAE,CAAC;oBAChB,MAAM,IAAI,KAAK,CAAC,oDAAoD,CAAC,CAAC;gBAC1E,CAAC;gBAED,MAAM,MAAM,GAAG,QAAQ,CAAC,GAAG,YAAY,aAAa,YAAY,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;gBAE5F,MAAM,MAAM,GAAG,gBAAgB,CAAC,WAAW,CAAC,OAAO,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAA;gBAC3G,OAAO,MAAM,CAAC,MAAM,EAAE,CAAC;YAC3B,CAAC;oBACO,CAAC;gBACL,sCAAsC;gBACtC,IAAI,YAAY;oBACZ,UAAU,CAAC,YAAY,CAAC,CAAC;YACjC,CAAC;QACL,CAAC,CACA,CAAA;IACL,CAAC;CACJ;AAAA,CAAC"}