feat: Support Electron

Author: timfish

package.json

@@ -58,7 +58,9 @@
     "vitest": "^3.0.4",
     "webpack": "^5.97.1",
     "node-loader": "^2.1.0",
-    "esbuild": "^0.24.2"
+    "esbuild": "^0.24.2",
+    "electron": "^34.1.0",
+    "@electron/rebuild": "^3.7.1"
   },
   "sideEffects": false,
   "volta": {

src/index.ts

@@ -37,6 +37,15 @@ export function importCppBindingsModule(): PrivateV8CpuProfilerBindings {
     return require(binaryPath);
   }
 
+  if (process.versions.electron) {
+    try {
+      return require('../build/Release/sentry_cpu_profiler.node');
+    } catch (e) {
+      console.warn(`The '@sentry/profiling-node' binary could not be found. Use '@electron/rebuild' to ensure the native module is built for Electron.`);
+      throw e;
+    }
+  }
+
   // We need the fallthrough so that in the end, we can fallback to the dynamic require.
   // This is for cases where precompiled binaries were not provided, but may have been compiled from source.
   if (platform === 'darwin') {

test/bundle.mjs

@@ -1,10 +1,18 @@
-import { inspect } from 'node:util';
-
 import { CpuProfilerBindings, ProfileFormat } from '@sentry-internal/node-cpu-profiler';
 
+process.on('uncaughtException', (err) => {
+  console.error(err);
+  process.exit(1);
+});
+process.on('unhandledRejection', (err) => {
+  console.error(err);
+  process.exit(1);
+ });
+
 CpuProfilerBindings.startProfiling('test');
 
 setTimeout(() => {
   const report = CpuProfilerBindings.stopProfiling('test', ProfileFormat.THREAD);
-  console.log(inspect(report, false, null, true));
+  console.assert(report);
+  process.exit(0);
 }, 5000);

test/electron.test.ts

@@ -0,0 +1,15 @@
+import { execSync, spawnSync,  } from 'child_process';
+import { default as getElectronPath } from 'electron';
+import { describe, expect, test } from "vitest";
+
+describe('Electron', () => {
+  test('should work', () => {
+    execSync('yarn rebuild', { cwd: __dirname });
+
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-ignore - The Electron types don't detail the default export outside
+    // of an Electron process.
+    const result = spawnSync(getElectronPath, [__dirname]);
+    expect(result.status).toBe(0);
+  });
+});

test/prepare.js

@@ -33,6 +33,10 @@ console.log('Writing package.json...');
 writeFileSync(join(__dirname, 'package.json'), `{
       "name": "node-cpu-profiler-test",
       "license": "MIT",
+      "main": "bundle.mjs",
+      "scripts": {
+        "rebuild": "electron-rebuild"
+      },
       "dependencies": {
         "@sentry-internal/node-cpu-profiler": "file:../${normalizedName}-${pkgJson.version}.tgz"
       }