@adcops/autocore-react 3.3.9 → 3.3.14

package/src/hub/HubWebSocket.ts

@@ -1,251 +1,251 @@
-/*
- * Copyright (C) 2024 Automated Design Corp.. All Rights Reserved.
- * Created Date: 2024-04-17 09:13:07
- * -----
- * Last Modified: 2026-01-29 09:34:31
- * Modified By: ADC
- * -----
- * 
- */
-
-/** 
- * @module hub/HubWebSocket
- * 
- * Implementation of `HubBase` using standard WebSockets.
- * 
- * ## Functionality
- * 
- * - **Transport**: Connects to `ws://host:port/ws/` (or `wss://`).
- * - **Request/Response**: Correlates requests to responses using `transaction_id`.
- * - **Broadcasts**: Handles unsolicited messages (subscriptions) and routes them via `HubBase.publish`.
- * - **Binary Data**: Handles `FILE_DOWNLOAD` events by decoding Base64 payloads into Blobs.
- * 
- * ## Protocol
- * 
- * Messages are JSON-serialized `CommandMessage` objects.
- * - **Requests**: Client sends `message_type` (Read/Write/etc) + `transaction_id`.
- * - **Responses**: Server replies with same `transaction_id` + `success`/`data`.
- * - **Broadcasts**: Server sends `message_type: Broadcast` + `topic` (FQDN) + `data`.
- */
-
-import { HubBase } from './HubBase';
-import { MessageType, type CommandMessage } from "./CommandMessage";
-import { getDebugPanel } from './DebugPanel';
-
-/**
- * Internal tracking record for pending requests.
- * Allows the `invoke` promise to be resolved/rejected when the response arrives.
- */
-interface RequestRecord {
-    resolve: (value?: any) => void;
-    reject: (reason?: any) => void;
-}
-
-
-/**
- * Converts a Base64 encoded string into a Blob object.
- * Used for file downloads.
- *
- * @param {string} b64Data The base64 encoded string.
- * @param {string} [contentType='application/octet-stream'] The MIME type.
- * @param {number} [sliceSize=512] Chunk size for processing.
- * @returns {Blob} The decoded binary blob.
- */
-function b64toBlob(
-    b64Data: string,
-    contentType: string = "application/octet-stream",
-    sliceSize: number = 512
-): Blob {
-    const byteCharacters = atob(b64Data);
-    const buffers: ArrayBuffer[] = [];
-
-    for (let offset = 0; offset < byteCharacters.length; offset += sliceSize) {
-        const slice = byteCharacters.slice(offset, offset + sliceSize);
-
-        const byteNumbers = new Array<number>(slice.length);
-        for (let i = 0; i < slice.length; i++) byteNumbers[i] = slice.charCodeAt(i);
-
-        const uint8 = new Uint8Array(byteNumbers);
-        buffers.push(uint8.buffer as ArrayBuffer);
-    }
-
-    return new Blob(buffers, { type: contentType });
-}
-
-
-
-/**
- * Triggers a browser download for a Blob object.
- *
- * @param {Blob} blob The binary data.
- * @param {string} filename The suggested filename.
- */
-function downloadBlob(blob: Blob, filename: string): void {
-    const url = window.URL.createObjectURL(blob);
-    const a = document.createElement('a');
-    a.href = url;
-    a.download = filename;
-    document.body.appendChild(a);
-    a.click();
-    document.body.removeChild(a);
-    window.URL.revokeObjectURL(url);
-}
-
-
-/**
- * WebSocket implementation of the Hub communication layer.
- */
-export class HubWebSocket extends HubBase {
-    private socket: WebSocket;
-    private requestId = 0;
-    
-    /** 
-     * Map of pending Transaction ID -> Promise Resolvers.
-     * Used to match asynchronous WebSocket responses to their original requests.
-     */
-    private pendingRequests = new Map<number, RequestRecord>();
-
-    /**
-     * Initializes the WebSocket connection immediately.
-     */
-    constructor() {
-        super();
-        console.log("[HubWebSocket] Constructor called");
-        getDebugPanel().hubCreated();
-
-        const host = window.location.hostname;
-        const port = window.location.port;
-
-        const proto = window.location.protocol === 'https:' ? 'wss://' : 'ws://';
-        const wsUrl = `${proto}${host}${port ? ':' + port : ''}/ws/`;
-
-        this.socket = new WebSocket(wsUrl);
-        let self = this;
-
-        // --- Connection Handlers ---
-
-        this.socket.onopen = function () {
-            console.log("WebSocket connection established.");
-            getDebugPanel().wsOpened(wsUrl);
-            // Notify app that we are online
-            self.publish("HUB/connected", true);
-            self.setIsConnected(true);
-        };
-
-        // --- Message Handler ---
-
-        this.socket.onmessage = (event) => {
-            const data: CommandMessage = JSON.parse(event.data);
-            getDebugPanel().messageReceived(
-                MessageType[data.message_type] || String(data.message_type),
-                data.topic,
-                data.transaction_id
-            );
-
-            console.log(`HUB MSG RX: ${JSON.stringify(data)}`);
-            
-            // Check if this message is a response to a pending request (has ID)
-            if (data.transaction_id && this.pendingRequests.has(data.transaction_id)) {
-                const { resolve, reject } = this.pendingRequests.get(data.transaction_id)!;
-
-                // SPECIAL CASE: File Download Response
-                if (data.topic === "FILE_DOWNLOAD"
-                    && data.data["file_name"] !== undefined && data.data["file_name"] !== null
-                    && data.data["file_name"].length > 0
-                ) {
-                    let tokens = data.data["file_name"].split("/");
-                    const filename = tokens[tokens.length - 1];
-                    
-                    if (data.success) {
-                        // Decode and trigger download
-                        const blob = b64toBlob(data.data);
-                        downloadBlob(blob, filename);
-
-                        // Clean up response data to avoid passing giant string to app
-                        data.data = filename;
-                        resolve(data);
-                    } else {
-                        reject(new Error(data.error_message));
-                    }
-                }
-                // STANDARD CASE: Normal Command Response
-                else {
-                    if (!data.success) {
-                        reject(new Error(data.error_message));
-                    } else {
-                        // Success: resolve with the full message
-                        resolve(data);
-                    }
-                }
-                // Cleanup request record
-                this.pendingRequests.delete(data.transaction_id);
-            } else {
-                // No transaction ID means it's an unsolicited broadcast (subscription update)
-                console.log(`HUB BROADCAST: ${JSON.stringify(data)}`);
-                this.handleUnsolicitedMessage(data);
-            }
-        };
-
-        this.socket.onerror = (error: Event) => {
-            console.error('WebSocket error:', error);
-            getDebugPanel().wsError(String(error));
-        };
-
-        this.socket.onclose = (event: CloseEvent) => {
-            self.setIsConnected(false);
-            console.log('WebSocket connection closed.');
-            getDebugPanel().wsClosed(event.code, event.reason || 'No reason');
-        };
-    }
-
-
-    /**
-     * Sends a command to the server via WebSocket.
-     * 
-     * Wraps the operation in a Promise that resolves when the server replies
-     * with a matching `transaction_id`.
-     */
-    invoke = (topic: string, messageType: MessageType, payload?: object): Promise<CommandMessage> => {
-
-        return new Promise((resolve, reject) => {
-            const id = ++this.requestId; // Generate unique ID
-            this.pendingRequests.set(id, { resolve, reject });
-
-            const data = payload ? payload : {};
-
-            const cm: CommandMessage = {
-                transaction_id: id,
-                topic: topic,
-                data: data,
-                timecode: Date.now(),
-                message_type: messageType,
-                success: false,
-                error_message: ''
-            };
-
-            getDebugPanel().messageSent(MessageType[messageType], topic, id);
-            this.socket.send(JSON.stringify(cm));
-        });
-    }
-
-    /**
-     * Processes messages that are not responses to a specific request.
-     * Usually these are subscription updates (Broadcasts).
-     */
-    handleUnsolicitedMessage = (msg: CommandMessage) => {
-        if (msg.message_type == MessageType.Broadcast && msg.topic.length > 1) {
-            console.log(`HUB PUBLISHING: ${msg.topic} : ${JSON.stringify(msg.data)}`);
-            
-            // Pass to HubBase to map the FQDN topic to a local tagName and dispatch
-            this.publish(msg.topic, msg.data);
-        }
-    }
-
-    disconnect = (): void => {
-        this.socket.close();
-    }
-
-    protected emit = (eventName: string, payload?: object): void => {
-        this.socket.send(JSON.stringify({ eventName, payload }));
-    }
+/*
+ * Copyright (C) 2024 Automated Design Corp.. All Rights Reserved.
+ * Created Date: 2024-04-17 09:13:07
+ * -----
+ * Last Modified: 2026-01-29 09:34:31
+ * Modified By: ADC
+ * -----
+ * 
+ */
+
+/** 
+ * @module hub/HubWebSocket
+ * 
+ * Implementation of `HubBase` using standard WebSockets.
+ * 
+ * ## Functionality
+ * 
+ * - **Transport**: Connects to `ws://host:port/ws/` (or `wss://`).
+ * - **Request/Response**: Correlates requests to responses using `transaction_id`.
+ * - **Broadcasts**: Handles unsolicited messages (subscriptions) and routes them via `HubBase.publish`.
+ * - **Binary Data**: Handles `FILE_DOWNLOAD` events by decoding Base64 payloads into Blobs.
+ * 
+ * ## Protocol
+ * 
+ * Messages are JSON-serialized `CommandMessage` objects.
+ * - **Requests**: Client sends `message_type` (Read/Write/etc) + `transaction_id`.
+ * - **Responses**: Server replies with same `transaction_id` + `success`/`data`.
+ * - **Broadcasts**: Server sends `message_type: Broadcast` + `topic` (FQDN) + `data`.
+ */
+
+import { HubBase } from './HubBase';
+import { MessageType, type CommandMessage } from "./CommandMessage";
+import { getDebugPanel } from './DebugPanel';
+
+/**
+ * Internal tracking record for pending requests.
+ * Allows the `invoke` promise to be resolved/rejected when the response arrives.
+ */
+interface RequestRecord {
+    resolve: (value?: any) => void;
+    reject: (reason?: any) => void;
+}
+
+
+/**
+ * Converts a Base64 encoded string into a Blob object.
+ * Used for file downloads.
+ *
+ * @param {string} b64Data The base64 encoded string.
+ * @param {string} [contentType='application/octet-stream'] The MIME type.
+ * @param {number} [sliceSize=512] Chunk size for processing.
+ * @returns {Blob} The decoded binary blob.
+ */
+function b64toBlob(
+    b64Data: string,
+    contentType: string = "application/octet-stream",
+    sliceSize: number = 512
+): Blob {
+    const byteCharacters = atob(b64Data);
+    const buffers: ArrayBuffer[] = [];
+
+    for (let offset = 0; offset < byteCharacters.length; offset += sliceSize) {
+        const slice = byteCharacters.slice(offset, offset + sliceSize);
+
+        const byteNumbers = new Array<number>(slice.length);
+        for (let i = 0; i < slice.length; i++) byteNumbers[i] = slice.charCodeAt(i);
+
+        const uint8 = new Uint8Array(byteNumbers);
+        buffers.push(uint8.buffer as ArrayBuffer);
+    }
+
+    return new Blob(buffers, { type: contentType });
+}
+
+
+
+/**
+ * Triggers a browser download for a Blob object.
+ *
+ * @param {Blob} blob The binary data.
+ * @param {string} filename The suggested filename.
+ */
+function downloadBlob(blob: Blob, filename: string): void {
+    const url = window.URL.createObjectURL(blob);
+    const a = document.createElement('a');
+    a.href = url;
+    a.download = filename;
+    document.body.appendChild(a);
+    a.click();
+    document.body.removeChild(a);
+    window.URL.revokeObjectURL(url);
+}
+
+
+/**
+ * WebSocket implementation of the Hub communication layer.
+ */
+export class HubWebSocket extends HubBase {
+    private socket: WebSocket;
+    private requestId = 0;
+    
+    /** 
+     * Map of pending Transaction ID -> Promise Resolvers.
+     * Used to match asynchronous WebSocket responses to their original requests.
+     */
+    private pendingRequests = new Map<number, RequestRecord>();
+
+    /**
+     * Initializes the WebSocket connection immediately.
+     */
+    constructor() {
+        super();
+        console.log("[HubWebSocket] Constructor called");
+        getDebugPanel().hubCreated();
+
+        const host = window.location.hostname;
+        const port = window.location.port;
+
+        const proto = window.location.protocol === 'https:' ? 'wss://' : 'ws://';
+        const wsUrl = `${proto}${host}${port ? ':' + port : ''}/ws/`;
+
+        this.socket = new WebSocket(wsUrl);
+        let self = this;
+
+        // --- Connection Handlers ---
+
+        this.socket.onopen = function () {
+            console.log("WebSocket connection established.");
+            getDebugPanel().wsOpened(wsUrl);
+            // Notify app that we are online
+            self.publish("HUB/connected", true);
+            self.setIsConnected(true);
+        };
+
+        // --- Message Handler ---
+
+        this.socket.onmessage = (event) => {
+            const data: CommandMessage = JSON.parse(event.data);
+            getDebugPanel().messageReceived(
+                MessageType[data.message_type] || String(data.message_type),
+                data.topic,
+                data.transaction_id
+            );
+
+            console.log(`HUB MSG RX: ${JSON.stringify(data)}`);
+            
+            // Check if this message is a response to a pending request (has ID)
+            if (data.transaction_id && this.pendingRequests.has(data.transaction_id)) {
+                const { resolve, reject } = this.pendingRequests.get(data.transaction_id)!;
+
+                // SPECIAL CASE: File Download Response
+                if (data.topic === "FILE_DOWNLOAD"
+                    && data.data["file_name"] !== undefined && data.data["file_name"] !== null
+                    && data.data["file_name"].length > 0
+                ) {
+                    let tokens = data.data["file_name"].split("/");
+                    const filename = tokens[tokens.length - 1];
+                    
+                    if (data.success) {
+                        // Decode and trigger download
+                        const blob = b64toBlob(data.data);
+                        downloadBlob(blob, filename);
+
+                        // Clean up response data to avoid passing giant string to app
+                        data.data = filename;
+                        resolve(data);
+                    } else {
+                        reject(new Error(data.error_message));
+                    }
+                }
+                // STANDARD CASE: Normal Command Response
+                else {
+                    if (!data.success) {
+                        reject(new Error(data.error_message));
+                    } else {
+                        // Success: resolve with the full message
+                        resolve(data);
+                    }
+                }
+                // Cleanup request record
+                this.pendingRequests.delete(data.transaction_id);
+            } else {
+                // No transaction ID means it's an unsolicited broadcast (subscription update)
+                console.log(`HUB BROADCAST: ${JSON.stringify(data)}`);
+                this.handleUnsolicitedMessage(data);
+            }
+        };
+
+        this.socket.onerror = (error: Event) => {
+            console.error('WebSocket error:', error);
+            getDebugPanel().wsError(String(error));
+        };
+
+        this.socket.onclose = (event: CloseEvent) => {
+            self.setIsConnected(false);
+            console.log('WebSocket connection closed.');
+            getDebugPanel().wsClosed(event.code, event.reason || 'No reason');
+        };
+    }
+
+
+    /**
+     * Sends a command to the server via WebSocket.
+     * 
+     * Wraps the operation in a Promise that resolves when the server replies
+     * with a matching `transaction_id`.
+     */
+    invoke = (topic: string, messageType: MessageType, payload?: object): Promise<CommandMessage> => {
+
+        return new Promise((resolve, reject) => {
+            const id = ++this.requestId; // Generate unique ID
+            this.pendingRequests.set(id, { resolve, reject });
+
+            const data = payload ? payload : {};
+
+            const cm: CommandMessage = {
+                transaction_id: id,
+                topic: topic,
+                data: data,
+                timecode: Date.now(),
+                message_type: messageType,
+                success: false,
+                error_message: ''
+            };
+
+            getDebugPanel().messageSent(MessageType[messageType], topic, id);
+            this.socket.send(JSON.stringify(cm));
+        });
+    }
+
+    /**
+     * Processes messages that are not responses to a specific request.
+     * Usually these are subscription updates (Broadcasts).
+     */
+    handleUnsolicitedMessage = (msg: CommandMessage) => {
+        if (msg.message_type == MessageType.Broadcast && msg.topic.length > 1) {
+            console.log(`HUB PUBLISHING: ${msg.topic} : ${JSON.stringify(msg.data)}`);
+            
+            // Pass to HubBase to map the FQDN topic to a local tagName and dispatch
+            this.publish(msg.topic, msg.data);
+        }
+    }
+
+    disconnect = (): void => {
+        this.socket.close();
+    }
+
+    protected emit = (eventName: string, payload?: object): void => {
+        this.socket.send(JSON.stringify({ eventName, payload }));
+    }
 }