Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(deps): update socket.io packages to v4.7.5 #378

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(deps): update socket.io packages to v4.7.5 #378

wants to merge 1 commit into from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Oct 14, 2021 •
edited
Loading

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
socket.io 4.2.0 -> 4.7.5 age adoption passing confidence
socket.io-client 4.2.0 -> 4.7.5 age adoption passing confidence

Release Notes

socketio/socket.io (socket.io)

v4.7.5

Compare Source

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

v4.7.4

Compare Source

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

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

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

v4.7.1

Compare Source

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

Links

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:

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

v4.6.2

Compare Source

Bug Fixes
Links

v4.6.1

Compare Source

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

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:

v4.5.4

Compare Source

This release contains a bump of:

Links:

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:

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:

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:

v4.5.0

Compare Source

Bug Fixes
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:

v4.4.1

Compare Source

Bug Fixes
Links:

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

v4.3.2

Compare Source

Bug Fixes
Links:

v4.3.1

Compare Source

Bug Fixes
Links:

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
Links:
socketio/socket.io-client (socket.io-client)

v4.7.5

Compare Source

Bug Fixes
  • discard acknowledgements upon disconnection (34cbfbb)
Dependencies

v4.7.4

Compare Source

There were some minor bug fixes on the server side, which mandate a client bump.

Dependencies

v4.7.3

Compare Source

