Update dependency socket.io-client to v4

[renovate]

This PR contains the following updates:

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

---

Release Notes

socketio/socket.io (socket.io-client)

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)

v4.2.0

Compare Source

Bug Fixes

• typings: allow async listener in typed events (ccfd8ca)

Features

• ignore the query string when serving client JavaScript (#​4024) (24fee27)

Links:

• Diff: socketio/socket.io@4.1.3...4.2.0
• Client release: 4.2.0
• engine.io version: ~5.2.0
• ws version: ~7.4.2

v4.1.3

Compare Source

Bug Fixes

• fix io.except() method (94e27cd)
• remove x-sourcemap header (a4dffc6)

Links:

• Diff: socketio/socket.io@4.1.2...4.1.3
• Client release: 4.1.3
• engine.io version: ~5.1.0
• ws version: ~7.4.2

v4.1.2

Compare Source

Bug Fixes

• typings: ensure compatibility with TypeScript 3.x (0cb6ac9)
• ensure compatibility with previous versions of the adapter (a2cf248)

Links:

• Diff: socketio/socket.io@4.1.1...4.1.2
• Client release: 4.1.2
• engine.io version: ~5.1.0
• ws version: ~7.4.2

v4.1.1

Compare Source

Bug Fixes

• typings: properly type server-side events (b84ed1e)
• typings: properly type the adapter attribute (891b187)

Links:

• Diff: socketio/socket.io@4.1.0...4.1.1
• Client release: 4.1.1
• engine.io version: ~5.1.0
• ws version: ~7.4.2

v4.1.0

Compare Source

Blog post: https://socket.io/blog/socket-io-4-1-0/

Features

• add support for inter-server communication (93cce05)
• notify upon namespace creation (499c892)
• add a "connection_error" event (7096e98, from engine.io)
• add the "initial_headers" and "headers" events (2527543, from engine.io)

Links:

• Diff: socketio/socket.io@4.0.2...4.1.0
• Client release: 4.1.0
• engine.io version: ~5.1.0
• ws version: ~7.4.2

v4.0.2

Compare Source

Bug Fixes

• typings: make "engine" attribute public (b81ce4c)
• properly export the Socket class (d65b6ee)

Links:

• Diff: socketio/socket.io@4.0.1...4.0.2
• Client release: 4.0.2
• engine.io version: ~5.0.0
• ws version: ~7.4.2

v4.0.1

Compare Source

Bug Fixes

• typings: add fallback to untyped event listener (#​3834) (a11152f)
• typings: update return type from emit (#​3843) (1a72ae4)

Links:

• Diff: socketio/socket.io@4.0.0...4.0.1
• Client release: 4.0.1
• engine.io version: ~5.0.0
• ws version: ~7.4.2

v4.0.0

Compare Source

Blog post: https://socket.io/blog/socket-io-4-release/
Migration guide: https://socket.io/docs/v3/migrating-from-3-x-to-4-0/

Bug Fixes

• make io.to(...) immutable (ac9e8ca)

Features

• add some utility methods (b25495c)
• add support for typed events (#​3822) (0107510)
• allow to exclude specific rooms when broadcasting (#​3789) (7de2e87)
• allow to pass an array to io.to(...) (085d1de)

BREAKING CHANGES

• io.to(...) now returns an immutable operator

Previously, broadcasting to a given room (by calling io.to()) would mutate the io instance, which could lead to surprising behaviors, like:

io.to("room1");
io.to("room2").emit(/* ... */); // also sent to room1

// or with async/await
io.to("room3").emit("details", await fetchDetails()); // random behavior: maybe in room3, maybe to all clients

Calling io.to() (or any other broadcast modifier) will now return an immutable instance.

Links:

• Diff: socketio/socket.io@3.1.2...4.0.0
• Client release: 4.0.0
• engine.io version: ~5.0.0
• ws version: ~7.4.2

v3.1.3

Compare Source

v3.1.2

Compare Source

Bug Fixes

• ignore packets received after disconnection (494c64e)

Links:

• Diff: socketio/socket.io@3.1.1...3.1.2
• Client release: 3.1.2
• engine.io version: ~4.1.0
• ws version: ~7.4.2

v3.1.1

Compare Source

Bug Fixes

• properly parse the CONNECT packet in v2 compatibility mode (6f4bd7f)
• typings: add return types and general-case overload signatures (#​3776) (9e8f288)
• typings: update the types of "query", "auth" and "headers" (4f2e9a7)

Links:

• Diff: socketio/socket.io@3.1.0...3.1.1
• Client release: 3.1.1
• engine.io version: ~4.1.0
• ws version: ~7.4.2

v3.1.0

Compare Source

In order to ease the migration to Socket.IO v3, the v3 server is now able to communicate with v2 clients:

const io = require("socket.io")({
  allowEIO3: true // false by default
});

Note: the allowEIO3 refers to the version 3 of the Engine.IO protocol which is used in Socket.IO v2

Features

• confirm a weak but matching ETag (#​3485) (161091d)
• esm: export the Namespace and Socket class (#​3699) (233650c)
• add support for Socket.IO v2 clients (9925746)
• add room events (155fa63)

Bug Fixes

• allow integers as event names (1c220dd)

Links:

• Diff: socketio/socket.io@3.0.5...3.1.0
• Client release: 3.1.0
• engine.io version: ~4.1.0
• ws version: ~7.4.2

v3.0.5

Compare Source

Bug Fixes

• properly clear timeout on connection failure (170b739)

Reverts

• restore the socket middleware functionality (bf54327)

Links:

• Diff: socketio/socket.io@3.0.4...3.0.5
• Client release: 3.0.5
• engine.io version: ~4.0.6
• ws version: ~7.4.2

v3.0.4

Compare Source

Links:

• Diff: socketio/socket.io@3.0.3...3.0.4
• Client release: 3.0.4
• engine.io version: ~4.0.0
• ws version: ^7.1.2

v3.0.3

Compare Source

Links:

• Diff: socketio/socket.io@3.0.2...3.0.3
• Client release: 3.0.3
• engine.io version: ~4.0.0
• ws version: ^7.1.2

v3.0.2

Compare Source

Bug Fixes

• merge Engine.IO options (43705d7)

Links:

• Diff: socketio/socket.io@3.0.1...3.0.2
• Client release: 3.0.2
• engine.io version: ~4.0.0
• ws version: ^7.1.2

v3.0.1

Compare Source

Bug Fixes

• export ServerOptions and Namespace types (#​3684) (f62f180)
• typings: update the signature of the emit method (50671d9)

Links:

• Diff: socketio/socket.io@3.0.0...3.0.1
• Client release: 3.0.1
• engine.io version: ~4.0.0
• ws version: ^7.1.2

v3.0.0

Compare Source

More details about this release in the blog post: https://socket.io/blog/socket-io-3-release/

Dedicated migration guide: https://socket.io/docs/migrating-from-2-x-to-3-0/

Bug Fixes

• close clients with no namespace (91cd255)

Features

• emit an Error object upon middleware error (54bf4a4)
• serve msgpack bundle (aa7574f)
• add support for catch-all listeners (5c73733)
• make Socket#join() and Socket#leave() synchronous (129c641)
• remove prod dependency to socket.io-client (7603da7)
• move binary detection back to the parser (669592d)
• add ES6 module export (8b6b100)
• do not reuse the Engine.IO id (2875d2c)
• remove Server#set() method (029f478)
• remove Socket#rooms object (1507b41)
• remove the 'origins' option (a8c0600)
• remove the implicit connection to the default namespace (3289f7e)
• throw upon reserved event names (4bd5b23)

BREAKING CHANGES

• the Socket#use() method is removed (see 5c73733)

• Socket#join() and Socket#leave() do not accept a callback argument anymore.

Before:

socket.join("room1", () => {
 io.to("room1").emit("hello");
});

After:

socket.join("room1");
io.to("room1").emit("hello");
// or await socket.join("room1"); for custom adapters

• the "connected" map is renamed to "sockets"
• the Socket#binary() method is removed, as this use case is now covered by the ability to provide your own parser.
• the 'origins' option is removed

Before:

new Server(3000, {
  origins: ["https://example.com"]
});

The 'origins' option was used in the allowRequest method, in order to
determine whether the request should pass or not. And the Engine.IO
server would implicitly add the necessary Access-Control-Allow-xxx
headers.

After:

new Server(3000, {
  cors: {
    origin: "https://example.com",
    methods: ["GET", "POST"],
    allowedHeaders: ["content-type"]
  }
});

The already existing 'allowRequest' option can be used for validation:

new Server(3000, {
  allowRequest: (req, callback) => {
    callback(null, req.headers.referer.startsWith("https://example.com"));
  }
});

• Socket#rooms is now a Set instead of an object

• Namespace#connected is now a Map instead of an object

• there is no more implicit connection to the default namespace:

// client-side
const socket = io("/admin");

// server-side
io.on("connect", socket => {
  // not triggered anymore
})

io.use((socket, next) => {
  // not triggered anymore
});

io.of("/admin").use((socket, next) => {
  // triggered
});

• the Server#set() method was removed

This method was kept for backward-compatibility with pre-1.0 versions.

Links:

• Diff: socketio/socket.io@2.3.0...3.0.0
• Client release: 3.0.0
• engine.io version: ~4.0.0
• ws version: ^7.1.2

v2.5.0

Compare Source

⚠️ WARNING ⚠️

The default value of the maxHttpBufferSize option has been decreased from 100 MB to 1 MB, in order to prevent attacks by denial of service.

Security advisory: GHSA-j4f2-536g-r55m

Bug Fixes

• fix race condition in dynamic namespaces (05e1278)
• ignore packet received after disconnection (22d4bdf)
• only set 'connected' to true after middleware execution (226cc16)
• prevent the socket from joining a room after disconnection (f223178)

Links:

• Diff: socketio/socket.io@2.4.1...2.5.0
• Client release: 2.5.0
• engine.io version: ~3.6.0 (diff)
• ws version: ~7.4.2

v2.4.0

Compare Source

Related blog post: https://socket.io/blog/socket-io-2-4-0/

Features (from Engine.IO)

• add support for all cookie options (19cc582)
• disable perMessageDeflate by default (5ad2736)

Bug Fixes

• security: do not allow all origins by default (f78a575)
• properly overwrite the query sent in the handshake (d33a619)

⚠️ BREAKING CHANGE ⚠️

Previously, CORS was enabled by default, which meant that a Socket.IO server sent the necessary CORS headers (Access-Control-Allow-xxx) to any domain. This will not be the case anymore, and you now have to explicitly enable it.

Please note that you are not impacted if:

• you are using Socket.IO v2 and the origins option to restrict the list of allowed domains
• you are using Socket.IO v3 (disabled by default)

This commit also removes the support for '*' matchers and protocol-less URL:

io.origins('https://example.com:443'); => io.origins(['https://example.com']);
io.origins('localhost:3000');          => io.origins(['http://localhost:3000']);
io.origins('http://localhost:*');      => io.origins(['http://localhost:3000']);
io.origins('*:3000');                  => io.origins(['http://localhost:3000']);

To restore the previous behavior (please use with caution):

io.origins((_, callback) => {
  callback(null, true);
});

See also:

• https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS
• https://socket.io/docs/v3/handling-cors/
• https://socket.io/docs/v3/migrating-from-2-x-to-3-0/#CORS-handling

Thanks a lot to @​ni8walk3r for the security report.

Links:

• Milestone: 2.4.0
• Diff: socketio/socket.io@2.3.0...2.4.0
• Client release: 2.4.0
• engine.io version: ~3.5.0
• ws version: ~7.4.2

v2.3.1

Compare Source

v2.3.0

Compare Source

This release mainly contains a bump of the engine.io and ws packages, but no additional features.

Links:

• Milestone: 2.3.0
• Diff: socketio/socket.io@2.2.0...2.3.0
• Client release: 2.3.0
• engine.io version: ~3.4.0 (diff: socketio/engine.io@3.3.1...3.4.2)
• ws version: ^7.1.2 (diff: websockets/ws@6.1.2...7.3.1)

---

Configuration

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

🚦 Automerge: Enabled.

♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

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

---

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

---

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