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.

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

fix(deps): update dependency socket.io-client to v4.7.5 #58

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

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Mar 21, 2023

Mend Renovate

This PR contains the following updates:

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

Release Notes

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

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

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 this update again.


  • If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

@renovate renovate bot force-pushed the renovate/socket.io-packages branch from dbecdd3 to 76d8fae Compare March 22, 2023 16:10
@renovate renovate bot changed the title fix(deps): update dependency socket.io-client to v4.6.1 fix(deps): update dependency socket.io-client to v4.6.2 May 31, 2023
@renovate renovate bot force-pushed the renovate/socket.io-packages branch 2 times, most recently from 37ea3ff to f440d69 Compare June 3, 2023 17:44
@renovate renovate bot changed the title fix(deps): update dependency socket.io-client to v4.6.2 fix(deps): update dependency socket.io-client to v4.7.0 Jun 22, 2023
@renovate renovate bot force-pushed the renovate/socket.io-packages branch from f440d69 to 586f0bf Compare June 22, 2023 10:11
@renovate renovate bot changed the title fix(deps): update dependency socket.io-client to v4.7.0 fix(deps): update dependency socket.io-client to v4.7.1 Jun 28, 2023
@renovate renovate bot force-pushed the renovate/socket.io-packages branch from 586f0bf to 9c11212 Compare June 28, 2023 07:48
@renovate renovate bot changed the title fix(deps): update dependency socket.io-client to v4.7.1 fix(deps): update dependency socket.io-client to v4.7.2 Aug 3, 2023
@renovate renovate bot force-pushed the renovate/socket.io-packages branch from 9c11212 to 9656878 Compare August 3, 2023 02:02
@renovate renovate bot changed the title fix(deps): update dependency socket.io-client to v4.7.2 fix(deps): update dependency socket.io-client to v4.7.3 Jan 3, 2024
@renovate renovate bot force-pushed the renovate/socket.io-packages branch from 9656878 to b0ea373 Compare January 3, 2024 21:34
@renovate renovate bot changed the title fix(deps): update dependency socket.io-client to v4.7.3 fix(deps): update dependency socket.io-client to v4.7.4 Jan 12, 2024
@renovate renovate bot force-pushed the renovate/socket.io-packages branch from b0ea373 to 906b4b1 Compare January 12, 2024 10:39
@renovate renovate bot force-pushed the renovate/socket.io-packages branch from 906b4b1 to 0be9b2c Compare March 14, 2024 18:30
@renovate renovate bot changed the title fix(deps): update dependency socket.io-client to v4.7.4 fix(deps): update dependency socket.io-client 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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

0 participants