Fix NetworkController to handle clearing of messenger#5116
Merged
Conversation
If the network controller is in the process of executing the `lookupNetwork` step and the messenger is cleared of subscriptions, then it may throw an error that the `networkDidChange` subscription is missing. This happens in Mobile when it destroys the engine. There are actually two places where `lookupNetwork` subscribes to `networkDidChange` and then unsubscribes, but the aforementioned error is only replicable with one of them. However, we handle both cases just in case.
mcmire
force-pushed
the
handle-missing-subscription-in-nc
branch
from
8590275 to
ffa69e9
Compare
mcmire
added
the
team-wallet-framework
7 tasks
Contributor
|
@metamaskbot publish-preview |
Contributor
|
Preview builds have been published. See these instructions for more information about preview builds. Expand for full list of packages and versions. |
4 tasks
mathieuartu
previously approved these changes
Jan 9, 2025
Contributor
mathieuartu
left a comment
mathieuartu
left a comment
There was a problem hiding this comment.
This fixes my PR, thanks a ton! LGTM 🏆
mathieuartu
added a commit
that referenced
this pull request
Jan 9, 2025
## Explanation This PR moves the logic related to account syncing from `UserStorageController` to separated files in the `account-syncing` folder. It also improves test coverage related to account syncing to 100%. ## References Related to #4923 - Extension draft PR: MetaMask/metamask-extension#29316 - CI & E2E Passes ✅ - I needed to add the new `isAccountSyncingInProgress` state key at various places to make it pass CI (as expected) - Account syncing is enabled on extension - Mobile draft PR: MetaMask/metamask-mobile#12755 - CI passes BUT ✅ ☝️ - I needed to add the new isAccountSyncingInProgress state key at various places to make it pass CI (as expected) - UTs were broken. It seems to be linked to the latest version of `NetworkController` and its `NetworkController:networkDidChange` event. This latest version is requested by our controller as part of the upcoming network syncing feature. - This will require a separate PR that bumps `NetworkController` to `v22.1.1` (or another incriminated dependency TBD) - This has started to be addressed here: MetaMask/metamask-mobile#12765 - This was fixed by this PR: #5116 - In any case, account syncing is **NOT** enabled on mobile yet ## 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/profile-sync-controller` - **CHANGED**: moved account syncing logic to its own files - **BREAKING**: added a new `isAccountSyncingInProgress` state key ## 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 - [x] I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes
PatrykLucka
pushed a commit
that referenced
this pull request
Jan 13, 2025
## Explanation This PR moves the logic related to account syncing from `UserStorageController` to separated files in the `account-syncing` folder. It also improves test coverage related to account syncing to 100%. ## References Related to #4923 - Extension draft PR: MetaMask/metamask-extension#29316 - CI & E2E Passes ✅ - I needed to add the new `isAccountSyncingInProgress` state key at various places to make it pass CI (as expected) - Account syncing is enabled on extension - Mobile draft PR: MetaMask/metamask-mobile#12755 - CI passes BUT ✅ ☝️ - I needed to add the new isAccountSyncingInProgress state key at various places to make it pass CI (as expected) - UTs were broken. It seems to be linked to the latest version of `NetworkController` and its `NetworkController:networkDidChange` event. This latest version is requested by our controller as part of the upcoming network syncing feature. - This will require a separate PR that bumps `NetworkController` to `v22.1.1` (or another incriminated dependency TBD) - This has started to be addressed here: MetaMask/metamask-mobile#12765 - This was fixed by this PR: #5116 - In any case, account syncing is **NOT** enabled on mobile yet ## 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/profile-sync-controller` - **CHANGED**: moved account syncing logic to its own files - **BREAKING**: added a new `isAccountSyncingInProgress` state key ## 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 - [x] I've prepared draft pull requests for clients and consumer packages to resolve any breaking changes
Contributor
Author
|
^ Merge conflicts resolved. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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
If the network controller is in the process of executing the
lookupNetworkstep and the messenger is cleared of subscriptions, then it may throw an error that thenetworkDidChangesubscription is missing. This happens in Mobile when it destroys the engine. There are actually two places wherelookupNetworksubscribes tonetworkDidChangeand then unsubscribes, but the aforementioned error is only replicable with one of them. However, we handle both cases just in case.References
Fixes #5115.
Changelog
(Updated in PR.)
Checklist