[composable-controller] Fix incorrect behavior and improve type-level safeguards #4467
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
force-pushed
the
240620-fix-ComposableController-validator-types
branch
4 times, most recently
from
6457a28 to
1a452ef
Compare
MajorLift
force-pushed
the
240620-fix-ComposableController-validator-types
branch
from
1a452ef to
7359c4b
Compare
MajorLift
force-pushed
the
240620-fix-ComposableController-validator-types
branch
from
7359c4b to
63e3837
Compare
MajorLift
force-pushed
the
240620-fix-ComposableController-validator-types
branch
2 times, most recently
from
a65140e to
604c2e9
Compare
MajorLift
force-pushed
the
240620-fix-ComposableController-validator-types
branch
2 times, most recently
from
d5343e5 to
a850f90
Compare
MajorLift
force-pushed
the
240620-fix-ComposableController-validator-types
branch
3 times, most recently
from
a32d745 to
ea7e75d
Compare
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as outdated.
This comment was marked as outdated.
MajorLift
force-pushed
the
240620-fix-ComposableController-validator-types
branch
from
c081c50 to
f59de5e
Compare
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
This comment was marked as resolved.
MajorLift
force-pushed
the
240620-fix-ComposableController-validator-types
branch
from
1f29151 to
36f9cf4
Compare
MajorLift
commented
Aug 1, 2024
MajorLift
force-pushed
the
240620-fix-ComposableController-validator-types
branch
from
edc11c3 to
7804ce6
Compare
MajorLift
commented
Aug 1, 2024
| */ | ||
| export class ComposableController< | ||
| ComposableControllerState extends LegacyComposableControllerStateConstraint, | ||
| ChildControllers extends ControllerInstance = GetChildControllers<ComposableControllerState>, | ||
| ChildControllers extends ControllerInstance, |
There was a problem hiding this comment.
The previous approach of generating mock controller classes from the ComposableControllerState input was flawed, because the mock controllers would always be incomplete, complicating attempts at validation.
Instead, we now rely on the downstream consumer to provide both a composed type of state schemas (ComposableControllerState) and a type union of the child controller instances (ChildControllers).
For example, in mobile, we can use (with some adjustments) EngineState for the former, and Controllers[keyof Controllers] for the latter.
Comment on lines
+195
to
+345
| try { | ||
| this.messagingSystem.subscribe( | ||
| // TODO: Either fix this lint violation or explain why it's necessary to ignore. | ||
| // False negative. `name` is a string type. | ||
| // eslint-disable-next-line @typescript-eslint/restrict-template-expressions | ||
| `${name}:stateChange`, | ||
| (childState: Record<string, unknown>) => { | ||
| (childState: LegacyControllerStateConstraint) => { | ||
| this.update((state) => { | ||
| Object.assign(state, { [name]: childState }); | ||
| }); | ||
| }, | ||
| ); | ||
| } else if (isBaseControllerV1(controller)) { | ||
| controller.subscribe((childState) => { | ||
| } catch (error: unknown) { | ||
| // False negative. `name` is a string type. | ||
| // eslint-disable-next-line @typescript-eslint/restrict-template-expressions | ||
| console.error(`${name} - ${String(error)}`); | ||
| } |
There was a problem hiding this comment.
To handle edge cases due to mobile using older BaseControllerV1 versions, this method no longer attempts to limit the stateChange event subscription to controllers that are defined with a messenger. Instead, it relies on the events allowlist of the ComposableController messenger to ensure that only valid subscriptions are made.
The subscribe call throws an error when invoked with a stateChange event that is not in the allowlist. This prevents any incorrect subscriptions to child controllers without a messenger or a stateChange event.
The catch block is intended to allow the logic to continue without terminating prematurely. We can remove or replace the console.error call if it causes noisy messages downstream.
Comment on lines
+211
to
+347
| if (isBaseControllerV1(controller)) { | ||
| controller.subscribe((childState: StateConstraintV1) => { |
There was a problem hiding this comment.
This subscription applies to all V1 child controllers. This may result in duplicate state updates for V1 child controllers with messengers, but the performance impact should be minimal, and it shouldn't affect the correctness of state.
Also, this issue will be automatically resolved as we phase out V1 controllers in our clients.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
This comment was marked as outdated.
MajorLift
force-pushed
the
240620-fix-ComposableController-validator-types
branch
from
b42590f to
2ca9038
Compare
3 tasks
|
@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. |
Cal-L
reviewed
Aug 1, 2024
MajorLift
changed the title
mikesposito
approved these changes
Aug 12, 2024
MajorLift
added a commit
that referenced
this pull request
Aug 21, 2024
## Explanation This commit moves `BaseController`-related types and functions in `@metamask/composable-controller` to `@metamask/base-controller`. Because applying these changes requires a concurrent major update of `@metamask/base-controller`, this commit will be excluded from `@metamask/composable-controller@8.0.0` (#4467), so that complications can be avoided while applying `8.0.0` to mobile. ## References - Blocked by #4467 - Blocked by MetaMask/metamask-mobile#10441 ## Changelog ### `@metamask/base-controller` (minor) ### Added - Migrate from `@metamask/composable-controller@8.0.0` into `@metamask/base-controller`: types `LegacyControllerStateConstraint`, `RestrictedControllerMessengerConstraint` and type guard functions `isBaseController`, `isBaseControllerV1` ([#4581](#4581)) - Add and export types `ControllerInstance`, `BaseControllerInstance`, `StateDeriverConstraint`, `StateMetadataConstraint`, `StatePropertyMetadataConstraint`, `BaseControllerV1Instance`, `ConfigConstraintV1`, `StateConstraintV1` ([#4581](#4581)) ### `@metamask/composable-controller` (major) ### Removed - **BREAKING:** Remove exports for types `LegacyControllerStateConstraint`, `RestrictedControllerMessengerConstraint`, and type guard functions `isBaseController`, `isBaseControllerV1` ([#4467](#4467)) - These have been migrated to `@metamask/base-controller@6.2.0`. ## 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 highlighted breaking changes using the "BREAKING" category above as appropriate
github-merge-queue bot
pushed a commit
to MetaMask/metamask-mobile
that referenced
this pull request
Dec 9, 2024
…`^10.0.0` (#10441) ## **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 - MetaMask/core#4968 - `composable-controller` v10 has been written to ensure that the effect of this optimization is maximized. - #12348 - #12407 - ~#11162 ## 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** - Closes #10073 - Applies MetaMask/core#4467 - Blocked by `@metamask/composable-controller@8.0.0` release. - Supersedes #10011 ## **Manual testing steps** ## **Screenshots/Recordings** ## **Pre-merge author checklist** - [x] I’ve followed [MetaMask Contributor Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Mobile Coding Standards](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/CODING_GUIDELINES.md). - [x] I've completed the PR template to the best of my ability - [x] I’ve included tests if applicable - [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format if applicable - [x] I’ve applied the right labels on the PR (see [labeling guidelines](https://github.com/MetaMask/metamask-mobile/blob/main/.github/guidelines/LABELING_GUIDELINES.md)). Not required for external contributors. ## **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. --------- Co-authored-by: Salah-Eddine Saakoun <salah-eddine.saakoun@consensys.net>
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.
Overview
This commit fixes issues with the
ComposableControllerclass's interface, and its logic for validating V1 and V2 controllers.These changes will enable
ComposableControllerto function correctly downstream in the Mobile Engine, and eventually the Wallet Framework POC.Explanation
The previous approach of generating mock controller classes from the
ComposableControllerStateinput using theGetChildControllerswas flawed, because the mock controllers would always be incomplete, complicating attempts at validation.Instead, we now rely on the downstream consumer to provide both a composed type of state schemas (
ComposableControllerState) and a type union of the child controller instances (ChildControllers). For example, in mobile, we can use (with some adjustments)EngineStatefor the former, andControllers[keyof Controllers]for the latter.The validation logic for V1 controllers has also been updated. Due to breaking changes made to the private properties of
BaseControllerV1(#3959), mobile V1 controllers relying on versions prior to these changes were introduced were incompatible with the up-to-dateBaseControllerV1version that the composable-controller package references.In this commit, the validator type
BaseControllerV1Instancefilters out the problematic private properties by using thePublicInterfacetype. Because the public API ofBaseControllerV1has been relatively constant, this removes the type errors that previously occurred in mobile when passing V1 controllers intoComposableController.References
BaseControllerV1Instancetype and makeChildControllersa required type parameter #4448ComposableControllerinstantiation and functionality is broken metamask-mobile#10073@metamask/composable-controllerfrom^3.0.0to^6.0.2metamask-mobile#10011Changelog
@metamask/composable-controller(major)Changed
ComposableControllerclass:ComposedControllerState(constrained byLegacyComposableControllerStateConstraint) andChildControllers(constrained byControllerInstance) (#4467).isBaseControllernow validates that the input has an object-type property namedmetadatain addition to its existing checks.isBaseControllerV1now validates that the input has object-type propertiesconfig,state, and function-type propertysubscribe, in addition to its existing checks.LegacyControllerStateConstrainttype fromBaseState | StateConstrainttoBaseState & object | StateConstraint.ControllerNameto theRestrictedControllerMessengerConstrainttype, which extendsstringand defaults tostring.Fixed
ComposableControllerclass raises a type error if a non-controller with nostateproperty is passed into theChildControllersgeneric parameter or thecontrollersconstructor option.ComposableControllerclass is instantiated, its messenger now attempts to subscribe to all child controllerstateChangeevents that are included in the messenger's events allowlist.@metamask/composable-controller@6.0.0causedstateChangeevent subscriptions to fail.isBaseControllerandisBaseControllerV1no longer return false negatives.instanceofoperator is no longer used to validate that the input is a subclass ofBaseControllerorBaseControllerV1.ChildControllerStateChangeEventstype checks that the child controller's state extends from theStateConstraintV1type instead of fromRecord<string, unknown>. (#4467)interfacekeyword, which are incompatible withRecord<string, unknown>by default. This resulted inChildControllerStateChangeEventsfailing to generatestateChangeevents for V1 controllers and returningnever.Checklist