test: [POM] Migrate vault decryption e2e tests to TS and Page Object Model #28419

chloeYue · 2024-11-12T09:06:44Z

Description

Migrate e2e tests test/e2e/vault-decryption-chrome.spec.js to TS and Page Object Model, this test runs only on develop branch, by migrating to POM, we improve the maintainability.
Create page classe functions for vault decryption page, so we can use that in the future when needed
Deprecate/remove old functions in helper.js
Improved testing logs to make it easier to debug. See testing logs on this branch:

Related issues

Fixes: #28431

Manual testing steps

Check code readability, make sure tests pass.

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-11-12T09:07:01Z

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.

…tests

metamaskbot · 2024-11-12T11:24:10Z

Builds ready [c1e6432]

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, 7
- common: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9
- content-script: 0
- offscreen: 0
- ui: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (1908 ± 95 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	310	2295	1743	472	226
		domContentLoaded	1617	2282	1882	187	90
		load	1650	2297	1908	198	95
		domInteractive	16	184	54	34	16
		backgroundConnect	9	101	31	25	12
		firstReactRender	59	328	128	65	31
		getState	5	64	16	16	8
		initialActions	0	1	0	0	0
		loadScripts	1161	1758	1394	172	83
		setupStore	6	75	17	21	10
		uiStartup	1857	2995	2181	274	132

Bundle size diffs

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

metamaskbot · 2024-11-13T09:15:39Z

Builds ready [b18fee1]

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, 7
- common: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9
- content-script: 0
- offscreen: 0
- ui: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (2138 ± 186 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	901	3443	2050	452	217
		domContentLoaded	1731	3430	2106	397	191
		load	1740	3444	2138	388	186
		domInteractive	20	169	63	33	16
		backgroundConnect	8	88	28	23	11
		firstReactRender	74	294	116	44	21
		getState	5	63	26	23	11
		initialActions	0	0	0	0	0
		loadScripts	1240	2823	1571	362	174
		setupStore	6	56	15	16	8
		uiStartup	1936	3680	2379	405	194

Bundle size diffs

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

test/e2e/page-objects/pages/settings/privacy-settings.ts

metamaskbot · 2024-11-13T10:01:28Z

Builds ready [1fc9eb9]

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, 7
- common: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9
- content-script: 0
- offscreen: 0
- ui: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (1672 ± 50 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1509	2005	1693	125	60
		domContentLoaded	1495	1981	1645	100	48
		load	1502	1985	1672	105	50
		domInteractive	22	93	52	21	10
		backgroundConnect	9	77	27	20	10
		firstReactRender	45	307	106	53	25
		getState	4	50	9	11	5
		initialActions	0	1	0	0	0
		loadScripts	1065	1574	1226	100	48
		setupStore	5	77	10	16	7
		uiStartup	1648	2623	1884	201	97

Bundle size diffs

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

DDDDDanica · 2024-11-13T13:20:51Z

LGTM !

test/e2e/vault-decryption-chrome.spec.ts

test/e2e/page-objects/flows/onboarding.flow.ts

seaona

Overall looks good 🔥 awesome work @chloeYue 🙌
I just added 2 small comments, in case you want to take them, or feel free to leave them too

Co-authored-by: seaona <[email protected]>

metamaskbot · 2024-11-14T15:05:30Z

Builds ready [9eeaaba]

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, 7
- common: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9
- content-script: 0
- offscreen: 0
- ui: 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9

Page Load Metrics (2328 ± 538 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	636	4525	1885	705	338
		domContentLoaded	1684	5338	2296	1106	531
		load	1694	5442	2328	1121	538
		domInteractive	31	238	86	59	28
		backgroundConnect	8	124	33	28	13
		firstReactRender	51	330	134	77	37
		getState	5	80	25	24	11
		initialActions	0	1	0	0	0
		loadScripts	1216	4061	1716	889	427
		setupStore	6	60	19	19	9
		uiStartup	1884	6402	2627	1306	627

Bundle size diffs

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

hjetpoluru · 2024-11-15T12:57:00Z

test/e2e/page-objects/pages/vault-decryptor-page.ts

+    this.driver = driver;
+  }
+
+  async check_pageIsLoaded(): Promise<void> {


hjetpoluru · 2024-11-15T13:01:37Z

test/e2e/vault-decryption-chrome.spec.ts

+        // we don't need to use navigate since MM will automatically open a new window in prod build
+        await driver.waitUntilXWindowHandles(2);
+
+        // we cannot use the customized driver functionsas there is no socket for window communications in prod builds


there is minor typo now we have approvals we could correct later. Able to understand too.

Looks like the PR is merged..

yeah this PR is merged, but i will open another PR soon, i will address comments in the next PR

Sure thanks @chloeYue

addressed here 902a275 in PR #28424

hjetpoluru · 2024-11-15T13:02:21Z

test/e2e/vault-decryption-chrome.spec.ts

+        await driver.waitUntilXWindowHandles(2);
+
+        // we cannot use the customized driver functionsas there is no socket for window communications in prod builds
+        const windowHandles = await driver.driver.getAllWindowHandles();


Could we use the one provided by Selenium?

chloeYue added 13 commits November 6, 2024 18:32

migrate import nft tests

f1c7747

migrate reveal srp tests

52d3c80

Merge branch 'migrate-srp-tests' into migrate-import-nft-tests

afb6552

migrate autodetect nft tests

200b48c

address comment

cb4a7ee

typo

743cd97

improve ts doc

5276590

Merge branch 'migrate-srp-tests' into develop

4e188f3

migrate vault decryption test

43d8d58

Merge branch 'develop' into migrate-import-nft-tests

3fa97d5

fix lint

60d54eb

Merge branch 'develop' into migrate-vault-decrption-tests

0daaa43

fix lint

eca3124

chloeYue added the team-extension-platform label Nov 12, 2024

chloeYue self-assigned this Nov 12, 2024

chloeYue requested a review from a team as a code owner November 12, 2024 09:06

chloeYue marked this pull request as draft November 12, 2024 09:06

chloeYue added 9 commits November 12, 2024 10:24

Merge branch 'develop' into migrate-import-nft-tests

1f9df48

fix lint

38cbfd0

improve function name

0c7b8c6

remobe unused function

2b8912e

fix function name

9ca7e4f

fix lint

b5ba5fb

Merge branch 'migrate-import-nft-tests' into migrate-vault-decrption-…

1f54c9b

…tests

remove unused function

2c8fcd1

remove migrated functions

c1e6432

Merge branch 'develop' into migrate-vault-decrption-tests

6802853

chloeYue changed the title ~~test: Migrate vault decrption tests~~ test: [POM] Migrate vault decrption e2e tests to use Page Object Model Nov 13, 2024

adjust default parameter

1fc9eb9

chloeYue commented Nov 13, 2024

View reviewed changes

test/e2e/page-objects/pages/settings/privacy-settings.ts Show resolved Hide resolved

DDDDDanica previously approved these changes Nov 13, 2024

View reviewed changes

chloeYue requested review from seaona and hjetpoluru November 13, 2024 16:20

seaona reviewed Nov 14, 2024

View reviewed changes

test/e2e/vault-decryption-chrome.spec.ts Outdated Show resolved Hide resolved

seaona reviewed Nov 14, 2024

View reviewed changes

test/e2e/page-objects/flows/onboarding.flow.ts Outdated Show resolved Hide resolved

seaona previously approved these changes Nov 14, 2024

View reviewed changes

Update test/e2e/vault-decryption-chrome.spec.ts

23054d2

Co-authored-by: seaona <[email protected]>

chloeYue dismissed stale reviews from seaona and DDDDDanica via 23054d2 November 14, 2024 14:12

chloeYue and others added 2 commits November 14, 2024 15:22

address comment

25e9b51

Merge branch 'develop' into migrate-vault-decrption-tests

9eeaaba

chloeYue requested review from seaona and DDDDDanica November 14, 2024 15:35

seaona approved these changes Nov 15, 2024

View reviewed changes

DDDDDanica approved these changes Nov 15, 2024

View reviewed changes

chloeYue added this pull request to the merge queue Nov 15, 2024

Merged via the queue into develop with commit 5990644 Nov 15, 2024
77 checks passed

chloeYue deleted the migrate-vault-decrption-tests branch November 15, 2024 12:56

github-actions bot locked and limited conversation to collaborators Nov 15, 2024

hjetpoluru reviewed Nov 15, 2024

View reviewed changes

metamaskbot added the release-12.8.0 Issue or pull request that will be included in release 12.8.0 label Nov 15, 2024

hjetpoluru reviewed Nov 15, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test: [POM] Migrate vault decryption e2e tests to TS and Page Object Model #28419

test: [POM] Migrate vault decryption e2e tests to TS and Page Object Model #28419

chloeYue commented Nov 12, 2024 •

edited

Loading

github-actions bot commented Nov 12, 2024

metamaskbot commented Nov 12, 2024

metamaskbot commented Nov 13, 2024

metamaskbot commented Nov 13, 2024

DDDDDanica commented Nov 13, 2024

seaona left a comment

metamaskbot commented Nov 14, 2024

hjetpoluru Nov 15, 2024

hjetpoluru Nov 15, 2024

hjetpoluru Nov 15, 2024

chloeYue Nov 15, 2024

hjetpoluru Nov 15, 2024

chloeYue Nov 15, 2024 •

edited

Loading

hjetpoluru Nov 15, 2024

test: [POM] Migrate vault decryption e2e tests to TS and Page Object Model #28419

test: [POM] Migrate vault decryption e2e tests to TS and Page Object Model #28419

Conversation

chloeYue commented Nov 12, 2024 • edited Loading

Description

Related issues

Manual testing steps

Screenshots/Recordings

Before

After

Pre-merge author checklist

Pre-merge reviewer checklist

github-actions bot commented Nov 12, 2024

metamaskbot commented Nov 12, 2024

metamaskbot commented Nov 13, 2024

metamaskbot commented Nov 13, 2024

DDDDDanica commented Nov 13, 2024

seaona left a comment

Choose a reason for hiding this comment

metamaskbot commented Nov 14, 2024

hjetpoluru Nov 15, 2024

Choose a reason for hiding this comment

hjetpoluru Nov 15, 2024

Choose a reason for hiding this comment

hjetpoluru Nov 15, 2024

Choose a reason for hiding this comment

chloeYue Nov 15, 2024

Choose a reason for hiding this comment

hjetpoluru Nov 15, 2024

Choose a reason for hiding this comment

chloeYue Nov 15, 2024 • edited Loading

Choose a reason for hiding this comment

hjetpoluru Nov 15, 2024

Choose a reason for hiding this comment

chloeYue commented Nov 12, 2024 •

edited

Loading

chloeYue Nov 15, 2024 •

edited

Loading