Merge branch 'main' into fix/update-padding-gas-fee-pill

Author: vinistevam

.github/scripts/create-e2e-test-report.ts

@@ -1,81 +1,17 @@
 import * as fs from 'fs/promises';
-import humanizeDuration from 'humanize-duration';
 import path from 'path';
-import * as xml2js from 'xml2js';
-
-const XML = {
-  parse: new xml2js.Parser().parseStringPromise,
-};
-
-const humanizer = humanizeDuration.humanizer({
-  language: 'shortEn',
-  languages: {
-    shortEn: {
-      y: () => 'y',
-      mo: () => 'mo',
-      w: () => 'w',
-      d: () => 'd',
-      h: () => 'h',
-      m: () => 'm',
-      s: () => 's',
-      ms: () => 'ms',
-    },
-  },
-  delimiter: ' ',
-  spacer: '',
-  round: true,
-});
-
-function formatTime(ms: number): string {
-  if (ms < 1000) {
-    return `${Math.round(ms)}ms`;
-  }
-  return humanizer(ms);
-}
-
-/**
- * Replaces HTML `<strong>` tags with ANSI escape codes to format
- * text as bold in the console output.
- */
-function consoleBold(str: string): string {
-  return str
-    .replaceAll('<strong>', '\x1b[1m')
-    .replaceAll('</strong>', '\x1b[0m');
-}
-
-interface TestRun {
-  name: string;
-  testSuites: TestSuite[];
-}
-
-interface TestSuite {
-  name: string;
-  job: {
-    name: string;
-    id: string;
-  };
-  path: string;
-  date: Date;
-  tests: number;
-  passed: number;
-  failed: number;
-  skipped: number;
-  time: number;
-  testCases: TestCase[];
-}
-
-type TestCase =
-  | {
-      name: string;
-      time: number;
-      status: 'passed';
-    }
-  | {
-      name: string;
-      time: number;
-      status: 'failed';
-      error: string;
-    };
+import type {
+  TestCase,
+  TestFile,
+  TestRun,
+  TestSuite,
+} from './shared/test-reports';
+import {
+  consoleBold,
+  formatTime,
+  normalizeTestPath,
+  XML,
+} from './shared/utils';
 
 async function main() {
   const env = {
@@ -115,15 +51,16 @@ async function main() {
         'utf8',
       );
       const results = await XML.parse(file);
+
       for (const suite of results.testsuites.testsuite || []) {
         if (!suite.testcase || !suite.$.file) continue;
         const tests = +suite.$.tests;
         const failed = +suite.$.failures;
         const skipped = tests - suite.testcase.length;
         const passed = tests - failed - skipped;
+
         const testSuite: TestSuite = {
           name: suite.$.name,
-          path: suite.$.file.slice(suite.$.file.indexOf(`test${path.sep}`)),
           job: {
             name: suite.properties?.[0].property?.[0]?.$.value ?? '',
             id: suite.properties?.[0].property?.[1]?.$.value ?? '',
@@ -134,8 +71,10 @@ async function main() {
           failed,
           skipped,
           time: +suite.$.time * 1000, // convert to ms,
+          attempts: [],
           testCases: [],
         };
+
         for (const test of suite.testcase || []) {
           const testCase: TestCase = {
             name: test.$.name,
@@ -145,63 +84,125 @@ async function main() {
           };
           testSuite.testCases.push(testCase);
         }
+
+        const testFile: TestFile = {
+          path: normalizeTestPath(suite.$.file),
+          tests: testSuite.tests,
+          passed: testSuite.passed,
+          failed: testSuite.failed,
+          skipped: testSuite.skipped,
+          time: testSuite.time,
+          testSuites: [testSuite],
+        };
+
         const testRun: TestRun = {
           // regex to remove the shard number from the job name
           name: testSuite.job.name.replace(/\s+\(\d+\)$/, ''),
-          testSuites: [testSuite],
+          testFiles: [testFile],
         };
+
         const existingRun = testRuns.find((run) => run.name === testRun.name);
         if (existingRun) {
-          existingRun.testSuites.push(testSuite);
+          const existingFile = existingRun.testFiles.find(
+            (file) => file.path === testFile.path,
+          );
+          if (existingFile) {
+            existingFile.testSuites.push(testSuite);
+          } else {
+            existingRun.testFiles.push(testFile);
+          }
         } else {
           testRuns.push(testRun);
         }
       }
     }
 
     for (const testRun of testRuns) {
-      const deduped: { [path: string]: TestSuite } = {};
-      for (const suite of testRun.testSuites) {
-        const existing = deduped[suite.path];
-        // If there is a duplicate, we keep the suite with the latest date
-        if (!existing || existing.date < suite.date) {
-          deduped[suite.path] = suite;
+      for (const testFile of testRun.testFiles) {
+        // Group test suites by name
+        const suitesByName: Record<string, TestSuite[]> = {};
+
+        for (const suite of testFile.testSuites) {
+          if (!suitesByName[suite.name]) {
+            suitesByName[suite.name] = [];
+          }
+          suitesByName[suite.name].push(suite);
         }
-      }
 
-      const suites = Object.values(deduped);
+        // Determine the latest test suite by date and nest attempts
+        const attempts: TestSuite[][] = [];
+        for (const suites of Object.values(suitesByName)) {
+          suites.sort((a, b) => b.date.getTime() - a.date.getTime()); // sort newest first
+          const [latest, ...otherAttempts] = suites;
+          latest.attempts = otherAttempts;
+          attempts.push(otherAttempts);
+        }
 
-      const title = `<strong>${testRun.name}</strong>`;
-      console.log(consoleBold(title));
+        // Remove the nested attempts from the top-level list
+        const attemptSet = new Set(attempts.flat());
+        testFile.testSuites = testFile.testSuites.filter(
+          (suite) => !attemptSet.has(suite),
+        );
 
-      if (suites.length) {
-        const total = suites.reduce(
+        const total = testFile.testSuites.reduce(
           (acc, suite) => ({
             tests: acc.tests + suite.tests,
             passed: acc.passed + suite.passed,
             failed: acc.failed + suite.failed,
             skipped: acc.skipped + suite.skipped,
+            time: acc.time + suite.time,
           }),
-          { tests: 0, passed: 0, failed: 0, skipped: 0 },
+          { tests: 0, passed: 0, failed: 0, skipped: 0, time: 0 },
         );
 
-        core.summary.addRaw(
-          total.failed ? `\n<details open>\n` : `\n<details>\n`,
+        testFile.tests = total.tests;
+        testFile.passed = total.passed;
+        testFile.failed = total.failed;
+        testFile.skipped = total.skipped;
+        testFile.time = total.time;
+      }
+
+      testRun.testFiles.sort((a, b) => a.path.localeCompare(b.path));
+
+      const title = `<strong>${testRun.name}</strong>`;
+
+      if (testRun.testFiles.length) {
+        const total = testRun.testFiles.reduce(
+          (acc, file) => ({
+            tests: acc.tests + file.tests,
+            passed: acc.passed + file.passed,
+            failed: acc.failed + file.failed,
+            skipped: acc.skipped + file.skipped,
+            time: acc.time + file.time,
+          }),
+          { tests: 0, passed: 0, failed: 0, skipped: 0, time: 0 },
         );
-        core.summary.addRaw(`\n<summary>${title}</summary>\n`);
 
-        const times = suites.map((suite) => {
-          const start = suite.date.getTime();
-          const duration = suite.time;
-          return { start, end: start + duration };
-        });
+        if (total.failed > 0) {
+          if (testRun.name) console.log(`${consoleBold(title)} ❌`);
+          core.summary.addRaw(`\n<details open>\n`);
+          core.summary.addRaw(`\n<summary>${title} ❌</summary>\n`);
+        } else {
+          if (testRun.name) console.log(`${consoleBold(title)} ✅`);
+          core.summary.addRaw(`\n<details>\n`);
+          core.summary.addRaw(`\n<summary>${title} ✅</summary>\n`);
+        }
+
+        const times = testRun.testFiles
+          .map((file) =>
+            file.testSuites.map((suite) => ({
+              start: suite.date.getTime(),
+              end: suite.date.getTime() + suite.time,
+            })),
+          )
+          .flat();
         const earliestStart = Math.min(...times.map((t) => t.start));
         const latestEnd = Math.max(...times.map((t) => t.end));
         const executionTime = latestEnd - earliestStart;
 
-        const conclusion = `<strong>${
-          total.tests
-        }</strong> tests were completed in <strong>${formatTime(
+        const conclusion = `<strong>${total.tests}</strong> ${
+          total.tests === 1 ? 'test was' : 'tests were'
+        } completed in <strong>${formatTime(
           executionTime,
         )}</strong> with <strong>${total.passed}</strong> passed, <strong>${
           total.failed
@@ -216,37 +217,40 @@ async function main() {
           core.summary.addRaw(
             `\n<hr style="height: 1px; margin-top: -5px; margin-bottom: 10px;">\n`,
           );
-          for (const suite of suites) {
-            if (!suite.failed) continue;
-            console.error(suite.path);
+          for (const file of testRun.testFiles) {
+            if (file.failed === 0) continue;
+            console.error(file.path);
             core.summary.addRaw(
-              `\n#### [${suite.path}](https://github.com/${env.OWNER}/${env.REPOSITORY}/blob/${env.BRANCH}/${suite.path})\n`,
+              `\n#### [${file.path}](https://github.com/${env.OWNER}/${env.REPOSITORY}/blob/${env.BRANCH}/${file.path})\n`,
             );
-            if (suite.job.name && suite.job.id && env.RUN_ID) {
-              core.summary.addRaw(
-                `\n##### Job: [${suite.job.name}](https://github.com/${
-                  env.OWNER
-                }/${env.REPOSITORY}/actions/runs/${env.RUN_ID}/job/${
-                  suite.job.id
-                }${env.PR_NUMBER ? `?pr=${env.PR_NUMBER}` : ''})\n`,
-              );
-            }
-            for (const test of suite.testCases) {
-              if (test.status !== 'failed') continue;
-              console.error(`  ${test.name}`);
-              console.error(`  ${test.error}\n`);
-              core.summary.addRaw(`\n##### ${test.name}\n`);
-              core.summary.addRaw(`\n\`\`\`js\n${test.error}\n\`\`\`\n`);
+            for (const suite of file.testSuites) {
+              if (suite.failed === 0) continue;
+              if (suite.job.name && suite.job.id && env.RUN_ID) {
+                core.summary.addRaw(
+                  `\n##### Job: [${suite.job.name}](https://github.com/${
+                    env.OWNER
+                  }/${env.REPOSITORY}/actions/runs/${env.RUN_ID}/job/${
+                    suite.job.id
+                  }${env.PR_NUMBER ? `?pr=${env.PR_NUMBER}` : ''})\n`,
+                );
+              }
+              for (const test of suite.testCases) {
+                if (test.status !== 'failed') continue;
+                console.error(`  ${test.name}`);
+                console.error(`  ${test.error}\n`);
+                core.summary.addRaw(`\n##### ${test.name}\n`);
+                core.summary.addRaw(`\n\`\`\`js\n${test.error}\n\`\`\`\n`);
+              }
             }
           }
         }
 
-        const rows = suites.map((suite) => ({
-          'Test suite': suite.path,
-          Passed: suite.passed ? `${suite.passed} ✅` : '',
-          Failed: suite.failed ? `${suite.failed} ❌` : '',
-          Skipped: suite.skipped ? `${suite.skipped} ⏩` : '',
-          Time: formatTime(suite.time),
+        const rows = testRun.testFiles.map((file) => ({
+          'Test file': file.path,
+          Passed: file.passed ? `${file.passed} ✅` : '',
+          Failed: file.failed ? `${file.failed} ❌` : '',
+          Skipped: file.skipped ? `${file.skipped} ⏩` : '',
+          Time: formatTime(file.time),
         }));
 
         const columns = Object.keys(rows[0]);
@@ -256,7 +260,7 @@ async function main() {
           .map((row) => {
             const data = {
               ...row,
-              'Test suite': `[${row['Test suite']}](https://github.com/${env.OWNER}/${env.REPOSITORY}/blob/${env.BRANCH}/${row['Test suite']})`,
+              'Test file': `[${row['Test file']}](https://github.com/${env.OWNER}/${env.REPOSITORY}/blob/${env.BRANCH}/${row['Test file']})`,
             };
             return `| ${Object.values(data).join(' | ')} |`;
           })

.github/scripts/shared/test-reports.ts

@@ -0,0 +1,43 @@
+export interface TestRun {
+  name: string;
+  testFiles: TestFile[];
+}
+
+export interface TestFile {
+  path: string;
+  tests: number;
+  passed: number;
+  failed: number;
+  skipped: number;
+  time: number;
+  testSuites: TestSuite[];
+}
+
+export interface TestSuite {
+  name: string;
+  job: {
+    name: string;
+    id: string;
+  };
+  date: Date;
+  tests: number;
+  passed: number;
+  failed: number;
+  skipped: number;
+  time: number;
+  attempts: TestSuite[];
+  testCases: TestCase[];
+}
+
+export type TestCase =
+  | {
+      name: string;
+      time: number;
+      status: 'passed';
+    }
+  | {
+      name: string;
+      time: number;
+      status: 'failed';
+      error: string;
+    };