test(node): Add utility to test esm & cjs instrumentation

Author: mydea

dev-packages/node-integration-tests/.eslintrc.js

@@ -12,10 +12,11 @@ module.exports = {
       },
     },
     {
-      files: ['suites/**/*.ts'],
+      files: ['suites/**/*.ts', 'suites/**/*.mjs'],
       parserOptions: {
         project: ['tsconfig.test.json'],
         sourceType: 'module',
+        ecmaVersion: 'latest',
       },
       rules: {
         '@typescript-eslint/typedef': 'off',

dev-packages/node-integration-tests/.gitignore

@@ -0,0 +1 @@
+suites/**/tmp_*

dev-packages/node-integration-tests/suites/anr/app-path.mjs

@@ -1,10 +1,9 @@
+import * as Sentry from '@sentry/node';
 import * as assert from 'assert';
 import * as crypto from 'crypto';
 import * as path from 'path';
 import * as url from 'url';
 
-import * as Sentry from '@sentry/node';
-
 global._sentryDebugIds = { [new Error().stack]: 'aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaa' };
 
 const __dirname = path.dirname(url.fileURLToPath(import.meta.url));

dev-packages/node-integration-tests/suites/anr/basic-multiple.mjs

@@ -1,8 +1,7 @@
+import * as Sentry from '@sentry/node';
 import * as assert from 'assert';
 import * as crypto from 'crypto';
 
-import * as Sentry from '@sentry/node';
-
 global._sentryDebugIds = { [new Error().stack]: 'aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaa' };
 
 setTimeout(() => {

dev-packages/node-integration-tests/suites/anr/basic.mjs

@@ -1,8 +1,7 @@
+import * as Sentry from '@sentry/node';
 import * as assert from 'assert';
 import * as crypto from 'crypto';
 
-import * as Sentry from '@sentry/node';
-
 global._sentryDebugIds = { [new Error().stack]: 'aaaaaaaa-aaaa-4aaa-aaaa-aaaaaaaaaa' };
 
 setTimeout(() => {

dev-packages/node-integration-tests/suites/anr/indefinite.mjs

@@ -1,8 +1,7 @@
+import * as Sentry from '@sentry/node';
 import * as assert from 'assert';
 import * as crypto from 'crypto';
 
-import * as Sentry from '@sentry/node';
-
 setTimeout(() => {
   process.exit();
 }, 10000);

dev-packages/node-integration-tests/suites/anr/isolated.mjs

@@ -1,8 +1,7 @@
+import * as Sentry from '@sentry/node';
 import * as assert from 'assert';
 import * as crypto from 'crypto';
 
-import * as Sentry from '@sentry/node';
-
 setTimeout(() => {
   process.exit();
 }, 10000);

dev-packages/node-integration-tests/suites/breadcrumbs/process-thread/app.mjs

@@ -1,7 +1,7 @@
+import * as Sentry from '@sentry/node';
+import { loggingTransport } from '@sentry-internal/node-integration-tests';
 import { spawn } from 'child_process';
 import { join } from 'path';
-import { loggingTransport } from '@sentry-internal/node-integration-tests';
-import * as Sentry from '@sentry/node';
 import { Worker } from 'worker_threads';
 
 const __dirname = new URL('.', import.meta.url).pathname;
@@ -13,16 +13,18 @@ Sentry.init({
   transport: loggingTransport,
 });
 
-await new Promise(resolve => {
-  const child = spawn('sleep', ['a']);
-  child.on('error', resolve);
-  child.on('exit', resolve);
-});
+(async () => {
+  await new Promise(resolve => {
+    const child = spawn('sleep', ['a']);
+    child.on('error', resolve);
+    child.on('exit', resolve);
+  });
 
-await new Promise(resolve => {
-  const worker = new Worker(join(__dirname, 'worker.mjs'));
-  worker.on('error', resolve);
-  worker.on('exit', resolve);
-});
+  await new Promise(resolve => {
+    const worker = new Worker(join(__dirname, 'worker.mjs'));
+    worker.on('error', resolve);
+    worker.on('exit', resolve);
+  });
 
-throw new Error('This is a test error');
+  throw new Error('This is a test error');
+})();

dev-packages/node-integration-tests/suites/child-process/fork.mjs

@@ -1,7 +1,7 @@
+import * as Sentry from '@sentry/node';
+import { loggingTransport } from '@sentry-internal/node-integration-tests';
 import { fork } from 'child_process';
 import * as path from 'path';
-import { loggingTransport } from '@sentry-internal/node-integration-tests';
-import * as Sentry from '@sentry/node';
 
 const __dirname = new URL('.', import.meta.url).pathname;
 
@@ -12,6 +12,7 @@ Sentry.init({
   transport: loggingTransport,
 });
 
+// eslint-disable-next-line no-unused-vars
 const _child = fork(path.join(__dirname, 'child.mjs'));
 
 setTimeout(() => {

dev-packages/node-integration-tests/suites/child-process/worker.mjs

@@ -1,6 +1,6 @@
-import * as path from 'path';
-import { loggingTransport } from '@sentry-internal/node-integration-tests';
 import * as Sentry from '@sentry/node';
+import { loggingTransport } from '@sentry-internal/node-integration-tests';
+import * as path from 'path';
 import { Worker } from 'worker_threads';
 
 const __dirname = new URL('.', import.meta.url).pathname;
@@ -12,6 +12,7 @@ Sentry.init({
   transport: loggingTransport,
 });
 
+// eslint-disable-next-line no-unused-vars
 const _worker = new Worker(path.join(__dirname, 'child.mjs'));
 
 setTimeout(() => {

dev-packages/node-integration-tests/suites/contextLines/filename-with-spaces/instrument.mjs

@@ -1,5 +1,5 @@
-import { loggingTransport } from '@sentry-internal/node-integration-tests';
 import * as Sentry from '@sentry/node';
+import { loggingTransport } from '@sentry-internal/node-integration-tests';
 
 Sentry.init({
   dsn: 'https://[email protected]/1337',

dev-packages/node-integration-tests/suites/contextLines/filename-with-spaces/test.ts

@@ -8,7 +8,7 @@ describe('ContextLines integration in ESM', () => {
     const instrumentPath = join(__dirname, 'instrument.mjs');
 
     await createRunner(__dirname, 'scenario with space.mjs')
-      .withFlags('--import', instrumentPath)
+      .withInstrument(instrumentPath)
       .expect({
         event: {
           exception: {

dev-packages/node-integration-tests/suites/esm/import-in-the-middle/app.mjs

@@ -1,5 +1,5 @@
-import { loggingTransport } from '@sentry-internal/node-integration-tests';
 import * as Sentry from '@sentry/node';
+import { loggingTransport } from '@sentry-internal/node-integration-tests';
 import * as iitm from 'import-in-the-middle';
 
 new iitm.Hook((_, name) => {
@@ -14,6 +14,8 @@ Sentry.init({
   transport: loggingTransport,
 });
 
-await import('./sub-module.mjs');
-await import('http');
-await import('os');
+(async () => {
+  await import('./sub-module.mjs');
+  await import('http');
+  await import('os');
+})();

dev-packages/node-integration-tests/suites/esm/modules-integration/app.mjs

@@ -1,5 +1,5 @@
-import { loggingTransport } from '@sentry-internal/node-integration-tests';
 import * as Sentry from '@sentry/node';
+import { loggingTransport } from '@sentry-internal/node-integration-tests';
 
 Sentry.init({
   dsn: 'https://[email protected]/1337',

dev-packages/node-integration-tests/suites/esm/warn-esm/server.mjs

@@ -1,15 +1,13 @@
-import { loggingTransport } from '@sentry-internal/node-integration-tests';
 import * as Sentry from '@sentry/node';
+import { loggingTransport, startExpressServerAndSendPortToRunner } from '@sentry-internal/node-integration-tests';
+import express from 'express';
 
 Sentry.init({
   dsn: 'https://[email protected]/1337',
   release: '1.0',
   transport: loggingTransport,
 });
 
-import { startExpressServerAndSendPortToRunner } from '@sentry-internal/node-integration-tests';
-import express from 'express';
-
 const app = express();
 
 app.get('/test/success', (req, res) => {

dev-packages/node-integration-tests/suites/public-api/LocalVariables/deny-inspector.mjs

@@ -1,5 +1,6 @@
 import { register } from 'node:module';
 
+// eslint-disable-next-line no-unused-vars
 const hookScript = Buffer.from(`
 
   `);
@@ -16,6 +17,8 @@ export async function resolve(specifier, context, nextResolve) {
   import.meta.url,
 );
 
-const Sentry = await import('@sentry/node');
+(async () => {
+  const Sentry = await import('@sentry/node');
 
-Sentry.init({});
+  Sentry.init({});
+})();

dev-packages/node-integration-tests/suites/public-api/LocalVariables/local-variables-caught.mjs

@@ -1,6 +1,6 @@
 /* eslint-disable no-unused-vars */
-import { loggingTransport } from '@sentry-internal/node-integration-tests';
 import * as Sentry from '@sentry/node';
+import { loggingTransport } from '@sentry-internal/node-integration-tests';
 
 Sentry.init({
   dsn: 'https://[email protected]/1337',

dev-packages/node-integration-tests/suites/tracing/amqplib/constants.ts

@@ -0,0 +1,75 @@
+import * as Sentry from '@sentry/node';
+import amqp from 'amqplib';
+
+const queueName = 'queue1';
+const amqpUsername = 'sentry';
+const amqpPassword = 'sentry';
+
+const AMQP_URL = `amqp://${amqpUsername}:${amqpPassword}@localhost:5672/`;
+const ACKNOWLEDGEMENT = { noAck: false };
+
+const QUEUE_OPTIONS = {
+  durable: true, // Make the queue durable
+  exclusive: false, // Not exclusive
+  autoDelete: false, // Don't auto-delete the queue
+  arguments: {
+    'x-message-ttl': 30000, // Message TTL of 30 seconds
+    'x-max-length': 1000, // Maximum queue length of 1000 messages
+  },
+};
+
+(async () => {
+  const { connection, channel } = await connectToRabbitMQ();
+  await createQueue(queueName, channel);
+
+  const consumeMessagePromise = consumeMessageFromQueue(queueName, channel);
+
+  await Sentry.startSpan({ name: 'root span' }, async () => {
+    sendMessageToQueue(queueName, channel, JSON.stringify({ foo: 'bar01' }));
+  });
+
+  await consumeMessagePromise;
+
+  await channel.close();
+  await connection.close();
+
+  // Stop the process from exiting before the transaction is sent
+  setInterval(() => {}, 1000);
+})();
+
+async function connectToRabbitMQ() {
+  const connection = await amqp.connect(AMQP_URL);
+  const channel = await connection.createChannel();
+  return { connection, channel };
+}
+
+async function createQueue(queueName, channel) {
+  await channel.assertQueue(queueName, QUEUE_OPTIONS);
+}
+
+function sendMessageToQueue(queueName, channel, message) {
+  channel.sendToQueue(queueName, Buffer.from(message));
+}
+
+async function consumer(queueName, channel) {
+  return new Promise((resolve, reject) => {
+    channel
+      .consume(
+        queueName,
+        message => {
+          if (message) {
+            channel.ack(message);
+            resolve();
+          } else {
+            reject(new Error('No message received'));
+          }
+        },
+        ACKNOWLEDGEMENT,
+      )
+      .catch(reject);
+  });
+}
+
+async function consumeMessageFromQueue(queueName, channel) {
+  await consumer(queueName, channel);
+}