feat: Migrate controller guidelines and examples to new Messenger #6335
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Gudahtt
force-pushed
the
messenger-migrate-controller-docs
branch
2 times, most recently
from
815bf50 to
39756ca
Compare
Gudahtt
force-pushed
the
messenger-migrate-base-controller
branch
2 times, most recently
from
ae71891 to
67c7853
Compare
Gudahtt
force-pushed
the
messenger-migrate-controller-docs
branch
4 times, most recently
from
0a1a16b to
0bdc3d1
Compare
Gudahtt
force-pushed
the
messenger-migrate-controller-docs
branch
from
0bdc3d1 to
7bbe29c
Compare
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Gudahtt
added a commit
that referenced
this pull request
Aug 20, 2025
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.
4 tasks
Gudahtt
added a commit
that referenced
this pull request
Aug 20, 2025
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.
This comment was marked as resolved.
This comment was marked as resolved.
Gudahtt
added a commit
that referenced
this pull request
Aug 20, 2025
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.
Gudahtt
added a commit
that referenced
this pull request
Aug 21, 2025
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.
Gudahtt
added a commit
that referenced
this pull request
Aug 21, 2025
…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
force-pushed
the
messenger-migrate-controller-docs
branch
2 times, most recently
from
c4836ce to
d669a35
Compare
|
Rebased to resolve conflict (the messenger package publish) |
mcmire
reviewed
Aug 21, 2025
packages/sample-controllers/src/sample-gas-prices-controller.test.ts
Outdated
Show resolved
Hide resolved
4 tasks
mcmire
reviewed
Aug 22, 2025
Gudahtt
force-pushed
the
messenger-migrate-controller-docs
branch
2 times, most recently
from
0f4215d to
5d451a9
Compare
Gudahtt
force-pushed
the
messenger-migrate-controller-docs
branch
from
e8652f9 to
e59a0bb
Compare
mcmire
previously approved these changes
Aug 28, 2025
| type RootMessenger = Messenger< | ||
| ExtractAvailableAction<SampleGasPricesControllerMessenger>, | ||
| ExtractAvailableEvent<SampleGasPricesControllerMessenger> | ||
| // Use `string` rather than 'Root' here to allow registering actions and publishing events from |
There was a problem hiding this comment.
Oh that's a good idea, I hadn't thought of that.
There was a problem hiding this comment.
It would have been a good idea if it worked 😅 I forgot there are runtime checks for this, tests are failing. Looking into it now.
4 tasks
Gudahtt
added a commit
that referenced
this pull request
Sep 2, 2025
## Explanation Fix mistakes and improve consistency and formatting in comment examples in the `@metamask/sample-controllers` package. ## References Extracted from #6335 ## 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
force-pushed
the
messenger-migrate-controller-docs
branch
2 times, most recently
from
ed42ac9 to
f2bb7e9
Compare
Gudahtt
force-pushed
the
messenger-migrate-controller-docs
branch
from
f2bb7e9 to
0f31c4e
Compare
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`.
Co-authored-by: Elliot Winkler <[email protected]>
Gudahtt
force-pushed
the
messenger-migrate-controller-docs
branch
from
0f31c4e to
013b836
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Explanation
Migrate the controller guidelines and the
sample-controllerspackage to thenextexport of the@metamask/base-controllerpackage and the newMessengerclass from@metamask/messenger.References
Relates to #5626
Checklist
Note
Migrates controller guidelines and sample controllers to the new
@metamask/messengerMessengerand@metamask/base-controller/next, updating APIs, tests, and docs, and adding the messenger dependency.docs/controller-guidelines.mdanddocs/data-services.mdto useMessenger(namespace/parent,delegate,subscribe/publish) instead ofRestrictedMessengerand "messaging system".*Actionsand*Eventsdirectly toMessenger; clarify external unions and non-export rules.messagingSystemwithmessengerAPI; addincludeInDebugSnapshotmetadata key.SampleGasPricesControllerandSamplePetnamesControllerto@metamask/base-controller/nextandMessenger; replaceRestrictedMessengertypes andmessagingSystem.*calls withmessenger.*.SampleGasPricesService) and tests to newMessenger(MockAnyNamespace,MessengerActions/MessengerEvents) and root/child messenger delegation.@metamask/messengerdependency and TS project references; updateyarn.lock.Messenger.Written by Cursor Bugbot for commit 013b836. This will update automatically on new commits. Configure here.