fix(node-core): Shut down OTel TraceProvider when calling Sentry.close() (#17499)

Ensure we shut down the SDKs internal OTel TraceProvider (if
internal OTel SDK is intialized), when calling `Sentry.close()` (or
rather `NodeClient::close`).

Author: Lms24

packages/node-core/src/sdk/client.ts

@@ -80,9 +80,7 @@ export class NodeClient extends ServerRuntimeClient<NodeClientOptions> {
   // Eslint ignore explanation: This is already documented in super.
   // eslint-disable-next-line jsdoc/require-jsdoc
   public async flush(timeout?: number): Promise<boolean> {
-    const provider = this.traceProvider;
-
-    await provider?.forceFlush();
+    await this.traceProvider?.forceFlush();
 
     if (this.getOptions().sendClientReports) {
       this._flushOutcomes();
@@ -106,7 +104,11 @@ export class NodeClient extends ServerRuntimeClient<NodeClientOptions> {
       process.off('beforeExit', this._logOnExitFlushListener);
     }
 
-    return super.close(timeout);
+    return super
+      .close(timeout)
+      .then(allEventsSent =>
+        this.traceProvider ? this.traceProvider.shutdown().then(() => allEventsSent) : allEventsSent,
+      );
   }
 
   /**

packages/node-core/test/sdk/client.test.ts

@@ -1,5 +1,6 @@
 import { ProxyTracer } from '@opentelemetry/api';
 import * as opentelemetryInstrumentationPackage from '@opentelemetry/instrumentation';
+import type { BasicTracerProvider } from '@opentelemetry/sdk-trace-base';
 import type { Event, EventHint, Log } from '@sentry/core';
 import { getCurrentScope, getGlobalScope, getIsolationScope, Scope, SDK_VERSION } from '@sentry/core';
 import { setOpenTelemetryContextAsyncContextStrategy } from '@sentry/opentelemetry';
@@ -321,4 +322,65 @@ describe('NodeClient', () => {
       });
     });
   });
+
+  describe('close', () => {
+    beforeEach(() => {
+      vi.clearAllMocks();
+    });
+
+    it('shuts down the OTel trace provider', async () => {
+      const shutdownSpy = vi.fn().mockResolvedValue(true);
+      const forceFlushSpy = vi.fn().mockResolvedValue(undefined);
+
+      const client = new NodeClient(getDefaultNodeClientOptions());
+
+      client.traceProvider = {
+        shutdown: shutdownSpy,
+        forceFlush: forceFlushSpy,
+      } as unknown as BasicTracerProvider;
+
+      const result = await client.close();
+
+      // ensure we return the flush result rather than void from the traceProvider shutdown
+      expect(result).toBe(true);
+
+      expect(shutdownSpy).toHaveBeenCalledTimes(1);
+
+      // close calls flush and flush force-flushes the traceProvider
+      expect(forceFlushSpy).toHaveBeenCalledTimes(1);
+    });
+
+    it('stops client report tracking if it was started', async () => {
+      const processOffSpy = vi.spyOn(process, 'off');
+      const clearIntervalSpy = vi.spyOn(globalThis, 'clearInterval');
+
+      const client = new NodeClient(getDefaultNodeClientOptions({ sendClientReports: true }));
+
+      client.startClientReportTracking();
+
+      const result = await client.close();
+
+      expect(result).toBe(true);
+
+      // once call directly in close to stop client reports,
+      // the other in core client `_isClientDoneProcessing`
+      expect(clearIntervalSpy).toHaveBeenCalledTimes(2);
+
+      // removes `_clientReportOnExitFlushListener`
+      expect(processOffSpy).toHaveBeenNthCalledWith(1, 'beforeExit', expect.any(Function));
+    });
+
+    it('stops log capture if it was started', async () => {
+      const processOffSpy = vi.spyOn(process, 'off');
+
+      const client = new NodeClient(getDefaultNodeClientOptions({ enableLogs: true }));
+
+      const result = await client.close();
+
+      expect(result).toBe(true);
+
+      // removes `_logOnExitFlushListener`
+      expect(processOffSpy).toHaveBeenNthCalledWith(1, 'beforeExit', expect.any(Function));
+    });
+  });
 });