fix(v10/sveltekit): Resolve @opentelemetry/api via the SDK on SvelteKit 3

Backport of #24736

Since `@sveltejs/kit@3.0.0-next.28` (sveltejs/kit#17081), the SvelteKit
server build keeps `@opentelemetry/api` external. With `tracing.server`
enabled, SvelteKit imports it at runtime from the app. Under pnpm or
Yarn PnP, the app cannot resolve it, because it is only a transitive
dependency of `@sentry/node`. Then SvelteKit fails every request with
`tracing_api_missing`. This is also why the `sveltekit-3` e2e app fails
on v10 against stable SvelteKit 3.

`@sentry/sveltekit` now depends on `@opentelemetry/api`, re-exports it
as `@sentry/sveltekit/opentelemetry-api`, and the `sentrySvelteKit()`
Vite plugin redirects SvelteKit's import to that re-export.

## Differences to the original PR

- `packages/sveltekit/package.json`: v10 has no `./vite` subpath export,
  so only the `./opentelemetry-api` export is added. The dependency list
  keeps the v10 packages and only adds `@opentelemetry/api`.
- `packages/sveltekit/rollup.npm.config.mjs`: only adds the
  `src/opentelemetryApi.ts` entry point, not `src/vite/index.ts`.
- `packages/sveltekit/test/vite/sentrySvelteKitPlugins.test.ts`: v10 has
  no orchestrion Vite plugin, so the expected plugin counts are one
  lower than on `develop`.

(cherry picked from commit 2a58c97)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

Author: 2 people

packages/sveltekit/package.json

@@ -41,6 +41,11 @@
         "import": "./build/esm/index.server.js",
         "require": "./build/cjs/index.server.js"
       }
