feat: Support Electron (#9)

timfish · web-flow · commit 76d1a632dd22 · 2025-02-12T17:59:00.000+01:00
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -253,7 +253,7 @@ jobs:
 
         - name: Build TypeScript
           run: yarn build:lib
-  
+
         - name: Extract Prebuilt Binaries
           uses: actions/download-artifact@v4
           with:
@@ -271,8 +271,8 @@ jobs:
             retention-days: 90
             path: ${{ github.workspace }}/*.tgz
 
-  job_test:
-    name: Test (v${{ matrix.node }}) ${{ matrix.os }}
+  job_test_bindings:
+    name: Test Bindings (v${{ matrix.node }}) ${{ matrix.os }}
     needs: [job_build]
     runs-on: ${{ matrix.os }}
     strategy:
@@ -302,11 +302,55 @@ jobs:
         with:
           name: ${{ github.sha }}
       - name: Run tests
-        run: yarn test
+        run: yarn test:bindings
+
+  job_test_electron:
+    name: Test Electron ${{ matrix.os }}
+    needs: [job_build]
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [macos-latest, windows-latest]
+    steps:
+      - name: Check out current commit
+        uses: actions/checkout@v4
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: 'package.json'
+      - name: Install dependencies
+        run: yarn install --ignore-engines --ignore-scripts --frozen-lockfile
+      - name: Download Tarball
+        uses: actions/download-artifact@v4
+        with:
+          name: ${{ github.sha }}
+      - name: Run tests
+        run: yarn test:electron
+
+  job_test_bundling:
+    name: Test Bundling
+    needs: [job_build]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out current commit
+        uses: actions/checkout@v4
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version-file: 'package.json'
+      - name: Install dependencies
+        run: yarn install --ignore-engines --ignore-scripts --frozen-lockfile
+      - name: Download Tarball
+        uses: actions/download-artifact@v4
+        with:
+          name: ${{ github.sha }}
+      - name: Run tests
+        run: yarn test:bundling
 
   job_required_jobs_passed:
     name: All required jobs passed
-    needs: [job_test, job_lint]
+    needs: [job_lint, job_test_bindings, job_test_electron, job_test_bundling]
     # Always run this, even if a dependent job failed
     if: always()
     runs-on: ubuntu-latest
diff --git a/.gitignore b/.gitignore
@@ -3,8 +3,8 @@
 
 build/*
 lib/*
-test/package.json
-test/yarn.lock
+test/**/yarn.lock
+test/**/package.json
 
 ### Node ###
 # Logs
diff --git a/package.json b/package.json
@@ -40,7 +40,10 @@
     "build:bindings:arm64": "node-gyp build --arch=arm64 && node scripts/copy-target.js",
     "build:dev": "yarn clean && yarn build:bindings:configure && yarn build",
     "build:tarball": "npm pack",
-    "test": "node ./test/prepare.js && vitest run --testTimeout 60000"
+    "test": "yarn test:bindings && yarn test:bundling && yarn test:electron",
+    "test:bundling": "node test/prepare.mjs bundler && vitest run --testTimeout 60000 ./test/bundler",
+    "test:electron": "node test/prepare.mjs electron && vitest run --testTimeout 120000 ./test/electron",
+    "test:bindings": "node test/prepare.mjs bindings && vitest run --testTimeout 60000 ./test/bindings"
   },
   "dependencies": {
     "detect-libc": "^2.0.3",
@@ -55,10 +58,7 @@
     "eslint": "^7.0.0",
     "node-gyp": "^9.4.1",
     "typescript": "^5.7.3",
-    "vitest": "^3.0.4",
-    "webpack": "^5.97.1",
-    "node-loader": "^2.1.0",
-    "esbuild": "^0.24.2"
+    "vitest": "^3.0.5"
   },
   "sideEffects": false,
   "volta": {
diff --git a/src/index.ts b/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') {
diff --git a/test/bindings/bindings.test.ts b/test/bindings/bindings.test.ts
diff --git a/test/bindings/package.json.template b/test/bindings/package.json.template
@@ -0,0 +1,7 @@
+{
+  "name": "node-cpu-profiler-test",
+  "license": "MIT",
+  "dependencies": {
+    "@sentry-internal/node-cpu-profiler": "{{path}}"
+  }
+}
diff --git a/test/bindings/profiler.test.ts b/test/bindings/profiler.test.ts
diff --git a/test/bundler/bundle.mjs b/test/bundler/bundle.mjs
@@ -1,10 +1,9 @@
-import { inspect } from 'node:util';
-
 import { CpuProfilerBindings, ProfileFormat } from '@sentry-internal/node-cpu-profiler';
 
 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);
diff --git a/test/bundler/bundler.test.ts b/test/bundler/bundler.test.ts
@@ -1,6 +1,8 @@
+// eslint-disable-next-line import/no-unresolved
 import esbuild from 'esbuild';
 import * as path from 'path';
 import { describe, expect, test } from "vitest";
+// eslint-disable-next-line import/no-unresolved
 import webpack from 'webpack';
 
 const entry = path.resolve(__dirname, 'bundle.mjs');
