fix: Flaky test `Account Custom Name..` #26062

hjetpoluru · 2024-07-23T19:18:06Z

Description

This PR address the fix flaky test related to the Account Custom Name Persistence persists custom account label through account change and wallet lock

Based on the screenshot from the pipeline, the Create button could not be clicked. Therefore, it has been replaced with the clickElementAndWaitToDisappear function.

https://app.circleci.com/pipelines/github/MetaMask/metamask-extension/92651/workflows/dac61e17-caa2-44ab-979c-05c38b16541b/jobs/3449337/tests

ElementClickInterceptedError: Element <button class="mm-box mm-text mm-button-base mm-button-base--size-sm mm-button-base--ellipsis multichain-account-picker mm-text--body-md-medium mm-text--ellipsis mm-box--padding-0 mm-box--padding-right-2 mm-box--padding-left-2 mm-box--display-inline-flex mm-box--gap-2 mm-box--justify-content-center mm-box--align-items-center mm-box--color-text-default mm-box--background-color-transparent mm-box--rounded-lg"> is not clickable at point (575,112) because another element <label class="mm-box mm-text mm-label mm-label--html-for mm-form-text-field__label mm-text--body-md mm-text--font-weight-medium mm-box--display-inline-flex mm-box--align-items-center mm-box--color-text-default"> obscures it

Related issues

Fixes:
#26061

Manual testing steps

Execute the test locally or codespaces using below commands:
yarn
ENABLE_MV3=false yarn build:test:flask
ENABLE_MV3=false yarn test:e2e:single test/e2e/accounts/create-snap-account.spec.ts --browser=firefox

There should not be CI failures related to the test.

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-07-23T19:18:21Z

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.

greptile-apps

PR Summary

The PR addresses a flaky test issue by modifying the test script to ensure the 'Create' button is properly clicked and waits for it to disappear.

Modified test/e2e/accounts/account-custom-name.spec.ts to replace clickElement with clickElementAndWaitToDisappear for the 'Create' button.
This change ensures the test waits for the 'Create' button to disappear after being clicked, improving reliability.
Fixes issue Flaky test - Account Custom Name Persistence persists custom account label through account change and wallet lock #26061 related to the Account Custom Name Persistence test.

_{1 file(s) reviewed, no comment(s)}
_{Edit PR Review Bot Settings}

… fix-flaky-test-custom-name

greptile-apps

PR Summary

(updates since last review)

The PR addresses a flaky test issue by modifying the test script to ensure the 'Create' button is properly clicked and waits for it to disappear.

Modified test/e2e/accounts/account-custom-name.spec.ts to replace clickElement with clickElementAndWaitToDisappear for the 'Create' button.
Removed test-e2e-swap-playwright job from .circleci/config.yml to streamline the CI pipeline.
Added SWAP_TEST_ETH_USDC_TRADES_MOCK in test/data/mock-data.js for enhanced swap test scenarios.
Simplified logic in test/e2e/api-specs/ConfirmationRejectionRule.ts by removing conditional checks for 'Reject' button.
Updated test/e2e/helpers.js to add checks for specific selectors, reducing flaky tests.

_{24 file(s) reviewed, no comment(s)}
_{Edit PR Review Bot Settings}

plasmacorral

LGTM, Thank you!

Missed a lint error

greptile-apps

PR Summary

(updates since last review)

This PR addresses a flaky test issue in the Account Custom Name Persistence test suite by ensuring the 'Create' button is clicked successfully, even when obscured by other elements.

Modified test/e2e/accounts/account-custom-name.spec.ts to replace clickElement with clickElementAndWaitToDisappear for the 'Create' button.

_{1 file(s) reviewed, no comment(s)}
_{Edit PR Review Bot Settings}

plasmacorral

Fixed linting and ran locally on both Firefox and Chrome. LGTM.

…mask-extension into fix-flaky-test-custom-name

… fix-flaky-test-custom-name

greptile-apps

PR Summary

(updates since last review)

This PR addresses a flaky test issue in the Account Custom Name Persistence test suite by ensuring the 'Create' button is clicked successfully, even when obscured by other elements.

