chore(release): 4.6.1

Diff: https://github.com/socketio/socket.io/compare/4.6.0...4.6.1

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## 2023
 
+- [4.6.1](#461-2023-02-20) (Feb 2023)
 - [4.6.0](#460-2023-02-07) (Feb 2023)
 
 ## 2022
@@ -56,7 +57,23 @@
 
 # Release notes
 
-# [4.6.0](https://github.com/socketio/socket.io/compare/4.5.4...4.6.0) (2023-02-07)
+## [4.6.1](https://github.com/socketio/socket.io/compare/4.6.0...4.6.1) (2023-02-20)
+
+
+### Bug Fixes
+
+* properly handle manually created dynamic namespaces ([0d0a7a2](https://github.com/socketio/socket.io/commit/0d0a7a22b5ff95f864216c529114b7dd41738d1e))
+* **types:** fix nodenext module resolution compatibility ([#4625](https://github.com/socketio/socket.io/issues/4625)) ([d0b22c6](https://github.com/socketio/socket.io/commit/d0b22c630208669aceb7ae013180c99ef90279b0))
+
+
+### Dependencies
+
+- [`engine.io@~6.4.0`](https://github.com/socketio/engine.io/releases/tag/6.4.0) (no change)
+- [`ws@~8.11.0`](https://github.com/websockets/ws/releases/tag/8.11.0) (no change)
+
+
+
+## [4.6.0](https://github.com/socketio/socket.io/compare/4.5.4...4.6.0) (2023-02-07)
 
 
 ### Bug Fixes

Readme.md

@@ -126,7 +126,7 @@ io.listen(3000);
 
 Starting with **3.0**, express applications have become request handler
 functions that you pass to `http` or `http` `Server` instances. You need
-to pass the `Server` to `socket.io`, and not the express application
+to pass the `Server` to `socket.io`, not the express application
 function. Also make sure to call `.listen` on the `server`, not the `app`.
 
 ```js

client-dist/socket.io.js

@@ -1,5 +1,5 @@
 /*!
- * Socket.IO v4.6.0
+ * Socket.IO v4.6.1
  * (c) 2014-2023 Guillermo Rauch
  * Released under the MIT License.
  */
@@ -3159,6 +3159,12 @@
        */
 
       _this._queue = [];
+      /**
+       * A sequence to generate the ID of the {@link QueuedPacket}.
+       * @private
+       */
+
+      _this._queueSeq = 0;
       _this.ids = 0;
       _this.acks = {};
       _this.flags = {};
@@ -3453,7 +3459,7 @@
         }
 
         var packet = {
-          id: this.ids++,
+          id: this._queueSeq++,
           tryCount: 0,
           pending: false,
           args: args,
@@ -3499,30 +3505,30 @@
       }
       /**
        * Send the first packet of the queue, and wait for an acknowledgement from the server.
+       * @param force - whether to resend a packet that has not been acknowledged yet
+       *
        * @private
        */
 
     }, {
       key: "_drainQueue",
       value: function _drainQueue() {
-        if (this._queue.length === 0) {
+        var force = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : false;
+
+        if (!this.connected || this._queue.length === 0) {
           return;
         }
 
         var packet = this._queue[0];
 
-        if (packet.pending) {
+        if (packet.pending && !force) {
           return;
         }
 
         packet.pending = true;
         packet.tryCount++;
-        var currentId = this.ids;
-        this.ids = packet.id; // the same id is reused for consecutive retries, in order to allow deduplication on the server side
-
         this.flags = packet.flags;
         this.emit.apply(this, packet.args);
-        this.ids = currentId; // restore offset
       }
       /**
        * Sends a packet.
@@ -3759,6 +3765,8 @@
         this.connected = true;
         this.emitBuffered();
         this.emitReserved("connect");
+
+        this._drainQueue(true);
       }
       /**
        * Emit buffered events (received and emitted).
@@ -4504,9 +4512,7 @@
         if (!socket) {
           socket = new Socket(this, nsp, opts);
           this.nsps[nsp] = socket;
-        }
-
-        if (this._autoConnect) {
+        } else if (this._autoConnect && !socket.active) {
           socket.connect();
         }
 

lib/index.ts

@@ -6,12 +6,11 @@ import { createDeflate, createGzip, createBrotliCompress } from "zlib";
 import accepts = require("accepts");
 import { pipeline } from "stream";
 import path = require("path");
-import {
-  attach,
-  Server as Engine,
+import { attach, Server as Engine, uServer } from "engine.io";
+import type {
   ServerOptions as EngineOptions,
   AttachOptions,
-  uServer,
+  BaseServer,
 } from "engine.io";
 import { Client } from "./client";
 import { EventEmitter } from "events";
@@ -41,7 +40,6 @@ import {
   SecondArg,
 } from "./typed-events";
 import { patchAdapter, restoreAdapter, serveFile } from "./uws";
-import type { BaseServer } from "engine.io/build/server";
 
 const debug = debugModule("socket.io:server");
 
@@ -180,6 +178,18 @@ export class Server<
     ParentNspNameMatchFn,
     ParentNamespace<ListenEvents, EmitEvents, ServerSideEvents, SocketData>
   > = new Map();
+
+  /**
+   * A subset of the {@link parentNsps} map, only containing {@link ParentNamespace} which are based on a regular
+   * expression.
+   *
+   * @private
+   */
+  private parentNamespacesFromRegExp: Map<
+    RegExp,
+    ParentNamespace<ListenEvents, EmitEvents, ServerSideEvents, SocketData>
+  > = new Map();
+
   private _adapter?: AdapterConstructor;
   private _serveClient: boolean;
   private readonly opts: Partial<ServerOptions>;
@@ -316,8 +326,6 @@ export class Server<
         }
         const namespace = this.parentNsps.get(nextFn.value)!.createChild(name);
         debug("dynamic namespace %s was created", name);
-        // @ts-ignore
-        this.sockets.emitReserved("new_namespace", namespace);
         fn(namespace);
       });
     };
@@ -693,6 +701,7 @@ export class Server<
           (nsp, conn, next) => next(null, (name as RegExp).test(nsp)),
           parentNsp
         );
+        this.parentNamespacesFromRegExp.set(name, parentNsp);
       }
       if (fn) {
         // @ts-ignore
@@ -705,6 +714,13 @@ export class Server<
 
     let nsp = this._nsps.get(name);
     if (!nsp) {
+      for (const [regex, parentNamespace] of this.parentNamespacesFromRegExp) {
+        if (regex.test(name as string)) {
+          debug("attaching namespace %s to parent namespace %s", name, regex);
+          return parentNamespace.createChild(name as string);
+        }
+      }
+
       debug("initializing namespace %s", name);
       nsp = new Namespace(this, name);
       this._nsps.set(name, nsp);

lib/namespace.ts

@@ -358,12 +358,15 @@ export class Namespace<
       typeof sessionId === "string" &&
       typeof offset === "string"
     ) {
-      const session = await this.adapter.restoreSession(sessionId, offset);
+      let session;
+      try {
+        session = await this.adapter.restoreSession(sessionId, offset);
+      } catch (e) {
+        debug("error while restoring session: %s", e);
+      }
       if (session) {
         debug("connection state recovered for sid %s", session.sid);
         return new Socket(this, client, auth, session);
-      } else {
-        debug("unable to restore session state");
       }
     }
     return new Socket(this, client, auth);

lib/parent-namespace.ts

@@ -11,6 +11,21 @@ import debugModule from "debug";
 
 const debug = debugModule("socket.io:parent-namespace");
 
+/**
+ * A parent namespace is a special {@link Namespace} that holds a list of child namespaces which were created either
+ * with a regular expression or with a function.
+ *
+ * @example
+ * const parentNamespace = io.of(/\/dynamic-\d+/);
+ *
+ * parentNamespace.on("connection", (socket) => {
+ *   const childNamespace = socket.nsp;
+ * }
+ *
+ * // will reach all the clients that are in one of the child namespaces, like "/dynamic-101"
+ * parentNamespace.emit("hello", "world");
+ *
+ */
 export class ParentNamespace<
   ListenEvents extends EventsMap = DefaultEventsMap,
   EmitEvents extends EventsMap = ListenEvents,
@@ -81,6 +96,10 @@ export class ParentNamespace<
     }
 
     this.server._nsps.set(name, namespace);
+
+    // @ts-ignore
+    this.server.sockets.emitReserved("new_namespace", namespace);
+
     return namespace;
   }
 

package-lock.json

@@ -1,18 +1,18 @@
 {
   "name": "socket.io",
-  "version": "4.5.4",
+  "version": "4.6.0",
   "lockfileVersion": 2,
   "requires": true,
   "packages": {
     "": {
       "name": "socket.io",
-      "version": "4.5.4",
+      "version": "4.6.0",
       "license": "MIT",
       "dependencies": {
         "accepts": "~1.3.4",
         "base64id": "~2.0.0",
         "debug": "~4.3.2",
-        "engine.io": "~6.4.0",
+        "engine.io": "~6.4.1",
         "socket.io-adapter": "~2.5.2",
         "socket.io-parser": "~4.2.1"
       },
@@ -23,7 +23,7 @@
         "nyc": "^15.1.0",
         "prettier": "^2.3.2",
         "rimraf": "^3.0.2",
-        "socket.io-client": "4.6.0",
+        "socket.io-client": "4.6.1",
         "socket.io-client-v2": "npm:socket.io-client@^2.4.0",
         "superagent": "^8.0.0",
         "supertest": "^6.1.6",
@@ -1377,9 +1377,9 @@
       "dev": true
     },
     "node_modules/engine.io": {
-      "version": "6.4.0",
-      "resolved": "https://registry.npmjs.org/engine.io/-/engine.io-6.4.0.tgz",
-      "integrity": "sha512-OgxY1c/RuCSeO/rTr8DIFXx76IzUUft86R7/P7MMbbkuzeqJoTNw2lmeD91IyGz41QYleIIjWeMJGgug043sfQ==",
+      "version": "6.4.1",
+      "resolved": "https://registry.npmjs.org/engine.io/-/engine.io-6.4.1.tgz",
+      "integrity": "sha512-JFYQurD/nbsA5BSPmbaOSLa3tSVj8L6o4srSwXXY3NqE+gGUNmmPTbhn8tjzcCtSqhFgIeqef81ngny8JM25hw==",
       "dependencies": {
         "@types/cookie": "^0.4.1",
         "@types/cors": "^2.8.12",
@@ -3463,9 +3463,9 @@
       }
     },
     "node_modules/socket.io-client": {
-      "version": "4.6.0",
-      "resolved": "https://registry.npmjs.org/socket.io-client/-/socket.io-client-4.6.0.tgz",
-      "integrity": "sha512-2XOp18xnGghUICSd5ziUIS4rB0dhr6S8OvAps8y+HhOjFQlqGcf+FIh6fCIsKKZyWFxJeFPrZRNPGsHDTsz1Ug==",
+      "version": "4.6.1",
+      "resolved": "https://registry.npmjs.org/socket.io-client/-/socket.io-client-4.6.1.tgz",
+      "integrity": "sha512-5UswCV6hpaRsNg5kkEHVcbBIXEYoVbMQaHJBXJCyEQ+CiFPV1NIOY0XOFWG4XR4GZcB8Kn6AsRs/9cy9TbqVMQ==",
       "dev": true,
       "dependencies": {
         "@socket.io/component-emitter": "~3.1.0",
@@ -5387,9 +5387,9 @@
       "dev": true
     },
     "engine.io": {
-      "version": "6.4.0",
-      "resolved": "https://registry.npmjs.org/engine.io/-/engine.io-6.4.0.tgz",
-      "integrity": "sha512-OgxY1c/RuCSeO/rTr8DIFXx76IzUUft86R7/P7MMbbkuzeqJoTNw2lmeD91IyGz41QYleIIjWeMJGgug043sfQ==",
+      "version": "6.4.1",
+      "resolved": "https://registry.npmjs.org/engine.io/-/engine.io-6.4.1.tgz",
+      "integrity": "sha512-JFYQurD/nbsA5BSPmbaOSLa3tSVj8L6o4srSwXXY3NqE+gGUNmmPTbhn8tjzcCtSqhFgIeqef81ngny8JM25hw==",
       "requires": {
         "@types/cookie": "^0.4.1",
         "@types/cors": "^2.8.12",
@@ -6922,9 +6922,9 @@
       }
     },
     "socket.io-client": {
-      "version": "4.6.0",
-      "resolved": "https://registry.npmjs.org/socket.io-client/-/socket.io-client-4.6.0.tgz",
-      "integrity": "sha512-2XOp18xnGghUICSd5ziUIS4rB0dhr6S8OvAps8y+HhOjFQlqGcf+FIh6fCIsKKZyWFxJeFPrZRNPGsHDTsz1Ug==",
+      "version": "4.6.1",
+      "resolved": "https://registry.npmjs.org/socket.io-client/-/socket.io-client-4.6.1.tgz",
+      "integrity": "sha512-5UswCV6hpaRsNg5kkEHVcbBIXEYoVbMQaHJBXJCyEQ+CiFPV1NIOY0XOFWG4XR4GZcB8Kn6AsRs/9cy9TbqVMQ==",
       "dev": true,
       "requires": {
         "@socket.io/component-emitter": "~3.1.0",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "socket.io",
-  "version": "4.6.0",
+  "version": "4.6.1",
   "description": "node.js realtime framework server",
   "keywords": [
     "realtime",
@@ -49,7 +49,7 @@
     "accepts": "~1.3.4",
     "base64id": "~2.0.0",
     "debug": "~4.3.2",
-    "engine.io": "~6.4.0",
+    "engine.io": "~6.4.1",
     "socket.io-adapter": "~2.5.2",
     "socket.io-parser": "~4.2.1"
   },
@@ -60,7 +60,7 @@
     "nyc": "^15.1.0",
     "prettier": "^2.3.2",
     "rimraf": "^3.0.2",
-    "socket.io-client": "4.6.0",
+    "socket.io-client": "4.6.1",
     "socket.io-client-v2": "npm:socket.io-client@^2.4.0",
     "superagent": "^8.0.0",
     "supertest": "^6.1.6",

test/namespaces.ts

@@ -652,5 +652,16 @@ describe("namespaces", () => {
 
       io.of(/^\/dynamic-\d+$/);
     });
+
+    it("should attach a child namespace to its parent upon manual creation", () => {
+      const io = new Server(0);
+      const parentNamespace = io.of(/^\/dynamic-\d+$/);
+      const childNamespace = io.of("/dynamic-101");
+
+      // @ts-ignore
+      expect(parentNamespace.children.has(childNamespace)).to.be(true);
+
+      io.close();
+    });
   });
 });