feat(base-controller): Allow using internal events/actions#2050
Merged
feat(base-controller): Allow using internal events/actions#2050
Conversation
Contributor
|
Looks good! I added some updates building on this: #2051 |
mcmire
reviewed
Nov 16, 2023
| * @returns Whether the event type is allowed. | ||
| */ | ||
| #isAllowedEvent(eventType: Event['type']): eventType is AllowedEvent { | ||
| // Safely upcast to allow runtime check |
Member
Author
There was a problem hiding this comment.
Yeah I thought so! I was considering suggesting this strategy in our docs.
That is, if you want to upcast something (which is always safe to do), assign it to a new variable. This lets TypeScript validate that it's a safe upcast.
Whereas the as operator also allows downcasting, so it's not as safe to use.
packages/base-controller/src/RestrictedControllerMessenger.test.ts
Outdated
Show resolved
Hide resolved
3 tasks
The restricted controller messenger now allows using all internal events and actions. Previously internal events were treated the same as external events, they had to be explicitly allowed. This is a non-breaking change; internal actions/events are still permitted to be list as "allowed", it's just no longer necessary. Resolves #2047
4fd01b5 to
6542f62
Compare
Member
Author
|
Thanks for the feedback @MajorLift , I removed the unnecessary allowed action/event types from the tests and I've propagated the new helper function to those three spots you found. The rest of the changes in that PR seem better to handle separately, but let me know if I've missed something |
MajorLift
reviewed
Nov 16, 2023
MajorLift
reviewed
Nov 16, 2023
MajorLift
reviewed
Nov 16, 2023
MajorLift
reviewed
Nov 16, 2023
MajorLift
reviewed
Nov 16, 2023
Contributor
|
Agreed on the scope of the PR, but I think the |
Co-authored-by: Jongsun Suh <jongsun.suh@icloud.com>
3 tasks
mcmire
added a commit
that referenced
this pull request
Nov 22, 2023
…ot initialized with internal actions/events in allow lists (#2051) ## Explanation - `RestrictedControllerMessenger` constructor and `ControllerMessenger.getRestricted()` method now raise a type error if an internal action is passed into `allowedActions`, or an internal event into `allowedEvents`. - ` Type 'string' is not assignable to type 'never'.` - `Type '"SomeController:internalAction"' is not assignable to type '"OtherController:externalAction1" | "OtherController:externalAction2"'.` - Fixes breaking tests in downstream controllers in core repo. ## Impact - The `allowed{Actions,Events}` arrays in `ControllerMessenger.getRestricted()` now align with the `Allowed{Actions,Events}` generic params of `RestrictedControllerMessenger`: Both only enumerate external actions/events. - This commit disallows `allowed{Actions,Events}` arrays that contain an incomplete list of internal actions/events. - A partial list doesn't provide any useful information as all internal actions/events will be available to the messenger regardless of whether any of them are allowlisted. - A partial list also gives the confusing impression that some internal actions/events can be *disallowed* through omission, which is not true as of #2050. --------- Co-authored-by: Elliot Winkler <elliot.winkler@gmail.com>
mcmire
added a commit
that referenced
this pull request
Nov 22, 2023
…ot initialized with internal actions/events in allow lists (#2051) ## Explanation - `RestrictedControllerMessenger` constructor and `ControllerMessenger.getRestricted()` method now raise a type error if an internal action is passed into `allowedActions`, or an internal event into `allowedEvents`. - ` Type 'string' is not assignable to type 'never'.` - `Type '"SomeController:internalAction"' is not assignable to type '"OtherController:externalAction1" | "OtherController:externalAction2"'.` - Fixes breaking tests in downstream controllers in core repo. ## Impact - The `allowed{Actions,Events}` arrays in `ControllerMessenger.getRestricted()` now align with the `Allowed{Actions,Events}` generic params of `RestrictedControllerMessenger`: Both only enumerate external actions/events. - This commit disallows `allowed{Actions,Events}` arrays that contain an incomplete list of internal actions/events. - A partial list doesn't provide any useful information as all internal actions/events will be available to the messenger regardless of whether any of them are allowlisted. - A partial list also gives the confusing impression that some internal actions/events can be *disallowed* through omission, which is not true as of #2050. --------- Co-authored-by: Elliot Winkler <elliot.winkler@gmail.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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
The restricted controller messenger now allows using all internal events and actions. Previously internal events were treated the same as external events, they had to be explicitly allowed.
This is a non-breaking change; internal actions/events are still permitted to be list as "allowed", it's just no longer necessary.
References
Resolves #2047
Changelog
@metamask/base-controllerChecklist