fixup! feat(http): portable node:http client instrumentation (#20393)

Author: isaacs

packages/core/src/index.ts

@@ -147,7 +147,11 @@ export { growthbookIntegration } from './integrations/featureFlags';
 export { conversationIdIntegration } from './integrations/conversationId';
 export { patchHttpModuleClient, patchHttpsModuleClient } from './integrations/http/client-patch';
 export { getHttpClientSubscriptions } from './integrations/http/client-subscriptions';
-export { HTTP_ON_CLIENT_REQUEST, HTTP_ON_SERVER_REQUEST } from './integrations/http/constants';
+export {
+  HTTP_ON_CLIENT_REQUEST,
+  HTTP_ON_CLIENT_REQUEST_FALLBACK,
+  HTTP_ON_SERVER_REQUEST,
+} from './integrations/http/constants';
 export type {
   HttpInstrumentationOptions,
   HttpClientRequest,

packages/core/src/integrations/http/client-subscriptions.ts

@@ -41,17 +41,17 @@ export type HttpClientSubscriptions = Record<ClientSubscriptionName, ChannelList
 
 export function getHttpClientSubscriptions(options: HttpInstrumentationOptions): HttpClientSubscriptions {
   const propagationDecisionMap = new LRUMap<string, boolean>(100);
-  const client = getClient();
-  const clientOptions = client?.getOptions();
-
-  const {
-    errorMonitor = 'error',
-    spans: createSpans = clientOptions ? hasSpansEnabled(clientOptions) : true,
-    propagateTrace = false,
-    breadcrumbs = true,
-  } = options;
+  const getConfig = () => getClient()?.getOptions();
 
   const onHttpClientRequestCreated: ChannelListener = (data: unknown): void => {
+    const clientOptions = getConfig();
+    const {
+      errorMonitor = 'error',
+      spans: createSpans = clientOptions ? hasSpansEnabled(clientOptions) : true,
+      propagateTrace = false,
+      breadcrumbs = true,
+    } = options;
+
     const { request } = data as { request: HttpClientRequest };
 
     // Skip if tracing is suppressed (e.g., inside Sentry.suppressTracing())

packages/core/src/integrations/http/constants.ts

@@ -1,5 +1,7 @@
 export const LOG_PREFIX = '@sentry/instrumentation-http';
 export const HTTP_ON_CLIENT_REQUEST = 'http.client.request.created';
+/** Used by node-light SDK to instrument on older node versions */
+export const HTTP_ON_CLIENT_REQUEST_FALLBACK = 'http.client.request.start';
 export const HTTP_ON_SERVER_REQUEST = 'http.server.request.start';
 export type ClientSubscriptionName = typeof HTTP_ON_CLIENT_REQUEST;
 export type ServerSubscriptionName = typeof HTTP_ON_SERVER_REQUEST;

packages/node-core/src/light/integrations/httpIntegration.ts

@@ -9,6 +9,7 @@ import {
   getHttpClientSubscriptions,
   getIsolationScope,
   HTTP_ON_CLIENT_REQUEST,
+  HTTP_ON_CLIENT_REQUEST_FALLBACK,
   httpRequestToRequestData,
   stripUrlQueryAndFragment,
   withIsolationScope,
@@ -19,9 +20,15 @@ import { patchRequestToCaptureBody } from '../../utils/captureRequestBody';
 import { getRequestOptions } from '../../utils/outgoingHttpRequest';
 import type { LightNodeClient } from '../client';
 import { errorMonitor } from 'node:events';
+import { NODE_VERSION } from '../../nodeVersion';
 
 const INTEGRATION_NAME = 'Http';
 
+const FULLY_SUPPORTS_HTTP_DIAGNOSTICS_CHANNEL =
+  (NODE_VERSION.major === 22 && NODE_VERSION.minor >= 12) ||
+  (NODE_VERSION.major === 23 && NODE_VERSION.minor >= 2) ||
+  NODE_VERSION.major >= 24;
+
 // We keep track of emit functions we wrapped, to avoid double wrapping
 const wrappedEmitFns = new WeakSet<typeof Server.prototype.emit>();
 
@@ -99,6 +106,10 @@ const _httpIntegration = ((options: HttpIntegrationOptions = {}) => {
 
       const { ignoreOutgoingRequests } = _options;
 
+      const channel = FULLY_SUPPORTS_HTTP_DIAGNOSTICS_CHANNEL
+        ? HTTP_ON_CLIENT_REQUEST
+        : HTTP_ON_CLIENT_REQUEST_FALLBACK;
+
       const { [HTTP_ON_CLIENT_REQUEST]: onHttpClientRequestCreated } = getHttpClientSubscriptions({
         breadcrumbs: _options.breadcrumbs,
         propagateTrace: _options.tracePropagation,
@@ -111,7 +122,9 @@ const _httpIntegration = ((options: HttpIntegrationOptions = {}) => {
       });
 
       subscribe('http.server.request.start', onHttpServerRequestStart);
-      subscribe(HTTP_ON_CLIENT_REQUEST, onHttpClientRequestCreated);
+      // Subscribe on the request creation in node versions that support it,
+      // or to the request start (ie, .end() being called) on older versions.
+      subscribe(channel, onHttpClientRequestCreated);
     },
   };
 }) satisfies IntegrationFn;