configurapi-runner-ws 1.4.0 → 1.5.0

package/README.md

@@ -4,9 +4,11 @@
 - User `Response` for a regular response data.
 - Use `StreamResponse` from `configurapi-handler-ws` for a stream response.
   - With a stream response, data will be delivered from the server in chunks.
-    - A check will have `X-Stream: chunk` header.
-    - The last chunk will have `X-Stream: done` header.
-    - Check `X-Stream-ID: $id` header for the stream ID. A chunk belonging to the same stream will have the same stream ID.  
+    - A check will have `x-stream: chunk` header.
+    - The last chunk will have `x-stream: done` header.
+    - 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.0",
+  "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

@@ -48,7 +48,7 @@ module.exports = {
                         }
 
                         const payload = { chunk: bucket };
-                        const headers = { 'X-Stream': 'chunk', 'X-Stream-ID': streamId, 'Content-Type': 'application/json' };
+                        const headers = { 'x-stream': 'chunk', 'x-stream-id': streamId, 'Content-Type': 'application/json' };
                         const response = new Response(bucket, 200, headers);
 
                         ws.send(JSON.stringify(response), (err) =>
@@ -94,7 +94,7 @@ module.exports = {
                     
                         if (ws.readyState === WebSocket.OPEN) 
                         {
-                            const headers = { 'X-Stream-ID': streamId, 'X-Stream': 'done' };
+                            const headers = { 'x-stream-id': streamId, 'x-stream': 'done' };
                             const response = new Response('', 204, headers);
                             
                             ws.send(JSON.stringify(response), (err) =>
@@ -149,8 +149,10 @@ module.exports = {
         request.params = data.params || {};
         request.payload = data.payload || undefined;
         
-        request.headers['Connection-ID'] = ws.connectionId;
-        request.headers['Push-Function'] = async (data)=>await this.write(ws, data);
+        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;
     }