[Bug|Feat] blockaid external link clicked metric update (#22631)

## **Description**

Various updates related to Blockaid metrics

### Fixes 
- Remove duplicate SignatureRequested SIWE event 
  - related: #21955)
- Removes `security_alert_response` and `security_alert_reason`
transaction, event fragment prop if unnecessary. Previously would add
"not applicable" values to all transaction metrics.

### Feat 
- Add 'external_link_clicked' transaction fragment prop
- Add `security_alert_failed ` ui_customization metric prop
- Removes ExternalLinkClicked from "Report an issue" click
  - related: #22667
- Add test coverage:
  -  utils/metrics:
    - test not applicable resultType and reason
    - test when type is failed, malicious, and benign

### Cleanup
- removes current MetaMetricsEventName.ExternalLinkClicked /
onSupportLinkClicked metric events for Blockaid
- adds external_link_clicked fragment prop to transaction metrics
related to Blockaid
- `let uiCustomizations` → `const uiCustomizations = [];` 
- other various cleanup e.g.:
  - rename variables
  - update test phrases

## **Related issues**

Fixes: MetaMask/MetaMask-planning#1756

## **Manual testing steps**

## **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 Coding
Standards](https://github.com/MetaMask/metamask-extension/blob/develop/.github/guidelines/CODING_GUIDELINES.md).
- [ ] I've clearly explained what problem this PR is solving and how it
is solved.
- [ ] I've linked related issues
- [ ] I've included manual testing steps
- [ ] I've included screenshots/recordings if applicable
- [ ] 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.
- [ ] I’ve properly set the pull request status:
  - [ ] In case it's not yet "ready for review", I've set it to "draft".
- [ ] In case it's "ready for review", I've changed it from "draft" to
"non-draft".

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

Author: digiwand

app/scripts/lib/transaction/metrics.test.ts

@@ -135,8 +135,6 @@ describe('Transaction metrics', () => {
       gas_edit_type: 'none',
       network: mockNetworkId,
       referrer: ORIGIN_METAMASK,
-      security_alert_reason: BlockaidReason.notApplicable,
-      security_alert_response: BlockaidReason.notApplicable,
       source: MetaMetricsTransactionEventSource.User,
       status: 'unapproved',
       token_standard: TokenStandard.none,

app/scripts/lib/transaction/metrics.ts

@@ -25,6 +25,7 @@ import {
   MetaMetricsEventCategory,
   MetaMetricsEventFragment,
   MetaMetricsEventName,
+  MetaMetricsEventUiCustomization,
   MetaMetricsPageObject,
   MetaMetricsReferrerObject,
 } from '../../../../shared/constants/metametrics';
@@ -35,11 +36,7 @@ import {
   TRANSACTION_ENVELOPE_TYPE_NAMES,
 } from '../../../../shared/lib/transactions-controller-utils';
 ///: BEGIN:ONLY_INCLUDE_IF(blockaid)
-import {
-  BlockaidReason,
-  BlockaidResultType,
-} from '../../../../shared/constants/security-provider';
-import { getBlockaidMetricsParams } from '../../../../ui/helpers/utils/metrics';
+import { getBlockaidMetricsProps } from '../../../../ui/helpers/utils/metrics';
 ///: END:ONLY_INCLUDE_IF
 import {
   getSnapAndHardwareInfoForMetrics,
@@ -763,9 +760,6 @@ async function buildEventFragmentProperties({
     finalApprovalAmount,
     contractMethodName,
     securityProviderResponse,
-    ///: BEGIN:ONLY_INCLUDE_IF(blockaid)
-    securityAlertResponse,
-    ///: END:ONLY_INCLUDE_IF
     simulationFails,
   } = transactionMeta;
   const query = new EthQuery(transactionMetricsRequest.provider);
@@ -928,37 +922,30 @@ async function buildEventFragmentProperties({
     }
   }
 
-  let uiCustomizations;
-  let additionalBlockaidParams;
+  const uiCustomizations = [];
 
+  /** securityProviderResponse is used by the OpenSea <> Blockaid provider */
   // eslint-disable-next-line no-lonely-if
   if (securityProviderResponse?.flagAsDangerous === 1) {
-    uiCustomizations = ['flagged_as_malicious'];
+    uiCustomizations.push(MetaMetricsEventUiCustomization.FlaggedAsMalicious);
   } else if (securityProviderResponse?.flagAsDangerous === 2) {
-    uiCustomizations = ['flagged_as_safety_unknown'];
-  } else {
-    uiCustomizations = null;
+    uiCustomizations.push(
+      MetaMetricsEventUiCustomization.FlaggedAsSafetyUnknown,
+    );
   }
 
   ///: BEGIN:ONLY_INCLUDE_IF(blockaid)
-  if (securityAlertResponse?.result_type === BlockaidResultType.Failed) {
-    uiCustomizations = ['security_alert_failed'];
-  } else {
-    additionalBlockaidParams = getBlockaidMetricsParams(
-      securityAlertResponse as any,
-    );
-    uiCustomizations = additionalBlockaidParams?.ui_customizations ?? null;
-  }
+  const blockaidProperties: any = getBlockaidMetricsProps(transactionMeta);
 
+  if (blockaidProperties?.ui_customizations?.length > 0) {
+    uiCustomizations.push(...blockaidProperties.ui_customizations);
+  }
   ///: END:ONLY_INCLUDE_IF
 
   if (simulationFails) {
-    if (uiCustomizations === null) {
-      uiCustomizations = ['gas_estimation_failed'];
-    } else {
-      uiCustomizations.push('gas_estimation_failed');
-    }
+    uiCustomizations.push(MetaMetricsEventUiCustomization.GasEstimationFailed);
   }
+
   /** The transaction status property is not considered sensitive and is now included in the non-anonymous event */
   let properties = {
     chain_id: chainId,
@@ -969,6 +956,7 @@ async function buildEventFragmentProperties({
     eip_1559_version: eip1559Version,
     gas_edit_type: 'none',
     gas_edit_attempted: 'none',
+    gas_estimation_failed: Boolean(simulationFails),
     account_type: await transactionMetricsRequest.getAccountType(
       transactionMetricsRequest.getSelectedAddress(),
     ),
@@ -979,15 +967,11 @@ async function buildEventFragmentProperties({
     token_standard: tokenStandard,
     transaction_type: transactionType,
     transaction_speed_up: type === TransactionType.retry,
-    ...additionalBlockaidParams,
-    ui_customizations: uiCustomizations?.length > 0 ? uiCustomizations : null,
     ///: BEGIN:ONLY_INCLUDE_IF(blockaid)
-    security_alert_response:
-      securityAlertResponse?.result_type ?? BlockaidResultType.NotApplicable,
-    security_alert_reason:
-      securityAlertResponse?.reason ?? BlockaidReason.notApplicable,
+    ...blockaidProperties,
     ///: END:ONLY_INCLUDE_IF
-    gas_estimation_failed: Boolean(simulationFails),
+    // ui_customizations must come after ...blockaidProperties
+    ui_customizations: uiCustomizations.length > 0 ? uiCustomizations : null,
   } as Record<string, any>;
 
   const snapAndHardwareInfo = await getSnapAndHardwareInfoForMetrics(

shared/constants/metametrics.ts

@@ -492,6 +492,11 @@ export const REJECT_NOTIFICATION_CLOSE = 'Cancel Via Notification Close';
 export const REJECT_NOTIFICATION_CLOSE_SIG =
   'Cancel Sig Request Via Notification Close';
 
+/**
+ * The name of the event. Event definitions with corresponding properties can be found in the following document:
+ *
+ * @see {@link https://www.notion.so/f2997ab32326441793ff790ba5c60a6a?v=267d984721cd4a26be610b5caa3e25b7&pvs=4}
+ */
 export enum MetaMetricsEventName {
   AccountAdded = 'Account Added',
   AccountAddSelected = 'Account Add Selected',
@@ -754,7 +759,9 @@ export enum MetaMetricsEventLocation {
 export enum MetaMetricsEventUiCustomization {
   FlaggedAsMalicious = 'flagged_as_malicious',
   FlaggedAsSafetyUnknown = 'flagged_as_safety_unknown',
+  FlaggedAsWarning = 'flagged_as_warning',
   GasEstimationFailed = 'gas_estimation_failed',
+  SecurityAlertFailed = 'security_alert_failed',
   Siwe = 'sign_in_with_ethereum',
 }
 

ui/components/app/security-provider-banner-alert/blockaid-banner-alert/blockaid-banner-alert.js

@@ -9,6 +9,7 @@ import {
   Severity,
 } from '../../../../helpers/constants/design-system';
 import { I18nContext } from '../../../../contexts/i18n';
+import { useTransactionEventFragment } from '../../../../hooks/useTransactionEventFragment';
 import {
   BlockaidReason,
   BlockaidResultType,
@@ -57,6 +58,7 @@ function BlockaidBannerAlert({ txData, ...props }) {
     txData;
 
   const t = useContext(I18nContext);
+  const { updateTransactionEventFragment } = useTransactionEventFragment();
 
   if (
     !securityAlertResponse ||
@@ -121,6 +123,17 @@ function BlockaidBannerAlert({ txData, ...props }) {
 
   const reportUrl = getReportUrl(encodedData);
 
+  const onClickSupportLink = () => {
+    updateTransactionEventFragment(
+      {
+        properties: {
+          external_link_clicked: 'security_alert_support_link',
+        },
+      },
+      txData.id,
+    );
+  };
+
   return (
     <SecurityProviderBannerAlert
       description={description}
@@ -129,6 +142,7 @@ function BlockaidBannerAlert({ txData, ...props }) {
       severity={severity}
       title={title}
       reportUrl={reportUrl}
+      onClickSupportLink={onClickSupportLink}
       {...props}
     />
   );