test: add user-storage to privacy snapshot and update user-storage mocks #27292

Prithpal-Sooriya · 2024-09-19T18:35:13Z

note - we need to update our library to support generic paths and mock X-Sync data features

Description

This fixes the flaky test for updating the privacy snapshot for user-storage API.
We also better mock the user-storage API to fail fast when testing Account-Syncing.

NOTE - we need to update our library to support generic paths, and also have mock data for testing the X-Syncing features (account syncing, network syncing, notification syncing, asset syncing).

Related issues

Fixes:

Manual testing steps

Go to this page...

Screenshots/Recordings

Before

After

Pre-merge author checklist

I've followed MetaMask Contributor Docs and MetaMask Extension 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-19T18:35:29Z

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.

note - we need to update our library to support generic paths and mock X-Sync data features

Prithpal-Sooriya · 2024-09-19T18:39:52Z

privacy-snapshot.json

@@ -58,5 +58,6 @@
  "oidc.api.cx.metamask.io",
  "price.api.cx.metamask.io",
  "token.api.cx.metamask.io",
-  "client-side-detection.api.cx.metamask.io"
+  "client-side-detection.api.cx.metamask.io",
+  "user-storage.api.cx.metamask.io"


This API is now introduced in e2e tests as we have launched a new "Account Syncing" feature, which will sync your accounts you may have previously stored. This is done on wallet start/open post onboarding.

Prithpal-Sooriya · 2024-09-19T18:40:34Z

test/e2e/tests/notifications/mocks.ts

+  // TODO - add better mock responses for other Profile Sync features
+  // (Account Sync, Network Sync, ...)


Yeah, we are currently mocking these API responses to fail fast. This ensures that the syncing features won't get in the way with existing e2e tests.

metamaskbot · 2024-09-19T19:08:14Z

Builds ready [fcec986]