Bug Fixes
  • improve compatibility with node16 module resolution (#​1595) (605de78)
  • typings: accept string | undefined as init argument (5a3eafe)
  • typings: fix the type of the socket#id attribute (f9c16f2)
Dependencies

v4.7.2

Compare Source

Some bug fixes are included from the engine.io-client package:

  • webtransport: add proper framing (d55c39e)
  • webtransport: honor the binaryType attribute (8270e00)
Dependencies

v4.7.1

Compare Source

Some bug fixes are included from the engine.io-client package:

  • make closeOnBeforeunload default to false (a63066b)
  • webtransport: properly handle abruptly closed connections (cf6aa1f)
Dependencies

v4.7.0

Compare Source

Bug Fixes
  • properly report timeout error when connecting (5bc94b5)
  • use same scope for setTimeout and clearTimeout calls (#​1568) (f2892ab)
Features
Support for WebTransport

The Engine.IO client 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:

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

import { WebTransport } from "@&#8203;fails-components/webtransport";

global.WebTransport = WebTransport;

Added in 7195c0f.

Cookie management for the Node.js client

When setting the withCredentials option to true, the Node.js client will now include the cookies in the HTTP requests, making it easier to use it with cookie-based sticky sessions.

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

const socket = io("https://example.com", {
  withCredentials: true
});

Added in 5fc88a6.

Conditional import of the ESM build with debug logs

By default, the ESM build does not include the debug package in the browser environments, because it increases the bundle size (see 16b6569).

Which means that, unfortunately, debug logs are not available in the devtools console, even when setting the localStorage.debug = ... attribute.

You can now import the build which includes the debug packages with a conditional import. Example with vite:

import { defineConfig } from 'vite'
import react from '@&#8203;vitejs/plugin-react'

export default defineConfig({
  plugins: [react()],
  server: {
    port: 4000
  },
  resolve: {
    conditions: ["development"]
  }
})

Reference: https://v2.vitejs.dev/config/#resolve-conditions

Added in 781d753.

Dependencies

v4.6.2

Compare Source

Bug Fixes
Dependencies

v4.6.1

Compare Source

Bug Fixes
  • do not drain the queue while the socket is offline (4996f9e)
  • prevent duplicate connections when multiplexing (46213a6)
Dependencies

v4.6.0

Compare Source

Bug Fixes
  • typings: do not expose browser-specific types (4d6d95e)
  • ensure manager.socket() returns an active socket (b7dd891)
  • typings: properly type emits with timeout (#​1570) (33e4172)
Features
A new "addTrailingSlash" option

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

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

const socket = io("https://example.com", {
  addTrailingSlash: false
});

In the example above, the request URL will be https://example.com/socket.io instead of https://example.com/socket.io/.

Added in 21a6e12.

Promise-based acknowledgements

This commit adds some syntactic sugar around acknowledgements:

// 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 server did not acknowledge the event in the given delay
}

Note: environments that do not support Promises will need to add a polyfill in order to use this feature.

Added in 47b979d.

Connection state recovery

This feature allows a client to reconnect after a temporary disconnection and restore its ID and receive any packets that was missed during the disconnection gap. It must be enabled on the server side.

A new boolean attribute named recovered is added on the socket object:

socket.on("connect", () => {
  console.log(socket.recovered); // whether the recovery was successful
});

Added in 54d5ee0 (server) and b4e20c5 (client).

Retry mechanism

Two new options are available:

  • retries: the maximum number of retries. Above the limit, the packet will be discarded.
  • ackTimeout: the default timeout in milliseconds used when waiting for an acknowledgement (not to be mixed up with the already existing timeout option, which is used by the Manager during the connection)
const socket = io({
  retries: 3,
  ackTimeout: 10000
});

// implicit ack
socket.emit("my-event");

// explicit ack
socket.emit("my-event", (err, val) => { /* ... */ });

// custom timeout (in that case the ackTimeout is optional)
socket.timeout(5000).emit("my-event", (err, val) => { /* ... */ });

In all examples above, "my-event" will be sent up to 4 times (1 + 3), until the server sends an acknowledgement.

Assigning a unique ID to each packet is the duty of the user, in order to allow deduplication on the server side.

Added in 655dce9.

Dependencies

v4.5.4

Compare Source

This release contains a bump of the socket.io-parser dependency, in order to fix CVE-2022-2421.

Dependencies

v4.5.3

Compare Source

Bug Fixes
  • do not swallow user exceptions (2403b88)
Dependencies

v4.5.2

Compare Source

Bug Fixes
  • handle ill-formatted packet from server (c597023)
Dependencies

v4.5.1

Compare Source

There were some minor bug fixes on the server side, which mandate a client bump.

Dependencies

v4.5.0

Compare Source

Features
Additional details for the disconnect event

The "disconnect" event will now include additional details to help debugging if anything has gone wrong.

Example when a payload is over the maxHttpBufferSize value in HTTP long-polling mode:

socket.on("disconnect", (reason, details) => {
  console.log(reason); // "transport error"

  // in that case, details is an error object
  console.log(details.message); "xhr post error"
  console.log(details.description); // 413 (the HTTP status of the response)

  // details.context refers to the XMLHttpRequest object
  console.log(details.context.status); // 413
  console.log(details.context.responseText); // ""
});

Added in b862924.

Catch-all listeners for outgoing packets

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

Syntax:

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

Added in 74e3e60.

Slice write buffer according to the maxPayload value

The server will now include a "maxPayload" field in the handshake details, allowing the clients to decide how many packets they have to send to stay under the maxHttpBufferSize value.

Added in 46fdc2f.

Dependencies

4.4.1 (2022-01-06)

v4.4.1

Compare Source

v4.4.0

Compare Source

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

4.3.2 (2021-10-16)

Bug Fixes
  • restore the default export (bis) (6780f29)

4.3.1 (2021-10-15)

Bug Fixes
  • restore the default export (f0aae84)
  • restore the namespace export (8737d0a)

v4.3.2

Compare Source

Bug Fixes
  • restore the default export (bis) (6780f29)

v4.3.1

Compare Source

Bug Fixes
  • restore the default export (f0aae84)
  • restore the namespace export (8737d0a)

v4.3.0

Compare Source

An ESM bundle is now provided:

<script type="module">
  import { io } from "https://cdn.socket.io/4.3.0/socket.io.esm.min.js";

  const socket = io();

  socket.emit("hello", "world");
</script>
Features
  • typings: add missing types for some emitter methods (#​1502) (a9e5b85)
  • provide an ESM build with and without debug (16b6569)
  • migrate to rollup (0661564)

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.

@renovate renovate bot force-pushed the renovate/socket.io-packages branch from a2d2b7f to 8517717 Compare October 16, 2021 00:04
@renovate renovate bot changed the title fix(deps): update socket.io packages to v4.3.0 fix(deps): update socket.io packages Oct 16, 2021
@renovate renovate bot force-pushed the renovate/socket.io-packages branch from 8517717 to 6237f57 Compare October 19, 2021 00:34
@renovate renovate bot force-pushed the renovate/socket.io-packages branch from 6237f57 to 0380cfa Compare November 8, 2021 11:00
@renovate renovate bot changed the title fix(deps): update socket.io packages fix(deps): update socket.io packages to v4.3.2 Nov 8, 2021
@renovate renovate bot force-pushed the renovate/socket.io-packages branch from 0380cfa to ebc02bc Compare November 18, 2021 15:29
@renovate renovate bot changed the title fix(deps): update socket.io packages to v4.3.2 fix(deps): update socket.io packages to v4.4.0 Nov 18, 2021
@renovate renovate bot force-pushed the renovate/socket.io-packages branch from ebc02bc to 2a99779 Compare January 6, 2022 08:43
@renovate renovate bot changed the title fix(deps): update socket.io packages to v4.4.0 fix(deps): update socket.io packages to v4.4.1 Jan 6, 2022
@renovate renovate bot changed the title fix(deps): update socket.io packages to v4.4.1 fix(deps): update socket.io packages to v4.5.0 Apr 23, 2022
@renovate renovate bot force-pushed the renovate/socket.io-packages branch from 2a99779 to 5891243 Compare April 23, 2022 23:37
@renovate renovate bot force-pushed the renovate/socket.io-packages branch from 5891243 to e3e20b4 Compare June 18, 2022 18:12
@renovate renovate bot changed the title fix(deps): update socket.io packages to v4.5.0 fix(deps): update socket.io packages to v4.5.1 Jun 18, 2022
@renovate renovate bot force-pushed the renovate/socket.io-packages branch from e3e20b4 to c223d3c Compare September 25, 2022 16:02
@renovate renovate bot changed the title fix(deps): update socket.io packages to v4.5.1 fix(deps): update socket.io packages to v4.5.2 Sep 25, 2022
@renovate renovate bot force-pushed the renovate/socket.io-packages branch from c223d3c to c5adea1 Compare November 20, 2022 16:49
@renovate renovate bot changed the title fix(deps): update socket.io packages to v4.5.2 fix(deps): update socket.io packages to v4.5.3 Nov 20, 2022
@renovate renovate bot force-pushed the renovate/socket.io-packages branch from c5adea1 to d87b59e Compare March 18, 2023 10:11
@renovate renovate bot changed the title fix(deps): update socket.io packages to v4.5.3 fix(deps): update socket.io packages to v4.6.1 Mar 18, 2023
@renovate renovate bot changed the title fix(deps): update socket.io packages to v4.6.1 fix(deps): update socket.io packages to v4.6.2 May 31, 2023
@renovate renovate bot force-pushed the renovate/socket.io-packages branch from d87b59e to 8dfb8b1 Compare May 31, 2023 09:54
@renovate renovate bot changed the title fix(deps): update socket.io packages to v4.6.2 fix(deps): update socket.io packages to v4.7.0 Jun 22, 2023
@renovate renovate bot force-pushed the renovate/socket.io-packages branch 2 times, most recently from a184706 to 4494b7d Compare June 28, 2023 10:10
@renovate renovate bot changed the title fix(deps): update socket.io packages to v4.7.0 fix(deps): update socket.io packages to v4.7.1 Jun 28, 2023
@renovate renovate bot changed the title fix(deps): update socket.io packages to v4.7.1 fix(deps): update socket.io packages to v4.7.2 Aug 3, 2023
@renovate renovate bot force-pushed the renovate/socket.io-packages branch from 4494b7d to 7ac509b Compare August 3, 2023 00:46
@renovate renovate bot force-pushed the renovate/socket.io-packages branch from 7ac509b to dbf4b3e Compare January 3, 2024 22:42
@renovate renovate bot changed the title fix(deps): update socket.io packages to v4.7.2 fix(deps): update socket.io packages to v4.7.3 Jan 3, 2024
@renovate renovate bot force-pushed the renovate/socket.io-packages branch from dbf4b3e to 9ba7a9b Compare January 12, 2024 11:38
@renovate renovate bot changed the title fix(deps): update socket.io packages to v4.7.3 fix(deps): update socket.io packages to v4.7.4 Jan 12, 2024
@renovate renovate bot force-pushed the renovate/socket.io-packages branch from 9ba7a9b to 389b7f3 Compare March 14, 2024 19:02
@renovate renovate bot changed the title fix(deps): update socket.io packages to v4.7.4 fix(deps): update socket.io packages to v4.7.5 Mar 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
0 participants