[composable-controller] Enable handling of non-controller input #4943
+79
−48
Conversation
This file contains 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
MajorLift
added
team-wallet-framework
team-tiger
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
|
@metamaskbot publish-preview |
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
mcmire
reviewed
Nov 19, 2024
| @@ -16,8 +15,18 @@ import type { Patch } from 'immer'; | |||
|
|
|||
| export const controllerName = 'ComposableController'; | |||
|
|
|||
| export const INVALID_CONTROLLER_ERROR = | |||
| 'Invalid controller: controller must have a `messagingSystem` or be a class inheriting from `BaseControllerV1`.'; | |||
| // TODO: Replace with type guard once superclass for messageable non-controllers has been defined. | |||
There was a problem hiding this comment.
If the goal is to figure out which controllers do not have state, can we check for the absence of the state property?
There was a problem hiding this comment.
Unfortunately only AssetsContractController lacks a state property.
NftDetectionController and TokenDetectionController both have a state property which is assigned an empty object of type Record<never, never>, because both inherit from BaseController.
Checking for an empty state object is not useful because there could be controllers with non-empty state that are initialized with empty state objects.
These inconsistencies make the changes in this PR less type-safe than they could be. This ties in to one of the motivations for the MessengerClient/Messageable ADR. which is to align inheritance for stateless non-controllers.
There was a problem hiding this comment.
Oh, I see. My thought is that we could clean this up by assuming that the non-controllers do not inherit from BaseController. I forgot that we will do that through the MessengerClient/Messageable ADR though.
There was a problem hiding this comment.
There's currently no common supertype for the stateless non-controllers that is narrower than an object with a 'name' property.
Ideally, we would be able to exclude all classes with properties 'name', 'messagingSystem' and without 'state', 'metadata', but since that's currently not an option until the ADR is implemented, I went for just explicitly specifying the non-controllers, so we wouldn't have to deal with edge cases in the input.
I refactored the logic a bit. Hopefully this makes the intention a bit clearer: 85389bb
MajorLift
commented
Nov 19, 2024
TODO: move to `@metamask/base-controller` once we have a type and type guard for stateless non-controllers
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
References
ComposableControllerAPI updates that fix broken functionality metamask-mobile#10441Changelog
@metamask/composable-controllerChanged
ComposableControllercontroller optioncontrollersand generic type parameterChildControllersto accept all objects with a 'name' property. Passing in non-controller input no longer produces a runtime error.stateChangeevent subscription operation will exclude non-controller input.ComposableControllerStateonly accepts controllers with a 'state' property.isBaseController,isBaseControllerV1fromControllerInstancetounknown.Checklist