+    },
+    "./opentelemetry-api": {
+      "types": "./build/types/opentelemetryApi.d.ts",
+      "import": "./build/esm/opentelemetryApi.js",
+      "require": "./build/cjs/opentelemetryApi.js"
     }
   },
   "publishConfig": {
@@ -57,6 +62,7 @@
     }
   },
   "dependencies": {
+    "@opentelemetry/api": "^1.9.1",
     "@sentry/cloudflare": "10.76.0",
     "@sentry/core": "10.76.0",
     "@sentry/conventions": "^0.16.0",

packages/sveltekit/rollup.npm.config.mjs

@@ -13,6 +13,7 @@ export default makeNPMConfigVariants(
       'src/client/svelte5BrowserTracing.ts',
       'src/server/index.ts',
       'src/worker/index.ts',
+      'src/opentelemetryApi.ts',
     ],
     packageSpecificConfig: {
       // Keep the variant subpath external so the transpiled output preserves the import for the

packages/sveltekit/src/opentelemetryApi.ts

@@ -0,0 +1,3 @@
+// Re-exported under `@sentry/sveltekit/opentelemetry-api` so the `sentrySvelteKit()` plugin can point
+// SvelteKit's `@opentelemetry/api` import here. See `makeOpenTelemetryApiResolverPlugin`.
+export * from '@opentelemetry/api';

packages/sveltekit/src/vite/sentryVitePlugins.ts

@@ -49,7 +49,11 @@ export async function sentrySvelteKit(options: SentrySvelteKitPluginOptions = {}
 
   // First so the config settles as early as possible. The plugins below read it in `configResolved`,
   // which Vite runs concurrently, so their order relative to the resolver doesn't matter.
-  const sentryPlugins: Plugin[] = [kitConfigResolver.plugin, makeBrowserTracingVariantResolverPlugin()];
+  const sentryPlugins: Plugin[] = [
+    kitConfigResolver.plugin,
+    makeBrowserTracingVariantResolverPlugin(),
+    makeOpenTelemetryApiResolverPlugin(),
+  ];
 
   if (mergedOptions.autoInstrument) {
     const pluginOptions: AutoInstrumentSelection = {
@@ -135,6 +139,44 @@ function makeBrowserTracingVariantResolverPlugin(): Plugin {
   };
 }
 
+const OTEL_API_ID = '@opentelemetry/api';
+const OTEL_API_REEXPORT_ID = '@sentry/sveltekit/opentelemetry-api';
+const OTEL_API_REEXPORT_FILE_REGEX = /[\\/]opentelemetryApi\.js$/;
+
+/**
+ * SvelteKit 3 externalizes `@opentelemetry/api` in server builds, so its runtime imports it at runtime
+ * from the app root. That only resolves if the app depends on it directly: under pnpm (or Yarn PnP),
+ * the copy installed through `@sentry/sveltekit` isn't reachable, and Kit fails every request once
+ * `tracing.server` is enabled.
+ *
+ * We redirect the import to our re-export instead, which resolves because the app always depends on
+ * `@sentry/sveltekit` directly. It stays external, so the Kit runtime and `instrumentation.server.js`
+ * still share a single module instance, which is why Kit externalizes it in the first place.
+ */
+function makeOpenTelemetryApiResolverPlugin(): Plugin {
+  let isKit3Promise: Promise<boolean> | undefined;
+
+  return {
+    name: 'sentry-sveltekit-opentelemetry-api',
+    enforce: 'pre',
+    // In dev, Kit's import resolves from Kit's own install location, where pnpm links the peer dep.
+    apply: 'build',
+    async resolveId(id, importer, options) {
+      // Skip our own re-export, in case it gets bundled, so it doesn't re-export itself.
+      if (id !== OTEL_API_ID || !options?.ssr || (importer && OTEL_API_REEXPORT_FILE_REGEX.test(importer))) {
+        return null;
+      }
+
+      isKit3Promise ??= isSvelteKit3(id => this.resolve(id, undefined, { skipSelf: true }));
+      if (!(await isKit3Promise)) {
+        return null;
+      }
+
+      return { id: OTEL_API_REEXPORT_ID, external: true };
+    },
+  };
+}
+
 /**
  * Whether to use the SvelteKit 3 (`$app/state`) variant, from the installed `@sveltejs/kit` version
  * (resolved via the bundler, not `process.cwd()`).

packages/sveltekit/test/vite/sentrySvelteKitPlugins.test.ts

@@ -1,3 +1,6 @@
+import * as fs from 'fs';
+import * as os from 'os';
+import * as path from 'path';
 import type { Plugin } from 'vite';
 import { describe, expect, it, vi } from 'vitest';
 import * as autoInstrument from '../../src/vite/autoInstrument';
@@ -42,9 +45,10 @@ describe('sentrySvelteKit()', () => {
     const plugins = await getSentrySvelteKitPlugins();
 
     expect(plugins).toBeInstanceOf(Array);
-    // 1 kit config resolver + 1 browser-tracing variant resolver + 1 auto instrument plugin
-    // + 1 global values injection plugin + 1 modified main plugin + 3 custom plugins
-    expect(plugins).toHaveLength(8);
+    // 1 kit config resolver + 1 browser-tracing variant resolver + 1 OpenTelemetry API resolver
+    // + 1 auto instrument plugin + 1 global values injection plugin + 1 modified main plugin
+    // + 3 custom plugins
+    expect(plugins).toHaveLength(9);
   });
 
   it('returns the custom sentry source maps upload plugin, unmodified sourcemaps plugins and the auto-instrument plugin by default', async () => {
@@ -55,6 +59,8 @@ describe('sentrySvelteKit()', () => {
       'sentry-sveltekit-kit-config-resolver',
       // browser-tracing variant resolver:
       'sentry-sveltekit-browser-tracing-variant',
+      // OpenTelemetry API resolver:
+      'sentry-sveltekit-opentelemetry-api',
       // auto instrument plugin:
       'sentry-auto-instrumentation',
       // global values injection plugin:
@@ -70,17 +76,17 @@ describe('sentrySvelteKit()', () => {
 
   it("doesn't return the sentry source maps plugins if autoUploadSourcemaps is `false`", async () => {
     const plugins = await getSentrySvelteKitPlugins({ autoUploadSourceMaps: false });
-    expect(plugins).toHaveLength(3); // kit config resolver + browser-tracing variant resolver + auto instrument
+    expect(plugins).toHaveLength(4); // kit config resolver + browser-tracing variant resolver + OpenTelemetry API resolver + auto instrument
   });
 
   it("doesn't return the sentry source maps plugins if `NODE_ENV` is development", async () => {
     const previousEnv = process.env.NODE_ENV;
 
     process.env.NODE_ENV = 'development';
     const plugins = await getSentrySvelteKitPlugins({ autoUploadSourceMaps: true, autoInstrument: true });
-    const instrumentPlugin = plugins[2];
+    const instrumentPlugin = plugins[3];
 
-    expect(plugins).toHaveLength(4); // kit config resolver + browser-tracing variant resolver + auto instrument + global values injection
+    expect(plugins).toHaveLength(5); // kit config resolver + browser-tracing variant resolver + OpenTelemetry API resolver + auto instrument + global values injection
     expect(instrumentPlugin?.name).toEqual('sentry-auto-instrumentation');
 
     process.env.NODE_ENV = previousEnv;
@@ -89,7 +95,7 @@ describe('sentrySvelteKit()', () => {
   it("doesn't return the auto instrument plugin if autoInstrument is `false`", async () => {
     const plugins = await getSentrySvelteKitPlugins({ autoInstrument: false });
     const pluginNames = plugins.map(plugin => plugin.name);
-    expect(plugins).toHaveLength(7); // kit config resolver + browser-tracing variant resolver + global values injection + 1 modified main plugin + 3 custom plugins
+    expect(plugins).toHaveLength(8); // kit config resolver + browser-tracing variant resolver + OpenTelemetry API resolver + global values injection + 1 modified main plugin + 3 custom plugins
     expect(pluginNames).not.toContain('sentry-auto-instrumentation');
   });
 
@@ -191,7 +197,7 @@ describe('sentrySvelteKit()', () => {
       // just to ignore the source maps plugin:
       autoUploadSourceMaps: false,
     });
-    const plugin = plugins[2]!;
+    const plugin = plugins[3]!;
 
     expect(plugin.name).toEqual('sentry-auto-instrumentation');
     expect(makePluginSpy).toHaveBeenCalledWith({
@@ -203,6 +209,55 @@ describe('sentrySvelteKit()', () => {
   });
 });
 
+describe('OpenTelemetry API resolver plugin', () => {
+  async function getResolver(kitVersion: string) {
+    const plugins = await getSentrySvelteKitPlugins({ autoUploadSourceMaps: false });
+    const plugin = plugins.find(p => p.name === 'sentry-sveltekit-opentelemetry-api')!;
+
+    const kitPackageJson = path.join(fs.mkdtempSync(path.join(os.tmpdir(), 'sentry-kit-')), 'package.json');
+    fs.writeFileSync(kitPackageJson, JSON.stringify({ version: kitVersion }));
+    const context = { resolve: vi.fn().mockResolvedValue({ id: kitPackageJson }) };
+
+    const resolveId = (id: string, importer: string | undefined, ssr = true) =>
+      // @ts-expect-error - minimal plugin context
+      plugin.resolveId.call(context, id, importer, { ssr });
+
+    return { plugin, resolveId };
+  }
+
+  it('only applies to builds', async () => {
+    const { plugin } = await getResolver('3.0.0');
+    expect(plugin.apply).toBe('build');
+  });
+
+  it('redirects `@opentelemetry/api` to the external re-export on SvelteKit 3', async () => {
+    const { resolveId } = await getResolver('3.0.0-next.28');
+
+    await expect(resolveId('@opentelemetry/api', '/app/node_modules/@sveltejs/kit/src/instance.js')).resolves.toEqual({
+      id: '@sentry/sveltekit/opentelemetry-api',
+      external: true,
+    });
+  });
+
+  it('leaves `@opentelemetry/api` alone on SvelteKit 2', async () => {
+    const { resolveId } = await getResolver('2.70.2');
+
+    await expect(resolveId('@opentelemetry/api', '/app/src/instrumentation.server.js')).resolves.toBeNull();
+  });
+
+  it('leaves client builds, other ids and the re-export itself alone', async () => {
+    const { resolveId } = await getResolver('3.0.0');
+
+    await expect(resolveId('@opentelemetry/api', '/app/src/hooks.client.js', false)).resolves.toBeNull();
+    await expect(
+      resolveId('@opentelemetry/api/experimental', '/app/src/instrumentation.server.js'),
+    ).resolves.toBeNull();
+    await expect(
+      resolveId('@opentelemetry/api', '/app/node_modules/@sentry/sveltekit/build/esm/opentelemetryApi.js'),
+    ).resolves.toBeNull();
+  });
+});
+
 describe('generateVitePluginOptions', () => {
   it('returns null if no relevant options are provided', () => {
     const options: SentrySvelteKitPluginOptions = {};