Merge branch 'develop' into start-upgrade-to-react-router-v6

.circleci/scripts/test-run-e2e-timeout-minutes.ts

@@ -0,0 +1,8 @@
+import { filterE2eChangedFiles } from '../../test/e2e/changedFilesUtil';
+
+const changedOrNewTests = filterE2eChangedFiles();
+
+//15 minutes, plus 3 minutes for every changed file, up to a maximum of 30 minutes
+const extraTime = Math.min(15 + changedOrNewTests.length * 3, 30);
+
+console.log(extraTime);

.circleci/scripts/test-run-e2e.sh

@@ -19,8 +19,11 @@ then
     exit 1
 fi
 
+TIMEOUT_MINUTES=$(yarn tsx .circleci/scripts/test-run-e2e-timeout-minutes.ts)
+echo "TIMEOUT_MINUTES: $TIMEOUT_MINUTES"
+
 # Run the actual test command from the parameters
-timeout 20m "$@" --retries 1
+timeout "${TIMEOUT_MINUTES}"m "$@" --retries 1
 
 # Error code 124 means the command timed out
 if [ $? -eq 124 ]

.circleci/scripts/validate-locales-only.ts

@@ -5,8 +5,8 @@ const { readChangedFiles } = require('../../test/e2e/changedFilesUtil.js');
  * Fails the build if any changed files are outside of the /_locales/ directory.
  * Fails if no changed files are detected.
  */
