feat: Focus approval request UI when a request is queued #4456
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
commented
Jun 24, 2024
| @@ -83,6 +83,7 @@ export type QueuedRequestControllerOptions = { | |||
| request: QueuedRequestMiddlewareJsonRpcRequest, | |||
| ) => boolean; | |||
| clearPendingConfirmations: () => void; | |||
| showApprovalRequest: () => void; | |||
There was a problem hiding this comment.
should this be optional?..
There was a problem hiding this comment.
probably not? this controller will only be used on the extension AFAIK and I believe we will always want this hook passed?
There was a problem hiding this comment.
it's optional in the sense that this isn't required for the QueuedRequestController to perform it's core function
There was a problem hiding this comment.
sure thats definitely true. I guess I think of the type as safeguard for accidental removal... though maybe that's not really true
Merged
jiexi
added a commit
that referenced
this pull request
Jun 24, 2024
Releases `queued-request-controller` #4456
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
Currently when a request is queued, it does not cause the existing confirmation window to be focused. This is because queued requests are withheld from the
ApprovalControllerwhich is responsible for showing batched/scrubbable confirmations to the user. Since theApprovalControllernever actually receives queued requests until they are ready to be shown to the user, it becomes the responsibility of theQueuedRequestControllerto determine when the confirmation window must be focused because a new confirmation has been enqueued.This PR adds a new callback/hook to the
QueuedRequestController, enabling it to trigger the notification window receiving focus.References
Fixes: MetaMask/metamask-extension#25397
Changelog
@metamask/queued-request-controllerQueuedRequestControllerconstructor params now requires ashowApprovalRequesthook that is called when the approval request UI should be opened/focused as the result of a request with confirmation being enqueued.Checklist