test: fix flaky test Increase Token Allowance increases token spending cap to allow other accounts to transfer tokens @no-mmi

[seaona]

Description

This PR fixes the flaky test Increase Token Allowance increases token spending cap to allow other accounts to transfer tokens @no-mmi).
The problem with this flaky test is that we are changing the allowance amount (from 0 to 1) and we confirm the transaction before the gas has been updated. This makes that the increase token allowance transaction fails, and the subsequent transaction with the Account 2 cannot be performed as it doesn't have the allowance for doing a transfer from action. So the dialog window cannot be found, as the popup is never triggered (see dapp error).

The fix is to simply await for the expected gas for the increaseAllowance with amount 1.

This can be clearly seen when you check the tx history from Account 1:

• Here is a successful increaseAllowance with amount 1, and the total gas is 31000 -- correct

• Here is a failed increaseAllowance with amount 1, and the total gas limit is 26776 -- incorrect (this value corresponds to the increaseAllowance with amount 0)

Related issues

Fixes: one of this cases, but not all of them, as the rest of testcases need to be looked separately #24603

Manual testing steps

1. Run this test locally multiple times
2. Check ci jobs yarn test:e2e:single test/e2e/tests/tokens/increase-token-allowance.spec.js --browser=firefox --leave-running --retryUntilFailure --retries=10

Screenshots/Recordings

increase-token-allowance-flaky.mp4

Pre-merge author checklist

• I’ve followed MetaMask 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]

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.

[seaona]

this await was missing, but it's not the cause of the flakiness

[hjetpoluru]

Nice catch.

[seaona]

here we await for the correct gas estimate. This way we ensure that the increaseAllowance tx is successful and we can proceed with the transferFrom, from account 2

[legobeat]

(could) add explicit expected maximum timeout in seconds here

[seaona]

thank you for the review @legobeat 🙇‍♀️ I think in this case is safe to rely on the default timeout, since I've observed that the gas update is really a matter of ms, so the default timeout seems more than enough.
But let me know if you think otherwise and we could add it 🙏

async waitForSelector(
    rawLocator,
    { timeout = this.timeout, state = 'visible' } = {}

[seaona]

ℹ️ after talking with Lego, we've agreed to merge this PR but we could have another task to look into explicit timeouts more generally

[metamaskbot]

Builds ready [798cf22]

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

Page Load Metrics (904 ± 550 ms)

Platform	Page	Metric	Min (ms)	Max (ms)	Average (ms)	StandardDeviation (ms)	MarginOfError (ms)
Chrome	Home	firstPaint	61	169	101	34	16
		domContentLoaded	8	50	17	11	5
		load	49	2661	904	1145	550
		domInteractive	8	50	17	11	5

Bundle size diffs

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

[metamaskbot]

Missing release label release-11.16.3 on PR. Adding release label release-11.16.3 on PR and removing other release labels(release-11.18.0), as PR was cherry-picked in branch 11.16.3.