feat: add some benches status display

Author: art049

packages/benchmark.js/rollup.config.ts

@@ -26,7 +26,7 @@ export default defineConfig([
       },
       { file: pkg.module, format: "es", sourcemap: true },
     ],
-    plugins: [...jsPlugins],
+    plugins: jsPlugins(pkg.version),
     external: ["@codspeed/core"],
   },
 ]);

packages/benchmark.js/src/index.ts

@@ -4,6 +4,8 @@ import { get as getStackTrace } from "stack-trace";
 import path, { dirname } from "path";
 import { findUpSync, Options } from "find-up";
 
+declare const __VERSION__: string;
+
 export function withCodSpeed(suite: Benchmark): Benchmark;
 export function withCodSpeed(suite: Benchmark.Suite): Benchmark.Suite;
 export function withCodSpeed(item: unknown): unknown {
@@ -16,30 +18,52 @@ export function withCodSpeed(item: unknown): unknown {
 
 function withCodSpeedBenchmark(bench: Benchmark): Benchmark {
   if (!measurement.isInstrumented()) {
+    const rawRun = bench.run;
+    bench.run = (options?: Benchmark.Options) => {
+      console.warn(
+        `[CodSpeed] bench detected but no instrumentation found, falling back to benchmark.js`
+      );
+      return rawRun.bind(bench)(options);
+    };
     return bench;
   }
   initCore();
   const callingFile = getCallingFile();
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   bench.run = function (options?: Benchmark.Options): Benchmark {
+    console.log(
+      `[CodSpeed] running with @codspeed/benchmark.js v${__VERSION__}`
+    );
     const uri = callingFile + "::" + (bench.name ?? "unknown");
     const fn = bench.fn as CallableFunction;
     optimizeFunctionSync(fn);
     measurement.startInstrumentation();
     fn();
     measurement.stopInstrumentation(uri);
+    console.log(`    ✔ Measured ${uri}`);
+    console.log("[CodSpeed] Done running 1 bench.");
     return bench;
   };
   return bench;
 }
 
 function withCodSpeedSuite(suite: Benchmark.Suite): Benchmark.Suite {
   if (!measurement.isInstrumented()) {
+    const rawRun = suite.run;
+    suite.run = (options?: Benchmark.Options) => {
+      console.warn(
+        `[CodSpeed] ${suite.length} benches detected but no instrumentation found, falling back to benchmark.js`
+      );
+      return rawRun.bind(suite)(options);
+    };
     return suite;
   }
   const callingFile = getCallingFile();
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   suite.run = function (options?: Benchmark.Options): Benchmark.Suite {
+    console.log(
+      `[CodSpeed] running with @codspeed/benchmark.js v${__VERSION__}`
+    );
     const suiteName = suite.name;
     const benches = this as unknown as Benchmark[];
     let baseUri = callingFile;
@@ -52,7 +76,9 @@ function withCodSpeedSuite(suite: Benchmark.Suite): Benchmark.Suite {
       measurement.startInstrumentation();
       (bench.fn as CallableFunction)();
       measurement.stopInstrumentation(uri);
+      console.log(`    ✔ Measured ${uri}`);
     }
+    console.log(`[CodSpeed] Done running ${suite.length} benches.`);
     return suite;
   };
   return suite;

packages/core/rollup.config.ts

@@ -3,7 +3,7 @@ import json from "@rollup/plugin-json";
 import commonjs from "@rollup/plugin-commonjs";
 import esbuild from "rollup-plugin-esbuild";
 import { defineConfig } from "rollup";
-import { declarationsPlugin } from "../../rollup.options";
+import { declarationsPlugin, jsPlugins } from "../../rollup.options";
 
 import pkg from "./package.json" assert { type: "json" };
 const entrypoint = "src/index.ts";
@@ -30,15 +30,6 @@ export default defineConfig([
       },
       { file: pkg.module, format: "es", sourcemap: true },
     ],
-    plugins: [
-      json(),
-      esbuild({
-        define: {
-          __VERSION__: '"' + pkg.version + '"',
-        },
-      }),
-      commonjs(),
-      resolve(),
-    ],
+    plugins: jsPlugins(pkg.version),
   },
 ]);

packages/tinybench/rollup.config.ts

@@ -26,7 +26,7 @@ export default defineConfig([
       },
       { file: pkg.module, format: "es", sourcemap: true },
     ],
-    plugins: [...jsPlugins],
+    plugins: jsPlugins(pkg.version),
     external: ["@codspeed/core"],
   },
 ]);

packages/tinybench/src/index.ts

@@ -4,20 +4,32 @@ import path, { dirname } from "path";
 import { findUpSync, Options } from "find-up";
 import { Bench } from "tinybench";
 
+declare const __VERSION__: string;
+
 export function withCodSpeed(bench: Bench): Bench {
   if (!measurement.isInstrumented()) {
+    const rawRun = bench.run;
+    bench.run = async () => {
+      console.warn(
+        `[CodSpeed] ${bench.tasks.length} benches detected but no instrumentation found, falling back to tinybench`
+      );
+      return await rawRun.bind(bench)();
+    };
     return bench;
   }
   initCore();
   const callingFile = getCallingFile();
   bench.run = async () => {
+    console.log(`[CodSpeed] running with @codspeed/tinybench v${__VERSION__}`);
     for (const task of bench.tasks) {
       const uri = callingFile + "::" + task.name;
       await optimizeFunction(task.fn);
       measurement.startInstrumentation();
       await task.fn();
       measurement.stopInstrumentation(uri);
+      console.log(`    ✔ Measured ${uri}`);
     }
+    console.log(`[CodSpeed] Done running ${bench.tasks.length} benches.`);
     return bench.tasks;
   };
   return bench;

rollup.options.js

@@ -6,4 +6,13 @@ import dts from "rollup-plugin-dts";
 
 export const declarationsPlugin = [dts()];
 
-export const jsPlugins = [json(), esbuild(), commonjs(), resolve()];
+export const jsPlugins = (version) => [
+  json(),
+  esbuild({
+    define: {
+      __VERSION__: '"' + version + '"',
+    },
+  }),
+  commonjs(),
+  resolve(),
+];