fix(bun): Keep diagnostics channel subscriptions alive (#24632)

Bun garbage-collects a diagnostics channel that no code references, and
its subscribers with it. Node and Deno keep subscribed channels alive.
The channel integrations kept no reference, so on Bun they could
silently stop producing spans after the first GC. They now create their
channels through wrappers in `@sentry/server-utils` that keep one.

`@sentry/bun` uses these integrations, and also `httpIntegration` from
`@sentry/node`, whose channel subscriptions now go through the same
wrappers. `diagnosticsChannelGc.test.ts` reproduces the GC on Bun.

Running the shared Node integration suites on Bun found this. Also an
oxlint rule has been added to prevent any issues in the future regarding
this

Part of #23889.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>

Author: JPeer264

dev-packages/bun-integration-tests/node-suites/excludes.ts

@@ -149,11 +149,6 @@ const NOT_TRIAGED = [
   'suites/tracing/tracer-start-active-span-error/test.ts',
 ];
 
-// Bun garbage-collects a diagnostics channel that no code references, and its subscribers with it.
-// `graphql` 17 publishes its own tracing channels, so the integration only subscribes to them, and
-// no spans arrive. See https://github.com/oven-sh/bun/issues/43086
-const CHANNEL_GARBAGE_COLLECTED = ['suites/tracing/graphql-tracing-channel/**'];
-
 // The scenario configures `nativeNodeFetchIntegration`, which `@sentry/bun` does not export.
 const NO_NATIVE_NODE_FETCH_INTEGRATION = [
   'suites/tracing/http-client-spans/fetch-forward-request-hook/test.ts',
@@ -209,7 +204,6 @@ export const NODE_SUITES_EXCLUDE = [
   ...NO_OUTGOING_HTTP_INSTRUMENTATION,
   ...NO_AUTO_INSTRUMENTATION,
   ...NOT_TRIAGED,
-  ...CHANNEL_GARBAGE_COLLECTED,
 ];
 
 // Excluded only in the `node-suites` project, which runs the suites with `@sentry/node`.

packages/bun/.oxlintrc.json

@@ -14,7 +14,24 @@
     {
       "files": ["**/src/**"],
       "rules": {
-        "sdk/no-class-field-initializers": "off"
+        "sdk/no-class-field-initializers": "off",
+        "no-restricted-imports": [
+          "error",
+          {
+            "paths": [
+              {
+                "name": "node:diagnostics_channel",
+                "allowTypeImports": true,
+                "message": "Bun garbage-collects a channel that no code references, together with its subscribers. Use `subscribeDiagnosticsChannel` or `diagnosticsTracingChannel` from `@sentry/server-utils` instead. See https://github.com/oven-sh/bun/issues/43086"
+              },
+              {
+                "name": "diagnostics_channel",
+                "allowTypeImports": true,
+                "message": "Bun garbage-collects a channel that no code references, together with its subscribers. Use `subscribeDiagnosticsChannel` or `diagnosticsTracingChannel` from `@sentry/server-utils` instead. See https://github.com/oven-sh/bun/issues/43086"
+              }
+            ]
+          }
+        ]
       }
     }
   ]

packages/bun/test/integrations/diagnosticsChannelGc.test.ts

@@ -0,0 +1,26 @@
+import { channel } from 'node:diagnostics_channel';
+import { describe, expect, test } from 'bun:test';
+import { init } from '../../src';
+
+const EXPRESS_HANDLE_START = 'tracing:orchestrion:express:handle:start';
+
+function nextTask(): Promise<void> {
+  return new Promise(resolve => setTimeout(resolve, 0));
+}
+
+describe('channel-based integrations', () => {
+  // Bun garbage-collects a diagnostics channel that no code references, together with its
+  // subscribers. A GC in the same task does not collect it, so the check runs in a later task.
+  // See https://github.com/oven-sh/bun/issues/43086
+  test('stay subscribed after a garbage collection', async () => {
+    init({ dsn: 'https://username@domain/123', tracesSampleRate: 1 });
+    await nextTask();
+
+    expect(channel(EXPRESS_HANDLE_START).hasSubscribers).toBe(true);
+
+    Bun.gc(true);
+    await nextTask();
+
+    expect(channel(EXPRESS_HANDLE_START).hasSubscribers).toBe(true);
+  });
+});

packages/node/.oxlintrc.json

@@ -17,7 +17,24 @@
     {
       "files": ["**/src/**"],
       "rules": {
-        "sdk/no-class-field-initializers": "off"
+        "sdk/no-class-field-initializers": "off",
+        "no-restricted-imports": [
+          "error",
+          {
+            "paths": [
+              {
+                "name": "node:diagnostics_channel",
+                "allowTypeImports": true,
+                "message": "Bun garbage-collects a channel that no code references, together with its subscribers. Use `subscribeDiagnosticsChannel` or `diagnosticsTracingChannel` from `@sentry/server-utils` instead. See https://github.com/oven-sh/bun/issues/43086"
+              },
+              {
+                "name": "diagnostics_channel",
+                "allowTypeImports": true,
+                "message": "Bun garbage-collects a channel that no code references, together with its subscribers. Use `subscribeDiagnosticsChannel` or `diagnosticsTracingChannel` from `@sentry/server-utils` instead. See https://github.com/oven-sh/bun/issues/43086"
+              }
+            ]
+          }
+        ]
       }
     },
     {

packages/node/src/integrations/childProcess.ts

@@ -1,6 +1,6 @@
 import type { ChildProcess } from 'node:child_process';
-import * as diagnosticsChannel from 'node:diagnostics_channel';
 import { addBreadcrumb, defineIntegration, isObjectLike } from '@sentry/core';
+import { subscribeDiagnosticsChannel } from '@sentry/server-utils';
 
 interface Options {
   /**
@@ -21,7 +21,7 @@ export const childProcessIntegration = defineIntegration((options: Options = {})
   return {
     name: INTEGRATION_NAME,
     setup() {
-      diagnosticsChannel.channel('child_process').subscribe((event: unknown) => {
+      subscribeDiagnosticsChannel('child_process', (event: unknown) => {
         if (isObjectLike(event) && 'process' in event) {
           captureChildProcessEvents(event.process as ChildProcess, options);
         }

packages/node/src/integrations/http/SentryHttpInstrumentation.ts

@@ -1,4 +1,3 @@
-import { subscribe } from 'node:diagnostics_channel';
 import { context, trace } from '@opentelemetry/api';
 import type { ClientRequest, IncomingMessage } from 'node:http';
 import type { Span } from '@sentry/core';
@@ -10,6 +9,7 @@ import {
   HTTP_ON_CLIENT_REQUEST,
   patchHttpModuleClient,
 } from '@sentry/core/server';
+import { subscribeDiagnosticsChannel } from '@sentry/server-utils';
 import { NODE_VERSION } from '../../nodeVersion';
 import { errorMonitor } from 'node:events';
 import * as http from 'node:http';
@@ -125,7 +125,7 @@ export function instrumentHttpOutgoingRequests(
 
 function instrumentHttpOutgoingRequestsViaChannel(options: HttpInstrumentationOptions): void {
   const { [HTTP_ON_CLIENT_REQUEST]: onHttpClientRequestCreated } = getHttpClientSubscriptions(options);
-  subscribe(HTTP_ON_CLIENT_REQUEST, onHttpClientRequestCreated);
+  subscribeDiagnosticsChannel(HTTP_ON_CLIENT_REQUEST, onHttpClientRequestCreated);
 }
 
 /**

packages/node/src/integrations/http/httpServerIntegration.ts

@@ -1,10 +1,10 @@
-import { subscribe } from 'node:diagnostics_channel';
 import type { RequestOptions } from 'node:http';
 import { context, createContextKey, propagation } from '@opentelemetry/api';
 import type { Integration, IntegrationFn } from '@sentry/core';
 import { addNonEnumerableProperty, debug, getClient } from '@sentry/core';
 import type { HttpIncomingMessage, HttpServerResponse } from '@sentry/core/server';
 import { getHttpServerSubscriptions, HTTP_ON_SERVER_REQUEST, recordRequestSession } from '@sentry/core/server';
+import { subscribeDiagnosticsChannel } from '@sentry/server-utils';
 import type { RequestEventData } from '@sentry/core';
 import { DEBUG_BUILD } from '../../debug-build';
 
@@ -143,7 +143,7 @@ const _httpServerIntegration = ((options: HttpServerIntegrationOptions = {}) =>
     name: INTEGRATION_NAME,
     setupOnce() {
       const { [HTTP_ON_SERVER_REQUEST]: onHttpServerRequestStart } = getHttpServerSubscriptions(_options);
-      subscribe(HTTP_ON_SERVER_REQUEST, onHttpServerRequestStart);
+      subscribeDiagnosticsChannel(HTTP_ON_SERVER_REQUEST, onHttpServerRequestStart);
     },
     afterAllSetup(client) {
       if (DEBUG_BUILD && client.getIntegrationByName('Http')) {

packages/node/src/integrations/node-fetch/undici-instrumentation.ts

@@ -16,7 +16,6 @@
 
 /* eslint-disable max-lines */
 
-import * as diagch from 'diagnostics_channel';
 import { URL } from 'url';
 
 import type { Span, SpanAttributes } from '@sentry/core';
@@ -42,6 +41,7 @@ import {
   filterCollectedUrlQuery,
   httpHeadersToSpanAttributes,
 } from '@sentry/core';
+import { subscribeDiagnosticsChannel } from '@sentry/server-utils';
 import { addFetchRequestBreadcrumb, addTracePropagationHeadersToFetchRequest } from '../../utils/outgoingFetchRequest';
 import {
   HTTP_REQUEST_METHOD,
@@ -118,7 +118,7 @@ function subscribeToChannel(
   diagnosticChannel: string,
   onMessage: (message: unknown, name: string | symbol) => void,
 ): void {
-  diagch.subscribe?.(diagnosticChannel, onMessage);
+  subscribeDiagnosticsChannel(diagnosticChannel, onMessage);
 }
 
 function parseRequestHeaders(request: UndiciRequest): Map<string, string | string[]> {

packages/node/src/integrations/pino.ts

@@ -1,4 +1,3 @@
-import * as diagnosticsChannel from 'node:diagnostics_channel';
 import type { IntegrationFn, LogSeverityLevel } from '@sentry/core';
 import {
   _INTERNAL_captureLog,
@@ -10,6 +9,7 @@ import {
   severityLevelFromString,
   withScope,
 } from '@sentry/core';
+import { diagnosticsTracingChannel } from '@sentry/server-utils';
 
 const SENTRY_TRACK_SYMBOL = Symbol('sentry-track-pino-logger');
 
@@ -125,7 +125,7 @@ const _pinoIntegration = defineIntegration((userOptions: DeepPartial<PinoOptions
   return {
     name: 'Pino',
     setup: () => {
-      const integratedChannel = diagnosticsChannel.tracingChannel('pino_asJson');
+      const integratedChannel = diagnosticsTracingChannel('pino_asJson');
 
       function onPinoStart(self: Pino, args: PinoHookArgs, result: PinoResult): void {
         if (!shouldTrackLogger(self)) {

packages/node/src/integrations/workerThreads.ts

@@ -1,6 +1,6 @@
 import type { Worker } from 'node:worker_threads';
-import * as diagnosticsChannel from 'node:diagnostics_channel';
 import { captureException, defineIntegration, isObjectLike } from '@sentry/core';
+import { subscribeDiagnosticsChannel } from '@sentry/server-utils';
 
 const INTEGRATION_NAME = 'WorkerThreads' as const;
 
@@ -12,7 +12,7 @@ export const workerThreadsIntegration = defineIntegration(() => {
   return {
     name: INTEGRATION_NAME,
     setup() {
-      diagnosticsChannel.channel('worker_threads').subscribe((event: unknown) => {
+      subscribeDiagnosticsChannel('worker_threads', (event: unknown) => {
         if (isObjectLike(event) && 'worker' in event) {
           captureWorkerThreadEvents(event.worker as Worker);
         }