Request Queue Controller #1806
Merged
Request Queue Controller #1806
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 |
|
New dependencies detected. Learn more about Socket for GitHub ↗︎
|
BelfordZ
commented
Oct 11, 2023
packages/queued-request-controller/src/QueuedRequestController.ts
Outdated
Show resolved
Hide resolved
BelfordZ
commented
Oct 11, 2023
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
jiexi
reviewed
Oct 11, 2023
jiexi
reviewed
Oct 11, 2023
jiexi
reviewed
Oct 11, 2023
packages/queued-request-controller/src/QueuedRequestMiddleware.ts
Outdated
Show resolved
Hide resolved
jiexi
reviewed
Oct 11, 2023
packages/queued-request-controller/src/QueuedRequestMiddleware.ts
Outdated
Show resolved
Hide resolved
jiexi
reviewed
Oct 11, 2023
packages/queued-request-controller/src/QueuedRequestMiddleware.ts
Outdated
Show resolved
Hide resolved
jiexi
reviewed
Oct 11, 2023
packages/queued-request-controller/tests/QueuedRequestController.test.ts
Outdated
Show resolved
Hide resolved
jiexi
reviewed
Oct 11, 2023
packages/queued-request-controller/tests/QueuedRequestController.test.ts
Outdated
Show resolved
Hide resolved
jiexi
reviewed
Oct 11, 2023
packages/queued-request-controller/tests/QueuedRequestMiddleware.test.ts
Outdated
Show resolved
Hide resolved
jiexi
reviewed
Oct 11, 2023
|
@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. |
|
👍 Dependency issues cleared. Learn more about Socket for GitHub ↗︎ This PR previously contained dependency changes with security issues that have been resolved, removed, or ignored. |
BelfordZ
force-pushed
the
queue2
branch
2 times, most recently
from
6d59afb
to
4e2d674
Compare
|
@metamaskbot publish-preview |
|
@metamaskbot publish-preview |
jiexi
previously approved these changes
Oct 23, 2023
MajorLift
reviewed
Oct 23, 2023
MajorLift
reviewed
Oct 23, 2023
Co-authored-by: Jongsun Suh <[email protected]>
mcmire
reviewed
Oct 23, 2023
adonesky1
approved these changes
Oct 23, 2023
|
@metamaskbot publish-preview |
|
Here are the updates for consolidating messenger and |
|
@MajorLift What do you think if we included those changes in a new PR? I know there are some other refactors mentioned here that we could possibly include there or in another PR as well. |
|
Yes the typing fixes could definitely be done in a separate PR.👍 |
MajorLift
approved these changes
Oct 23, 2023
3 tasks
3 tasks
MajorLift
added a commit
that referenced
this pull request
Nov 29, 2023
…wareMessenger` pattern, fix `any` (#1970) ## Explanation ### Apply controller-messenger pattern - Defines `QueuedRequestMiddlewareMessenger`, `SelectedNetworkMiddlewareMessenger` types to represent external controller messengers in the middleware chain. - Reserved for internal use and not exported at package level. - Defines separate allow lists for `QueuedRequest{Controller,Middleware}Messenger` and `SelectedNetwork{Controller,Middleware}Messenger`. ### Type fixes - Defines and exports `QueuedRequestMiddlewareJsonRpcRequest`, `SelectedNetworkMiddlewareJsonRpcRequest` types. - Fix `any` usage in `createSelectedNetworkMiddleware` ### Tests - Fixes `any`, `as any` usage in `QueuedRequestController`, `QueuedRequestMiddleware` tests. - Moves util functions for building test messengers into individual test files. - For context: #1970 (comment) ## References - Follow-up from #1806 - Builds on #2051 - Closes #2038 ## Changelog ### `@metamask/queued-request-controller` - **ADDED**: Add `QueuedRequestMiddlewareJsonRpcRequest` typee - **BREAKING:** `QueuedRequestControllerMessenger` can no longer be defined with any allowed actions or events. - **CHANGED**: Move `@metamask/approval-controller` from devDeps to deps. ### `@metamask/selected-network-controller` - **ADDED**: Add `SelectedNetworkMiddlewareJsonRpcRequest` type - **BREAKING:** Rename `SelectedNetworkControllerAction` to `SelectedNetworkControllerActions` and `SelectedNetworkControllerEvent` to `SelectedNetworkControllerEvents` for consistency with corresponding type exports from other controllers. - **BREAKING:** `createSelectedNetworkMiddleware` return type is constrained to satisfy `JsonRpcMiddleware<JsonRpcParams, Json>`, and the `req` parameter needs to satisfy `SelectedNetworkMiddlewareJsonRpcRequest`. ## Checklist - [x] I've updated the test suite for new or updated code as appropriate - [x] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate - [x] I've highlighted breaking changes using the "BREAKING" category above as appropriate --------- Co-authored-by: Elliot Winkler <[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
What is the current state of things and why does it need to change?
Currently, dapps must keep track of what metamasks selected network is, and switch the network appropriately. We recently added a selectedNetworkController that keeps track of what dapp has requested what network. This PR adds some middleware that will automatically prompt the user to switch metamasks network if the saved network for the dapp doesnt match. It also adds a queue, which will cause requests which require confirmations to be processed in a first-in-first-out manner.
The queued request controller provides this api mechanism and serves as a place to interate on the queueing implementation.
The selected network controller is updated to provide a proxy provider - that is, a provider that will be swapped out based on the dapps network selections.
References
needs these
Parent issue: https://github.com/MetaMask/MetaMask-planning/issues/1316
Changelog
@metamask/queued-request-controller@metamask/selected-network-controllerChecklist