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

deps: Update to streams3 API #288

Merged
merged 5 commits into from
Nov 7, 2023
Merged

deps: Update to streams3 API #288

merged 5 commits into from
Nov 7, 2023

Conversation

legobeat
Copy link
Contributor

@legobeat legobeat commented Oct 26, 2023

Changed

  • BREAKING: Consolidate on streams API v3. All streams are now using and expecting compatibility with readable-stream@3.x.
  • Update extension-port-stream from ^2.1.1 to ^3.0.0
  • Update json-rpc-middleware-stream from ^4.2.3 to ^5.0.1
  • Update @metamask/object-multiplex from ^1.3.0 to ^2.0.0
  • Add direct dependency on readable-stream@^3.6.2

The package is previously mixing usage of readable-stream@2, readable-stream@3 and Node.js native streams (the API and behavior of which differ depending on Node.js version). This consolidates all internal streams on portable readable-stream.

@legobeat legobeat added the dependencies Pull requests that update a dependency file label Oct 26, 2023
@socket-security
Copy link

socket-security bot commented Oct 26, 2023

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

Packages Version New capabilities Transitives Size Publisher
extension-port-stream 2.1.1...3.0.0 None +2/-0 57 kB
json-rpc-middleware-stream 4.2.3...5.0.1 None +2/-6 67 kB gudahtt
@metamask/object-multiplex 1.3.0...2.0.0 None +2/-7 59.7 kB lgbot

🚮 Removed packages: @types/readable-stream@2.3.15

This was referenced Oct 26, 2023
@socket-security
Copy link

socket-security bot commented Oct 27, 2023

👍 Dependency issues cleared. Learn more about Socket for GitHub ↗︎

This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored.

Ignoring: extension-port-stream@3.0.0

Next steps

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 package-name@version specifiers. e.g. @SocketSecurity ignore foo@1.0.0 bar@* or ignore all packages with @SocketSecurity ignore-all

@legobeat legobeat force-pushed the streams-v3 branch 2 times, most recently from d594081 to c5e9dc1 Compare October 27, 2023 04:25
set subdep readable-stream to ^3.6.2 in resolutions
@legobeat
Copy link
Contributor Author

@SocketSecurity ignore extension-port-stream@3.0.0

@legobeat legobeat requested a review from jiexi October 27, 2023 04:34
@legobeat legobeat marked this pull request as ready for review October 27, 2023 04:34
@legobeat legobeat requested a review from a team as a code owner October 27, 2023 04:34
.eslintrc.js Show resolved Hide resolved
@jiexi
Copy link
Contributor

jiexi commented Oct 27, 2023

I mean, the tests pass. We probably want to test this locally in extension and see what happens. I imagine it'll just work though

@legobeat legobeat requested a review from jiexi November 7, 2023 21:49
@jiexi
Copy link
Contributor

jiexi commented Nov 7, 2023

Tested locally. Seems to work fine

@legobeat legobeat merged commit 024925d into MetaMask:main Nov 7, 2023
16 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants