Fix: SelectedNetworkController should return globally selected networkClient from getProviderAndBlockTracker when domain not in state
#4063
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. |
adonesky1
commented
Mar 18, 2024
| globallySelectedNetworkClient.blockTracker, | ||
| ); | ||
| } else if (networkProxy) { | ||
| this.#proxies.delete(domain); |
There was a problem hiding this comment.
we still need to destroy the proxies to avoid a memory leak.
From @Gudahtt :
We can counteract this by storing the proxies as WeakRefs using the strategy described here: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Memory_management#weakrefs_and_finalizationregistry
adonesky1
changed the title
SelectedNetworkController should return globally selected networkClient from getProviderAndBlockTracker when domain not in state
jiexi
reviewed
Mar 20, 2024
|
@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. |
3 tasks
jiexi
reviewed
Mar 22, 2024
| ], | ||
| ); | ||
|
|
||
| // TODO(JL): replace this with a test that the proxy is removed from cache when the domainProxyMap PR is merged |
Gudahtt
reviewed
Mar 26, 2024
| @@ -654,6 +665,21 @@ export class NetworkController extends BaseController< | |||
| }; | |||
| } | |||
|
|
|||
| getSelectedNetworkClient(): | |||
There was a problem hiding this comment.
This method should have a JSDoc description.
Maybe also worth adding a @deprecated tag on getProviderAndBlockTracker (it's equivalent to this, except more difficult to work with because of the return type)
There was a problem hiding this comment.
done here: b0f1670
Gudahtt
reviewed
Mar 26, 2024
|
|
||
| this.update((state) => { | ||
| state.domains[domain] = networkClientId; | ||
| }); | ||
| } | ||
|
|
||
| #unsetNetworkClientIdForDomain(domain: Domain) { |
There was a problem hiding this comment.
Nit: Could use a JSDoc description here as well
There was a problem hiding this comment.
done here: b0f1670
adonesky1
added a commit
that referenced
this pull request
Mar 26, 2024
…ructor params (#4104) ## Explanation In a [preceding PR](#4063), the SelectedNetworkController will start to keep proxy instances for all domains seen without a way to remove them when they become stale. This PR exposes the private proxies cache map as a constructor param which will enable callers to implement their own cache invalidation strategies without needing to concern the SelectedNetworkController of the implementation details themselves. This is needed because Mobile and Extension will need to follow different cache invalidation strategies. This PR should be merged before #4063 ## References Fixes: #4062 See: #4063 ## Changelog ### `@metamask/selected-network-controller` - **BREAKING**: `SelectedNetworkController` now expects the `domainProxyMap` param which is a `Map` of `Domain` to `NetworkProxy` - **ADDED**: exports the `Domain` type ## 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: Alex Donesky <adonesky@gmail.com> Co-authored-by: Mark Stacey <markjstacey@gmail.com>
adonesky1
force-pushed
the
selected-network-bug-fix-wip
branch
2 times, most recently
from
5828800
to
f3fd820
Compare
adonesky1
commented
Mar 26, 2024
adonesky1
force-pushed
the
selected-network-bug-fix-wip
branch
from
f3fd820
to
af622c6
Compare
adonesky1
force-pushed
the
selected-network-bug-fix-wip
branch
from
af622c6
to
b0f1670
Compare
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 SelectedNetworkController currently constructs a proxy for any domain that has permissions. Other domains have no associated proxy, so the getProviderAndBlockTracker method would throw an error.
This is problematic because we grab the network client for an origin a single time when constructing an RPC pipeline for that origin in the MetaMask extension. We don't re-create the RPC pipeline when permissions change. That means that the pipeline is setup with the wrong network client (see here for more details on this bug: MetaMask/metamask-extension#23509 )
To resolve this problem, we can instead keep network client proxies for all origins, not just those with permissions. Origins without permissions still should not have a selected network client ID state, but they can have proxies that point at the globally selected network client. That way, when the origin is granted permissions, we can redirect this proxy to the selected network client and everything works smoothly, without needing to reconstruct the RPC pipeline.
This PR should be merged shortly after #4104
References
Fixes: #4062
See: #4104
Changelog
@metamask/network-controllergetSelectedNetworkClient()method that returns the provider and blockTracker for the currently selected network@metamask/selected-network-controllerSelectedNetworkControllernow requires theNetworkController:getSelectedNetworkClientmessenger actionSelectedNetworkController. getProviderAndBlockTracker()no longer throws an error if theuseRequestQueueflag is falseSelectedNetworkController. getProviderAndBlockTracker()threw an error if there was no networkClientId set for the passed domain. Now it returns a proxy that follows the globally selected network instead.Checklist