Migrate-AvatarIcon

.github/scripts/label-prs.ts

@@ -0,0 +1,177 @@
+import * as core from '@actions/core';
+import { context, getOctokit } from '@actions/github';
+import { GitHub } from '@actions/github/lib/utils';
+
+main().catch((error: Error): void => {
+  console.error(error);
+  process.exit(1);
+});
+
+async function main(): Promise<void> {
+  const token = process.env.GITHUB_TOKEN;
+
+  if (!token) {
+    core.setFailed('GITHUB_TOKEN not found');
+    process.exit(1);
+  }
+
+  const octokit = getOctokit(token);
+
+  const headRef = context.payload.pull_request?.head.ref || '';
+
+  let issueNumber = await getIssueNumberFromPullRequestBody();
+  if (issueNumber === "") {
+    bailIfIsBranchNameInvalid(headRef);
+    bailIfIsNotFeatureBranch(headRef);
+    issueNumber = getIssueNumberFromBranchName(headRef);
+  }
+
+  if (Number(issueNumber) === 0) {
+    process.exit(0);
+  }
+
+  await updateLabels(octokit, issueNumber);
+}
+
+async function getIssueNumberFromPullRequestBody(): Promise<string> {
+  console.log("Checking if the PR's body references an issue...");
+
+  let ISSUE_LINK_IN_PR_DESCRIPTION_REGEX =
+    /(close|closes|closed|fix|fixes|fixed|resolve|resolves|resolved)\s#\d+/gi;
+
+  const prBody = await getPullRequestBody();
+
+  let matches = prBody.match(ISSUE_LINK_IN_PR_DESCRIPTION_REGEX);
+  if (!matches || matches?.length === 0) {
+    console.log(
+      'No direct link can be drawn between the PR and an issue from the PR body because no issue number was referenced.',
+    );
+    return "";
+  }
+
+  if (matches?.length > 1) {
+    console.log(
+      'No direct link can be drawn between the PR and an issue from the PR body because more than one issue number was referenced.',
+    );
+    return "";
+  }
+
+  const ISSUE_NUMBER_REGEX = /\d+/;
+  const issueNumber = matches[0].match(ISSUE_NUMBER_REGEX)?.[0] || '';
+
+  console.log(`Found issue number ${issueNumber} in PR body.`);
+
+  return issueNumber;
+}
+
+async function getPullRequestBody(): Promise<string> {
+  if (context.eventName !== 'pull_request') {
+    console.log('This action should only run on pull_request events.');
+    process.exit(1);
+  }
+
+  const prBody = context.payload.pull_request?.body || '';
+  return prBody;
+}
+
+function bailIfIsBranchNameInvalid(branchName: string): void {
+  const BRANCH_REGEX =
+    /^(main|develop|(ci|chore|docs|feat|feature|fix|perf|refactor|revert|style)\/\d*(?:[-](?![-])\w*)*|Version-v\d+\.\d+\.\d+)$/;
+  const isValidBranchName = new RegExp(BRANCH_REGEX).test(branchName);
+
+  if (!isValidBranchName) {
+    console.log('This branch name does not follow the convention.');
+    console.log(
+      'Here are some example branch names that are accepted: "fix/123-description", "feat/123-longer-description", "feature/123", "main", "develop", "Version-v10.24.2".',
+    );
+    console.log(
+      'No issue could be linked to this PR, so no labels were copied',
+    );
+
+    process.exit(0);
+  }
+}
+
+function bailIfIsNotFeatureBranch(branchName: string): void {
+  if (
+    branchName === 'main' ||
+    branchName === 'develop' ||
+    branchName.startsWith('Version-v')
+  ) {
+    console.log(`${branchName} is not a feature branch.`);
+    console.log(
+      'No issue could be linked to this PR, so no labels were copied',
+    );
+    process.exit(0);
+  }
+}
+
+async function updateLabels(octokit: InstanceType<typeof GitHub>, issueNumber: string): Promise<void> {
+  interface ILabel {
+    name: string;
+  };
+
+  const owner = context.repo.owner;
+  const repo = context.repo.repo;
+
+  const issue = await octokit.rest.issues.get({
+    owner: owner,
+    repo: repo,
+    issue_number: Number(issueNumber),
+  });
+
+  const getNameFromLabel = (label: ILabel): string => label.name
+
+  const issueLabels = issue.data.labels.map(label => getNameFromLabel(label as ILabel));
+
+  const prNumber = context.payload.number;
+
+  const pr = await octokit.rest.issues.get({
+    owner: owner,
+    repo: repo,
+    issue_number: prNumber,
+  });
+
+  const startingPRLabels = pr.data.labels.map(label => getNameFromLabel(label as ILabel));
+
+  const dedupedFinalPRLabels = [
+    ...new Set([...startingPRLabels, ...issueLabels]),
+  ];
+
+  const hasIssueAdditionalLabels = !sortedArrayEqual(
+    startingPRLabels,
+    dedupedFinalPRLabels,
+  );
+  if (hasIssueAdditionalLabels) {
+    await octokit.rest.issues.update({
+      owner,
+      repo,
+      issue_number: prNumber,
+      labels: dedupedFinalPRLabels,
+    });
+  }
+}
+
+function getIssueNumberFromBranchName(branchName: string): string {
+  console.log('Checking if the branch name references an issue...');
+
+  let issueNumber: string;
+  if (branchName.split('/').length > 1) {
+    issueNumber = branchName.split('/')[1].split('-')[0];
+  } else {
+    issueNumber = branchName.split('-')[0];
+  }
+
+  console.log(`Found issue number ${issueNumber} in branch name.`);
+
+  return issueNumber;
+}
+
+function sortedArrayEqual(array1: string[], array2: string[]): boolean {
+  const lengthsAreEqual = array1.length === array2.length;
+  const everyElementMatchesByIndex = array1.every(
+    (value: string, index: number): boolean => value === array2[index],
+  );
+
+  return lengthsAreEqual && everyElementMatchesByIndex;
+}

