@cocreate/socket-server 1.8.1 → 1.9.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+# [1.9.0](https://github.com/CoCreate-app/CoCreate-socket-server/compare/v1.8.2...v1.9.0) (2023-05-24)
+
+
+### Features
+
+* Refactored SocketServer permission checking and added a new function getHost. ([c6a51d1](https://github.com/CoCreate-app/CoCreate-socket-server/commit/c6a51d143fda143aca3d059958bc668f9fac6d04))
+
+## [1.8.2](https://github.com/CoCreate-app/CoCreate-socket-server/compare/v1.8.1...v1.8.2) (2023-05-21)
+
+
+### Bug Fixes
+
+* Refactor socket server to track and limit server bandwidth usage. ([0c4c0f4](https://github.com/CoCreate-app/CoCreate-socket-server/commit/0c4c0f438a27e75d659044bfdcc19f422df67347))
+
 ## [1.8.1](https://github.com/CoCreate-app/CoCreate-socket-server/compare/v1.8.0...v1.8.1) (2023-05-20)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cocreate/socket-server",
-  "version": "1.8.1",
+  "version": "1.9.0",
   "description": "CoCreate-socket-server",
   "keywords": [
     "cocreate-socket",

package/src/index.js

@@ -87,7 +87,7 @@ class SocketServer extends EventEmitter {
         let total_cnt = 0;
         this.clients.forEach((c) => total_cnt += c.length)
 
-        this.emit("createMetrics", null, {
+        this.emit("createMetrics", {
             organization_id,
             client_cnt: room_clients.length,
             total_cnt: total_cnt
@@ -109,7 +109,7 @@ class SocketServer extends EventEmitter {
             if (user_id)
                 this.emit('userStatus', socket, { user_id, status: 'off', organization_id });
 
-            this.emit("deleteMetrics", null, { organization_id });
+            this.emit("deleteMetrics", { organization_id });
             this.emit("deletePermissions", organization_id);
             this.emit('disconnect', organization_id)
             this.asyncMessages.delete(key);
@@ -117,7 +117,7 @@ class SocketServer extends EventEmitter {
             let total_cnt = 0;
             this.clients.forEach((c) => total_cnt += c.length)
 
-            this.emit("changeCountMetrics", null, {
+            this.emit("changeCountMetrics", {
                 organization_id,
                 total_cnt,
                 client_cnt: room_clients.length
@@ -129,78 +129,76 @@ class SocketServer extends EventEmitter {
     async onMessage(req, socket, message) {
         try {
             const organization_id = socket.config.organization_id
-
-            // TODO: remove
-            // if (message instanceof Buffer) {
-            // 	this.emit('importFile2DB', socket, message);
-            // 	console.log('importFile2DB', socket, message);
-            // 	return;
-            // }
-
-            const { action, data } = JSON.parse(message)
+            let { action, data } = JSON.parse(message)
 
             if (action) {
-                this.recordTransfer('in', message, organization_id)
-
+                this.emit("setBandwidth", {
+                    type: 'in',
+                    data: message,
+                    organization_id
+                });
                 let user_id = null;
                 if (this.authInstance)
                     user_id = await this.authInstance.getUserId(req);
 
                 if (this.permissionInstance) {
-                    const permission = await this.permissionInstance.check(action, data, req, user_id)
-                    if (!permission || permission.error) {
-                        // if (action == 'syncServer' && permission.database === true)
-                        // if (action == 'syncServer')
-                        // 	this.emit('createDocument', socket, data);
-                        // else
-                        if (permission.dbUrl === false) {
-                            data.database = process.env.organization_id
-                            data.organization_id = process.env.organization_id
-
-                            const permission2 = await this.permissionInstance.check(action, data, req, user_id)
-                            if (!permission2 || permission2.error) {
-                                return this.send(socket, 'Access Denied', { action, permission2, ...data })
-                            }
-                        } else
-                            return this.send(socket, 'Access Denied', { action, permission, ...data })
+                    data.host = this.getHost(req)
+                    const permission = await this.permissionInstance.check(action, data, user_id)
+                    if (permission.dbUrl === false) {
+                        data.database = process.env.organization_id
+                        data.organization_id = process.env.organization_id
+
+                        const permission2 = await this.permissionInstance.check(action, data, req, user_id)
+                        if (!permission2 || permission2.error) {
+                            return this.send(socket, 'Access Denied', { action, permission2, ...data })
+                        }
+                    } else if (!permission || permission.error) {
+                        if (!user_id)
+                            this.send(socket, 'updateUserStatus', { userStatus: 'off', clientId: data.clientId, organization_id })
+
+                        return this.send(socket, 'Access Denied', { action, permission, ...data })
                     }
-                }
+                    // dburl is true and db does not have 'keys' collection
+                    // action: syncCollection data{collection: 'keys', document[]}
+                    // actions: add keys as once keys are added admin user can do anything
+
+
+                    // }
+
+                    if (permission.authorized)
+                        data = permission.authorized
 
-                if (user_id) {
-                    if (!socket.config.user_id) {
-                        socket.config.user_id = user_id
-                        this.emit('userStatus', socket, { user_id, userStatus: 'on', organization_id });
+                    if (user_id) {
+                        if (!socket.config.user_id) {
+                            socket.config.user_id = user_id
+                            this.emit('userStatus', socket, { user_id, userStatus: 'on', organization_id });
+                        }
+                    } else {
+                        this.send(socket, 'updateUserStatus', { userStatus: 'off', clientId: data.clientId, organization_id })
                     }
-                } else {
-                    this.send(socket, 'updateUserStatus', { userStatus: 'off', clientId: data.clientId, organization_id })
-                }
 
-                //. checking async status....				
-                if (data.async == true) {
-                    console.log('async true')
-                    const asyncMessage = this.asyncMessages.get(socket.config.key);
-                    socket.config.asyncId = uid.generate();
-                    if (asyncMessage) {
-                        asyncMessage.defineMessage(socket.config.asyncId);
+                    //. checking async status....				
+                    if (data.async == true) {
+                        console.log('async true')
+                        const asyncMessage = this.asyncMessages.get(socket.config.key);
+                        socket.config.asyncId = uid.generate();
+                        if (asyncMessage) {
+                            asyncMessage.defineMessage(socket.config.asyncId);
+                        }
                     }
-                }
 
-                this.emit(action, socket, data);
-            }
+                    this.emit(action, socket, data);
 
+                }
+            }
         } catch (e) {
             console.log(e);
         }
     }
 
     broadcast(socket, action, data) {
-        const self = this;
         if (!data.uid)
             data.uid = uid.generate()
-        const responseData = JSON.stringify({
-            action,
-            data
-        });
 
         const asyncId = socket.config.asyncId
         let isAsync = false;
@@ -217,6 +215,7 @@ class SocketServer extends EventEmitter {
             url += `/${namespace}`
         }
 
+
         let rooms = data.room;
         if (rooms) {
             if (!rooms.isArray())
@@ -225,61 +224,63 @@ class SocketServer extends EventEmitter {
                 let url = url;
                 url += `/${room}`;
 
-                const clients = this.clients.get(url);
-                if (clients) {
-                    clients.forEach((client) => {
-                        if (socket != client && data.broadcast != false || socket == client && data.broadcastSender != false) {
-                            if (isAsync) {
-                                asyncData.push({ socket: client, message: responseData })
-                            } else {
-                                client.send(responseData);
-                            }
-                            self.recordTransfer('out', responseData, organization_id)
-                        }
-                    })
-                }
+                this.send(socket, action, data, url, isAsync, asyncData)
             }
-
         } else {
-            this.clients.forEach((value, key) => {
-                if (key.includes(url)) {
-                    value.forEach(client => {
-                        if (socket != client && data.broadcast != false || socket == client && data.broadcastSender != false) {
-                            if (isAsync) {
-                                asyncData.push({ socket: client, message: responseData })
-                            } else {
-                                client.send(responseData);
-                            }
-                            self.recordTransfer('out', responseData, organization_id)
-                        }
-                    })
-                }
-            })
+            this.send(socket, action, data, url, isAsync, asyncData)
         }
 
-        //. set async processing
         if (isAsync) {
             this.asyncMessages.get(socket.config.key).setMessage(asyncId, asyncData)
         }
 
     }
 
-    send(socket, action, data) {
+    async send(socket, action, data, url, isAsync, asyncData) {
         const asyncId = socket.config.asyncId
-        let responseData = JSON.stringify({
-            action,
-            data
-        });
 
-        if (asyncId && socket.config && socket.config.key) {
+        if (!url && asyncId && socket.config && socket.config.key) {
+            let responseData = JSON.stringify({
+                action,
+                data
+            });
             this.asyncMessages.get(socket.config.key).setMessage(asyncId, [{ socket, message: responseData }]);
         } else {
-            socket.send(responseData);
+            let clients
+            if (!url)
+                clients = [socket]
+            else
+                clients = this.clients.get(url);
+
+            if (clients) {
+                for (let client of clients) {
+                    if (socket != client && data.broadcast != false || socket == client && data.broadcastSender != false) {
+                        if (isAsync) {
+                            asyncData.push({ socket, message: JSON.stringify({ action, data }) })
+                        } else {
+                            const permission = await this.permissionInstance.check(action, data, socket.config.user_id)
+                            if (permission && permission.authorized)
+                                data = permission.authorized
+
+                            let responseData = JSON.stringify({
+                                action,
+                                data
+                            });
+
+                            socket.send(responseData);
+
+                            if (socket.config && socket.config.organization_id)
+                                this.emit("setBandwidth", {
+                                    type: 'out',
+                                    data: responseData,
+                                    organization_id: socket.config.organization_id
+                                })
+                        }
+                    }
+                }
+            }
         }
 
-        if (socket.config && socket.config.organization_id)
-            this.recordTransfer('out', responseData, socket.config.organization_id)
-
     }
 
     // addAsyncMessage(key) {
@@ -302,19 +303,13 @@ class SocketServer extends EventEmitter {
         return params
     }
 
-
-    sendBinary(socket, data, organization_id) {
-        socket.send(data, { binary: true });
-        this.recordTransfer('out', data, organization_id)
+    getHost(req) {
+        const headers = req['headers']
+        let origin = headers['origin'];
+        if (origin && origin !== 'null')
+            return url.parse(origin).hostname;
     }
 
-    recordTransfer(type, data, organization_id) {
-        this.emit("setBandwidth", null, {
-            type,
-            data,
-            organization_id
-        });
-    }
 }