configurapi-runner-ws 1.12.0 → 1.14.0

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "configurapi-runner-ws",
-  "version": "1.12.0",
+  "version": "1.14.0",
   "description": "Websocket runner for configurapi.",
   "bin": {
     "configurapi-runner-ws": "src/app.mjs"
   },
   "main": "src/index.js",
   "scripts": {
-    "test": "cd test && mocha ./"
+    "test": "node --test --test-reporter=spec spec/**/*.spec.js",
+    "test-watch": "node --test --watch --test-reporter=spec spec/**/*.spec.js"
   },
   "files": [
     "src/*"
@@ -33,5 +34,9 @@
     "dotenv": "^17.2.3",
     "one-liner": "^1.3.0",
     "ws": "^8.18.3"
+  },
+  "devDependencies": {
+    "@types/chai": "^5.2.3",
+    "chai": "^6.2.2"
   }
 }

package/src/index.js

@@ -1,7 +1,6 @@
 require('dotenv').config();
 const http = require('http');
 const https = require('https');
-const WsAdapter = require('./wsAdapter');
 const events = require('events');
 const Configurapi = require('configurapi');
 const { WebSocketServer } = require('ws');
@@ -11,7 +10,7 @@ const oneliner = require('one-liner');
 const wsAdapter = require('./wsAdapter');
 const URL = require('url');
 
-function addInternalRoute(self, config, routeName,)
+function addInternalRoute(self, config, routeName)
 {
     let route = new Route();
     route.name = routeName;
@@ -27,7 +26,7 @@ function addInternalRoute(self, config, routeName,)
     config.events.set(route.name, route);
 }
 
-const connections = []
+const connections = new Map()
 
 module.exports = class HttpRunner extends events.EventEmitter 
 {
@@ -55,7 +54,7 @@ module.exports = class HttpRunner extends events.EventEmitter
         loader.handlers.set('list_@connections', (e)=>
         { 
             e.response.headers['Content-Type'] = 'application/json';
-            e.response.body = Object.keys(connections);
+            e.response.body = Array.from(connections.keys());
         });
         loader.handlers.set('post_@connection', async (e)=>
         {
@@ -63,10 +62,10 @@ module.exports = class HttpRunner extends events.EventEmitter
 
             const connectionId = e.params?.['@connection'];
 
-            if(connectionId && connections[connectionId])
+            if(connectionId && connections.has(connectionId))
             {
                 let wsResponse = new Response(e.payload, 200, {...e.request.headers, 'connection-id': connectionId})
-                await wsAdapter.write(connections[connectionId].ws, wsResponse)
+                await wsAdapter.write(connections.get(connectionId).ws, wsResponse)
                 e.response.statusCode = 204
             }
             else
@@ -80,9 +79,9 @@ module.exports = class HttpRunner extends events.EventEmitter
         addInternalRoute(this, config, 'post_@connection')
         
         this.service = new Configurapi.Service(config, loader);
-        this.service.on("trace", (s) => this.emit("trace", s));
-        this.service.on("debug", (s) => this.emit("debug", s));
-        this.service.on("error", (s) => this.emit("error", s));
+        this.service.on(LogLevel.Trace, (s) => this.emit(LogLevel.Trace, s));
+        this.service.on(LogLevel.Debug, (s) => this.emit(LogLevel.Debug, s));
+        this.service.on(LogLevel.Error, (s) => this.emit(LogLevel.Error, s));
         await this.service.init();
 
         let httpServer;
@@ -94,7 +93,7 @@ module.exports = class HttpRunner extends events.EventEmitter
             httpServer.keepAliveTimeout = this.keepAliveTimeout;
             httpServer.listen(this.sPort);
 
-            this.emit("trace", "Secure Server is listening...");
+            this.emit(LogLevel.Trace, "Secure Server is listening...");
         }
         else
         {
@@ -103,7 +102,7 @@ module.exports = class HttpRunner extends events.EventEmitter
             httpServer.keepAliveTimeout = this.keepAliveTimeout;
             httpServer.listen(this.port);
             
-            this.emit("trace", "Server is listening..."+this.port);
+            this.emit(LogLevel.Trace, "Server is listening..."+this.port);
         }
 
         let managementServer =  http.createServer({key: this.key, cert: this.cert}, (req, resp) => {
@@ -112,7 +111,7 @@ module.exports = class HttpRunner extends events.EventEmitter
         managementServer.keepAliveTimeout = this.keepAliveTimeout;
         managementServer.listen(this.mPort);
 
-        this.emit('trace', 'Management server is listening...'+this.mPort);
+        this.emit(LogLevel.Trace, 'Management server is listening...'+this.mPort);
 
         const wss = new WebSocketServer({ server: httpServer, path: "/ws", handleProtocols: (protocols, req) => {
                         if(protocols === undefined)
@@ -136,45 +135,65 @@ module.exports = class HttpRunner extends events.EventEmitter
             const connectionId = randomUUID();
             ws.connectionId = connectionId;
           
-            connections[connectionId] = {
-                connectionId,
-                ws
-            }
-            this.emit("trace", `[connect] ${connectionId}`);
+            connections.set(connectionId, { connectionId, ws });
+
+            this.emit(LogLevel.Trace, `[connect] ${connectionId}`);
           
-            if (config.events.has('on_connect'))
-            {
-                const response = await this._requestListener(ws, undefined, 'on_connect');
-        
-                if (response.statusCode >= 400)
-                {
-                    return ws.close(1008, 'Policy Violation');
-                }
-            }
             ws.on("message", async (data) => 
             {
                 const incomingMessage = typeof data === "string" ? data : data.toString("utf8");
 
-                await this._requestListener(ws, incomingMessage);
+                try
+                {
+                    await this._requestListener(ws, incomingMessage);
+                }
+                catch(err)
+                {
+                    this.emit(LogLevel.Error, err);
+                }
             });
           
             ws.on("close", async(code, reason) => 
             {
-                await (config.events.has('on_disconnect') ? this._requestListener(ws, undefined, 'on_disconnect') : undefined);
+                try
+                {
+                    await (config.events.has('on_disconnect') ? this._requestListener(ws, undefined, 'on_disconnect') : undefined);
+                }
+                catch(err)
+                {
+                    this.emit(LogLevel.Error, err);
+                }
 
                 const reasonMessage = reason && reason.length ? reason.toString("utf8") : "";
 
-                delete connections[connectionId];
+                connections.delete(connectionId);
 
-                this.emit("trace", `[disconnect] ${connectionId} (${code}${reasonMessage ? ` - ${reasonMessage}` : ""})`);
+                this.emit(LogLevel.Trace, `[disconnect] ${connectionId} (${code}${reasonMessage ? ` - ${reasonMessage}` : ""})`);
             });
           
             ws.on("error", (err) => 
             {
                 // Note: 'error' will often be followed by 'close'
                 const message = err instanceof Error ? err.message : err;
-                this.emit("error", `${connectionId} - ${message}`);
+                this.emit(LogLevel.Error, `${connectionId} - ${message}`);
             });
+
+            if (config.events.has('on_connect'))
+            {
+                try
+                {
+                    const response = await this._requestListener(ws, undefined, 'on_connect');
+            
+                    if (response.statusCode >= 400)
+                    {
+                        return ws.close(1008, 'Policy Violation');
+                    }
+                }
+                catch(err)
+                {
+                    this.emit(LogLevel.Error, err);
+                }
+            }
         });
     }
 
@@ -197,7 +216,7 @@ module.exports = class HttpRunner extends events.EventEmitter
 
         try 
         {
-            event = new Configurapi.Event(await WsAdapter.toRequest(ws, incomingMessage));
+            event = new Configurapi.Event(await wsAdapter.toRequest(ws, incomingMessage));
             
             if(customEventName)
             {
@@ -216,7 +235,7 @@ module.exports = class HttpRunner extends events.EventEmitter
                     event.response.headers['Sec-WebSocket-Protocol'] = protocol;
                 }
 
-                await WsAdapter.write(ws, event.response); 
+                await wsAdapter.write(ws, event.response); 
             }
             else
             {
@@ -228,7 +247,7 @@ module.exports = class HttpRunner extends events.EventEmitter
                 }
                 event.response.headers['message-id'] = event.request.headers?.['message-id'];
 
-                await WsAdapter.write(ws, event.response); // Send response back to the caller.
+                await wsAdapter.write(ws, event.response); // Send response back to the caller.
             }
 
             return event.response;
@@ -245,13 +264,13 @@ module.exports = class HttpRunner extends events.EventEmitter
             
             try
             {
-                await WsAdapter.write(ws, response);
+                await wsAdapter.write(ws, response);
             }
             catch(err)
             {
                 try
                 {
-                    this.emit("error", JSON.stringify(err));
+                    this.emit(LogLevel.Error, JSON.stringify(err));
                 }
                 catch(errorFromListner)
                 {

package/src/wsAdapter.js

@@ -12,6 +12,26 @@ module.exports = {
 
         await new Promise((resolve, reject)=>
         {
+            let settled = false;
+
+            const safeResolve = () => 
+            {
+                if(!settled)
+                {
+                    settled = true;
+                    resolve();
+                }
+            };
+
+            const safeReject = (err) => 
+            {
+                if(!settled)
+                {
+                    settled = true;
+                    reject(err);
+                }
+            };
+
             try
             {
                 if(message instanceof StreamResponse)
@@ -22,7 +42,7 @@ module.exports = {
                     // Guard: need a readable stream
                     if(!stream || typeof stream.on !== 'function')
                     {
-                        return reject(new Error('StreamResponse.stream is not a readable stream.'));
+                        return safeReject(new Error('StreamResponse.stream is not a readable stream.'));
                     }
 
                     const HIGH_WATER = 64 * 1024;
@@ -40,7 +60,11 @@ module.exports = {
                         {
                             stream.pause();
                             const check = () => {
-                                if (ws.readyState !== WebSocket.OPEN) return cleanup();
+                                if (ws.readyState !== WebSocket.OPEN)
+                                {
+                                    cleanup();
+                                    return safeResolve();
+                                }
                                 if (ws.bufferedAmount <= HIGH_WATER) return stream.resume();
                                 setTimeout(check, 100);
                             };
@@ -52,13 +76,13 @@ module.exports = {
 
                         ws.send(JSON.stringify(response), (err) =>
                         {
-                            if (err) { cleanup(); return reject(err); }
+                            if (err) { cleanup(); return safeReject(err); }
                         });
 
                         bucket = '';
                         bucketBytes = 0;
                     };
-
+                    
                     const cleanup = () =>
                     {
                         try {
@@ -66,9 +90,31 @@ module.exports = {
                             stream.removeListener('data', onData);
                             stream.removeListener('end', onEnd);
                             stream.removeListener('error', onErr);
+                            stream.removeListener('close', onClose);
+                    
+                            ws.removeListener('close', onWsClose);
+                            ws.removeListener('error', onWsError);
+
+                           // safeResolve(); 
                         } catch(_) {}
                     };
 
+                    // If ws connection closes before the stream does, cleanup the connection.
+                    const onWsClose = () =>
+                    {
+                        cleanup();
+                        safeResolve();
+                    };
+                    
+                    const onWsError = () =>
+                    {
+                        cleanup();
+                        safeResolve();
+                    };
+
+                    ws.on('close', onWsClose);
+                    ws.on('error', onWsError);
+           
                     const onData = (chunk) =>
                     {
                         if (ws.readyState !== WebSocket.OPEN) { cleanup(); return; }
@@ -99,44 +145,63 @@ module.exports = {
                             ws.send(JSON.stringify(response), (err) =>
                             {
                                 cleanup();
-                                return err ? reject(err) : resolve();
+                                return err ? safeReject(err) : safeResolve();
                             });
                         } 
                         else 
                         {
                             cleanup();
-                            return resolve();
+                            safeResolve();
                         }
                     };
 
                     const onErr = (e) =>
                     {
                         cleanup();
-                        return reject(e);
+                        safeReject(e);
                     };
 
+                    const onClose = () =>
+                    {
+                        cleanup();
+                        safeResolve()
+                    }
+
                     stream.on('data', onData);
                     stream.on('end', onEnd);
                     stream.on('error', onErr);
+                    stream.on('close', onClose);
 
                     // Important: stop here; promise resolves on 'end' or rejects on 'error'
                     return;
                 }
                 else
                 {
-                    ws.send(JSON.stringify(message), (err) => err ? reject(err) : resolve());
+                    ws.send(JSON.stringify(message), (err) => err ? safeReject(err) : safeResolve());
                 }
             }
             catch(e)
             {
-                reject(e)
+                safeReject(e)
             }
         });
     },
 
     toRequest: async function(ws, incomingMessage)
-    {        
-        let data = incomingMessage ? JSON.parse(incomingMessage) : {};
+    {
+        let data = {};
+
+        if(incomingMessage) 
+        {
+            try
+            {
+                data = JSON.parse(incomingMessage);
+            }
+            catch(e)
+            {
+                throw new SyntaxError(`Invalid JSON payload: '${incomingMessage}'`);
+            }
+        }
 
         let request = new Configurapi.Request();