builds: chrome, firefox
builds (beta): chrome
builds (flask): chrome, firefox
builds (MMI): chrome, firefox
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Background Module Init Stats
mv3: UI Init Stats
mv3: Module Load Stats
mv3: Bundle Size Stats
mv2: E2e Actions Stats
code coverage: Report
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5, 6
- common: 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9
- content-script: 0
- offscreen: 0
- ui: 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (1855 ± 104 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1626	2452	1849	218	104
		domContentLoaded	1613	2298	1812	197	95
		load	1649	2474	1855	216	104
		domInteractive	13	88	37	17	8

Bundle size diffs

background: 0 Bytes (0.00%)
ui: 0 Bytes (0.00%)
common: 0 Bytes (0.00%)

metamaskbot · 2024-09-20T11:21:19Z

Builds ready [552f88e]

builds: chrome, firefox
builds (beta): chrome
builds (flask): chrome, firefox
builds (MMI): chrome, firefox
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Background Module Init Stats
mv3: UI Init Stats
mv3: Module Load Stats
mv3: Bundle Size Stats
mv2: E2e Actions Stats
code coverage: Report
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5, 6
- common: 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9
- content-script: 0
- offscreen: 0
- ui: 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (1977 ± 113 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	618	2609	1927	387	186
		domContentLoaded	1586	2363	1940	229	110
		load	1649	2490	1977	235	113
		domInteractive	17	104	48	23	11

Bundle size diffs

background: 0 Bytes (0.00%)
ui: 0 Bytes (0.00%)
common: 0 Bytes (0.00%)

matteoscurati

LGTM!

danjm · 2024-09-20T12:46:37Z

will this API call not occur if the basic functionalities toggle is off?

danjm · 2024-09-20T12:48:59Z

and when/how did the related test become flaky? how does it pass sometimes and fail other times?

Prithpal-Sooriya · 2024-09-20T14:08:09Z

@danjm

will this API call not occur if the basic functionalities toggle is off?

Yes profile sync/this API is disabled when basic functionality is turned off.

and when/how did the related test become flaky? how does it pass sometimes and fail other times?

We started seeing this appear sometime yesterday.
https://app.circleci.com/pipelines/github/MetaMask/metamask-extension/101355/workflows/37ecc4fa-a568-4932-97b1-d90c35dfc55f/jobs/3773505
We have just released the "Account-Syncing" feature, which also is turned off if basic functionality is turned off.
The mock endpoint update was to "wildcard" all calls to this endpoint, and not just notifications.

Happy to sync or async on this.

sonarcloud · 2024-09-20T14:12:16Z

Quality Gate passed

Issues
1 New issue
0 Accepted issues

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

See analysis details on SonarCloud

metamaskbot · 2024-09-20T14:32:55Z

Builds ready [1897fad]

builds: chrome, firefox
builds (beta): chrome
builds (flask): chrome, firefox
builds (MMI): chrome, firefox
builds (test): chrome, firefox
builds (test-flask): chrome, firefox
build viz: Build System
mv3: Background Module Init Stats
mv3: UI Init Stats
mv3: Module Load Stats
mv3: Bundle Size Stats
mv2: E2e Actions Stats
code coverage: Report
storybook: Storybook
typescript migration: Dashboard
all artifacts
bundle viz:
- background: 0, 1, 2, 3, 4, 5, 6
- common: 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9
- content-script: 0
- offscreen: 0
- ui: 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (1925 ± 78 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	495	2201	1861	354	170
		domContentLoaded	1550	2191	1908	164	79
		load	1593	2202	1925	162	78
		domInteractive	14	84	36	17	8

Bundle size diffs

background: 0 Bytes (0.00%)
ui: 0 Bytes (0.00%)
common: 0 Bytes (0.00%)

Prithpal-Sooriya added the team-notifications Notifications team label Sep 19, 2024

test: add user-storage to privacy snapshot and update user-storage mocks

fcec986

note - we need to update our library to support generic paths and mock X-Sync data features

Prithpal-Sooriya force-pushed the test/fix-failing-user-storage-snapshot branch from ac2fef4 to fcec986 Compare September 19, 2024 18:36

Prithpal-Sooriya commented Sep 19, 2024

View reviewed changes

mathieuartu approved these changes Sep 20, 2024

View reviewed changes

Merge branch 'develop' into test/fix-failing-user-storage-snapshot

552f88e

Prithpal-Sooriya marked this pull request as ready for review September 20, 2024 11:25

Prithpal-Sooriya requested review from a team as code owners September 20, 2024 11:25

Merge branch 'develop' into test/fix-failing-user-storage-snapshot

655d179

matteoscurati approved these changes Sep 20, 2024

View reviewed changes

Merge branch 'develop' into test/fix-failing-user-storage-snapshot

04bf9de

pedronfigueiredo approved these changes Sep 20, 2024

View reviewed changes

Merge branch 'develop' into test/fix-failing-user-storage-snapshot

1897fad

hjetpoluru mentioned this pull request Sep 20, 2024

Fix "MetaMask onboarding @no-mmi should not prevent netwo..." flaky tests #27301

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test: add user-storage to privacy snapshot and update user-storage mocks #27292

test: add user-storage to privacy snapshot and update user-storage mocks #27292

Prithpal-Sooriya commented Sep 19, 2024 •

edited by github-actions bot

Loading

github-actions bot commented Sep 19, 2024

Prithpal-Sooriya Sep 19, 2024

Prithpal-Sooriya Sep 19, 2024

metamaskbot commented Sep 19, 2024

metamaskbot commented Sep 20, 2024

matteoscurati left a comment

danjm commented Sep 20, 2024

danjm commented Sep 20, 2024

Prithpal-Sooriya commented Sep 20, 2024

sonarcloud bot commented Sep 20, 2024

metamaskbot commented Sep 20, 2024

		// TODO - add better mock responses for other Profile Sync features
		// (Account Sync, Network Sync, ...)

test: add user-storage to privacy snapshot and update user-storage mocks #27292

Are you sure you want to change the base?

test: add user-storage to privacy snapshot and update user-storage mocks #27292

Conversation

Prithpal-Sooriya commented Sep 19, 2024 • edited by github-actions bot Loading

Description

Related issues

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

github-actions bot commented Sep 19, 2024

Prithpal-Sooriya Sep 19, 2024

Choose a reason for hiding this comment

Prithpal-Sooriya Sep 19, 2024

Choose a reason for hiding this comment

metamaskbot commented Sep 19, 2024

metamaskbot commented Sep 20, 2024

matteoscurati left a comment

Choose a reason for hiding this comment

danjm commented Sep 20, 2024

danjm commented Sep 20, 2024

Prithpal-Sooriya commented Sep 20, 2024

sonarcloud bot commented Sep 20, 2024

Quality Gate passed

metamaskbot commented Sep 20, 2024

Prithpal-Sooriya commented Sep 19, 2024 •

edited by github-actions bot

Loading