Skip to content

Commit

Permalink
fix: cherry pick disable the confirm button when there is a blocking …
Browse files Browse the repository at this point in the history
…alert fix into 12.3.0 (#27354)

<!--
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**
This PR cherry-picks
#27347
<!--
Write a short description of the changes included in this pull request,
also include relevant motivation and context. Have in mind the following
questions:
1. What is the reason for the change?
2. What is the improvement/solution?
-->

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

## **Related issues**

Fixes: #27147

## **Manual testing steps**

Tested and approved by QA in original PR

## **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**

- [x] 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).
- [x] I've completed the PR template to the best of my ability
- [x] I’ve included tests if applicable
- [x] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [x] 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
vinistevam authored Sep 24, 2024
1 parent 080fd23 commit 24b5e1e
Show file tree
Hide file tree
Showing 4 changed files with 157 additions and 8 deletions.
85 changes: 85 additions & 0 deletions test/e2e/tests/confirmations/alerts/insufficient-funds.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
import { strict as assert } from 'assert';
import FixtureBuilder from '../../../fixture-builder';
import {
PRIVATE_KEY,
convertETHToHexGwei,
withFixtures,
WINDOW_TITLES,
} from '../../../helpers';
import { SMART_CONTRACTS } from '../../../seeder/smart-contracts';
import {
TestSuiteArguments,
openDAppWithContract,
} from '../transactions/shared';
import { Driver } from '../../../webdriver/driver';

describe('Alert for insufficient funds @no-mmi', function () {
it('Shows an alert when the user tries to send a transaction with insufficient funds', async function () {
const nftSmartContract = SMART_CONTRACTS.NFTS;
const ganacheOptions = {
accounts: [
{
secretKey: PRIVATE_KEY,
balance: convertETHToHexGwei(0.0053), // Low balance only to create the contract and then trigger the alert for insufficient funds
},
],
};
await withFixtures(
{
dapp: true,
fixtures: new FixtureBuilder()
.withPermissionControllerConnectedToTestDapp()
.withPreferencesController({
preferences: {
redesignedConfirmationsEnabled: true,
isRedesignedConfirmationsDeveloperEnabled: true,
},
})
.build(),
ganacheOptions,
smartContract: nftSmartContract,
title: this.test?.fullTitle(),
},
async ({ driver, contractRegistry }: TestSuiteArguments) => {
await openDAppWithContract(driver, contractRegistry, nftSmartContract);

await mintNft(driver);

await verifyAlertForInsufficientBalance(driver);

await verifyConfirmationIsDisabled(driver);
},
);
});
});

async function verifyConfirmationIsDisabled(driver: Driver) {
const confirmButton = await driver.findElement(
'[data-testid="confirm-footer-button"]',
);
assert.equal(await confirmButton.isEnabled(), false);
}

async function verifyAlertForInsufficientBalance(driver: Driver) {
const alert = await driver.findElement('[data-testid="inline-alert"]');
assert.equal(await alert.getText(), 'Alert');
await driver.clickElementSafe('.confirm-scroll-to-bottom__button');
await driver.clickElement('[data-testid="inline-alert"]');

const alertDescription = await driver.findElement(
'[data-testid="alert-modal__selected-alert"]',
);
const alertDescriptionText = await alertDescription.getText();
assert.equal(
alertDescriptionText,
'You do not have enough ETH in your account to pay for transaction fees.',
);
}

