@iobroker/socket-classes 0.3.2 → 0.4.0

package/README.md

@@ -69,6 +69,9 @@ io.close();
 -->
 
 ## Changelog
+### 0.4.0 (2022-05-19)
+* (bluefox) Added support of socket.io 4.x
+
 ### 0.3.2 (2022-05-19)
 * (bluefox) Hide warn messages
 

package/lib/socketAdmin.js

@@ -141,21 +141,27 @@ class SocketAdmin extends SocketCommon {
         this.commands.stateChange(id, state);
 
         if (this.server && this.server.sockets) {
-            this.server.sockets.connected.forEach(socket =>
+            const sockets = this.server.sockets.sockets || this.server.sockets.connected;
+
+            sockets.forEach(socket =>
                 this.commands.publish(socket, 'stateChange', id, state));
         }
     }
 
     fileChange(id, fileName, size) {
         if (this.server && this.server.sockets) {
-            this.server.sockets.connected.forEach(socket =>
+            const sockets = this.server.sockets.sockets || this.server.sockets.connected;
+
+            sockets.forEach(socket =>
                 this.commands.publishFile(socket, id, fileName, size));
         }
     }
 
     repoUpdated() {
         if (this.server && this.server.sockets) {
-            this.server.sockets.connected.forEach(socket =>
+            const sockets = this.server.sockets.sockets || this.server.sockets.connected;
+
+            sockets.forEach(socket =>
                 this.__updateSession(socket));
 
             this.server.sockets.emit('repoUpdated');
@@ -164,7 +170,9 @@ class SocketAdmin extends SocketCommon {
 
     objectChange(id, obj) {
         if (this.server && this.server.sockets) {
-            this.server.sockets.connected.forEach(socket =>
+            const sockets = this.server.sockets.sockets || this.server.sockets.connected;
+
+            sockets.forEach(socket =>
                 this.commands.publish(socket, 'objectChange', id, obj));
         }
     }
@@ -179,7 +187,9 @@ class SocketAdmin extends SocketCommon {
 
     sendCommand(obj) {
         if (this.commands.sendCommand(obj) && this.server && this.server.sockets) {
-            this.server.sockets.connected.forEach(socket =>
+            const sockets = this.server.sockets.sockets || this.server.sockets.connected;
+
+            sockets.forEach(socket =>
                 this.__updateSession(socket));
 
             this.server.sockets.emit(obj.command, obj.message.id, obj.message.data);

package/lib/socketCommands.js

@@ -630,8 +630,8 @@ class SocketCommands {
                         zipFiles
                             .writeDirAsZip(
                                 this.adapter, // normally we have to pass here the internal "objects" object, but as
-                                              // only writeFile is used, and it has the same name we can pass here the
-                                              // adapter, which has the function with the same name and arguments
+                                // only writeFile is used, and it has the same name we can pass here the
+                                // adapter, which has the function with the same name and arguments
                                 message.id,
                                 message.name,
                                 Buffer.from(message.data, 'base64'),

package/lib/socketCommon.js

@@ -67,7 +67,14 @@ class SocketCommon {
         // it can be used as client too for cloud
         if (socketClass) {
             if (!server.__inited) {
-                this.server = socketClass.listen(server, socketOptions);
+                if (typeof socketClass.listen === 'function') {
+                    // old socket.io@2.x and ws
+                    this.server = socketClass.listen(server, socketOptions);
+                } else {
+                    // socket.io 4.x
+                    this.server = socketClass(server, socketOptions);
+                }
+
                 server.__inited = true;
                 this.adapter.log.info(`${this.settings.secure ? 'Secure ' : ''}socket.io server listening on port ${this.settings.port}`);
             }
@@ -77,6 +84,7 @@ class SocketCommon {
             }
 
             // Enable cross domain access
+            // deprecated, because no more used in socket.io@4 only(in @2)
             if (this.settings.crossDomain && this.server.set) {
                 this.server.set('origins', '*:*');
             }
@@ -141,8 +149,10 @@ class SocketCommon {
     _unsubscribeAll() {
         if (this.server && this.server.ioBroker) {
             // this could be an object or array
-            Object.keys(this.server.sockets.connected).forEach(i =>
-                this.commands.unsubscribeSocket(this.server.sockets.connected[i]));
+            const sockets = this.server.sockets.sockets || this.server.sockets.connected;
+
+            Object.keys(sockets).forEach(i =>
+                this.commands.unsubscribeSocket(sockets[i]));
         } else
         if (this.server && this.server.sockets) {
             for (const socket in this.server.sockets) {
@@ -320,8 +330,10 @@ class SocketCommon {
                     let clientsArray = [];
                     if (this.server.sockets) {
                         // this could be an object or array
-                        Object.keys(this.server.sockets.connected).forEach(i =>
-                            clientsArray.push(this.server.sockets.connected[i]._name || 'noname'));
+                        const sockets = this.server.sockets.sockets || this.server.sockets.connected;
+
+                        Object.keys(sockets).forEach(i =>
+                            clientsArray.push(sockets[i]._name || 'noname'));
                     }
                     const text = `[${clientsArray.length}]${clientsArray.join(', ')}`;
                     this.adapter.setState('info.connected', text, true);
@@ -360,8 +372,10 @@ class SocketCommon {
 
         if (this.server && this.server.sockets) {
             // this could be an object or array
-            Object.keys(this.server.sockets.connected).forEach(i => {
-                const socket = this.server.sockets.connected[i];
+            const sockets = this.server.sockets.sockets || this.server.sockets.connected;
+
+            Object.keys(sockets).forEach(i => {
+                const socket = sockets[i];
                 if (socket._sessionTimer) {
                     clearTimeout(socket._sessionTimer);
                     socket._sessionTimer = null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@iobroker/socket-classes",
-  "version": "0.3.2",
+  "version": "0.4.0",
   "description": "ioBroker server-side web sockets",
   "author": {
     "name": "bluefox",