improve debugger already connected handling (#1571)

core/algorithm-debug/bootstrap.js

@@ -1,6 +1,6 @@
 const configIt = require('@hkube/config');
 const Logger = require('@hkube/logger');
-const component = require('./lib/algorithm-communication/consts/component-names').MAIN;
+const component = require('./lib/consts/component-names').MAIN;
 const { main: config, logger } = configIt.load();
 const log = new Logger(config.serviceName, logger);
 

core/algorithm-debug/lib/algorithm-communication/ws.js

@@ -5,8 +5,9 @@ const url = require('url');
 const Logger = require('@hkube/logger');
 const { Encoding } = require('@hkube/encoding');
 const Validator = require('ajv');
-const schema = require('./schema').socketWorkerCommunicationSchema;
-const component = require('./consts').Components.COMMUNICATIONS;
+const { socketWorkerCommunicationSchema: schema } = require('./schema');
+const { Components, debugMessages } = require('../consts');
+const component = Components.COMMUNICATIONS;
 const validator = new Validator({ useDefaults: true, coerceTypes: true });
 let log;
 let connectedPromise;
@@ -16,6 +17,7 @@ class WsWorkerCommunication extends EventEmitter {
         super();
         this._socketServer = null;
         this._socket = null;
+        this._queryData = null;
         connectedPromise = new Promise((res) => {
             resolveConnected = res;
         });
@@ -35,13 +37,14 @@ class WsWorkerCommunication extends EventEmitter {
 
                 this._socketServer.on('connection', (socket, opt) => {
                     if (this._socketServer.clients.size > 1) {
-                        log.info('Debugger connected already');
-                        socket.close(1013);
+                        log.info(`Debugger already connected from ${this._queryData?.hostname}`);
+                        socket.send(this._encoding.encode({ command: debugMessages.outgoing.alreadyConnectedError, data: { hostname: this._queryData?.hostname } }));
+                        socket.close(debugMessages.codes.close);
                     }
                     else {
                         const data = url.parse(opt.url, true).query;
-                        log.info('Connected!!!', { component });
-                        this._registerSocketMessages(socket);
+                        log.info(`Debugger connected from ${data.hostname || 'unknown'}`, { component });
+                        this._registerSocketMessages(socket, data);
                         this.setEncodingType(data.encoding);
                         this.emit('connection', data);
                     }
@@ -67,8 +70,9 @@ class WsWorkerCommunication extends EventEmitter {
         this._encoding = new Encoding({ type });
     }
 
-    _registerSocketMessages(socket) {
+    _registerSocketMessages(socket, queryData) {
         this._socket = socket;
+        this._queryData = queryData;
         resolveConnected();
         socket.on('message', (data) => {
             const payload = this._encoding.decode(data);
@@ -79,6 +83,7 @@ class WsWorkerCommunication extends EventEmitter {
             log.info('Debug connection closed');
             const reason = code === 1006 ? 'CLOSE_ABNORMAL' : `${code}`;
             this._socket = null;
+            this._queryData = null;
             connectedPromise = new Promise((res) => {
                 resolveConnected = res;
             });

core/algorithm-debug/lib/consts/index.js

@@ -0,0 +1,6 @@
+const Components = require('./component-names');
+const debugMessages = require('./messages');
+module.exports = {
+    Components,
+    debugMessages
+};

core/algorithm-debug/lib/consts/messages.js

@@ -0,0 +1,8 @@
+module.exports = {
+    outgoing: {
+        alreadyConnectedError: 'alreadyConnectedError',
+    },
+    codes: {
+        close: 4001
+    }
+};

core/algorithm-debug/tests/debug.js

@@ -1,7 +1,9 @@
 const configIt = require('@hkube/config');
+const { once } = require('events');
 const { main: config } = configIt.load();
 const { expect } = require('chai');
 const { messages } = require('@hkube/nodejs-wrapper');
+const { debugMessages } = require('../lib/consts');
 const WebSocket = require('ws');
 let app;
 // const Logger = require('@hkube/logger');
@@ -467,18 +469,14 @@ describe('Debug', () => {
     });
 
     it('connect twice', async () => {
-        socket = new WebSocket(combinedUrl, {});
-        const socket2 = new WebSocket(combinedUrl, {});
-        let resolveGotAlreadyConnected;
-        const gotConnectedAlready = new Promise((res, rej) => {
-            resolveGotAlreadyConnected = res;
-        });
+        socket = new WebSocket(`${combinedUrl}&hostname=host 1`, {});
+        const socket2 = new WebSocket(`${combinedUrl}&hostname=host 2`, {});
+        const [alreadyConnectedRes] = await once(socket2, 'message');
+        const decodedData = encoding.decode(alreadyConnectedRes);
+        expect(decodedData.command).to.eql(debugMessages.outgoing.alreadyConnectedError);
+        expect(decodedData.data.hostname).to.eql('host 1')
+        const [closeCode] = await once(socket2, 'close');
+        expect(closeCode).to.eql(debugMessages.codes.close);
 
-        socket2.on("close", (code) => {
-            if (code == 1013) {
-                resolveGotAlreadyConnected();
-            }
-        })
-        await gotConnectedAlready;
     });
 });