Merge pull request #30314 from MetaMask/Version-v12.13.0

Version v12.13.0

Author: danjm

.circleci/config.yml

@@ -321,12 +321,15 @@ jobs:
       - run:
           name: Save Yarn version
           command: yarn --version > /tmp/YARN_VERSION
+      - run:
+          name: Save Foundry version
+          command: node -e "process.stdout.write(require('./package.json').foundryup.version)" > /tmp/FOUNDRY_VERSION
       - restore_cache:
           keys:
             # First try to get the specific cache for the checksum of the yarn.lock file.
             # This cache key lookup will fail if the lock file is modified and a cache
             # has not yet been persisted for the new checksum.
-            - dependency-cache-{{ checksum "/tmp/YARN_VERSION" }}-{{ checksum "yarn.lock" }}
+            - dependency-cache-{{ checksum "/tmp/YARN_VERSION" }}-{{ checksum "yarn.lock" }}-{{ checksum "/tmp/FOUNDRY_VERSION" }}
             # To prevent having to do a full install of every node_module when
             # dependencies change, restore from the last known cache of any
             # branch/checksum with the same Yarn version, the install step will remove
@@ -338,12 +341,14 @@ jobs:
           name: Install dependencies
           command: yarn --immutable
       - save_cache:
-          key: dependency-cache-{{ checksum "/tmp/YARN_VERSION" }}-{{ checksum "yarn.lock" }}
+          key: dependency-cache-{{ checksum "/tmp/YARN_VERSION" }}-{{ checksum "yarn.lock" }}-{{ checksum "/tmp/FOUNDRY_VERSION" }}
           paths:
             - .yarn/cache
+            - .metamask/cache # should match yarn's relative location
       - persist_to_workspace:
           root: .
           paths:
+            - .metamask/cache # ensures anvil is installed
             - node_modules
             - build-artifacts
 
@@ -364,6 +369,9 @@ jobs:
           root: .
           paths:
             - changed-files
+      - store_artifacts:
+          path: changed-files
+          destination: changed-files
 
   validate-locales-only:
     executor: node-browsers-small

.circleci/scripts/git-diff-default-branch.ts

