WIP

Author: mydea

dev-packages/node-integration-tests/suites/express/with-http/test.ts

@@ -1,7 +1,7 @@
-import { afterAll, describe, test } from 'vitest';
+import { afterAll, describe } from 'vitest';
 import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';
 
-describe('express with http import xxx', () => {
+describe('express with http import', () => {
   afterAll(() => {
     cleanupChildProcesses();
   });
@@ -10,7 +10,7 @@ describe('express with http import xxx', () => {
     __dirname,
     'scenario.mjs',
     'instrument.mjs',
-    createRunner => {
+    (createRunner, test) => {
       test('it works when importing the http module', async () => {
         const runner = createRunner()
           .expect({

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

@@ -1,5 +1,5 @@
 import type { TransactionEvent } from '@sentry/core';
-import { afterAll, describe, expect, test } from 'vitest';
+import { afterAll, describe, expect } from 'vitest';
 import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';
 
 const EXPECTED_MESSAGE_SPAN_PRODUCER = expect.objectContaining({
@@ -29,7 +29,7 @@ describe('amqplib auto-instrumentation', () => {
     cleanupChildProcesses();
   });
 
-  createEsmAndCjsTests(__dirname, 'scenario.mjs', 'instrument.mjs', createTestRunner => {
+  createEsmAndCjsTests(__dirname, 'scenario.mjs', 'instrument.mjs', (createTestRunner, test) => {
     test('should be able to send and receive messages', async () => {
       await createTestRunner()
         .withDockerCompose({

dev-packages/node-integration-tests/suites/tracing/connect/test.ts

@@ -1,4 +1,4 @@
-import { afterAll, describe, expect, test } from 'vitest';
+import { afterAll, describe, expect } from 'vitest';
 import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';
 
 describe('connect auto-instrumentation', () => {
@@ -40,7 +40,7 @@ describe('connect auto-instrumentation', () => {
     __dirname,
     'scenario.mjs',
     'instrument.mjs',
-    createTestRunner => {
+    (createTestRunner, test) => {
       test('should auto-instrument `connect` package.', async () => {
         const runner = createTestRunner().expect({ transaction: EXPECTED_TRANSACTION }).start();
         runner.makeRequest('get', '/');

dev-packages/node-integration-tests/suites/tracing/dataloader/test.ts

@@ -1,4 +1,4 @@
-import { afterAll, describe, expect, test } from 'vitest';
+import { afterAll, describe, expect } from 'vitest';
 import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';
 
 describe('dataloader auto-instrumentation', () => {
@@ -36,7 +36,7 @@ describe('dataloader auto-instrumentation', () => {
     __dirname,
     'scenario.mjs',
     'instrument.mjs',
-    createRunner => {
+    (createRunner, test) => {
       test('should auto-instrument `dataloader` package.', async () => {
         const runner = createRunner().expect({ transaction: EXPECTED_TRANSACTION }).start();
         runner.makeRequest('get', '/');

dev-packages/node-integration-tests/suites/tracing/hapi/test.ts

@@ -1,4 +1,4 @@
-import { afterAll, describe, expect, test } from 'vitest';
+import { afterAll, describe, expect } from 'vitest';
 import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../utils/runner';
 
 describe('hapi auto-instrumentation', () => {
@@ -36,7 +36,7 @@ describe('hapi auto-instrumentation', () => {
     },
   };
 
-  createEsmAndCjsTests(__dirname, 'scenario.mjs', 'instrument.mjs', createRunner => {
+  createEsmAndCjsTests(__dirname, 'scenario.mjs', 'instrument.mjs', (createRunner, test) => {
     test('should auto-instrument `@hapi/hapi` package.', async () => {
       const runner = createRunner().expect({ transaction: EXPECTED_TRANSACTION }).start();
       runner.makeRequest('get', '/');

dev-packages/node-integration-tests/utils/runner.ts

@@ -16,7 +16,7 @@ import axios from 'axios';
 import { execSync, spawn, spawnSync } from 'child_process';
 import { existsSync, readFileSync, unlinkSync, writeFileSync } from 'fs';
 import { join } from 'path';
-import { afterAll, describe } from 'vitest';
+import { afterAll, describe, test } from 'vitest';
 import {
   assertEnvelopeHeader,
   assertSentryCheckIn,
@@ -169,7 +169,11 @@ export function createEsmAndCjsTests(
   cwd: string,
   scenarioPath: string,
   instrumentPath: string,
-  callback: (createTestRunner: () => ReturnType<typeof createRunner>, mode: 'esm' | 'cjs') => void,
+  callback: (
+    createTestRunner: () => ReturnType<typeof createRunner>,
+    testFn: typeof test | typeof test.fails,
+    mode: 'esm' | 'cjs',
+  ) => void,
   options?: { skipCjs?: boolean; skipEsm?: boolean },
 ): void {
   const mjsScenarioPath = join(cwd, scenarioPath);
@@ -206,16 +210,14 @@ export function createEsmAndCjsTests(
       }
     });
 
-    const scenarios: [mode: 'esm' | 'cjs', getRunner: () => ReturnType<typeof createRunner>][] = [];
-    if (!options?.skipEsm) {
-      scenarios.push(['esm', () => createRunner(mjsScenarioPath).withFlags('--import', mjsInstrumentPath)]);
-    }
-    if (!options?.skipCjs) {
-      scenarios.push(['cjs', () => createRunner(cjsScenarioPath).withFlags('--require', cjsInstrumentPath)]);
-    }
+    describe('esm', () => {
+      const testFn = options?.skipEsm ? test.fails : test;
+      callback(() => createRunner(mjsScenarioPath).withFlags('--import', mjsInstrumentPath), testFn, 'esm');
+    });
 
-    describe.each(scenarios)('%s', (mode, getRunner) => {
-      callback(getRunner, mode);
+    describe('cjs', () => {
+      const testFn = options?.skipCjs ? test.fails : test;
+      callback(() => createRunner(cjsScenarioPath).withFlags('--require', cjsInstrumentPath), testFn, 'cjs');
     });
   });
 }
@@ -245,7 +247,6 @@ export function createRunner(...paths: string[]) {
   let dockerOptions: DockerOptions | undefined;
   let ensureNoErrorOutput = false;
   const logs: string[] = [];
-  const cleanups: VoidFunction[] = [];
 
   if (testPath.endsWith('.ts')) {
     flags.push('-r', 'ts-node/register');
@@ -282,10 +283,6 @@ export function createRunner(...paths: string[]) {
       flags.push('--import', instrumentPath);
       return this;
     },
-    withCleanup: function (cleanup: VoidFunction) {
-      cleanups.push(cleanup);
-      return this;
-    },
     withMockSentryServer: function () {
       withSentryServer = true;
       return this;
@@ -308,13 +305,10 @@ export function createRunner(...paths: string[]) {
       ensureNoErrorOutput = true;
       return this;
     },
-    start: function (done?: (e?: unknown) => void): StartResult {
-      let resolve: (value: void) => void;
-      let reject: (reason?: unknown) => void;
-      const completePromise = new Promise<void>((res, rej) => {
-        resolve = res;
-        reject = rej;
-      });
+    start: function (): StartResult {
+      let isComplete = false;
+      let completeError: Error | undefined;
+
       const expectedEnvelopeCount = Math.max(expectedEnvelopes.length, (expectedEnvelopeHeaders || []).length);
 
       let envelopeCount = 0;
@@ -323,15 +317,13 @@ export function createRunner(...paths: string[]) {
       let child: ReturnType<typeof spawn> | undefined;
 
       function complete(error?: Error): void {
-        cleanups.forEach(cleanup => cleanup());
+        if (isComplete) {
+          return;
+        }
 
+        isComplete = true;
+        completeError = error || undefined;
         child?.kill();
-        done?.(normalize(error));
-        if (error) {
-          reject(error);
-        } else {
-          resolve();
-        }
       }
 
       /** Called after each expect callback to check if we're complete */
@@ -526,8 +518,12 @@ export function createRunner(...paths: string[]) {
         .catch(e => complete(e));
 
       return {
-        completed: function (): Promise<void> {
-          return completePromise;
+        completed: async function (): Promise<void> {
+          await waitFor(() => isComplete);
+
+          if (completeError) {
+            throw completeError;
+          }
         },
         childHasExited: function (): boolean {
           return hasExited;