@@ -28,7 +30,7 @@ describe('Bundler tests', () => {
           rules: [
             {
               test: /\.node$/,
-              loader: 'node-loader',
+              loader: require.resolve('node-loader'),
             },
           ],
         },
diff --git a/test/bundler/package.json.template b/test/bundler/package.json.template
@@ -0,0 +1,10 @@
+{
+  "name": "node-cpu-profiler-bundler-test",
+  "license": "MIT",
+  "dependencies": {
+    "webpack": "^5.97.1",
+    "node-loader": "^2.1.0",
+    "esbuild": "^0.24.2",
+    "@sentry-internal/node-cpu-profiler": "{{path}}"
+  }
+}
diff --git a/test/electron/electron.test.ts b/test/electron/electron.test.ts
@@ -0,0 +1,27 @@
+import type { SpawnSyncReturns } from 'child_process';
+import { execSync, spawnSync } from 'child_process';
+// eslint-disable-next-line import/no-unresolved
+import { default as getElectronPath } from 'electron';
+import { describe, expect, test } from "vitest";
+
+function runElectron(): SpawnSyncReturns<Buffer> {
+  // 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.
+  return spawnSync(getElectronPath, [__dirname]);
+}
+
+describe('Electron', () => {
+
+  test('should work', () => {
+    const result1 = runElectron();
+
+    expect(result1.stderr.toString()).toContain('binary could not be found')
+    expect(result1.status).toBe(1);
+
+    execSync('yarn rebuild', { cwd: __dirname });
+
+    const result2 = runElectron();
+    expect(result2.status).toBe(0);
+  });
+});
diff --git a/test/electron/main.mjs b/test/electron/main.mjs
@@ -0,0 +1,18 @@
+process.on('unhandledRejection', (err) => {
+  console.error(err);
+  process.exit(1);
+});
+process.on('uncaughtException', (err) => {
+  console.error(err);
+  process.exit(1);
+});
+
+const { CpuProfilerBindings, ProfileFormat } = await import('@sentry-internal/node-cpu-profiler');
+
+CpuProfilerBindings.startProfiling('test');
+
+setTimeout(() => {
+  const report = CpuProfilerBindings.stopProfiling('test', ProfileFormat.THREAD);
+  console.assert(report);
+  process.exit(0);
+}, 5000);
diff --git a/test/electron/package.json.template b/test/electron/package.json.template
@@ -0,0 +1,13 @@
+{
+  "name": "node-cpu-profiler-test",
+  "license": "MIT",
+  "main": "main.mjs",
+  "scripts": {
+    "rebuild": "electron-rebuild"
+  },
+  "dependencies": {
+    "electron": "^34.1.0",
+    "@electron/rebuild": "^3.7.1",
+    "@sentry-internal/node-cpu-profiler": "{{path}}"
+  }
+}
diff --git a/test/prepare.js b/test/prepare.js
diff --git a/test/prepare.mjs b/test/prepare.mjs
@@ -0,0 +1,45 @@
+import { execSync, spawnSync } from 'node:child_process';
+import {readFileSync, rmSync, writeFileSync, existsSync } from 'node:fs';
+import { createRequire } from 'node:module';
+import { dirname, join, relative } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const require = createRequire(import.meta.url);
+
+function prepareTest(root) {
+  const pkgJson = require('../package.json');
+  const normalizedName = pkgJson.name.replace('@', '').replace('/', '-');
+
+  const tarball = join(__dirname, '..', `${normalizedName}-${pkgJson.version}.tgz`);
+
+  if (!existsSync(tarball)) {
+    console.error(`Tarball not found: '${tarball}'`);
+    console.error(`Run 'yarn build && yarn build:tarball' first`);
+    process.exit(1);
+  }
+
+  const tarballRelative = relative(root, tarball);
+
+  console.log('Clearing node_modules...');
+  rmSync(join(root, 'node_modules'), { recursive: true, force: true });
+  console.log('Clearing yarn.lock...');
+  rmSync(join(root, 'yarn.lock'), { force: true });
+
+  console.log('Clearing yarn cache...');
+  spawnSync(`yarn cache clean ${pkgJson.name}`, { shell: true, stdio: 'inherit' });
+  // Yarn has a bug where 'yarn cache clean X' does not remove the temp directory where the tgz is unpacked to.
+  // This means installing from local tgz does not update when src changes are made https://github.com/yarnpkg/yarn/issues/5357
+  const dirResult = spawnSync('yarn cache dir', { shell: true });
+  const tmpDir = join(dirResult.output.toString().replace(/[,\n\r]/g, ''), '.tmp');
+  rmSync(tmpDir, { recursive: true, force: true });
+
+  const pkg = readFileSync(join(root, 'package.json.template'), 'utf-8');
+  const modified = pkg.replace(/"{{path}}"/, JSON.stringify(`file:${tarballRelative}`));
+  writeFileSync(join(root, 'package.json'), modified);
+
+  console.log('Installing dependencies...');
+  execSync('yarn install', { cwd: root });
+}
+
+prepareTest(join(__dirname, process.argv[2]));
diff --git a/yarn.lock b/yarn.lock
