Run the tests on the tarball

Author: timfish

.gitignore

@@ -1,3 +1,4 @@
 node_modules/
 build/
 lib/
+/*.tgz

test/e2e.test.mjs

@@ -1,10 +1,15 @@
 import { spawnSync } from 'node:child_process';
 import { join } from 'node:path';
-import { describe, expect, test } from 'vitest';
+import { beforeAll, describe, expect, test } from 'vitest';
+import { installTarballAsDependency } from './prepare.mjs';
 
 const __dirname = import.meta.dirname || new URL('.', import.meta.url).pathname;
 
 describe('e2e Tests', { timeout: 20000 }, () => {
+  beforeAll(() => {
+    installTarballAsDependency(__dirname);
+  });
+
   test('Capture stack trace from multiple threads', () => {
     const testFile = join(__dirname, 'stack-traces.js');
     const result = spawnSync('node', [testFile])

test/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "node-cpu-profiler-test",
+  "license": "MIT",
+  "dependencies": {
+    "@sentry-internal/node-native-stacktrace": "file:../sentry-internal-node-native-stacktrace-0.1.0.tgz"
+  }
+}

test/package.json.template

@@ -0,0 +1,7 @@
+{
+  "name": "node-cpu-profiler-test",
+  "license": "MIT",
+  "dependencies": {
+    "@sentry-internal/node-native-stacktrace": "{{path}}"
+  }
+}

test/prepare.mjs

@@ -0,0 +1,45 @@
+
+import { execSync, spawnSync } from 'node:child_process';
+import {existsSync,readFileSync, rmSync, writeFileSync } 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);
+const env = {...process.env, NODE_OPTIONS: '--no-deprecation'};
+
+export function installTarballAsDependency(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', env });
+  // 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, env });
+  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 });
+}

test/stack-traces.js

@@ -1,6 +1,6 @@
 const { Worker } = require('node:worker_threads');
 const { longWork } = require('./long-work.js');
-const { registerThread } = require('../lib/index.js');
+const { registerThread } = require('@sentry-internal/node-native-stacktrace');
 
 registerThread();
 

test/stalled-watchdog.js

@@ -1,4 +1,4 @@
-const { captureStackTrace, getThreadsLastSeen } = require('../lib/index.js');
+const { captureStackTrace, getThreadsLastSeen } = require('@sentry-internal/node-native-stacktrace');
 
 const THRESHOLD = 500; // 1 second
 

test/stalled.js

@@ -1,6 +1,6 @@
 const { Worker } = require('node:worker_threads');
 const { longWork } = require('./long-work.js');
-const { registerThread } = require('../lib/index.js');
+const { registerThread } = require('@sentry-internal/node-native-stacktrace');
 
 setInterval(() => {
   registerThread();

test/watchdog.js

@@ -1,4 +1,4 @@
-const { captureStackTrace } = require('..');
+const { captureStackTrace } = require('@sentry-internal/node-native-stacktrace');
 
 setTimeout(() => {
     console.log(JSON.stringify(captureStackTrace()));

test/worker-do-nothing.js

@@ -1,5 +1,5 @@
 const { longWork } = require('./long-work');
-const { registerThread } = require('../lib/index.js');
+const { registerThread } = require('@sentry-internal/node-native-stacktrace');
 
 setInterval(() => {
   registerThread();