Zb/queue flush event #4139
Merged
Zb/queue flush event #4139
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
BelfordZ
force-pushed
the
zb/queue-flush-event
branch
from
698a775
to
524c67e
Compare
adonesky1
reviewed
Apr 8, 2024
packages/queued-request-controller/src/QueuedRequestController.ts
Outdated
Show resolved
Hide resolved
adonesky1
reviewed
Apr 8, 2024
packages/queued-request-controller/src/QueuedRequestController.test.ts
Outdated
Show resolved
Hide resolved
jiexi
reviewed
Apr 8, 2024
packages/queued-request-controller/src/QueuedRequestController.ts
Outdated
Show resolved
Hide resolved
adonesky1
reviewed
Apr 9, 2024
adonesky1
reviewed
Apr 9, 2024
packages/queued-request-controller/src/QueuedRequestController.test.ts
Outdated
Show resolved
Hide resolved
|
@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. |
BelfordZ
force-pushed
the
zb/queue-flush-event
branch
from
d6d8a2b
to
7a58957
Compare
jiexi
reviewed
Apr 10, 2024
Gudahtt
reviewed
Apr 11, 2024
| SelectedNetworkControllerEventTypes.stateChange, | ||
| (_, patch) => { | ||
| patch.forEach(({ op, path }) => { | ||
| if ( |
There was a problem hiding this comment.
Nit: Hmm, I can see why you chose you use the patch here. I don't love seeing patches used for this because this code ends up being a bit fragile; different patch operations than expected would break this. This would also break depending on how domains were updated, e.g. if we did domains = { 'foo.com': 'networkClientId', ...domains } instead of domains['foo.com'] = 'networkClientId', it might result in a domains replacement patch rather than a domains['foo.com'] replacement patch. Some tricky assumptions here.
The obvious alternative approach would be to cache the entire domains state here and spot the difference, but that's a bit inelegant and inefficient compared to the patch approach.
Maybe we could add an event to the SelectedNetworkController that specifically tells us when a network is switched? That would make this much simpler.
Gudahtt
approved these changes
Apr 11, 2024
This was referenced Apr 11, 2024
Merged
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 <jiexiluan@gmail.com>
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 PR is a follow up to this - where instead of calling the flush method directly after successfully handling a request, we instead subscribe to SelectedNetworkController state changes and flush the queue for the domain in question when the network changes.
One potential issue that may arise is relating to a possible race condition. The question is when will the subscriptions fire - will they happen before processing the next request starts? It's hard to say for certain.
References
Changelog
@metamask/request-queue-controllerwallet_switchEthereumChainwill clear all queued transactions from the domain, across all queued 'batches'Checklist