feat: implement tinybench compatibility

Author: art049

packages/core/README.md

@@ -7,4 +7,5 @@ The core Node library used to integrate with Codspeed runners
 
 For now, this crate should not be used directly. Instead, use one of the integration crates:
 
+- `@codspeed/tinybench`
 - `@codspeed/benchmark.js`

packages/tinybench/README.md

@@ -0,0 +1,6 @@
+<div align="center">
+<h1><code>@codspeed/tinybench</code></h1>
+
+tinybench compatibility layer for CodSpeed
+
+</div>

packages/tinybench/benches/sample.ts

@@ -0,0 +1,18 @@
+import Benchmark from "benchmark";
+import { withCodSpeed } from "../";
+
+const suite = withCodSpeed(new Benchmark.Suite());
+
+suite
+  .add("RegExp#test", function () {
+    /o/.test("Hello World!");
+  })
+  .add("String#indexOf", function () {
+    "Hello World!".indexOf("o") > -1;
+  })
+  // add listeners
+  .on("cycle", function (event: Benchmark.Event) {
+    console.log(String(event.target));
+  })
+  // run async
+  .run({ async: true });

packages/tinybench/jest.config.js

@@ -0,0 +1,13 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: "ts-jest",
+  testEnvironment: "node",
+  transform: {
+    "^.+\\.tsx?$": [
+      "ts-jest",
+      {
+        tsconfig: "tsconfig.test.json",
+      },
+    ],
+  },
+};

packages/tinybench/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@codspeed/tinybench",
+  "version": "0.0.0",
+  "description": "",
+  "keywords": [],
+  "main": "dist/index.cjs.js",
+  "module": "dist/index.es5.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "author": "--username-- <--usermail-->",
+  "repository": {
+    "type": "git",
+    "url": ""
+  },
+  "license": "MIT",
+  "devDependencies": {
+    "@types/find-up": "^4.0.0",
+    "@types/stack-trace": "^0.0.30",
+    "jest-mock-extended": "^3.0.1"
+  },
+  "dependencies": {
+    "@codspeed/core": "workspace:*",
+    "find-up": "^6.3.0",
+    "stack-trace": "1.0.0-pre1",
+    "tinybench": "^2.3.1"
+  }
+}

packages/tinybench/rollup.config.ts

@@ -0,0 +1,32 @@
+import { defineConfig } from "rollup";
+import pkg from "./package.json" assert { type: "json" };
+import { declarationsPlugin, jsPlugins } from "../../rollup.options";
+
+const entrypoint = "src/index.ts";
+
+export default defineConfig([
+  {
+    input: entrypoint,
+    output: [
+      {
+        file: pkg.types,
+        format: "es",
+        sourcemap: true,
+      },
+    ],
+    plugins: declarationsPlugin,
+  },
+  {
+    input: entrypoint,
+    output: [
+      {
+        file: pkg.main,
+        format: "cjs",
+        sourcemap: true,
+      },
+      { file: pkg.module, format: "es", sourcemap: true },
+    ],
+    plugins: [...jsPlugins],
+    external: ["@codspeed/core"],
+  },
+]);

packages/tinybench/src/index.ts

@@ -0,0 +1,40 @@
+import measurement from "@codspeed/core";
+import { get as getStackTrace } from "stack-trace";
+import path, { dirname } from "path";
+import { findUpSync, Options } from "find-up";
+import { Bench } from "tinybench";
+
+export function withCodSpeed(bench: Bench): Bench {
+  if (!measurement.isInstrumented()) {
+    return bench;
+  }
+  const callingFile = getCallingFile();
+  bench.run = async () => {
+    for (const task of bench.tasks) {
+      const uri = callingFile + "::" + task.name;
+      measurement.startMeasurement();
+      await task.fn();
+      measurement.stopMeasurement(uri);
+    }
+    return bench.tasks;
+  };
+  return bench;
+}
+
+function getCallingFile(): string {
+  const stack = getStackTrace();
+  const callingFile = stack[2].getFileName(); // [here, withCodSpeed, actual caller]
+  const gitDir = getGitDir(callingFile);
+  if (gitDir === undefined) {
+    throw new Error("Could not find a git repository");
+  }
+  return path.relative(gitDir, callingFile);
+}
+
+function getGitDir(path: string): string | undefined {
+  const dotGitPath = findUpSync(".git", {
+    cwd: path,
+    type: "directory",
+  } as Options);
+  return dotGitPath ? dirname(dotGitPath) : undefined;
+}

packages/tinybench/test/library.test.ts

@@ -0,0 +1,58 @@
+import { mockDeep, mockReset } from "jest-mock-extended";
+const mockCore = mockDeep<Measurement>();
+
+import { Bench } from "tinybench";
+import { withCodSpeed } from "..";
+import type { Measurement } from "@codspeed/core";
+
+jest.mock("@codspeed/core", () => mockCore);
+
+beforeEach(() => {
+  mockReset(mockCore);
+});
+
+describe("Benchmark.Suite", () => {
+  it("simple suite", async () => {
+    mockCore.isInstrumented.mockReturnValue(false);
+    const bench = withCodSpeed(new Bench({ time: 100 }));
+    const onComplete = jest.fn();
+    bench.add("RegExp", function () {
+      /o/.test("Hello World!");
+    });
+    bench.getTask("RegExp")?.addEventListener("complete", onComplete);
+    await bench.run();
+
+    expect(onComplete).toHaveBeenCalled();
+    expect(mockCore.startMeasurement).not.toHaveBeenCalled();
+    expect(mockCore.stopMeasurement).not.toHaveBeenCalled();
+  });
+  it("check core methods are called", async () => {
+    mockCore.isInstrumented.mockReturnValue(true);
+    await withCodSpeed(new Bench())
+      .add("RegExp", function () {
+        /o/.test("Hello World!");
+      })
+      .run();
+    expect(mockCore.startMeasurement).toHaveBeenCalled();
+    expect(mockCore.stopMeasurement).toHaveBeenCalledWith(
+      "packages/tinybench/test/library.test.ts::RegExp"
+    );
+  });
+  it("check suite name is in the uri", async () => {
+    mockCore.isInstrumented.mockReturnValue(true);
+    await withCodSpeed(new Bench())
+      .add("RegExp", function () {
+        /o/.test("Hello World!");
+      })
+      .add("RegExp2", () => {
+        /o/.test("Hello World!");
+      })
+      .run();
+    expect(mockCore.stopMeasurement).toHaveBeenCalledWith(
+      "packages/tinybench/test/library.test.ts::RegExp"
+    );
+    expect(mockCore.stopMeasurement).toHaveBeenCalledWith(
+      "packages/tinybench/test/library.test.ts::RegExp2"
+    );
+  });
+});

packages/tinybench/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "outDir": "dist",
+    "rootDir": "src",
+    "typeRoots": [
+      "node_modules/@types",
+      "../../node_modules/@types"
+    ]
+  },
+  "include": [
+    "src/**/*.ts"
+  ]
+}

packages/tinybench/tsconfig.test.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "types": ["jest", "node"]
+  },
+  "include": ["test/**/*.ts", "benches/**/*.ts", "jest.config.ts"]
+}