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

chore: Update @metamask/controller-utils to v3.4 #6884

Merged
merged 1 commit into from
Jul 25, 2023

Conversation

Gudahtt
Copy link
Member

@Gudahtt Gudahtt commented Jul 24, 2023

Development & PR Process

  1. Follow MetaMask Mobile Coding Standards
  2. Add release-xx label to identify the PR slated for a upcoming release (will be used in release discussion)
  3. Add needs-dev-review label when work is completed
  4. Add needs-qa label when dev review is completed
  5. Add QA Passed label when QA has signed off

Description

The @metamask/controller-utils package has been updated to v3.4. This package had previously been held back because v3.1.0 introduced a usage of the BigInt API, which was a compatibility issue. But that should no longer be a problem now that React Native has been upgraded.

There were no breaking changes in this range of updates, but there were a few additions and rearrangements that required substantial patch updates.

Issue

This change was done to simplify PR #6872, which is part of https://github.com/MetaMask/mobile-planning/issues/798

Checklist

  • There is a related GitHub issue
  • Tests are included if applicable
  • Any added code is fully documented

@Gudahtt Gudahtt changed the title Update @metamask/controller-utils to v3.4 chore: Update @metamask/controller-utils to v3.4 Jul 24, 2023
@socket-security
Copy link

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

Packages Version New capabilities Transitives Size Publisher
@metamask/controller-utils 3.0.0...3.4.0 None +5/-1 4.2 MB metamaskbot

@socket-security
Copy link

socket-security bot commented Jul 24, 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: @spruceid/siwe-parser@1.1.3, apg-js@4.1.3

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

@Gudahtt
Copy link
Member Author

Gudahtt commented Jul 24, 2023

@SocketSecurity ignore @spruceid/siwe-parser@1.1.3
@SocketSecurity ignore apg-js@4.1.3

The parser package has been evaluated by us already, and the lack of a README in general isn't a big concern for us.

The flagged module in apg-js appears to be a development script included in the published package by mistake.

@Gudahtt Gudahtt added No QA Needed Apply this label when your PR does not need any QA effort. needs-dev-review PR needs reviews from other engineers (in order to receive required approvals) labels Jul 25, 2023
@Gudahtt Gudahtt marked this pull request as ready for review July 25, 2023 03:28
@Gudahtt Gudahtt requested a review from a team as a code owner July 25, 2023 03:28
@Gudahtt
Copy link
Member Author

Gudahtt commented Jul 25, 2023

The `@metamask/controller-utils` package has been updated to v3.4. This
package had previously been held back because v3.1.0 introduced a usage
of the BigInt API, which was a compatibility issue. But that should no
longer be a problem now that React Native has been upgraded.

There were no breaking changes in this range of updates, but there were
a few additions and rearrangements that required substantial patch
updates.

This change was done to simplify PR #6872, which is part of
MetaMask/mobile-planning#798
@Gudahtt
Copy link
Member Author

Gudahtt commented Jul 25, 2023

For reference, here is the source for v3.4.0: https://github.com/MetaMask/core/blob/%40metamask/controller-utils%403.4.0/packages/controller-utils/src/constants.ts
You can see the intended structure there.

The networks Linea Goerli and Linea Mainnet weren't added until a later version, here: MetaMask/core#1423

Copy link
Member

@leotm leotm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm!

@sonarcloud
Copy link

sonarcloud bot commented Jul 25, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@Gudahtt Gudahtt merged commit 32ea4dd into main Jul 25, 2023
@Gudahtt Gudahtt deleted the update-controller-utils branch July 25, 2023 14:45
@github-actions github-actions bot removed the needs-dev-review PR needs reviews from other engineers (in order to receive required approvals) label Jul 25, 2023
@github-actions github-actions bot locked and limited conversation to collaborators Jul 25, 2023
@metamaskbot metamaskbot added the release-7.5.0 Issue or pull request that will be included in release 7.5.0 label Jul 25, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
No QA Needed Apply this label when your PR does not need any QA effort. release-7.5.0 Issue or pull request that will be included in release 7.5.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants