remove tracing config runtime check, cleanup, move some files

Lms24 · Lms24 · commit eebd5cca6822 · 2025-08-27T20:17:39.000+02:00
diff --git a/dev-packages/e2e-tests/test-applications/sveltekit-2-kit-tracing/tests/errors.server.test.ts b/dev-packages/e2e-tests/test-applications/sveltekit-2-kit-tracing/tests/errors.server.test.ts
@@ -71,7 +71,7 @@ test.describe('server-side errors', () => {
 
     expect(errorEventFrames?.[errorEventFrames?.length - 1]).toEqual(
       expect.objectContaining({
-        filename: expect.stringMatching(/app:\/\/\/chunks\/_server.ts-.+.js/),
+        filename: expect.stringMatching(/app:\/\/\/_server.ts-.+.js/),
         function: 'GET',
         in_app: true,
       }),
diff --git a/dev-packages/e2e-tests/test-applications/sveltekit-2-kit-tracing/tests/test.json b/dev-packages/e2e-tests/test-applications/sveltekit-2-kit-tracing/tests/test.json
diff --git a/packages/sveltekit/src/server-common/handle.ts b/packages/sveltekit/src/server-common/handle.ts
@@ -170,7 +170,7 @@ async function instrumentHandle(
         // Update the root span emitted from SvelteKit to resemble a `http.server` span
         // We're doing this here instead of an event processor to ensure we update the
         // span name as early as possible (for dynamic sampling, et al.)
-        // Other spans are enhanced in the `processKitSpans` function.
+        // Other spans are enhanced in the `processKitSpans` integration.
         const spanJson = spanToJSON(kitRootSpan);
         const kitRootSpanAttributes = spanJson.data;
         const originalName = spanJson.description;
diff --git a/packages/sveltekit/src/server-common/integrations/rewriteFramesIntegration.ts b/packages/sveltekit/src/server-common/integrations/rewriteFramesIntegration.ts
@@ -7,8 +7,8 @@ import {
   join,
   rewriteFramesIntegration as originalRewriteFramesIntegration,
 } from '@sentry/core';
-import { WRAPPED_MODULE_SUFFIX } from '../common/utils';
-import type { GlobalWithSentryValues } from '../vite/injectGlobalValues';
+import { WRAPPED_MODULE_SUFFIX } from '../../common/utils';
+import type { GlobalWithSentryValues } from '../../vite/injectGlobalValues';
 
 type StackFrameIteratee = (frame: StackFrame) => StackFrame;
 interface RewriteFramesOptions {
diff --git a/packages/sveltekit/src/server-common/integrations/svelteKitSpans.ts b/packages/sveltekit/src/server-common/integrations/svelteKitSpans.ts
diff --git a/packages/sveltekit/src/server-common/utils.ts b/packages/sveltekit/src/server-common/utils.ts
@@ -53,17 +53,3 @@ export function sendErrorToSentry(e: unknown, handlerFn: 'handle' | 'load' | 'se
 
   return objectifiedErr;
 }
-
-/**
- * During build, we inject the SvelteKit tracing config into the global object of the server.
- * @returns tracing config (available since 2.31.0)
- */
-export function getKitTracingConfig(): { instrumentation: boolean; tracing: boolean } {
-  const globalWithSentryValues: GlobalWithSentryValues = GLOBAL_OBJ;
-  const kitTracingConfig = globalWithSentryValues.__sentry_sveltekit_tracing_config;
-
-  return {
-    instrumentation: kitTracingConfig?.instrumentation?.server ?? false,
-    tracing: kitTracingConfig?.tracing?.server ?? false,
-  };
-}
diff --git a/packages/sveltekit/src/server/index.ts b/packages/sveltekit/src/server/index.ts
@@ -53,7 +53,6 @@ export {
   getTraceMetaTags,
   graphqlIntegration,
   hapiIntegration,
-  httpIntegration,
   // eslint-disable-next-line deprecation/deprecation
   inboundFiltersIntegration,
   eventFiltersIntegration,
@@ -141,6 +140,7 @@ export { wrapLoadWithSentry, wrapServerLoadWithSentry } from '../server-common/l
 export { sentryHandle } from '../server-common/handle';
 export { initCloudflareSentryHandle } from './handle';
 export { wrapServerRouteWithSentry } from '../server-common/serverRoute';
+export { httpIntegration } from './integrations/http';
 
 /**
  * Tracks the Svelte component's initialization and mounting operation as well as
diff --git a/packages/sveltekit/src/server/integrations/http.ts b/packages/sveltekit/src/server/integrations/http.ts
@@ -0,0 +1,39 @@
+import type { IntegrationFn } from '@sentry/core';
+import { httpIntegration as originalHttpIntegration } from '@sentry/node';
+
+type HttpOptions = Parameters<typeof originalHttpIntegration>[0];
+
+/**
+ * The http integration instruments Node's internal http and https modules.
+ * It creates breadcrumbs and spans for outgoing HTTP requests which will be attached to the currently active span.
+ *
+ * For SvelteKit, does not create spans for incoming requests but instead we use SvelteKit's own spans.
+ * If you need to create incoming spans, set the `disableIncomingRequestSpans` option to `false`.
+ * (You likely don't need this!)
+ *
+ */
+export const httpIntegration = ((options: HttpOptions = {}) => {
+  /*
+   * This is a slightly modified version of the original httpIntegration: We avoid creating
+   * incoming request spans because:
+   *
+   *   - If Kit-tracing is available and enabled, we take the `sveltekit.handle.root` span
+   *     as the root span and make it the `http.server` span. This gives us a single root
+   *     span across all deployment plaftorms (while httpIntegration doesn't apply on e.g.
+   *     AWS Lambda or edge)
+   *   - If Kit-tracing is N/A or disabled and users follow the current/old docs, httpIntegration
+   *     does nothing anyway, so this isn't a concern.
+   *   - Which leaves the undocumented case that users --import an instrument.mjs file
+   *     in which they initialize the SDK. IMHO it's fine to ignore this for now since it was
+   *     well ... undocumented. Given in the future there won't be be an easy way for us
+   *     to detect where the SDK is initialized, we should simply redirect users to use
+   *     instrumentation.server.ts instead. If users want to, they can simply import and
+   *     register `httpIntegration` and explicitly enable incoming request spans.
+   */
+
+  return originalHttpIntegration({
+    // We disable incoming request spans here, because otherwise we'd end up with duplicate spans.
+    disableIncomingRequestSpans: true,
+    ...options,
+  });
+}) satisfies IntegrationFn;
diff --git a/packages/sveltekit/src/server/sdk.ts b/packages/sveltekit/src/server/sdk.ts
@@ -1,35 +1,21 @@
-import { applySdkMetadata } from '@sentry/core';
+import { applySdkMetadata, hasSpansEnabled } from '@sentry/core';
 import type { NodeClient, NodeOptions } from '@sentry/node';
-import {
-  getDefaultIntegrations as getDefaultNodeIntegrations,
-  httpIntegration,
-  init as initNodeSdk,
-} from '@sentry/node';
-import { svelteKitSpansIntegration } from '../server-common/processKitSpans';
-import { rewriteFramesIntegration } from '../server-common/rewriteFramesIntegration';
-import { getKitTracingConfig } from '../server-common/utils';
+import { getDefaultIntegrations as getDefaultNodeIntegrations, init as initNodeSdk } from '@sentry/node';
+import { rewriteFramesIntegration } from '../server-common/integrations/rewriteFramesIntegration';
+import { svelteKitSpansIntegration } from '../server-common/integrations/svelteKitSpans';
+import { httpIntegration } from './integrations/http';
 
 /**
  * Initialize the Server-side Sentry SDK
  * @param options
  */
 export function init(options: NodeOptions): NodeClient | undefined {
-  const defaultIntegrations = [...getDefaultNodeIntegrations(options), rewriteFramesIntegration()];
-
-  const config = getKitTracingConfig();
-  if (config.instrumentation) {
-    // Whenever `instrumentation` is enabled, we don't need httpIntegration to emit spans
-    // - if `tracing` is enabled, kit will emit the root span
-    // - if `tracing` is disabled, our handler will emit the root span
-    // In old (hooks.server.ts) based SDK setups, adding the default version of the integration does nothing
-    // for incoming requests. We still add it in default config for the undocumented case that anyone is
-    // using the SDK by `--import`ing the SDK setup directly (e.g. with adapter-node).
-    defaultIntegrations.push(httpIntegration({ disableIncomingRequestSpans: true }));
-    if (config.tracing) {
-      // If `tracing` is enabled, we need to instrument spans for the server
-      defaultIntegrations.push(svelteKitSpansIntegration());
-    }
-  }
+  const defaultIntegrations = [
+    ...getDefaultNodeIntegrations(options).filter(integration => integration.name !== 'Http'),
+    rewriteFramesIntegration(),
+    httpIntegration(),
+    svelteKitSpansIntegration(),
+  ];
 
   const opts = {
     defaultIntegrations,
diff --git a/packages/sveltekit/src/vite/injectGlobalValues.ts b/packages/sveltekit/src/vite/injectGlobalValues.ts
@@ -1,18 +1,11 @@
 import { type InternalGlobal, escapeStringForRegex } from '@sentry/core';
 import MagicString from 'magic-string';
 import type { Plugin } from 'vite';
-import {
-  type BackwardsForwardsCompatibleSvelteConfig,
-  type SvelteKitTracingConfig,
-  getAdapterOutputDir,
-  getHooksFileName,
-  getTracingConfig,
-} from './svelteConfig';
+import { type BackwardsForwardsCompatibleSvelteConfig, getAdapterOutputDir, getHooksFileName } from './svelteConfig';
 import type { SentrySvelteKitPluginOptions } from './types';
 
 export type GlobalSentryValues = {
   __sentry_sveltekit_output_dir?: string;
-  __sentry_sveltekit_tracing_config?: SvelteKitTracingConfig;
 };
 
 /**
@@ -54,14 +47,16 @@ export async function makeGlobalValuesInjectionPlugin(
 
   const globalSentryValues: GlobalSentryValues = {
     __sentry_sveltekit_output_dir: adapterOutputDir,
-    __sentry_sveltekit_tracing_config: getTracingConfig(svelteConfig),
   };
 
   if (debug) {
     // eslint-disable-next-line no-console
     console.log('[Sentry SvelteKit] Global values:', globalSentryValues);
   }
 
+  // eslint-disable-next-line @sentry-internal/sdk/no-regexp-constructor -- not end user input + escaped anyway
+  const hooksFileRegexp = new RegExp(`/${escapeStringForRegex(serverHooksFile)}(.(js|ts|mjs|mts))?`);
+
   return {
     name: 'sentry-sveltekit-global-values-injection-plugin',
     resolveId: (id, _importer, _ref) => {
@@ -85,10 +80,7 @@ export async function makeGlobalValuesInjectionPlugin(
     },
 
     transform: async (code, id) => {
-      const isServerEntryFile =
-        /instrumentation\.server\./.test(id) ||
-        // eslint-disable-next-line @sentry-internal/sdk/no-regexp-constructor -- not end user input + escaped anyway
-        new RegExp(`/${escapeStringForRegex(serverHooksFile)}(.(js|ts|mjs|mts))?`).test(id);
+      const isServerEntryFile = /instrumentation\.server\./.test(id) || hooksFileRegexp.test(id);
 
       if (isServerEntryFile) {
         if (debug) {
diff --git a/packages/sveltekit/src/vite/sentryVitePlugins.ts b/packages/sveltekit/src/vite/sentryVitePlugins.ts
@@ -10,7 +10,6 @@ import type { CustomSentryVitePluginOptions, SentrySvelteKitPluginOptions } from
 const DEFAULT_PLUGIN_OPTIONS: SentrySvelteKitPluginOptions = {
   autoUploadSourceMaps: true,
   autoInstrument: true,
-  injectGlobalValues: true,
   debug: false,
 };
 
@@ -33,6 +32,8 @@ export async function sentrySvelteKit(options: SentrySvelteKitPluginOptions = {}
   const sentryPlugins: Plugin[] = [];
 
   if (mergedOptions.autoInstrument) {
+    // TODO: Once tracing is promoted stable, we need to adjust this check!
+    // We probably need to make a instrumentation.server.ts|js file lookup instead.
     const kitTracingEnabled = !!svelteConfig.kit?.experimental?.tracing?.server;
 
     const pluginOptions: AutoInstrumentSelection = {
@@ -45,15 +46,15 @@ export async function sentrySvelteKit(options: SentrySvelteKitPluginOptions = {}
       makeAutoInstrumentationPlugin({
         ...pluginOptions,
         debug: options.debug || false,
-        // if kit-internal tracing is enabled, we only want to instrument client-side code.
+        // if kit-internal tracing is enabled, we only want to wrap and instrument client-side code.
         onlyInstrumentClient: kitTracingEnabled,
       }),
     );
   }
 
   const sentryVitePluginsOptions = generateVitePluginOptions(mergedOptions);
 
-  if (mergedOptions.injectGlobalValues) {
+  if (mergedOptions.autoUploadSourceMaps) {
     sentryPlugins.push(await makeGlobalValuesInjectionPlugin(svelteConfig, mergedOptions));
   }
 
diff --git a/packages/sveltekit/src/vite/svelteConfig.ts b/packages/sveltekit/src/vite/svelteConfig.ts
@@ -8,14 +8,15 @@ export type SvelteKitTracingConfig = {
   tracing?: {
     server: boolean;
   };
+  // TODO: Once instrumentation is promoted stable, this will be removed!
   instrumentation?: {
     server: boolean;
   };
 };
 
 /**
- * Experimental tracing and instrumentation config is available
- * @since 2.31.0
+ * Experimental tracing and instrumentation config is available @since 2.31.0
+ * // TODO: Once instrumentation and tracing is promoted stable, adjust this type!s
  */
 type BackwardsForwardsCompatibleKitConfig = Config['kit'] & { experimental?: SvelteKitTracingConfig };
 
@@ -129,21 +130,3 @@ async function getNodeAdapterOutputDir(svelteConfig: Config): Promise<string> {
 
   return outputDir;
 }
-
-/**
- * Returns the Sveltekit tracing config users can enable in svelte.config.js.
- * Available in Kit @since 2.31.0
- */
-export function getTracingConfig(
-  svelteConfig: BackwardsForwardsCompatibleSvelteConfig,
-): BackwardsForwardsCompatibleKitConfig['experimental'] {
-  const experimentalConfig = svelteConfig.kit?.experimental;
-  return {
-    instrumentation: {
-      server: experimentalConfig?.instrumentation?.server ?? false,
-    },
-    tracing: {
-      server: experimentalConfig?.tracing?.server ?? false,
-    },
-  };
-}
diff --git a/packages/sveltekit/src/vite/types.ts b/packages/sveltekit/src/vite/types.ts
@@ -224,17 +224,4 @@ export type SentrySvelteKitPluginOptions = {
    * Options related to source maps upload to Sentry
    */
   sourceMapsUploadOptions?: SourceMapsUploadOptions;
-
-  /**
-   * Controls whether application config values should be injected into the server's global object at runtime.
-   *
-   * The Sentry SDK needs some information about your application config at runtime, like for example
-   * the used build output directory or your Sveltekit Tracing config.
-   *
-   * Important: You most likely don't want to disable this! Only disable injection if you're suspecting any
-   * kinds of build problems to be related to Sentry.
-   *
-   * @default true
-   */
-  injectGlobalValues?: boolean;
 };
diff --git a/packages/sveltekit/src/worker/cloudflare.ts b/packages/sveltekit/src/worker/cloudflare.ts
@@ -6,8 +6,8 @@ import {
 } from '@sentry/cloudflare';
 import { addNonEnumerableProperty } from '@sentry/core';
 import type { Handle } from '@sveltejs/kit';
-import { svelteKitSpansIntegration } from '../server-common/processKitSpans';
-import { rewriteFramesIntegration } from '../server-common/rewriteFramesIntegration';
+import { rewriteFramesIntegration } from '../server-common/integrations/rewriteFramesIntegration';
+import { svelteKitSpansIntegration } from '../server-common/integrations/svelteKitSpans';
 
 /**
  *  Initializes Sentry SvelteKit Cloudflare SDK
diff --git a/packages/sveltekit/test/server-common/integrations/rewriteFramesIntegration.test.ts b/packages/sveltekit/test/server-common/integrations/rewriteFramesIntegration.test.ts
@@ -2,8 +2,8 @@ import { rewriteFramesIntegration } from '@sentry/browser';
 import type { Event, StackFrame } from '@sentry/core';
 import { basename } from '@sentry/core';
 import { describe, expect, it } from 'vitest';
-import { rewriteFramesIteratee } from '../../src/server-common/rewriteFramesIntegration';
-import type { GlobalWithSentryValues } from '../../src/vite/injectGlobalValues';
+import { rewriteFramesIteratee } from '../../../src/server-common/integrations/rewriteFramesIntegration';
+import type { GlobalWithSentryValues } from '../../../src/vite/injectGlobalValues';
 
 describe('rewriteFramesIteratee', () => {
   it('removes the module property from the frame', () => {
diff --git a/packages/sveltekit/test/server-common/integrations/svelteKitSpans.test.ts b/packages/sveltekit/test/server-common/integrations/svelteKitSpans.test.ts
@@ -1,7 +1,7 @@
 import type { SpanJSON, TransactionEvent } from '@sentry/core';
 import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '@sentry/core';
 import { describe, expect, it } from 'vitest';
-import { _enhanceKitSpan, svelteKitSpansIntegration } from '../../src/server-common/processKitSpans';
+import { _enhanceKitSpan, svelteKitSpansIntegration } from '../../../src/server-common/integrations/svelteKitSpans';
 
 describe('svelteKitSpansIntegration', () => {
   it('has a name and a preprocessEventHook', () => {
diff --git a/packages/sveltekit/test/server-common/utils.test.ts b/packages/sveltekit/test/server-common/utils.test.ts
diff --git a/packages/sveltekit/test/server/integrations/http.test.ts b/packages/sveltekit/test/server/integrations/http.test.ts
diff --git a/packages/sveltekit/test/vite/injectGlobalValues.test.ts b/packages/sveltekit/test/vite/injectGlobalValues.test.ts