async function mintNft(driver: Driver) {
await driver.switchToWindowWithTitle(WINDOW_TITLES.TestDApp);
await driver.clickElement(`#mintButton`);

await driver.waitUntilXWindowHandles(3);
await driver.switchToWindowWithTitle(WINDOW_TITLES.Dialog);
}
7 changes: 6 additions & 1 deletion ui/components/app/alert-system/alert-modal/alert-modal.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,12 @@ function AlertDetails({
>
{customDetails ?? (
<Box>
<Text variant={TextVariant.bodyMd}>{selectedAlert.message}</Text>
<Text
variant={TextVariant.bodyMd}
data-testid="alert-modal__selected-alert"
>
{selectedAlert.message}
</Text>
{selectedAlert.alertDetails?.length ? (
<Text variant={TextVariant.bodyMdBold} marginTop={1}>
{t('alertModalDetails')}
Expand Down
37 changes: 32 additions & 5 deletions ui/pages/confirmations/components/confirm/footer/footer.test.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ import * as MMIConfirmations from '../../../../../hooks/useMMIConfirmations';
import * as Actions from '../../../../../store/actions';
import configureStore from '../../../../../store/store';
import { Severity } from '../../../../../helpers/constants/design-system';

import { Alert } from '../../../../../ducks/confirm-alerts/confirm-alerts';
import Footer from './footer';

jest.mock('react-redux', () => ({
Expand Down Expand Up @@ -184,7 +186,8 @@ describe('ConfirmFooter', () => {
const OWNER_ID_MOCK = '123';
const KEY_ALERT_KEY_MOCK = 'Key';
const ALERT_MESSAGE_MOCK = 'Alert 1';
const alertsMock = [

const alertsMock: Alert[] = [
{
key: KEY_ALERT_KEY_MOCK,
field: KEY_ALERT_KEY_MOCK,
Expand Down Expand Up @@ -213,18 +216,42 @@ describe('ConfirmFooter', () => {
};
it('renders the review alerts button when there are unconfirmed alerts', () => {
const { getByText } = render(stateWithAlertsMock);
expect(getByText('Confirm')).toBeInTheDocument();
expect(getByText('Review alerts')).toBeInTheDocument();
});

it('renders the confirm button when there are no unconfirmed alerts', () => {
const { getByText } = render();
expect(getByText('Confirm')).toBeInTheDocument();
it('renders the "review alerts" button disabled when there are blocking alerts', () => {
const stateWithMultipleDangerAlerts = {
...stateWithAlertsMock,
confirmAlerts: {
alerts: {
[OWNER_ID_MOCK]: [
alertsMock[0],
{
...alertsMock[0],
key: 'From',
isBlocking: true,
},
],
},
confirmed: {
[OWNER_ID_MOCK]: { [KEY_ALERT_KEY_MOCK]: false },
},
},
};
const { getByText } = render(stateWithMultipleDangerAlerts);
expect(getByText('Review alerts')).toBeInTheDocument();
expect(getByText('Review alerts')).toBeDisabled();
});

it('sets the alert modal visible when the review alerts button is clicked', () => {
const { getByTestId } = render(stateWithAlertsMock);
fireEvent.click(getByTestId('confirm-footer-button'));
expect(getByTestId('confirm-alert-modal-submit-button')).toBeDefined();
});

it('renders the "confirm" button when there are no alerts', () => {
const { getByText } = render();
expect(getByText('Confirm')).toBeInTheDocument();
});
});
});
36 changes: 34 additions & 2 deletions ui/pages/confirmations/components/confirm/footer/footer.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,30 @@ import {
import { confirmSelector } from '../../../selectors';
import { REDESIGN_TRANSACTION_TYPES } from '../../../utils';
import { getConfirmationSender } from '../utils';
import { MetaMetricsEventLocation } from '../../../../../../shared/constants/metametrics';
import { Severity } from '../../../../../helpers/constants/design-system';

export type OnCancelHandler = ({
location,
}: {
location: MetaMetricsEventLocation;
}) => void;

function getButtonDisabledState(
hasUnconfirmedDangerAlerts: boolean,
hasBlockingAlerts: boolean,
disabled: boolean,
) {
if (hasBlockingAlerts) {
return true;
}

if (hasUnconfirmedDangerAlerts) {
return false;
}

return disabled;
}

const ConfirmButton = ({
alertOwnerId = '',
Expand All @@ -47,6 +71,10 @@ const ConfirmButton = ({
const { dangerAlerts, hasDangerAlerts, hasUnconfirmedDangerAlerts } =
useAlerts(alertOwnerId);

const hasDangerBlockingAlerts = dangerAlerts.some(
(alert) => alert.severity === Severity.Danger && alert.isBlocking,
);

const handleCloseConfirmModal = useCallback(() => {
setConfirmModalVisible(false);
}, []);
Expand All @@ -70,12 +98,16 @@ const ConfirmButton = ({
block
danger
data-testid="confirm-footer-button"
disabled={hasUnconfirmedDangerAlerts ? false : disabled}
disabled={getButtonDisabledState(
hasUnconfirmedDangerAlerts,
hasDangerBlockingAlerts,
disabled,
)}
onClick={handleOpenConfirmModal}
size={ButtonSize.Lg}
startIconName={IconName.Danger}
>
{dangerAlerts?.length > 1 ? t('reviewAlerts') : t('confirm')}
{dangerAlerts?.length > 0 ? t('reviewAlerts') : t('confirm')}
</Button>
) : (
<Button
Expand Down

0 comments on commit 24b5e1e

Please sign in to comment.