Skip to content

Commit

Permalink
test: Improve test for signatures (#27532)
Browse files Browse the repository at this point in the history
<!--
Please submit this PR as a draft initially.
Do not mark it as "Ready for review" until the template has been
completely filled out, and PR status checks have passed at least once.
-->

## **Description**

The current mock server setup injects all mocks at the beginning of the
test, which can lead to delays. Specifically, when we assert the account
details opened metric, only the relevant endpoint for that metric gets
triggered, while other mocks, like "signature approved," may not be
invoked yet. Although this doesn’t cause the test to fail, it results in
unnecessarily long wait times during the test, as the framework waits
for mocks that haven’t been triggered.

This PR addresses the issue by moving the metric assertions to the end
of the test. By doing so, we eliminate the idle waiting period,
streamlining the test flow and reducing overall test execution time.

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/27532?quickstart=1)

## **Related issues**

Fixes:
[#19823](#19823)

## **Manual testing steps**

1. Go to this page...
2.
3.

## **Screenshots/Recordings**

<!-- If applicable, add screenshots and/or recordings to visualize the
before and after of your change. -->

### **Before**

<!-- [screenshots/recordings] -->

### **After**

<!-- [screenshots/recordings] -->

## **Pre-merge author checklist**

- [ ] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding
Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md).
- [ ] 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](https://jsdoc.app/) format
if applicable
- [ ] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/LABELING_GUIDELINES.md)).
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.
  • Loading branch information
pnarayanaswamy authored Nov 14, 2024
1 parent 072c8c7 commit 8441041
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 20 deletions.
11 changes: 6 additions & 5 deletions test/e2e/tests/confirmations/signatures/personal-sign.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,17 +43,18 @@ describe('Confirmation Signature - Personal Sign @no-mmi', function (this: Suite

await copyAddressAndPasteWalletAddress(driver);
await assertPastedAddress(driver);
await assertAccountDetailsMetrics(
driver,
mockedEndpoints as MockedEndpoint[],
'personal_sign',
);
await driver.switchToWindowWithTitle(WINDOW_TITLES.Dialog);
await assertInfoValues(driver);

await driver.clickElement('[data-testid="confirm-footer-button"]');

await assertVerifiedPersonalMessage(driver, publicAddress);

await assertAccountDetailsMetrics(
driver,
mockedEndpoints as MockedEndpoint[],
'personal_sign',
);
await assertSignatureConfirmedMetrics({
driver,
mockedEndpoints: mockedEndpoints as MockedEndpoint[],
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,15 +47,17 @@ describe('Confirmation Signature - Sign Typed Data V3 @no-mmi', function (this:

await copyAddressAndPasteWalletAddress(driver);
await assertPastedAddress(driver);
await driver.switchToWindowWithTitle(WINDOW_TITLES.Dialog);
await driver.delay(1000);

await assertInfoValues(driver);
await scrollAndConfirmAndAssertConfirm(driver);

await assertAccountDetailsMetrics(
driver,
mockedEndpoints as MockedEndpoint[],
'eth_signTypedData_v3',
);
await driver.switchToWindowWithTitle(WINDOW_TITLES.Dialog);

await assertInfoValues(driver);
await scrollAndConfirmAndAssertConfirm(driver);
await assertSignatureConfirmedMetrics({
driver,
mockedEndpoints: mockedEndpoints as MockedEndpoint[],
Expand Down
11 changes: 5 additions & 6 deletions test/e2e/tests/confirmations/signatures/sign-typed-data.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,17 +43,16 @@ describe('Confirmation Signature - Sign Typed Data @no-mmi', function (this: Sui

await copyAddressAndPasteWalletAddress(driver);
await assertPastedAddress(driver);
await assertAccountDetailsMetrics(
driver,
mockedEndpoints as MockedEndpoint[],
'eth_signTypedData',
);

await assertInfoValues(driver);

await driver.clickElement('[data-testid="confirm-footer-button"]');
await driver.delay(1000);

await assertAccountDetailsMetrics(
driver,
mockedEndpoints as MockedEndpoint[],
'eth_signTypedData',
);
await assertSignatureConfirmedMetrics({
driver,
mockedEndpoints: mockedEndpoints as MockedEndpoint[],
Expand Down
11 changes: 6 additions & 5 deletions test/e2e/tests/confirmations/signatures/siwe.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,6 @@ describe('Confirmation Signature - SIWE @no-mmi', function (this: Suite) {

await copyAddressAndPasteWalletAddress(driver);
await assertPastedAddress(driver);
await assertAccountDetailsMetrics(
driver,
mockedEndpoints as MockedEndpoint[],
'personal_sign',
);
await driver.switchToWindowWithTitle(WINDOW_TITLES.Dialog);
await assertInfoValues(driver);
await scrollAndConfirmAndAssertConfirm(driver);
Expand All @@ -56,6 +51,12 @@ describe('Confirmation Signature - SIWE @no-mmi', function (this: Suite) {
driver,
'0xef8674a92d62a1876624547bdccaef6c67014ae821de18fa910fbff56577a65830f68848585b33d1f4b9ea1c3da1c1b11553b6aabe8446717daf7cd1e38a68271c',
);

await assertAccountDetailsMetrics(
driver,
mockedEndpoints as MockedEndpoint[],
'personal_sign',
);
await assertSignatureConfirmedMetrics({
driver,
mockedEndpoints: mockedEndpoints as MockedEndpoint[],
Expand Down

0 comments on commit 8441041

Please sign in to comment.