Skip to content

Latest commit

 

History

History
877 lines (469 loc) · 34.7 KB

CHANGELOG.md

File metadata and controls

877 lines (469 loc) · 34.7 KB
Raw

History

2024

2023

2022

2021

2020

2019

2018

Release notes

4.7.5 (2024-03-14)

Bug Fixes

  • discard acknowledgements upon disconnection (34cbfbb)

Dependencies

4.7.4 (2024-01-12)

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

Dependencies

4.7.3 (2024-01-03)

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

4.7.2 (2023-08-02)

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

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

Dependencies

4.7.1 (2023-06-28)

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

4.7.0 (2023-06-22)

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 "@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.

Dependencies

4.6.2 (2023-05-31)

Bug Fixes

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

Dependencies

4.6.1 (2023-02-20)

Bug Fixes

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

Dependencies

4.6.0 (2023-02-07)

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

4.5.4 (2022-11-22)

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

Dependencies

4.5.3 (2022-10-15)

Bug Fixes

  • do not swallow user exceptions (2403b88)

Dependencies

4.5.2 (2022-09-02)

Bug Fixes

  • handle ill-formatted packet from server (c597023)

Dependencies

2.5.0 (2022-06-26)

Bug Fixes

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

Dependencies

4.5.1 (2022-05-17)

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

Dependencies

4.5.0 (2022-04-23)

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)

4.4.0 (2021-11-18)

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)

4.3.0 (2021-10-14)

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)

4.2.0 (2021-08-30)

Bug Fixes

  • typings: allow async listener in typed events (66e00b7)
  • allow to set randomizationFactor to 0 (#1447) (dfb46b5)

Features

  • add an option to use native timer functions (#1479) (4e1b656)

4.1.3 (2021-07-10)

4.1.2 (2021-05-17)

Bug Fixes

  • typings: add missing closeOnBeforeunload option (#1469) (35d27df)
  • typings: add missing requestTimeout option (#1467) (c8dfbb1)

4.1.1 (2021-05-11)

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

4.1.0 (2021-05-11)

Features

  • add the "closeOnBeforeunload" option (dcb85e9, from engine.io-client)

4.0.2 (2021-05-06)

Bug Fixes

  • typings: add fallback to untyped event listener (5394669)
  • ensure buffered events are sent in order (34f822f)
  • ensure connections are properly multiplexed (dd2a8fc)
  • properly export the Socket class (e20d487)

4.0.1 (2021-03-31)

Bug Fixes

  • typings: make auth property public (#1455) (c150223)
  • typings: update definition to match wrapper.mjs (#1456) (48f573f)

3.1.3 (2021-03-12)

Bug Fixes

  • bundle: restore support for JS modules (afa7953)

4.0.0 (2021-03-10)

The major bump is due to some breaking changes on the server side.

Bug Fixes

  • bundle: restore support for JS modules (43613d1)

Features

  • add autoUnref option (6abfa1f)
  • add support for typed events (5902365)

3.1.2 (2021-02-26)

Bug Fixes

  • restore support for web workers (13b32b3)
  • silently close the transport in the beforeunload hook (ed48b5d, from engine.io-client)

3.1.1 (2021-02-03)

Bug Fixes

  • include the path in the manager ID (7a0c2b5)
  • remove polyfill for process in the bundle (61afc5d)
  • typings: add return types and general-case overload signatures (#1440) (47f917a)
  • typings: fix the type of the "query" option (#1439) (f02ab3b)

3.1.0 (2021-01-15)

Bug Fixes

3.0.5 (2021-01-05)

Bug Fixes

  • emit a connect_error event upon connection failure (53c7374)
  • typings: make sendBuffer and receiveBuffer public (b83f89c)

2.4.0 (2021-01-04)

The minor bump is matching the bump of the server, but there is no new feature in this release.

3.0.4 (2020-12-07)

Bug Fixes

3.0.3 (2020-11-19)

Bug Fixes

  • properly export io in ES modules wrapper (bec1524)

3.0.2 (2020-11-17)

Bug Fixes

  • typings: export withCredentials option (7193078)
  • typings: export ManagerOptions (#1398) (96cd2c9)
  • add io as named exports (7b3ec9f)

3.0.1 (2020-11-09)

Bug Fixes

  • typings: export Socket and SocketOptions types (#1394) (19ab1e9)

3.0.0 (2020-11-05)

Code Refactoring

  • rename ERROR to CONNECT_ERROR (13e1db7)

Features

  • emit an Error object upon middleware error (0939395)
  • add bundle with msgpack parser (71d6048)
  • add support for catch-all listeners (55f464f)
  • add volatile events (7ddad2c)
  • move binary detection back to the parser (1789094)
  • add ES6 module export (cbabb03)
  • do not reuse the Engine.IO id (bbe94ad)
  • remove the implicit connection to the default namespace (249e0be)
  • split the events of the Manager and Socket (132f8ec)
  • throw upon reserved event names (6494f61)

BREAKING CHANGES

  • the Socket instance will now emit a "connect_error" event instead of "error" (which is not a reserved event anymore)
// before
socket.on("error", () => {});

// after
socket.on("connect_error", () => {});

  • the Socket#binary() method is removed, as this use case is now covered by the ability to provide your own parser.

  • the Socket instance will no longer forward the events of its Manager

Those events can still be accessed on the Manager instance though:

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

3.0.0-rc4 (2020-10-30)

Features

  • emit an Error object upon middleware error (0939395)

3.0.0-rc3 (2020-10-26)

Code Refactoring

  • rename ERROR to CONNECT_ERROR (13e1db7)

Features

  • add bundle with msgpack parser (71d6048)
  • add support for catch-all listeners (55f464f)
  • add volatile events (7ddad2c)

BREAKING CHANGES

  • the Socket instance will now emit a "connect_error" event instead of "error" (which is not a reserved event anymore)
// before
socket.on("error", () => {});

// after
socket.on("connect_error", () => {});

3.0.0-rc2 (2020-10-15)

Features

  • move binary detection back to the parser (1789094)

BREAKING CHANGES

  • the Socket#binary() method is removed, as this use case is now covered by the ability to provide your own parser.

3.0.0-rc1 (2020-10-13)

Features

  • add ES6 module export (cbabb03)
  • do not reuse the Engine.IO id (bbe94ad)
  • remove the implicit connection to the default namespace (249e0be)
  • split the events of the Manager and Socket (132f8ec)
  • throw upon reserved event names (6494f61)

BREAKING CHANGES

  • the Socket instance will no longer forward the events of its Manager

Those events can still be accessed on the Manager instance though:

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

2.3.1 (2020-09-30)

The debug dependency has been reverted to ~3.1.0, as the newer versions contains ES6 syntax which breaks in IE browsers.

Please note that this only applied to users that bundle the Socket.IO client in their application, with webpack for example, as the "official" bundles (in the dist/ folder) were already transpiled with babel.

For webpack users, you can also take a look at the webpack-remove-debug plugin.

Bug Fixes

  • fix reconnection after opening socket asynchronously (#1253) (050108b)

2.3.0 (2019-09-20)

The minor bump is matching the bump of the server, but there is no new feature in this release.

2.2.0 (2018-11-29)

Bug fixes

  • remove any reference to the global variable (related: #1166)

2.1.1 (2018-05-17)

Bug fixes

  • fire an error event on middleware failure for non-root namespace (#1202) (0fe9439)

2.1.0 (2018-03-29)

Features

// by default, the object is recursively scanned to check whether it contains some binary data
// in the following example, the check is skipped in order to improve performance
socket.binary(false).emit('plain-object', object);