fix(deps): update socket.io packages to v4.8.1

[renovate]

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
socket.io (source)	4.2.0 -> 4.8.1
socket.io-client (source)	4.2.0 -> 4.8.1

---

Release Notes

socketio/socket.io (socket.io)

v4.8.1

Compare Source

Bug Fixes

• bundle: do not mangle the "_placeholder" attribute (ca9e994)

Dependencies

• engine.io-client@~6.6.1 (no change)
• ws@~8.17.1 (no change)

v4.8.0

Compare Source

Features

Custom transport implementations

The transports option now accepts an array of transport implementations:

import { io } from "socket.io-client";
import { XHR, WebSocket } from "engine.io-client";

const socket = io({
  transports: [XHR, WebSocket]
});

Here is the list of provided implementations:

Transport	Description
Fetch	HTTP long-polling based on the built-in fetch() method.
NodeXHR	HTTP long-polling based on the XMLHttpRequest object provided by the xmlhttprequest-ssl package.
XHR	HTTP long-polling based on the built-in XMLHttpRequest object.
NodeWebSocket	WebSocket transport based on the WebSocket object provided by the ws package.
WebSocket	WebSocket transport based on the built-in WebSocket object.
WebTransport	WebTransport transport based on the built-in WebTransport object.

Usage:

Transport	browser	Node.js	Deno	Bun
Fetch	✅	✅ (1)	✅	✅
NodeXHR		✅	✅	✅
XHR	✅
NodeWebSocket		✅	✅	✅
WebSocket	✅	✅ (2)	✅	✅
WebTransport	✅	✅

(1) since v18.0.0
(2) since v21.0.0

Added in f4d898e and b11763b.

Test each low-level transports

When setting the tryAllTransports option to true, if the first transport (usually, HTTP long-polling) fails, then the other transports will be tested too:

import { io } from "socket.io-client";

const socket = io({
  tryAllTransports: true
});

This feature is useful in two cases:

• when HTTP long-polling is disabled on the server, or if CORS fails
• when WebSocket is tested first (with transports: ["websocket", "polling"])

The only potential downside is that the connection attempt could take more time in case of failure, as there have been reports of WebSocket connection errors taking several seconds before being detected (that's one reason for using HTTP long-polling first). That's why the option defaults to false for now.

Added in 579b243.

Bug Fixes

• accept string | undefined as init argument (bis) (60c757f)
• allow to manually stop the reconnection loop (13c6d2e)
• close the engine upon decoding exception (04c8dd9)
• do not send a packet on an expired connection (#​5134) (8adcfbf)

Dependencies

• engine.io-client@~6.6.1 (diff and diff)
• ws@~8.17.1 (diff)

v4.7.5

Compare Source

Bug Fixes

• close the adapters when the server is closed (bf64870)
• remove duplicate pipeline when serving bundle (e426f3e)

Links

• Diff: socketio/socket.io@4.7.4...4.7.5
• Client release: 4.7.5
• engine.io@~6.5.2 (no change)
• ws@~8.11.0 (no change)

v4.7.4

Compare Source

Bug Fixes

• typings: calling io.emit with no arguments incorrectly errored (cb6d2e0), closes #​4914

Links

• Diff: socketio/socket.io@4.7.3...4.7.4
• Client release: 4.7.4
• engine.io@~6.5.2 (no change)
• ws@~8.11.0 (no change)

v4.7.3

Compare Source

Bug Fixes

• return the first response when broadcasting to a single socket (#​4878) (df8e70f)
• typings: allow to bind to a non-secure Http2Server (#​4853) (8c9ebc3)

Links

• Diff: socketio/socket.io@4.7.2...4.7.3
• Client release: 4.7.3
• engine.io@~6.5.2 (no change)
• ws@~8.11.0 (no change)

v4.7.2

Compare Source

Bug Fixes

• clean up child namespace when client is rejected in middleware (#​4773) (0731c0d)
• webtransport: properly handle WebTransport-only connections (3468a19)
• webtransport: add proper framing (a306db0)

Links

• Diff: socketio/socket.io@4.7.1...4.7.2
• Client release: 4.7.2
• engine.io@~6.5.2 (diff)
• ws@~8.11.0 (no change)

v4.7.1

Compare Source

The client bundle contains a few fixes regarding the WebTransport support.

Links

• Diff: socketio/socket.io@4.7.0...4.7.1
• Client release: 4.7.1
• engine.io@~6.5.0 (no change)
• ws@~8.11.0 (no change)

v4.7.0

Compare Source

Bug Fixes

• remove the Partial modifier from the socket.data type (#​4740) (e5c62ca)

Features

Support for WebTransport

The Socket.IO server can now use WebTransport as the underlying transport.

WebTransport is a web API that uses the HTTP/3 protocol as a bidirectional transport. It's intended for two-way communications between a web client and an HTTP/3 server.

References:

• https://w3c.github.io/webtransport/
• https://developer.mozilla.org/en-US/docs/Web/API/WebTransport
• https://developer.chrome.com/articles/webtransport/

Until WebTransport support lands in Node.js, you can use the @fails-components/webtransport package:

import { readFileSync } from "fs";
import { createServer } from "https";
import { Server } from "socket.io";
import { Http3Server } from "@​fails-components/webtransport";

// WARNING: the total length of the validity period MUST NOT exceed two weeks (https://w3c.github.io/webtransport/#custom-certificate-requirements)
const cert = readFileSync("/path/to/my/cert.pem");
const key = readFileSync("/path/to/my/key.pem");

const httpsServer = createServer({
  key,
  cert
});

httpsServer.listen(3000);

const io = new Server(httpsServer, {
  transports: ["polling", "websocket", "webtransport"] // WebTransport is not enabled by default
});

const h3Server = new Http3Server({
  port: 3000,
  host: "0.0.0.0",
  secret: "changeit",
  cert,
  privKey: key,
});

(async () => {
  const stream = await h3Server.sessionStream("/socket.io/");
  const sessionReader = stream.getReader();

  while (true) {
    const { done, value } = await sessionReader.read();
    if (done) {
      break;
    }
    io.engine.onWebTransportSession(value);
  }
})();

h3Server.startServer();

Added in 123b68c.

Client bundles with CORS headers

The bundles will now have the right Access-Control-Allow-xxx headers.

Added in 63f181c.

Links

• Diff: socketio/socket.io@4.6.2...4.7.0
• Client release: 4.7.0
• engine.io@~6.5.0 (diff)
• ws@~8.11.0 (no change)

v4.6.2

Compare Source

Bug Fixes

• exports: move types condition to the top (#​4698) (3d44aae)

Links

• Diff: socketio/socket.io@4.6.1...4.6.2
• Client release: 4.6.2
• engine.io@~6.4.2 (diff)
• ws@~8.11.0 (no change)

v4.6.1

Compare Source

Bug Fixes

• properly handle manually created dynamic namespaces (0d0a7a2)
• types: fix nodenext module resolution compatibility (#​4625) (d0b22c6)

Links

• Diff: socketio/socket.io@4.6.0...4.6.1
• Client release: 4.6.1
• engine.io@~6.4.1 (diff)
• ws@~8.11.0 (no change)

v4.6.0

Compare Source

Bug Fixes

• add timeout method to remote socket (#​4558) (0c0eb00)
• typings: properly type emits with timeout (f3ada7d)

Features

Promise-based acknowledgements

This commit adds some syntactic sugar around acknowledgements:

• emitWithAck()

try {
  const responses = await io.timeout(1000).emitWithAck("some-event");
  console.log(responses); // one response per client
} catch (e) {
  // some clients did not acknowledge the event in the given delay
}

io.on("connection", async (socket) => {
    // without timeout
  const response = await socket.emitWithAck("hello", "world");

  // with a specific timeout
  try {
    const response = await socket.timeout(1000).emitWithAck("hello", "world");
  } catch (err) {
    // the client did not acknowledge the event in the given delay
  }
});

• serverSideEmitWithAck()

try {
  const responses = await io.timeout(1000).serverSideEmitWithAck("some-event");
  console.log(responses); // one response per server (except itself)
} catch (e) {
  // some servers did not acknowledge the event in the given delay
}

Added in 184f3cf.

Connection state recovery

This feature allows a client to reconnect after a temporary disconnection and restore its state:

• id
• rooms
• data
• missed packets

Usage:

import { Server } from "socket.io";

const io = new Server({
  connectionStateRecovery: {
    // default values
    maxDisconnectionDuration: 2 * 60 * 1000,
    skipMiddlewares: true,
  },
});

io.on("connection", (socket) => {
  console.log(socket.recovered); // whether the state was recovered or not
});

Here's how it works:

• the server sends a session ID during the handshake (which is different from the current id attribute, which is public and can be freely shared)
• the server also includes an offset in each packet (added at the end of the data array, for backward compatibility)
• upon temporary disconnection, the server stores the client state for a given delay (implemented at the adapter level)
• upon reconnection, the client sends both the session ID and the last offset it has processed, and the server tries to restore the state

The in-memory adapter already supports this feature, and we will soon update the Postgres and MongoDB adapters. We will also create a new adapter based on Redis Streams, which will support this feature.

Added in 54d5ee0.

Compatibility (for real) with Express middlewares

This feature implements middlewares at the Engine.IO level, because Socket.IO middlewares are meant for namespace authorization and are not executed during a classic HTTP request/response cycle.

Syntax:

io.engine.use((req, res, next) => {
  // do something

  next();
});

// with express-session
import session from "express-session";

io.engine.use(session({
  secret: "keyboard cat",
  resave: false,
  saveUninitialized: true,
  cookie: { secure: true }
}));

// with helmet
import helmet from "helmet";

io.engine.use(helmet());

A workaround was possible by using the allowRequest option and the "headers" event, but this feels way cleaner and works with upgrade requests too.

Added in 24786e7.

Error details in the disconnecting and disconnect events

The disconnect event will now contain additional details about the disconnection reason.

io.on("connection", (socket) => {
  socket.on("disconnect", (reason, description) => {
    console.log(description);
  });
});

Added in 8aa9499.

Automatic removal of empty child namespaces

This commit adds a new option, "cleanupEmptyChildNamespaces". With this option enabled (disabled by default), when a socket disconnects from a dynamic namespace and if there are no other sockets connected to it then the namespace will be cleaned up and its adapter will be closed.

import { createServer } from "node:http";
import { Server } from "socket.io";

const httpServer = createServer();
const io = new Server(httpServer, {
  cleanupEmptyChildNamespaces: true
});

Added in 5d9220b.

A new "addTrailingSlash" option

The trailing slash which was added by default can now be disabled:

import { createServer } from "node:http";
import { Server } from "socket.io";

const httpServer = createServer();
const io = new Server(httpServer, {
  addTrailingSlash: false
});

In the example above, the clients can omit the trailing slash and use /socket.io instead of /socket.io/.

Added in d0fd474.

Performance Improvements

• precompute the WebSocket frames when broadcasting (da2b542)

Links:

• Diff: socketio/socket.io@4.5.4...4.6.0
• Client release: 4.6.0
• engine.io@~6.4.0 (diff)
• ws@~8.11.0 (diff)

v4.5.4

Compare Source

This release contains a bump of:

• engine.io in order to fix CVE-2022-41940
• socket.io-parser in order to fix CVE-2022-2421.

Links:

• Diff: socketio/socket.io@4.5.3...4.5.4
• Client release: 4.5.4
• engine.io@~6.2.1 (diff)
• ws@~8.2.3

v4.5.3

Compare Source

Bug Fixes

• typings: accept an HTTP2 server in the constructor (d3d0a2d)
• typings: apply types to "io.timeout(...).emit()" calls (e357daf)

Links:

• Diff: socketio/socket.io@4.5.2...4.5.3
• Client release: 4.5.3
• engine.io version: ~6.2.0
• ws version: ~8.2.3

v4.5.2

Compare Source

Bug Fixes

• prevent the socket from joining a room after disconnection (18f3fda)
• uws: prevent the server from crashing after upgrade (ba497ee)

Links:

• Diff: socketio/socket.io@4.5.1...4.5.2
• Client release: 4.5.2
• engine.io version: ~6.2.0
• ws version: ~8.2.3

v4.5.1

Compare Source

Bug Fixes

• forward the local flag to the adapter when using fetchSockets() (30430f0)
• typings: add HTTPS server to accepted types (#​4351) (9b43c91)

Links:

• Diff: socketio/socket.io@4.5.0...4.5.1
• Client release: 4.5.1
• engine.io version: ~6.2.0
• ws version: ~8.2.3

v4.5.0

Compare Source

Bug Fixes

• typings: ensure compatibility with TypeScript 3.x (#​4259) (02c87a8)

Features

• add support for catch-all listeners for outgoing packets (531104d)

This is similar to onAny(), but for outgoing packets.

Syntax:

socket.onAnyOutgoing((event, ...args) => {
  console.log(event);
});

• broadcast and expect multiple acks (8b20457)

Syntax:

io.timeout(1000).emit("some-event", (err, responses) => {
  // ...
});

• add the "maxPayload" field in the handshake details (088dcb4)

So that clients in HTTP long-polling can decide how many packets they have to send to stay under the maxHttpBufferSize
value.

This is a backward compatible change which should not mandate a new major revision of the protocol (we stay in v4), as
we only add a field in the JSON-encoded handshake data:

0{"sid":"lv_VI97HAXpY6yYWAAAC","upgrades":["websocket"],"pingInterval":25000,"pingTimeout":5000,"maxPayload":1000000}

Links:

• Diff: socketio/socket.io@4.4.1...4.5.0
• Client release: 4.5.0
• engine.io version: ~6.2.0 (diff)
• ws version: ~8.2.3

v4.4.1

Compare Source

Bug Fixes

• types: make RemoteSocket.data type safe (#​4234) (770ee59)
• types: pass SocketData type to custom namespaces (#​4233) (f2b8de7)

Links:

• Diff: socketio/socket.io@4.4.0...4.4.1
• Client release: 4.4.1
• engine.io version: ~6.1.0 (diff)
• ws version: ~8.2.3

v4.4.0

Compare Source

Bug Fixes

• only set 'connected' to true after middleware execution (02b0f73)

Features

• add an implementation based on uWebSockets.js (c0d8c5a)

const { App } = require("uWebSockets.js");
const { Server } = require("socket.io");

const app = new App();
const io = new Server();

io.attachApp(app);

io.on("connection", (socket) => {
  // ...
});

app.listen(3000, (token) => {
  if (!token) {
    console.warn("port already in use");
  }
});

• add timeout feature (f0ed42f)

socket.timeout(5000).emit("my-event", (err) => {
  if (err) {
    // the client did not acknowledge the event in the given delay
  }
});

• add type information to socket.data (#​4159) (fe8730c)

interface SocketData {
  name: string;
  age: number;
}

const io = new Server<ClientToServerEvents, ServerToClientEvents, InterServerEvents, SocketData>();

io.on("connection", (socket) => {
  socket.data.name = "john";
  socket.data.age = 42;
});

Links:

• Diff: socketio/socket.io@4.3.2...4.4.0
• Client release: 4.4.0
• engine.io version: ~6.1.0 (diff)
• ws version: ~8.2.3

v4.3.2

Compare Source

Bug Fixes

• fix race condition in dynamic namespaces (#​4137) (9d86397)

Links:

• Diff: socketio/socket.io@4.3.1...4.3.2
• Client release: 4.3.2
• engine.io version: ~6.0.0
• ws version: ~8.2.3

v4.3.1

Compare Source

Bug Fixes

• fix server attachment (#​4127) (0ef2a4d)

Links:

• Diff: socketio/socket.io@4.3.0...4.3.1
• Client release: 4.3.1
• engine.io version: ~6.0.0
• ws version: ~8.2.3

v4.3.0

Compare Source

For this release, most of the work was done on the client side, see here.

Bug Fixes

• typings: add name field to cookie option (#​4099) (033c5d3)
• send volatile packets with binary attachments (dc81fcf)

Features

• serve ESM bundle (60edecb)

Links:

• Diff: socketio/socket.io@4.2.0...4.3.0
• Client release: 4.3.0
• engine.io version: ~6.0.0 (diff)
• ws version: ~8.2.3 (diff)

---

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about these updates again.

---

• If you want to rebase/retry this PR, check this box

---

This PR was generated by Mend Renovate. View the repository job log.