feat: use instrument hooks for measurements

Author: GuillaumeLagrange

.github/workflows/ci.yml

@@ -12,7 +12,7 @@ jobs:
     steps:
       - uses: "actions/checkout@v4"
         with:
-          fetch-depth: 0
+          submodules: true
       - name: Install valgrind
         run: |
           sudo apt-get update
@@ -32,6 +32,8 @@ jobs:
       examples: ${{ steps.list-examples.outputs.examples }}
     steps:
       - uses: "actions/checkout@v4"
+        with:
+          submodules: true
       # list the directories in ./examples and output them to a github action workflow variables as a JSON array
       - run: |
           examples=$(find ./examples -maxdepth 1 -mindepth 1 -type d -printf '%f\n' | jq -R -s -c 'split("\n") | map(select(length > 0))')
@@ -50,7 +52,7 @@ jobs:
     steps:
       - uses: "actions/checkout@v4"
         with:
-          fetch-depth: 0
+          submodules: true
       - name: Install valgrind
         run: |
           sudo apt-get update

.prettierignore

@@ -2,3 +2,4 @@ node_modules
 .rollup.cache
 dist
 generated
+packages/core/src/native_core/instruments/hooks

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

@@ -1,5 +1,5 @@
 import {
-  Measurement,
+  InstrumentHooks,
   mongoMeasurement,
   optimizeFunction,
   optimizeFunctionSync,
@@ -90,7 +90,7 @@ export function withCodSpeed(item: unknown): unknown {
 }
 
 function withCodSpeedBenchmark(bench: Benchmark): WithCodSpeedBenchmark {
-  if (!Measurement.isInstrumented()) {
+  if (!InstrumentHooks.isInstrumented()) {
     const rawRun = bench.run;
     bench.run = (options?: Benchmark.Options) => {
       console.warn(
@@ -120,7 +120,7 @@ function withCodSpeedBenchmark(bench: Benchmark): WithCodSpeedBenchmark {
 }
 
 function withCodSpeedSuite(suite: Benchmark.Suite): WithCodSpeedSuite {
-  if (!Measurement.isInstrumented()) {
+  if (!InstrumentHooks.isInstrumented()) {
     const rawRun = suite.run;
     suite.run = (options?: Benchmark.Options) => {
       console.warn(
@@ -198,18 +198,20 @@ async function runBenchmarks({
       await mongoMeasurement.start(uri);
       global.gc?.();
       await (async function __codspeed_root_frame__() {
-        Measurement.startInstrumentation();
+        const benchmarkId = InstrumentHooks.startBenchmark();
         await benchPayload();
-        Measurement.stopInstrumentation(uri);
+        InstrumentHooks.stopBenchmark();
+        InstrumentHooks.setExecutedBenchmark(benchmarkId, uri);
       })();
       await mongoMeasurement.stop(uri);
     } else {
       optimizeFunctionSync(benchPayload);
       await mongoMeasurement.start(uri);
       (function __codspeed_root_frame__() {
-        Measurement.startInstrumentation();
+        const benchmarkId = InstrumentHooks.startBenchmark();
         benchPayload();
-        Measurement.stopInstrumentation(uri);
+        InstrumentHooks.stopBenchmark();
+        InstrumentHooks.setExecutedBenchmark(benchmarkId, uri);
       })();
       await mongoMeasurement.stop(uri);
     }
@@ -231,7 +233,7 @@ async function runBenchmarks({
 export async function setupInstruments(
   body: SetupInstrumentsRequestBody
 ): Promise<SetupInstrumentsResponse> {
-  if (!Measurement.isInstrumented()) {
+  if (!InstrumentHooks.isInstrumented()) {
     console.warn("[CodSpeed] No instrumentation found, using default mongoUrl");
 
     return { remoteAddr: body.mongoUrl };

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

@@ -15,6 +15,8 @@ jest.mock("@codspeed/core", () => {
 beforeEach(() => {
   mockReset(mockCore);
   jest.clearAllMocks();
+  // Set up mock return values
+  mockCore.InstrumentHooks.startBenchmark.mockReturnValue(1);
 });
 
 const benchOptions: Benchmark.Options = {
@@ -23,7 +25,7 @@ const benchOptions: Benchmark.Options = {
 
 describe("Benchmark", () => {
   it("simple benchmark", async () => {
-    mockCore.Measurement.isInstrumented.mockReturnValue(false);
+    mockCore.InstrumentHooks.isInstrumented.mockReturnValue(false);
     const bench = withCodSpeed(
       new Benchmark(
         "RegExp",
@@ -37,11 +39,11 @@ describe("Benchmark", () => {
     bench.on("complete", onComplete);
     await bench.run();
     expect(onComplete).toHaveBeenCalled();
-    expect(mockCore.Measurement.startInstrumentation).not.toHaveBeenCalled();
-    expect(mockCore.Measurement.stopInstrumentation).not.toHaveBeenCalled();
+    expect(mockCore.InstrumentHooks.startBenchmark).not.toHaveBeenCalled();
+    expect(mockCore.InstrumentHooks.stopBenchmark).not.toHaveBeenCalled();
   });
   it("check core methods are called", async () => {
-    mockCore.Measurement.isInstrumented.mockReturnValue(true);
+    mockCore.InstrumentHooks.isInstrumented.mockReturnValue(true);
 
     const bench = withCodSpeed(
       new Benchmark(
@@ -56,13 +58,15 @@ describe("Benchmark", () => {
     bench.on("complete", onComplete);
     await bench.run();
     expect(onComplete).toHaveBeenCalled();
-    expect(mockCore.Measurement.startInstrumentation).toHaveBeenCalled();
-    expect(mockCore.Measurement.stopInstrumentation).toHaveBeenCalledWith(
+    expect(mockCore.InstrumentHooks.startBenchmark).toHaveBeenCalled();
+    expect(mockCore.InstrumentHooks.stopBenchmark).toHaveBeenCalled();
+    expect(mockCore.InstrumentHooks.setExecutedBenchmark).toHaveBeenCalledWith(
+      expect.any(Number),
       "packages/benchmark.js-plugin/tests/index.integ.test.ts::RegExpSingle"
     );
   });
   it("check error handling", async () => {
-    mockCore.Measurement.isInstrumented.mockReturnValue(true);
+    mockCore.InstrumentHooks.isInstrumented.mockReturnValue(true);
     const bench = withCodSpeed(
       new Benchmark(
         "throwing",
@@ -79,7 +83,7 @@ describe("Benchmark", () => {
     async (instrumented) => {
       const logSpy = jest.spyOn(console, "log");
       const warnSpy = jest.spyOn(console, "warn");
-      mockCore.Measurement.isInstrumented.mockReturnValue(instrumented);
+      mockCore.InstrumentHooks.isInstrumented.mockReturnValue(instrumented);
       await withCodSpeed(
         new Benchmark(
           "RegExpSingle",
@@ -108,7 +112,7 @@ describe("Benchmark", () => {
     }
   );
   it("should call setup and teardown", async () => {
-    mockCore.Measurement.isInstrumented.mockReturnValue(true);
+    mockCore.InstrumentHooks.isInstrumented.mockReturnValue(true);
     const setup = jest.fn();
     const teardown = jest.fn();
     const bench = withCodSpeed(
@@ -128,7 +132,7 @@ describe("Benchmark", () => {
 
 describe("Benchmark.Suite", () => {
   it("simple suite", async () => {
-    mockCore.Measurement.isInstrumented.mockReturnValue(false);
+    mockCore.InstrumentHooks.isInstrumented.mockReturnValue(false);
     const suite = withCodSpeed(new Benchmark.Suite());
     suite.add(
       "RegExp",
@@ -141,11 +145,11 @@ describe("Benchmark.Suite", () => {
     suite.on("complete", onComplete);
     await suite.run({ maxTime: 0.1, initCount: 1 });
     expect(onComplete).toHaveBeenCalled();
-    expect(mockCore.Measurement.startInstrumentation).not.toHaveBeenCalled();
-    expect(mockCore.Measurement.stopInstrumentation).not.toHaveBeenCalled();
+    expect(mockCore.InstrumentHooks.startBenchmark).not.toHaveBeenCalled();
+    expect(mockCore.InstrumentHooks.stopBenchmark).not.toHaveBeenCalled();
   });
   it("check core methods are called", async () => {
-    mockCore.Measurement.isInstrumented.mockReturnValue(true);
+    mockCore.InstrumentHooks.isInstrumented.mockReturnValue(true);
     const suite = withCodSpeed(new Benchmark.Suite()).add(
       "RegExp",
       function () {
@@ -156,13 +160,15 @@ describe("Benchmark.Suite", () => {
     const onComplete = jest.fn();
     suite.on("complete", onComplete);
     await suite.run({ maxTime: 0.1, initCount: 1 });
-    expect(mockCore.Measurement.startInstrumentation).toHaveBeenCalled();
-    expect(mockCore.Measurement.stopInstrumentation).toHaveBeenCalledWith(
+    expect(mockCore.InstrumentHooks.startBenchmark).toHaveBeenCalled();
+    expect(mockCore.InstrumentHooks.stopBenchmark).toHaveBeenCalled();
+    expect(mockCore.InstrumentHooks.setExecutedBenchmark).toHaveBeenCalledWith(
+      expect.any(Number),
       "packages/benchmark.js-plugin/tests/index.integ.test.ts::RegExp"
     );
   });
   it("check suite name is in the uri", async () => {
-    mockCore.Measurement.isInstrumented.mockReturnValue(true);
+    mockCore.InstrumentHooks.isInstrumented.mockReturnValue(true);
     await withCodSpeed(new Benchmark.Suite("thesuite"))
       .add(
         "RegExp",
@@ -175,15 +181,19 @@ describe("Benchmark.Suite", () => {
         /o/.test("Hello World!");
       }, benchOptions)
       .run();
-    expect(mockCore.Measurement.stopInstrumentation).toHaveBeenCalledWith(
+    expect(mockCore.InstrumentHooks.stopBenchmark).toHaveBeenCalled();
+    expect(mockCore.InstrumentHooks.setExecutedBenchmark).toHaveBeenCalledWith(
+      expect.any(Number),
       "packages/benchmark.js-plugin/tests/index.integ.test.ts::thesuite::RegExp"
     );
-    expect(mockCore.Measurement.stopInstrumentation).toHaveBeenCalledWith(
+    expect(mockCore.InstrumentHooks.stopBenchmark).toHaveBeenCalled();
+    expect(mockCore.InstrumentHooks.setExecutedBenchmark).toHaveBeenCalledWith(
+      expect.any(Number),
       "packages/benchmark.js-plugin/tests/index.integ.test.ts::thesuite::unknown_1"
     );
   });
   it("check error handling", async () => {
-    mockCore.Measurement.isInstrumented.mockReturnValue(true);
+    mockCore.InstrumentHooks.isInstrumented.mockReturnValue(true);
     const bench = withCodSpeed(new Benchmark.Suite("thesuite")).add(
       "throwing",
       () => {
@@ -197,7 +207,7 @@ describe("Benchmark.Suite", () => {
     async (instrumented) => {
       const logSpy = jest.spyOn(console, "log");
       const warnSpy = jest.spyOn(console, "warn");
-      mockCore.Measurement.isInstrumented.mockReturnValue(instrumented);
+      mockCore.InstrumentHooks.isInstrumented.mockReturnValue(instrumented);
       await withCodSpeed(new Benchmark.Suite("thesuite"))
         .add(
           "RegExp",
@@ -229,35 +239,41 @@ describe("Benchmark.Suite", () => {
     }
   );
   it("check nested file path is in the uri when bench is registered in another file", async () => {
-    mockCore.Measurement.isInstrumented.mockReturnValue(true);
+    mockCore.InstrumentHooks.isInstrumented.mockReturnValue(true);
     const suite = withCodSpeed(new Benchmark.Suite("thesuite"));
     registerBenchmarks(suite);
     const onComplete = jest.fn();
     suite.on("complete", onComplete);
     await suite.run({ maxTime: 0.1, initCount: 1 });
-    expect(mockCore.Measurement.startInstrumentation).toHaveBeenCalled();
-    expect(mockCore.Measurement.stopInstrumentation).toHaveBeenCalledWith(
+    expect(mockCore.InstrumentHooks.startBenchmark).toHaveBeenCalled();
+    expect(mockCore.InstrumentHooks.stopBenchmark).toHaveBeenCalled();
+    expect(mockCore.InstrumentHooks.setExecutedBenchmark).toHaveBeenCalledWith(
+      expect.any(Number),
       "packages/benchmark.js-plugin/tests/registerBenchmarks.ts::thesuite::RegExp"
     );
   });
   it("check that benchmarks with same name have different URIs when registered in different files", async () => {
-    mockCore.Measurement.isInstrumented.mockReturnValue(true);
+    mockCore.InstrumentHooks.isInstrumented.mockReturnValue(true);
     const suite = withCodSpeed(new Benchmark.Suite("thesuite"));
     registerBenchmarks(suite);
     registerOtherBenchmarks(suite);
     const onComplete = jest.fn();
     suite.on("complete", onComplete);
     await suite.run({ maxTime: 0.1, initCount: 1 });
-    expect(mockCore.Measurement.startInstrumentation).toHaveBeenCalled();
-    expect(mockCore.Measurement.stopInstrumentation).toHaveBeenCalledWith(
+    expect(mockCore.InstrumentHooks.startBenchmark).toHaveBeenCalled();
+    expect(mockCore.InstrumentHooks.stopBenchmark).toHaveBeenCalled();
+    expect(mockCore.InstrumentHooks.setExecutedBenchmark).toHaveBeenCalledWith(
+      expect.any(Number),
       "packages/benchmark.js-plugin/tests/registerBenchmarks.ts::thesuite::RegExp"
     );
-    expect(mockCore.Measurement.stopInstrumentation).toHaveBeenCalledWith(
+    expect(mockCore.InstrumentHooks.stopBenchmark).toHaveBeenCalled();
+    expect(mockCore.InstrumentHooks.setExecutedBenchmark).toHaveBeenCalledWith(
+      expect.any(Number),
       "packages/benchmark.js-plugin/tests/registerOtherBenchmarks.ts::thesuite::RegExp"
     );
   });
   it("should call setupCore and teardownCore only once after run()", async () => {
-    mockCore.Measurement.isInstrumented.mockReturnValue(true);
+    mockCore.InstrumentHooks.isInstrumented.mockReturnValue(true);
     const suite = withCodSpeed(new Benchmark.Suite("thesuite"));
     registerBenchmarks(suite);
     registerOtherBenchmarks(suite);
@@ -271,7 +287,7 @@ describe("Benchmark.Suite", () => {
     expect(mockCore.teardownCore).toHaveBeenCalledTimes(1);
   });
   it("should call setup and teardown", async () => {
-    mockCore.Measurement.isInstrumented.mockReturnValue(true);
+    mockCore.InstrumentHooks.isInstrumented.mockReturnValue(true);
     const setup = jest.fn();
     const teardown = jest.fn();
 

packages/core/binding.gyp

@@ -8,14 +8,30 @@
       "cflags_cc!": [
         "-fno-exceptions"
       ],
+      "cflags": [
+        "-Wno-maybe-uninitialized",
+        "-Wno-unused-variable",
+        "-Wno-unused-parameter",
+        "-Wno-unused-but-set-variable",
+        "-Wno-type-limits"
+      ],
+      "cflags_cc": [
+        "-Wno-maybe-uninitialized",
+        "-Wno-unused-variable",
+        "-Wno-unused-parameter",
+        "-Wno-unused-but-set-variable",
+        "-Wno-type-limits"
+      ],
       "sources": [
-        "src/native_core/measurement/measurement.cc",
         "src/native_core/linux_perf/linux_perf.cc",
         "src/native_core/linux_perf/linux_perf_listener.cc",
+        "src/native_core/instruments/hooks_wrapper.cc",
+        "src/native_core/instruments/hooks/dist/core.c",
         "src/native_core/native_core.cc"
       ],
       "include_dirs": [
-        "<!@(node -p \"require('node-addon-api').include\")"
+        "<!@(node -p \"require('node-addon-api').include\")",
+        "src/native_core/instruments/hooks/includes"
       ],
       "defines": [
         "NAPI_DISABLE_CPP_EXCEPTIONS"

packages/core/moon.yml

@@ -13,6 +13,7 @@ tasks:
     inputs:
       - "src/native_core/**/*.cc"
       - "src/native_core/**/*.h"
+      - "src/native_core/**/*.c"
       - "binding.gyp"
     outputs:
       - "prebuilds"

packages/core/src/index.ts

@@ -11,9 +11,7 @@ export const isBound = native_core.isBound;
 export const mongoMeasurement = new MongoMeasurement();
 
 export const setupCore = () => {
-  native_core.Measurement.stopInstrumentation(
-    `Metadata: codspeed-node ${__VERSION__}`
-  );
+  native_core.InstrumentHooks.setIntegration("codspeed-node", __VERSION__);
   linuxPerf.start();
   checkV8Flags();
 };
@@ -29,4 +27,4 @@ export type {
 export { getV8Flags, tryIntrospect } from "./introspection";
 export { optimizeFunction, optimizeFunctionSync } from "./optimization";
 export * from "./utils";
-export const Measurement = native_core.Measurement;
+export const InstrumentHooks = native_core.InstrumentHooks;

packages/core/src/native_core/index.ts

@@ -1,8 +1,9 @@
 import path from "path";
+import { InstrumentHooks } from "./instruments/hooks";
 import { LinuxPerf } from "./linux_perf/linux_perf";
-import { Measurement } from "./measurement/measurement";
+
 interface NativeCore {
-  Measurement: Measurement;
+  InstrumentHooks: InstrumentHooks;
   LinuxPerf: typeof LinuxPerf;
 }
 
@@ -22,12 +23,12 @@ try {
   };
 } catch (e) {
   native_core = {
-    Measurement: {
+    InstrumentHooks: {
       isInstrumented: () => false,
-      // eslint-disable-next-line @typescript-eslint/no-empty-function
-      startInstrumentation: () => {},
-      // eslint-disable-next-line @typescript-eslint/no-unused-vars, @typescript-eslint/no-empty-function
-      stopInstrumentation: (at) => {},
+      startBenchmark: () => 1,
+      stopBenchmark: () => 1,
+      setExecutedBenchmark: () => 1,
+      setIntegration: () => 1,
     },
     LinuxPerf: class LinuxPerf {
       start() {

packages/core/src/native_core/instrument-hooks

@@ -0,0 +1,7 @@
+export interface InstrumentHooks {
+  isInstrumented: () => boolean;
+  startBenchmark: () => number;
+  stopBenchmark: () => number;
+  setExecutedBenchmark: (pid: number, uri: string) => number;
+  setIntegration: (name: string, version: string) => number;
+}