test: [POM] Migrate hardware wallet e2e tests to follow Page Object Model #28768

chloeYue · 2024-11-27T13:03:22Z

Description

Create base pages for hardware wallet related pages
Migrate hardware wallet e2e tests to Page Object Model
Remove dead code (We should not keep unused functions in the codebase because they can lead to several issues, such as increased maintenance overhead, added complexity, potential bugs, and misleading information.)

Related issues

Fixes: #28808

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-27T13:03:36Z

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.

metamaskbot · 2024-11-27T15:04:25Z

Builds ready [9182760]

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 (1702 ± 69 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	305	2101	1635	337	162
		domContentLoaded	1506	2073	1672	142	68
		load	1546	2104	1702	144	69
		domInteractive	25	109	37	22	10
		backgroundConnect	9	60	30	17	8
		firstReactRender	17	166	61	39	19
		getState	4	85	24	29	14
		initialActions	0	1	0	0	0
		loadScripts	1119	1579	1236	124	60
		setupStore	6	63	13	16	8
		uiStartup	1723	2486	2004	220	106

Bundle size diffs

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

metamaskbot · 2024-12-05T14:07:01Z

Builds ready [2eb0cfd]

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

Page Load Metrics (1911 ± 78 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1764	2341	1916	157	75
		domContentLoaded	1744	2194	1868	127	61
		load	1766	2358	1911	163	78
		domInteractive	25	58	33	9	4
		backgroundConnect	10	261	47	58	28
		firstReactRender	15	38	20	7	3
		getState	88	441	145	85	41
		initialActions	0	1	0	0	0
		loadScripts	1341	1759	1451	112	54
		setupStore	6	42	10	8	4
		uiStartup	2013	3189	2229	290	139

Bundle size diffs

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

chloeYue · 2024-12-05T14:41:40Z

test/e2e/page-objects/pages/test-dapp.ts

   */
-  async signTypedDataV4() {
+  async signTypedDataV4(confirmationRedesign: boolean = false) {


Keep the confirmationRedesign as a parameter as a temporary solution, will do the refacto once the redesign toggle is removed, as planned in MetaMask-planning issue #3030.

metamaskbot · 2024-12-05T14:43:47Z

Builds ready [524a8fb]

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

Page Load Metrics (2034 ± 106 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	532	2493	1952	389	187
		domContentLoaded	1664	2447	2008	212	102
		load	1674	2498	2034	220	106
		domInteractive	25	114	42	23	11
		backgroundConnect	10	78	24	20	10
		firstReactRender	16	96	28	22	11
		getState	102	293	152	56	27
		initialActions	0	1	0	0	0
		loadScripts	1249	1881	1560	185	89
		setupStore	7	83	12	16	8
		uiStartup	1911	2925	2393	319	153

Bundle size diffs

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

metamaskbot · 2024-12-08T22:06:14Z

Builds ready [89e2f7a]

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

Page Load Metrics (1625 ± 36 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	1502	1774	1630	78	37
		domContentLoaded	1489	1735	1610	71	34
		load	1497	1767	1625	76	36
		domInteractive	23	63	32	13	6
		backgroundConnect	8	45	16	12	6
		firstReactRender	14	89	18	16	8
		getState	73	298	115	43	21
		initialActions	0	0	0	0	0
		loadScripts	1154	1380	1268	67	32
		setupStore	6	25	8	4	2
		uiStartup	1692	2459	1860	160	77

Bundle size diffs

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

test/e2e/tests/hardware-wallets/lattice-connect.spec.ts

test/e2e/tests/hardware-wallets/trezor-account.spec.ts

hjetpoluru

Nice job @chloeYue, I notice minot observation otherwise everything is looking good.

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

metamaskbot · 2024-12-09T18:37:44Z

Builds ready [bc3c4e1]

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

Page Load Metrics (1862 ± 92 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	741	2311	1795	304	146
		domContentLoaded	1578	2293	1844	190	91
		load	1586	2314	1862	193	92
		domInteractive	24	212	50	47	23
		backgroundConnect	7	63	22	16	8
		firstReactRender	15	91	22	16	8
		getState	72	391	129	63	30
		initialActions	0	0	0	0	0
		loadScripts	1224	1919	1427	177	85
		setupStore	7	19	8	3	1
		uiStartup	1780	2695	2127	246	118

Bundle size diffs

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

test/e2e/page-objects/pages/hardware-wallet/connect-hardware-wallet-page.ts

test/e2e/page-objects/pages/hardware-wallet/select-trezor-account-page.ts

test/e2e/tests/hardware-wallets/trezor-account.spec.ts

test/e2e/page-objects/pages/account-list-page.ts

…allet-page.ts Co-authored-by: Derek Brans <[email protected]>

…sk/metamask-extension into hardware-wallet-migration

metamaskbot · 2024-12-10T10:16:46Z

Builds ready [d31ac54]

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

Page Load Metrics (1931 ± 63 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	561	2198	1863	326	156
		domContentLoaded	1617	2163	1905	126	61
		load	1621	2200	1931	131	63
		domInteractive	26	61	40	12	6
		backgroundConnect	7	64	26	21	10
		firstReactRender	17	90	28	21	10
		getState	106	309	146	53	26
		initialActions	0	1	0	0	0
		loadScripts	1217	1767	1491	121	58
		setupStore	7	13	9	2	1
		uiStartup	1876	2855	2278	213	102

Bundle size diffs

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

dbrans

Nice work, Chloe!

test/e2e/page-objects/pages/home/asset-list.ts

test/e2e/tests/hardware-wallets/lattice-connect.spec.ts

seaona · 2024-12-12T14:25:59Z

test/e2e/tests/hardware-wallets/trezor-sign.spec.ts

+        const testDappPage = new TestDappPage(driver);
+        await testDappPage.openTestDappPage();
+        await testDappPage.check_pageIsLoaded();
+        await testDappPage.signTypedDataV4(true);


I think passing an object with the flag name, would make it clearer what this boolean is actually indicating. However given that handling redesign/no-redesign is temporary I think it's fine as it is

yeah it's a very temporary solution. Let's wait for the removal of the toggle as planned in this ticket, and then we can refactor the redesign together with other parts of the testing code to keep them coherent.

seaona

LGTM!!

chloeYue added 3 commits November 27, 2024 09:21

migrate tests

d1011e7

Merge branch 'develop' into hardware-wallet-migration

4addcc8

reduce flainess

26e0385

chloeYue added the team-extension-platform Extension Platform team label Nov 27, 2024

chloeYue self-assigned this Nov 27, 2024

chloeYue requested a review from a team as a code owner November 27, 2024 13:03

chloeYue marked this pull request as draft November 27, 2024 13:03

chloeYue and others added 2 commits November 27, 2024 15:29

fix test

2bed54d

Merge branch 'develop' into hardware-wallet-migration

9182760

chloeYue and others added 6 commits December 5, 2024 13:08

Merge branch 'main' into hardware-wallet-migration

d47c0be

remove dead code

e6bc5e2

test

d9dfe15

fix lint

671ca43

fix lint

63ddb08

Merge branch 'main' into hardware-wallet-migration

2eb0cfd

revert changes

524a8fb

chloeYue changed the title ~~test: DRAFT Hardware wallet migration~~ test: [POM] Migrate hardware wallet e2e tests to follow Page Object Model Dec 5, 2024

chloeYue commented Dec 5, 2024

View reviewed changes

Merge branch 'main' into hardware-wallet-migration

89e2f7a

chloeYue marked this pull request as ready for review December 9, 2024 09:27

hjetpoluru reviewed Dec 9, 2024

View reviewed changes

test/e2e/tests/hardware-wallets/lattice-connect.spec.ts Outdated Show resolved Hide resolved

hjetpoluru reviewed Dec 9, 2024

View reviewed changes

test/e2e/tests/hardware-wallets/trezor-account.spec.ts Outdated Show resolved Hide resolved

hjetpoluru self-requested a review December 9, 2024 17:51

hjetpoluru previously approved these changes Dec 9, 2024

View reviewed changes

Update test/e2e/tests/hardware-wallets/lattice-connect.spec.ts

ef9fe3a

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

chloeYue dismissed hjetpoluru’s stale review via ef9fe3a December 9, 2024 17:54

address comment

bc3c4e1

hjetpoluru self-requested a review December 9, 2024 18:06

hjetpoluru previously approved these changes Dec 9, 2024

View reviewed changes

dbrans reviewed Dec 9, 2024

View reviewed changes

Update test/e2e/page-objects/pages/hardware-wallet/connect-hardware-w…

0a39734

…allet-page.ts Co-authored-by: Derek Brans <[email protected]>

chloeYue dismissed hjetpoluru’s stale review via 0a39734 December 10, 2024 08:25

chloeYue and others added 5 commits December 10, 2024 09:42

Update test/e2e/page-objects/pages/hardware-wallet/connect-hardware-w…

63d6ba7

…allet-page.ts Co-authored-by: Derek Brans <[email protected]>

add comment

5c6702b

Merge branch 'hardware-wallet-migration' of https://github.com/MetaMa…

ca8ac74

…sk/metamask-extension into hardware-wallet-migration

Merge branch 'main' into hardware-wallet-migration

f5f443f

fix lint

d31ac54

chloeYue requested review from dbrans, hjetpoluru and seaona December 10, 2024 15:05

dbrans self-assigned this Dec 10, 2024

dbrans approved these changes Dec 11, 2024

View reviewed changes

seaona reviewed Dec 12, 2024

View reviewed changes

test/e2e/page-objects/pages/home/asset-list.ts Show resolved Hide resolved

seaona reviewed Dec 12, 2024

View reviewed changes

test/e2e/tests/hardware-wallets/lattice-connect.spec.ts Show resolved Hide resolved

seaona reviewed Dec 12, 2024

View reviewed changes

seaona approved these changes Dec 12, 2024

View reviewed changes

chloeYue added this pull request to the merge queue Dec 12, 2024

Merged via the queue into main with commit c065d93 Dec 12, 2024
75 checks passed

chloeYue deleted the hardware-wallet-migration branch December 12, 2024 15:13

github-actions bot locked and limited conversation to collaborators Dec 12, 2024

metamaskbot added the release-12.10.0 Issue or pull request that will be included in release 12.10.0 label Dec 12, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test: [POM] Migrate hardware wallet e2e tests to follow Page Object Model #28768

test: [POM] Migrate hardware wallet e2e tests to follow Page Object Model #28768

chloeYue commented Nov 27, 2024 •

edited

Loading

github-actions bot commented Nov 27, 2024

metamaskbot commented Nov 27, 2024

metamaskbot commented Dec 5, 2024

chloeYue Dec 5, 2024 •

edited

Loading

metamaskbot commented Dec 5, 2024

metamaskbot commented Dec 8, 2024

hjetpoluru left a comment

metamaskbot commented Dec 9, 2024

metamaskbot commented Dec 10, 2024

dbrans left a comment

seaona Dec 12, 2024

chloeYue Dec 12, 2024 •

edited

Loading

seaona left a comment

test: [POM] Migrate hardware wallet e2e tests to follow Page Object Model #28768

test: [POM] Migrate hardware wallet e2e tests to follow Page Object Model #28768

Conversation

chloeYue commented Nov 27, 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 27, 2024

metamaskbot commented Nov 27, 2024

metamaskbot commented Dec 5, 2024

chloeYue Dec 5, 2024 • edited Loading

Choose a reason for hiding this comment

metamaskbot commented Dec 5, 2024

metamaskbot commented Dec 8, 2024

hjetpoluru left a comment

Choose a reason for hiding this comment

metamaskbot commented Dec 9, 2024

metamaskbot commented Dec 10, 2024

dbrans left a comment

Choose a reason for hiding this comment

seaona Dec 12, 2024

Choose a reason for hiding this comment

chloeYue Dec 12, 2024 • edited Loading

Choose a reason for hiding this comment

seaona left a comment

Choose a reason for hiding this comment

chloeYue commented Nov 27, 2024 •

edited

Loading

chloeYue Dec 5, 2024 •

edited

Loading

chloeYue Dec 12, 2024 •

edited

Loading