Add controller messaging system #377

Gudahtt · 2021-03-05T14:59:44Z

Adds a controller messaging system, which will be used to facilitate inter-controller communication. The controller messenger acts as a message broker, passing actions and events back and forth between controllers. It is fully type safe.

This idea was described in the Controller Messaging System proposal.

This controller messenger doesn't yet support attenuation, so it's not yet possible to restrict which actions and events are interacted with. That will be coming in a later PR.

src/ControllerMessenger.ts

Gudahtt · 2021-03-08T14:42:42Z

src/ControllerMessenger.ts

+  : never;
+export type ExtractEventPayload<Event, T> = Event extends { type: T; payload: infer P } ? P : never;
+
+type ActionConstraint = { type: string; handler: (...args: any) => unknown };


I wasn't able to get rid of this any 🤔 Using unknown or unknown[] seemed to upset TypeScript. What I wanted here was to express that I don't know anything about these parameters, but I don't know how to do that.

Though, maybe it's fine to leave this as-is. There are unit tests for zero parameters, one parameter, and multiple parameters (of various different types). Those should be sufficient for ensuring we're not assuming anything about these parameters in this class.

When i was trying to figure out types I had to do some 'any' to allow it to work, even though I had full type safety in practice. Hard to explain/understand why that was true but I think it's fine as is

Gudahtt · 2021-03-08T14:45:16Z

Attenuation is added in this follow-up PR: #378. It's still a work-in-progress, but that should give some idea what attenuation could look like.

Gudahtt · 2021-03-08T14:53:43Z

I don't yet have tests for ensuring this is type-safe. There is no straightforward way of testing this, as any misuse of types would fail to compile, and JavaScript tests wouldn't test the types at all.

There are some libraries that could help here though. I've opened #379 for investigating this further.

In the meantime I've been testing that this is type-safe by manually editing the unit tests into various type violations, and ensuring I get an error when I run the tests.

src/BaseControllerV2.ts

brad-decker

LGTM, the removal of base controller subscribe/unsubscribe can happen here or in a follow up. Happy to see this taking shape, and can't wait to use it in the extension :)

brad-decker

LGTM!

Gudahtt · 2021-03-08T20:49:09Z

Thanks for the review @brad-decker ! Unfortunately I've just discovered that I forgot to document all of these methods though 🤦. So I'm gonna push one more commit in a few minutes to address that shortcoming.

Gudahtt · 2021-03-09T05:09:49Z

Alright, all methods should now be documented! This is ready for review again.

brad-decker

Docs LGTM

Gudahtt · 2021-03-09T14:31:30Z

It'd be nice to get more feedback on this one before merging since it'll have a large impact upon future controller work, so I've tagged more people for review. No pressure though. I'll leave this open another couple of days, or until it gets another approval or two.

Adds a controller messaging system, which will be used to facilitate inter-controller communication. The controller messenger acts as a message broker, passing actions and events back and forth between controllers. It is _fully type safe_. This idea was described in the Controller Messaging System proposal[1]. This controller messenger doesn't yet support attenuation, so it's not yet possible to restrict which actions and events are interacted with. That will be coming in a later PR. [1]: https://www.notion.so/Controller-Messaging-System-617efb02b9e54bd0a0b0e44c6f776d85

The base controller no longer exposes methods to subscribe and unsubscribe to state changes. Instead all subscriptions and unsubscriptions are done with the controller messaging system.

This event name matches the naming convention of the event prefix, which is also camelCase.

JSDoc comments have been added for each method on the controller messenger instance. Additionally, the `event` parameter has been renamed to `eventType`, and the `action` parameter has been renamed to `actionType`. This was done while adding docs because it made the documentation easier to understand.

These types were only used internally. We can export them again if and when that becomes useful.

brad-decker

Still LGTM.

Adds a controller messaging system, which will be used to facilitate inter-controller communication. The controller messenger acts as a message broker, passing actions and events back and forth between controllers. It is _fully type safe_. This idea was described in the Controller Messaging System proposal[1]. This controller messenger doesn't yet support attenuation, so it's not yet possible to restrict which actions and events are interacted with. That will be coming in a later PR. [1]: https://www.notion.so/Controller-Messaging-System-617efb02b9e54bd0a0b0e44c6f776d85 * Remove `subscribe` and `unsubscribe` BaseController methods The base controller no longer exposes methods to subscribe and unsubscribe to state changes. Instead all subscriptions and unsubscriptions are done with the controller messaging system.

Gudahtt force-pushed the controller-messaging branch from 0e63938 to e803cc0 Compare March 5, 2021 18:22

Gudahtt commented Mar 5, 2021

View reviewed changes

