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

Update dependency socket.io-client to v4 #31

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

Update dependency socket.io-client to v4 #31

wants to merge 1 commit into from

Conversation

renovate[bot]
Copy link

@renovate renovate bot commented Apr 26, 2021 •
edited

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
socket.io-client ^3.0.0 -> ^4.0.0 age adoption passing confidence

Release Notes

socketio/socket.io-client

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)

v4.5.2

Compare Source

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

v4.5.1

Compare Source

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

v4.5.0

Compare Source

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.

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)

v4.2.0

Compare Source

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

4.1.3 (2021-07-10)

4.1.2 (2021-05-17)

Bug Fixes

4.1.1 (2021-05-11)

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

v4.1.3

Compare Source

v4.1.2

Compare Source

Bug Fixes

v4.1.1

Compare Source

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

v4.1.0

Compare Source

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

3.1.3 (2021-03-12)

Bug Fixes
  • bundle: restore support for JS modules (afa7953)

v4.0.2

Compare Source

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)

v4.0.1

Compare Source

Bug Fixes

v4.0.0

Compare Source

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)

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
Copy link
Author

renovate bot commented Mar 25, 2023 •
edited

Edited/Blocked Notification

Renovate will not automatically rebase this PR, because it does not recognize the last commit author and assumes somebody else may have edited the PR.

You can manually request rebase by checking the rebase/retry box above.

⚠️ Warning: custom changes will be lost.

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.

None yet
1 participant
@renovate-bot