Modified test/e2e/accounts/account-custom-name.spec.ts to replace clickElement with clickElementAndWaitToDisappear for the 'Create' button.

_{No file(s) reviewed, no comment(s)}
_{Edit PR Review Bot Settings}

sonarcloud · 2024-07-23T20:09:06Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarCloud

greptile-apps

PR Summary

(updates since last review)

This PR addresses a flaky test related to the Account Custom Name Persistence by ensuring the 'Create' button is clicked successfully, even when obscured by other elements.

Modified test/e2e/accounts/account-custom-name.spec.ts to replace clickElement with clickElementAndWaitToDisappear for the 'Create' button.
Removed 'sendAToken' message key from multiple localization files (app/_locales/*/messages.json), ensuring no references remain in the codebase.
Enhanced ui/components/multichain/asset-picker-amount/asset-picker-modal/asset-picker-modal.tsx by adding additional props to the Search component and adjusting padding/margin properties.
Introduced textProps to ui/components/multichain/pages/page/components/header/header.tsx for more flexible customization of the Text component.
Updated header text and properties in ui/components/multichain/pages/send/send.js to improve UI consistency.

_{18 file(s) reviewed, no comment(s)}
_{Edit PR Review Bot Settings}

HowardBraham

The test failures are not related to this PR

chloeYue

LGTM! Thanks for the quick fix!

… fix-flaky-test-custom-name

greptile-apps

PR Summary

(updates since last review)

This PR addresses a flaky test related to the Account Custom Name Persistence by ensuring the 'Create' button is clicked successfully, even when obscured by other elements.

Modified test/e2e/accounts/account-custom-name.spec.ts to replace clickElement with clickElementAndWaitToDisappear for the 'Create' button.
Updated app/scripts/background.js to conditionally initialize getSocketBackgroundToMocha during test builds.
Added server-mocha-to-background.ts and socket-background-to-mocha.ts for improved communication between Mocha/Selenium tests and the background script.
Enhanced test/e2e/helpers.js with a new clickElementSafe helper function to improve test reliability.
Updated package.json to include new dependencies and devDependencies for enhanced functionality and compatibility.

_{71 file(s) reviewed, no comment(s)}
_{Edit PR Review Bot Settings}

… fix-flaky-test-custom-name

greptile-apps

PR Summary

(updates since last review)

This PR addresses a flaky test related to the Account Custom Name Persistence by ensuring the 'Create' button is clicked successfully, even when obscured by other elements.

Modified test/e2e/tests/settings/show-hex-data.spec.js to update selectors and add conditional logic for different environments.
Updated clickElementsInSequence function to include a conditional check for the MMI environment variable.
Improved reliability of the test by ensuring correct elements are interacted with, especially in different environments.

_{1 file(s) reviewed, no comment(s)}
_{Edit PR Review Bot Settings}

… fix-flaky-test-custom-name

greptile-apps

PR Summary

(updates since last review)

This PR addresses a flaky test related to the Account Custom Name Persistence by ensuring the 'Create' button is clicked successfully, even when obscured by other elements.

Modified test/e2e/accounts/account-custom-name.spec.ts to use clickElementAndWaitToDisappear for the 'Create' button.
Refactored development/generate-rc-commits.js to fetch author-team mappings from an external teams.json file, improving maintainability.
Added error handling for fetching teams.json and ensured JSON structure correctness.

No major changes found since the last review.

_{1 file(s) reviewed, no comment(s)}
_{Edit PR Review Bot Settings}

… fix-flaky-test-custom-name

greptile-apps

PR Summary

(updates since last review)

This PR addresses a flaky test related to the Account Custom Name Persistence by ensuring the 'Create' button is clicked successfully, even when obscured by other elements.

Modified test/e2e/accounts/account-custom-name.spec.ts to use clickElementAndWaitToDisappear for the 'Create' button.
Updated test/e2e/vault-decryption-chrome.spec.js to improve test stability by adding disableServerMochaToBackground and ensuring correct window handling.
Replaced Typography with Text component in ui/pages/onboarding-flow/creation-successful/creation-successful.js for design consistency.

_{2 file(s) reviewed, no comment(s)}
_{Edit PR Review Bot Settings}

hjetpoluru · 2024-07-24T17:10:34Z

As @HowardBraham mentioned, we will be unable to merge this PR until the other tests are addressed.

… fix-flaky-test-custom-name

sonarcloud · 2024-07-24T19:58:44Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

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

See analysis details on SonarCloud

greptile-apps

PR Summary

(updates since last review)

This PR addresses a flaky test related to the Account Custom Name Persistence by ensuring the 'Create' button is clicked successfully, even when obscured by other elements.

test/e2e/accounts/account-custom-name.spec.ts: Replaced clickElement with clickElementAndWaitToDisappear for the 'Create' button to ensure it is clicked even when obscured.
test/e2e/webdriver/chrome.js: Locked ChromeDriver to version 126 to maintain test stability.
ui/components/app/import-token/token-list/token-list.component.js: Removed showHalo prop from AvatarToken component.
ui/components/multichain/asset-picker-amount/asset-picker/asset-picker.tsx: Removed showHalo prop from AvatarToken component.
ui/components/multichain/import-tokens-modal/import-tokens-modal-confirm.js: Removed showHalo prop from AvatarToken component.

_{5 file(s) reviewed, no comment(s)}
_{Edit PR Review Bot Settings}

codecov · 2024-07-24T20:18:43Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.67%. Comparing base (335c497) to head (429068f).
Report is 1 commits behind head on develop.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop   #26062   +/-   ##
========================================
  Coverage    69.67%   69.67%           
========================================
  Files         1405     1405           
  Lines        49728    49728           
  Branches     13748    13748           
========================================
  Hits         34646    34646           
  Misses       15082    15082

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

metamaskbot · 2024-07-24T20:29:05Z

Builds ready [429068f]

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
- common: 0, 1, 10, 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 (305 ± 254 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	69	277	123	50	24
		domContentLoaded	9	139	38	29	14
		load	43	1648	305	528	254
		domInteractive	9	139	38	29	14

Bundle size diffs

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

Replaced the clickElement to clickElementAndWaitToDisappear

cece0a8

hjetpoluru requested review from HowardBraham, vthomas13, plasmacorral, seaona and chloeYue July 23, 2024 19:18

hjetpoluru requested a review from a team as a code owner July 23, 2024 19:18

hjetpoluru self-assigned this Jul 23, 2024

hjetpoluru added flaky tests team-extension-platform labels Jul 23, 2024

greptile-apps bot reviewed Jul 23, 2024

View reviewed changes

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

Merge branch 'develop' of github.com:MetaMask/metamask-extension into…

29e824d

… fix-flaky-test-custom-name

greptile-apps bot reviewed Jul 23, 2024

View reviewed changes

plasmacorral previously approved these changes Jul 23, 2024

View reviewed changes

linting

c3e2521

greptile-apps bot reviewed Jul 23, 2024

View reviewed changes

plasmacorral self-requested a review July 23, 2024 20:05

Fixed lint

793bd84

plasmacorral approved these changes Jul 23, 2024

View reviewed changes

hjetpoluru added 2 commits July 23, 2024 16:06

Merge branch 'fix-flaky-test-custom-name' of github.com:MetaMask/meta…

62f8c64

…mask-extension into fix-flaky-test-custom-name

Merge branch 'develop' of github.com:MetaMask/metamask-extension into…

3eba1d9

… fix-flaky-test-custom-name

greptile-apps bot reviewed Jul 23, 2024

View reviewed changes

HowardBraham approved these changes Jul 23, 2024

View reviewed changes

chloeYue approved these changes Jul 24, 2024

View reviewed changes

Merge branch 'develop' of github.com:MetaMask/metamask-extension into…

015dcde

… fix-flaky-test-custom-name

greptile-apps bot reviewed Jul 24, 2024

View reviewed changes

Merge branch 'develop' of github.com:MetaMask/metamask-extension into…

5827df4

… fix-flaky-test-custom-name

greptile-apps bot reviewed Jul 24, 2024

View reviewed changes

Merge branch 'develop' of github.com:MetaMask/metamask-extension into…

81b5d2b

… fix-flaky-test-custom-name

greptile-apps bot reviewed Jul 24, 2024

View reviewed changes

Merge branch 'develop' of github.com:MetaMask/metamask-extension into…

cb671da

… fix-flaky-test-custom-name

greptile-apps bot reviewed Jul 24, 2024

View reviewed changes

Merge branch 'develop' of github.com:MetaMask/metamask-extension into…

429068f

… fix-flaky-test-custom-name

greptile-apps bot reviewed Jul 24, 2024

View reviewed changes

plasmacorral merged commit 83e4b2a into develop Jul 24, 2024
76 checks passed

plasmacorral deleted the fix-flaky-test-custom-name branch July 24, 2024 22:04

github-actions bot locked and limited conversation to collaborators Jul 24, 2024

metamaskbot added the release-12.3.0 Issue or pull request that will be included in release 12.3.0 label Jul 24, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Flaky test `Account Custom Name..` #26062

fix: Flaky test `Account Custom Name..` #26062

hjetpoluru commented Jul 23, 2024 •

edited by plasmacorral

Loading

github-actions bot commented Jul 23, 2024

greptile-apps bot left a comment

greptile-apps bot left a comment

plasmacorral left a comment •

edited

Loading

greptile-apps bot left a comment

plasmacorral left a comment

greptile-apps bot left a comment

sonarcloud bot commented Jul 23, 2024

greptile-apps bot left a comment

HowardBraham left a comment

chloeYue left a comment

greptile-apps bot left a comment

greptile-apps bot left a comment

greptile-apps bot left a comment

greptile-apps bot left a comment

hjetpoluru commented Jul 24, 2024

sonarcloud bot commented Jul 24, 2024

greptile-apps bot left a comment

codecov bot commented Jul 24, 2024 •

edited

Loading

metamaskbot commented Jul 24, 2024

fix: Flaky test Account Custom Name.. #26062

fix: Flaky test Account Custom Name.. #26062

Conversation

hjetpoluru commented Jul 23, 2024 • edited by plasmacorral Loading

Description

Related issues

Manual testing steps

Pre-merge author checklist

Pre-merge reviewer checklist

github-actions bot commented Jul 23, 2024

greptile-apps bot left a comment

Choose a reason for hiding this comment

PR Summary

greptile-apps bot left a comment

Choose a reason for hiding this comment

PR Summary

plasmacorral left a comment • edited Loading

Choose a reason for hiding this comment

greptile-apps bot left a comment

Choose a reason for hiding this comment

PR Summary

plasmacorral left a comment

Choose a reason for hiding this comment

greptile-apps bot left a comment

Choose a reason for hiding this comment

PR Summary

sonarcloud bot commented Jul 23, 2024

Quality Gate passed

greptile-apps bot left a comment

Choose a reason for hiding this comment

PR Summary

HowardBraham left a comment

Choose a reason for hiding this comment

chloeYue left a comment

Choose a reason for hiding this comment

greptile-apps bot left a comment

Choose a reason for hiding this comment

PR Summary

greptile-apps bot left a comment

Choose a reason for hiding this comment

PR Summary

greptile-apps bot left a comment

Choose a reason for hiding this comment

PR Summary

greptile-apps bot left a comment

Choose a reason for hiding this comment

PR Summary

hjetpoluru commented Jul 24, 2024

sonarcloud bot commented Jul 24, 2024

Quality Gate passed

greptile-apps bot left a comment

Choose a reason for hiding this comment

PR Summary

codecov bot commented Jul 24, 2024 • edited Loading

Codecov Report

metamaskbot commented Jul 24, 2024

fix: Flaky test `Account Custom Name..` #26062

fix: Flaky test `Account Custom Name..` #26062

hjetpoluru commented Jul 23, 2024 •

edited by plasmacorral

Loading

plasmacorral left a comment •

edited

Loading

codecov bot commented Jul 24, 2024 •

edited

Loading