feat: Migrate controller guidelines and examples to new Messenger by Gudahtt · Pull Request #6335 · MetaMask/core

Gudahtt · 2025-08-19T17:50:55Z

Explanation

Migrate the controller guidelines and the sample-controllers package to the next export of the @metamask/base-controller package and the new Messenger class from @metamask/messenger.

References

Relates to #5626

Checklist

I've updated the test suite for new or updated code as appropriate
I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
I've communicated my changes to consumers by updating changelogs for packages I've changed, highlighting breaking changes as necessary
I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes

Note

Migrate controller docs and sample-controllers to the new @metamask/messenger Messenger and @metamask/base-controller/next, updating APIs, metadata, tests, and dependencies.

Docs
- Rewrite guidelines and data-services to use @metamask/messengerMessenger instead of RestrictedMessenger; update examples for actions/events typing, root/child messenger setup, delegation, and selector utilities (MessengerActions/MessengerEvents).
- Replace references to “messaging system” with “messenger”; update code samples to messenger.call/subscribe/publish/registerMethodActionHandlers.
Sample Controllers (@metamask/sample-controllers)
- Migrate to @metamask/base-controller/next and @metamask/messenger.
- Replace messagingSystem.* with messenger.*; update controller/service messenger types to Messenger<...> and constructor usage.
- Update state metadata (anonymous → includeInDebugSnapshot).
- Revise tests to use new Messenger, mock namespace utilities, and MessengerActions/MessengerEvents.
- Add dependency on @metamask/messenger; update TS project references.
- Changelog: mark BREAKING changes for Messenger migration and metadata rename.
Repo/README
- Dependency graph: add sample_controllers --> messenger; add middleware/controller edge; list @metamask/messenger package.

^{Written by Cursor Bugbot for commit c1ad7a4. This will update automatically on new commits. Configure here.}

Tests that used the `@metamask/base-controller/next` export were not working correctly until after a build was completed. They were using the built code rather than the source code. On CI the tests run without any build, so they would always fail. This was resolved up updating the TSConfig and Jest config to map the `next` export to the correct source code. This unblocks #6335 as well as other controller migrations to the upcoming BaseController version.

…6349) ## Explanation Tests that used the `@metamask/base-controller/next` export were not working correctly until after a build was completed. They were using the built code rather than the source code. On CI the tests run without any build, so they would always fail. This was resolved up updating the TSConfig and Jest config to map the `next` export to the correct source code. This unblocks #6335 as well as other controller migrations to the upcoming BaseController version. ## References Relates to #5626 ## Checklist - [x] I've updated the test suite for new or updated code as appropriate - [x] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate - [x] I've communicated my changes to consumers by [updating changelogs for packages I've changed](https://github.com/MetaMask/core/tree/main/docs/contributing.md#updating-changelogs), highlighting breaking changes as necessary - [x] I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes

Gudahtt · 2025-08-21T16:43:37Z

Rebased to resolve conflict (the messenger package publish)

mcmire

Had some minor comments, but overall these changes make sense.

Co-authored-by: Elliot Winkler <elliot.winkler@gmail.com>

socket-security · 2025-10-21T21:00:12Z

No dependency changes detected. Learn more about Socket for GitHub.

👍 No dependency changes detected in pull request

mcmire

LGTM!

cryptodev-2s

LGTM!

mikesposito · 2025-10-23T08:47:43Z

nit: we should run yarn update-readme-content to refresh the README dependency graph

Gudahtt added the DO-NOT-MERGE label Aug 19, 2025

Gudahtt force-pushed the messenger-migrate-controller-docs branch 2 times, most recently from 815bf50 to 39756caCompare August 19, 2025 18:05

Gudahtt force-pushed the messenger-migrate-base-controller branch 2 times, most recently from ae71891 to 67c7853Compare August 20, 2025 14:04

Base automatically changed from messenger-migrate-base-controller to mainAugust 20, 2025 14:10

