[dist] Update dependency socket.io to v4 (!1528) · Merge requests · http ... PARTY! / node-http-proxy

Open Administrator requested to merge renovate/socket.io-4.x into master May 09, 2021

Created by: renovate[bot]

This PR contains the following updates:

Package	Change	Age	Adoption	Passing	Confidence
socket.io	`^2.1.0` -> `^4.0.0`
socket.io	`~0.9.16` -> `~4.6.0`

Release Notes

socketio/socket.io

`v4.6.1`

Compare Source

Bug Fixes

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

Dependencies

engine.io@~6.4.0 (no change)
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)

Dependencies

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.

Dependencies

engine.io@~6.2.1 (diff)
ws@~8.2.3 (no change)

`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)

`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)

`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)

`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}

4.4.1 (2022-01-06)

Bug Fixes

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

`v4.4.1`

Compare Source

Bug Fixes

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

`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)
add timeout feature (f0ed42f)
add type information to socket.data (#4159) (fe8730c)

4.3.2 (2021-11-08)

Bug Fixes

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

4.3.1 (2021-10-16)

Bug Fixes

fix server attachment (#4127) (0ef2a4d)

`v4.3.2`

Compare Source

Bug Fixes

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

`v4.3.1`

Compare Source

Bug Fixes

fix server attachment (#4127) (0ef2a4d)

`v4.3.0`

Compare Source

Bug Fixes

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

Features

serve ESM bundle (60edecb)

`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)

4.1.3 (2021-07-10)

Bug Fixes

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

4.1.2 (2021-05-17)

Bug Fixes

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

4.1.1 (2021-05-11)

Bug Fixes

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

`v4.1.3`

Compare Source

Bug Fixes

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

`v4.1.2`

Compare Source

Bug Fixes

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

`v4.1.1`

Compare Source

Bug Fixes

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

`v4.1.0`

Compare Source

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)

Performance Improvements

add support for the "wsPreEncoded" writing option (dc381b7)

4.0.2 (2021-05-06)

Bug Fixes

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

4.0.1 (2021-03-31)

Bug Fixes

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

`v4.0.2`

Compare Source

Bug Fixes

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

`v4.0.1`

Compare Source

Bug Fixes

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

`v4.0.0`

Compare Source

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)

3.1.2 (2021-02-26)

Bug Fixes

ignore packets received after disconnection (494c64e)

3.1.1 (2021-02-03)

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)

`v3.1.2`

Compare Source

Bug Fixes

ignore packets received after disconnection (494c64e)

`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)

`v3.1.0`

Compare Source

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)

2.4.1 (2021-01-07)

Reverts

fix(security): do not allow all origins by default (a169050)

3.0.5 (2021-01-05)

Bug Fixes

properly clear timeout on connection failure (170b739)

Reverts

restore the socket middleware functionality (bf54327)

`v3.0.5`

Compare Source

Bug Fixes

properly clear timeout on connection failure (170b739)

Reverts

restore the socket middleware functionality (bf54327)

Bug Fixes

merge Engine.IO options (43705d7)

`v3.0.1`

Compare Source

Bug Fixes

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

`v3.0.0`

Compare Source

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
});