Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[UserStorageController] Decouple account sync code from main controller #4923

Open
mathieuartu opened this issue Nov 13, 2024 · 0 comments
Open
Assignees
Labels
team-identity Identity Team changes. https://github.com/orgs/MetaMask/teams/identity

Comments

@mathieuartu
Copy link
Contributor

No description provided.

@mathieuartu mathieuartu self-assigned this Nov 13, 2024
@mathieuartu mathieuartu added the team-identity Identity Team changes. https://github.com/orgs/MetaMask/teams/identity label Nov 15, 2024
mathieuartu added a commit that referenced this issue 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 issue 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
team-identity Identity Team changes. https://github.com/orgs/MetaMask/teams/identity
Projects
None yet
Development

No branches or pull requests

1 participant