[Snyk] Upgrade socket.io-client from 4.5.4 to 4.6.0

This PR was automatically created by Snyk using the credentials of a real user.

Snyk has created this PR to upgrade socket.io-client from 4.5.4 to 4.6.0.

:information_source: Keep your dependencies up-to-date. This makes it easier to fix existing vulnerabilities and to more quickly identify and fix newly disclosed vulnerabilities when they affect your project.

- The recommended version is **3 versions** ahead of your current version. - The recommended version was released **21 days ago**, on 2023-02-06.

Release notes

Package name: socket.io-client

4.6.0 - 2023-02-06

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

	min	min+gzip
socket.io.min.js	45.8 KB (+ 3.2 KB ⬆️)	14.5 KB (+ 0.9 KB ⬆️)
socket.io.msgpack.min.js	50.7 KB (+ 3.0 KB ⬆️)	15.5 KB (+ 0.9 KB ⬆️)
socket.io.esm.min.js	37.0 KB (+ 2.5 KB ⬆️)	12.3 KB (+ 0.8 KB ⬆️)

4.6.0-alpha2 - 2023-02-04

  </li>
  <li>
    <b>4.6.0-alpha1</b> - 2023-02-03
  </li>
  <li>
    <b>4.5.4</b> - <a href="https://snyk.io/redirect/github/socketio/socket.io-client/releases/tag/4.5.4">2022-11-22</a></br><p>This release contains a bump of the <code>socket.io-parser</code> dependency, in order to fix <a href="https://snyk.io/redirect/github/advisories/GHSA-qm95-pgcg-qqfq">CVE-2022-2421</a>.</p>

Links:

Diff: 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:

	min	min+gzip
socket.io.min.js	42.6 KB (-)	13.6 KB (-)
socket.io.msgpack.min.js	47.7 KB (-)	14.6 KB (-)
socket.io.esm.min.js	34.5 KB (-)	11.5 KB (-)

  </li>
</ul>
from <a href="https://snyk.io/redirect/github/socketio/socket.io-client/releases">socket.io-client GitHub release notes</a>

Commit messages

Package name: socket.io-client

5980918 chore(release): 4.6.0
dff34a3 chore: bump engine.io-client to version 6.4.0
4d6d95e fix(typings): do not expose browser-specific types
c54e09d test: add more tests for the retry mechanism
0110e46 chore: bump engine.io-client to version 6.3.1
5ba0d49 refactor: minor edit
b1eed5f chore: bump engine.io-client to version 6.3.0
b7dd891 fix: ensure manager.socket() returns an active socket
655dce9 feat: implement retry mechanism
9f32925 test: add test with onAnyOutgoing() and binary attachments
f27cba5 refactor: add recovered flag after a successful recovery
47b979d feat: add promise-based acknowledgements
b4e20c5 feat: implement connection state recovery
a1c528b fix(typings): properly type emits with timeout (2)
33e4172 fix(typings): properly type emits with timeout (#1570)
18c6e0a chore: add security policy

Compare

Note: You are seeing this because you or someone else with access to this repository has authorized Snyk to open upgrade PRs.

For more information:

🧐 View latest project report

🛠 Adjust upgrade PR settings

🔕 Ignore this dependency or unsubscribe from future upgrade PRs

V0l-D / Discord-Netflix