socket.io-client

Bug Fixes

• discard acknowledgements upon disconnection (34cbfbb)

Links

• Diff: https://github.com/socketio/socket.io-client/compare/4.7.4...4.7.5
• Server release: 4.7.5
• engine.io-client@~6.5.2 (no change)
• ws@~8.11.0 (no change)

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

Links

• Diff: https://github.com/socketio/socket.io-client/compare/4.7.3...4.7.4
• Server release: 4.7.4
• engine.io-client@~6.5.2 (no change)
• ws@~8.11.0 (no change)

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)

Links

• Diff: https://github.com/socketio/socket.io-client/compare/4.7.2...4.7.3
• Server release: 4.7.3
• engine.io-client@~6.5.2 (no change)
• ws@~8.11.0 (no change)

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

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

Links

• Diff: https://github.com/socketio/socket.io-client/compare/4.7.1...4.7.2
• Server release: 4.7.2
• engine.io-client@~6.5.2 (diff)
• ws@~8.11.0 (no change)

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

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

Links

• Diff: https://github.com/socketio/socket.io-client/compare/4.7.0...4.7.1
• Server release: 4.7.1
• engine.io-client@~6.5.1 (diff)
• ws@~8.11.0 (no change)

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:

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

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

import { WebTransport } from "@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 '@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.

Links

• Diff: https://github.com/socketio/socket.io-client/compare/4.6.2...4.7.0
• Server release: 4.7.0
• engine.io-client version: ~6.5.0 (diff)
• ws version: ~8.11.0 (no change)

Bug Fixes

• exports: move types condition to the top (#1580) (7ead241)

Links

• Diff: https://github.com/socketio/socket.io-client/compare/4.6.1...4.6.2
• Server release: 4.6.2
• engine.io-client version: ~6.4.0 (no change)
• ws version: ~8.11.0 (no change)

Bug Fixes

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

Links

• Diff: https://github.com/socketio/socket.io-client/compare/4.6.0...4.6.1
• Server release: 4.6.1
• engine.io-client version: ~6.4.0 (no change)
• ws version: ~8.11.0 (no change)

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.

Links

• Diff: https://github.com/socketio/socket.io-client/compare/4.5.4...4.6.0
• Server release: 4.6.0
• engine.io-client version: ~6.4.0 (diff)
• ws version: ~8.11.0 (diff)

Size of the bundles:

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

Links:

• Diff: https://github.com/socketio/socket.io-client/compare/4.5.3...4.5.4
• Server release: 4.5.4
• engine.io-client version: ~6.2.3
• ws version: ~8.2.3

Size of the bundles:

Bug Fixes

• do not swallow user exceptions (2403b88)

Links:

• Diff: https://github.com/socketio/socket.io-client/compare/4.5.2...4.5.3
• Server release: 4.5.3
• engine.io-client version: ~6.2.1
• ws version: ~8.2.3

Size of the bundles:

Bug Fixes

• handle ill-formatted packet from server (c597023)

Links:

• Diff: https://github.com/socketio/socket.io-client/compare/4.5.1...4.5.2
• Server release: 4.5.2
• engine.io-client version: ~6.2.1 (diff)
• ws version: ~8.2.3

Size of the bundles:

Bug Fixes

• ensure buffered events are sent in order (991eb0b)

Links:

• Diff: https://github.com/socketio/socket.io-client/compare/2.4.0...2.5.0
• Server release: 2.5.0
• engine.io-client version: ~3.5.0
• ws version: ~7.4.2

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

Links:

• Diff: https://github.com/socketio/socket.io-client/compare/4.5.0...4.5.1
• Server release: 4.5.1
• engine.io-client version: ~6.2.1 (diff)
• ws version: ~8.2.3

Size of the bundles:

Features

• add details to the disconnect event (b862924)

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

• add support for catch-all listeners for outgoing packets (74e3e60)

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

Syntax:

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

• slice write buffer according to the maxPayload value (46fdc2f)

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.

Links:

• Diff: https://github.com/socketio/socket.io-client/compare/4.4.1...4.5.0
• Server release: 4.5.0
• engine.io-client version: ~6.2.1 (diff)
• ws version: ~8.2.3

Size of the bundles:

This release only contains minor changes. Please see the diff for more details.

Links:

• Diff: https://github.com/socketio/socket.io-client/compare/4.4.0...4.4.1
• Server release: 4.4.1
• engine.io-client version: ~6.1.1
• ws version: ~8.2.3

Size of the bundles:

Bug Fixes

• add package name in nested package.json (53d8fca), closes socketio/socket.io-client#1513
• fix socket.disconnect().connect() usage (99c2cb8)
• prevent socket from reconnecting after middleware failure (d54d12c)

Features

• add timeout feature (ccf7998)

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

Links:

• Diff: https://github.com/socketio/socket.io-client/compare/4.3.2...4.4.0
• Server release: 4.4.0
• engine.io-client version: ~6.1.1 (diff)
• ws version: ~8.2.3

Size of the bundles:

Bug Fixes

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

Links:

• Diff: https://github.com/socketio/socket.io-client/compare/4.3.1...4.3.2
• Server release: -
• engine.io-client version: ~6.0.1
• ws version: ~8.2.3

Size of the bundles:

Bug Fixes

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

Links:

• Diff: https://github.com/socketio/socket.io-client/compare/4.3.0...4.3.1
• Server release: -
• engine.io-client version: ~6.0.1
• ws version: ~8.2.3

Size of the bundles:

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>

The bundle size has also been greatly reduced, from 16.0 KB to 12.9 KB (min+gzip).

Features

• typings: add missing types for some emitter methods (#1502) (a9e5b85)
• provide an ESM build with and without debug (16b6569)
• migrate to rollup (0661564)

Links:

• Diff: https://github.com/socketio/socket.io-client/compare/4.2.0...4.3.0
• Server release: 4.3.0
• engine.io-client version: ~6.0.1 (diff)
• ws version: ~8.2.3 (diff)

Size of the bundles: