feat(build): run precompile

.github/workflows/build.yml

@@ -82,4 +82,4 @@ jobs:
         with:
           name: ${{ matrix.os }}.${{ matrix.node-version }}.${{ matrix.host }}.${{ github.sha }}
           path: |
-            ${{ github.workspace }}/binaries/*.node
+            ${{ github.workspace }}/binaries

.gitignore

@@ -6,6 +6,7 @@
 
 coverage/
 lib/
+binaries/
 
 node_modules/
 memory_db

package.json

@@ -19,9 +19,13 @@
     "README.md",
     "package.json",
     "package-lock.json",
-    "binaries"
+    "binaries",
+    "scripts/binaries.js",
+    "scripts/check-build.js",
+    "scripts/copu-target.js"
   ],
   "scripts": {
+    "postinstall": "node scripts/check-build.js",
     "clean": "rm -rf ./lib && rm -rf build",
     "lint": "eslint ./src --ext .ts",
     "build": "npm run build:bindings && npm run build:lib",
@@ -62,6 +66,7 @@
     "@types/express": "^4.17.14",
     "@types/jest": "^29.0.0",
     "@types/node": "^18.0.2",
+    "@types/node-abi": "^3.0.0",
     "@typescript-eslint/eslint-plugin": "^5.36.2",
     "@typescript-eslint/parser": "^5.36.2",
     "autocannon": "^7.9.0",

scripts/binaries.js

@@ -0,0 +1,14 @@
+/* eslint-env node */
+const os = require('os');
+const path = require('path');
+const abi = require('node-abi');
+
+function getModuleName() {
+  return `sentry_cpu_profiler-v${abi.getAbi(process.versions.node, 'node')}-${os.platform()}-${os.arch()}.node`;
+}
+
+const source = path.join(__dirname, '..', 'build', 'Release', 'sentry_cpu_profiler.node');
+const target = path.join(__dirname, '..', 'binaries', getModuleName());
+
+module.exports.target = target;
+module.exports.source = source;

scripts/check-build.js

@@ -0,0 +1,44 @@
+/* eslint-env node */
+const cp = require('child_process');
+const os = require('os');
+
+const { target } = require('./binaries');
+
+function recompileFromSource() {
+  try {
+    console.log('@sentry/profiling-node: Precompiled binary not found, compiling from source...');
+    cp.execSync(`npm run build:configure --arch=${os.arch()}`);
+    cp.execSync(`npm run build:bindings`);
+    cp.execSync('node scripts/copy-target.js');
+    return true;
+  } catch (e) {
+    console.error(
+      '@sentry/profiling-node: Failed to build from source, please report this a bug at https://github.com/getsentry/profiling-node/issues/new?assignees=&labels=Type%3A+Bug&template=bug.yml'
+    );
+    return false;
+  }
+}
+
+try {
+  require(target);
+  console.log('@sentry/profiling-node: Precompiled binary found, skipping build from source.');
+} catch (e) {
+  // Check for node version missmatch
+  if (/was compiled against a different Node.js/.test(e.message)) {
+    const success = recompileFromSource();
+    if (success) {
+      process.exit(0);
+    }
+  }
+  // Not sure if this could even happen, but just in case it somehow does,
+  //  we can provide a better experience than just crashing with cannot find module message.
+  if (/Cannot find module/.test(e.message)) {
+    const success = recompileFromSource();
+    if (success) {
+      process.exit(0);
+    }
+  }
+
+  // re-throw so we dont end up swallowing errors
+  throw e;
+}

src/cpu_profiler.ts

@@ -1,7 +1,13 @@
-// @ts-expect-error this screams because it cannot resolve the module?
-import profiler from './../build/Release/sentry_cpu_profiler.node';
+import os from 'os';
+import path from 'path';
+import abi from 'node-abi';
 import { threadId } from 'worker_threads';
 
+export function importCppBindingsModule(): PrivateV8CpuProfilerBindings {
+  const name = `sentry_cpu_profiler-v${abi.getAbi(process.versions.node, 'node')}-${os.platform()}-${os.arch()}.node`;
+  return require(path.join(__dirname, '..', 'binaries', name));
+}
+
 interface Sample {
   stack_id: number;
   thread_id: string;
@@ -44,7 +50,7 @@ interface V8CpuProfilerBindings {
   stopProfiling(name: string): RawThreadCpuProfile | null;
 }
 
-const privateBindings: PrivateV8CpuProfilerBindings = profiler;
+const privateBindings: PrivateV8CpuProfilerBindings = importCppBindingsModule();
 const CpuProfilerBindings: V8CpuProfilerBindings = {
   startProfiling(name: string) {
     return privateBindings.startProfiling(name);

src/hubextensions.hub.test.ts

@@ -1,6 +1,7 @@
 import * as Sentry from '@sentry/node';
 import '@sentry/tracing'; // this has a addExtensionMethods side effect
 import { ProfilingIntegration } from './index'; // this has a addExtensionMethods side effect
+import { importCppBindingsModule } from './cpu_profiler';
 
 Sentry.init({
   dsn: 'https://[email protected]/6625302',
@@ -11,8 +12,7 @@ Sentry.init({
   integrations: [new ProfilingIntegration()]
 });
 
-// @ts-expect-error file extension errors
-import profiler from './../build/Release/sentry_cpu_profiler';
+const profiler = importCppBindingsModule();
 
 describe('hubextensions', () => {
   beforeEach(() => {

src/hubextensions.test.ts

@@ -1,9 +1,9 @@
 import type { BaseTransportOptions, ClientOptions, Hub, Transaction, TransactionMetadata } from '@sentry/types';
 
 import { __PRIVATE__wrapStartTransactionWithProfiling } from './hubextensions';
+import { importCppBindingsModule } from './cpu_profiler';
 
-// @ts-expect-error file extension errors
-import profiler from './../build/Release/sentry_cpu_profiler';
+const profiler = importCppBindingsModule();
 
 function makeTransactionMock(): Transaction {
   return {