feat(NOTIFY-1096): add account syncing #11190

mathieuartu · 2024-09-13T08:30:15Z

Description

This PR adds account syncing to MetaMask.
As part of profile syncing, with this new feature, users will be able to synchronize all of their accounts and accounts' names across all of their devices.

Related issues

Fixes:

NOTIFY-1096

Manual testing steps

Log in with SRP
Activate profile syncing in preferences
Add new accounts and rename others
Using another browser, log in with SRP
Activate profile syncing in preferences
Watch the magic happen!

Pre-merge author checklist

I’ve followed MetaMask Contributor Docs and MetaMask Mobile Coding Standards.
I've completed the PR template to the best of my ability
I’ve included tests if applicable
I’ve documented my code using JSDoc format if applicable
I’ve applied the right labels on the PR (see labeling guidelines). Not required for external contributors.

Pre-merge reviewer checklist

I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed).
I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

github-actions · 2024-09-13T08:30:30Z

CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes.

mathieuartu · 2024-09-13T08:30:57Z

I have read the CLA Document and I hereby sign the CLA

socket-security · 2024-09-13T08:35:04Z

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/@metamask/[email protected]	None	`+1`	338 kB	metamaskbot
npm/@metamask/[email protected]	None	`0`	437 kB	danfinlay, gudahtt, kumavis, ...8 more
npm/@metamask/[email protected]	None	`0`	1.62 MB	metamaskbot
npm/@metamask/[email protected]	Transitive: network	`+1`	2.6 MB	metamaskbot

🚮 Removed packages: npm/@metamask/[email protected], npm/@metamask/[email protected], npm/@metamask/[email protected], npm/@metamask/[email protected], npm/@metamask/[email protected]

View full report↗︎

codecov-commenter · 2024-09-13T11:03:40Z

Codecov Report

Attention: Patch coverage is 95.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 55.68%. Comparing base (7475ab4) to head (9aca646).
Report is 29 commits behind head on main.

Files with missing lines	Patch %	Lines
app/components/Views/Wallet/index.tsx	66.66%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #11190      +/-   ##
==========================================
+ Coverage   55.24%   55.68%   +0.43%     
==========================================
  Files        1558     1573      +15     
  Lines       37153    37497     +344     
  Branches     4406     4473      +67     
==========================================
+ Hits        20527    20880     +353     
+ Misses      16155    16126      -29     
- Partials      471      491      +20

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

github-actions · 2024-09-13T11:19:57Z

Bitrise

❌❌❌ pr_smoke_e2e_pipeline failed on Bitrise! ❌❌❌

Commit hash: b9bb37a
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/2134006d-61ca-4b88-9604-1c8f52146b4d

Note

You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

…nge event

github-actions · 2024-09-13T12:39:32Z

Bitrise

❌❌❌ pr_smoke_e2e_pipeline failed on Bitrise! ❌❌❌

Commit hash: 6c9b2ce
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/79653e7d-5260-497f-b2ed-3cdcf84785e9

Note

You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

github-actions · 2024-09-13T15:49:15Z

Bitrise

❌❌❌ pr_smoke_e2e_pipeline failed on Bitrise! ❌❌❌

Commit hash: ab17435
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/362ae0c7-a89a-402c-956b-3c7737d8a7c0

Note

You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

app/components/Views/Wallet/index.tsx

app/core/Engine.ts

Jonathansoufer

LGTM!

app/actions/notification/helpers/index.ts

Daniel-Cross

Just one small listing issue fix and you're good to go!

Daniel-Cross

GTG!

app/util/notifications/hooks/useProfileSyncing.ts

app/components/Views/Wallet/index.tsx

app/core/Engine.ts

sonarcloud · 2024-10-17T09:20:38Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
65.5% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

github-actions · 2024-10-17T09:21:33Z

Bitrise

❌❌❌ pr_smoke_e2e_pipeline failed on Bitrise! ❌❌❌

Commit hash: 9ca93ba
Build link: https://app.bitrise.io/app/be69d4368ee7e86d/pipelines/05e21872-7d34-427e-a7ca-99988fd8e5d2

Note

You can kick off another pr_smoke_e2e_pipeline on Bitrise by removing and re-applying the Run Smoke E2E label on the pull request

Tip

Check the documentation if you have any doubts on how to understand the failure on bitrise

NicolasMassart · 2024-10-17T10:57:18Z

app/components/Views/Wallet/index.test.tsx

@@ -144,4 +153,36 @@ describe('Wallet', () => {
    const foxIcon = screen.getByTestId(CommonSelectorsIDs.FOX_ICON);
    expect(foxIcon).toBeDefined();
  });
