more breadcrumb tests for worker events

Author: nicohrubec

dev-packages/e2e-tests/test-applications/nestjs-bullmq/src/jobs/test.processor.ts

@@ -17,6 +17,15 @@ export class TestProcessor extends WorkerHost {
       return { processed: true };
     }
 
+    if (job.name === 'lifecycle-failed-breadcrumb-test') {
+      throw new Error('Intentional error to trigger failed event');
+    }
+
+    if (job.name === 'lifecycle-progress-breadcrumb-test') {
+      await job.updateProgress(50);
+      return { processed: true };
+    }
+
     return { processed: true };
   }
 
@@ -29,4 +38,34 @@ export class TestProcessor extends WorkerHost {
       });
     }
   }
+
+  @OnWorkerEvent('active')
+  onActive(job: Job) {
+    if (job.name === 'lifecycle-active-breadcrumb-test') {
+      Sentry.addBreadcrumb({
+        message: 'leaked-breadcrumb-from-active-event',
+        level: 'info',
+      });
+    }
+  }
+
+  @OnWorkerEvent('failed')
+  onFailed(job: Job) {
+    if (job.name === 'lifecycle-failed-breadcrumb-test') {
+      Sentry.addBreadcrumb({
+        message: 'leaked-breadcrumb-from-failed-event',
+        level: 'info',
+      });
+    }
+  }
+
+  @OnWorkerEvent('progress')
+  onProgress(job: Job) {
+    if (job.name === 'lifecycle-progress-breadcrumb-test') {
+      Sentry.addBreadcrumb({
+        message: 'leaked-breadcrumb-from-progress-event',
+        level: 'info',
+      });
+    }
+  }
 }

dev-packages/e2e-tests/test-applications/nestjs-bullmq/tests/bullmq.test.ts

@@ -61,11 +61,10 @@ test('BullMQ processor breadcrumbs do not leak into subsequent HTTP requests', a
   expect(leakedBreadcrumb).toBeUndefined();
 });
 
-// TODO: @OnWorkerEvent handlers run outside the isolation scope created by process().
+// TODO: @OnWorkerEvent('completed') handlers run outside the isolation scope created by process().
 // They are registered via worker.on() (EventEmitter), so breadcrumbs/tags set there
 // leak into the default isolation scope and appear on subsequent HTTP requests.
-// This should be fixed in a follow-up by also wrapping lifecycle event handlers.
-test('BullMQ @OnWorkerEvent lifecycle breadcrumbs currently leak into subsequent HTTP requests', async ({
+test('BullMQ @OnWorkerEvent completed lifecycle breadcrumbs currently leak into subsequent HTTP requests', async ({
   baseURL,
 }) => {
   const processTransactionPromise = waitForTransaction('nestjs-bullmq', transactionEvent => {
@@ -91,3 +90,87 @@ test('BullMQ @OnWorkerEvent lifecycle breadcrumbs currently leak into subsequent
   // This SHOULD be toBeUndefined() once lifecycle event isolation is implemented.
   expect(leakedBreadcrumb).toBeDefined();
 });
+
+// TODO: @OnWorkerEvent('active') handlers run outside the isolation scope created by process().
+// Breadcrumbs set there leak into the default isolation scope and appear on subsequent HTTP requests.
+test('BullMQ @OnWorkerEvent active lifecycle breadcrumbs currently leak into subsequent HTTP requests', async ({
+  baseURL,
+}) => {
+  const processTransactionPromise = waitForTransaction('nestjs-bullmq', transactionEvent => {
+    return transactionEvent.contexts?.trace?.op === 'queue.process';
+  });
+
+  await fetch(`${baseURL}/enqueue/lifecycle-active-breadcrumb-test`);
+
+  await processTransactionPromise;
+
+  const transactionPromise = waitForTransaction('nestjs-bullmq', transactionEvent => {
+    return transactionEvent.transaction === 'GET /check-isolation';
+  });
+
+  await fetch(`${baseURL}/check-isolation`);
+
+  const transaction = await transactionPromise;
+
+  const leakedBreadcrumb = (transaction.breadcrumbs || []).find(
+    (b: any) => b.message === 'leaked-breadcrumb-from-active-event',
+  );
+  // This SHOULD be toBeUndefined() once lifecycle event isolation is implemented.
+  expect(leakedBreadcrumb).toBeDefined();
+});
+
+// TODO: @OnWorkerEvent('failed') handlers run outside the isolation scope created by process().
+// Breadcrumbs set there leak into the default isolation scope and appear on subsequent HTTP requests.
+test('BullMQ @OnWorkerEvent failed lifecycle breadcrumbs currently leak into subsequent HTTP requests', async ({
+  baseURL,
+}) => {
+  const processTransactionPromise = waitForTransaction('nestjs-bullmq', transactionEvent => {
+    return transactionEvent.contexts?.trace?.op === 'queue.process';
+  });
+
+  await fetch(`${baseURL}/enqueue/lifecycle-failed-breadcrumb-test`);
+
+  await processTransactionPromise;
+
+  const transactionPromise = waitForTransaction('nestjs-bullmq', transactionEvent => {
+    return transactionEvent.transaction === 'GET /check-isolation';
+  });
+
+  await fetch(`${baseURL}/check-isolation`);
+
+  const transaction = await transactionPromise;
+
+  const leakedBreadcrumb = (transaction.breadcrumbs || []).find(
+    (b: any) => b.message === 'leaked-breadcrumb-from-failed-event',
+  );
+  // This SHOULD be toBeUndefined() once lifecycle event isolation is implemented.
+  expect(leakedBreadcrumb).toBeDefined();
+});
+
+// The 'progress' event does NOT leak breadcrumbs — unlike 'active', 'completed', and 'failed',
+// BullMQ emits it inside the process() call (via job.updateProgress()), so it runs within
+// the isolation scope already established by the instrumentation.
+test('BullMQ @OnWorkerEvent progress lifecycle breadcrumbs do not leak into subsequent HTTP requests', async ({
+  baseURL,
+}) => {
+  const processTransactionPromise = waitForTransaction('nestjs-bullmq', transactionEvent => {
+    return transactionEvent.contexts?.trace?.op === 'queue.process';
+  });
+
+  await fetch(`${baseURL}/enqueue/lifecycle-progress-breadcrumb-test`);
+
+  await processTransactionPromise;
+
+  const transactionPromise = waitForTransaction('nestjs-bullmq', transactionEvent => {
+    return transactionEvent.transaction === 'GET /check-isolation';
+  });
+
+  await fetch(`${baseURL}/check-isolation`);
+
+  const transaction = await transactionPromise;
+
+  const leakedBreadcrumb = (transaction.breadcrumbs || []).find(
+    (b: any) => b.message === 'leaked-breadcrumb-from-progress-event',
+  );
+  expect(leakedBreadcrumb).toBeUndefined();
+});