fix: don't import from @opentelemetry/api in public types (#9066)

Author: sheremet-va

packages/vitest/src/runtime/moduleRunner/moduleEvaluator.ts

@@ -29,6 +29,9 @@ export interface VitestModuleEvaluatorOptions {
   getCurrentTestFilepath?: () => string | undefined
   compiledFunctionArgumentsNames?: string[]
   compiledFunctionArgumentsValues?: unknown[]
+  /**
+   * @internal
+   */
   traces?: Traces
 }
 

packages/vitest/src/runtime/moduleRunner/moduleMocker.ts

@@ -20,6 +20,9 @@ interface MockContext {
 
 export interface VitestMockerOptions {
   context?: vm.Context
+  /**
+   * @internal
+   */
   traces: Traces
   spyModule?: typeof import('@vitest/spy')
   root: string

packages/vitest/src/runtime/moduleRunner/moduleRunner.ts

@@ -206,6 +206,9 @@ export interface VitestModuleRunnerOptions {
   getWorkerState: () => WorkerGlobalState
   mocker?: VitestMocker
   vm?: VitestVmOptions
+  /**
+   * @internal
+   */
   traces?: Traces
   spyModule?: typeof import('@vitest/spy')
   createImportMeta?: CreateImportMeta

packages/vitest/src/runtime/moduleRunner/startModuleRunner.ts

@@ -27,6 +27,9 @@ export interface ContextModuleRunnerOptions {
   context?: vm.Context
   externalModulesExecutor?: ExternalModulesExecutor
   state: WorkerGlobalState
+  /**
+   * @internal
+   */
   traces?: Traces // optional to keep backwards compat
   spyModule?: typeof import('@vitest/spy')
   createImportMeta?: CreateImportMeta

packages/vitest/src/types/worker.ts

@@ -49,6 +49,9 @@ export interface WorkerSetupContext {
   config: SerializedConfig
   projectName: string
   rpc: WorkerRPC
+  /**
+   * @internal
+   */
   traces: Traces
 }
 

packages/vitest/src/utils/traces.ts

@@ -83,13 +83,19 @@ export class Traces {
     return !!this.#otel
   }
 
+  /**
+   * @internal
+   */
   async waitInit(): Promise<this> {
     if (this.#init) {
       await this.#init
     }
     return this
   }
 
+  /**
+   * @internal
+   */
   startContextSpan(name: string, currentContext?: Context): {
     span: Span
     context: Context
@@ -114,6 +120,9 @@ export class Traces {
     }
   }
 
+  /**
+   * @internal
+   */
   getContextFromCarrier(carrier: OTELCarrier | undefined): Context {
     if (!this.#otel) {
       return this.#noopContext
@@ -125,6 +134,9 @@ export class Traces {
     return this.#otel.propagation.extract(activeContext, carrier)
   }
 
+  /**
+   * @internal
+   */
   getContextCarrier(context?: Context): OTELCarrier | undefined {
     if (!this.#otel) {
       return undefined
@@ -177,8 +189,17 @@ export class Traces {
     }
   }
 
+  /**
+   * @internal
+   */
   $<T>(name: string, fn: (span: Span) => T): T
+  /**
+   * @internal
+   */
   $<T>(name: string, optionsOrFn: TracesSpanOptions, fn: (span: Span) => T): T
+  /**
+   * @internal
+   */
   $<T>(name: string, optionsOrFn: TracesSpanOptions | ((span: Span) => T), fn?: (span: Span) => T): T {
     const callback = typeof optionsOrFn === 'function' ? optionsOrFn : fn!
     if (!this.#otel) {
@@ -203,6 +224,9 @@ export class Traces {
     )
   }
 
+  /**
+   * @internal
+   */
   startSpan(name: string, options?: SpanOptions, context?: Context): Span {
     if (!this.#otel) {
       return this.#noopSpan
@@ -211,6 +235,9 @@ export class Traces {
     return tracer.startSpan(name, options, context)
   }
 
+  /**
+   * @internal
+   */
   async finish(): Promise<void> {
     await this.#sdk?.shutdown()
   }