Merge branch 'main' into feat/add-unichain-logo

Author: salimtb

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

@@ -105,10 +105,12 @@ async function gitDiff(): Promise<string> {
   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) {

.github/workflows/validate-page-object-usage.yml

@@ -2,6 +2,8 @@ name: Validate E2E Page Object usage on modified files
 
 on:
   pull_request:
+    branches:
+      - main
     types:
       - opened
       - reopened

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

@@ -1,3 +1,4 @@
+import { noop } from 'lodash';
 import {
   getPPOMControllerMessenger,
   getPPOMControllerInitMessenger,
@@ -26,35 +27,43 @@ import {
 export const CONTROLLER_MESSENGERS = {
   CronjobController: {
     getMessenger: getCronjobControllerMessenger,
+    getInitMessenger: noop,
   },
   ExecutionService: {
     getMessenger: getExecutionServiceMessenger,
+    getInitMessenger: noop,
   },
   MultichainAssetsController: {
     getMessenger: getMultichainAssetsControllerMessenger,
+    getInitMessenger: noop,
   },
   MultichainBalancesController: {
     getMessenger: getMultichainBalancesControllerMessenger,
+    getInitMessenger: noop,
   },
   MultichainTransactionsController: {
     getMessenger: getMultichainTransactionsControllerMessenger,
+    getInitMessenger: noop,
   },
   RateLimitController: {
     getMessenger: getRateLimitControllerMessenger,
     getInitMessenger: getRateLimitControllerInitMessenger,
   },
   SnapsRegistry: {
     getMessenger: getSnapsRegistryMessenger,
+    getInitMessenger: noop,
   },
   SnapController: {
     getMessenger: getSnapControllerMessenger,
     getInitMessenger: getSnapControllerInitMessenger,
   },
   SnapInsightsController: {
     getMessenger: getSnapInsightsControllerMessenger,
+    getInitMessenger: noop,
   },
   SnapInterfaceController: {
     getMessenger: getSnapInterfaceControllerMessenger,
+    getInitMessenger: noop,
   },
   PPOMController: {
     getMessenger: getPPOMControllerMessenger,

app/scripts/controller-init/multichain/multichain-assets-controller-init.test.ts

@@ -20,6 +20,7 @@ function buildInitRequestMock(): jest.Mocked<
     controllerMessenger: getMultichainAssetsControllerMessenger(
       baseControllerMessenger,
     ),
+    initMessenger: undefined,
   };
 }
 

app/scripts/controller-init/multichain/multichain-balances-controller-init.test.ts

@@ -20,6 +20,7 @@ function buildInitRequestMock(): jest.Mocked<
     controllerMessenger: getMultichainBalancesControllerMessenger(
       baseControllerMessenger,
     ),
+    initMessenger: undefined,
   };
 }
 

app/scripts/controller-init/multichain/multichain-transactions-controller-init.test.ts

@@ -20,6 +20,7 @@ function buildInitRequestMock(): jest.Mocked<
     controllerMessenger: getMultichainTransactionsControllerMessenger(
       baseControllerMessenger,
     ),
+    initMessenger: undefined,
   };
 }
 

app/scripts/controller-init/snaps/cronjob-controller-init.test.ts

@@ -21,6 +21,7 @@ function getInitRequestMock(): jest.Mocked<
   const requestMock = {
     ...buildControllerInitRequestMock(),
     controllerMessenger: getCronjobControllerMessenger(baseMessenger),
+    initMessenger: undefined,
   };
 
   return requestMock;

app/scripts/controller-init/snaps/execution-service-init.test.ts

@@ -24,6 +24,7 @@ function getInitRequestMock(): jest.Mocked<
   const requestMock = {
     ...buildControllerInitRequestMock(),
     controllerMessenger: getExecutionServiceMessenger(baseMessenger),
+    initMessenger: undefined,
   };
 
   return requestMock;

app/scripts/controller-init/snaps/snap-insights-controller-init.test.ts

@@ -18,6 +18,7 @@ function getInitRequestMock(): jest.Mocked<
   const requestMock = {
     ...buildControllerInitRequestMock(),
     controllerMessenger: getSnapInsightsControllerMessenger(baseMessenger),
+    initMessenger: undefined,
   };
 
   return requestMock;

app/scripts/controller-init/snaps/snap-interface-controller-init.test.ts

@@ -18,6 +18,7 @@ function getInitRequestMock(): jest.Mocked<
   const requestMock = {
     ...buildControllerInitRequestMock(),
     controllerMessenger: getSnapInterfaceControllerMessenger(baseMessenger),
+    initMessenger: undefined,
   };
 
   return requestMock;

app/scripts/controller-init/snaps/snaps-registry-init.test.ts

@@ -18,6 +18,7 @@ function getInitRequestMock(): jest.Mocked<
   const requestMock = {
     ...buildControllerInitRequestMock(),
     controllerMessenger: getSnapsRegistryMessenger(baseMessenger),
+    initMessenger: undefined,
   };
 
   return requestMock;

app/scripts/controller-init/types.ts

@@ -161,15 +161,13 @@ export type ControllerInitRequest<
     message: string,
     url?: string,
   ) => Promise<void>;
