Replace sdk-trace-base with sdk-trace-node

andreiborza · andreiborza · commit 8b4c77346cfd · 2025-03-17T13:42:48.000+09:00
diff --git a/packages/node/src/types.ts b/packages/node/src/types.ts
@@ -1,6 +1,6 @@
 import type { Span as WriteableSpan } from '@opentelemetry/api';
 import type { Instrumentation } from '@opentelemetry/instrumentation';
-import type { ReadableSpan, SpanProcessor } from '@opentelemetry/sdk-trace-base';
+import type { ReadableSpan, SpanProcessor } from '@opentelemetry/sdk-trace-node';
 import type { ClientOptions, Options, SamplingContext, Scope, Span, TracePropagationTargets } from '@sentry/core';
 
 import type { NodeTransportOptions } from './transports';
diff --git a/packages/node/test/helpers/mockSdkInit.ts b/packages/node/test/helpers/mockSdkInit.ts
@@ -1,5 +1,5 @@
 import { ProxyTracerProvider, context, propagation, trace } from '@opentelemetry/api';
-import { BasicTracerProvider } from '@opentelemetry/sdk-trace-base';
+import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
 import { getClient, getCurrentScope, getGlobalScope, getIsolationScope } from '@sentry/core';
 import type { NodeClient } from '../../src';
 
@@ -27,7 +27,7 @@ export function mockSdkInit(options?: Partial<NodeClientOptions>) {
   });
 }
 