src/ControllerMessenger.ts Outdated Show resolved Hide resolved

Gudahtt force-pushed the controller-messaging branch 4 times, most recently from c86d06e to 159d49e Compare March 8, 2021 14:29

Gudahtt mentioned this pull request Mar 8, 2021

Add restricted controller messenger #378

Merged

Gudahtt force-pushed the controller-messaging branch from 159d49e to 756e986 Compare March 8, 2021 14:38

Gudahtt commented Mar 8, 2021

View reviewed changes

Gudahtt marked this pull request as ready for review March 8, 2021 14:44

Gudahtt requested a review from a team as a code owner March 8, 2021 14:44

Gudahtt commented Mar 8, 2021

View reviewed changes

src/BaseControllerV2.ts Outdated Show resolved Hide resolved

Gudahtt commented Mar 8, 2021

View reviewed changes

src/BaseControllerV2.ts Outdated Show resolved Hide resolved

brad-decker previously approved these changes Mar 8, 2021

View reviewed changes

Gudahtt dismissed brad-decker’s stale review via 5202621 March 8, 2021 18:20

Gudahtt force-pushed the controller-messaging branch from 756e986 to 5202621 Compare March 8, 2021 18:20

brad-decker previously approved these changes Mar 8, 2021

View reviewed changes

Gudahtt dismissed brad-decker’s stale review via 6dec3da March 8, 2021 21:25

Gudahtt force-pushed the controller-messaging branch from 6dec3da to 34f5f13 Compare March 8, 2021 21:26

brad-decker previously approved these changes Mar 9, 2021

View reviewed changes

Gudahtt requested review from rekmarks, danfinlay, shanejonas and estebanmino March 9, 2021 14:27

Gudahtt dismissed brad-decker’s stale review via c267a31 March 11, 2021 04:14

Gudahtt force-pushed the controller-messaging branch from c4fb8f4 to c267a31 Compare March 11, 2021 04:14

Gudahtt added 6 commits March 11, 2021 13:21

Remove subscribe and unsubscribe BaseController methods

85fc3ef

The base controller no longer exposes methods to subscribe and unsubscribe to state changes. Instead all subscriptions and unsubscriptions are done with the controller messaging system.

Rename state-change event to stateChange

ed6488f

This event name matches the naming convention of the event prefix, which is also camelCase.

Add JSDOc comment for ControllerMessenger class

3ed24a6

Remove unused type exports

1671284

These types were only used internally. We can export them again if and when that becomes useful.

Gudahtt force-pushed the controller-messaging branch from c267a31 to 1671284 Compare March 11, 2021 16:52

brad-decker approved these changes Mar 11, 2021

View reviewed changes

Gudahtt merged commit 1416de9 into develop Mar 11, 2021

Gudahtt deleted the controller-messaging branch March 11, 2021 17:32

Gudahtt mentioned this pull request Mar 12, 2021

Prototype/propsoal: Implement controller messaging proposal #320

Closed

This was referenced Jul 24, 2024

[DNM] Preview branch of complete ComposableController fix with no type error suppression MetaMask/metamask-mobile#10374

Closed

chore(deps): Bump @metamask/composable-controller from ^3.0.0 to ^10.0.0 MetaMask/metamask-mobile#10441

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add controller messaging system #377

Add controller messaging system #377

Gudahtt commented Mar 5, 2021 •

edited

Loading

Gudahtt Mar 8, 2021

brad-decker Mar 8, 2021

Gudahtt commented Mar 8, 2021 •

edited

Loading

Gudahtt commented Mar 8, 2021

brad-decker left a comment

brad-decker left a comment

Gudahtt commented Mar 8, 2021

Gudahtt commented Mar 9, 2021

brad-decker left a comment

Gudahtt commented Mar 9, 2021

brad-decker left a comment

Add controller messaging system #377

Add controller messaging system #377

Conversation

Gudahtt commented Mar 5, 2021 • edited Loading

Gudahtt Mar 8, 2021

Choose a reason for hiding this comment

brad-decker Mar 8, 2021

Choose a reason for hiding this comment

Gudahtt commented Mar 8, 2021 • edited Loading

Gudahtt commented Mar 8, 2021

brad-decker left a comment

Choose a reason for hiding this comment

brad-decker left a comment

Choose a reason for hiding this comment

Gudahtt commented Mar 8, 2021

Gudahtt commented Mar 9, 2021

brad-decker left a comment

Choose a reason for hiding this comment

Gudahtt commented Mar 9, 2021

brad-decker left a comment

Choose a reason for hiding this comment

Gudahtt commented Mar 5, 2021 •

edited

Loading

Gudahtt commented Mar 8, 2021 •

edited

Loading