@cocreate/socket-server 1.1.13 → 1.2.0

package/CHANGELOG.md

@@ -1,3 +1,18 @@
+# [1.2.0](https://github.com/CoCreate-app/CoCreate-socket-server/compare/v1.1.13...v1.2.0) (2022-03-06)
+
+
+### Bug Fixes
+
+* broadcast_sender if condition ([663da41](https://github.com/CoCreate-app/CoCreate-socket-server/commit/663da417cb127048a5bf7be92b3988ba88c9ad37))
+* removed querystring dependancy ([340b131](https://github.com/CoCreate-app/CoCreate-socket-server/commit/340b13124fc3d222cdd57c0b20db0913a71eb807))
+* update param roomInfo to socketInfo ([7d651d6](https://github.com/CoCreate-app/CoCreate-socket-server/commit/7d651d65b1299b18499559a747eba6b10395ef00))
+* update param ws to socket for convetion purposes ([17e5989](https://github.com/CoCreate-app/CoCreate-socket-server/commit/17e598940acec73286465c5947a9b9b9d58b0c56))
+
+
+### Features
+
+* broadcast supports multiple rooms ([a8edf12](https://github.com/CoCreate-app/CoCreate-socket-server/commit/a8edf125e0b925e597bd54f7179e1c9aae3b39c3))
+
 ## [1.1.13](https://github.com/CoCreate-app/CoCreate-socket-server/compare/v1.1.12...v1.1.13) (2022-03-03)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cocreate/socket-server",
-  "version": "1.1.13",
+  "version": "1.2.0",
   "description": "CoCreate-socket-server",
   "keywords": [
     "cocreate-socket",
@@ -41,9 +41,7 @@
   "homepage": "https://cocreate.app/docs/CoCreate-socket-server",
   "dependencies": {
     "@cocreate/docs": "^1.2.70",
-    "@cocreate/uuid": "^1.1.60",
-    "querystring": "^0.2.0",
-    "ws": "^7.3.0"
+    "@cocreate/uuid": "^1.1.60"
   },
   "devDependencies": {
     "express": "^4.17.1",

package/src/index.js

@@ -1,5 +1,3 @@
-
-const qs = require('querystring');
 const WebSocket = require('ws');
 const url = require("url");
 const EventEmitter = require("events").EventEmitter;
@@ -32,55 +30,55 @@ class SocketServer extends EventEmitter{
 	handleUpgrade(req, socket, head) {
 		const self = this;
 		const pathname = url.parse(req.url).pathname;
-		const url_info = this.getKeyFromUrl(pathname)
-		if (url_info.type == this.prefix) {
-			self.wss.handleUpgrade(req, socket, head, function(ws) {
-				self.onWebSocket(req, ws, url_info);
+		const socketInfo = this.getKeyFromUrl(pathname)
+		if (socketInfo.type == this.prefix) {
+			self.wss.handleUpgrade(req, socket, head, function(socket) {
+				self.onWebSocket(req, socket, socketInfo);
 			})
 			return true;
 		}
 		return false;
 	}
 	
-	onWebSocket(req, ws, info) {
+	onWebSocket(req, socket, socketInfo) {
 		const self = this;
 		
-		this.addClient(ws, info.key, info);
+		this.addClient(socket, socketInfo.key, socketInfo);
 
-		ws.on('message', async (message) => {
-			await self.onMessage(req, ws, message, info);
+		socket.on('message', async (message) => {
+			await self.onMessage(req, socket, message, socketInfo);
 		})
 		
-		ws.on('close', function () {
-			self.removeClient(ws, info.key, info)
+		socket.on('close', function () {
+			self.removeClient(socket, socketInfo.key, socketInfo)
 		})
 
-		ws.on("error", () => {
-			self.removeClient(ws, info.key, info)
+		socket.on("error", () => {
+			self.removeClient(socket, socketInfo.key, socketInfo)
 		});
 		
-		this.send(ws, 'connect', info.key);
+		this.send(socket, 'connect', socketInfo.key);
 		
 	}
 	
-	removeClient(ws, key, roomInfo) {
+	removeClient(socket, key, socketInfo) {
 		let room_clients = this.clients.get(key)
-		const index = room_clients.indexOf(ws);
+		const index = room_clients.indexOf(socket);
 
 		if (index > -1) {
 			room_clients.splice(index, 1);
 		}
 		
 		if (room_clients.length == 0) {
-			this.emit('userStatus', ws, {info: key.replace(`/${this.prefix}/`, ''), status: 'off'}, roomInfo);
-			this.emit("removeMetrics", null, { org_id: roomInfo.orgId });
+			this.emit('userStatus', socket, {info: key.replace(`/${this.prefix}/`, ''), status: 'off'}, socketInfo);
+			this.emit("removeMetrics", null, { org_id: socketInfo.orgId });
 			// this.addAsyncMessage.delete(key);
 		} else {
 			let total_cnt = 0;
 			this.clients.forEach((c) => total_cnt += c.length)
 			
 			this.emit("changeCountMetrics", null, {
-				org_id: roomInfo.orgId, 
+				org_id: socketInfo.orgId, 
 				total_cnt, 
 				client_cnt: room_clients.length
 			});
@@ -88,24 +86,24 @@ class SocketServer extends EventEmitter{
 		
 	}
 	
-	addClient(ws, key, roomInfo) {
+	addClient(socket, key, socketInfo) {
 		let room_clients = this.clients.get(key);
 		if (room_clients) {
-			room_clients.push(ws);
+			room_clients.push(socket);
 		} else {
-			room_clients = [ws];
+			room_clients = [socket];
 		}
 		this.clients.set(key, room_clients);
-		this.addAsyncMessage(roomInfo.key)
+		this.addAsyncMessage(socketInfo.key)
 		
-		this.emit('userStatus', ws, {info: key.replace(`/${this.prefix}/`, ''), status: 'on'}, roomInfo);
+		this.emit('userStatus', socket, {info: key.replace(`/${this.prefix}/`, ''), status: 'on'}, socketInfo);
 
 		//. add metrics
 		let total_cnt = 0;
 		this.clients.forEach((c) => total_cnt += c.length)
 		
 		this.emit("createMetrics", null, {
-			org_id: roomInfo.orgId, 
+			org_id: socketInfo.orgId, 
 			client_cnt: room_clients.length, 
 			total_cnt: total_cnt
 		});
@@ -131,19 +129,18 @@ class SocketServer extends EventEmitter{
 		return params
 	}
 	
-	async onMessage(req, ws, message, roomInfo) {
+	async onMessage(req, socket, message, socketInfo) {
 		try {
-			this.recordTransfer('in', message, roomInfo.orgId)
+			this.recordTransfer('in', message, socketInfo.orgId)
 			
 			// ToDo remove
 			if (message instanceof Buffer) {
-				this.emit('importFile2DB', ws, message, roomInfo);
-				console.log('importFile2DB', ws, message, roomInfo);
+				this.emit('importFile2DB', socket, message, socketInfo);
+				console.log('importFile2DB', socket, message, socketInfo);
 				return;
 			}
 			
 			const requestData = JSON.parse(message)
-			let cloneRoomInfo = {...roomInfo};
 
 			if (requestData.module) {
 				let user_id = null;
@@ -155,20 +152,20 @@ class SocketServer extends EventEmitter{
 				if (this.permissionInstance) {
 					let passStatus = await this.permissionInstance.check(requestData.module, requestData.data, req, user_id)
 					if (!passStatus) {
-						this.send(ws, 'permissionError', requestData.data, cloneRoomInfo.orgId, cloneRoomInfo)
+						this.send(socket, 'permissionError', requestData.data, socketInfo.orgId, socketInfo)
 						return;
 					}
 				}
 				
 				//. checking async status....				
 				if (requestData.data.async == true) {
-					const uuid = CoCreateUUID.generate(), asyncMessage = this.asyncMessages.get(cloneRoomInfo.key);
-					cloneRoomInfo.asyncId = uuid;
+					const uuid = CoCreateUUID.generate(), asyncMessage = this.asyncMessages.get(socketInfo.key);
+					socketInfo.asyncId = uuid;
 					if (asyncMessage) {
 						asyncMessage.defineMessage(uuid);
 					}
 				}
-				this.emit(requestData.module, ws, requestData.data, cloneRoomInfo);
+				this.emit(requestData.module, socket, requestData.data, socketInfo);
 			}
 			
 		} catch(e) {
@@ -176,40 +173,40 @@ class SocketServer extends EventEmitter{
 		}
 	}
 	
-	broadcast(ws, namespace, room, messageType, data, isExact, roomInfo) {
+	broadcast(socket, namespace, rooms, messageName, data, socketInfo) {
 		const self = this;
-		const asyncId = this.getAsyncId(roomInfo)
+		const asyncId = this.getAsyncId(socketInfo)
 	    let room_key = `/${this.prefix}/${namespace}`;
-	    if (room) {
-	    	room_key += `/${room}`;	
-	    }
 	    const responseData =JSON.stringify({
-			module: messageType,
+			module: messageName,
 			data: data
 		});
 		
 		let isAsync = false;
 		let asyncData = [];
-		if (asyncId && roomInfo && roomInfo.key) {
+		if (asyncId && socketInfo && socketInfo.key) {
 			isAsync = true;	
 		}
-		
-		if (isExact) {
-			const clients = this.clients.get(room_key);
-			// console.log('client-count, room_key', clients, room_key)
-			// console.log(clients.length)
-			
-			if (clients) {
-				clients.forEach((client) => {
-					if (ws != client) {
-						if (isAsync) {
-							asyncData.push({socket: client, message: responseData})
-						} else {
-							client.send(responseData);
+
+		if (rooms) {
+			if (!rooms.isArray())
+				rooms = [rooms]
+			for (let room of rooms) {
+				room_key += `/${room}`;	
+				const clients = this.clients.get(room_key);
+
+				if (clients) {
+					clients.forEach((client) => {
+						if (socket != client || socket == client && data.broadcast_sender != false) {
+							if (isAsync) {
+								asyncData.push({socket: client, message: responseData})
+							} else {
+								client.send(responseData);
+							}
+							self.recordTransfer('out', responseData, namespace)
 						}
-						self.recordTransfer('out', responseData, namespace)
-					}
-				})
+					})
+				}
 			}
 			
 		} else {
@@ -217,7 +214,7 @@ class SocketServer extends EventEmitter{
 				console.log(value.length, key)
 				if (key.includes(room_key)) {
 					value.forEach(client => {
-						if (ws != client) {
+						if (socket != client || socket == client && data.broadcast_sender != false) {
 							if (isAsync) {
 								asyncData.push({socket: client, message: responseData})
 							} else {
@@ -232,38 +229,38 @@ class SocketServer extends EventEmitter{
 		
 		//. set async processing
 		if (isAsync) {
-			this.asyncMessages.get(roomInfo.key).setMessage(asyncId, asyncData)
+			this.asyncMessages.get(socketInfo.key).setMessage(asyncId, asyncData)
 		}
 		
 	}
 	
-	send(ws, messageType,  data, orgId, roomInfo){
-		const asyncId = this.getAsyncId(roomInfo)
+	send(socket, messageName, data, orgId, socketInfo){
+		const asyncId = this.getAsyncId(socketInfo)
 		let responseData = JSON.stringify({
-			module: messageType,
+			module: messageName,
 			data: data
 		});
 
-		if (asyncId && roomInfo && roomInfo.key) {
-			this.asyncMessages.get(roomInfo.key).setMessage(asyncId, [{socket: ws, message: responseData}]);
+		if (asyncId && socketInfo && socketInfo.key) {
+			this.asyncMessages.get(socketInfo.key).setMessage(asyncId, [{socket, message: responseData}]);
 		} else {
-			ws.send(responseData);
+			socket.send(responseData);
 		}
 		this.recordTransfer('out', responseData, orgId)
 
 	}
 	
-	getAsyncId(roomInfo) {
-		if (!roomInfo) return null;
+	getAsyncId(socketInfo) {
+		if (!socketInfo) return null;
 		
-		if (roomInfo.asyncId) {
-			return roomInfo.asyncId;
+		if (socketInfo.asyncId) {
+			return socketInfo.asyncId;
 		}
 		return null
 	}
 	
-	sendBinary(ws, data, orgId) {
-		ws.send(data, {binary: true});
+	sendBinary(socket, data, orgId) {
+		socket.send(data, {binary: true});
 		this.recordTransfer('out', data, orgId)
 	}