@@ -91,24 +91,26 @@ async function fetchUntilMergeBaseFound() {
  * Performs a git diff command to get the list of files changed between the current branch and the origin.
  * It first ensures that the necessary commits are fetched until the merge base is found.
  *
- * @returns The output of the git diff command, listing the changed files.
+ * @returns The output of the git diff command, listing the file paths with status (A, M, D).
  * @throws If unable to get the diff after fetching the merge base or if an unexpected error occurs.
  */
 async function gitDiff(): Promise<string> {
   await fetchUntilMergeBaseFound();
   const { stdout: diffResult } = await exec(
-    `git diff --name-only "origin/HEAD...${SOURCE_BRANCH}"`,
+    `git diff --name-status "origin/HEAD...${SOURCE_BRANCH}"`,
   );
   if (!diffResult) {
     throw new Error('Unable to get diff after full checkout.');
   }
   return diffResult;
 }
 
-function writePrBodyToFile(prBody: string) {
+function writePrBodyAndInfoToFile(prInfo: PRInfo) {
   const prBodyPath = path.resolve(CHANGED_FILES_DIR, 'pr-body.txt');
-  fs.writeFileSync(prBodyPath, prBody.trim());
-  console.log(`PR body saved to ${prBodyPath}`);
+  const labels = prInfo.labels.map(label => label.name).join(', ');
+  const updatedPrBody = `PR labels: {${labels}}\nPR base: {${prInfo.base.ref}}\n${prInfo.body.trim()}`;
+  fs.writeFileSync(prBodyPath, updatedPrBody);
+  console.log(`PR body and info saved to ${prBodyPath}`);
 }
 
 /**
@@ -135,17 +137,9 @@ async function storeGitDiffOutputAndPrBody() {
     if (!baseRef) {
       console.log('Not a PR, skipping git diff');
       return;
-    } else if (baseRef !== GITHUB_DEFAULT_BRANCH) {
-      console.log(`This is for a PR targeting '${baseRef}', skipping git diff`);
-      writePrBodyToFile(prInfo.body);
-      return;
-    } else if (
-      prInfo.labels.some((label) => label.name === 'skip-e2e-quality-gate')
-    ) {
-      console.log('PR has the skip-e2e-quality-gate label, skipping git diff');
-      return;
     }
-
+    // We perform git diff even if the PR base is not main or skip-e2e-quality-gate label is applied
+    // because we rely on the git diff results for other jobs
     console.log('Attempting to get git diff...');
     const diffOutput = await gitDiff();
     console.log(diffOutput);
@@ -155,7 +149,7 @@ async function storeGitDiffOutputAndPrBody() {
     fs.writeFileSync(outputPath, diffOutput.trim());
     console.log(`Git diff results saved to ${outputPath}`);
 
-    writePrBodyToFile(prInfo.body);
+    writePrBodyAndInfoToFile(prInfo);
 
     process.exit(0);
   } catch (error: any) {

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

@@ -1,13 +1,15 @@
 import { fetchManifestFlagsFromPRAndGit } from '../../development/lib/get-manifest-flag';
-import { filterE2eChangedFiles } from '../../test/e2e/changedFilesUtil';
+import { filterE2eChangedFiles, readChangedAndNewFilesWithStatus, getChangedAndNewFiles } from '../../test/e2e/changedFilesUtil';
 
 fetchManifestFlagsFromPRAndGit().then((manifestFlags) => {
   let timeout;
 
   if (manifestFlags.circleci?.timeoutMinutes) {
     timeout = manifestFlags.circleci?.timeoutMinutes;
   } else {
-    const changedOrNewTests = filterE2eChangedFiles();
+    const changedAndNewFilesWithStatus = readChangedAndNewFilesWithStatus();
+    const changedAndNewFiles = getChangedAndNewFiles(changedAndNewFilesWithStatus);
+    const changedOrNewTests = filterE2eChangedFiles(changedAndNewFiles);
 
     // 20 minutes, plus 3 minutes for every changed file, up to a maximum of 30 minutes
     timeout = Math.min(20 + changedOrNewTests.length * 3, 30);

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

@@ -1,12 +1,13 @@
-const { readChangedFiles } = require('../../test/e2e/changedFilesUtil.js');
+const { readChangedAndNewFilesWithStatus, getChangedAndNewFiles } = require('../../test/e2e/changedFilesUtil.js');
 
 /**
  * Verifies that all changed files are in the /_locales/ directory.
  * Fails the build if any changed files are outside of the /_locales/ directory.
  * Fails if no changed files are detected.
  */
 function validateLocalesOnlyChangedFiles() {
-  const changedFiles = readChangedFiles();
+  const changedAndNewFilesWithStatus = readChangedAndNewFilesWithStatus();
+  const changedFiles = getChangedAndNewFiles(changedAndNewFilesWithStatus);
   if (!changedFiles || changedFiles.length === 0) {
     console.error('Failure: No changed files detected.');
     process.exit(1);

.depcheckrc.yml

@@ -40,6 +40,8 @@ ignores:
   - 'wait-on'
   - 'tsx' # used in .devcontainer
   - 'prettier-eslint' # used by the Prettier ESLint VSCode extension
+  - 'tar' # used by foundryup.ts
+  - 'minipass' # used by foundryup.ts
   # storybook
   - '@storybook/cli'
   - '@storybook/core'
@@ -65,7 +67,7 @@ ignores:
   - 'html-bundler-webpack-plugin' # build tool
   - 'postcss-loader' # build tool
   - '@swc/helpers' # build tool
-  - browserslist # build tool
+  - 'browserslist' # build tool
   - 'buffer' # polyfill
   - 'crypto-browserify' # polyfill
   - 'process' # polyfill

.devcontainer/download-builds.ts

@@ -1,6 +1,10 @@
 import { execSync } from 'child_process';
 import util from 'util';
-
+import {
+  getJobsByWorkflowId,
+  getPipelineId,
+  getWorkflowId,
+} from '../.github/scripts/shared/circle-artifacts';
 const exec = util.promisify(require('node:child_process').exec);
 
 function getGitBranch() {
@@ -10,34 +14,10 @@ function getGitBranch() {
   return gitOutput.match(branchRegex)?.groups?.branch || 'main';
 }
 
-async function getCircleJobs(branch: string) {
-  let response = await fetch(
-    `https://circleci.com/api/v2/project/gh/MetaMask/metamask-extension/pipeline?branch=${branch}`,
-  );
-
-  const pipelineId = (await response.json()).items[0].id;
-
-  console.log('pipelineId:', pipelineId);
-
-  response = await fetch(
-    `https://circleci.com/api/v2/pipeline/${pipelineId}/workflow`,
-  );
-
-  const workflowId = (await response.json()).items[0].id;
-
-  console.log('workflowId:', workflowId);
-
-  response = await fetch(
-    `https://circleci.com/api/v2/workflow/${workflowId}/job`,
-  );
-
-  const jobs = (await response.json()).items;
-
-  return jobs;
-}
-
 async function getBuilds(branch: string, jobNames: string[]) {
-  const jobs = await getCircleJobs(branch);
+  const pipelineId = await getPipelineId(branch);
+  const workflowId = await getWorkflowId(pipelineId);
+  const jobs = await getJobsByWorkflowId(workflowId);
   let builds = [] as any[];
 
   for (const jobName of jobNames) {
@@ -137,7 +117,7 @@ function unzipBuilds(folder: 'builds' | 'builds-test', versionNumber: string) {
 }
 
 async function main(jobNames: string[]) {
-  const branch = getGitBranch();
+  const branch = process.env.CIRCLE_BRANCH || getGitBranch();
 
   const builds = await getBuilds(branch, jobNames);
 

.eslintrc.js

@@ -280,6 +280,54 @@ module.exports = {
         },
       },
     },
+
+    /**
+     * TypeScript React-specific code
+     *
+     * Similar to above, but marks a majority of errors to warnings.
+     * TODO - combine rulesets and resolve errors
+     */
+    {
+      files: ['ui/**/*.ts', 'ui/**/*.tsx'],
+      extends: ['plugin:react/recommended', 'plugin:react-hooks/recommended'],
+      parserOptions: {
+        ecmaFeatures: {
+          jsx: true,
+        },
+      },
+      plugins: ['react'],
+      rules: {
+        'react/no-unused-prop-types': 'warn',
+        'react/no-unused-state': 'warn',
+        'react/jsx-boolean-value': 'warn',
+        'react/jsx-curly-brace-presence': [
+          'warn',
+          {
+            props: 'never',
+            children: 'never',
+          },
+        ],
+        'react/no-deprecated': 'warn',
+        'react/default-props-match-prop-types': 'warn',
+        'react/jsx-no-duplicate-props': 'warn',
+        'react/display-name': 'off',
+        'react/no-unescaped-entities': 'warn',
+        'react/prop-types': 'off',
+        'react/no-children-prop': 'off',
+        'react/jsx-key': 'warn', // TODO - increase this into 'error' level
+        'react-hooks/rules-of-hooks': 'warn', // TODO - increase this into 'error' level
+      },
+      settings: {
+        react: {
+          // If this is set to 'detect', ESLint will import React in order to
+          // find its version. Because we run ESLint in the build system under
+          // LavaMoat, this means that detecting the React version requires a
+          // LavaMoat policy for all of React, in the build system. That's a
+          // no-go, so we grab it from React's package.json.
+          version: reactVersion,
+        },
+      },
+    },
     /**
      * Mocha tests
      *

.github/CODEOWNERS

@@ -44,6 +44,11 @@ offscreen/scripts/offscreen.ts       @MetaMask/snaps-devs
 # make all such communication opt IN versus opt OUT.
 privacy-snapshot.json                @MetaMask/extension-privacy-reviewers
 
+
+# A machine-generated file that tracks circular dependencies in the codebase.
+# It is updated using yarn circular-deps:update
+development/circular-deps.jsonc      @MetaMask/extension-security-team @HowardBraham @dbrans
+
 # The CODEOWNERS file constitutes an agreement amongst organization
 # admins and maintainers to restrict approval capabilities to a subset
 # of contributors. Modifications to this file result in a modification of