feat: add slowest tests report with average duration

Author: Ma11hewThomas

.github/workflows/build-and-test.yaml

@@ -198,6 +198,7 @@ jobs:
           flaky-rate-report: true
           fail-rate-report: true
           insights-report: true
+          slowest-report: true
           annotate: false
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

action.yml

@@ -79,6 +79,11 @@ inputs:
       'Include the insights report showing test metrics and statistics.'
     required: false
     default: false
+  slowest-report:
+    description:
+      'Include a report showing the top 10 slowest tests by average duration.'
+    required: false
+    default: false
   pull-request-report:
     description: 'Include the pull request report.'
     required: false

badges/coverage.svg

@@ -31,6 +31,7 @@ export function getCliInputs(args: Arguments): Inputs {
     customReport: args._.includes('custom'),
     communityReport: args._.includes('community'),
     insightsReport: args._.includes('insights'),
+    slowestReport: args._.includes('slowest'),
     communityReportName: args.communityReportName || '',
     artifactName: args.artifactName || 'ctrf-report',
     annotate: args.annotate !== false,
@@ -87,6 +88,7 @@ export function getInputs(): Inputs {
       core.getInput('pull-request-report').toLowerCase() === 'true',
     commitReport: core.getInput('commit-report').toLowerCase() === 'true',
     insightsReport: core.getInput('insights-report').toLowerCase() === 'true',
+    slowestReport: core.getInput('slowest-report').toLowerCase() === 'true',
     customReport: core.getInput('custom-report').toLowerCase() === 'true',
     communityReport: core.getInput('community-report').toLowerCase() === 'true',
     communityReportName: core.getInput('community-report-name'),

dist/index.js

@@ -188,7 +188,6 @@ function findSlowestTestByP95(
 ): { name: string; duration: number } | undefined {
   if (!tests.length) return undefined
 
-  // Group tests by name to handle multiple runs of the same test
   const testGroups = tests.reduce(
     (groups, test) => {
       const name = test.name
@@ -201,20 +200,84 @@ function findSlowestTestByP95(
     {} as Record<string, number[]>
   )
 
-  // Calculate p95 duration for each test
   const testP95Durations = Object.entries(testGroups).map(
     ([name, durations]) => ({
       name,
       duration: calculateP95Duration(durations)
     })
   )
 
-  // Find the test with the highest p95 duration
   return testP95Durations.reduce((slowest, current) => {
     return current.duration > slowest.duration ? current : slowest
   }, testP95Durations[0])
 }
 
+/**
+ * Calculates the average duration for each test across all runs and sorts them.
+ * Returns only the top 10 slowest tests.
+ *
+ * @param tests - Array of tests to analyze
+ * @param previousReports - Array of previous reports
+ * @returns Array of tests with average durations, sorted by duration
+ */
+function calculateAndSortTestDurations(
+  tests: CtrfTest[],
+  previousReports: CtrfReport[]
+): CtrfTest[] {
+  const testDurations: Record<string, number[]> = {}
+
+  tests.forEach(test => {
+    if (!testDurations[test.name]) {
+      testDurations[test.name] = []
+    }
+    if (test.duration) {
+      testDurations[test.name].push(test.duration)
+    }
+  })
+
+  previousReports.forEach(report => {
+    report.results.tests.forEach(test => {
+      if (!testDurations[test.name]) {
+        testDurations[test.name] = []
+      }
+      if (test.duration) {
+        testDurations[test.name].push(test.duration)
+      }
+    })
+  })
+
+  const testsWithAvg = tests.map(test => {
+    const durations = testDurations[test.name] || []
+    if (durations.length > 0) {
+      const currentExtra = test.extra || {
+        totalAttempts: 0,
+        flakyRate: 0,
+        flakyRateChange: 0,
+        passedCount: 0,
+        failedCount: 0,
+        failRate: 0,
+        failRateChange: 0,
+        finalResults: 0,
+        finalFailures: 0
+      }
+      test.extra = {
+        ...currentExtra,
+        avgDuration: calculateP95Duration(durations)
+      }
+    }
+    return test
+  })
+
+  return testsWithAvg
+    .filter(test => test.extra?.avgDuration !== undefined)
+    .sort((a, b) => {
+      const aDuration = a.extra?.avgDuration || 0
+      const bDuration = b.extra?.avgDuration || 0
+      return bDuration - aDuration
+    })
+    .slice(0, 10)
+}
+
 /**
  * Enriches the CTRF report summary with overall metrics, including flaky and fail rates.
  *
@@ -282,6 +345,11 @@ export function enrichReportSummary(
   )
   const slowestTest = findSlowestTestByP95(report.results.tests)
 
+  report.results.tests = calculateAndSortTestDurations(
+    report.results.tests,
+    previousReports
+  )
+
   report.results.summary.extra = {
     ...(report.results.summary.extra || {}),
     flakyRate,

dist/index.js.map

@@ -108,7 +108,12 @@ export function generateViews(inputs: Inputs, report: CtrfReport): void {
 
   if (inputs.insightsReport) {
     core.info('Adding insights report to summary')
-    addViewToSummary('', BuiltInReports.InsightsTable, report)
+    addViewToSummary('### Insights', BuiltInReports.InsightsTable, report)
+  }
+
+  if (inputs.slowestReport) {
+    core.info('Adding slowest tests report to summary')
+    addViewToSummary('### Slowest Tests', BuiltInReports.SlowestTable, report)
   }
 
   if (inputs.customReport && inputs.templatePath) {