Added support for single-user outbound messages

coreWidgets/yad-toggle-switch/yad-switch-node.js

@@ -44,28 +44,36 @@ module.exports = function(RED) {
 
   yadNode.prototype.recMessage = function(m) {
     var node = this;
-    var msg = {};
+    var msg = {
+      _socketid: m._socketid
+    };
     if(node.config.topic !== '') {
       msg.topic = node.config.topic;
     }
     if(m.payload === true) {
-      node.sendBackToUIHelper(true);
+      node.sendBackToUIHelper(true, m._socketid);
       msg.payload = RED.util.evaluateNodeProperty(node.config.onValue, node.config.onValueType, node);
       node.send(msg);
     } else if(m.payload === false) {
-      node.sendBackToUIHelper(false);
+      node.sendBackToUIHelper(false, m._socketid);
       msg.payload = RED.util.evaluateNodeProperty(node.config.offValue, node.config.offValueType, node);
       node.send(msg);
     }
   }
 
-  yadNode.prototype.sendBackToUIHelper = function(state) {
+  yadNode.prototype.sendBackToUIHelper = function(state, _socketid) {
     var node = this;
     if(!node.config.decoupled) {
       if(node.config.replay === true) {
-        node.yad.sendMessage(node, {payload: state}, 'state');
+        node.yad.sendMessage(node, {
+          payload: state,
+          _socketid
+        }, 'state');
       } else {
-        node.yad.sendMessage(node, {payload: state});
+        node.yad.sendMessage(node, {
+          payload: state,
+          _socketid
+        });
       }
     }
   }

nodes/yad-client-node.html

@@ -1,6 +1,6 @@
 <!--
   Copyright (c) 2020 cinhcet
- 
+
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at
@@ -21,7 +21,7 @@
     defaults: {
       yad: {
         value: "",
-        required: true,
+        required: false,
         type: "yad-configuration"
       },
       name: {
@@ -32,7 +32,7 @@
     outputs: 1,
     icon: "yad-icon.svg",
     label: function() {
-      return this.name || "ui client connect";
+      return this.name || "client node";
     },
     paletteLabel: 'client node'
   });
@@ -50,5 +50,7 @@
 </script>
 
 <script type="text/x-red" data-help-name="yad-client-node">
-  <p>Emits message if new ui client connects</p>
+  <p>Emits messages when UI clients connect to, or disconnect from, the configured dashboards.</p>
+  <p>If you specify a YAD Configuration, the node will notify about user activity regarding to the related dashboard only.
+    Otherwise, the node will notify about any configured dashboard.</p>
 </script>

nodes/yad-client-node.js

@@ -21,17 +21,44 @@ module.exports = function(RED) {
     RED.nodes.createNode(this, config);
     var node = this;
     node.config = config;
-    node.yad = RED.nodes.getNode(node.config.yad);
-
-    function newClientConnectedCallback() {
-      node.send({payload: 'newClientConnected'});
+
+    function registerClientEventHandlers(yadConfiguration) {
+      function sendConnectionMessage(message) {
+        node.send({
+          payload: 'newClientConnected',
+          _dashboard: yadConfiguration.name,
+          ...message
+        });
+      }
+
+      function sendDisconnectionMessage(message) {
+        node.send({
+          payload: 'clientDisconnected',
+          _dashboard: yadConfiguration.name,
+          ...message
+        });
+      }
+
+      yadConfiguration.eventEmitter.on('newClientConnected', sendConnectionMessage);
+      yadConfiguration.eventEmitter.on('clientDisconnected', sendDisconnectionMessage);
+
+      node.on('close', function() {
+        yadConfiguration.eventEmitter.removeListener('newClientConnected', sendConnectionMessage);
+        yadConfiguration.eventEmitter.removeListener('clientDisconnected', sendDisconnectionMessage);
+      });
     }
 
-    node.yad.eventEmitter.on('newClientConnected', newClientConnectedCallback);
-
-    node.on('close', function() {
-      node.yad.eventEmitter.removeListener('newClientConnected', newClientConnectedCallback);
-    });
+    if(node.config.yad) {
+      var yadConfiguration = RED.nodes.getNode(node.config.yad);
+      registerClientEventHandlers(yadConfiguration);
+    } else {
+      RED.nodes.eachNode(function(n) {
+        if(n.type === 'yad-configuration') {
+          var yadConfiguration = RED.nodes.getNode(n.id);
+          registerClientEventHandlers(yadConfiguration);
+        }
+      });
+    }
   }
 
   RED.nodes.registerType("yad-client-node", yadNode);

nodes/yad-node.html

@@ -1,6 +1,6 @@
 <!--
   Copyright (c) 2020 cinhcet
- 
+
   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at
@@ -25,8 +25,7 @@
         type: "yad-configuration"
       },
       elementID: {
-        value: "",
-        required: true
+        value: ""
       },
       replayLastMessage: {
         value: false
@@ -42,8 +41,8 @@
     outputs: 1,
     icon: "yad-icon.svg",
     label: function() {
-      return this.name || this.elementID;
-    }, 
+      return this.name || this.elementID || 'universal node';
+    },
     paletteLabel: 'universal node'
   });
 </script>

