fix: ensure benchmarks summary is only displayed with two valid bench…

…marks

Signed-off-by: Jérôme Benoit <[email protected]>

CHANGELOG.md

@@ -8,6 +8,10 @@ and this project adheres to
 
 ## [Unreleased]
 
+### Fixed
+
+- Ensure benchmarks summary is only displayed with two valid benchmarks.
+
 ## [0.4.13] - 2024-05-25
 
 ### Changed

src/benchmark.js

@@ -306,12 +306,14 @@ export async function run(opts = {}) {
     log(table.br(opts));
   }
 
-  const noGroupBenchmarks = benchmarks.filter(
+  let noGroupBenchmarks = benchmarks.filter(
     benchmark => benchmark.group == null,
   );
   let once = await executeBenchmarks(noGroupBenchmarks, log, opts);
 
-  // TODO: ensure no erroed benchmarks are included in the summary
+  noGroupBenchmarks = noGroupBenchmarks.filter(
+    noGroupBenchmark => noGroupBenchmark.error == null,
+  );
   if (!opts.json && noGroupBenchmarks.length > 1) {
     log('');
     log(table.summary(noGroupBenchmarks, opts));
@@ -325,7 +327,7 @@ export async function run(opts = {}) {
         log(clr.gray(opts.colors, table.br(opts)));
     }
 
-    const groupBenchmarks = benchmarks.filter(
+    let groupBenchmarks = benchmarks.filter(
       benchmark => benchmark.group === group,
     );
 
@@ -339,7 +341,9 @@ export async function run(opts = {}) {
       ? await groupOpts.after()
       : groupOpts.after();
 
-    // TODO: ensure no erroed benchmarks are included in the summary
+    groupBenchmarks = groupBenchmarks.filter(
+      groupBenchmark => groupBenchmark.error == null,
+    );
     if (
       groupOpts.summary === true &&
       !opts.json &&

src/reporter/table.js

@@ -125,8 +125,12 @@ export function benchmark(
  * @param {Array} benchmarks - array of benchmarks
  */
 export function summary(benchmarks, { colors = true }) {
-  // biome-ignore lint/style/noParameterAssign: <explanation>
-  benchmarks = benchmarks.filter(benchmark => benchmark.error == null);
+  if (benchmarks.every(benchmark => benchmark.error != null)) {
+    throw new Error('Cannot summarize benchmarks with error');
+  }
+  if (benchmarks.length < 2) {
+    throw new Error('Cannot summarize less than two benchmarks');
+  }
   benchmarks.sort(
     (benchmarkA, benchmarkB) => benchmarkA.stats.avg - benchmarkB.stats.avg,
   );