@caboodle-tech/node-simple-server 4.1.0 → 4.2.0

package/README.md

@@ -87,7 +87,7 @@ function watcherCallback(event, path, extension) {
         /**
          * NOTE: This is a heavy request to use if your site loads resources from
          * other sites such as images, databases, or API calls. Consider a better
-         * approach in this cases such as throttling.
+         * approach in these cases such as throttling.
          */
         Server.reloadAllPages();
         return;
@@ -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

@@ -8,6 +8,7 @@ import { fileURLToPath } from 'url';
 
 import ContentTypes from '../handlers/js/content-types.js';
 import HTTPStatus from '../handlers/js/http-status.js';
+import Print from './print.js';
 
 // eslint-disable-next-line no-underscore-dangle
 const __filename = fileURLToPath(import.meta.url);
@@ -43,7 +44,7 @@ class NodeSimpleServer {
         map: {}
     };
 
-    #VERSION = '4.1.0';
+    #VERSION = '4.2.0';
 
     #watching = [];
 
@@ -730,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) {
@@ -749,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;
 
@@ -779,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') {
@@ -787,17 +810,32 @@ 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.
-            console.log(`Unanswered WebSocket message from ${cleanURL}: ${message.toString()}`);
+            Print.warn(`Unanswered WebSocket message from ${cleanURL}: ${message.toString()}`);
         });
 
         // When a connection closes remove it from CONNECTIONS.
@@ -813,6 +851,7 @@ class NodeSimpleServer {
             }
         });
 
+        console.log(this.#OPS.callbacks);
     }
 
     /**
@@ -842,7 +881,7 @@ class NodeSimpleServer {
 
         // Don't start an already running server.
         if (this.#OPS.running) {
-            console.log('Server is already running.');
+            Print.warn('Server is already running.');
             // Notify the callback.
             if (callback) {
                 callback(true);
@@ -878,7 +917,8 @@ class NodeSimpleServer {
                 if (port) {
                     // Stop trying new ports after 100 attempts.
                     if (this.#OPS.port - port > 100) {
-                        console.log(`FATAL ERROR: Could not find an available port number in the range of ${this.#OPS.port}–${this.#OPS.port + 100}.`);
+                        // eslint-disable-next-line max-len
+                        Print.error(`FATAL ERROR: Could not find an available port number in the range of ${this.#OPS.port}–${this.#OPS.port + 100}.`);
                         // Notify the callback.
                         if (callback) {
                             callback(false);
@@ -891,7 +931,7 @@ class NodeSimpleServer {
                 }
                 return;
             }
-            console.log('Server error', error);
+            Print.error(`Server Error:\n${error}`);
         });
 
         // Attempt to start the server now.
@@ -907,19 +947,19 @@ class NodeSimpleServer {
 
             // Warn the user if we had to change port numbers.
             if (port && (port !== this.#OPS.port)) {
-                console.log(`Port ${this.#OPS.port} was in use, switched to using ${port}.\n`);
+                Print.warn(`Port ${this.#OPS.port} was in use, switched to using ${port}.\n`);
             }
 
             // Record port in use.
             this.#OPS.portInUse = port;
 
             // Log the ip addresses being watched.
-            console.log('Node Simple Server live @:');
+            Print.notice('Node Simple Server live @:');
             const addresses = this.getAddresses(port);
             addresses.forEach((address) => {
-                console.log(`    ${address}`);
+                Print.notice(`    ${address}`);
             });
-            console.log('');
+            Print.log('');
 
             // Notify the callback.
             if (callback) {
@@ -953,7 +993,7 @@ class NodeSimpleServer {
             this.#server = null;
             this.#socket = null;
             this.#OPS.running = false;
-            console.log('Server has been stopped.');
+            Print.notice('Server has been stopped.');
         }
         // Notify the callback.
         if (callback) {
@@ -1031,7 +1071,7 @@ class NodeSimpleServer {
                  * all backslashes (\) into forward slashes (/).
                  */
                 if (alterCatachAlls.includes(key)) {
-                    watcher.on(key, (evt, path, statsOrDetails) => {
+                    watcher.on(key, (evt, path, statsOrDetails = {}) => {
                         // Capture the call and alter the path before passing it on.
                         const altPath = path.replace(/\\/g, '/');
                         // Since we're messing with the path already grab the extension for the user.
@@ -1040,7 +1080,7 @@ class NodeSimpleServer {
                         options.events[key](evt, altPath, statsOrDetails);
                     });
                 } else if (alterAddUpdates.includes(key)) {
-                    watcher.on(key, (path, statsOrDetails) => {
+                    watcher.on(key, (path, statsOrDetails = {}) => {
                         // Capture the call and alter the path before passing it on.
                         const altPath = path.replace(/\\/g, '/');
                         // Since we're messing with the path already grab the extension for the user.
@@ -1061,7 +1101,7 @@ class NodeSimpleServer {
                 }
             });
         } catch (error) {
-            console.log(error);
+            Print.error(error);
             return false;
         }
         return true;

package/bin/print.js

@@ -0,0 +1,64 @@
+/* eslint-disable no-console */
+
+class Print {
+
+    #enabled = true;
+
+    disable() {
+        this.#enabled = false;
+    }
+
+    enable() {
+        this.#enabled = true;
+    }
+
+    error(message, override = false) {
+        if (!this.#enabled && !override) {
+            return;
+        }
+        // Red color
+        console.error(this.#formatMessage(message, '\x1b[31m'));
+    }
+
+    #formatMessage(message, colorCode) {
+        const resetCode = '\x1b[0m';
+        return `${colorCode}${message}${resetCode}`;
+    }
+
+    log(message, override = false) {
+        if (!this.#enabled && !override) {
+            return;
+        }
+        // White color
+        console.log(this.#formatMessage(message, '\x1b[37m'));
+    }
+
+    notice(message, override = false) {
+        if (!this.#enabled && !override) {
+            return;
+        }
+        // Blue color
+        console.log(this.#formatMessage(message, '\x1b[94m'));
+    }
+
+    success(message, override = false) {
+        if (!this.#enabled && !override) {
+            return;
+        }
+        // Green color
+        console.log(this.#formatMessage(message, '\x1b[32m'));
+    }
+
+    warn(message, override = false) {
+        if (!this.#enabled && !override) {
+            return;
+        }
+        // Yellow color
+        console.warn(this.#formatMessage(message, '\x1b[33m'));
+    }
+
+}
+
+const printer = new Print();
+
+export default printer;

package/changelogs/v4.md

@@ -1,3 +1,12 @@
+### 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.
+- improve: Quality of life improvement by adding the Caboodle Tech Print class to replace console output; Now in color!
+
 ### NSS 4.0.0 (7 January 2024)
 
 - !feat: Correct bug caused by NSS non-standard implementation of Chokidar; see below.

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.0",
+    "version": "4.2.0",
     "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": {