feat(core): Consolidate bun and node types with BaseWinterTCOptions

JPeer264 · JPeer264 · commit 7b7341ed8fc6 · 2026-01-08T17:16:45.000+01:00
diff --git a/packages/bun/src/types.ts b/packages/bun/src/types.ts
@@ -1,54 +1,11 @@
-import type { BaseTransportOptions, ClientOptions, Options, TracePropagationTargets } from '@sentry/core';
+import type { BaseTransportOptions, BaseWinterTCOptions, ClientOptions, Options } from '@sentry/core';
 
-export interface BaseBunOptions {
-  /**
-   * List of strings/regex controlling to which outgoing requests
-   * the SDK will attach tracing headers.
-   *
-   * By default the SDK will attach those headers to all outgoing
-   * requests. If this option is provided, the SDK will match the
-   * request URL of outgoing requests against the items in this
-   * array, and only attach tracing headers if a match was found.
-   *
-   * @example
-   * ```js
-   * Sentry.init({
-   *   tracePropagationTargets: ['api.site.com'],
-   * });
-   * ```
-   */
-  tracePropagationTargets?: TracePropagationTargets;
-
-  /** Sets an optional server name (device name) */
-  serverName?: string;
-
-  /**
-   * If you use Spotlight by Sentry during development, use
-   * this option to forward captured Sentry events to Spotlight.
-   *
-   * Either set it to true, or provide a specific Spotlight Sidecar URL.
-   *
-   * More details: https://spotlightjs.com/
-   *
-   * IMPORTANT: Only set this option to `true` while developing, not in production!
-   */
-  spotlight?: boolean | string;
-
-  /**
-   * If this is set to true, the SDK will not set up OpenTelemetry automatically.
-   * In this case, you _have_ to ensure to set it up correctly yourself, including:
-   * * The `SentrySpanProcessor`
-   * * The `SentryPropagator`
-   * * The `SentryContextManager`
-   * * The `SentrySampler`
-   *
-   * If you are registering your own OpenTelemetry Loader Hooks (or `import-in-the-middle` hooks), it is also recommended to set the `registerEsmLoaderHooks` option to false.
-   */
-  skipOpenTelemetrySetup?: boolean;
-
-  /** Callback that is executed when a fatal global error occurs. */
-  onFatalError?(this: void, error: Error): void;
-}
+/**
+ * Base options for the Sentry Bun SDK.
+ * Extends the common WinterTC options shared with Node.js and other server-side SDKs.
+ */
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface BaseBunOptions extends BaseWinterTCOptions {}
 
 /**
  * Configuration options for the Sentry Bun SDK
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -386,7 +386,7 @@ export type { Extra, Extras } from './types-hoist/extra';
 export type { Integration, IntegrationFn } from './types-hoist/integration';
 export type { Mechanism } from './types-hoist/mechanism';
 export type { ExtractedNodeRequestData, HttpHeaderValue, Primitive, WorkerLocation } from './types-hoist/misc';
-export type { ClientOptions, CoreOptions as Options } from './types-hoist/options';
+export type { BaseWinterTCOptions, ClientOptions, CoreOptions as Options } from './types-hoist/options';
 export type { Package } from './types-hoist/package';
 export type { PolymorphicEvent, PolymorphicRequest } from './types-hoist/polymorphics';
 export type {
diff --git a/packages/core/src/types-hoist/options.ts b/packages/core/src/types-hoist/options.ts
@@ -11,6 +11,67 @@ import type { StackLineParser, StackParser } from './stacktrace';
 import type { TracePropagationTargets } from './tracing';
 import type { BaseTransportOptions, Transport } from './transport';
 
+/**
+ * Base options for WinterTC-compatible server-side JavaScript runtimes.
+ * This interface contains common configuration options shared between
+ * Node.js, Bun, and other WinterTC-compliant runtime SDKs.
+ *
+ * @see https://wintercg.org/
+ */
+export interface BaseWinterTCOptions {
+  /**
+   * List of strings/regex controlling to which outgoing requests
+   * the SDK will attach tracing headers.
+   *
+   * By default the SDK will attach those headers to all outgoing
+   * requests. If this option is provided, the SDK will match the
+   * request URL of outgoing requests against the items in this
+   * array, and only attach tracing headers if a match was found.
+   *
+   * @example
+   * ```js
+   * Sentry.init({
+   *   tracePropagationTargets: ['api.site.com'],
+   * });
+   * ```
+   */
+  tracePropagationTargets?: TracePropagationTargets;
+
+  /**
+   * Sets an optional server name (device name).
+   *
+   * This is useful for identifying which server or instance is sending events.
+   */
+  serverName?: string;
+
+  /**
+   * If you use Spotlight by Sentry during development, use
+   * this option to forward captured Sentry events to Spotlight.
+   *
+   * Either set it to true, or provide a specific Spotlight Sidecar URL.
+   *
+   * More details: https://spotlightjs.com/
+   *
+   * IMPORTANT: Only set this option to `true` while developing, not in production!
+   */
+  spotlight?: boolean | string;
+
+  /**
+   * If this is set to true, the SDK will not set up OpenTelemetry automatically.
+   * In this case, you _have_ to ensure to set it up correctly yourself, including:
+   * * The `SentrySpanProcessor`
+   * * The `SentryPropagator`
+   * * The `SentryContextManager`
+   * * The `SentrySampler`
+   */
+  skipOpenTelemetrySetup?: boolean;
+
+  /**
+   * Callback that is executed when a fatal global error occurs.
+   */
+  onFatalError?(this: void, error: Error): void;
+}
+
 /**
  * A filter object for ignoring spans.
  * At least one of the properties (`op` or `name`) must be set.
diff --git a/packages/node-core/src/types.ts b/packages/node-core/src/types.ts
@@ -1,28 +1,14 @@
 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 { ClientOptions, Options, SamplingContext, Scope, Span, TracePropagationTargets } from '@sentry/core';
+import type { BaseWinterTCOptions, ClientOptions, Options, SamplingContext, Scope, Span } from '@sentry/core';
 import type { NodeTransportOptions } from './transports';
 
-export interface BaseNodeOptions {
-  /**
-   * List of strings/regex controlling to which outgoing requests
-   * the SDK will attach tracing headers.
-   *
-   * By default the SDK will attach those headers to all outgoing
-   * requests. If this option is provided, the SDK will match the
-   * request URL of outgoing requests against the items in this
-   * array, and only attach tracing headers if a match was found.
-   *
-   * @example
-   * ```js
-   * Sentry.init({
-   *   tracePropagationTargets: ['api.site.com'],
-   * });
-   * ```
-   */
-  tracePropagationTargets?: TracePropagationTargets;
-
+/**
+ * Base options for the Sentry Node SDK.
+ * Extends the common WinterTC options shared with Bun and other server-side SDKs.
+ */
+export interface BaseNodeOptions extends BaseWinterTCOptions {
   /**
    * Sets profiling sample rate when @sentry/profiling-node is installed
    *
@@ -71,28 +57,13 @@ export interface BaseNodeOptions {
    */
   includeServerName?: boolean;
 
-  /** Sets an optional server name (device name) */
-  serverName?: string;
-
   /**
    * Include local variables with stack traces.
    *
    * Requires the `LocalVariables` integration.
    */
   includeLocalVariables?: boolean;
 
-  /**
-   * If you use Spotlight by Sentry during development, use
-   * this option to forward captured Sentry events to Spotlight.
-   *
-   * Either set it to true, or provide a specific Spotlight Sidecar URL.
-   *
-   * More details: https://spotlightjs.com/
-   *
-   * IMPORTANT: Only set this option to `true` while developing, not in production!
-   */
-  spotlight?: boolean | string;
-
   /**
    * Provide an array of OpenTelemetry Instrumentations that should be registered.
    *
@@ -144,9 +115,6 @@ export interface BaseNodeOptions {
    * problems.
    */
   shutdownTimeout?: number;
-
-  /** Callback that is executed when a fatal global error occurs. */
-  onFatalError?(this: void, error: Error): void;
 }
 
 /**
diff --git a/packages/node/src/types.ts b/packages/node/src/types.ts
@@ -1,28 +1,14 @@
 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 { ClientOptions, Options, SamplingContext, Scope, Span, TracePropagationTargets } from '@sentry/core';
+import type { BaseWinterTCOptions, ClientOptions, Options, SamplingContext, Scope, Span } from '@sentry/core';
 import type { NodeTransportOptions } from '@sentry/node-core';
 
-export interface BaseNodeOptions {
-  /**
-   * List of strings/regex controlling to which outgoing requests
-   * the SDK will attach tracing headers.
-   *
-   * By default the SDK will attach those headers to all outgoing
-   * requests. If this option is provided, the SDK will match the
-   * request URL of outgoing requests against the items in this
-   * array, and only attach tracing headers if a match was found.
-   *
-   * @example
-   * ```js
-   * Sentry.init({
-   *   tracePropagationTargets: ['api.site.com'],
-   * });
-   * ```
-   */
-  tracePropagationTargets?: TracePropagationTargets;
-
+/**
+ * Base options for the Sentry Node SDK.
+ * Extends the common WinterTC options shared with Bun and other server-side SDKs.
+ */
+export interface BaseNodeOptions extends BaseWinterTCOptions {
   /**
    * Sets profiling sample rate when @sentry/profiling-node is installed
    *
@@ -74,40 +60,13 @@ export interface BaseNodeOptions {
    */
   includeServerName?: boolean;
 
-  /** Sets an optional server name (device name) */
-  serverName?: string;
-
   /**
    * Include local variables with stack traces.
    *
    * Requires the `LocalVariables` integration.
    */
   includeLocalVariables?: boolean;
 
-  /**
-   * If you use Spotlight by Sentry during development, use
-   * this option to forward captured Sentry events to Spotlight.
-   *
-   * Either set it to true, or provide a specific Spotlight Sidecar URL.
-   *
-   * More details: https://spotlightjs.com/
-   *
-   * IMPORTANT: Only set this option to `true` while developing, not in production!
-   */
-  spotlight?: boolean | string;
-
-  /**
-   * If this is set to true, the SDK will not set up OpenTelemetry automatically.
-   * In this case, you _have_ to ensure to set it up correctly yourself, including:
-   * * The `SentrySpanProcessor`
-   * * The `SentryPropagator`
-   * * The `SentryContextManager`
-   * * The `SentrySampler`
-   *
-   * If you are registering your own OpenTelemetry Loader Hooks (or `import-in-the-middle` hooks), it is also recommended to set the `registerEsmLoaderHooks` option to false.
-   */
-  skipOpenTelemetrySetup?: boolean;
-
   /**
    * Provide an array of OpenTelemetry Instrumentations that should be registered.
    *
@@ -159,9 +118,6 @@ export interface BaseNodeOptions {
    * problems.
    */
   shutdownTimeout?: number;
-
-  /** Callback that is executed when a fatal global error occurs. */
-  onFatalError?(this: void, error: Error): void;
 }
 
 /**
