Skip to content
This repository has been archived by the owner on Nov 22, 2022. It is now read-only.

Update socket.io packages to v4 (major) #69

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

Update socket.io packages to v4 (major) #69

wants to merge 1 commit into from

Conversation

renovate[bot]
Copy link

@renovate renovate bot commented Mar 10, 2021 •
edited
Loading

Mend Renovate

This PR contains the following updates:

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

Release Notes

socketio/socket.io

v4.5.3

Compare Source

Bug Fixes
  • typings: accept an HTTP2 server in the constructor (d3d0a2d)
  • typings: apply types to "io.timeout(...).emit()" calls (e357daf)

v4.5.2

Compare Source

Bug Fixes
  • prevent the socket from joining a room after disconnection (18f3fda)
  • uws: prevent the server from crashing after upgrade (ba497ee)

v4.5.1

Compare Source

Bug Fixes
  • forward the local flag to the adapter when using fetchSockets() (30430f0)
  • typings: add HTTPS server to accepted types (#​4351) (9b43c91)

v4.5.0

Compare Source

Bug Fixes
Features
  • add support for catch-all listeners for outgoing packets (531104d)

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

Syntax:

socket.onAnyOutgoing((event, ...args) => {
  console.log(event);
});
  • broadcast and expect multiple acks (8b20457)

Syntax:

io.timeout(1000).emit("some-event", (err, responses) => {
  // ...
});
  • add the "maxPayload" field in the handshake details (088dcb4)

So that clients in HTTP long-polling can decide how many packets they have to send to stay under the maxHttpBufferSize
value.

This is a backward compatible change which should not mandate a new major revision of the protocol (we stay in v4), as
we only add a field in the JSON-encoded handshake data:

0{"sid":"lv_VI97HAXpY6yYWAAAC","upgrades":["websocket"],"pingInterval":25000,"pingTimeout":5000,"maxPayload":1000000}

4.4.1 (2022-01-06)

Bug Fixes

v4.4.1

Compare Source

Bug Fixes

v4.4.0

Compare Source

Bug Fixes
  • only set 'connected' to true after middleware execution (02b0f73)
Features

4.3.2 (2021-11-08)

Bug Fixes

4.3.1 (2021-10-16)

Bug Fixes

v4.3.2

Compare Source

Bug Fixes

v4.3.1

Compare Source

Bug Fixes

v4.3.0

Compare Source

Bug Fixes
  • typings: add name field to cookie option (#​4099) (033c5d3)
  • send volatile packets with binary attachments (dc81fcf)
Features

v4.2.0

Compare Source

Bug Fixes
  • typings: allow async listener in typed events (ccfd8ca)
Features
  • ignore the query string when serving client JavaScript (#​4024) (24fee27)

4.1.3 (2021-07-10)

Bug Fixes
  • fix io.except() method (94e27cd)
  • remove x-sourcemap header (a4dffc6)

4.1.2 (2021-05-17)

Bug Fixes
  • typings: ensure compatibility with TypeScript 3.x (0cb6ac9)
  • ensure compatibility with previous versions of the adapter (a2cf248)

4.1.1 (2021-05-11)

Bug Fixes
  • typings: properly type server-side events (b84ed1e)
  • typings: properly type the adapter attribute (891b187)

v4.1.3

Compare Source

Bug Fixes
  • fix io.except() method (94e27cd)
  • remove x-sourcemap header (a4dffc6)

v4.1.2

Compare Source

Bug Fixes
  • typings: ensure compatibility with TypeScript 3.x (0cb6ac9)
  • ensure compatibility with previous versions of the adapter (a2cf248)

v4.1.1

Compare Source

Bug Fixes
  • typings: properly type server-side events (b84ed1e)
  • typings: properly type the adapter attribute (891b187)

v4.1.0

Compare Source

Features
  • add support for inter-server communication (93cce05)
  • notify upon namespace creation (499c892)
  • add a "connection_error" event (7096e98, from engine.io)
  • add the "initial_headers" and "headers" events (2527543, from engine.io)
Performance Improvements
  • add support for the "wsPreEncoded" writing option (dc381b7)

4.0.2 (2021-05-06)

Bug Fixes
  • typings: make "engine" attribute public (b81ce4c)
  • properly export the Socket class (d65b6ee)

4.0.1 (2021-03-31)

Bug Fixes

v4.0.2

Compare Source

Bug Fixes
  • typings: make "engine" attribute public (b81ce4c)
  • properly export the Socket class (d65b6ee)

v4.0.1

Compare Source

Bug Fixes

v4.0.0

Compare Source

Bug Fixes
  • make io.to(...) immutable (ac9e8ca)
Features

3.1.2 (2021-02-26)

Bug Fixes
  • ignore packets received after disconnection (494c64e)

3.1.1 (2021-02-03)

Bug Fixes
  • properly parse the CONNECT packet in v2 compatibility mode (6f4bd7f)
  • typings: add return types and general-case overload signatures (#​3776) (9e8f288)
  • typings: update the types of "query", "auth" and "headers" (4f2e9a7)

v3.1.2

Compare Source

Bug Fixes
  • ignore packets received after disconnection (494c64e)
socketio/socket.io-client

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)

v3.1.3

Compare Source

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

v3.1.2

Compare Source

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

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 these updates 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 requested a review from rclement March 10, 2021 13:27
@renovate renovate bot force-pushed the renovate/major-socket.io-packages branch from 7d36206 to 75c7d7e Compare April 1, 2021 00:43
@renovate renovate bot force-pushed the renovate/major-socket.io-packages branch from 75c7d7e to b1bdc65 Compare May 9, 2021 22:43
@codecov-commenter
Copy link

codecov-commenter commented May 9, 2021 •
edited
Loading

Codecov Report

Merging #69 (ae8c180) into master (cd02ab3) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #69   +/-   ##
=======================================
  Coverage   98.08%   98.08%           
=======================================
  Files          14       14           
  Lines         209      209           
  Branches       19       19           
=======================================
  Hits          205      205           
  Misses          4        4

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update cd02ab3...ae8c180. Read the comment docs.

@renovate renovate bot force-pushed the renovate/major-socket.io-packages branch from b1bdc65 to e80344b Compare May 15, 2021 21:16
@renovate renovate bot force-pushed the renovate/major-socket.io-packages branch from e80344b to abea681 Compare June 6, 2021 21:52
@renovate renovate bot force-pushed the renovate/major-socket.io-packages branch from abea681 to ae8c180 Compare October 18, 2021 20:48
@renovate renovate bot changed the title Update socket.io packages to v4 (major) Update socket.io packages (major) Oct 18, 2021
@renovate renovate bot force-pushed the renovate/major-socket.io-packages branch from ae8c180 to 459f60f Compare December 29, 2021 13:38
@renovate renovate bot changed the title Update socket.io packages (major) Update socket.io packages to v4 (major) Dec 29, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@rclement rclement Awaiting requested review from rclement

Assignees

@rclement rclement

Labels
dependencies
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@codecov-commenter @rclement @renovate-bot