nodes/yad.js

@@ -55,7 +55,10 @@ module.exports = function(RED) {
     var socketIoPath = join(fullPath, 'socket.io');
 
     if(!socketIOInstances.has(node.yadPath)) {
-      let socketIOInstance = socketIO(server, {path: socketIoPath});
+      let socketIOInstance = socketIO(server, {
+        path: socketIoPath,
+        cookiePath: RED.settings.httpNodeRoot.replace(/\/$/, '') || '/'
+      });
       socketIOInstance.use(function(socket, next) {
         if(socket.handshake.xdomain === false) {
           return next();
@@ -105,13 +108,20 @@ module.exports = function(RED) {
       node.socketList[socket.id] = socket;
 
       // emit event when new ui client connects
-      node.eventEmitter.emit('newClientConnected');
+      node.eventEmitter.emit('newClientConnected', {
+        _socketid: socket.id,
+        _cookies: socket.handshake.headers.cookie,
+        _useragent: socket.handshake.headers['user-agent']
+      });
 
       // receive message from ui
       socket.on('toNR', function(msg) {
-        if(msg.hasOwnProperty('elementID') && msg.hasOwnProperty('msg')) {
-          if(node.elementNodes.hasOwnProperty(msg.elementID)) {
-            node.elementNodes[msg.elementID].recMessage(msg.msg);
+        if(msg.hasOwnProperty('msg')) {
+          msg.msg._socketid = socket.id;
+          if(msg.hasOwnProperty('elementID')) {
+            if(node.elementNodes.hasOwnProperty(msg.elementID)) {
+              node.elementNodes[msg.elementID].recMessage(msg.msg);
+            }
           }
         }
       });
@@ -140,6 +150,13 @@ module.exports = function(RED) {
 
       socket.on('disconnect', function() {
         delete node.socketList[socket.id];
+
+        // emit event when ui client disconnects
+        node.eventEmitter.emit('clientDisconnected', {
+          _socketid: socket.id,
+          _cookies: socket.handshake.headers.cookie,
+          _useragent: socket.handshake.headers['user-agent']
+        });
       });
     });
 
@@ -168,15 +185,33 @@ module.exports = function(RED) {
 
   yad.prototype.sendMessage = function(elementNode, msg, replayMsgId) {
     var node = this;
-    var sendMsg = {elementID: elementNode.elementID, msg: msg, type: 'msg'};
-    node.io.emit('fromNR', JSON.stringify(sendMsg));
-
-    // optional save message for replay when a new client connects
-    if(replayMsgId) {
-      if(typeof replayMsgId === 'string') {
-        elementNode.replayMessages[replayMsgId] = msg;
+    var sendMsg = {elementID: msg._elementid || elementNode.elementID, msg: msg, type: 'msg'};
+    if(!sendMsg.elementID) {
+      elementNode.warn('Element ID must either be configured in node or specified by msg._elementid');
+    } else {
+      if(msg.hasOwnProperty('_socketid')) {
+        (Array.isArray(msg._socketid) ? msg._socketid : [msg._socketid])
+          .forEach(function(socketId) {
+            if(typeof socketId === 'string') {
+              const socket = node.socketList[socketId];
+              if(socket) {
+                socket.emit('fromNR', JSON.stringify(sendMsg));
+              }
+            } else {
+              elementNode.warn('_socketid must be a string or a string array');
+            }
+          });
       } else {
-        elementNode.warn('replayMsgId is not a string');
+        node.io.emit('fromNR', JSON.stringify(sendMsg));
+      }
+
+      // optional save message for replay when a new client connects
+      if(replayMsgId) {
+        if(typeof replayMsgId === 'string') {
+          elementNode.replayMessages[replayMsgId] = msg;
+        } else {
+          elementNode.warn('replayMsgId is not a string');
+        }
       }
     }
   }
@@ -276,7 +311,7 @@ module.exports = function(RED) {
       node.copySrcFile('../templates/bareboneDashboardTemplate/index.html');
       node.copySrcFile('../templates/bareboneDashboardTemplate/widgets.js');
       node.copySrcFile('../templates/bareboneDashboardTemplate/style.css');
-      
+
       node.createManifestJSON();
 
     } catch(e) {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-red-contrib-component-dashboard",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "dashboard",
   "keywords": [
     "node-red",
@@ -15,7 +15,7 @@
     "parcel-bundler": "^1.11.0",
     "yad-icons-iconify": "cinhcet/yad-icons-iconify",
     "lit-element": "^2.3.1",
-    "justgage": "^1.3.5" 
+    "justgage": "^1.3.5"
   },
   "node-red": {
     "nodes": {