@caboodle-tech/node-simple-server 4.1.1 → 4.2.1

package/README.md

@@ -97,7 +97,13 @@ function watcherCallback(event, path, extension) {
     }
 }
 
-// A bare minimum callback to handle all websocket messages from the frontend.
+/**
+ * A bare minimum callback to handle all websocket messages from the frontend. By
+ * default NSS registers and responds to WebSockets by the web pages pathname. In
+ * a web page:
+ * 
+ * NSS_WS.send([string|int|bool|object]) // Pathname lookup will be used.
+ */
 function websocketCallback(messageObject, pageId) {
     // Interpret and do what you need to with the message:
     const datatype = messageObject.type
@@ -107,9 +113,26 @@ function websocketCallback(messageObject, pageId) {
     // Respond to the page that sent the message if you like:
     Server.message(pageId, 'Messaged received!');
 }
-
 Server.addWebsocketCallback('.*', websocketCallback);
 
+/**
+ * A bare minimum callback to handle all websocket messages from the frontend.
+ * This is a special example that registers a specific route to listen for. In a
+ * web page:
+ * 
+ * NSS_WS.send([string|int|bool|object], [route string]) // Route lookup will be used.
+ */
+function websocketCallback(messageObject, pageId) {
+    // Interpret and do what you need to with the message:
+    const datatype = messageObject.type
+    const data = messageObject.data;
+    console.log(`Route received ${datatype} data from page ${pageId}: ${data}`)
+
+    // Respond to the page that sent the message if you like:
+    Server.message(pageId, 'Route specific messaged received!');
+}
+Server.addWebsocketCallback('api/search', websocketCallback);
+
 // A bare minimum watcher options object; use for development, omit for production.
 const watcherOptions = {
     events: {

package/bin/nss.js

@@ -44,7 +44,7 @@ class NodeSimpleServer {
         map: {}
     };
 
-    #VERSION = '4.1.1';
+    #VERSION = '4.2.1';
 
     #watching = [];
 
@@ -731,7 +731,6 @@ class NodeSimpleServer {
      * @param {object} request The incoming initial connection.
      */
     #socketListener(socket, request) {
-
         // Strip the page ID and /ws tag off the url to get the actual url.
         let cleanURL = request.url.substr(1, request.url.indexOf('/ws?id=') - 1);
         if (!cleanURL) {
@@ -750,7 +749,20 @@ class NodeSimpleServer {
         }
 
         // Record the unique page ID directly on the socket object.
-        const pageId = request.url.substr(request.url.indexOf('?id=')).replace('?id=', '');
+        let idStartIndex;
+        if (request.url.indexOf('?id=') !== -1) {
+            idStartIndex = request.url.indexOf('?id=');
+        } else {
+            idStartIndex = -1;
+        }
+
+        let pageId;
+        if (idStartIndex !== -1) {
+            pageId = request.url.substr(idStartIndex).replace('?id=', '');
+        } else {
+            pageId = 'unknown';
+        }
+
         // eslint-disable-next-line no-param-reassign
         socket.nssUid = pageId;
 
@@ -780,7 +792,17 @@ class NodeSimpleServer {
         // Handle future incoming WebSocket messages from this page.
         socket.on('message', (message) => {
             // NSS messages have a standard format.
-            const msgObj = JSON.parse(message.toString());
+            let msgObj;
+            try {
+                msgObj = JSON.parse(message.toString());
+                if (!('message' in msgObj) || !('type' in msgObj)) {
+                    throw new Error('Bad format!');
+                }
+            } catch (e) {
+                Print.warn('Invalid socket message received! Socket message must be in Node Simple Server\'s format.');
+                return;
+            }
+
             // If message is a ping send pong and stop.
             if (msgObj.type === 'string') {
                 if (msgObj.message === 'ping') {
@@ -788,15 +810,30 @@ class NodeSimpleServer {
                     return;
                 }
             }
+
+            // Pull out specific route if there is one.
+            let route = null;
+            if ('route' in msgObj) {
+                route = msgObj.route;
+            }
+
             // See if the message belongs to a callback and send it there.
             for (let i = 0; i < this.#OPS.callbacks.length; i++) {
                 const regex = this.#OPS.callbacks[i][0];
                 const callback = this.#OPS.callbacks[i][1];
-                if (regex.test(cleanURL)) {
+                // If the message has a route check that only.
+                if (route) {
+                    if (regex.test(route)) {
+                        callback(msgObj, pageId);
+                        return;
+                    }
+                } else if (regex.test(cleanURL)) {
+                    // Default to the URL (pathname).
                     callback(msgObj, pageId);
                     return;
                 }
             }
+
             // No one is listening for this message.
             Print.warn(`Unanswered WebSocket message from ${cleanURL}: ${message.toString()}`);
         });
@@ -813,7 +850,6 @@ class NodeSimpleServer {
                 }
             }
         });
-
     }
 
     /**

package/changelogs/v4.md

@@ -1,3 +1,7 @@
+### NSS 4.2.0 (23 January 2024)
+
+- feat: WebSocket connections can now specify a specific backend route instead of just sending messages to the the listener (if any) for the pages path. 
+
 ### NSS 4.1.1 (22 January 2024)
 
 - fix: Correct a bug in the watcher where we attach a files extension to the stats object. This object is missing when moving directories causing a crash since there is no object to attach the extension, albeit non-existent, to.

package/handlers/live-reloading.html

@@ -91,10 +91,11 @@
             };
 
             /** Send a WebSocket message to the WebSocket server. */
-            const send = (message) => {
+            const send = (message, route = null) => {
                 if (ready && socket.readyState === WebSocket.OPEN) {
                     socket.send(JSON.stringify({
                         message,
+                        route,
                         type: whatIs(message)
                     }));
                     return;
@@ -147,7 +148,7 @@
 
             // Socket specific variables.
             const protocol = window.location.protocol === "http:" ? "ws://" : "wss://";
-            const address = protocol + window.location.host + window.location.pathname + "/ws?id=" + pageId;
+            const address = protocol + window.location.host + pathname + "/ws?id=" + pageId;
             const socket = new WebSocket(address);
 
             // Respond to messages the socket receives.

package/handlers/websocket-only.html

@@ -42,15 +42,16 @@
             };
 
             /** Send a WebSocket message to the WebSocket server. */
-            const send = (message) => {
+            const send = (message, route = null) => {
                 if (ready && socket.readyState === WebSocket.OPEN) {
                     socket.send(JSON.stringify({
                         message,
+                        route,
                         type: whatIs(message)
                     }));
                     return;
                 }
-                console.warn("Node Simple Server: The WebSocket is not ready or the connection was closed.");
+                console.warn('Node Simple Server: The WebSocket is not ready or the connection was closed.');
             };
 
             /** Generate a random unique ID for this page; will be registered in the back-end. */
@@ -90,9 +91,15 @@
             let restartAttempts = 0;
             let restartInterval = null;
 
+            // Prep window path.
+            let pathname = window.location.pathname;
+            if (pathname === '/') {
+                pathname = '';
+            }
+
             // Socket specific variables.
             const protocol = window.location.protocol === "http:" ? "ws://" : "wss://";
-            const address = protocol + window.location.host + window.location.pathname + "/ws?id=" + pageId;
+            const address = protocol + window.location.host + pathname + "/ws?id=" + pageId;
             const socket = new WebSocket(address);
 
             // Respond to messages the socket receives.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@caboodle-tech/node-simple-server",
-    "version": "4.1.1",
+    "version": "4.2.1",
     "description": "Node Simple Server (NSS): A small but effective node based server for development sites, customizable live reloading, and websocket support built-in.",
     "main": "bin/nss.js",
     "scripts": {