Update dependency socket.io to v3 - autoclosed #4

mend-for-github-com · 2022-07-05T14:25:40Z

This PR contains the following updates:

Package	Type	Update	Change
socket.io	dependencies	major	`^1.4.8` -> `^3.0.0`

By merging this PR, the below vulnerabilities will be automatically resolved:

Severity	CVSS Score	CVE
High	8.1	WS-2020-0443
High	7.5	CVE-2020-36048
High	7.5	CVE-2020-36049
Medium	5.3	CVE-2017-16137
Medium	5.3	CVE-2017-16137
Medium	4.3	CVE-2020-28481

Release Notes

socketio/socket.io

`v3.0.0`

Compare Source

Bug Fixes

close clients with no namespace (91cd255)

Features

emit an Error object upon middleware error (54bf4a4)
serve msgpack bundle (aa7574f)
add support for catch-all listeners (5c73733)
make Socket#join() and Socket#leave() synchronous (129c641)
remove prod dependency to socket.io-client (7603da7)
move binary detection back to the parser (669592d)
add ES6 module export (8b6b100)
do not reuse the Engine.IO id (2875d2c)
remove Server#set() method (029f478)
remove Socket#rooms object (1507b41)
remove the 'origins' option (a8c0600)
remove the implicit connection to the default namespace (3289f7e)
throw upon reserved event names (4bd5b23)

BREAKING CHANGES

the Socket#use() method is removed (see 5c73733)
Socket#join() and Socket#leave() do not accept a callback argument anymore.

Before:

socket.join("room1", () => {
 io.to("room1").emit("hello");
});

After:

socket.join("room1");
io.to("room1").emit("hello");
// or await socket.join("room1"); for custom adapters

the "connected" map is renamed to "sockets"
the Socket#binary() method is removed, as this use case is now covered by the ability to provide your own parser.
the 'origins' option is removed

Before:

new Server(3000, {
  origins: ["https://example.com"]
});

The 'origins' option was used in the allowRequest method, in order to
determine whether the request should pass or not. And the Engine.IO
server would implicitly add the necessary Access-Control-Allow-xxx
headers.

After:

new Server(3000, {
  cors: {
    origin: "https://example.com",
    methods: ["GET", "POST"],
    allowedHeaders: ["content-type"]
  }
});

The already existing 'allowRequest' option can be used for validation:

new Server(3000, {
  allowRequest: (req, callback) => {
    callback(null, req.headers.referer.startsWith("https://example.com"));
  }
});

Socket#rooms is now a Set instead of an object
Namespace#connected is now a Map instead of an object
there is no more implicit connection to the default namespace:

// client-side
const socket = io("/admin");

// server-side
io.on("connect", socket => {
  // not triggered anymore
})

io.use((socket, next) => {
  // not triggered anymore
});

io.of("/admin").use((socket, next) => {
  // triggered
});

the Server#set() method was removed

This method was kept for backward-compatibility with pre-1.0 versions.

`v2.5.0`

Compare Source

Bug Fixes

fix race condition in dynamic namespaces (05e1278)
ignore packet received after disconnection (22d4bdf)
only set 'connected' to true after middleware execution (226cc16)
prevent the socket from joining a room after disconnection (f223178)

4.5.1 (2022-05-17)

Bug Fixes

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

`v2.4.1`

Compare Source

Reverts

fix(security): do not allow all origins by default (a169050)

`v2.4.0`

Compare Source

Bug Fixes

security: do not allow all origins by default (f78a575)
properly overwrite the query sent in the handshake (d33a619)

3.0.4 (2020-12-07)

3.0.3 (2020-11-19)

3.0.2 (2020-11-17)

Bug Fixes

merge Engine.IO options (43705d7)

3.0.1 (2020-11-09)

Bug Fixes