-export function cleanupOtel(_provider?: BasicTracerProvider): void {
+export function cleanupOtel(_provider?: NodeTracerProvider): void {
   const provider = getProvider(_provider);
 
   if (!provider) {
@@ -43,14 +43,14 @@ export function cleanupOtel(_provider?: BasicTracerProvider): void {
   propagation.disable();
 }
 
-export function getProvider(_provider?: BasicTracerProvider): BasicTracerProvider | undefined {
+export function getProvider(_provider?: NodeTracerProvider): NodeTracerProvider | undefined {
   let provider = _provider || getClient<NodeClient>()?.traceProvider || trace.getTracerProvider();
 
   if (provider instanceof ProxyTracerProvider) {
     provider = provider.getDelegate();
   }
 
-  if (!(provider instanceof BasicTracerProvider)) {
+  if (!(provider instanceof NodeTracerProvider)) {
     return undefined;
   }
 
diff --git a/packages/node/test/integration/transactions.test.ts b/packages/node/test/integration/transactions.test.ts
@@ -1,5 +1,5 @@
 import { TraceFlags, context, trace } from '@opentelemetry/api';
-import type { SpanProcessor } from '@opentelemetry/sdk-trace-base';
+import type { SpanProcessor } from '@opentelemetry/sdk-trace-node';
 import { SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN, SEMANTIC_ATTRIBUTE_SENTRY_SOURCE } from '@sentry/core';
 import { logger } from '@sentry/core';
 import type { TransactionEvent } from '@sentry/core';
diff --git a/packages/opentelemetry/package.json b/packages/opentelemetry/package.json
@@ -46,15 +46,15 @@
     "@opentelemetry/context-async-hooks": "^2.0.0-dev.0",
     "@opentelemetry/core": "^2.0.0-dev.0",
     "@opentelemetry/instrumentation": "^0.200.0-dev.0",
-    "@opentelemetry/sdk-trace-base": "^2.0.0-dev.0",
+    "@opentelemetry/sdk-trace-node": "^2.0.0-dev.0",
     "@opentelemetry/semantic-conventions": "^1.28.0"
   },
   "devDependencies": {
     "@opentelemetry/api": "^1.9.0",
     "@opentelemetry/context-async-hooks": "^2.0.0-dev.0",
     "@opentelemetry/core": "^2.0.0-dev.0",
     "@opentelemetry/instrumentation": "^0.200.0-dev.0",
-    "@opentelemetry/sdk-trace-base": "^2.0.0-dev.0",
+    "@opentelemetry/sdk-trace-node": "^2.0.0-dev.0",
     "@opentelemetry/semantic-conventions": "^1.30.0"
   },
   "scripts": {
diff --git a/packages/opentelemetry/src/custom/client.ts b/packages/opentelemetry/src/custom/client.ts
@@ -1,6 +1,6 @@
 import type { Tracer } from '@opentelemetry/api';
 import { trace } from '@opentelemetry/api';
-import type { BasicTracerProvider } from '@opentelemetry/sdk-trace-base';
+import type { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
 import type { Client } from '@sentry/core';
 import { SDK_VERSION } from '@sentry/core';
 import type { OpenTelemetryClient as OpenTelemetryClientInterface } from '../types';
@@ -23,7 +23,7 @@ export function wrapClientClass<
 >(ClientClass: ClassConstructor): WrappedClassConstructor {
   // @ts-expect-error We just assume that this is non-abstract, if you pass in an abstract class this would make it non-abstract
   class OpenTelemetryClient extends ClientClass implements OpenTelemetryClientInterface {
-    public traceProvider: BasicTracerProvider | undefined;
+    public traceProvider: NodeTracerProvider | undefined;
     private _tracer: Tracer | undefined;
 
     public constructor(...args: any[]) {
diff --git a/packages/opentelemetry/src/sampler.ts b/packages/opentelemetry/src/sampler.ts
@@ -2,8 +2,8 @@
 import type { Context, Span, TraceState as TraceStateInterface } from '@opentelemetry/api';
 import { SpanKind, isSpanContextValid, trace } from '@opentelemetry/api';
 import { TraceState } from '@opentelemetry/core';
-import type { Sampler, SamplingResult } from '@opentelemetry/sdk-trace-base';
-import { SamplingDecision } from '@opentelemetry/sdk-trace-base';
+import type { Sampler, SamplingResult } from '@opentelemetry/sdk-trace-node';
+import { SamplingDecision } from '@opentelemetry/sdk-trace-node';
 import {
   ATTR_HTTP_REQUEST_METHOD,
   ATTR_URL_FULL,
diff --git a/packages/opentelemetry/src/spanExporter.ts b/packages/opentelemetry/src/spanExporter.ts
@@ -1,7 +1,7 @@
 /* eslint-disable max-lines */
 import type { Span } from '@opentelemetry/api';
 import { SpanKind } from '@opentelemetry/api';
-import type { ReadableSpan } from '@opentelemetry/sdk-trace-base';
+import type { ReadableSpan } from '@opentelemetry/sdk-trace-node';
 import { ATTR_HTTP_RESPONSE_STATUS_CODE, SEMATTRS_HTTP_STATUS_CODE } from '@opentelemetry/semantic-conventions';
 import type {
   SpanAttributes,
diff --git a/packages/opentelemetry/src/spanProcessor.ts b/packages/opentelemetry/src/spanProcessor.ts
@@ -1,6 +1,6 @@
 import type { Context } from '@opentelemetry/api';
 import { ROOT_CONTEXT, trace } from '@opentelemetry/api';
-import type { ReadableSpan, Span, SpanProcessor as SpanProcessorInterface } from '@opentelemetry/sdk-trace-base';
+import type { ReadableSpan, Span, SpanProcessor as SpanProcessorInterface } from '@opentelemetry/sdk-trace-node';
 import {
   addChildSpanToSpan,
   getClient,
diff --git a/packages/opentelemetry/src/types.ts b/packages/opentelemetry/src/types.ts
@@ -1,10 +1,10 @@
 import type { Span as WriteableSpan, SpanKind, Tracer } from '@opentelemetry/api';
-import type { BasicTracerProvider, ReadableSpan } from '@opentelemetry/sdk-trace-base';
+import type { NodeTracerProvider, ReadableSpan } from '@opentelemetry/sdk-trace-node';
 import type { Scope, Span, StartSpanOptions } from '@sentry/core';
 
 export interface OpenTelemetryClient {
   tracer: Tracer;
-  traceProvider: BasicTracerProvider | undefined;
+  traceProvider: NodeTracerProvider | undefined;
 }
 
 export interface OpenTelemetrySpanContext extends StartSpanOptions {
diff --git a/packages/opentelemetry/src/utils/getRequestSpanData.ts b/packages/opentelemetry/src/utils/getRequestSpanData.ts
@@ -1,5 +1,5 @@
 import type { Span } from '@opentelemetry/api';
-import type { ReadableSpan } from '@opentelemetry/sdk-trace-base';
+import type { ReadableSpan } from '@opentelemetry/sdk-trace-node';
 import {
   ATTR_HTTP_REQUEST_METHOD,
   ATTR_URL_FULL,
diff --git a/packages/opentelemetry/src/utils/groupSpansWithParents.ts b/packages/opentelemetry/src/utils/groupSpansWithParents.ts
@@ -1,4 +1,4 @@
-import type { ReadableSpan } from '@opentelemetry/sdk-trace-base';
+import type { ReadableSpan } from '@opentelemetry/sdk-trace-node';
 import { SEMANTIC_ATTRIBUTE_SENTRY_PARENT_IS_REMOTE } from '../semanticAttributes';
 
 export interface SpanNode {
diff --git a/packages/opentelemetry/src/utils/spanTypes.ts b/packages/opentelemetry/src/utils/spanTypes.ts
@@ -1,5 +1,5 @@
-import type {SpanContext, SpanKind, SpanStatus} from '@opentelemetry/api';
-import type { ReadableSpan, TimedEvent } from '@opentelemetry/sdk-trace-base';
+import type { SpanContext, SpanKind, SpanStatus } from '@opentelemetry/api';
+import type { ReadableSpan, TimedEvent } from '@opentelemetry/sdk-trace-node';
 
 import type { AbstractSpan } from '../types';
 
diff --git a/packages/opentelemetry/test/asyncContextStrategy.test.ts b/packages/opentelemetry/test/asyncContextStrategy.test.ts
@@ -1,4 +1,4 @@
-import type { BasicTracerProvider } from '@opentelemetry/sdk-trace-base';
+import type { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
 import {
   Scope as ScopeClass,
   getCurrentScope,
@@ -16,7 +16,7 @@ import { setupOtel } from './helpers/initOtel';
 import { cleanupOtel } from './helpers/mockSdkInit';
 
 describe('asyncContextStrategy', () => {
-  let provider: BasicTracerProvider | undefined;
+  let provider: NodeTracerProvider | undefined;
 
   beforeEach(() => {
     getCurrentScope().clear();
diff --git a/packages/opentelemetry/test/helpers/createSpan.ts b/packages/opentelemetry/test/helpers/createSpan.ts
@@ -1,7 +1,7 @@
-import type { Context, SpanContext, TimeInput } from '@opentelemetry/api';
+import type { SpanContext, TimeInput } from '@opentelemetry/api';
 import { SpanKind } from '@opentelemetry/api';
-import type { Tracer } from '@opentelemetry/sdk-trace-base';
-import { Span } from '@opentelemetry/sdk-trace-base';
+import type { SpanProcessor } from '@opentelemetry/sdk-trace-node';
+import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
 import { uuid4 } from '@sentry/core';
 
 export function createSpan(
@@ -17,24 +17,50 @@ export function createSpan(
     traceId?: string;
     startTime?: TimeInput;
   } = {},
-): Span {
-  const spanProcessor = {
+) {
+  const spanProcessor: SpanProcessor = {
     onStart: () => {},
     onEnd: () => {},
+    forceFlush: (() => {}) as () => Promise<void>,
+    shutdown: (() => {}) as () => Promise<void>,
+  };
+
+  const provider = new NodeTracerProvider({
+    spanLimits: {},
+    spanProcessors: [spanProcessor],
+  });
+
+  const tracer = provider.getTracer('test-instrumentation-library');
+
+  // const tracer = {
+  //   resource: 'test-resource',
+  //   instrumentationLibrary: 'test-instrumentation-library',
+  //   getSpanLimits: () => ({}),
+  //   getActiveSpanProcessor: () => spanProcessor,
+  // } as unknown as Tracer;
+
+  const tId = traceId || uuid4();
+
+  const parentSpanContext: SpanContext = {
+    spanId: parentSpanId || uuid4(),
+    traceId: tId,
+    traceFlags: 0,
   };
-  const tracer = {
-    resource: 'test-resource',
-    instrumentationLibrary: 'test-instrumentation-library',
-    getSpanLimits: () => ({}),
-    getActiveSpanProcessor: () => spanProcessor,
-  } as unknown as Tracer;
 
   const spanContext: SpanContext = {
     spanId: spanId || uuid4(),
-    traceId: traceId || uuid4(),
+    traceId: tId,
     traceFlags: 0,
   };
 
-  // eslint-disable-next-line deprecation/deprecation
-  return new Span(tracer, {} as Context, name || 'test', spanContext, SpanKind.INTERNAL, parentSpanId, [], startTime);
+  return tracer.startSpan(
+    name || 'test',
+    {
+      kind: SpanKind.INTERNAL,
+      links: [],
+      spanContext,
+      startTime,
+    },
+    parentSpanContext,
+  );
 }
diff --git a/packages/opentelemetry/test/helpers/mockSdkInit.ts b/packages/opentelemetry/test/helpers/mockSdkInit.ts
@@ -1,5 +1,5 @@
 import { ProxyTracerProvider, context, propagation, trace } from '@opentelemetry/api';
-import { BasicTracerProvider } from '@opentelemetry/sdk-trace-base';
+import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
 import type { ClientOptions, Options } from '@sentry/core';
 import { getClient } from '@sentry/core';
 
@@ -35,7 +35,7 @@ export function mockSdkInit(options?: Partial<ClientOptions>) {
   init({ dsn: PUBLIC_DSN, ...options });
 }
 
-export async function cleanupOtel(_provider?: BasicTracerProvider): Promise<void> {
+export async function cleanupOtel(_provider?: NodeTracerProvider): Promise<void> {
   clearOpenTelemetrySetupCheck();
 
   const provider = getProvider(_provider);
@@ -53,14 +53,14 @@ export async function cleanupOtel(_provider?: BasicTracerProvider): Promise<void
   await flush();
 }
 
-export function getProvider(_provider?: BasicTracerProvider): BasicTracerProvider | undefined {
+export function getProvider(_provider?: NodeTracerProvider): NodeTracerProvider | undefined {
   let provider = _provider || getClient<OpenTelemetryClient>()?.traceProvider || trace.getTracerProvider();
 
   if (provider instanceof ProxyTracerProvider) {
     provider = provider.getDelegate();
   }
 
-  if (!(provider instanceof BasicTracerProvider)) {
+  if (!(provider instanceof NodeTracerProvider)) {
     return undefined;
   }
 
diff --git a/packages/opentelemetry/test/integration/transactions.test.ts b/packages/opentelemetry/test/integration/transactions.test.ts
@@ -1,7 +1,7 @@
 import type { SpanContext } from '@opentelemetry/api';
 import { ROOT_CONTEXT } from '@opentelemetry/api';
 import { TraceFlags, context, trace } from '@opentelemetry/api';
-import type { SpanProcessor } from '@opentelemetry/sdk-trace-base';
+import type { SpanProcessor } from '@opentelemetry/sdk-trace-node';
 import {
   SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
   SEMANTIC_ATTRIBUTE_SENTRY_SOURCE,
diff --git a/packages/opentelemetry/test/sampler.test.ts b/packages/opentelemetry/test/sampler.test.ts
@@ -1,6 +1,6 @@
 import { SpanKind, context, trace } from '@opentelemetry/api';
 import { TraceState } from '@opentelemetry/core';
-import { SamplingDecision } from '@opentelemetry/sdk-trace-base';
+import { SamplingDecision } from '@opentelemetry/sdk-trace-node';
 import { ATTR_HTTP_REQUEST_METHOD } from '@opentelemetry/semantic-conventions';
 import { generateSpanId, generateTraceId } from '@sentry/core';
 import { describe, afterEach, vi, expect, it } from 'vitest';
diff --git a/packages/opentelemetry/test/trace.test.ts b/packages/opentelemetry/test/trace.test.ts
@@ -3,8 +3,8 @@ import type { Span, TimeInput } from '@opentelemetry/api';
 import { ROOT_CONTEXT } from '@opentelemetry/api';
 import { SpanKind } from '@opentelemetry/api';
 import { TraceFlags, context, trace } from '@opentelemetry/api';
-import type { ReadableSpan } from '@opentelemetry/sdk-trace-base';
-import { Span as SpanClass } from '@opentelemetry/sdk-trace-base';
+import type { ReadableSpan } from '@opentelemetry/sdk-trace-node';
+import { Span as SpanClass } from '@opentelemetry/sdk-trace-node';
 import {
   SEMANTIC_ATTRIBUTE_SENTRY_OP,
   SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
diff --git a/packages/opentelemetry/test/utils/getActiveSpan.test.ts b/packages/opentelemetry/test/utils/getActiveSpan.test.ts
@@ -1,5 +1,5 @@
 import { trace } from '@opentelemetry/api';
-import type { BasicTracerProvider } from '@opentelemetry/sdk-trace-base';
+import type { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
 import { getRootSpan } from '@sentry/core';
 import { describe, afterEach, beforeEach, expect, it } from 'vitest';
 
@@ -9,7 +9,7 @@ import { setupOtel } from '../helpers/initOtel';
 import { cleanupOtel } from '../helpers/mockSdkInit';
 
 describe('getActiveSpan', () => {
-  let provider: BasicTracerProvider | undefined;
+  let provider: NodeTracerProvider | undefined;
 
   beforeEach(() => {
     const client = new TestClient(getDefaultTestClientOptions());
@@ -94,7 +94,7 @@ describe('getActiveSpan', () => {
 });
 
 describe('getRootSpan', () => {
-  let provider: BasicTracerProvider | undefined;
+  let provider: NodeTracerProvider | undefined;
 
   beforeEach(() => {
     const client = new TestClient(getDefaultTestClientOptions({ tracesSampleRate: 1 }));
diff --git a/packages/opentelemetry/test/utils/setupCheck.test.ts b/packages/opentelemetry/test/utils/setupCheck.test.ts
@@ -1,4 +1,4 @@
-import { BasicTracerProvider } from '@opentelemetry/sdk-trace-base';
+import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
 import { describe, afterEach, beforeEach, expect, it } from 'vitest';
 
 import { SentrySampler } from '../../src/sampler';
@@ -9,7 +9,7 @@ import { setupOtel } from '../helpers/initOtel';
 import { cleanupOtel } from '../helpers/mockSdkInit';
 
 describe('openTelemetrySetupCheck', () => {
-  let provider: BasicTracerProvider | undefined;
+  let provider: NodeTracerProvider | undefined;
 
   beforeEach(() => {
     cleanupOtel(provider);
@@ -34,12 +34,10 @@ describe('openTelemetrySetupCheck', () => {
 
   it('returns partial setup parts', () => {
     const client = new TestClient(getDefaultTestClientOptions());
-    provider = new BasicTracerProvider({
+    provider = new NodeTracerProvider({
       sampler: new SentrySampler(client),
+      spanProcessors: [new SentrySpanProcessor()],
     });
-    // We want to test this deprecated case also works
-    // eslint-disable-next-line deprecation/deprecation
-    provider.addSpanProcessor(new SentrySpanProcessor());
 
     const setup = openTelemetrySetupCheck();
     expect(setup).toEqual(['SentrySampler', 'SentrySpanProcessor']);
diff --git a/packages/opentelemetry/test/utils/setupEventContextTrace.test.ts b/packages/opentelemetry/test/utils/setupEventContextTrace.test.ts
@@ -1,4 +1,4 @@
-import type { BasicTracerProvider } from '@opentelemetry/sdk-trace-base';
+import type { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
 import { captureException, setCurrentClient } from '@sentry/core';
 import { describe, afterEach, beforeEach, expect, it, vi, afterAll } from 'vitest';
 
@@ -13,7 +13,7 @@ const PUBLIC_DSN = 'https://username@domain/123';
 describe('setupEventContextTrace', () => {
   const beforeSend = vi.fn(() => null);
   let client: TestClientInterface;
-  let provider: BasicTracerProvider | undefined;
+  let provider: NodeTracerProvider | undefined;
 
   beforeEach(() => {
     client = new TestClient(
diff --git a/packages/vercel-edge/src/client.ts b/packages/vercel-edge/src/client.ts
@@ -2,7 +2,7 @@ import type { ServerRuntimeClientOptions } from '@sentry/core';
 import { applySdkMetadata } from '@sentry/core';
 import { ServerRuntimeClient } from '@sentry/core';
 
-import type { BasicTracerProvider } from '@opentelemetry/sdk-trace-base';
+import type { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
 import type { VercelEdgeClientOptions } from './types';
 
 declare const process: {
@@ -16,7 +16,7 @@ declare const process: {
  * @see ServerRuntimeClient for usage documentation.
  */
 export class VercelEdgeClient extends ServerRuntimeClient<VercelEdgeClientOptions> {
-  public traceProvider: BasicTracerProvider | undefined;
+  public traceProvider: NodeTracerProvider | undefined;
 
   /**
    * Creates a new Vercel Edge Runtime SDK instance.
diff --git a/yarn.lock b/yarn.lock
@@ -5995,7 +5995,7 @@
     "@opentelemetry/api" "^0.12.0"
     "@opentelemetry/core" "^0.12.0"
 
-"@opentelemetry/sdk-trace-base@2.0.0-dev.0", "@opentelemetry/sdk-trace-base@^2.0.0-dev.0":
+"@opentelemetry/sdk-trace-base@2.0.0-dev.0":
   version "2.0.0-dev.0"
   resolved "https://registry.yarnpkg.com/@opentelemetry/sdk-trace-base/-/sdk-trace-base-2.0.0-dev.0.tgz#320a259ea4332b4d9452e6bd309862c4c2d08e9e"
   integrity sha512-zULpgNZNGS6LM+rI6fw2fraAVvIm3aI/DfcuwxRvPa6Yqf9kR7FQk1EdB8Tf2AJm+UWakGPpRbEhkv1KqPVu2w==

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`import { ProxyTracerProvider, context, propagation, trace } from '@opentelemetry/api';`
`2`		`-import { BasicTracerProvider } from '@opentelemetry/sdk-trace-base';`
	`2`	`+import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';`
`3`	`3`	`import { getClient, getCurrentScope, getGlobalScope, getIsolationScope } from '@sentry/core';`
`4`	`4`	`import type { NodeClient } from '../../src';`
`5`	`5`
`@@ -27,7 +27,7 @@ export function mockSdkInit(options?: Partial<NodeClientOptions>) {`
`27`	`27`	`});`
`28`	`28`	`}`
`29`	`29`
`30`		`-export function cleanupOtel(_provider?: BasicTracerProvider): void {`
	`30`	`+export function cleanupOtel(_provider?: NodeTracerProvider): void {`
`31`	`31`	`const provider = getProvider(_provider);`
`32`	`32`
`33`	`33`	`if (!provider) {`
`@@ -43,14 +43,14 @@ export function cleanupOtel(_provider?: BasicTracerProvider): void {`
`43`	`43`	`propagation.disable();`
`44`	`44`	`}`
`45`	`45`
`46`		`-export function getProvider(_provider?: BasicTracerProvider): BasicTracerProvider \| undefined {`
	`46`	`+export function getProvider(_provider?: NodeTracerProvider): NodeTracerProvider \| undefined {`
`47`	`47`	`let provider = _provider \|\| getClient<NodeClient>()?.traceProvider \|\| trace.getTracerProvider();`
`48`	`48`
`49`	`49`	`if (provider instanceof ProxyTracerProvider) {`
`50`	`50`	`provider = provider.getDelegate();`
`51`	`51`	`}`
`52`	`52`
`53`		`- if (!(provider instanceof BasicTracerProvider)) {`
	`53`	`+ if (!(provider instanceof NodeTracerProvider)) {`
`54`	`54`	`return undefined;`
`55`	`55`	`}`
`56`	`56`