[base-controller] Make allowed{Actions,Events} required parameters of getRestricted
#4035
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
bug
MajorLift
changed the title
getRestricted not inferring omitted allowed{Actions,Events} as never[] when used with unrestrictedControllerMessenger pattern getRestricted not inferring omitted allowed{Actions,Events} as never[] when used with unrestrictedControllerMessenger pattern
MajorLift
force-pushed
the
240307-fix-getRestricted-not-infers-omitted-allowlists-as-empty-array
branch
from
e855785 to
522ece0
Compare
MajorLift
changed the title
getRestricted not inferring omitted allowed{Actions,Events} as never[] when used with unrestrictedControllerMessenger pattern getRestricted not inferring omitted Allowed{Actions,Events} as never when used with unrestrictedControllerMessenger pattern
MajorLift
changed the title
getRestricted not inferring omitted Allowed{Actions,Events} as never when used with unrestrictedControllerMessenger pattern getRestricted not inferring omitted allowlists as empty
MajorLift
changed the title
getRestricted not inferring omitted allowlists as emptygetRestricted not inferring allowlists as empty, when they are omitted in both function and generic arguments
…and function params and assigning directly to `messenger` in controller constructor prevents `Allowed{Action,Event}` generic defaults (`never`) from being applied. Assigning restricted messenger to variable first fixes issue.
MajorLift
force-pushed
the
240307-fix-getRestricted-not-infers-omitted-allowlists-as-empty-array
branch
from
522ece0 to
142cc22
Compare
…vents}` are required params
MajorLift
changed the title
getRestricted not inferring allowlists as empty, when they are omitted in both function and generic argumentsallowed{Actions,Events} required parameters of getRestricted
…ctions,Events}` were omitted
… param is omitted
MajorLift
force-pushed
the
240307-fix-getRestricted-not-infers-omitted-allowlists-as-empty-array
branch
from
0a9af45 to
8fcaf68
Compare
Mrtenz
previously approved these changes
Mar 8, 2024
| @@ -45,6 +45,8 @@ function getRestrictedMessenger( | |||
| ) { | |||
| return controllerMessenger.getRestricted({ | |||
| name, | |||
| allowedActions: [], | |||
| allowedEvents: [], | |||
| }) as RateLimitMessenger<RateLimitedApis>; | |||
There was a problem hiding this comment.
Can this be removed now? I noticed you removed some type casts in other files.
There was a problem hiding this comment.
Good catch! I missed that one. Removed here: 9cdcbf1
MajorLift
force-pushed
the
240307-fix-getRestricted-not-infers-omitted-allowlists-as-empty-array
branch
from
8fcaf68 to
9cdcbf1
Compare
Mrtenz
approved these changes
Mar 8, 2024
MajorLift
deleted the
240307-fix-getRestricted-not-infers-omitted-allowlists-as-empty-array
branch
|
@metamaskbot publish-preview |
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.
Explanation
This commit implements a fundamental solution to aligning runtime and type-level behavior for
getRestricted: removing the option to omit its function parameters altogether.Impact
The downsides of this approach are a bit more redundant code and inconvenience, but having to write an extra empty array or two doesn't seem like a terrible cost for getting unambiguous, explicit behavior.
Caveat
Note that this solution does not directly resolve the observed bug that motivated this ticket. It does make the bug irrelevant for
getRestricted, because passing in both allowlist params fixes the issue, but in general, there may still be cases where generic default arguments fail to apply.See #4033 for repro steps and more details on this bug.
Overview
References
getRestrictednot inferring allowlists as empty, when they are omitted in both function and generic arguments #4033Changelog
@metamask/base-controllerChanged
getRestrictedmethod of theControllerMessengerclass now expects bothallowedActionsandallowedEventsas required parameters.Checklist