feat: added preClose hook to disconnect sockets

giovanni-bertoncelli commented 9 months ago

In this PR:

BugFix: This PR resolves the fastify server hanging when websockets clients are still connected, as referenced in #88.
Breaking: since io.disconnectSockets exists only on that version, the plugin now support peerDependency socket.io@>=4.x. This can be discussed, if too strict.
Adds a new options preClose to customize preClose hook of plugin

Issues reference:

Checklist:

[X] Have you checked to ensure there aren't other open Pull Requests for the same update/change?
[X] Have you lint your code with pnpm lint locally prior to submission?
[X] Have you added an explanation of what your changes do and why you'd like us to include them?
[X] Have you written new tests for your core changes, as applicable?
[X] Have you successfully ran build with pnpm build of your changes locally?
[X] Have you successfully ran tests with pnpm test of your changes locally?
[X] Have you commit using Conventional Commits?

socket-security[bot] commented 9 months ago

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/socket.io-client@4.7.4	Transitive: environment, filesystem, network, shell	`+8`	2.37 MB	darrachequesne
npm/socket.io@4.7.4	filesystem, network Transitive: environment	`+19`	2.15 MB	darrachequesne

🚮 Removed packages: npm/socket.io@4.7.1

View full report↗︎

socket-security[bot] commented 9 months ago

🚨 Potential security issues detected. Learn more about Socket for GitHub ↗︎

To accept the risk, merge this PR and you will not be notified again.

Alert	Package	Note	Source	CI
Filesystem access	npm/xmlhttprequest-ssl@2.0.0	Module: fs Location: Package overview	`package.json` `pnpm-lock.yaml`	🚫
Shell access	npm/xmlhttprequest-ssl@2.0.0	Module: child_process Location: Package overview	`package.json` `pnpm-lock.yaml`	🚫
Network access	npm/xmlhttprequest-ssl@2.0.0	Module: http Location: Package overview	`package.json` `pnpm-lock.yaml`	🚫
Network access	npm/xmlhttprequest-ssl@2.0.0	Module: https Location: Package overview	`package.json` `pnpm-lock.yaml`	🚫

View full report↗︎

Next steps

What is filesystem access?

Accesses the file system, and could potentially read sensitive data.

If a package must read the file system, clarify what it will read and ensure it reads only what it claims to. If appropriate, packages can leave file system access to consumers and operate on data passed to it instead.

What is shell access?

This module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.

Packages should avoid accessing the shell which can reduce portability, and make it easier for malicious shell access to be introduced.

What is network access?

This module accesses the network.

Packages should remove all network access that is functionally unnecessary. Consumers should audit network access to ensure legitimate use.

Take a deeper look at the dependency

Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support [AT] socket [DOT] dev.

Remove the package

If you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency.

Mark a package as acceptable risk

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of ecosystem/package-name@version specifiers. e.g. @SocketSecurity ignore npm/foo@1.0.0 or ignore all packages with @SocketSecurity ignore-all

@SocketSecurity ignore npm/xmlhttprequest-ssl@2.0.0

giovanni-bertoncelli commented 8 months ago

Hi @alemagio, I haven't hear anything from you by 1 month.. We have production software that need this fix.. Would you please share your thoughts on this PR? Thank you

ducktors / fastify-socket.io