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

fix(deps): update socket.io packages to v4 (major) #30

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

fix(deps): update socket.io packages to v4 (major) #30

wants to merge 1 commit into from

Conversation

renovate[bot]
Copy link

@renovate renovate bot commented Jun 7, 2021 •
edited
Loading

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
socket.io (source) 3.1.1 -> 4.8.1 age adoption passing confidence
socket.io-client (source) 3.1.2 -> 4.8.1 age adoption passing confidence

Release Notes

socketio/socket.io (socket.io)

v4.8.1

Compare Source

Bug Fixes
  • bundle: do not mangle the "_placeholder" attribute (ca9e994)
Dependencies

v4.8.0

Compare Source

Features
Custom transport implementations

The transports option now accepts an array of transport implementations:

import { io } from "socket.io-client";
import { XHR, WebSocket } from "engine.io-client";

const socket = io({
  transports: [XHR, WebSocket]
});

Here is the list of provided implementations:

Transport Description
Fetch HTTP long-polling based on the built-in fetch() method.
NodeXHR HTTP long-polling based on the XMLHttpRequest object provided by the xmlhttprequest-ssl package.
XHR HTTP long-polling based on the built-in XMLHttpRequest object.
NodeWebSocket WebSocket transport based on the WebSocket object provided by the ws package.
WebSocket WebSocket transport based on the built-in WebSocket object.
WebTransport WebTransport transport based on the built-in WebTransport object.

Usage:

Transport browser Node.js Deno Bun
Fetch ✅ ✅ (1) ✅ ✅
NodeXHR ✅ ✅ ✅
XHR ✅
NodeWebSocket ✅ ✅ ✅
WebSocket ✅ ✅ (2) ✅ ✅
WebTransport ✅ ✅

(1) since v18.0.0
(2) since v21.0.0

Added in f4d898e and b11763b.

Test each low-level transports

When setting the tryAllTransports option to true, if the first transport (usually, HTTP long-polling) fails, then the other transports will be tested too:

import { io } from "socket.io-client";

const socket = io({
  tryAllTransports: true
});

This feature is useful in two cases:

  • when HTTP long-polling is disabled on the server, or if CORS fails
  • when WebSocket is tested first (with transports: ["websocket", "polling"])

The only potential downside is that the connection attempt could take more time in case of failure, as there have been reports of WebSocket connection errors taking several seconds before being detected (that's one reason for using HTTP long-polling first). That's why the option defaults to false for now.

Added in 579b243.

Bug Fixes
  • accept string | undefined as init argument (bis) (60c757f)
  • allow to manually stop the reconnection loop (13c6d2e)
  • close the engine upon decoding exception (04c8dd9)
  • do not send a packet on an expired connection (#​5134) (8adcfbf)
Dependencies

v4.7.5

Compare Source

Bug Fixes
  • close the adapters when the server is closed (bf64870)
  • remove duplicate pipeline when serving bundle (e426f3e)
Links

v4.7.4

Compare Source

Bug Fixes
  • typings: calling io.emit with no arguments incorrectly errored (cb6d2e0), closes #​4914
Links

v4.7.3

Compare Source

Bug Fixes
  • return the first response when broadcasting to a single socket (#​4878) (df8e70f)
  • typings: allow to bind to a non-secure Http2Server (#​4853) (8c9ebc3)
Links

v4.7.2

Compare Source

Bug Fixes
  • clean up child namespace when client is rejected in middleware (#​4773) (0731c0d)
  • webtransport: properly handle WebTransport-only connections (3468a19)
  • webtransport: add proper framing (a306db0)
Links

v4.7.1

Compare Source

The client bundle contains a few fixes regarding the WebTransport support.

Links

v4.7.0

Compare Source

Bug Fixes
  • remove the Partial modifier from the socket.data type (#​4740) (e5c62ca)
Features
Support for WebTransport

The Socket.IO server 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:

Until WebTransport support lands in Node.js, you can use the @fails-components/webtransport package:

import { readFileSync } from "fs";
import { createServer } from "https";
import { Server } from "socket.io";
import { Http3Server } from "@​fails-components/webtransport";

// WARNING: the total length of the validity period MUST NOT exceed two weeks (https://w3c.github.io/webtransport/#custom-certificate-requirements)
const cert = readFileSync("/path/to/my/cert.pem");
const key = readFileSync("/path/to/my/key.pem");

const httpsServer = createServer({
  key,
  cert
});

httpsServer.listen(3000);

const io = new Server(httpsServer, {
  transports: ["polling", "websocket", "webtransport"] // WebTransport is not enabled by default
});

const h3Server = new Http3Server({
  port: 3000,
  host: "0.0.0.0",
  secret: "changeit",
  cert,
  privKey: key,
});

(async () => {
  const stream = await h3Server.sessionStream("/socket.io/");
  const sessionReader = stream.getReader();

  while (true) {
    const { done, value } = await sessionReader.read();
    if (done) {
      break;
    }
    io.engine.onWebTransportSession(value);
  }
})();

h3Server.startServer();

Added in 123b68c.

Client bundles with CORS headers

The bundles will now have the right Access-Control-Allow-xxx headers.

Added in 63f181c.

Links

v4.6.2

Compare Source

Bug Fixes
Links

v4.6.1

Compare Source

Bug Fixes
  • properly handle manually created dynamic namespaces (0d0a7a2)
  • types: fix nodenext module resolution compatibility (#​4625) (d0b22c6)
Links

v4.6.0

Compare Source

Bug Fixes
  • add timeout method to remote socket (#​4558) (0c0eb00)
  • typings: properly type emits with timeout (f3ada7d)
Features
Promise-based acknowledgements

This commit adds some syntactic sugar around acknowledgements:

  • emitWithAck()
try {
  const responses = await io.timeout(1000).emitWithAck("some-event");
  console.log(responses); // one response per client
} catch (e) {
  // some clients did not acknowledge the event in the given delay
}

io.on("connection", async (socket) => {
    // 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 client did not acknowledge the event in the given delay
  }
});
  • serverSideEmitWithAck()
try {
  const responses = await io.timeout(1000).serverSideEmitWithAck("some-event");
  console.log(responses); // one response per server (except itself)
} catch (e) {
  // some servers did not acknowledge the event in the given delay
}

Added in 184f3cf.

Connection state recovery

This feature allows a client to reconnect after a temporary disconnection and restore its state:

  • id
  • rooms
  • data
  • missed packets

Usage:

import { Server } from "socket.io";

const io = new Server({
  connectionStateRecovery: {
    // default values
    maxDisconnectionDuration: 2 * 60 * 1000,
    skipMiddlewares: true,
  },
});

io.on("connection", (socket) => {
  console.log(socket.recovered); // whether the state was recovered or not
});

Here's how it works:

  • the server sends a session ID during the handshake (which is different from the current id attribute, which is public and can be freely shared)
  • the server also includes an offset in each packet (added at the end of the data array, for backward compatibility)
  • upon temporary disconnection, the server stores the client state for a given delay (implemented at the adapter level)
  • upon reconnection, the client sends both the session ID and the last offset it has processed, and the server tries to restore the state

The in-memory adapter already supports this feature, and we will soon update the Postgres and MongoDB adapters. We will also create a new adapter based on Redis Streams, which will support this feature.

Added in 54d5ee0.

Compatibility (for real) with Express middlewares

This feature implements middlewares at the Engine.IO level, because Socket.IO middlewares are meant for namespace authorization and are not executed during a classic HTTP request/response cycle.

Syntax:

io.engine.use((req, res, next) => {
  // do something

  next();
});

// with express-session
import session from "express-session";

io.engine.use(session({
  secret: "keyboard cat",
  resave: false,
  saveUninitialized: true,
  cookie: { secure: true }
}));

// with helmet
import helmet from "helmet";

io.engine.use(helmet());

A workaround was possible by using the allowRequest option and the "headers" event, but this feels way cleaner and works with upgrade requests too.

Added in 24786e7.

Error details in the disconnecting and disconnect events

The disconnect event will now contain additional details about the disconnection reason.

io.on("connection", (socket) => {
  socket.on("disconnect", (reason, description) => {
    console.log(description);
  });
});

Added in 8aa9499.

Automatic removal of empty child namespaces

This commit adds a new option, "cleanupEmptyChildNamespaces". With this option enabled (disabled by default), when a socket disconnects from a dynamic namespace and if there are no other sockets connected to it then the namespace will be cleaned up and its adapter will be closed.

import { createServer } from "node:http";
import { Server } from "socket.io";

const httpServer = createServer();
const io = new Server(httpServer, {
  cleanupEmptyChildNamespaces: true
});

Added in 5d9220b.

A new "addTrailingSlash" option

The trailing slash which was added by default can now be disabled:

import { createServer } from "node:http";
import { Server } from "socket.io";

const httpServer = createServer();
const io = new Server(httpServer, {
  addTrailingSlash: false
});

In the example above, the clients can omit the trailing slash and use /socket.io instead of /socket.io/.

Added in d0fd474.

Performance Improvements
  • precompute the WebSocket frames when broadcasting (da2b542)
Links:

v4.5.4

Compare Source

This release contains a bump of:

Links:

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

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

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

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

v4.4.1

Compare Source

Bug Fixes
Links:

v4.4.0

Compare Source

Bug Fixes
  • only set 'connected' to true after middleware execution (02b0f73)
Features
  • add an implementation based on uWebSockets.js (c0d8c5a)
const { App } = require("uWebSockets.js");
const { Server } = require("socket.io");

const app = new App();
const io = new Server();

io.attachApp(app);

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

app.listen(3000, (token) => {
  if (!token) {
    console.warn("port already in use");
  }
});
socket.timeout(5000).emit("my-event", (err) => {
  if (err) {
    // the client did not acknowledge the event in the given delay
  }
});
interface SocketData {
  name: string;
  age: number;
}

const io = new Server<ClientToServerEvents, ServerToClientEvents, InterServerEvents, SocketData>();

io.on("connection", (socket) => {
  socket.data.name = "john";
  socket.data.age = 42;
});
Links:

v4.3.2

Compare Source

Bug Fixes
Links:

v4.3.1

Compare Source

Bug Fixes
Links:

v4.3.0

Compare Source

For this release, most of the work was done on the client side, see here.

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

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

v4.1.3

Compare Source

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

v4.1.2

Compare Source

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

v4.1.1

Compare Source

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

v4.1.0

Compare Source

Blog post: https://socket.io/blog/socket-io-4-1-0/

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

v4.0.2

Compare Source

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

v4.0.1

Compare Source

Bug Fixes
Links:

v4.0.0

Compare Source

Blog post: https://socket.io/blog/socket-io-4-release/
Migration guide: https://socket.io/docs/v3/migrating-from-3-x-to-4-0/

Bug Fixes
  • make io.to(...) immutable (ac9e8ca)
Features
BREAKING CHANGES
  • io.to(...) now returns an immutable operator

Previously, broadcasting to a given room (by calling io.to()) would mutate the io instance, which could lead to surprising behaviors, like:

io.to("room1");
io.to("room2").emit(/* ... */); // also sent to room1

// or with async/await
io.to("room3").emit("details", await fetchDetails()); // random behavior: maybe in room3, maybe to all clients

Calling io.to() (or any other broadcast modifier) will now return an immutable instance.

Links:

v3.1.2

Compare Source

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

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 was generated by Mend Renovate. View the repository job log.

@guardrails
Copy link

guardrails bot commented Jun 7, 2021 •
edited
Loading

⚠️ We detected 34 security issues in this pull request:

Vulnerable Libraries (34)
Severity Details
Critical @babel/traverse@7.13.0 (t) upgrade to: >=7.23.2
Critical @quasar/app@2.1.15 (t) upgrade to: >=1.4.1
High async@3.2.0 (t) upgrade to: >2.6.3 || >3.2.1
High axios@0.21.1 (t) upgrade to: >=0.21.4
High browserify-sign@4.2.1 (t) upgrade to: >4.2.1
Medium browserslist@4.16.3 (t) upgrade to: >4.16.4
Medium color-string@1.5.4 (t) upgrade to: >=1.5.5
High decode-uri-component@0.2.0 (t) upgrade to: >=0.2.1
High dns-packet@1.3.1 (t) upgrade to: >=1.3.2
Critical eventsource@1.0.7 (t) upgrade to: >=1.1.1
High follow-redirects@1.13.2 (t) upgrade to: >1.15.5
Medium hosted-git-info@2.8.8 (t) upgrade to: >=2.8.9
Critical loader-utils@1.4.0 (t) upgrade to: >1.4.1 || >2.0.3
High moment@2.29.1 (t) upgrade to: >2.29.3
Medium path-parse@1.0.6 (t) upgrade to: >=1.0.7
Critical plist@3.0.1 (t) upgrade to: >3.0.4
High postcss-svgo@4.0.2 (t) upgrade to: >5.0.0-rc.2
High renderkid@2.0.5 (t) upgrade to: >2.0.5
Critical shell-quote@1.7.2 (t) upgrade to: >1.7.2
High ssri@6.0.1 (t) upgrade to: >6.0.1
High tar@6.1.0 (t) upgrade to: >6.2.0
High terser@4.8.0 (t) upgrade to: >=5.14.2 || >=4.8.1
Critical url-parse@1.5.1 (t) upgrade to: >1.5.8
Medium word-wrap@1.2.3 (t) upgrade to: >=1.2.4
High @babel/core@7.13.1 (t) upgrade to: >7.13.1
High @babel/helper-compilation-targets@7.13.0 (t) upgrade to: 7.13.0
High @babel/plugin-transform-runtime@7.13.4 (t) upgrade to: >7.13.7
High @babel/preset-env@7.13.0 (t) upgrade to: >7.13.5
High core-js-compat@3.9.0 (t) upgrade to: >3.25.0
High find-babel-config@1.2.0 (t) upgrade to: >1.2.0
High html-minifier@4.0.0 (t) upgrade to: ***
High ip@1.1.5 (t) upgrade to: ***
Medium postcss-rtl@1.7.3 (t) upgrade to: >1.7.3
High vue-server-renderer@2.6.12 (t) upgrade to: >=2.3.0-beta.1

More info on how to fix Vulnerable Libraries in JavaScript.

👉 Go to the dashboard for detailed results.

📥 Happy? Share your feedback with us.

@renovate renovate bot force-pushed the renovate/major-socket.io-packages branch from a630bf1 to 2af623e Compare July 10, 2021 10:25
@renovate renovate bot force-pushed the renovate/major-socket.io-packages branch from 2af623e to a77676d Compare August 30, 2021 09:20
@renovate renovate bot force-pushed the renovate/major-socket.io-packages branch 2 times, most recently from d85cc65 to 079eecd Compare October 16, 2021 00:02
@renovate renovate bot changed the title fix(deps): update socket.io packages to v4 (major) fix(deps): update socket.io packages (major) Oct 16, 2021
@renovate renovate bot force-pushed the renovate/major-socket.io-packages branch from 079eecd to 7cb9f5a Compare October 19, 2021 00:34
@renovate renovate bot force-pushed the renovate/major-socket.io-packages branch from 7cb9f5a to 34bd6e2 Compare March 7, 2022 14:40
@renovate renovate bot changed the title fix(deps): update socket.io packages (major) fix(deps): update socket.io packages to v4 (major) Mar 7, 2022
@renovate renovate bot force-pushed the renovate/major-socket.io-packages branch from 34bd6e2 to 8b44a72 Compare April 24, 2022 23:29
@renovate renovate bot force-pushed the renovate/major-socket.io-packages branch from 8b44a72 to aa2554d Compare May 17, 2022 22:30
@renovate renovate bot force-pushed the renovate/major-socket.io-packages branch from aa2554d to cf890e8 Compare September 25, 2022 11:10
@renovate renovate bot force-pushed the renovate/major-socket.io-packages branch from cf890e8 to ba40612 Compare November 20, 2022 16:34
@renovate renovate bot force-pushed the renovate/major-socket.io-packages branch from ba40612 to 72cd119 Compare March 16, 2023 16:04
@renovate renovate bot force-pushed the renovate/major-socket.io-packages branch from 72cd119 to 650c529 Compare May 31, 2023 11:09
@renovate renovate bot force-pushed the renovate/major-socket.io-packages branch 2 times, most recently from aba309d to f8f476e Compare June 28, 2023 10:39
@renovate renovate bot force-pushed the renovate/major-socket.io-packages branch from f8f476e to 74f5f2b Compare August 3, 2023 03:29
@renovate renovate bot force-pushed the renovate/major-socket.io-packages branch from 74f5f2b to 763f7ef Compare January 3, 2024 23:19
@renovate renovate bot force-pushed the renovate/major-socket.io-packages branch from 763f7ef to 4f9a579 Compare January 12, 2024 12:23
@renovate renovate bot force-pushed the renovate/major-socket.io-packages branch from 4f9a579 to 8812252 Compare March 14, 2024 18:48
@renovate renovate bot changed the title fix(deps): update socket.io packages to v4 (major) fix(deps): update dependency socket.io-client to v4 Jun 19, 2024
@renovate renovate bot changed the title fix(deps): update dependency socket.io-client to v4 fix(deps): update socket.io packages to v4 (major) Aug 6, 2024
@renovate renovate bot force-pushed the renovate/major-socket.io-packages branch from 8812252 to 7812aca Compare September 21, 2024 10:50
@renovate renovate bot force-pushed the renovate/major-socket.io-packages branch from 7812aca to 8764755 Compare October 25, 2024 08:16
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.
0 participants