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

build(deps): bump engine.io-client from 6.5.3 to 6.6.0 #6305

Merged
merged 3 commits into from
Sep 19, 2024

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Sep 16, 2024

Bumps engine.io-client from 6.5.3 to 6.6.0.

Release notes

Sourced from engine.io-client's releases.

6.6.0

Features

Custom transport implementations

The transports option now accepts an array of transport implementations:

import { Socket, XHR, WebSocket } from "engine.io-client";
const socket = new Socket({
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.

Transport tree-shaking

The feature above also comes with the ability to exclude the code related to unused transports (a.k.a. "tree-shaking"):

import { SocketWithoutUpgrade, WebSocket } from "engine.io-client";
</tr></table>

... (truncated)

Changelog

Sourced from engine.io-client's changelog.

6.6.0 (2024-06-21)

Bug Fixes

  • add some randomness to the cache busting string generator (b624c50)
  • fix cookie management with WebSocket (Node.js only) (e105551)

Features

  • add HTTP long-polling implementation based on fetch() (b11763b)
  • add the ability to test all transports (579b243)
  • allow to provide a list of transport implementations (f4d898e)

Dependencies

6.5.4 (2024-06-18)

This release contains a bump of the ws dependency, which includes an important security fix.

Advisory: GHSA-3h5v-q93c-6h6q

Dependencies

3.5.4 (2024-06-18)

This release contains a bump of the ws dependency, which includes an important security fix.

Advisory: GHSA-3h5v-q93c-6h6q

Dependencies

Commits
  • a17cbc5 chore(release): 6.6.0
  • 72408ad docs(changelog): include release notes from versions 3.5.3, 3.5.4 and 6.5.4
  • e97a4d3 chore: bump ws from 8.11.0 to 8.17.1 (#720)
  • b624c50 fix: add some randomness to the cache busting string generator
  • c087dc5 docs(changelog): include the size of the bundle
  • ce13763 ci: upgrade to actions/checkout@4 and actions/setup-node@4
  • 74cfb98 refactor: prefix private attributes to allow property mangling
  • 2b9abbb chore: restore the debug package in the dev bundle
  • e105551 fix: fix cookie management with WebSocket (Node.js only)
  • 3f66478 chore: remove unused rollup plugin
  • Additional commits viewable in compare view

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Bumps [engine.io-client](https://github.com/socketio/engine.io-client) from 6.5.3 to 6.6.0.
- [Release notes](https://github.com/socketio/engine.io-client/releases)
- [Changelog](https://github.com/socketio/engine.io-client/blob/6.6.0/CHANGELOG.md)
- [Commits](socketio/engine.io-client@6.5.3...6.6.0)

---
updated-dependencies:
- dependency-name: engine.io-client
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file javascript Pull requests that update Javascript code labels Sep 16, 2024
@coveralls
Copy link

coveralls commented Sep 16, 2024

Coverage Status

coverage: 78.751%. remained the same
when pulling f90bea4 on dependabot/npm_and_yarn/engine.io-client-6.6.0
into 42b775f on master.

@goplayoutside3
Copy link
Contributor

@mcbouslog this package was added in #2575 to build notifications, but I don't see engine.io-client actually imported anywhere -- could you double check it's needed in FEM and if so we might want to add an inline comment in app-project's PageHeader or elsewhere.

@mcbouslog
Copy link
Contributor

The quick answer is that it's a strange situation where engine.io-client is a dependency of the SugarClient/primus -https://github.com/zooniverse/panoptes-javascript-client/blob/main/lib/SugarClient/primus.js . There's a similar discussion in PFE where we tried to remove it, but it's required for tests - zooniverse/Panoptes-Front-End#4712 (comment) . I can dig into more if you'd like, but I think we need it.

@mcbouslog
Copy link
Contributor

At minimum I could add a comment where the sugarClient is imported, I could also investigate updating PJC to include engine.io-client as a dependency, though per the linked comments I'm not sure that's the right solution.

@goplayoutside3
Copy link
Contributor

Thanks! I suggest just adding an inline comment. For instance, if I search all of FEM for keyword "engine.io" then at least there'd be a bit of documentation so future devs don't accidentally remove the package. Feel free to take over this dependabot PR and add to it if easiest! You should be able to approve and merge it without additional review.

@mcbouslog mcbouslog self-assigned this Sep 17, 2024
@mcbouslog mcbouslog self-requested a review September 17, 2024 14:49
@github-actions github-actions bot added the approved This PR is approved for merging label Sep 19, 2024
@goplayoutside3 goplayoutside3 merged commit 7ba1f74 into master Sep 19, 2024
8 checks passed
@goplayoutside3 goplayoutside3 deleted the dependabot/npm_and_yarn/engine.io-client-6.6.0 branch September 19, 2024 14:47
@eatyourgreens
Copy link
Contributor

eatyourgreens commented Sep 27, 2024

@goplayoutside3 @mcbouslog If you're bumping the web sockets client to 6.6, you'll also need to bump the server to 6.6. See zooniverse/sugar#347.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved This PR is approved for merging dependencies Pull requests that update a dependency file javascript Pull requests that update Javascript code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants