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(deps): Bump @metamask/composable-controller from ^3.0.0 to ^10.0.0 #10441

Merged
merged 101 commits into from
Dec 9, 2024

Conversation

MajorLift
Copy link
Contributor

@MajorLift MajorLift commented Jul 26, 2024

Description

This commit updates @metamask/composable-controller to ^10.0.0.

This involves fixing bugs outlined in #10073, and applying the major changes to the ComposableController API that has accumulated between the intervening versions.

Blocked by

Changelog

Changed

  • BREAKING: Bump @metamask/composable-controller from ^3.0.0 to ^10.0.0.
  • BREAKING: Instantiate ComposableController class constructor option messenger with a RestrictedControllerMessenger instance derived from the controllerMessenger class field instance of Engine, instead of passing in the unrestricted controllerMessenger instance directly.
    • BREAKING: Narrow external actions allowlist for messenger instance passed into ComposableController constructor from GlobalActions['type'] to an empty union.
    • BREAKING: Narrow external events allowlist for messenger instance passed into ComposableController constructor from GlobalEvents['type'] to a union of the stateChange events of all controllers included in the EngineState type.
  • Convert the EngineState interface to use type alias syntax to ensure compatibility with types used in MetaMask controllers.

Fixed

  • BREAKING: Narrow Engine class datamodel field from any to ComposableController<EngineState, StatefulControllers>.
  • BREAKING: The CurrencyRatesController constructor now normalizes null into 0 for the conversionRate values of all native currencies keyed in the currencyRates object of CurrencyRatesControllerState.
  • Restore previously suppressed type-level validation for ComposableController constructor option controllers.

Related issues

Manual testing steps

Screenshots/Recordings

Pre-merge author checklist

Pre-merge reviewer checklist

  • I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed).
  • I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

Copy link
Contributor

CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes.

@MajorLift MajorLift linked an issue Jul 26, 2024 that may be closed by this pull request
9 tasks
Copy link

socket-security bot commented Jul 26, 2024

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

Package New capabilities Transitives Size Publisher
npm/@metamask/[email protected] None 0 70.3 kB metamaskbot

🚮 Removed packages: npm/@metamask/[email protected]

View full report↗︎

@MajorLift MajorLift force-pushed the jongsun/fix-composable-controller branch 6 times, most recently from 815f836 to 992908f Compare July 31, 2024 23:18
@MajorLift MajorLift added the No QA Needed Apply this label when your PR does not need any QA effort. label Jul 31, 2024
@MajorLift MajorLift force-pushed the jongsun/fix-composable-controller branch 3 times, most recently from 6209b1f to a519205 Compare August 1, 2024 01:07
@MajorLift MajorLift added the DO-NOT-MERGE Pull requests that should not be merged label Aug 1, 2024
@MajorLift MajorLift requested a review from a team August 1, 2024 04:22
Copy link
Contributor Author

@MajorLift MajorLift left a comment

Choose a reason for hiding this comment

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

Notes for reviewers:

@MajorLift MajorLift marked this pull request as ready for review August 1, 2024 05:03
@MajorLift MajorLift requested review from a team as code owners August 1, 2024 05:03
@MajorLift MajorLift force-pushed the jongsun/fix-composable-controller branch 2 times, most recently from f501427 to 2c0475a Compare August 1, 2024 18:28
@MajorLift MajorLift removed the DO-NOT-MERGE Pull requests that should not be merged label Aug 1, 2024
@MajorLift MajorLift marked this pull request as draft August 1, 2024 18:57
@MajorLift MajorLift force-pushed the jongsun/fix-composable-controller branch 2 times, most recently from 8e8fc98 to 2a010d3 Compare August 1, 2024 19:51
@MajorLift MajorLift marked this pull request as ready for review August 1, 2024 20:11
@MajorLift MajorLift force-pushed the jongsun/fix-composable-controller branch from 908c281 to 73a608b Compare August 1, 2024 22:15
@MajorLift MajorLift changed the title chore(deps): Bump @metamask/composable-controller from ^3.0.0 to ^9.1.0 chore(deps): Bump @metamask/composable-controller from ^3.0.0 to ^10.0.0 Dec 5, 2024
@MajorLift MajorLift dismissed stale reviews from cryptodev-2s and mcmire via 9610b54 December 5, 2024 12:57
@MajorLift MajorLift added Run Smoke E2E Triggers smoke e2e on Bitrise and removed DO-NOT-MERGE Pull requests that should not be merged Run Smoke E2E Triggers smoke e2e on Bitrise labels Dec 5, 2024

This comment was marked as outdated.

@metamaskbot
Copy link
Collaborator

https://bitrise.io/ Bitrise

✅✅✅ pr_smoke_e2e_pipeline passed on Bitrise! ✅✅✅

Commit hash: 9610b54
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/e1b02249-1d25-44b5-ba99-968733b8b609

Note

  • You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

@MajorLift MajorLift added Run Smoke E2E Triggers smoke e2e on Bitrise and removed Run Smoke E2E Triggers smoke e2e on Bitrise labels Dec 5, 2024

This comment was marked as duplicate.

@metamaskbot
Copy link
Collaborator

https://bitrise.io/ Bitrise

✅✅✅ pr_smoke_e2e_pipeline passed on Bitrise! ✅✅✅

Commit hash: 9610b54
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/051b6e1b-13b9-4c05-ab2c-57ccffc9b5c3

Note

  • You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

@MajorLift MajorLift added the team-mobile-platform Mobile Platform team label Dec 5, 2024
mcmire
mcmire previously approved these changes Dec 5, 2024
Cal-L
Cal-L previously approved these changes Dec 6, 2024
Copy link
Contributor

@Cal-L Cal-L left a comment

Choose a reason for hiding this comment

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

Looks good for platform

@MajorLift MajorLift dismissed stale reviews from Cal-L and mcmire via 0519182 December 7, 2024 07:47
@MajorLift MajorLift enabled auto-merge December 8, 2024 11:25
Copy link
Contributor

@Cal-L Cal-L left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@christopherferreira9 christopherferreira9 left a comment

Choose a reason for hiding this comment

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

Looks good for SDK, will validate in the next RC

@MajorLift MajorLift added this pull request to the merge queue Dec 9, 2024
Merged via the queue into main with commit 2adeecd Dec 9, 2024
36 checks passed
@MajorLift MajorLift deleted the jongsun/fix-composable-controller branch December 9, 2024 17:33
@github-actions github-actions bot locked and limited conversation to collaborators Dec 9, 2024
@metamaskbot metamaskbot added the release-7.38.0 Issue or pull request that will be included in release 7.38.0 label Dec 9, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
release-7.38.0 Issue or pull request that will be included in release 7.38.0 Run Smoke E2E Triggers smoke e2e on Bitrise team-mobile-platform Mobile Platform team team-tiger Tiger team (for tech debt reduction + performance improvements) team-wallet-framework
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

fix: ComposableController instantiation and functionality is broken
8 participants