export ServerOptions and Namespace types (#3684) (f62f180)
typings: update the signature of the emit method (50671d9)

`v2.3.0`

Compare Source

This release mainly contains a bump of the engine.io and ws packages, but no additional features.

`v2.2.0`

Compare Source

Features

add cache-control header when serving the client source (#2907) (b00ae50)

Bug fixes

throw an error when trying to access the clients of a dynamic namespace (#3355) (a7fbd1a)

`v2.1.1`

Compare Source

Features

add local flag to the socket object (#3129) (1decae3)

socket.local.to('room101').emit(/* */);

`v2.1.0`

Compare Source

Features

add a 'binary' flag (#3185) (f48a06c)

// by default, the object is recursively scanned to check whether it contains some binary data
// in the following example, the check is skipped in order to improve performance
socket.binary(false).emit('plain-object', object);

// it also works at the namespace level
io.binary(false).emit('plain-object', object);

add support for dynamic namespaces (#3195) (c0c79f0)

io.of(/^\/dynamic-\d+$/).on('connect', (socket) => {
  // socket.nsp.name = '/dynamic-101'
});

// client-side
const client = require('socket.io-client')('/dynamic-101');

Bug fixes

properly emit 'connect' when using a custom namespace (#3197) (f4fc517)
include the protocol in the origins check (#3198) (1f1d64b)

Important note ⚠️ from Engine.IO 3.2.0 release

There are two non-breaking changes that are somehow quite important:

ws was reverted as the default wsEngine ([chore] Revert to ws as default wsEngine socketio/engine.io#550), as there was several blocking issues with uws. You can still use uws by running npm install uws --save in your project and using the wsEngine option:

var engine = require('engine.io');
var server = engine.listen(3000, {
  wsEngine: 'uws'
});

pingTimeout now defaults to 5 seconds (instead of 60 seconds): [chore] Update default value of pingTimeout socketio/engine.io#551

`v2.0.4`

Compare Source

Bug fixes

do not throw when receiving an unhandled error packet (#3038)
reset rooms object before broadcasting from namespace (#3039)

Links:

Milestone: 2.0.4
Diff: 2.0.3...2.0.4
Client release: 2.0.4
Diff engine.io: -
Diff ws: -

`v2.0.3`

Compare Source

Bug fixes

reset rooms object before broadcasting (#2970)
fix middleware initialization (#2969)

Links:

Milestone: 2.0.3
Diff: 2.0.2...2.0.3
Client release: 2.0.3
Diff engine.io: -
Diff ws: -

`v2.0.2`

Compare Source

Bug fixes

fix timing issues with middleware (#2948)

Links:

Milestone: 2.0.2
Diff: 2.0.1...2.0.2
Client release: 2.0.2
Diff engine.io: -
Diff ws: -

`v2.0.1`

Compare Source

Bug fixes

- update path of client file (#2934)

Links:

Milestone: 2.0.1
Diff: 2.0.0...2.0.1
Client release: 2.0.1
Diff engine.io: -
Diff ws: -

`v2.0.0`

Compare Source

This major release brings several performance improvements:

uws is now the default Websocket engine. It should bring significant improvement in performance (particularly in terms of memory consumption) (https://github.com/socketio/engine.io/releases/tag/2.0.0)
the Engine.IO and Socket.IO handshake packets were merged, reducing the number of roundtrips necessary to establish a connection. (#2833)
it is now possible to provide a custom parser according to the needs of your application (#2829). Please take a look at the example for more information.

Please note that this release is not backward-compatible, due to:

a breaking change related to utf-8 encoding in engine.io-parser (Fix double utf8 encoding for payloads socketio/engine.io-parser#81)
an update to make the socket id on the client match the id on the server-side (Add nsp prefix to socket.id socketio/socket.io-client#1058)

Please also note that if you are using a self-signed certificate, rejectUnauthorized now defaults to true (socketio/engine.io-client#558).

Finally, the API documentation is now in the repository (here), and the content of the website here. Do not hesitate if you see something wrong or missing!

The full list of changes:

[feat] Move binary detection to the parser (#2923)
[feat] Allow to join several rooms at once (#2879)
[feat] Merge Engine.IO and Socket.IO handshake packets (#2833)
[feat] Allow the use of custom parsers (#2829)
[fix] Use path.resolve by default and require.resolve as a fallback (#2797) (by @a-lucas)
[fix] Properly close the connection on error (#2681) (by @Nibbler999)
[fix] Prevent null from being accepted as argument (#2606) (by @ianbrode)
[perf] Use shared instance of the encoder (#2825) (by @Nibbler999)
[perf] Reset properties instead of deleting them (#2826) (by @Nibbler999)
[perf] micro-optimisations (#2793) (by @billouboq)
[chore] Merge history of 1.7.x and 0.9.x branches (#2930)
[chore] Added backers and sponsors on the README (#2933) (by @xdamman)
[chore] Bump dependencies (#2926)
[chore] Bump socket.io-adapter to version 1.0.0 (#2867)
[chore] Bump engine.io to version 2.0.2 (#2864)
[chore] Bump engine.io to version 2.0.0 (#2832) (by @sgress454)
[chore] Update issue template with fiddle (#2811)
[docs] Add an example of custom parser (#2929)
[docs] Replace non-breaking space with proper whitespace (#2913) (by @epicTCK)
[docs] Update emit cheatsheet (#2906) (by @FarazPatankar)
[docs] Explicitly document that Server extends EventEmitter (#2874) (by @i8-pi)
[docs] Add server.engine.generateId attribute (#2880) (by @efkan)
[docs] Fix wrong space character in README (#2900) (by @SimenB)
[docs] Fix documentation for 'connect' event (#2898) (by @swhgoon)
[docs] Add webpack build example (#2828)
[docs] Update the wording to match the code example (#2853) (by @timruffles)
[docs] Small addition to the Express Readme Part (#2846) (by @H3rby7)
[docs] Add a 'Features' section in the README (#2824)
[docs] Add httpd cluster example (#2819)
[docs] Add haproxy cluster example (#2818)
[docs] Add nginx cluster example (#2817)
[docs] Implement whiteboard example (#2810)
[docs] Fix documentation for local flag (#2816)
[docs] Add emit cheatsheet (#2815)
[docs] Add pingInterval/pingTimeout/transports options in the API documentation (#2814)
[docs] Add an example for socket.join() method (#2813)
[docs] Fix a typo on clients method in the API documentation (#2812)
[docs] Fix wrong argument name in API.md (#2802) (by @andrea11)
[docs] Add install script on Readme.md (#2780) (by @bananaappletw)
[docs] API documentation (#2784)

Besides, we are proud to announce that Socket.IO is now a part of open collective: https://opencollective.com/socketio. More on that later.

`v1.7.4`

Compare Source

[chore] Bump engine.io to version 1.8.4

`v1.7.3`

Compare Source

[chore] Bump engine.io-client to version 1.8.3

`v1.7.2`

Compare Source

[chore] Bump engine.io to version 1.8.2 (#2782)
[fix] Fixes socket.use error packet (#2772)

`v1.7.1`

Compare Source

(following socket.io-client update)

`v1.7.0`

Compare Source

[docs] Comment connected socket availability for adapters (#2081)
[docs] Fixed grammar issues in the README.md (#2159)
[feature] serve sourcemap for socket.io-client (#2482)
[feature] Add a local flag (#2628)
[chore] Bump engine.io to version 1.8.1 (#2765)
[chore] Update client location and serve minified file (#2766)

`v1.6.0`

Compare Source

[fix] Make ETag header comply with standard. (#2603)
[feature] Loading client script on demand. (#2567)
[test] Fix leaking clientSocket (#2721)
[feature] Add support for all event emitter methods (#2601)
[chore] Update year to 2016 (#2456)
[feature] Add support for socket middleware (#2306)
[feature] add support for Server#close(callback) (#2748)
[fix] Don't drop query variables on handshake (#2745)
[example] Add disconnection/reconnection logs to the chat example (#2675)
[perf] Minor code optimizations (#2219)
[chore] Bump debug to version 2.3.3 (#2754)
[chore] Bump engine.io to version 1.8.0 (#2755)
[chore] Bump socket.io-adapter to version 0.5.0 (#2756)

`v1.5.1`

Compare Source

[fix] Avoid swallowing exceptions thrown by user event handlers (#2682)
[test] Use client function to unify client in test script (#2731)
[docs] Add link to LICENSE (#2221)
[docs] Fix JSDoc of optional parameters (#2465)
[docs] Fix typo (#2724)
[docs] Link readme npm package badge to npm registry page (#2612)
[docs] Minor fixes (#2526)
[chore] Bump socket.io-parser to 2.3.0 (#2730)
[chore] Add Github issue and PR templates (#2733)
[chore] Bump engine.io to 1.7.2 (#2729)
[chore] Bump socket.io-parser to 2.3.1 (#2734)

`v1.5.0`

Compare Source

[feature] stop append /# before id when no namespace (#2509)
[feature] Add a 'disconnecting' event to access to socket.rooms upon disconnection (#2332)
[fix] Fix query string management (#2422)
[fix] add quote to exec paths, prevent error when spaces in path (#2508)
[docs] Prevent mixup for new programmers (#2599)
[example] Fix chat display in Firefox (#2477)
[chore] Add gulp & babel in the build process (#2471)
[chore] Bump engine.io to 1.7.0 (#2707)
[chore] Remove unused zuul-ngrok dependency (#2708)
[chore] Point towards current master of socket.io-client (#2710)
[chore] Restrict files included in npm package (#2709)
[chore] Link build badge to master branch (#2549)

If you want to rebase/retry this PR, click this checkbox.

Update dependency socket.io to v3

c9beb6a

mend-for-github-com bot added the security fix Security fix generated by Mend label Jul 5, 2022

mend-for-github-com bot changed the title ~~Update dependency socket.io to v3~~ Update dependency socket.io to v3 - autoclosed Nov 20, 2022

mend-for-github-com bot closed this Nov 20, 2022

mend-for-github-com bot deleted the whitesource-remediate/socket.io-3.x branch November 20, 2022 20:37

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update dependency socket.io to v3 - autoclosed #4

Update dependency socket.io to v3 - autoclosed #4

mend-for-github-com bot commented Jul 5, 2022 •

edited

Loading

Update dependency socket.io to v3 - autoclosed #4

Update dependency socket.io to v3 - autoclosed #4

Conversation

mend-for-github-com bot commented Jul 5, 2022 • edited Loading

Release Notes

Bug Fixes

Features

BREAKING CHANGES

Bug Fixes

4.5.1 (2022-05-17)

Bug Fixes

Reverts

Bug Fixes

3.0.4 (2020-12-07)

3.0.3 (2020-11-19)

3.0.2 (2020-11-17)

Bug Fixes

3.0.1 (2020-11-09)

Bug Fixes

Features

Bug fixes

Features

Features

Bug fixes

Important note ⚠️ from Engine.IO 3.2.0 release

Bug fixes

Links:

Bug fixes

Links:

Bug fixes

Links:

Bug fixes

Links:

mend-for-github-com bot commented Jul 5, 2022 •

edited

Loading