feat: use prebuildify to create the bundle with native addons

Author: art049

.gitignore

@@ -125,8 +125,7 @@ packages/app/.env
 
 .vercel
 .DS_Store
-#node-gyp builds
-packages/core/build
+
 # moon
 .moon/cache
 .moon/docker

packages/core/.gitignore

@@ -0,0 +1,2 @@
+build
+prebuilds

packages/core/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/core/moon.yml

@@ -7,10 +7,13 @@ tasks:
       - "build-native-addon"
 
   build-native-addon:
-    command: "node-gyp rebuild"
-    platform: "system"
+    deps:
+      - "build-native-addon-linux-x64"
+
+  build-native-addon-linux-x64:
+    command: prebuildify --napi --strip
     inputs:
       - "src/measurement.cc"
       - "binding.gyp"
     outputs:
-      - "build/"
+      - "prebuilds/linux-x64"

packages/core/package.json

@@ -7,23 +7,24 @@
     "benchmark",
     "performance"
   ],
-  "gypfile": true,
+  "files": [
+    "dist",
+    "prebuilds"
+  ],
   "main": "dist/index.cjs.js",
   "module": "dist/index.es5.js",
   "types": "dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
+  "gypfile": true,
   "author": "Arthur Pastel <[email protected]>",
   "repository": "https://github.com/CodSpeedHQ/codspeed-node/tree/main/packages/core",
   "homepage": "https://codspeed.io",
   "license": "MIT",
   "devDependencies": {
-    "@types/bindings": "^1.5.1",
-    "rollup-plugin-natives": "^0.7.6"
+    "node-addon-api": "^5.0.0",
+    "node-gyp": "^9.3.1",
+    "prebuildify": "^5.0.1"
   },
   "dependencies": {
-    "bindings": "^1.5.0",
-    "node-addon-api": "^5.0.0"
+    "node-gyp-build": "^4.6.0"
   }
 }

packages/core/rollup.config.ts

@@ -1,5 +1,4 @@
 import { defineConfig } from "rollup";
-import nativePlugin from "rollup-plugin-natives";
 import { declarationsPlugin, jsPlugins } from "../../rollup.options";
 
 import pkg from "./package.json" assert { type: "json" };
@@ -28,12 +27,6 @@ export default defineConfig([
       },
       { file: pkg.module, format: "es", sourcemap: true },
     ],
-    plugins: [
-      ...jsPlugins,
-      nativePlugin({
-        copyTo: "dist/lib",
-        destDir: "./lib",
-      }),
-    ],
+    plugins: jsPlugins,
   },
 ]);

packages/core/src/index.ts

@@ -1,10 +1,30 @@
+import path from "path";
+
+/* eslint-disable @typescript-eslint/no-empty-function */
 export interface Measurement {
   isInstrumented(): boolean;
   startMeasurement(): void;
   stopMeasurement(at: string): void;
+  isBound: boolean;
 }
 
-// eslint-disable-next-line @typescript-eslint/no-var-requires
-const measurement = require("bindings")("measurement.node") as Measurement;
-
+let m: Measurement;
+try {
+  m = {
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
+    ...require("node-gyp-build")(path.dirname(__dirname)),
+    isBound: true,
+  } as Measurement;
+  console.warn("@codspeed/core binding found");
+} catch (e) {
+  console.warn("@codspeed/core binding not available on this architecture");
+  m = {
+    isInstrumented: () => false,
+    startMeasurement: () => {},
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    stopMeasurement: (at) => {},
+    isBound: false,
+  };
+}
+const measurement = m;
 export default measurement;

packages/core/tests/unit.test.ts

@@ -0,0 +1,27 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+import type { Measurement } from "../dist";
+
+beforeEach(() => {
+  jest.resetModules();
+});
+
+describe("with bindings", () => {
+  it("should be bound", () => {
+    const measurement = require("..") as Measurement;
+    expect(measurement.isBound).toBe(true);
+  });
+});
+
+describe("without bindings", () => {
+  const initialEnv = process.env;
+  beforeAll(() => {
+    process.env.npm_config_arch = "unknown";
+  });
+  afterAll(() => {
+    process.env = initialEnv;
+  });
+  it("should not be bound", () => {
+    const measurement = require("..") as Measurement;
+    expect(measurement.isBound).toBe(false);
+  });
+});