ref(core): extract getCallingFile utility for plugins to share

The tinybench and benchmark.js plugins each carried their own
near-identical implementation of "what file called withCodSpeed()",
built on stack-trace + find-up + getGitDir to compute a path relative
to the enclosing git repository.

Move the helper into @codspeed/core (next to getGitDir, which it
already depends on), accept a `depth` argument to skip indirection
frames the way benchmark.js needs, and rewire both plugins to import
from core. Drop the now-redundant stack-trace dependency from each
plugin's package.json — it lives on core alone now.

The benchmark.js-plugin integ tests mock @codspeed/core wholesale; add
getCallingFile to the un-mocked names alongside getGitDir so the URI
derivation still works under test.

Refs COD-2721
Co-Authored-By: Claude <noreply@anthropic.com>

Author: GuillaumeLagrange

packages/benchmark.js-plugin/package.json

@@ -33,14 +33,12 @@
     "@babel/preset-env": "^7.22.5",
     "@types/benchmark": "^2.1.2",
     "@types/lodash": "^4.14.195",
-    "@types/stack-trace": "^0.0.30",
     "benchmark": "^2.1.4",
     "jest-mock-extended": "^3.0.4"
   },
   "dependencies": {
     "@codspeed/core": "workspace:^5.4.0",
-    "lodash": "^4.17.10",
-    "stack-trace": "1.0.0-pre2"
+    "lodash": "^4.17.10"
   },
   "peerDependencies": {
     "benchmark": "^2.1.0"

packages/benchmark.js-plugin/src/buildSuiteAdd.ts

@@ -1,6 +1,6 @@
+import { getCallingFile } from "@codspeed/core";
 import { Options, Suite } from "benchmark";
 import { isFunction, isPlainObject } from "lodash";
-import getCallingFile from "./getCallingFile";
 
 function isOptions(options: unknown): options is Options {
   return isPlainObject(options);

packages/benchmark.js-plugin/src/getCallingFile.ts

@@ -1,4 +1,5 @@
 import {
+  getCallingFile,
   InstrumentHooks,
   mongoMeasurement,
   optimizeFunction,
@@ -11,7 +12,6 @@ import {
 } from "@codspeed/core";
 import Benchmark from "benchmark";
 import buildSuiteAdd from "./buildSuiteAdd";
-import getCallingFile from "./getCallingFile";
 import { CodSpeedBenchmark } from "./types";
 
 declare const __VERSION__: string;

packages/benchmark.js-plugin/src/index.ts

@@ -8,7 +8,9 @@ import { registerBenchmarks } from "./registerBenchmarks";
 import { registerOtherBenchmarks } from "./registerOtherBenchmarks";
 
 jest.mock("@codspeed/core", () => {
-  mockCore.getGitDir = jest.requireActual("@codspeed/core").getGitDir;
+  const actual = jest.requireActual("@codspeed/core");
+  mockCore.getGitDir = actual.getGitDir;
+  mockCore.getCallingFile = actual.getCallingFile;
   return mockCore;
 });
 

packages/benchmark.js-plugin/tests/index.integ.test.ts

@@ -33,6 +33,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@types/find-up": "^4.0.0",
+    "@types/stack-trace": "^0.0.30",
     "node-addon-api": "^5.1.0",
     "node-gyp": "^12.2.0",
     "openapi-typescript-codegen": "^0.23.0",
@@ -42,6 +43,7 @@
     "axios": "^1.4.0",
     "find-up": "^6.3.0",
     "form-data": "^4.0.4",
-    "node-gyp-build": "^4.6.0"
+    "node-gyp-build": "^4.6.0",
+    "stack-trace": "1.0.0-pre2"
   }
 }

packages/core/package.json

@@ -1,5 +1,7 @@
 import { Options as FindupOptions, findUpSync } from "find-up";
-import { dirname } from "path";
+import path, { dirname } from "path";
+import { get as getStackTrace } from "stack-trace";
+import { fileURLToPath } from "url";
 
 export function getGitDir(path: string): string | undefined {
   const dotGitPath = findUpSync(".git", {
@@ -9,6 +11,28 @@ export function getGitDir(path: string): string | undefined {
   return dotGitPath ? dirname(dotGitPath) : undefined;
 }
 
+/**
+ * Return the file that called the function this is invoked from, expressed as
+ * a path relative to the enclosing git repository root.
+ *
+ * The `depth` parameter is the number of stack frames to skip past
+ * `getCallingFile` itself. Pass `0` to get the file of the function that
+ * called `getCallingFile`, `1` to skip one further frame (for indirection
+ * through a helper), and so on.
+ */
+export function getCallingFile(depth: number): string {
+  const stack = getStackTrace();
+  let callingFile = stack[depth + 1].getFileName();
+  const gitDir = getGitDir(callingFile);
+  if (gitDir === undefined) {
+    throw new Error("Could not find a git repository");
+  }
+  if (callingFile.startsWith("file://")) {
+    callingFile = fileURLToPath(callingFile);
+  }
+  return path.relative(gitDir, callingFile);
+}
+
 /**
  * Log debug messages if the environment variable `CODSPEED_DEBUG` is set.
  */

packages/core/src/utils.ts

@@ -36,14 +36,12 @@
   "homepage": "https://codspeed.io",
   "license": "Apache-2.0",
   "devDependencies": {
-    "@types/stack-trace": "^0.0.30",
     "esbuild-register": "^3.4.2",
     "tinybench": "^4.0.1",
     "vitest": "^3.2.4"
   },
   "dependencies": {
-    "@codspeed/core": "workspace:^5.4.0",
-    "stack-trace": "1.0.0-pre2"
+    "@codspeed/core": "workspace:^5.4.0"
   },
   "peerDependencies": {
     "tinybench": ">=4.0.1"

packages/tinybench-plugin/package.json

@@ -1,17 +1,14 @@
 import {
+  getCallingFile,
   getCodspeedRunnerMode,
-  getGitDir,
   getInstrumentMode,
   InstrumentHooks,
   mongoMeasurement,
   SetupInstrumentsRequestBody,
   SetupInstrumentsResponse,
   tryIntrospect,
 } from "@codspeed/core";
-import path from "path";
-import { get as getStackTrace } from "stack-trace";
 import { Bench } from "tinybench";
-import { fileURLToPath } from "url";
 import { setupCodspeedAnalysisBench } from "./analysis";
 import { getOrCreateUriMap } from "./uri";
 import { setupCodspeedWalltimeBench } from "./walltime";
@@ -24,13 +21,13 @@ export function withCodSpeed(bench: Bench): Bench {
     return bench;
   }
 
-  const rootCallingFile = getCallingFile();
+  const rootCallingFile = getCallingFile(1);
 
   // Compute and register URI for bench
   const uriMap = getOrCreateUriMap(bench);
   const rawAdd = bench.add;
   bench.add = (name, fn, opts?) => {
-    const callingFile = getCallingFile();
+    const callingFile = getCallingFile(1);
     let uri = callingFile;
     if (bench.name !== undefined) {
       uri += `::${bench.name}`;
@@ -50,19 +47,6 @@ export function withCodSpeed(bench: Bench): Bench {
   return bench;
 }
 
-function getCallingFile(): string {
-  const stack = getStackTrace();
-  let callingFile = stack[2].getFileName(); // [here, withCodSpeed, actual caller]
-  const gitDir = getGitDir(callingFile);
-  if (gitDir === undefined) {
-    throw new Error("Could not find a git repository");
-  }
-  if (callingFile.startsWith("file://")) {
-    callingFile = fileURLToPath(callingFile);
-  }
-  return path.relative(gitDir, callingFile);
-}
-
 /**
  * Dynamically setup the CodSpeed instruments.
  */