-} & (InitMessengerType extends BaseRestrictedControllerMessenger
-  ? {
-      /**
-       * Required initialization messenger instance.
-       * Generated using the callback specified in `getInitMessengerCallback`.
-       */
-      initMessenger: InitMessengerType;
-    }
-  : unknown);
+
+  /**
+   * Required initialization messenger instance.
+   * Generated using the callback specified in `getInitMessengerCallback`.
+   */
+  initMessenger: InitMessengerType;
+};
 
 /**
  * A single background API method available to the UI.

app/scripts/controller-init/utils.ts

@@ -29,14 +29,26 @@ export type InitControllersResult = {
 
 type BaseControllerInitRequest = ControllerInitRequest<
   BaseRestrictedControllerMessenger,
-  BaseRestrictedControllerMessenger
+  BaseRestrictedControllerMessenger | void
 >;
 
 type ControllerMessengerCallback = (
   BaseControllerMessenger: BaseControllerMessenger,
 ) => BaseRestrictedControllerMessenger;
 
-type ControllersToInitialize = 'PPOMController' | 'TransactionController';
+export type ControllersToInitialize =
+  | 'CronjobController'
+  | 'ExecutionService'
+  | 'MultichainAssetsController'
+  | 'MultichainBalancesController'
+  | 'MultichainTransactionsController'
+  | 'RateLimitController'
+  | 'SnapsRegistry'
+  | 'SnapController'
+  | 'SnapInsightsController'
+  | 'SnapInterfaceController'
+  | 'PPOMController'
+  | 'TransactionController';
 
 type InitFunction<Name extends ControllersToInitialize> =
   ControllerInitFunction<
@@ -101,7 +113,6 @@ export function initControllers({
     const messengerCallbacks = CONTROLLER_MESSENGERS[controllerName];
 
     const controllerMessengerCallback =
-      // @ts-expect-error TODO: Resolve mismatch between base-controller versions.
       messengerCallbacks?.getMessenger as ControllerMessengerCallback;
 
     const initMessengerCallback =
@@ -120,11 +131,8 @@ export function initControllers({
       initMessenger,
     };
 
-    // TODO: Remove @ts-expect-error once base-controller version mismatch is resolved
-    // Instead of suppressing all type errors, we'll be specific about the controllerMessenger mismatch
     const result = initFunction({
       ...finalInitRequest,
-      // @ts-expect-error TODO: Resolve mismatch between base-controller versions.
       controllerMessenger: finalInitRequest.controllerMessenger,
     });
 
@@ -144,8 +152,8 @@ export function initControllers({
     const memStateKey =
       memStateKeyRaw === null ? undefined : memStateKeyRaw ?? controllerName;
 
-    partialControllersByName[controllerName] = controller as Controller &
-      undefined;
+    // @ts-expect-error: Union too complex.
+    partialControllersByName[controllerName] = controller;
 
     controllerApi = {
       ...controllerApi,

test/e2e/changedFilesUtil.js

@@ -7,6 +7,7 @@ const CHANGED_FILES_PATH = path.join(
   'changed-files',
   'changed-files.txt',
 );
+const PR_INFO_PATH = path.join(BASE_PATH, 'changed-files', 'pr-body.txt');
 
 /**
  * Reads the list of changed files from the git diff file with status (A, M, D).
@@ -80,10 +81,49 @@ function getChangedAndNewFiles(changedFiles) {
   return changedFiles.map((file) => file.filePath);
 }
 
+/**
+ * Checks if the E2E quality gate should be skipped based on the PR info.
+ *
+ * @returns {boolean} True if the quality gate should be skipped, otherwise false.
+ */
+function shouldE2eQualityGateBeSkipped() {
+  try {
+    const data = fs.readFileSync(PR_INFO_PATH, 'utf8');
+    const lines = data.split('\n');
+    const labelsLine = lines.find((line) => line.startsWith('PR labels:'));
+    const baseLine = lines.find((line) => line.startsWith('PR base:'));
+
+    const labels = labelsLine
+      ? labelsLine
+          .replace(/PR labels: \{/gu, '')
+          .replace(/\}/gu, '')
+          .split(',')
+          .map((label) => label.trim())
+      : [];
+    const base = baseLine
+      ? baseLine
+          .replace(/PR base: \{/gu, '')
+          .replace(/\}/gu, '')
+          .trim()
+      : '';
+    console.log('PR labels', labels);
+    console.log('PR base', base);
+
+    const skipGate =
+      labels.includes('skip-e2e-quality-gate') || base !== 'main';
+    console.log('Should we skip the e2e quality gate:', skipGate);
+    return skipGate;
+  } catch (error) {
+    console.error('Error reading PR body file:', error);
+    return false;
+  }
+}
+
 module.exports = {
   filterE2eChangedFiles,
   getChangedAndNewFiles,
   getChangedFilesOnly,
   getNewFilesOnly,
   readChangedAndNewFilesWithStatus,
+  shouldE2eQualityGateBeSkipped,
 };

test/e2e/run-all.js

@@ -10,6 +10,7 @@ const {
   filterE2eChangedFiles,
   getChangedAndNewFiles,
   readChangedAndNewFilesWithStatus,
+  shouldE2eQualityGateBeSkipped,
 } = require('./changedFilesUtil');
 
 // These tests should only be run on Flask for now.
@@ -75,10 +76,9 @@ function runningOnCircleCI(testPaths) {
   const changedOrNewTests = filterE2eChangedFiles(changedandNewFilesPaths);
   console.log('Changed or new test list:', changedOrNewTests);
 
-  const fullTestList = applyQualityGate(
-    testPaths.join('\n'),
-    changedOrNewTests,
-  );
+  const fullTestList = shouldE2eQualityGateBeSkipped()
+    ? testPaths.join('\n')
+    : applyQualityGate(testPaths.join('\n'), changedOrNewTests);
 
   console.log('Full test list:', fullTestList);
   fs.writeFileSync('test/test-results/fullTestList.txt', fullTestList);