Ensure WS messages are sent to correct recipients

In most cases, we don't want to send a websocket message to all
connected clients. The messages clients should receive depends on the
user type and the user's association (if any) with the object the
message pertains to. This commit ensures that only appropriate clients
receive messages.

Includes:
- Added new WebocketServer.recipientsMessage method. This method
receives an array of user IDs that should receive the message, it then
iterates through this and sends the message to any connected clients in
that list.
- Added "who should receive this message" logic to all side effect
functions, mostly making use of the new 'associated' DB resolver

Author: Andrew Isherwood

classes/WebsocketServer.js

@@ -42,7 +42,9 @@ class WebsocketServer {
     // Return an array of all connected client user IDs
     connectedClientUserIds() {
         const ids = [];
-        this.socketServer.clients.forEach((client) => ids.push(client.userId));
+        this.socketServer.clients.forEach(
+            (client) => ids.push(client.userId)
+        );
         return ids;
     }
     // Send a message to all available clients
@@ -61,6 +63,20 @@ class WebsocketServer {
             }
         });
     }
+    // Send a message to a specific list of recipients, as long as they're
+    // connected
+    recipientsMessage({ recipients, initiator, subject, action, payload }) {
+        this.socketServer.clients.forEach((client) => {
+            if (
+                recipients.indexOf(client.userId) > -1 &&
+                client.readyState === WebSocket.OPEN
+            ) {
+                client.send(
+                    JSON.stringify({ initiator, subject, action, payload })
+                );
+            }
+        });
+    }
     // Send a message to all client *except* the one that initiated
     // the action
     excludeInitiatorMessage({ initiator, subject, action, payload }) {

middleware/side-effects/folders.js

@@ -2,28 +2,26 @@ const WebsocketServer = require('../../classes/WebsocketServer');
 const db = require('../../../ems-db');
 
 const folders = {
-    // Send updated folder counts to anyone who is connected
-    // and can see the given query
+    // Send updated folder counts to any staff connected
     folderCountsToClients: async (req, res, next) => {
-        // Get the user objects associated with connected clients
         const activeClientIds = WebsocketServer.connectedClientUserIds();
-        const activeClients = await db.resolvers.users.allUsers({
-            query: { user_ids: activeClientIds.join('_') }
-        });
-
-        activeClients.rows.forEach((client) => {
-            // We don't await here because these can be sent async
-            db.resolvers.folders
-                .folderCounts({ user: client })
-                .then((folderCounts) => {
-                    WebsocketServer.onlyInitiatorMessage({
-                        initiator: client.id,
-                        subject: 'folderCount',
-                        action: 'update',
-                        payload: folderCounts
-                    });
-                })
-                .catch((err) => err);
+        // Get the user objects associated with all staff
+        const allStaff = await db.resolvers.users.allStaff();
+        allStaff.rows.forEach((staff) => {
+            if (activeClientIds.indexOf(staff.id) > -1) {
+                // We don't await here because these can be sent async
+                db.resolvers.folders
+                    .folderCounts({ user: staff })
+                    .then((folderCounts) => {
+                        WebsocketServer.onlyInitiatorMessage({
+                            initiator: staff.id,
+                            subject: 'folderCount',
+                            action: 'update',
+                            payload: folderCounts
+                        });
+                    })
+                    .catch((err) => err);
+            }
         });
         next();
     }

middleware/side-effects/labels.js

@@ -2,40 +2,43 @@ const WebsocketServer = require('../../classes/WebsocketServer');
 const db = require('../../../ems-db');
 
 const labels = {
-    // Inform all clients, apart from the initiator, that
+    // Inform all staff, apart from the initiator, that
     // a label has been created or updated
-    labelToClients: (req, res, next) => {
+    labelToClients: async (req, res, next) => {
         const methodToAction = {
             POST: 'create',
             PUT: 'update',
             DELETE: 'delete'
         };
         const { label } = req.wsData;
-        // Send the new message via the websocket
-        WebsocketServer.excludeInitiatorMessage({
+        // Get the recipients
+        const allStaff = await db.resolvers.users.allStaff();
+        const recipients = allStaff.rows
+            .filter((staff) => staff.id !== req.user.id)
+            .map((toMap) => toMap.id);
+
+        WebsocketServer.recipientsMessage({
+            recipients,
             initiator: req.user.id,
             subject: 'label',
             action: methodToAction[req.method],
             payload: label
         });
         next();
     },
-    // Send updated label counts to anyone who is connected
-    // and can see the given query
+    // Send updated label counts to all staff
     labelCountsToClients: async (req, res, next) => {
-        // Get the user objects associated with connected clients
-        const activeClientIds = WebsocketServer.connectedClientUserIds();
-        const activeClients = await db.resolvers.users.allUsers({
-            query: { user_ids: activeClientIds.join('_') }
-        });
+        // Get the recipients
+        const allStaff = await db.resolvers.users.allStaff();
 
-        activeClients.rows.forEach((client) => {
-            // We don't await here because these can be sent async
+        // Iterate through each recipient
+        allStaff.rows.forEach((recipient) => {
+            // Get this recipient's label counts
             db.resolvers.labels
-                .labelCounts({ user: client })
+                .labelCounts({ user: recipient })
                 .then((labelCounts) => {
                     WebsocketServer.onlyInitiatorMessage({
-                        initiator: client.id,
+                        initiator: recipient.id,
                         subject: 'labelCount',
                         action: 'update',
                         payload: labelCounts

middleware/side-effects/messages.js

@@ -1,26 +1,45 @@
 const WebsocketServer = require('../../classes/WebsocketServer');
 
+const db = require('../../../ems-db');
+
 const messages = {
-    // Inform all clients, apart from the initiator, that
+    // Inform all participants, apart from the initiator, that
     // a message has been created or updated
-    newMessageToClients: (req, res, next) => {
+    newMessageToClients: async (req, res, next) => {
         const socketAction = req.method === 'POST' ? 'create' : 'update';
         const { message } = req.wsData;
+        // Find out who should receive this message
+        const allAssociated = await db.resolvers.queries.associated(
+            [message.query_id]
+        );
+        const recipients = allAssociated.filter(
+            (associated) => associated !== req.user.id
+        );
+        console.log(recipients);
         // Send the new message via the websocket
-        WebsocketServer.excludeInitiatorMessage({
+        WebsocketServer.recipientsMessage({
+            recipients,
             initiator: message.creator_id,
             subject: 'message',
             action: socketAction,
             payload: message
         });
         next();
     },
-    // Inform all clients, apart from the initiator, that
+    // Inform all participants, apart from the initiator, that
     // a message has been deleted
-    deletedMessageToClients: (req, res, next) => {
+    deletedMessageToClients: async (req, res, next) => {
         const { message } = req.wsData;
+        // Find out who should receive this message
+        const allAssociated = await db.resolvers.queries.associated(
+            [message.query_id]
+        );
+        const recipients = allAssociated.filter(
+            (associated) => associated !== req.user.id
+        );
         // Send the deleted message details via the websocket
-        WebsocketServer.excludeInitiatorMessage({
+        WebsocketServer.recipientsMessage({
+            recipients,
             initiator: message.creator_id,
             subject: 'message',
             action: 'delete',

middleware/side-effects/queries.js

@@ -6,8 +6,16 @@ const queries = {
     createdQueryToClients: async (req, res, next) => {
         const { queries } = req.wsData;
         // Send the updated query via the websocket
-        // but not to the user who created the message
-        WebsocketServer.excludeInitiatorMessage({
+        // Find out who should receive this message
+        const queryIds = queries.map((query) => query.id);
+        const allAssociated = await db.resolvers.queries.associated(queryIds);
+        // Remove the creator of the query, they will have received it in
+        // the API response
+        const recipients = allAssociated.filter(
+            (associated) => associated !== queries[0].initiator
+        );
+        WebsocketServer.recipientsMessage({
+            recipients,
             initiator: queries[0].initiator,
             subject: 'query',
             action: 'create',
@@ -19,8 +27,17 @@ const queries = {
     updatedQueriesToClients: async (req, res, next) => {
         const { queries } = req.wsData;
         const toSend = await helpers.addEmbeds(queries);
+        // Find out who should receive this message
+        const queryIds = queries.map((query) => query.id);
+        const allAssociated = await db.resolvers.queries.associated(queryIds);
+        // Remove the updater of the query, they will have received it in
+        // the API response
+        const recipients = allAssociated.filter(
+            (associated) => associated !== req.user.id
+        );
         // Send the updated query via the websocket
-        WebsocketServer.broadcastMessage({
+        WebsocketServer.recipientsMessage({
+            recipients,
             subject: 'query',
             action: 'update',
             payload: toSend

middleware/side-effects/uploads.js

@@ -1,12 +1,21 @@
 const WebsocketServer = require('../../classes/WebsocketServer');
+const db = require('../../../ems-db');
 
 const uploads = {
     // Inform all clients, apart from the initiator, that
     // one or more uploads have been sent
-    newUploadToClients: (req, res, next) => {
+    newUploadToClients: async (req, res, next) => {
         const { uploads } = req.wsData;
+        // Find out who should receive this message
+        const allAssociated = await db.resolvers.queries.associated(
+            [uploads[0].query_id]
+        );
+        const recipients = allAssociated.filter(
+            (associated) => associated !== req.user.id
+        );
         // Send the new message via the websocket
-        WebsocketServer.excludeInitiatorMessage({
+        WebsocketServer.recipientsMessage({
+            recipients,
             initiator: uploads[0].creator_id,
             subject: 'upload',
             action: 'create',