+  it('should dispatch account syncing on mount', () => {


Suggested change

it('should dispatch account syncing on mount', () => {

it('dispatches account syncing on mount', () => {

NicolasMassart · 2024-10-17T10:57:47Z

app/components/Views/Wallet/index.test.tsx

+    render(Wallet);
+    expect(useAccountSyncing().dispatchAccountSyncing).toHaveBeenCalledTimes(1);
+  });
+  it('should dispatch account syncing when appState switches from inactive|background to active', () => {


Suggested change

it('should dispatch account syncing when appState switches from inactive|background to active', () => {

it('dispatches account syncing when appState switches from inactive|background to active', () => {

NicolasMassart · 2024-10-17T11:18:19Z

app/components/Views/Wallet/index.test.tsx

+
+    expect(addEventListener).toHaveBeenCalledTimes(1);
+
+    const handleAppStateChange = addEventListener.mock.calls[0][1];


C: Not fond of this as if we add another listener in the code, this will break this test even if the feature works.

Suggested change

const handleAppStateChange = addEventListener.mock.calls[0][1];

expect(addEventListener).toHaveBeenCalledWith('change', expect.any(Function));

const handleAppStateChange = (addEventListener as jest.Mock).mock.calls.find(

([event]) => event === 'change'

)[1];

mathieuartu added 2 commits September 13, 2024 10:05

feat(NOTIFY-1096): add account syncing

631dbe9

fix: import path

04780e0

mathieuartu added the team-notifications Notifications team label Sep 13, 2024

metamaskbot added the INVALID-PR-TEMPLATE PR's body doesn't match template label Sep 13, 2024

mathieuartu added 5 commits September 13, 2024 11:58

fix: useEffect

771ad50

fix: temporarily remove keyring-controller patch

2f20cdb

fix: yarn.lock

249a1ba

fix: remove Gemfile.lock

6e2b5b5

fix: add @ts-expect-error for controller version mismatch

888f01d

fix: remove unused import

b9bb37a

mathieuartu added Run Smoke E2E Triggers smoke e2e on Bitrise and removed INVALID-PR-TEMPLATE PR's body doesn't match template labels Sep 13, 2024

metamaskbot added the INVALID-PR-TEMPLATE PR's body doesn't match template label Sep 13, 2024

feat: group profile-sync effects under a layout effect + AppState cha…

6c9b2ce

…nge event

mathieuartu added Run Smoke E2E Triggers smoke e2e on Bitrise and removed Run Smoke E2E Triggers smoke e2e on Bitrise labels Sep 13, 2024

mathieuartu added 2 commits September 13, 2024 17:18

add layouteffect deps

80af81c

Merge branch 'main' into feat/add_account_syncing

ab17435

mathieuartu added Run Smoke E2E Triggers smoke e2e on Bitrise and removed Run Smoke E2E Triggers smoke e2e on Bitrise labels Sep 13, 2024

mathieuartu added 2 commits September 16, 2024 16:32

Merge branch 'main' into feat/add_account_syncing

95563d9

chore: remove preview packages and use latest deps

c8e8e91

Prithpal-Sooriya previously approved these changes Oct 16, 2024

View reviewed changes

app/components/Views/Wallet/index.tsx Show resolved Hide resolved

app/core/Engine.ts Show resolved Hide resolved

mathieuartu marked this pull request as ready for review October 16, 2024 08:05

mathieuartu requested review from a team as code owners October 16, 2024 08:05

Jonathansoufer previously approved these changes Oct 16, 2024

View reviewed changes

Daniel-Cross reviewed Oct 16, 2024

View reviewed changes

app/actions/notification/helpers/index.ts Outdated Show resolved Hide resolved

Daniel-Cross previously approved these changes Oct 16, 2024

View reviewed changes

mathieuartu added 2 commits October 16, 2024 10:51

Merge branch 'main' into feat/add_account_syncing

1ba5618

fix: add missing semi-colon

5752f14

mathieuartu dismissed stale reviews from Daniel-Cross, Jonathansoufer, and Prithpal-Sooriya via 5752f14 October 16, 2024 08:53

Daniel-Cross previously approved these changes Oct 16, 2024

View reviewed changes

NicolasMassart requested changes Oct 16, 2024

View reviewed changes

app/util/notifications/hooks/useProfileSyncing.ts Outdated Show resolved Hide resolved

app/components/Views/Wallet/index.tsx Show resolved Hide resolved

fix: move account syncing to its own hook file

d859175

mathieuartu dismissed Daniel-Cross’s stale review via d859175 October 16, 2024 09:26

NicolasMassart requested changes Oct 16, 2024

View reviewed changes

app/core/Engine.ts Outdated Show resolved Hide resolved

mathieuartu added 4 commits October 17, 2024 10:48

fix: add tests

250f1e9

Merge branch 'main' into feat/add_account_syncing

b0786f6

feat: use new event builder

3885490

fix: formatting

9ca93ba

mathieuartu added Run Smoke E2E Triggers smoke e2e on Bitrise and removed Run Smoke E2E Triggers smoke e2e on Bitrise labels Oct 17, 2024

Daniel-Cross added Run Smoke E2E Triggers smoke e2e on Bitrise and removed Run Smoke E2E Triggers smoke e2e on Bitrise labels Oct 17, 2024

NicolasMassart requested changes Oct 17, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(NOTIFY-1096): add account syncing #11190

feat(NOTIFY-1096): add account syncing #11190

mathieuartu commented Sep 13, 2024 •

edited

Loading

github-actions bot commented Sep 13, 2024 •

edited

Loading

mathieuartu commented Sep 13, 2024

socket-security bot commented Sep 13, 2024 •

edited

Loading

codecov-commenter commented Sep 13, 2024 •

edited

Loading

github-actions bot commented Sep 13, 2024 •

edited by metamaskbot

Loading

github-actions bot commented Sep 13, 2024 •

edited by metamaskbot

Loading

github-actions bot commented Sep 13, 2024 •

edited by metamaskbot

Loading

Jonathansoufer left a comment

Daniel-Cross left a comment

Daniel-Cross left a comment

sonarcloud bot commented Oct 17, 2024

github-actions bot commented Oct 17, 2024 •

edited by metamaskbot

Loading

NicolasMassart Oct 17, 2024

NicolasMassart Oct 17, 2024

NicolasMassart Oct 17, 2024

	it('should dispatch account syncing on mount', () => {
	it('dispatches account syncing on mount', () => {

	it('should dispatch account syncing when appState switches from inactive\|background to active', () => {
	it('dispatches account syncing when appState switches from inactive\|background to active', () => {


		expect(addEventListener).toHaveBeenCalledTimes(1);

		const handleAppStateChange = addEventListener.mock.calls[0][1];

-    const handleAppStateChange = addEventListener.mock.calls[0][1];
+    expect(addEventListener).toHaveBeenCalledWith('change', expect.any(Function));
+    const handleAppStateChange = (addEventListener as jest.Mock).mock.calls.find(
+      ([event]) => event === 'change'
+    )[1];

feat(NOTIFY-1096): add account syncing #11190

Are you sure you want to change the base?

feat(NOTIFY-1096): add account syncing #11190

Conversation

mathieuartu commented Sep 13, 2024 • edited Loading

Description

Related issues

Manual testing steps

Pre-merge author checklist

Pre-merge reviewer checklist

github-actions bot commented Sep 13, 2024 • edited Loading

mathieuartu commented Sep 13, 2024

socket-security bot commented Sep 13, 2024 • edited Loading

codecov-commenter commented Sep 13, 2024 • edited Loading

Codecov Report

github-actions bot commented Sep 13, 2024 • edited by metamaskbot Loading

Bitrise

github-actions bot commented Sep 13, 2024 • edited by metamaskbot Loading

Bitrise

github-actions bot commented Sep 13, 2024 • edited by metamaskbot Loading

Bitrise

Jonathansoufer left a comment

Choose a reason for hiding this comment

Daniel-Cross left a comment

Choose a reason for hiding this comment

Daniel-Cross left a comment

Choose a reason for hiding this comment

sonarcloud bot commented Oct 17, 2024

Quality Gate passed

github-actions bot commented Oct 17, 2024 • edited by metamaskbot Loading

Bitrise

NicolasMassart Oct 17, 2024

Choose a reason for hiding this comment

NicolasMassart Oct 17, 2024

Choose a reason for hiding this comment

NicolasMassart Oct 17, 2024

Choose a reason for hiding this comment

mathieuartu commented Sep 13, 2024 •

edited

Loading

github-actions bot commented Sep 13, 2024 •

edited

Loading

socket-security bot commented Sep 13, 2024 •

edited

Loading

codecov-commenter commented Sep 13, 2024 •

edited

Loading

github-actions bot commented Sep 13, 2024 •

edited by metamaskbot

Loading

github-actions bot commented Sep 13, 2024 •

edited by metamaskbot

Loading

github-actions bot commented Sep 13, 2024 •

edited by metamaskbot

Loading

github-actions bot commented Oct 17, 2024 •

edited by metamaskbot

Loading