Merge branch 'main' of github.com:MetaMask/metamask-extension into cleanup_incoming_txn_network_preference

Author: jpuri

.github/workflows/security-code-scanner.yml

@@ -1,10 +1,13 @@
-name: 'MetaMask Security Code Scanner'
+name: MetaMask Security Code Scanner
 
 on:
   push:
-    branches: ['main']
+    branches:
+      - main
   pull_request:
-    branches: ['main']
+    branches:
+      - main
+  workflow_dispatch:
 
 jobs:
   run-security-scan:

.storybook/index.css

@@ -9,8 +9,8 @@
   margin-top: auto !important;
 }
 
-.snap-ui-renderer__content {
-  margin-bottom: 0 !important;
+.snap-ui-renderer__container {
+  padding-bottom: 0 !important;
 }
 
 .snap-ui-renderer__panel {

.storybook/metamask-storybook-theme.js

@@ -2,5 +2,5 @@
 export const metamaskStorybookTheme = {
   brandTitle: 'MetaMask Storybook',
   // Typography
-  fontBase: 'Euclid Circular B, Helvetica, Arial, sans-serif',
+  fontBase: 'var(--font-family-sans)',
 };

.yarn/patches/@sentry-browser-npm-8.33.1-4405cafca3.patch

@@ -6,6 +6,11 @@ let scriptsLoadInitiated = false;
 const { chrome } = globalThis;
 const testMode = process.env.IN_TEST;
 
+/**
+ * @type {globalThis.stateHooks}
+ */
+globalThis.stateHooks = globalThis.stateHooks || {};
+
 const loadTimeLogs = [];
 // eslint-disable-next-line import/unambiguous
 function tryImport(...fileNames) {
@@ -184,12 +189,32 @@ const registerInPageContentScript = async () => {
   }
 };
 
-chrome.runtime.onInstalled.addListener(function (details) {
+/**
+ * `onInstalled` event handler.
+ *
+ * On MV3 builds we must listen for this event in `app-init`, otherwise we found that the listener
+ * is never called.
+ * For MV2 builds, the listener is added in `background.js` instead.
+ *
+ * @param {chrome.runtime.InstalledDetails} details - Event details.
+ */
+function onInstalledListener(details) {
   if (details.reason === 'install') {
-    chrome.storage.session.set({ isFirstTimeInstall: true });
-  } else if (details.reason === 'update') {
-    chrome.storage.session.set({ isFirstTimeInstall: false });
+    // This condition is for when `background.js` was loaded before the `onInstalled` listener was
+    // called.
+    if (globalThis.stateHooks.metamaskTriggerOnInstall) {
+      globalThis.stateHooks.metamaskTriggerOnInstall();
+      // Delete just to clean up global namespace
+      delete globalThis.stateHooks.metamaskTriggerOnInstall;
+      // This condition is for when the `onInstalled` listener in `app-init` was called before
+      // `background.js` was loaded.
+    } else {
+      globalThis.stateHooks.metamaskWasJustInstalled = true;
+    }
+    chrome.runtime.onInstalled.removeListener(onInstalledListener);
   }
-});
+}
+
+chrome.runtime.onInstalled.addListener(onInstalledListener);
 
 registerInPageContentScript();

app/scripts/app-init.js

@@ -141,22 +141,35 @@ const PHISHING_WARNING_PAGE_TIMEOUT = ONE_SECOND_IN_MILLISECONDS;
 // Event emitter for state persistence
 export const statePersistenceEvents = new EventEmitter();
 
-if (isFirefox) {
-  browser.runtime.onInstalled.addListener(function (details) {
-    if (details.reason === 'install') {
-      browser.storage.session.set({ isFirstTimeInstall: true });
-    } else if (details.reason === 'update') {
-      browser.storage.session.set({ isFirstTimeInstall: false });
-    }
-  });
-} else if (!isManifestV3) {
-  browser.runtime.onInstalled.addListener(function (details) {
+if (!isManifestV3) {
+  /**
+   * `onInstalled` event handler.
+   *
+   * On MV3 builds we must listen for this event in `app-init`, otherwise we found that the listener
+   * is never called.
+   * There is no `app-init` file on MV2 builds, so we add a listener here instead.
+   *
+   * @param {import('webextension-polyfill').Runtime.OnInstalledDetailsType} details - Event details.
+   */
+  const onInstalledListener = (details) => {
     if (details.reason === 'install') {
-      global.sessionStorage.setItem('isFirstTimeInstall', true);
-    } else if (details.reason === 'update') {
-      global.sessionStorage.setItem('isFirstTimeInstall', false);
+      onInstall();
+      browser.runtime.onInstalled.removeListener(onInstalledListener);
     }
-  });
+  };
+
+  browser.runtime.onInstalled.addListener(onInstalledListener);
+
+  // This condition is for when the `onInstalled` listener in `app-init` was called before
+  // `background.js` was loaded.
+} else if (globalThis.stateHooks.metamaskWasJustInstalled) {
+  onInstall();
+  // Delete just to clean up global namespace
+  delete globalThis.stateHooks.metamaskWasJustInstalled;
+  // This condition is for when `background.js` was loaded before the `onInstalled` listener was
+  // called.
+} else {
+  globalThis.stateHooks.metamaskTriggerOnInstall = () => onInstall();
 }
 
 /**
@@ -505,12 +518,6 @@ async function initialize() {
     await sendReadyMessageToTabs();
     log.info('MetaMask initialization complete.');
 
-    if (isManifestV3 || isFirefox) {
-      browser.storage.session.set({ isFirstTimeInstall: false });
-    } else {
-      global.sessionStorage.setItem('isFirstTimeInstall', false);
-    }
-
     resolveInitialization();
   } catch (error) {
     rejectInitialization(error);
@@ -1286,24 +1293,15 @@ const addAppInstalledEvent = () => {
   }, 500);
 };
 
-// On first install, open a new tab with MetaMask
-async function onInstall() {
-  const sessionData =
-    isManifestV3 || isFirefox
-      ? await browser.storage.session.get(['isFirstTimeInstall'])
-      : await global.sessionStorage.getItem('isFirstTimeInstall');
-
-  const isFirstTimeInstall = sessionData?.isFirstTimeInstall;
-
-  if (process.env.IN_TEST) {
-    addAppInstalledEvent();
-  } else if (!isFirstTimeInstall && !process.env.METAMASK_DEBUG) {
-    // If storeAlreadyExisted is true then this is a fresh installation
-    // and an app installed event should be tracked.
-    addAppInstalledEvent();
+/**
+ * Trigger actions that should happen only upon initial install (e.g. open tab for onboarding).
+ */
+function onInstall() {
+  log.debug('First install detected');
+  addAppInstalledEvent();
+  if (!process.env.IN_TEST && !process.env.METAMASK_DEBUG) {
     platform.openExtensionInBrowser();
   }
-  onNavigateToTab();
 }
 
 function onNavigateToTab() {
@@ -1334,7 +1332,7 @@ function setupSentryGetStateGlobal(store) {
 }
 
 async function initBackground() {
-  await onInstall();
+  onNavigateToTab();
   try {
     await initialize();
     if (process.env.IN_TEST) {

app/scripts/background.js

@@ -0,0 +1 @@
+export { TokenRatesControllerInit } from './token-rates-controller-init';

app/scripts/controller-init/assets/index.ts

@@ -0,0 +1,47 @@
+import {
+  TokenRatesController,
+  TokenRatesControllerMessenger,
+} from '@metamask/assets-controllers';
+import { Messenger } from '@metamask/base-controller';
+import { buildControllerInitRequestMock } from '../test/utils';
+import { ControllerInitRequest } from '../types';
+import { getTokenRatesControllerMessenger } from '../messengers/assets';
+import { TokenRatesControllerInit } from './token-rates-controller-init';
+
+jest.mock('@metamask/assets-controllers');
+
+function buildInitRequestMock(): jest.Mocked<
+  ControllerInitRequest<TokenRatesControllerMessenger>
+> {
+  const baseControllerMessenger = new Messenger();
+
+  return {
+    ...buildControllerInitRequestMock(),
+    controllerMessenger: getTokenRatesControllerMessenger(
+      baseControllerMessenger,
+    ),
+    initMessenger: undefined,
+  };
+}
+
+describe('TokenRatesControllerInit', () => {
+  const tokenRatesControllerClassMock = jest.mocked(TokenRatesController);
+
+  beforeEach(() => {
+    jest.resetAllMocks();
+  });
+
+  it('returns controller instance', () => {
+    const requestMock = buildInitRequestMock();
+    expect(TokenRatesControllerInit(requestMock).controller).toBeInstanceOf(
+      TokenRatesController,
+    );
+  });
+
+  it('initializes with correct messenger and state', () => {
+    const requestMock = buildInitRequestMock();
+    TokenRatesControllerInit(requestMock);
+
+    expect(tokenRatesControllerClassMock).toHaveBeenCalled();
+  });
+});

app/scripts/controller-init/assets/token-rates-controller-init.test.ts

@@ -0,0 +1,30 @@
+import {
+  CodefiTokenPricesServiceV2,
+  TokenRatesController,
+} from '@metamask/assets-controllers';
+import { ControllerInitFunction } from '../types';
+import { TokenRatesControllerMessenger } from '../messengers/assets';
+
+/**
+ * Initialize the Token Rates controller.
+ *
+ * @param request - The request object.
+ * @param request.controllerMessenger - The messenger to use for the controller.
+ * @param request.persistedState - The persisted state of the extension.
+ * @returns The initialized controller.
+ */
+export const TokenRatesControllerInit: ControllerInitFunction<
+  TokenRatesController,
+  TokenRatesControllerMessenger
+> = ({ controllerMessenger, persistedState }) => {
+  const controller = new TokenRatesController({
+    messenger: controllerMessenger,
+    state: persistedState.TokenRatesController,
+    tokenPricesService: new CodefiTokenPricesServiceV2(),
+    disabled: !persistedState.PreferencesController?.useCurrencyRateCheck,
+  });
+
+  return {
+    controller,
+  };
+};

app/scripts/controller-init/assets/token-rates-controller-init.ts

@@ -222,6 +222,26 @@ function getControllers(
   };
 }
 
+function getSmartTransactionCommonParams(flatState: ControllerFlatState) {
+  // UI state is required to support shared selectors to avoid duplicate logic in frontend and backend.
+  // Ideally all backend logic would instead rely on messenger event / state subscriptions.
+  const uiState = getUIState(flatState);
+
+  // @ts-expect-error Smart transaction selector types does not match controller state
+  const isSmartTransaction = getIsSmartTransaction(uiState);
+
+  // @ts-expect-error Smart transaction selector types does not match controller state
+  const featureFlags = getFeatureFlagsByChainId(uiState);
+
+  const isHardwareWalletAccount = isHardwareWallet(uiState);
+
+  return {
+    isSmartTransaction,
+    featureFlags,
+    isHardwareWalletAccount,
+  };
+}
+
 function publishSmartTransactionHook(
   transactionController: TransactionController,
   smartTransactionsController: SmartTransactionsController,
@@ -230,29 +250,22 @@ function publishSmartTransactionHook(
   transactionMeta: TransactionMeta,
   signedTransactionInHex: Hex,
 ) {
-  // UI state is required to support shared selectors to avoid duplicate logic in frontend and backend.
-  // Ideally all backend logic would instead rely on messenger event / state subscriptions.
-  const uiState = getUIState(flatState);
-
-  // @ts-expect-error Smart transaction selector types does not match controller state
-  const isSmartTransaction = getIsSmartTransaction(uiState);
+  const { isSmartTransaction, featureFlags, isHardwareWalletAccount } =
+    getSmartTransactionCommonParams(flatState);
 
   if (!isSmartTransaction) {
     // Will cause TransactionController to publish to the RPC provider as normal.
     return { transactionHash: undefined };
   }
 
-  // @ts-expect-error Smart transaction selector types does not match controller state
-  const featureFlags = getFeatureFlagsByChainId(uiState);
-
   return submitSmartTransactionHook({
     transactionMeta,
     signedTransactionInHex,
     transactionController,
     smartTransactionsController,
     controllerMessenger: hookControllerMessenger,
     isSmartTransaction,
-    isHardwareWallet: isHardwareWallet(uiState),
+    isHardwareWallet: isHardwareWalletAccount,
     // @ts-expect-error Smart transaction selector return type does not match FeatureFlags type from hook
     featureFlags,
   });
@@ -271,21 +284,16 @@ function publishBatchSmartTransactionHook({
   flatState: ControllerFlatState;
   transactions: PublishBatchHookTransaction[];
 }) {
-  // UI state is required to support shared selectors to avoid duplicate logic in frontend and backend.
-  // Ideally all backend logic would instead rely on messenger event / state subscriptions.
-  const uiState = getUIState(flatState);
-
-  // @ts-expect-error Smart transaction selector types does not match controller state
-  const isSmartTransaction = getIsSmartTransaction(uiState);
+  const { isSmartTransaction, featureFlags, isHardwareWalletAccount } =
+    getSmartTransactionCommonParams(flatState);
 
   if (!isSmartTransaction) {
     // Will cause TransactionController to publish to the RPC provider as normal.
-    return undefined;
+    throw new Error(
+      'publishBatchSmartTransactionHook: Smart Transaction is required for batch submissions',
+    );
   }
 
-  // @ts-expect-error Smart transaction selector types does not match controller state
-  const featureFlags = getFeatureFlagsByChainId(uiState);
-
   // Get transactionMeta based on the last transaction ID
   const lastTransaction = transactions[transactions.length - 1];
   const transactionMeta = getTransactionById(
@@ -295,10 +303,9 @@ function publishBatchSmartTransactionHook({
 
   // If we couldn't find the transaction, we should handle that gracefully
   if (!transactionMeta) {
-    console.warn(
-      `Publish batch hook: could not find transaction with id ${lastTransaction.id}`,
+    throw new Error(
+      `publishBatchSmartTransactionHook: Could not find transaction with id ${lastTransaction.id}`,
     );
-    return undefined;
   }
 
   return submitBatchSmartTransactionHook({
@@ -307,7 +314,7 @@ function publishBatchSmartTransactionHook({
     smartTransactionsController,
     controllerMessenger: hookControllerMessenger,
     isSmartTransaction,
-    isHardwareWallet: isHardwareWallet(uiState),
+    isHardwareWallet: isHardwareWalletAccount,
     // @ts-expect-error Smart transaction selector return type does not match FeatureFlags type from hook
     featureFlags,
     transactionMeta,