Version v12.1.1 RC

.depcheckrc.yml

@@ -39,8 +39,6 @@ ignores:
   - 'wait-on'
   - 'tsx' # used in .devcontainer
   - 'prettier-eslint' # used by the Prettier ESLint VSCode extension
-  # development tool
-  - 'nyc'
   # storybook
   - '@storybook/cli'
   - '@storybook/core'

.devcontainer/download-builds.ts

@@ -45,11 +45,12 @@ async function getBuilds(branch: string, jobNames: string[]) {
 
     console.log(`jobName: ${jobName}, jobId: ${jobId}`);
 
+    // Using the CircleCI API version 1.1 here, because this endpoint recently started requiring Authorization in v2
     const response = await fetch(
-      `https://circleci.com/api/v2/project/gh/MetaMask/metamask-extension/${jobId}/artifacts`,
+      `https://circleci.com/api/v1.1/project/gh/MetaMask/metamask-extension/${jobId}/artifacts`,
     );
 
-    const artifacts = (await response.json()).items;
+    const artifacts = await response.json();
 
     if (!artifacts || artifacts.length === 0) {
       return [];

.eslintrc.js

@@ -46,9 +46,7 @@ module.exports = {
         'development/**/*.js',
         'test/e2e/**/*.js',
         'test/helpers/*.js',
-        'test/lib/wait-until-called.js',
         'test/run-unit-tests.js',
-        'test/merge-coverage.js',
       ],
       extends: [
         path.resolve(__dirname, '.eslintrc.base.js'),
@@ -94,8 +92,6 @@ module.exports = {
         'test/stub/**/*.js',
         'test/unit-global/**/*.js',
       ],
-      // TODO: Convert these files to modern JS
-      excludedFiles: ['test/lib/wait-until-called.js'],
       extends: [
         path.resolve(__dirname, '.eslintrc.base.js'),
         path.resolve(__dirname, '.eslintrc.node.js'),
@@ -261,26 +257,7 @@ module.exports = {
      * Mocha library.
      */
     {
-      files: [
-        '**/*.test.js',
-        'test/lib/wait-until-called.js',
-        'test/e2e/**/*.spec.js',
-      ],
-      excludedFiles: [
-        'app/scripts/controllers/app-state.test.js',
-        'app/scripts/controllers/mmi-controller.test.js',
-        'app/scripts/controllers/permissions/**/*.test.js',
-        'app/scripts/controllers/preferences.test.js',
-        'app/scripts/lib/**/*.test.js',
-        'app/scripts/metamask-controller.test.js',
-        'app/scripts/migrations/*.test.js',
-        'app/scripts/platforms/*.test.js',
-        'development/**/*.test.js',
-        'shared/**/*.test.js',
-        'ui/**/*.test.js',
-        'ui/__mocks__/*.js',
-        'test/e2e/helpers.test.js',
-      ],
+      files: ['test/e2e/**/*.spec.js', 'test/unit-global/*.test.js'],
       extends: ['@metamask/eslint-config-mocha'],
       rules: {
         // In Mocha tests, it is common to use `this` to store values or do
@@ -293,13 +270,19 @@ module.exports = {
      * Jest tests
      *
      * These are files that make use of globals and syntax introduced by the
-     * Jest library. The files in this section should match the Mocha excludedFiles section.
+     * Jest library.
+     * TODO: This list of files is incomplete, and should be replaced with globs that match the
+     * Jest config.
      */
     {
       files: [
         '**/__snapshots__/*.snap',
         'app/scripts/controllers/app-state.test.js',
         'app/scripts/controllers/mmi-controller.test.ts',
+        'app/scripts/metamask-controller.actions.test.js',
+        'app/scripts/detect-multiple-instances.test.js',
+        'app/scripts/controllers/swaps.test.js',
+        'app/scripts/controllers/metametrics.test.js',
         'app/scripts/controllers/permissions/**/*.test.js',
         'app/scripts/controllers/preferences.test.js',
         'app/scripts/lib/**/*.test.js',
@@ -383,7 +366,6 @@ module.exports = {
         'test/e2e/benchmark.js',
         'test/helpers/setup-helper.js',
         'test/run-unit-tests.js',
-        'test/merge-coverage.js',
       ],
       rules: {
         'node/no-process-exit': 'off',

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -29,7 +29,7 @@ body:
    id: screenshot-recording
    attributes:
      label: Screenshots/Recordings
-     description: Please include screenshots/recordings if applicable! (https://recordit.co/ is recommended)
+     description: Please include screenshots/recordings if applicable!
  - type: textarea
    id: reproduce
    attributes:

.github/ISSUE_TEMPLATE/config.yml

@@ -4,5 +4,5 @@ contact_links:
     url: https://community.metamask.io/c/feature-requests-ideas/
     about: Request new features and vote on the ones that are important to you
   - name: Get support or ask a question
-    url: https://metamask.zendesk.com/hc/en-us
+    url: https://support.metamask.io/
     about: Use the MetaMask support system to get help and ask questions

.github/scripts/add-team-label-to-pr.ts

@@ -0,0 +1,89 @@
+import * as core from '@actions/core';
+import { context, getOctokit } from '@actions/github';
+import { GitHub } from '@actions/github/lib/utils';
+
+import { retrieveLabel } from './shared/label';
+import { Labelable, addLabelByIdToLabelable } from './shared/labelable';
+import { retrievePullRequest } from './shared/pull-request';
+
+main().catch((error: Error): void => {
+  console.error(error);
+  process.exit(1);
+});
+
+async function main(): Promise<void> {
+  // "GITHUB_TOKEN" is an automatically generated, repository-specific access token provided by GitHub Actions.
+  // We can't use "GITHUB_TOKEN" here, as its permissions are scoped to the repository where the action is running.
+  // "GITHUB_TOKEN" does not have access to other repositories, even when they belong to the same organization.
+  // As we want to get files which are not necessarily located in the same repository,
+  // we need to create our own "RELEASE_LABEL_TOKEN" with "repo" permissions.
+  // Such a token allows to access other repositories of the MetaMask organisation.
+  const personalAccessToken = process.env.RELEASE_LABEL_TOKEN;
+  if (!personalAccessToken) {
+    core.setFailed('RELEASE_LABEL_TOKEN not found');
+    process.exit(1);
+  }
+
+  // Initialise octokit, required to call Github GraphQL API
+  const octokit: InstanceType<typeof GitHub> = getOctokit(personalAccessToken, {
+    previews: ['bane'], // The "bane" preview is required for adding, updating, creating and deleting labels.
+  });
+
+  // Retrieve pull request info from context
+  const pullRequestRepoOwner = context.repo.owner;
+  const pullRequestRepoName = context.repo.repo;
+  const pullRequestNumber = context.payload.pull_request?.number;
+  if (!pullRequestNumber) {
+    core.setFailed('Pull request number not found');
+    process.exit(1);
+  }
+
+  // Retrieve pull request
+  const pullRequest: Labelable = await retrievePullRequest(
+    octokit,
+    pullRequestRepoOwner,
+    pullRequestRepoName,
+    pullRequestNumber,
+  );
+
+  // Get the team label id based on the author of the pull request
+  const teamLabelId = await getTeamLabelIdByAuthor(
+    octokit,
+    pullRequestRepoOwner,
+    pullRequestRepoName,
+    pullRequest.author,
+  );
+
+  // Add the team label by id to the pull request
+  await addLabelByIdToLabelable(octokit, pullRequest, teamLabelId);
+}
+
+// This helper function gets the team label id based on the author of the pull request
+const getTeamLabelIdByAuthor = async (
+  octokit: InstanceType<typeof GitHub>,
+  repoOwner: string,
+  repoName: string,
+  author: string,
+): Promise<string> => {
+  // Retrieve the teams.json file from the repository
+  const { data } = (await octokit.request(
+    'GET /repos/{owner}/{repo}/contents/{path}',
+    { owner: repoOwner, repo: 'MetaMask-planning', path: 'teams.json' },
+  )) as { data: { content: string } };
+
+  // Parse the teams.json file content to json from base64
+  const teamMembers: Record<string, string> = JSON.parse(atob(data.content));
+
+  // Get the label name based on the author
+  const labelName = teamMembers[author];
+
+  if (!labelName) {
+    core.setFailed(`Team label not found for author: ${author}`);
+    process.exit(1);
+  }
+
+  // Retrieve the label id based on the label name
+  const labelId = await retrieveLabel(octokit, repoOwner, repoName, labelName);
+
+  return labelId;
+};

.github/scripts/shared/label.ts

@@ -93,7 +93,7 @@ async function createLabel(
 }
 
 // This function retrieves the label on a specific repo
-async function retrieveLabel(
+export async function retrieveLabel(
   octokit: InstanceType<typeof GitHub>,
   repoOwner: string,
   repoName: string,

.github/scripts/shared/labelable.ts

@@ -27,14 +27,14 @@ export interface Labelable {
 export function findLabel(
   labelable: Labelable,
   labelToFind: Label,
-): {
-  id: string;
-  name: string;
-} | undefined {
+):
+  | {
+      id: string;
+      name: string;
+    }
+  | undefined {
   // Check if label is present on labelable
-  return labelable.labels.find(
-    (label) => label.name === labelToFind.name,
-  );
+  return labelable.labels.find((label) => label.name === labelToFind.name);
 }
 
 // This function adds label to a labelable object (i.e. a pull request or an issue)
@@ -51,6 +51,15 @@ export async function addLabelToLabelable(
     label,
   );
 
+  await addLabelByIdToLabelable(octokit, labelable, labelId);
+}
+
+// This function adds label by id to a labelable object (i.e. a pull request or an issue)
+export async function addLabelByIdToLabelable(
+  octokit: InstanceType<typeof GitHub>,
+  labelable: Labelable,
+  labelId: string,
+): Promise<void> {
   const addLabelsToLabelableMutation = `
       mutation AddLabelsToLabelable($labelableId: ID!, $labelIds: [ID!]!) {
         addLabelsToLabelable(input: {labelableId: $labelableId, labelIds: $labelIds}) {

.github/workflows/add-team-label.yml

@@ -0,0 +1,37 @@
+name: Add team label to PR when it is opened
+
+on:
+  pull_request:
+    types:
+      - opened
+
+jobs:
+  add-team-label:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 'lts/*'
+
+      - run: corepack enable
+
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+            fetch-depth: 0 # This is needed to checkout all branches
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: '.nvmrc'
+          cache: yarn
+
+      - name: Install dependencies
+        run: yarn --immutable
+
+      - name: Add team label to PR
+        id: add-team-label-to-pr
+        env:
+          RELEASE_LABEL_TOKEN: ${{ secrets.RELEASE_LABEL_TOKEN }}
+        run: yarn run add-team-label-to-pr

.github/workflows/sonar.yml

@@ -1,18 +1,11 @@
 name: Sonar
 on:
-  workflow_call:
-    secrets:
-      SONAR_TOKEN:
-        required: true
-#  pull_request:
-#    branches:
-#      - develop
-#    types:
-#      - opened
-#      - reopened
-#      - synchronize
-#      - labeled
-#      - unlabeled
+  push:
+    branches:
+      - develop
+  pull_request:
+    branches:
+      - develop
 
 jobs:
   sonarcloud:
@@ -25,8 +18,5 @@ jobs:
       - name: SonarCloud Scan
         # This is SonarSource/[email protected]
         uses: SonarSource/sonarcloud-github-action@4b4d7634dab97dcee0b75763a54a6dc92a9e6bc1
-        with:
-          args: >
-            -Dsonar.javascript.lcov.reportPaths=tests/coverage/lcov.info
         env:
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}

.github/workflows/update-lavamoat-policies.yml

@@ -112,7 +112,7 @@ jobs:
       matrix:
         # Ensure this is synchronized with the list below in the "commit-updated-policies" job
         # and with the build type list in `builds.yml`
-        build-type: [main, beta, flask, mmi, desktop]
+        build-type: [main, beta, flask, mmi]
     name: Update LavaMoat ${{ matrix.build-type }} application policy
     runs-on: ubuntu-latest
     needs:
@@ -184,7 +184,7 @@ jobs:
           path: lavamoat/build-system
           key: cache-build-${{ needs.prepare.outputs.COMMIT_SHA }}
           fail-on-cache-miss: true
-      # One restore step per build type: [main, beta, flask, mmi, desktop]
+      # One restore step per build type: [main, beta, flask, mmi]
       # Ensure this is synchronized with the list above in the "update-lavamoat-webapp-policy" job
       # and with the build type list in `builds.yml`
       - name: Restore main application policy
@@ -211,12 +211,6 @@ jobs:
           path: lavamoat/browserify/mmi
           key: cache-mmi-${{ needs.prepare.outputs.COMMIT_SHA }}
           fail-on-cache-miss: true
-      - name: Restore desktop application policy
-        uses: actions/cache/restore@v3
-        with:
-          path: lavamoat/browserify/desktop
-          key: cache-desktop-${{ needs.prepare.outputs.COMMIT_SHA }}
-          fail-on-cache-miss: true
       - name: Check whether there are policy changes
         id: policy-changes
         run: |