fix: split files

Author: github-actions[bot]

.github/workflows/scripts/update-pr-description.js

@@ -1,161 +1,41 @@
-const fs = require('fs');
-
-// Helper function to extract all tests from a suite recursively
-function extractTestsFromSuite(suite, parentTitle = '') {
-  let tests = [];
-  const fullSuiteTitle = parentTitle ? `${parentTitle} > ${suite.title}` : suite.title;
-  
-  if (suite.specs) {
-    tests.push(...suite.specs.map(spec => {
-      const isSkipped = spec.tests && spec.tests[0] && 
-        (spec.tests[0].annotations?.some(a => a.type === 'skip') || 
-         spec.tests[0].status === 'skipped');
-      
-      return {
-        title: spec.title,
-        fullTitle: `${fullSuiteTitle} > ${spec.title}`,
-        status: isSkipped ? 'skipped' : (spec.ok ? 'passed' : 'failed'),
-        file: suite.file,
-        skipped: isSkipped
-      };
-    }));
-  }
+const { compareTests } = require('./utils/test');
+const { generateTestChangesSummary } = require('./utils/format');
+const { generateBundleSizeSection, getBundleInfo } = require('./utils/bundle');
+const { readTestResults, getTestStatus } = require('./utils/results');
+
+/**
+ * Main function to update PR description with test results and bundle size information
+ * @param {Object} github - GitHub API object
+ * @param {Object} context - GitHub Actions context
+ */
+async function updatePRDescription(github, context) {
+  // Read test results
+  const currentResults = readTestResults('playwright-artifacts/test-results.json');
+  const mainResults = readTestResults('gh-pages/main/test-results.json');
 
-  // Recursively process nested suites
-  if (suite.suites) {
-    suite.suites.forEach(nestedSuite => {
-      tests.push(...extractTestsFromSuite(nestedSuite, fullSuiteTitle));
-    });
-  }
+  // Compare tests
+  const testComparison = compareTests(currentResults.tests, mainResults.tests);
 
-  return tests;
-}
-
-function formatSize(size) {
-  if (size >= 1024) {
-    return `${(size / (1024 * 1024)).toFixed(2)} MB`;
-  }
-  return `${(size / 1024).toFixed(2)} KB`;
-}
-
-async function updatePRDescription(github, context) {
-  const testResultsPath = 'playwright-artifacts/test-results.json';
-  const mainTestResultsPath = 'gh-pages/main/test-results.json';
-  let testResults;
-  let mainTestResults;
-  let testComparison = {
-    new: [],
-    skipped: [],
-    deleted: []
-  };
-
-  // Read current PR test results
-  if (fs.existsSync(testResultsPath)) {
-    const rawData = fs.readFileSync(testResultsPath);
-    const data = JSON.parse(rawData);
-    const allTests = data.suites.flatMap(suite => extractTestsFromSuite(suite));
-    
-    testResults = {
-      total: data.stats.expected + data.stats.unexpected + data.stats.flaky + data.stats.skipped,
-      passed: data.stats.expected,
-      failed: data.stats.unexpected,
-      flaky: data.stats.flaky,
-      skipped: data.stats.skipped,
-      tests: allTests
-    };
-  } else {
-    console.log('Test results file not found');
-    testResults = { total: 0, passed: 0, failed: 0, flaky: 0, skipped: 0, tests: [] };
-  }
-
-  // Read main branch test results
-  if (fs.existsSync(mainTestResultsPath)) {
-    const rawData = fs.readFileSync(mainTestResultsPath);
-    const data = JSON.parse(rawData);
-    const allTests = data.suites.flatMap(suite => extractTestsFromSuite(suite));
-    mainTestResults = { tests: allTests };
-
-    // Compare tests
-    const currentTests = new Map(testResults.tests.map(t => [t.fullTitle, t]));
-    const mainTests = new Map(mainTestResults.tests.map(t => [t.fullTitle, t]));
-
-    // Find new tests
-    for (const [fullTitle, test] of currentTests) {
-      if (!mainTests.has(fullTitle)) {
-        testComparison.new.push(`${test.title} (${test.file})`);
-      }
-    }
-
-    // Find deleted tests
-    for (const [fullTitle, test] of mainTests) {
-      if (!currentTests.has(fullTitle)) {
-        testComparison.deleted.push(`${test.title} (${test.file})`);
-      }
-    }
-
-    // Find skipped tests (both newly skipped and already skipped)
-    testComparison.skipped = testResults.tests
-      .filter(t => t.skipped)
-      .map(test => `${test.title} (${test.file})`);
-
-    testComparison.skipped = Array.from(new Set(testComparison.skipped));
-  } else {
-    console.log('Main branch test results file not found');
-    mainTestResults = { tests: [] };
-  }
-
+  // Get test status and report URL
+  const { status, statusColor } = getTestStatus(currentResults);
   const reportUrl = `https://${context.repo.owner}.github.io/${context.repo.repo}/${context.issue.number}/`;
-  const status = testResults.failed > 0 ? '❌ FAILED' : (testResults.flaky > 0 ? '⚠️ FLAKY' : '✅ PASSED');
-  const statusColor = testResults.failed > 0 ? 'red' : (testResults.flaky > 0 ? 'orange' : 'green');
-
-  // Get bundle size information from environment variables
-  const currentSize = parseInt(process.env.CURRENT_SIZE || '0');
-  const mainSize = parseInt(process.env.MAIN_SIZE || '0');
-  const diff = parseInt(process.env.SIZE_DIFF || '0');
-  const percent = process.env.SIZE_PERCENT || 'N/A';
 
-  const bundleStatus = percent === 'N/A' ? '⚠️' :
-                      parseFloat(percent) > 0 ? '🔺' :
-                      parseFloat(percent) < 0 ? '🔽' : '✅';
-
-  // Generate test changes summary based on actual changes
-  let testChangesSummary = '😟 No changes in tests. 😕';
-  if (testComparison.new.length > 0 || testComparison.deleted.length > 0 || testComparison.skipped.length > 0) {
-    testChangesSummary = `
-    <details>
-    <summary>Test Changes Summary ${testComparison.new.length > 0 ? `✨${testComparison.new.length} ` : ''}${testComparison.skipped.length > 0 ? `⏭️${testComparison.skipped.length} ` : ''}${testComparison.deleted.length > 0 ? `🗑️${testComparison.deleted.length}` : ''}</summary>
-
-    ${testComparison.new.length > 0 ? `#### ✨ New Tests (${testComparison.new.length})
-    ${testComparison.new.map((test, i) => `${i + 1}. ${test}`).join('\n')}
-
-    ` : ''}${testComparison.skipped.length > 0 ? `#### ⏭️ Skipped Tests (${testComparison.skipped.length})
-    ${testComparison.skipped.map((test, i) => `${i + 1}. ${test}`).join('\n')}
-
-    ` : ''}${testComparison.deleted.length > 0 ? `#### 🗑️ Deleted Tests (${testComparison.deleted.length})
-    ${testComparison.deleted.map((test, i) => `${i + 1}. ${test}`).join('\n')}` : ''}
-    </details>`;
-  }
+  // Get bundle size information
+  const bundleInfo = getBundleInfo();
 
+  // Generate the CI section content
   const ciSection = `## CI Results
 
   ### Test Status: <span style="color: ${statusColor};">${status}</span>
   📊 [Full Report](${reportUrl})
 
   | Total | Passed | Failed | Flaky | Skipped |
   |:-----:|:------:|:------:|:-----:|:-------:|
-  | ${testResults.total} | ${testResults.passed} | ${testResults.failed} | ${testResults.flaky} | ${testResults.skipped} |
-
-  ${testChangesSummary}
+  | ${currentResults.total} | ${currentResults.passed} | ${currentResults.failed} | ${currentResults.flaky} | ${currentResults.skipped} |
 
-  ### Bundle Size: ${bundleStatus}
-  Current: ${formatSize(currentSize)} | Main: ${formatSize(mainSize)}
-  Diff: ${diff > 0 ? '+' : ''}${formatSize(Math.abs(diff))} (${percent === 'N/A' ? 'N/A' : `${percent}%`})
+  ${generateTestChangesSummary(testComparison)}
 
-  ${
-    percent === 'N/A' ? '⚠️ Unable to calculate change.' :
-    parseFloat(percent) > 0 ? '⚠️ Bundle size increased. Please review.' :
-    parseFloat(percent) < 0 ? '✅ Bundle size decreased.' : '✅ Bundle size unchanged.'
-  }
+  ${generateBundleSizeSection(bundleInfo)}
 
   <details>
   <summary>ℹ️ CI Information</summary>
@@ -166,6 +46,7 @@ async function updatePRDescription(github, context) {
   - 🔺 indicates increase, 🔽 decrease, and ✅ no change in bundle size.
   </details>`;
 
+  // Update PR description
   const { data: pullRequest } = await github.rest.pulls.get({
     owner: context.repo.owner,
     repo: context.repo.repo,
@@ -175,12 +56,9 @@ async function updatePRDescription(github, context) {
   const currentBody = pullRequest.body || '';
   const ciSectionRegex = /## CI Results[\s\S]*?(?=\n## (?!CI Results)|$)/;
 
-  let newBody = currentBody;
-  if (ciSectionRegex.test(newBody)) {
-    newBody = newBody.replace(ciSectionRegex, ciSection);
-  } else {
-    newBody += '\n\n' + ciSection;
-  }
+  const newBody = ciSectionRegex.test(currentBody)
+    ? currentBody.replace(ciSectionRegex, ciSection)
+    : currentBody + '\n\n' + ciSection;
 
   await github.rest.pulls.update({
     owner: context.repo.owner,

.github/workflows/scripts/utils/bundle.js

@@ -0,0 +1,40 @@
+const { formatSize } = require('./format');
+
+/**
+ * Generates the bundle size status section
+ * @param {Object} bundleInfo - Bundle size information
+ * @returns {string} Formatted bundle size section
+ */
+function generateBundleSizeSection({ currentSize, mainSize, diff, percent }) {
+  const bundleStatus = percent === 'N/A' ? '⚠️' :
+                      parseFloat(percent) > 0 ? '🔺' :
+                      parseFloat(percent) < 0 ? '🔽' : '✅';
+
+  const sizeChangeMessage = percent === 'N/A' ? '⚠️ Unable to calculate change.' :
+                           parseFloat(percent) > 0 ? '⚠️ Bundle size increased. Please review.' :
+                           parseFloat(percent) < 0 ? '✅ Bundle size decreased.' : '✅ Bundle size unchanged.';
+
+  return `### Bundle Size: ${bundleStatus}
+  Current: ${formatSize(currentSize)} | Main: ${formatSize(mainSize)}
+  Diff: ${diff > 0 ? '+' : ''}${formatSize(Math.abs(diff))} (${percent === 'N/A' ? 'N/A' : `${percent}%`})
+
+  ${sizeChangeMessage}`;
+}
+
+/**
+ * Gets bundle size information from environment variables
+ * @returns {Object} Bundle size information
+ */
+function getBundleInfo() {
+  return {
+    currentSize: parseInt(process.env.CURRENT_SIZE || '0'),
+    mainSize: parseInt(process.env.MAIN_SIZE || '0'),
+    diff: parseInt(process.env.SIZE_DIFF || '0'),
+    percent: process.env.SIZE_PERCENT || 'N/A'
+  };
+}
+
+module.exports = {
+  generateBundleSizeSection,
+  getBundleInfo
+};

.github/workflows/scripts/utils/format.js

@@ -0,0 +1,53 @@
+/**
+ * Formats a size in bytes to a human-readable string (KB or MB)
+ * @param {number} sizeInBytes - Size in bytes to format
+ * @returns {string} Formatted size string with units
+ */
+function formatSize(sizeInBytes) {
+  const MB_THRESHOLD = 1024;
+  if (sizeInBytes >= MB_THRESHOLD) {
+    return `${(sizeInBytes / (1024 * 1024)).toFixed(2)} MB`;
+  }
+  return `${(sizeInBytes / 1024).toFixed(2)} KB`;
+}
+
+/**
+ * Generates a summary of test changes
+ * @param {Object} comparison - Test comparison results
+ * @returns {string} Formatted test changes summary
+ */
+function generateTestChangesSummary(comparison) {
+  if (!comparison.new.length && !comparison.deleted.length && !comparison.skipped.length) {
+    return '😟 No changes in tests. 😕';
+  }
+
+  const summaryParts = [];
+  const { new: newTests, skipped, deleted } = comparison;
+
+  if (newTests.length) {
+    summaryParts.push(`#### ✨ New Tests (${newTests.length})
+    ${newTests.map((test, i) => `${i + 1}. ${test}`).join('\n')}\n`);
+  }
+
+  if (skipped.length) {
+    summaryParts.push(`#### ⏭️ Skipped Tests (${skipped.length})
+    ${skipped.map((test, i) => `${i + 1}. ${test}`).join('\n')}\n`);
+  }
+
+  if (deleted.length) {
+    summaryParts.push(`#### 🗑️ Deleted Tests (${deleted.length})
+    ${deleted.map((test, i) => `${i + 1}. ${test}`).join('\n')}`);
+  }
+
+  return `
+  <details>
+  <summary>Test Changes Summary ${newTests.length ? `✨${newTests.length} ` : ''}${skipped.length ? `⏭️${skipped.length} ` : ''}${deleted.length ? `🗑️${deleted.length}` : ''}</summary>
+
+  ${summaryParts.join('\n')}
+  </details>`;
+}
+
+module.exports = {
+  formatSize,
+  generateTestChangesSummary
+};

.github/workflows/scripts/utils/results.js

@@ -0,0 +1,48 @@
+const fs = require('fs');
+const { extractTestsFromSuite } = require('./test');
+
+/**
+ * Reads and processes test results from a JSON file
+ * @param {string} filePath - Path to the test results JSON file
+ * @returns {Object} Processed test results
+ */
+function readTestResults(filePath) {
+  if (!fs.existsSync(filePath)) {
+    console.log(`Test results file not found: ${filePath}`);
+    return { total: 0, passed: 0, failed: 0, flaky: 0, skipped: 0, tests: [] };
+  }
+
+  const data = JSON.parse(fs.readFileSync(filePath));
+  const allTests = data.suites.flatMap(suite => extractTestsFromSuite(suite));
+  
+  return {
+    total: data.stats.expected + data.stats.unexpected + data.stats.flaky + data.stats.skipped,
+    passed: data.stats.expected,
+    failed: data.stats.unexpected,
+    flaky: data.stats.flaky,
+    skipped: data.stats.skipped,
+    tests: allTests
+  };
+}
+
+/**
+ * Gets the test status information
+ * @param {Object} results - Test results object
+ * @returns {Object} Status information including color and label
+ */
+function getTestStatus(results) {
+  const status = results.failed > 0 ? '❌ FAILED' : 
+                results.flaky > 0 ? '⚠️ FLAKY' : 
+                '✅ PASSED';
+  
+  const statusColor = results.failed > 0 ? 'red' : 
+                     results.flaky > 0 ? 'orange' : 
+                     'green';
+
+  return { status, statusColor };
+}
+
+module.exports = {
+  readTestResults,
+  getTestStatus
+};