feat: change queued-request-controller methods array params to callbacks
#4423
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
|
@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. |
This was referenced Jun 13, 2024
adonesky1
deleted the
jl/change-queued-request-controller-method-param-to-callback
branch
jiexi
added a commit
to MetaMask/metamask-extension
that referenced
this pull request
Jun 20, 2024
<!-- Please submit this PR as a draft initially. Do not mark it as "Ready for review" until the template has been completely filled out, and PR status checks have passed at least once. --> ## **Description** Bumps `@metamask/queued-request-controller` to `^1.0.0` in order to handle the case where `eth_requestAccounts` requests that would not cause a confirmation to be presented to the user (because they have permitted some accounts for that dapp) would be stuck behind the request queue when they could just be passed through. [](https://codespaces.new/MetaMask/metamask-extension/pull/25310?quickstart=1) ## **Related issues** See: MetaMask/core#4423 Fixes: #25407 ## **Manual testing steps** 1. Open https://metamask.github.io/test-dapp/ and https://app.odos.xyz/, connect to both 1. On the Test Dapp, send an EIP 1559 txn, but do not confirm/reject the confirmation nor close the popup 1. Reload ODOS 1. ODOS should show that is connected to MetaMask in the top right of the webpage 1. Open console on the ODOS page 1. run `await window.ethereum.request({method: 'eth_requestAccounts'})`, it should return immediately with the permitted accounts ## **Screenshots/Recordings** <!-- If applicable, add screenshots and/or recordings to visualize the before and after of your change. --> ### **Before** ### **After** https://github.com/MetaMask/metamask-extension/assets/918701/b76607ef-b0a3-4943-b1d5-85f8cd766343 ## **Pre-merge author checklist** - [x] I've followed [MetaMask Contributor Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Extension Coding Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md). - [x] I've completed the PR template to the best of my ability - [ ] 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-extension/blob/develop/.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: MetaMask Bot <[email protected]>
](https://codespaces.new/MetaMask/metamask-extension/pull/25310?quickstart=1){kind=link}
jiexi
added a commit
to MetaMask/metamask-extension
that referenced
this pull request
Jun 20, 2024
<!-- Please submit this PR as a draft initially. Do not mark it as "Ready for review" until the template has been completely filled out, and PR status checks have passed at least once. --> Bumps `@metamask/queued-request-controller` to `^1.0.0` in order to handle the case where `eth_requestAccounts` requests that would not cause a confirmation to be presented to the user (because they have permitted some accounts for that dapp) would be stuck behind the request queue when they could just be passed through. [](https://codespaces.new/MetaMask/metamask-extension/pull/25310?quickstart=1) See: MetaMask/core#4423 Fixes: #25407 1. Open https://metamask.github.io/test-dapp/ and https://app.odos.xyz/, connect to both 1. On the Test Dapp, send an EIP 1559 txn, but do not confirm/reject the confirmation nor close the popup 1. Reload ODOS 1. ODOS should show that is connected to MetaMask in the top right of the webpage 1. Open console on the ODOS page 1. run `await window.ethereum.request({method: 'eth_requestAccounts'})`, it should return immediately with the permitted accounts <!-- If applicable, add screenshots and/or recordings to visualize the before and after of your change. --> https://github.com/MetaMask/metamask-extension/assets/918701/b76607ef-b0a3-4943-b1d5-85f8cd766343 - [x] I've followed [MetaMask Contributor Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask Extension Coding Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md). - [x] I've completed the PR template to the best of my ability - [ ] 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-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)). Not required for external contributors. - [ ] 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: MetaMask Bot <[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
The existing
methodsWithConfirmationarray param is not sufficient for determining if a method will cause a confirmation to be presented to the user or not because some methods such aseth_requestAccountsmay only cause a prompt in some scenarios but not others.This PR replaces the array params used in the QueuedRequestController and its middleware to be callbacks that accept the entire request object instead.
References
See: MetaMask/metamask-extension#25310
Changelog
@metamask/queued-request-controllerQueuedRequestControllerconstructor no longer accepts themethodsRequiringNetworkSwitcharray param. It's now replaced with theshouldRequestSwitchNetworkfunction param which should return true when a request requires the globally selected network to match that of the dapp.createQueuedRequestMiddlewareno longer accepts themethodsWithConfirmationarray param. It's now replaced with theshouldEnqueueRequestfunction param which should return true when a request should be handled by the QueuedRequestControllerChecklist