QueuedRequestController: Fix list of methods that should have requests enqueued and/or switch the globally selected network #4066
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
jiexi
changed the title
13 tasks
Gudahtt
reviewed
Mar 18, 2024
| * network for the dapp. It could also be that a method expects the | ||
| * globally selected network to match some value in the request params itself. | ||
| */ | ||
| export const methodsRequiringNetworkSwitch = [ |
There was a problem hiding this comment.
Rather than describing these here as constants, perhaps we should accept them as controller or middleware options? The current set of supported methods, and whether each one has a confirmation or not, may differ between platforms. Listing this at the platform layer should let us reuse this list for other functionality as well, and it would perhaps make it less likely we'd forget to update this list after adding a new confirmation.
There was a problem hiding this comment.
This would also let us ship it as a non-breaking change, as we could use the existing list as a fallback
adonesky1
approved these changes
Apr 8, 2024
adonesky1
pushed a commit
that referenced
this pull request
Apr 16, 2024
## Explanation <!-- Thanks for your contribution! Take a moment to answer these questions so that reviewers have the information they need to properly understand your changes: * What is the current state of things and why does it need to change? * What is the solution your changes offer and how does it work? * Are there any changes whose purpose might not obvious to those unfamiliar with the domain? * If your primary goal was to update one package but you found you had to update another one along the way, why did you do so? * If you had to upgrade a dependency, why did you do so? --> ## References <!-- Are there any issues that this pull request is tied to? Are there other links that reviewers should consult to understand these changes better? For example: * Fixes #12345 * Related to #67890 --> ## Changelog <!-- If you're making any consumer-facing changes, list those changes here as if you were updating a changelog, using the template below as a guide. (CATEGORY is one of BREAKING, ADDED, CHANGED, DEPRECATED, REMOVED, or FIXED. For security-related issues, follow the Security Advisory process.) Please take care to name the exact pieces of the API you've added or changed (e.g. types, interfaces, functions, or methods). If there are any breaking changes, make sure to offer a solution for consumers to follow once they upgrade to the changes. Finally, if you're only making changes to development scripts or tests, you may replace the template below with "None". --> ### `@metamask/queued-request-controller` - **BREAKING**: The `QueuedRequestMiddleware` constructor now requires the `methodsWithConfirmation` param which should be a list of methods that can trigger confirmations ([#4066](#4066)) - **BREAKING**: The `QueuedRequestController` constructor now requires the `methodsRequiringNetworkSwitch` param which should be a list of methods that need the globally selected network to switched to the dapp selected network before being processed ([#4066](#4066)) - **BREAKING**: Clear pending confirmations (non-queued requests) after processing revokePermissions. ([#4165](#4165)) - **BREAKING**: Flush the RequestQueue after processing revokePermissions. ([#4139](#4139)) ## Checklist - [ ] I've updated the test suite for new or updated code as appropriate - [ ] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate - [ ] I've highlighted breaking changes using the "BREAKING" category above as appropriate --------- Co-authored-by: jiexi <[email protected]>
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
Previously we were not properly enqueuing requests that could trigger a confirmation notification as well as not switching networks for methods that either require it or would exhibit unexpected UI/UX without doing so beforehand. This PR improves the specificity of which methods should be handled differently in the queued request flow which covers many methods not previously handled correctly.
References
See: MetaMask/metamask-extension#22865 (comment)
Changelog
@metamask/queued-request-controllerAdded
QueuedRequestMiddlewareconstructor now requires themethodsWithConfirmationparam which should be a list of methods that can trigger confirmations (#4066)QueuedRequestControllerconstructor now requires themethodsRequiringNetworkSwitchparam which should be a list of methods that need the globally selected network to switched to the dapp selected network before being processed (#4066)Changed
QueuedRequestController.enqueueRequest()now ensures the globally selected network matches the dapp selected network before processing methods listed in themethodsRequiringNetworkSwitchconstructor param. This replaces the previous behavior of switching for all methods excepteth_requestAccounts. (#4066)Checklist