@cocreate/socket-server 1.3.4 → 1.4.0

package/CHANGELOG.md

@@ -1,3 +1,19 @@
+# [1.4.0](https://github.com/CoCreate-app/CoCreate-socket-server/compare/v1.3.4...v1.4.0) (2022-09-28)
+
+
+### Bug Fixes
+
+* asyncMessages.delete ([d24d0de](https://github.com/CoCreate-app/CoCreate-socket-server/commit/d24d0de90b7a99b3bbcd84fece5ce86728f68260))
+* broadcast params reduced to socket, message, data. emit updateUserStatus ([bfc40a7](https://github.com/CoCreate-app/CoCreate-socket-server/commit/bfc40a754e7f55f23febaaa15534aed3d7ce30ae))
+* bump ws version to 7.5.9 ([910c246](https://github.com/CoCreate-app/CoCreate-socket-server/commit/910c246153f4259af25d19901b4f0a6a30866174))
+* remove param socketInfo when emitting userStatus ([ae45514](https://github.com/CoCreate-app/CoCreate-socket-server/commit/ae45514f1c9435ba0d8217d2c13bc3f9df31d7d7))
+* replaced socketInfo with socket.config ([0e2b047](https://github.com/CoCreate-app/CoCreate-socket-server/commit/0e2b047419313eb4e8023991ae9be4140d80a551))
+
+
+### Features
+
+* config is now accessible from socket.config ([549ea18](https://github.com/CoCreate-app/CoCreate-socket-server/commit/549ea18180e64a4df9769774881c08a8a5b1cc17))
+
 ## [1.3.4](https://github.com/CoCreate-app/CoCreate-socket-server/compare/v1.3.3...v1.3.4) (2022-09-01)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cocreate/socket-server",
-  "version": "1.3.4",
+  "version": "1.4.0",
   "description": "CoCreate-socket-server",
   "keywords": [
     "cocreate-socket",
@@ -45,6 +45,6 @@
   },
   "devDependencies": {
     "express": "^4.17.1",
-    "ws": "^7.3.0"
+    "ws": "7.5.9"
   }
 }

package/src/index.js

@@ -30,63 +30,41 @@ class SocketServer extends EventEmitter{
 	handleUpgrade(req, socket, head) {
 		const self = this;
 		const pathname = url.parse(req.url).pathname;
-		const socketInfo = this.getKeyFromUrl(pathname)
-		if (socketInfo.type == this.prefix) {
+		const config = this.getKeyFromUrl(pathname)
+		if (config.type == this.prefix) {
 			self.wss.handleUpgrade(req, socket, head, function(socket) {
-				self.onWebSocket(req, socket, socketInfo);
+				socket.config = config
+				self.onWebSocket(req, socket);
 			})
 			return true;
 		}
 		return false;
 	}
 	
-	onWebSocket(req, socket, socketInfo) {
+	onWebSocket(req, socket) {
 		const self = this;
 		
-		this.addClient(socket, socketInfo.key, socketInfo);
+		this.addClient(socket);
 
 		socket.on('message', async (message) => {
-			await self.onMessage(req, socket, message, socketInfo);
+			self.onMessage(req, socket, message);
 		})
 		
 		socket.on('close', function () {
-			self.removeClient(socket, socketInfo.key, socketInfo)
+			self.removeClient(socket)
 		})
 
 		socket.on("error", () => {
-			self.removeClient(socket, socketInfo.key, socketInfo)
+			self.removeClient(socket)
 		});
 		
-		this.send(socket, 'connect', socketInfo.key);
+		this.send(socket, 'connect', socket.config.key);
 		
 	}
 	
-	removeClient(socket, key, socketInfo) {
-		let room_clients = this.clients.get(key)
-		const index = room_clients.indexOf(socket);
-
-		if (index > -1) {
-			room_clients.splice(index, 1);
-		}
-		
-		if (room_clients.length == 0) {
-			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: socketInfo.orgId, 
-				total_cnt, 
-				client_cnt: room_clients.length
-			});
-		}
-		
-	}
-	
-	addClient(socket, key, socketInfo) {
+	addClient(socket) {
+		let organization_id = socket.config.orgId
+		let key = socket.config.key
 		let room_clients = this.clients.get(key);
 		if (room_clients) {
 			room_clients.push(socket);
@@ -94,49 +72,64 @@ class SocketServer extends EventEmitter{
 			room_clients = [socket];
 		}
 		this.clients.set(key, room_clients);
-		this.addAsyncMessage(socketInfo.key)
-		
-		this.emit('userStatus', socket, {info: key.replace(`/${this.prefix}/`, ''), status: 'on'}, socketInfo);
+		// this.addAsyncMessage(key)
 
+		let asyncMessage = this.asyncMessages.get(key)
+		if (!asyncMessage) {
+			this.asyncMessages.set(key, new AsyncMessage(key));
+		}
+		
 		//. add metrics
 		let total_cnt = 0;
 		this.clients.forEach((c) => total_cnt += c.length)
 		
 		this.emit("createMetrics", null, {
-			org_id: socketInfo.orgId, 
+			org_id: organization_id, 
 			client_cnt: room_clients.length, 
 			total_cnt: total_cnt
 		});
 	}
 	
-	addAsyncMessage(key) {
-		let asyncMessage = this.asyncMessages.get(key)
-		if (!asyncMessage) {
-			this.asyncMessages.set(key, new AsyncMessage(key));
+	removeClient(socket) {
+		let organization_id = socket.config.orgId
+		let user_id = socket.config.user_id
+		let key = socket.config.key
+		let room_clients = this.clients.get(key)
+		const index = room_clients.indexOf(socket);
+
+		if (index > -1) {
+			room_clients.splice(index, 1);
 		}
-	}
-	
-	getKeyFromUrl(pathname)	{
-		var path = pathname.split("/");
-		var params = {
-			type: null,
-			key: pathname
-		}  
-		if (path.length > 0) {
-			params.type = path[1];
-			params.orgId = path[2]
+		
+		if (room_clients.length == 0) {
+			if (user_id)
+				this.emit('userStatus', socket, {user_id, status: 'off', organization_id});
+			
+			this.emit("removeMetrics", null, { org_id: organization_id });
+
+			this.asyncMessages.delete(key);
+		} else {
+			let total_cnt = 0;
+			this.clients.forEach((c) => total_cnt += c.length)
+			
+			this.emit("changeCountMetrics", null, {
+				org_id: organization_id, 
+				total_cnt, 
+				client_cnt: room_clients.length
+			});
 		}
-		return params
+		
 	}
-	
-	async onMessage(req, socket, message, socketInfo) {
+		
+	async onMessage(req, socket, message) {
 		try {
-			this.recordTransfer('in', message, socketInfo.orgId)
+			const organization_id = socket.config.orgId
+			this.recordTransfer('in', message, organization_id)
 			
 			// ToDo remove
 			if (message instanceof Buffer) {
-				this.emit('importFile2DB', socket, message, socketInfo);
-				console.log('importFile2DB', socket, message, socketInfo);
+				this.emit('importFile2DB', socket, message);
+				console.log('importFile2DB', socket, message);
 				return;
 			}
 			
@@ -147,12 +140,19 @@ class SocketServer extends EventEmitter{
 				if (this.authInstance) {
 					user_id = await this.authInstance.getUserId(req);
 				}
+				if (user_id) {
+					if (!socket.config.user_id ) {
+						socket.config.user_id = user_id
+
+					this.emit('userStatus', socket, {user_id, status: 'on', organization_id});
+					}
+				}
 
 				//. check permission
 				if (this.permissionInstance) {
 					let passStatus = await this.permissionInstance.check(requestData.module, requestData.data, req, user_id)
 					if (!passStatus) {
-						this.send(socket, 'permissionError', requestData.data, socketInfo.orgId, socketInfo)
+						this.send(socket, 'permissionError', requestData.data)
 						return;
 					}
 				}
@@ -160,13 +160,13 @@ class SocketServer extends EventEmitter{
 				//. checking async status....				
 				if (requestData.data.async == true) {
 					console.log('async true')
-					const uuid = CoCreateUUID.generate(), asyncMessage = this.asyncMessages.get(socketInfo.key);
-					socketInfo.asyncId = uuid;
+					const uuid = CoCreateUUID.generate(), asyncMessage = this.asyncMessages.get(socket.config.key);
+					socket.config.asyncId = uuid;
 					if (asyncMessage) {
 						asyncMessage.defineMessage(uuid);
 					}
 				}
-				this.emit(requestData.module, socket, requestData.data, socketInfo);
+				this.emit(requestData.module, socket, requestData.data);
 			}
 			
 		} catch(e) {
@@ -174,27 +174,36 @@ class SocketServer extends EventEmitter{
 		}
 	}
 	
-	broadcast(socket, namespace, rooms, messageName, data, socketInfo) {
+	broadcast(socket, messageName, data) {
 		const self = this;
-		const asyncId = this.getAsyncId(socketInfo)
-	    let room_key = `/${this.prefix}/${namespace}`;
-	    const responseData =JSON.stringify({
+		const responseData = JSON.stringify({
 			module: messageName,
 			data: data
 		});
-		
+
+		const asyncId = socket.config.asyncId
 		let isAsync = false;
 		let asyncData = [];
-		if (asyncId && socketInfo && socketInfo.key) {
+		if (asyncId && socket.config && socket.config.key) {
 			isAsync = true;	
 		}
 
+		let organization_id = socket.config.orgId;
+	    let url = `/${this.prefix}/${organization_id}`;
+		
+		let namespace = data.namespace;
+		if (namespace) {
+			url += `/${namespace}`
+		}
+
+		let rooms = data.room;
 		if (rooms) {
 			if (!rooms.isArray())
 				rooms = [rooms]
 			for (let room of rooms) {
-				room_key += `/${room}`;	
-				const clients = this.clients.get(room_key);
+				let url = url;
+				url += `/${room}`;	
+				const clients = this.clients.get(url);
 
 				if (clients) {
 					clients.forEach((client) => {
@@ -204,7 +213,7 @@ class SocketServer extends EventEmitter{
 							} else {
 								client.send(responseData);
 							}
-							self.recordTransfer('out', responseData, namespace)
+							self.recordTransfer('out', responseData, organization_id)
 						}
 					})
 				}
@@ -212,7 +221,7 @@ class SocketServer extends EventEmitter{
 			
 		} else {
 			this.clients.forEach((value, key) => {
-				if (key.includes(room_key)) {
+				if (key.includes(url)) {
 					value.forEach(client => {
 						if (socket != client || socket == client && data.broadcastSender != false) {
 							if (isAsync) {
@@ -220,7 +229,7 @@ class SocketServer extends EventEmitter{
 							} else {
 								client.send(responseData);
 							}
-							self.recordTransfer('out', responseData, namespace)
+							self.recordTransfer('out', responseData, organization_id)
 						}
 					})
 				}
@@ -229,38 +238,50 @@ class SocketServer extends EventEmitter{
 		
 		//. set async processing
 		if (isAsync) {
-			this.asyncMessages.get(socketInfo.key).setMessage(asyncId, asyncData)
+			this.asyncMessages.get(socket.config.key).setMessage(asyncId, asyncData)
 		}
 		
 	}
 	
-	send(socket, messageName, data, socketInfo){
-		const asyncId = this.getAsyncId(socketInfo)
+	send(socket, messageName, data){
+		const asyncId = socket.config.asyncId
 		let responseData = JSON.stringify({
 			module: messageName,
-			data: data
+			data
 		});
 
-		if (asyncId && socketInfo && socketInfo.key) {
-			this.asyncMessages.get(socketInfo.key).setMessage(asyncId, [{socket, message: responseData}]);
+		if (asyncId && socket.config && socket.config.key) {
+			this.asyncMessages.get(socket.config.key).setMessage(asyncId, [{socket, message: responseData}]);
 		} else {
 			socket.send(responseData);
 		}
 
-		if (socketInfo && socketInfo.orgId)
-		this.recordTransfer('out', responseData, socketInfo.orgId)
+		if (socket.config && socket.config.orgId)
+			this.recordTransfer('out', responseData, socket.config.orgId)
 
 	}
+
+	// addAsyncMessage(key) {
+	// 	let asyncMessage = this.asyncMessages.get(key)
+	// 	if (!asyncMessage) {
+	// 		this.asyncMessages.set(key, new AsyncMessage(key));
+	// 	}
+	// }
 	
-	getAsyncId(socketInfo) {
-		if (!socketInfo) return null;
-		
-		if (socketInfo.asyncId) {
-			return socketInfo.asyncId;
+	getKeyFromUrl(pathname)	{
+		var path = pathname.split("/");
+		var params = {
+			type: null,
+			key: pathname
+		}  
+		if (path.length > 0) {
+			params.type = path[1];
+			params.orgId = path[2]
 		}
-		return null
+		return params
 	}
-	
+
+		
 	sendBinary(socket, data, orgId) {
 		socket.send(data, {binary: true});
 		this.recordTransfer('out', data, orgId)