feat: implement benchmark.js compatibility

Author: art049

.eslintrc.json

@@ -6,7 +6,12 @@
     "plugin:import/recommended",
     "plugin:import/typescript"
   ],
-  "ignorePatterns": ["**/dist/**", "**/node_modules/**", "**/rollup.config.ts"],
+  "ignorePatterns": [
+    "**/dist/**",
+    "**/node_modules/**",
+    "**/rollup.config.ts",
+    "**/jest.config.js"
+  ],
   "settings": {
     "import/parsers": {
       "@typescript-eslint/parser": [".ts", ".tsx"]

.moon/project.yml

@@ -55,12 +55,23 @@ tasks:
     outputs:
       - "dist/"
     deps:
-      - "clean"
       - "typecheck"
       - "^:build"
     env:
       NODE_NO_WARNINGS: "1"
 
+  test:
+    command: "jest --passWithNoTests"
+    inputs:
+      - "@globs(sources)"
+      - "@globs(tests)"
+      - "@globs(configs)"
+      - "tsconfig.json"
+      - "/tsconfig.json"
+      - "/tsconfig.base.json"
+    deps:
+      - "build"
+
   clean:
     command: "rm -rf"
     args:

package.json

@@ -9,7 +9,7 @@
     "@rollup/plugin-json": "^6.0.0",
     "@rollup/plugin-node-resolve": "^15.0.1",
     "@rollup/plugin-typescript": "^11.0.0",
-    "@types/jest": "^23.3.14",
+    "@types/jest": "^29.2.5",
     "@types/node": "^18.11.18",
     "@typescript-eslint/eslint-plugin": "^5.37.0",
     "@typescript-eslint/parser": "^5.48.1",
@@ -18,13 +18,14 @@
     "eslint-import-resolver-typescript": "^3.5.1",
     "eslint-plugin-import": "^2.26.0",
     "husky": "^7.0.4",
-    "jest": "^23.6.0",
-    "jest-config": "^23.6.0",
+    "jest": "^29.3.1",
+    "jest-config": "^29.3.1",
     "prettier": "^2.7.1",
     "prettier-plugin-organize-imports": "^2.3.4",
     "rollup": "^3.10.0",
     "rollup-plugin-dts": "^5.1.1",
     "rollup-plugin-esbuild": "^5.0.0",
+    "ts-jest": "^29.0.5",
     "ts-node": "^7.0.1",
     "tslib": "^2.4.1",
     "typescript": "4.9.4"

packages/benchmark.js/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/benchmark.js/package.json

@@ -15,23 +15,16 @@
     "url": ""
   },
   "license": "MIT",
-  "jest": {
-    "transform": {
-      ".(ts|tsx)": "ts-jest"
-    },
-    "testEnvironment": "node",
-    "testRegex": "(/__tests__/.*|\\.(test|spec))\\.(ts|tsx|js)$",
-    "moduleFileExtensions": [
-      "ts",
-      "tsx",
-      "js"
-    ]
-  },
   "devDependencies": {
-    "@types/benchmark": "^2.1.2"
+    "@types/benchmark": "^2.1.2",
+    "@types/find-up": "^4.0.0",
+    "@types/stack-trace": "^0.0.30",
+    "jest-mock-extended": "^3.0.1"
   },
   "dependencies": {
     "@codspeed/core": "workspace:*",
-    "benchmark": "^2.1.4"
+    "benchmark": "^2.1.4",
+    "find-up": "^6.3.0",
+    "stack-trace": "1.0.0-pre1"
   }
 }

packages/benchmark.js/rollup.config.ts

@@ -15,7 +15,6 @@ export default defineConfig([
       },
     ],
     plugins: declarationsPlugin,