.github/workflows/label-prs.yml

@@ -0,0 +1,32 @@
+name: Label PR
+
+on:
+  pull_request:
+    types: [assigned, opened, edited, synchronize, reopened]
+
+jobs:
+  label-pr:
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+
+    - name: Use Node.js
+      uses: actions/setup-node@v3
+      with:
+        node-version: '16'
+
+    - name: Install Yarn
+      run: npm install -g yarn
+
+    - name: Install dependencies
+      run: yarn
+
+    - name: Run PR labelling script
+      run: npm run label-prs
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

app/scripts/background.js

@@ -9,6 +9,9 @@ import debounce from 'debounce-stream';
 import log from 'loglevel';
 import browser from 'webextension-polyfill';
 import { storeAsStream } from '@metamask/obs-store';
+///: BEGIN:ONLY_INCLUDE_IN(snaps)
+import { ApprovalType } from '@metamask/controller-utils';
+///: END:ONLY_INCLUDE_IN
 import PortStream from 'extension-port-stream';
 
 import { ethErrors } from 'eth-rpc-errors';
@@ -18,9 +21,6 @@ import {
   ENVIRONMENT_TYPE_FULLSCREEN,
   EXTENSION_MESSAGES,
   PLATFORM_FIREFOX,
-  ///: BEGIN:ONLY_INCLUDE_IN(snaps)
-  MESSAGE_TYPE,
-  ///: END:ONLY_INCLUDE_IN
 } from '../../shared/constants/app';
 import {
   REJECT_NOTIFICATION_CLOSE,
@@ -713,7 +713,9 @@ export function setupController(
   // User Interface setup
   //
 
-  updateBadge();
+  controller.txController.initApprovals().then(() => {
+    updateBadge();
+  });
   controller.txController.on(
     METAMASK_CONTROLLER_EVENTS.UPDATE_BADGE,
     updateBadge,
@@ -800,11 +802,11 @@ export function setupController(
       ({ id, type }) => {
         switch (type) {
           ///: BEGIN:ONLY_INCLUDE_IN(snaps)
-          case MESSAGE_TYPE.SNAP_DIALOG_ALERT:
-          case MESSAGE_TYPE.SNAP_DIALOG_PROMPT:
+          case ApprovalType.SnapDialogAlert:
+          case ApprovalType.SnapDialogPrompt:
             controller.approvalController.accept(id, null);
             break;
-          case MESSAGE_TYPE.SNAP_DIALOG_CONFIRMATION:
+          case ApprovalType.SnapDialogConfirmation:
             controller.approvalController.accept(id, false);
             break;
           ///: END:ONLY_INCLUDE_IN

app/scripts/controllers/app-state.js

@@ -2,6 +2,7 @@ import EventEmitter from 'events';
 import { ObservableStore } from '@metamask/obs-store';
 import { v4 as uuid } from 'uuid';
 import log from 'loglevel';
+import { ApprovalType } from '@metamask/controller-utils';
 import { METAMASK_CONTROLLER_EVENTS } from '../metamask-controller';
 import { MINUTE } from '../../../shared/constants/time';
 import { AUTO_LOCK_TIMEOUT_ALARM } from '../../../shared/constants/alarms';
@@ -13,8 +14,6 @@ import {
   ORIGIN_METAMASK,
 } from '../../../shared/constants/app';
 
-const APPROVAL_REQUEST_TYPE = 'unlock';
-
 export default class AppStateController extends EventEmitter {
   /**
    * @param {object} opts
@@ -408,7 +407,7 @@ export default class AppStateController extends EventEmitter {
         {
           id: this._approvalRequestId,
           origin: ORIGIN_METAMASK,
-          type: APPROVAL_REQUEST_TYPE,
+          type: ApprovalType.Unlock,
         },
         true,
       )

app/scripts/controllers/network/network-controller.ts

@@ -307,10 +307,9 @@ function isErrorWithCode(error: unknown): error is { code: string | number } {
  * @param value - The value to check.
  */
 function assertNetworkId(value: any): asserts value is NetworkId {
-  assert(
-    /^\d+$/u.test(value) && !Number.isNaN(Number(value)),
-    'value is not a number',
-  );
+  if (!/^\d+$/u.test(value) || Number.isNaN(Number(value))) {
+    throw new Error('value is not a number');
+  }
 }
 
 /**
@@ -624,12 +623,14 @@ export class NetworkController extends EventEmitter {
       supportsEIP1559 = results[1];
       networkStatus = NetworkStatus.Available;
     } catch (error) {
-      if (isErrorWithCode(error) && isErrorWithMessage(error)) {
+      if (isErrorWithCode(error)) {
         let responseBody;
-        try {
-          responseBody = JSON.parse(error.message);
-        } catch {
-          // error.message must not be JSON
+        if (isInfura && isErrorWithMessage(error)) {
+          try {
+            responseBody = JSON.parse(error.message);
+          } catch {
+            // error.message must not be JSON
+          }
         }
 
         if (

app/scripts/controllers/network/provider-api-tests/shared-tests.ts

@@ -295,9 +295,8 @@ export function testsForProviderType(providerType: ProviderType) {
         // tests on the core side.
 
         { name: 'net_listening', numberOfParameters: 0 },
-        // TODO: Methods to add back when we add testing for subscribe middleware
-        // { name: 'eth_subscribe', numberOfParameters: 1 },
-        // { name: 'eth_unsubscribe', numberOfParameters: 1 },
+        { name: 'eth_subscribe', numberOfParameters: 1 },
+        { name: 'eth_unsubscribe', numberOfParameters: 1 },
         { name: 'custom_rpc_method', numberOfParameters: 1 },
         { name: 'net_peerCount', numberOfParameters: 0 },
         { name: 'parity_nextNonce', numberOfParameters: 1 },