-async function validateLocalesOnlyChangedFiles() {
-  const changedFiles = await readChangedFiles();
+function validateLocalesOnlyChangedFiles() {
+  const changedFiles = readChangedFiles();
   if (!changedFiles || changedFiles.length === 0) {
     console.error('Failure: No changed files detected.');
     process.exit(1);

.depcheckrc.yml

@@ -28,6 +28,7 @@ ignores:
   - '@sentry/cli' # invoked as `sentry-cli`
   - 'chromedriver'
   - 'depcheck' # ooo meta
+  - 'ethers' # ethers @5.7.0 expected by @account-abstraction/contracts, but conflicts with transitive ethers@6.x
   - 'ganache-cli'
   - 'geckodriver'
   - 'jest'

.github/workflows/run-tests.yml

@@ -0,0 +1,142 @@
+name: Run tests
+
+on:
+  push:
+    branches:
+      - develop
+      - master
+  pull_request:
+    types:
+      - opened
+      - reopened
+      - synchronize
+
+jobs:
+  test-unit:
+    name: Unit tests
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        shard: [1, 2, 3, 4, 5, 6]
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup environment
+        uses: metamask/github-tools/.github/actions/setup-environment@main
+
+      - name: test:unit:coverage
+        run: yarn test:unit:coverage --shard=${{ matrix.shard }}/${{ strategy.job-total }}
+
+      - name: Rename coverage
+        run: mv coverage/unit/coverage-final.json coverage/unit/coverage-unit-${{matrix.shard}}.json
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: coverage-unit-${{matrix.shard}}
+          path: coverage/unit/coverage-unit-${{matrix.shard}}.json
+
+  test-webpack:
+    name: Webpack tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup environment
+        uses: metamask/github-tools/.github/actions/setup-environment@main
+
+      - name: test:unit:webpack:coverage
+        run: yarn test:unit:webpack:coverage
+
+      - name: Rename coverage
+        run: mv coverage/webpack/coverage-final.json coverage/webpack/coverage-webpack.json
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: coverage-webpack
+          path: coverage/webpack/coverage-webpack.json
+
+  test-integration:
+    name: Integration tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup environment
+        uses: metamask/github-tools/.github/actions/setup-environment@main
+
+      - name: test:integration:coverage
+        run: yarn test:integration:coverage
+
+      - name: Rename coverage
+        run: mv coverage/integration/coverage-final.json coverage/integration/coverage-integration.json
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: coverage-integration
+          path: coverage/integration/coverage-integration.json
+
+  sonarcloud:
+    name: SonarCloud
+    runs-on: ubuntu-latest
+    needs:
+      - test-unit
+      - test-webpack
+      - test-integration
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0  # Shallow clones should be disabled for better relevancy of analysis
+
+      - name: Setup environment
+        uses: metamask/github-tools/.github/actions/setup-environment@main
+
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          path: coverage
+          merge-multiple: true
+
+      - name: Merge coverage reports
+        run: yarn nyc merge coverage .nyc_output/coverage-final.json && yarn nyc report --reporter lcov
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: lcov.info
+          path: coverage/lcov.info
+
+      - name: Get Sonar coverage
+        id: get-sonar-coverage
+        env:
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
+        run: |
+          projectKey=$(grep 'sonar.projectKey=' sonar-project.properties | cut -d'=' -f2)
+          sonar_coverage=$(curl --silent --header "Authorization: Bearer $SONAR_TOKEN" "https://sonarcloud.io/api/measures/component?component=$projectKey&metricKeys=coverage" | jq -r '.component.measures[0].value // 0')
+          echo "The Sonar coverage of $projectKey is $sonar_coverage%."
+          echo 'SONAR_COVERAGE='"$sonar_coverage" >> "$GITHUB_OUTPUT"
+
+      - name: Validate test coverage
+        env:
+            SONAR_COVERAGE: ${{ steps.get-sonar-coverage.outputs.SONAR_COVERAGE }}
+        run: |
+          coverage=$(yarn nyc report --reporter=text-summary | grep 'Lines' | awk '{gsub(/%/, ""); print $3}')
+          if [ -z "$coverage" ]; then
+            echo "::error::Could not retrieve test coverage."
+            exit 1
+          fi
+          if (( $(echo "$coverage < $SONAR_COVERAGE" | bc -l) )); then
+            echo "::error::Quality gate failed for test coverage. Current test coverage is $coverage%, please increase coverage to at least $SONAR_COVERAGE%."
+            exit 1
+          else
+            echo "Test coverage is $coverage%. Quality gate passed."
+          fi
+
+      - name: SonarCloud Scan
+        # This is SonarSource/sonarcloud-github-action@v2.0.0
+        uses: SonarSource/sonarcloud-github-action@4b4d7634dab97dcee0b75763a54a6dc92a9e6bc1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

.gitignore

@@ -79,4 +79,4 @@ licenseInfos.json
 html-report/
 
 /app/images/branding
-
+/changed-files

.storybook/main.js

@@ -48,6 +48,10 @@ module.exports = {
     config.resolve.alias['../../../../../../store/actions'] = require.resolve(
       '../ui/__mocks__/actions.js',
     );
+    // Import within controller-utils crashes storybook.
+    config.resolve.alias['@ethereumjs/util'] = require.resolve(
+      '../ui/__mocks__/ethereumjs-util.js',
+    );
     config.resolve.fallback = {
       child_process: false,
       constants: false,

.storybook/metamask-storybook-theme.js

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

.yarn/patches/jest-environment-jsdom-npm-29.7.0-0b72dd0e0b.patch

@@ -0,0 +1,16 @@
+diff --git a/build/index.js b/build/index.js
+index 2e6c16c33c2f588cf8d6a5717ac776bb8908bd0d..5534a739c6bc7cda9e0f8439656a6215dfacc26a 100644
+--- a/build/index.js
++++ b/build/index.js
+@@ -95,6 +95,11 @@ class JSDOMEnvironment {
+
+     // TODO: remove this ASAP, but it currently causes tests to run really slow
+     global.Buffer = Buffer;
++    // Needed to support toChecksumAddress from the ethereumjs-util@7.1.5.
++    // It converts a hex string to a buffer and then expects it to be an instanceof Uint8Array.
++    // And although on Node env that buffer is an instance of Uint8Array, on JSDOM it is not.
++    // So we need to override the jsdom Uint8Array with Node Uint8Array.
++    global.Uint8Array = Uint8Array;
+
+     // Report uncaught errors.
+     this.errorEventListener = event => {

README.md

@@ -83,8 +83,13 @@ If you are using VS Code and are unable to make commits from the source control
 
 To start a development build (e.g. with logging and file watching) run `yarn start`.
 
-Alternatively, one can skip wallet onboarding and preload the vault state with a specific SRP by adding `TEST_SRP='<insert SRP here>'` and `PASSWORD='<insert wallet password here>'` to the `.metamaskrc` file and running `yarn start:skip-onboarding`.
+#### Development build with wallet state
+You can start a development build with a preloaded wallet state, by adding `TEST_SRP='<insert SRP here>'` and `PASSWORD='<insert wallet password here>'` to the `.metamaskrc` file. Then you have the following options:
+1. Start the wallet with the default fixture flags, by running `yarn start:with-state`.
+2. Check the list of available fixture flags, by running `yarn start:with-state --help`.
+3. Start the wallet with custom fixture flags, by running `yarn start:with-state --FIXTURE_NAME=VALUE` for example `yarn start:with-state --withAccounts=100`. You can pass as many flags as you want. The rest of the fixtures will take the default values.
 
+#### Development build with Webpack
 You can also start a development build using the `yarn webpack` command, or `yarn webpack --watch`. This uses an alternative build system that is much faster, but not yet production ready. See the [Webpack README](./development/webpack/README.md) for more information.
 
 #### React and Redux DevTools