-    external: ["@codspeed/core"],
   },
   {
     input: entrypoint,

packages/benchmark.js/src/index.ts

@@ -1,8 +1,74 @@
 import Benchmark from "benchmark";
+import measurement from "@codspeed/core";
+import { get as getStackTrace } from "stack-trace";
+import path, { dirname } from "path";
+import { findUpSync, Options } from "find-up";
 
-export function withCodSpeed(suite: Benchmark.Suite): Benchmark.Suite {
-  suite.on("cycle", function (event: Benchmark.Event) {
-    console.log(String(event.target));
-  });
+export function withCodSpeed(suite: Benchmark): Benchmark;
+export function withCodSpeed(suite: Benchmark.Suite): Benchmark.Suite;
+export function withCodSpeed(item: unknown): unknown {
+  if ((item as { length?: number }).length === undefined) {
+    return withCodSpeedBenchmark(item as Benchmark);
+  } else {
+    return withCodSpeedSuite(item as Benchmark.Suite);
+  }
+}
+
+function withCodSpeedBenchmark(bench: Benchmark): Benchmark {
+  if (!measurement.isInstrumented()) {
+    return bench;
+  }
+  const callingFile = getCallingFile();
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  bench.run = function (options?: Benchmark.Options): Benchmark {
+    const uri = callingFile + "::" + (bench.name ?? "unknown");
+    measurement.startMeasurement();
+    (bench.fn as CallableFunction)();
+    measurement.stopMeasurement(uri);
+    return bench;
+  };
+  return bench;
+}
+
+function withCodSpeedSuite(suite: Benchmark.Suite): Benchmark.Suite {
+  if (!measurement.isInstrumented()) {
+    return suite;
+  }
+  const callingFile = getCallingFile();
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  suite.run = function (options?: Benchmark.Options): Benchmark.Suite {
+    const suiteName = suite.name;
+    const benches = this as unknown as Benchmark[];
+    let baseUri = callingFile;
+    if (suiteName !== undefined) {
+      baseUri += `::${suiteName}`;
+    }
+    for (let i = 0; i < benches.length; i++) {
+      const bench = benches[i];
+      const uri = baseUri + "::" + (bench.name ?? `unknown_${i}`);
+      measurement.startMeasurement();
+      (bench.fn as CallableFunction)();
+      measurement.stopMeasurement(uri);
+    }
+    return suite;
+  };
   return suite;
 }
+
+function getCallingFile(): string {
+  const stack = getStackTrace();
+  const callingFile = stack[3].getFileName(); // [here, withCodSpeed, withCodSpeedX, 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/benchmark.js/test/library.test.ts

@@ -1,10 +1,87 @@
-// import DummyClass from "../src/--libraryname--"
-
-/**
- * Dummy test
- */
-describe("Dummy test", () => {
-  it("works if true is truthy", () => {
-    expect(true).toBeTruthy();
+import { mockDeep, mockReset } from "jest-mock-extended";
+const mockCore = mockDeep<Measurement>();
+
+import Benchmark from "benchmark";
+import { withCodSpeed } from "..";
+import type { Measurement } from "@codspeed/core";
+
+jest.mock("@codspeed/core", () => mockCore);
+
+beforeEach(() => {
+  mockReset(mockCore);
+});
+
+describe("Benchmark", () => {
+  it("simple benchmark", () => {
+    mockCore.isInstrumented.mockReturnValue(false);
+    const bench = withCodSpeed(
+      new Benchmark("RegExp", function () {
+        /o/.test("Hello World!");
+      })
+    );
+    const onComplete = jest.fn();
+    bench.on("complete", onComplete);
+    bench.run({ maxTime: 0.1, initCount: 1 });
+    expect(onComplete).toHaveBeenCalled();
+    expect(mockCore.startMeasurement).not.toHaveBeenCalled();
+    expect(mockCore.stopMeasurement).not.toHaveBeenCalled();
+  });
+  it("check core methods are called", () => {
+    mockCore.isInstrumented.mockReturnValue(true);
+    expect(mockCore.isInstrumented()).toBe(true);
+    withCodSpeed(
+      new Benchmark("RegExpSingle", function () {
+        /o/.test("Hello World!");
+      })
+    ).run();
+    expect(mockCore.startMeasurement).toHaveBeenCalled();
+    expect(mockCore.stopMeasurement).toHaveBeenCalledWith(
+      "packages/benchmark.js/test/library.test.ts::RegExpSingle"
+    );
+  });
+});
+
+describe("Benchmark.Suite", () => {
+  it("simple suite", () => {
+    mockCore.isInstrumented.mockReturnValue(false);
+    const suite = withCodSpeed(new Benchmark.Suite());
+    suite.add("RegExp", function () {
+      /o/.test("Hello World!");
+    });
+    const onComplete = jest.fn();
+    suite.on("complete", onComplete);
+    suite.run({ maxTime: 0.1, initCount: 1 });
+    expect(onComplete).toHaveBeenCalled();
+    expect(mockCore.startMeasurement).not.toHaveBeenCalled();
+    expect(mockCore.stopMeasurement).not.toHaveBeenCalled();
+  });
+  it("check core methods are called", () => {
+    mockCore.isInstrumented.mockReturnValue(true);
+    withCodSpeed(new Benchmark.Suite())
+      .add("RegExp", function () {
+        /o/.test("Hello World!");
+      })
+      .run();
+    expect(mockCore.startMeasurement).toHaveBeenCalled();
+    expect(mockCore.stopMeasurement).toHaveBeenCalledWith(
+      "packages/benchmark.js/test/library.test.ts::RegExp"
+    );
+  });
+  it("check suite name is in the uri", () => {
+    mockCore.isInstrumented.mockReturnValue(true);
+    withCodSpeed(new Benchmark.Suite("thesuite"))
+      .add("RegExp", function () {
+        /o/.test("Hello World!");
+      })
+      .add(() => {
+        /o/.test("Hello World!");
+      })
+      .run();
+    expect(mockCore.stopMeasurement).toHaveBeenCalledWith(
+      "packages/benchmark.js/test/library.test.ts::thesuite::RegExp"
+    );
+    expect(mockCore.stopMeasurement).toHaveBeenCalledWith(
+      "packages/benchmark.js/test/library.test.ts::thesuite::unknown_1"
+    );
   });
 });

packages/benchmark.js/tsconfig.json

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

packages/benchmark.js/tsconfig.test.json

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