configurapi-runner-ws 1.0.2 → 1.2.0

package/README.md

@@ -1,5 +1,11 @@
 # configurapi-runner-ws
 
 - Use `Event` for an incoming data.
-- User `Response` for a response data.
-- connectionId is available at `event.request.headers.connectionId`
+- 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.  
+- connectionId is available at `event.request.headers.connectionId`
+- `on_connect` and `on_disconnect` will be called when a new connection is made or closed.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "configurapi-runner-ws",
-  "version": "1.0.2",
+  "version": "1.2.0",
   "description": "Websocket runner for configurapi.",
   "bin": {
     "configurapi-runner-ws": "src/app.mjs"
@@ -28,7 +28,7 @@
   "homepage": "https://gitlab.com/mappies/configurapi-runner-ws#readme",
   "dependencies": {
     "commander": "^14.0.1",
-    "configurapi": "^1.9.0",
+    "configurapi": "^2.2.1",
     "configurapi-handler-ws": "^1.0.0",
     "dotenv": "^17.2.3",
     "one-liner": "^1.3.0",

package/src/index.js

@@ -64,6 +64,8 @@ module.exports = class HttpRunner extends events.EventEmitter
           
             this.emit("trace", `[connect] ${connectionId}`);
           
+            this._requestListener(ws, undefined, 'on_connect');
+
             ws.on("message", async (data) => 
             {
                 const incomingMessage = typeof data === "string" ? data : data.toString("utf8");
@@ -73,6 +75,8 @@ module.exports = class HttpRunner extends events.EventEmitter
           
             ws.on("close", (code, reason) => 
             {
+                this._requestListener(ws, undefined, 'on_disconnect');
+
                 const reasonMessage = reason && reason.length ? reason.toString("utf8") : "";
 
                 this.emit("trace", `[disconnect] ${connectionId} (${code}${reasonMessage ? ` - ${reasonMessage}` : ""})`);
@@ -99,15 +103,22 @@ module.exports = class HttpRunner extends events.EventEmitter
         if ('sPort' in options) this.sPort = options.sPort;
     }
 
-    async _requestListener(ws, incomingMessage) 
+    async _requestListener(ws, incomingMessage, customEventName) 
     {
         try 
         {
             let event = new Configurapi.Event(await WsAdapter.toRequest(ws, incomingMessage));
 
-            await this.service.process(event);
-            
-            await WsAdapter.write(ws, event.response);
+            if(customEventName)
+            {
+                event.name = customEventName;
+                await this.service.process(event);  // No response will be sent back to the caller for 'on_disconnect'
+            }
+            else
+            {
+                await this.service.process(event);
+                await WsAdapter.write(ws, event.response); // Send response back to the caller.
+            }
         }
         catch (error) 
         {

package/src/wsAdapter.js

@@ -138,7 +138,7 @@ module.exports = {
 
     toRequest: async function(ws, incomingMessage)
     {        
-        let data = JSON.parse(incomingMessage);
+        let data = incomingMessage ? JSON.parse(incomingMessage) : {};
 
         let request = new Configurapi.Request();
 
@@ -146,6 +146,7 @@ module.exports = {
         request.headers = data.headers || {};
         request.name =  data.name || undefined;
         request.query = data.query || {};
+        request.params = data.params || {};
         request.payload = data.payload || undefined;
         
         request.headers['connectionId'] = ws.connectionId;