Add signal handling to test runners and utilities

This change integrates `signal` handling for all test runners, utilities, and server setups, allowing better management of abortable operations. It improves reliability and ensures proper cleanup during execution interruptions.

Author: cod1k

dev-packages/cloudflare-integration-tests/runner.ts

@@ -54,7 +54,7 @@ type StartResult = {
 
 /** Creates a test runner */
 // eslint-disable-next-line @typescript-eslint/explicit-function-return-type
-export function createRunner(...paths: string[]) {
+export function createRunner({ signal }: { readonly signal?: AbortSignal }, ...paths: string[]) {
   const testPath = join(...paths);
 
   if (!existsSync(testPath)) {
@@ -130,7 +130,7 @@ export function createRunner(...paths: string[]) {
         }
       }
 
-      createBasicSentryServer(newEnvelope)
+      createBasicSentryServer(newEnvelope, { signal })
         .then(([mockServerPort, mockServerClose]) => {
           if (mockServerClose) {
             CLEANUP_STEPS.add(() => {
@@ -155,7 +155,7 @@ export function createRunner(...paths: string[]) {
               '--var',
               `SENTRY_DSN:http://public@localhost:${mockServerPort}/1337`,
             ],
-            { stdio },
+            { stdio, signal },
           );
 
           CLEANUP_STEPS.add(() => {

dev-packages/cloudflare-integration-tests/suites/basic/test.ts

@@ -2,8 +2,8 @@ import { expect, it } from 'vitest';
 import { eventEnvelope } from '../../expect';
 import { createRunner } from '../../runner';
 
-it('Basic error in fetch handler', async () => {
-  const runner = createRunner(__dirname)
+it('Basic error in fetch handler', async ({ signal }) => {
+  const runner = createRunner({ signal }, __dirname)
     .expect(
       eventEnvelope({
         level: 'error',

dev-packages/cloudflare-integration-tests/suites/tracing/anthropic-ai/test.ts

@@ -6,8 +6,8 @@ import { createRunner } from '../../../runner';
 // want to test that the instrumentation does not break in our
 // cloudflare SDK.
 
-it('traces a basic message creation request', async () => {
-  const runner = createRunner(__dirname)
+it('traces a basic message creation request', async ({ signal }) => {
+  const runner = createRunner({ signal }, __dirname)
     .ignore('event')
     .expect(envelope => {
       const transactionEvent = envelope[1]?.[0]?.[1] as any;

dev-packages/cloudflare-integration-tests/suites/tracing/durableobject/test.ts

@@ -1,8 +1,8 @@
 import { expect, it } from 'vitest';
 import { createRunner } from '../../../runner';
 
-it('traces a durable object method', async () => {
-  const runner = createRunner(__dirname)
+it('traces a durable object method', async ({ signal }) => {
+  const runner = createRunner({ signal }, __dirname)
     .expect(envelope => {
       const transactionEvent = envelope[1]?.[0]?.[1];
       expect(transactionEvent).toEqual(

dev-packages/cloudflare-integration-tests/suites/tracing/google-genai/test.ts

@@ -6,8 +6,8 @@ import { createRunner } from '../../../runner';
 // want to test that the instrumentation does not break in our
 // cloudflare SDK.
 
-it('traces Google GenAI chat creation and message sending', async () => {
-  const runner = createRunner(__dirname)
+it('traces Google GenAI chat creation and message sending', async ({ signal }) => {
+  const runner = createRunner({ signal }, __dirname)
     .ignore('event')
     .expect(envelope => {
       const transactionEvent = envelope[1]?.[0]?.[1] as any;

dev-packages/cloudflare-integration-tests/suites/tracing/openai/test.ts

@@ -6,11 +6,11 @@ import { createRunner } from '../../../runner';
 // want to test that the instrumentation does not break in our
 // cloudflare SDK.
 
-it('traces a basic chat completion request', async () => {
-  const runner = createRunner(__dirname)
+it('traces a basic chat completion request', async ({ signal }) => {
+  const runner = createRunner({ signal }, __dirname)
     .ignore('event')
     .expect(envelope => {
-      const transactionEvent = envelope[1]?.[0]?.[1];
+      const transactionEvent = envelope[1]?.[0]?.[1] as any;
 
       expect(transactionEvent.transaction).toBe('GET /');
       expect(transactionEvent.spans).toEqual(

dev-packages/e2e-tests/registrySetup.ts

@@ -17,11 +17,15 @@ function groupCIOutput(groupTitle: string, fn: () => void): void {
   }
 }
 
-export function registrySetup(): void {
+export function registrySetup(signal?: AbortSignal): void {
   groupCIOutput('Test Registry Setup', () => {
     // Stop test registry container (Verdaccio) if it was already running
-    childProcess.spawnSync('docker', ['stop', TEST_REGISTRY_CONTAINER_NAME], { stdio: 'ignore' });
-    console.log('Stopped previously running test registry');
+    const stop = (): void => {
+      childProcess.spawnSync('docker', ['stop', TEST_REGISTRY_CONTAINER_NAME], { stdio: 'ignore' });
+      console.log('Stopped previously running test registry');
+    };
+    stop();
+    signal?.addEventListener('abort', () => stop());
 
     // Start test registry (Verdaccio)
     const startRegistryProcessResult = childProcess.spawnSync(
@@ -38,7 +42,7 @@ export function registrySetup(): void {
         `${__dirname}/verdaccio-config:/verdaccio/conf`,
         `verdaccio/verdaccio:${VERDACCIO_VERSION}`,
       ],
-      { encoding: 'utf8', stdio: 'inherit' },
+      { encoding: 'utf8', stdio: 'inherit', signal },
     );
 
     if (startRegistryProcessResult.status !== 0) {
@@ -60,6 +64,7 @@ export function registrySetup(): void {
       {
         encoding: 'utf8',
         stdio: 'inherit',
+        signal,
       },
     );
 
@@ -82,6 +87,7 @@ export function registrySetup(): void {
       {
         encoding: 'utf8',
         stdio: 'inherit',
+        signal,
       },
     );
 

dev-packages/e2e-tests/run.ts

@@ -12,7 +12,10 @@ const DEFAULT_DSN = 'https://username@domain/123';
 const DEFAULT_SENTRY_ORG_SLUG = 'sentry-javascript-sdks';
 const DEFAULT_SENTRY_PROJECT = 'sentry-javascript-e2e-tests';
 
-function asyncExec(command: string, options: { env: Record<string, string | undefined>; cwd: string }): Promise<void> {
+function asyncExec(
+  command: string,
+  options: { env: Record<string, string | undefined>; cwd: string; signal: AbortSignal },
+): Promise<void> {
   return new Promise((resolve, reject) => {
     const process = spawn(command, { ...options, shell: true });
 
@@ -41,6 +44,8 @@ async function run(): Promise<void> {
   // Load environment variables from .env file locally
   dotenv.config();
 
+  const abortController = new AbortController();
+
   // Allow to run a single app only via `yarn test:run <app-name>`
   const appName = process.argv[2] || '';
 
@@ -65,11 +70,11 @@ async function run(): Promise<void> {
     console.log('');
 
     if (!process.env.SKIP_REGISTRY) {
-      registrySetup();
+      registrySetup(abortController.signal);
     }
 
-    await asyncExec('pnpm clean:test-applications', { env, cwd: __dirname });
-    await asyncExec('pnpm cache delete "@sentry/*"', { env, cwd: __dirname });
+    await asyncExec('pnpm clean:test-applications', { env, cwd: __dirname, signal: abortController.signal });
+    await asyncExec('pnpm cache delete "@sentry/*"', { env, cwd: __dirname, signal: abortController.signal });
 
     const testAppPaths = appName ? [appName.trim()] : globSync('*', { cwd: `${__dirname}/test-applications/` });
 
@@ -84,15 +89,17 @@ async function run(): Promise<void> {
       const cwd = tmpDirPath;
 
       console.log(`Building ${testAppPath} in ${tmpDirPath}...`);
-      await asyncExec('volta run pnpm test:build', { env, cwd });
+      await asyncExec('volta run pnpm test:build', { env, cwd, signal: abortController.signal });
 
       console.log(`Testing ${testAppPath}...`);
-      await asyncExec('volta run pnpm test:assert', { env, cwd });
+      await asyncExec('volta run pnpm test:assert', { env, cwd, signal: abortController.signal });
 
       // clean up (although this is tmp, still nice to do)
       await rm(tmpDirPath, { recursive: true });
     }
+    abortController.abort();
   } catch (error) {
+    abortController.abort(error);
     console.error(error);
     process.exit(1);
   }

dev-packages/e2e-tests/test-applications/aws-serverless/src/stack.ts

@@ -1,10 +1,9 @@
-import { Stack, CfnResource, StackProps } from 'aws-cdk-lib';
+import { CfnResource, Stack, StackProps } from 'aws-cdk-lib';
 import { Construct } from 'constructs';
 import * as path from 'node:path';
 import * as fs from 'node:fs';
 import * as os from 'node:os';
 import * as dns from 'node:dns/promises';
-import { platform } from 'node:process';
 import { globSync } from 'glob';
 import { execFileSync } from 'node:child_process';
 
@@ -123,10 +122,5 @@ export async function getHostIp() {
     return host.address;
   }
 
-  if (platform === 'darwin' || platform === 'win32') {
-    return 'host.docker.internal';
-  }
-
-  const host = await dns.lookup(os.hostname());
-  return host.address;
+  return 'host.docker.internal';
 }

dev-packages/node-core-integration-tests/suites/tracing/dsc-txn-name-update/test.ts

@@ -6,12 +6,12 @@ import { createTestServer } from '../../../utils/server';
 // This test requires Node.js 22+ because it depends on the 'http.client.request.created'
 // diagnostic channel for baggage header propagation, which only exists since Node 22.12.0+ and 23.2.0+
 conditionalTest({ min: 22 })('node >=22', () => {
-  test('adds current transaction name to baggage when the txn name is high-quality', async () => {
+  test('adds current transaction name to baggage when the txn name is high-quality', async ({ signal }) => {
     expect.assertions(5);
 
     let traceId: string | undefined;
 
-    const [SERVER_URL, closeTestServer] = await createTestServer()
+    const [SERVER_URL, closeTestServer] = await createTestServer({ signal })
       .get('/api/v0', (headers: Record<string, string | string[] | undefined>) => {
         const baggageItems = getBaggageHeaderItems(headers);
         traceId = baggageItems.find(item => item.startsWith('sentry-trace_id='))?.split('=')[1] as string;
@@ -54,7 +54,7 @@ conditionalTest({ min: 22 })('node >=22', () => {
       })
       .start();
 
-    await createRunner(__dirname, 'scenario-headers.ts')
+    await createRunner({ signal }, __dirname, 'scenario-headers.ts')
       .withEnv({ SERVER_URL })
       .expect({
         transaction: {},
@@ -65,10 +65,10 @@ conditionalTest({ min: 22 })('node >=22', () => {
   });
 });
 
-test('adds current transaction name to trace envelope header when the txn name is high-quality', async () => {
+test('adds current transaction name to trace envelope header when the txn name is high-quality', async ({ signal }) => {
   expect.assertions(4);
 
-  await createRunner(__dirname, 'scenario-events.ts')
+  await createRunner({ signal }, __dirname, 'scenario-events.ts')
     .expectHeader({
       event: {
         trace: {