Gudahtt force-pushed the messenger-migrate-controller-docs branch 4 times, most recently from 0a1a16b to 0bdc3d1Compare August 20, 2025 15:58

Gudahtt marked this pull request as ready for review August 20, 2025 15:58

Gudahtt requested a review from a team as a code owner August 20, 2025 15:58

Gudahtt force-pushed the messenger-migrate-controller-docs branch from 0bdc3d1 to 7bbe29cCompare August 20, 2025 17:25

This comment was marked as outdated.
Sign in to view

Gudahtt mentioned this pull request Aug 20, 2025
chore: Update Jest config to map next export to source correctly #6349
Merged
4 tasks

This comment was marked as resolved.
Sign in to view

Gudahtt force-pushed the messenger-migrate-controller-docs branch 2 times, most recently from c4836ce to d669a35Compare August 21, 2025 16:43

Gudahtt mentioned this pull request Jul 17, 2025
Implement messenger delegation #5626
Closed
43 tasks

mcmire reviewed Aug 21, 2025
View reviewed changes

mcmire mentioned this pull request Aug 21, 2025
Improve sample-controllers to be more useful examples #6168
Merged
4 tasks

mcmire reviewed Aug 22, 2025
View reviewed changes

Comment threadpackages/sample-controllers/src/sample-gas-prices-controller.ts
Comment threadpackages/sample-controllers/src/sample-petnames-controller.ts

Gudahtt force-pushed the messenger-migrate-controller-docs branch 2 times, most recently from 0f4215d to 5d451a9Compare August 28, 2025 16:50

Gudahttand others added 13 commits October 21, 2025 18:27

Update docs and sample-controllers to handle messagingSystem rename
bcd4e74

Update data services docs
2723744

Avoid using the term messaging system
1692a73

Expand on data service delegation example
7215dd0

Fix typo
f784d48
Co-authored-by: Elliot Winkler <elliot.winkler@gmail.com>

Remove 'as const' that doesn't seem necessary
53f2c02

Improve example title by dropping reference to type parameter order
0e497c2

Fix mistake in type parameter number
22a761e

Improve example title consistency
2ddbd1a

Use new mock namespace bypass
7ebddfd

Delegate actions/events to test gas prices controller messenger
692060d

Fix lint errors
2e2705b

Update controller metadata docs with new properties`
80d7730

Gudahtt force-pushed the messenger-migrate-controller-docs branch from efa167b to 80d7730Compare October 21, 2025 20:57

Dedupe dependencies
d4bea7d

mcmire previously approved these changes Oct 21, 2025
View reviewed changes

cryptodev-2s previously approved these changes Oct 21, 2025
View reviewed changes

Merge branch 'main' into messenger-migrate-controller-docs
f8360c3

mikesposito dismissed stale reviews from cryptodev-2s and mcmire via f8360c3October 24, 2025 17:43

Fix mistake in docs
c1ad7a4

mikesposito removed the DO-NOT-MERGE label Oct 27, 2025

mikesposito enabled auto-merge October 27, 2025 13:10

cryptodev-2s approved these changes Oct 27, 2025
View reviewed changes

mikesposito added this pull request to the merge queue Oct 27, 2025

Merged via the queue into main with commit a607066Oct 27, 2025
256 of 257 checks passed

mikesposito deleted the messenger-migrate-controller-docs branch October 27, 2025 13:18

Uh oh!

Uh oh!

Conversation

Gudahtt commented Aug 19, 2025• edited by cursor BotLoading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Explanation

References

Checklist

Uh oh!

This comment was marked as outdated.

Uh oh!

This comment was marked as resolved.

Gudahtt commented Aug 21, 2025

Uh oh!

mcmire left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

socket-securityBot commented Oct 21, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mcmire left a comment

Choose a reason for hiding this comment

Uh oh!

cryptodev-2s left a comment

Choose a reason for hiding this comment

Uh oh!

mikesposito commented Oct 23, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Gudahtt commented Aug 19, 2025•
edited by cursor Bot
Loading

socket-securityBot commented Oct 21, 2025•
edited
Loading