configurapi-runner-ws 1.4.1 → 1.5.0

package/README.md

@@ -9,4 +9,6 @@
     - Check `x-stream-id: $id` header for the stream ID. A chunk belonging to the same stream will have the same stream ID.  
 - connectionId is available at `event.request.headers.connectionId`
 - `on_connect` and `on_disconnect` will be called when a new connection is made or closed.
-- Use `Request.headers['push-function']` to send an out-of-band message.  The function is async and accepts an object to send back to the caller.
+- Use `Request.headers['push-function']` to send an out-of-band message.  The function is async and accepts an object to send back to the caller.
+- Use `on_connect` to perform authorization.
+- `Sec-WebSocket-Protocol` is automatically returned for `on_connect` events.  

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "configurapi-runner-ws",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "description": "Websocket runner for configurapi.",
   "bin": {
     "configurapi-runner-ws": "src/app.mjs"

package/src/index.js

@@ -55,7 +55,22 @@ module.exports = class HttpRunner extends events.EventEmitter
             this.emit("trace", "Server is listening..."+this.port);
         }
 
-        const wss = new WebSocketServer({ server: httpServer, path: "/ws" })
+        const wss = new WebSocketServer({ server: httpServer, path: "/ws", handleProtocols: (protocols, req) => {
+                        if(protocols === undefined)
+                        {
+                            return;
+                        }
+                        if(!Array.isArray(protocols))
+                        {
+                            let array = Array.from(protocols);
+                            return array.length > 0 ? array[0] : undefined;
+                        }
+                        else
+                        {
+                            //array
+                            return array.length > 0 ? array[0] : undefined;
+                        }
+                    } })
 
         wss.on("connection", async (ws, req) => 
         {
@@ -112,7 +127,21 @@ module.exports = class HttpRunner extends events.EventEmitter
             if(customEventName)
             {
                 event.name = customEventName;
-                await this.service.process(event);  // No response will be sent back to the caller for 'on_disconnect'
+                await this.service.process(event); 
+
+                if(event.name === 'on_connect')
+                {
+                    let protocol = event.request?.headers?.['sec-websocket-protocol'] || '';
+
+                    if(event.response.headers === undefined)
+                    {
+                        event.response.headers = {};
+                    }
+                    
+                    event.response.headers['Sec-WebSocket-Protocol'] = protocol;
+                }
+                
+                await WsAdapter.write(ws, event.response); 
             }
             else
             {

package/src/wsAdapter.js

@@ -152,6 +152,8 @@ module.exports = {
         request.headers['connection-id'] = ws.connectionId;
         request.headers['push-function'] = async (data)=>await this.write(ws, data);
         
+        request.headers['sec-websocket-protocol'] = ws.protocol
+        
         return request;
     }
 };