import React, {
useCallback,
useEffect,
useMemo,
useReducer,
useState,
} from 'react';
import PropTypes from 'prop-types';
import { useDispatch, useSelector } from 'react-redux';
import { useHistory } from 'react-router-dom';
import { isEqual } from 'lodash';
import { produce } from 'immer';
///: BEGIN:ONLY_INCLUDE_IN(snaps)
import { ApprovalType } from '@metamask/controller-utils';
///: END:ONLY_INCLUDE_IN
import Box from '../../components/ui/box';
import MetaMaskTemplateRenderer from '../../components/app/metamask-template-renderer';
import ConfirmationWarningModal from '../../components/app/confirmation-warning-modal';
import { DEFAULT_ROUTE } from '../../helpers/constants/routes';
import {
AlignItems,
FLEX_DIRECTION,
Size,
TextColor,
} from '../../helpers/constants/design-system';
import { useI18nContext } from '../../hooks/useI18nContext';
import { useOriginMetadata } from '../../hooks/useOriginMetadata';
import {
///: BEGIN:ONLY_INCLUDE_IN(snaps)
getTargetSubjectMetadata,
///: END:ONLY_INCLUDE_IN
getUnapprovedTemplatedConfirmations,
getUnapprovedTxCount,
getApprovalFlows,
getTotalUnapprovedCount,
} from '../../selectors';
import NetworkDisplay from '../../components/app/network-display/network-display';
import Callout from '../../components/ui/callout';
import SiteOrigin from '../../components/ui/site-origin';
import { Icon, IconName } from '../../components/component-library';
import Loading from '../../components/ui/loading-screen';
///: BEGIN:ONLY_INCLUDE_IN(snaps)
import SnapAuthorshipHeader from '../../components/app/snaps/snap-authorship-header';
import { getSnapName } from '../../helpers/utils/util';
///: END:ONLY_INCLUDE_IN
import ConfirmationFooter from './components/confirmation-footer';
import {
getTemplateValues,
getTemplateAlerts,
getTemplateState,
} from './templates';
// TODO(rekmarks): This component and all of its sub-components should probably
// be renamed to "Dialog", now that we are using it in that manner.
/**
* a very simple reducer using produce from Immer to keep state manipulation
* immutable and painless. This state is not stored in redux state because it
* should persist only for the lifespan of the current session, and will only
* be used on this page. Dismissing alerts for confirmations should persist
* while the user pages back and forth between confirmations. However, if the
* user closes the confirmation window and later reopens the extension they
* should be displayed the alerts again.
*/
const alertStateReducer = produce((state, action) => {
switch (action.type) {
case 'dismiss':
if (state?.[action.confirmationId]?.[action.alertId]) {
state[action.confirmationId][action.alertId].dismissed = true;
}
break;
case 'set':
if (!state[action.confirmationId]) {
state[action.confirmationId] = {};
}
action.alerts.forEach((alert) => {
state[action.confirmationId][alert.id] = {
...alert,
dismissed: false,
};
});
break;
default:
throw new Error(
'You must provide a type when dispatching an action for alertState',
);
}
});
/**
* Encapsulates the state and effects needed to manage alert state for the
* confirmation page in a custom hook. This hook is not likely to be used
* outside of this file, but it helps to reduce complexity of the primary
* component.
*
* @param {object} pendingConfirmation - a pending confirmation waiting for
* user approval
* @param {object} state - The state object consist of required info to determine alerts.
* @param state.unapprovedTxsCount
* @returns {[alertState: object, dismissAlert: Function]} A tuple with
* the current alert state and function to dismiss an alert by id
*/
function useAlertState(pendingConfirmation, { unapprovedTxsCount } = {}) {
const [alertState, dispatch] = useReducer(alertStateReducer, {});
/**
* Computation of the current alert state happens every time the current
* pendingConfirmation changes. The async function getTemplateAlerts is
* responsible for returning alert state. Setting state on unmounted
* components is an anti-pattern, so we use a isMounted variable to keep
* track of the current state of the component. Returning a function that
* sets isMounted to false when the component is unmounted.
*/
useEffect(() => {
let isMounted = true;
if (pendingConfirmation) {
getTemplateAlerts(pendingConfirmation, { unapprovedTxsCount }).then(
(alerts) => {
if (isMounted && alerts.length > 0) {
dispatch({
type: 'set',
confirmationId: pendingConfirmation.id,
alerts,
});
}
},
);
}
return () => {
isMounted = false;
};
}, [pendingConfirmation, unapprovedTxsCount]);
const dismissAlert = useCallback(
(alertId) => {
dispatch({
type: 'dismiss',
confirmationId: pendingConfirmation.id,
alertId,
});
},
[pendingConfirmation],
);
return [alertState, dismissAlert];
}
function useTemplateState(pendingConfirmation) {
const [templateState, setTemplateState] = useState({});
useEffect(() => {
let isMounted = true;
if (pendingConfirmation) {
getTemplateState(pendingConfirmation).then((state) => {
if (isMounted && Object.values(state).length > 0) {
setTemplateState((prevState) => ({
...prevState,
[pendingConfirmation.id]: state,
}));
}
});
}
return () => {
isMounted = false;
};
}, [pendingConfirmation]);
return [templateState];
}
export default function ConfirmationPage({
redirectToHomeOnZeroConfirmations = true,
}) {
const t = useI18nContext();
const dispatch = useDispatch();
const history = useHistory();
const pendingConfirmations = useSelector(
getUnapprovedTemplatedConfirmations,
isEqual,
);
const unapprovedTxsCount = useSelector(getUnapprovedTxCount);
const approvalFlows = useSelector(getApprovalFlows, isEqual);
const totalUnapprovedCount = useSelector(getTotalUnapprovedCount);
const [approvalFlowLoadingText, setApprovalFlowLoadingText] = useState(null);
const [currentPendingConfirmation, setCurrentPendingConfirmation] =
useState(0);
const pendingConfirmation = pendingConfirmations[currentPendingConfirmation];
const originMetadata = useOriginMetadata(pendingConfirmation?.origin) || {};
const [alertState, dismissAlert] = useAlertState(pendingConfirmation, {
unapprovedTxsCount,
});
const [templateState] = useTemplateState(pendingConfirmation);
const [showWarningModal, setShowWarningModal] = useState(false);
const [inputStates, setInputStates] = useState({});
const setInputState = (key, value) => {
setInputStates((currentState) => ({ ...currentState, [key]: value }));
};
const [loading, setLoading] = useState(false);
const [loadingText, setLoadingText] = useState();
const [submitAlerts, setSubmitAlerts] = useState([]);
///: BEGIN:ONLY_INCLUDE_IN(snaps)
const targetSubjectMetadata = useSelector((state) =>
getTargetSubjectMetadata(state, pendingConfirmation?.origin),
);
// When pendingConfirmation is undefined, this will also be undefined
const snapName =
targetSubjectMetadata &&
getSnapName(pendingConfirmation?.origin, targetSubjectMetadata);
const SNAP_DIALOG_TYPE = [
ApprovalType.SnapDialogAlert,
ApprovalType.SnapDialogConfirmation,
ApprovalType.SnapDialogPrompt,
];
const isSnapDialog = SNAP_DIALOG_TYPE.includes(pendingConfirmation?.type);
///: END:ONLY_INCLUDE_IN
const INPUT_STATE_CONFIRMATIONS = [
///: BEGIN:ONLY_INCLUDE_IN(snaps)
ApprovalType.SnapDialogPrompt,
///: END:ONLY_INCLUDE_IN
];
// Generating templatedValues is potentially expensive, and if done on every render
// will result in a new object. Avoiding calling this generation unnecessarily will
// improve performance and prevent unnecessary draws.
const templatedValues = useMemo(() => {
return pendingConfirmation
? getTemplateValues(
{
///: BEGIN:ONLY_INCLUDE_IN(snaps)
snapName: isSnapDialog && snapName,
///: END:ONLY_INCLUDE_IN
...pendingConfirmation,
},
t,
dispatch,
history,
setInputState,
)
: {};
}, [
pendingConfirmation,
t,
dispatch,
history,
///: BEGIN:ONLY_INCLUDE_IN(snaps)
isSnapDialog,
snapName,
///: END:ONLY_INCLUDE_IN
]);
useEffect(() => {
// If the number of pending confirmations reduces to zero when the user
// return them to the default route. Otherwise, if the number of pending
// confirmations reduces to a number that is less than the currently
// viewed index, reset the index.
if (
pendingConfirmations.length === 0 &&
(approvalFlows.length === 0 || totalUnapprovedCount !== 0) &&
redirectToHomeOnZeroConfirmations
) {
history.push(DEFAULT_ROUTE);
} else if (
pendingConfirmations.length &&
pendingConfirmations.length <= currentPendingConfirmation
) {
setCurrentPendingConfirmation(pendingConfirmations.length - 1);
}
}, [
pendingConfirmations,
approvalFlows,
totalUnapprovedCount,
history,
currentPendingConfirmation,
redirectToHomeOnZeroConfirmations,
]);
useEffect(() => {
const childFlow = approvalFlows[approvalFlows.length - 1];
setApprovalFlowLoadingText(childFlow?.loadingText ?? null);
}, [approvalFlows]);
if (!pendingConfirmation) {
if (approvalFlows.length > 0) {
return
{t('xOfYPending', [ currentPendingConfirmation + 1, pendingConfirmations.length, ])}
{currentPendingConfirmation > 0 && ( )}