fix(astro): Serve the managed tunnel under base on Cloudflare Workers

The server's tunnel base path only reached `@sentry/astro`'s own server init. On Workers the client comes from
`@sentry/cloudflare`, so the browser posted under `base` and got a 404. The server side of the tunnel options
module now goes through core's managed tunnel defaults, and the Worker entry imports it first.

Author: logaretm

dev-packages/e2e-tests/test-applications/astro-6-cf-workers/astro.config.mjs

@@ -4,8 +4,13 @@ import { defineConfig } from 'astro/config';
 import cloudflare from '@astrojs/cloudflare';
 import { sentryCloudflareVitePlugin } from '@sentry/cloudflare/vite';
 
+// The tunnel variant serves the app under a base path with trailing slashes to cover that the managed tunnel
+// follows both on Workers too.
+const tunnelVariant = !!process.env.PUBLIC_E2E_TEST_TUNNEL;
+
 // https://astro.build/config
 export default defineConfig({
+  ...(tunnelVariant && { base: '/docs', trailingSlash: 'always' }),
   integrations: [
     sentry({
       debug: true,

dev-packages/e2e-tests/test-applications/astro-6-cf-workers/instrument.server.js

@@ -4,6 +4,6 @@ export default defineCloudflareOptions(env => ({
   dsn: env.E2E_TEST_DSN,
   environment: 'qa',
   tracesSampleRate: 1.0,
-  tunnel: 'http://localhost:3031/', // proxy server
+  tunnel: import.meta.env.PUBLIC_E2E_TEST_TUNNEL ? true : 'http://localhost:3031/', // proxy server
   debug: true,
 }));

dev-packages/e2e-tests/test-applications/astro-6-cf-workers/package.json

@@ -10,7 +10,9 @@
     "start": "wrangler dev --var \"E2E_TEST_DSN:$E2E_TEST_DSN\" --port 3030",
     "test:build": "pnpm install && pnpm build",
     "test:assert": "TEST_ENV=production playwright test",
-    "cf-typegen": "wrangler types --include-runtime=false"
+    "cf-typegen": "wrangler types --include-runtime=false",
+    "test:build:tunnel": "pnpm install && PUBLIC_E2E_TEST_TUNNEL=1 PUBLIC_E2E_TEST_DSN=http://public@localhost:3031/1337 pnpm build",
+    "test:assert:tunnel": "PUBLIC_E2E_TEST_TUNNEL=1 E2E_TEST_DSN=http://public@localhost:3031/1337 TEST_ENV=production playwright test tunnel"
   },
   "dependencies": {
     "@astrojs/cloudflare": "^13.0.2",
@@ -24,5 +26,14 @@
   },
   "volta": {
     "extends": "../../package.json"
+  },
+  "sentryTest": {
+    "variants": [
+      {
+        "build-command": "pnpm test:build:tunnel",
+        "assert-command": "pnpm test:assert:tunnel",
+        "label": "astro-6-cf-workers (tunnel)"
+      }
+    ]
   }
 }

dev-packages/e2e-tests/test-applications/astro-6-cf-workers/sentry.client.config.js

@@ -4,7 +4,7 @@ Sentry.init({
   dsn: import.meta.env.PUBLIC_E2E_TEST_DSN,
   environment: 'qa',
   tracesSampleRate: 1.0,
-  tunnel: 'http://localhost:3031/', // proxy server
+  tunnel: import.meta.env.PUBLIC_E2E_TEST_TUNNEL ? true : 'http://localhost:3031/', // proxy server
   integrations: [
     Sentry.browserTracingIntegration({
       beforeStartSpan: opts => {

dev-packages/e2e-tests/test-applications/astro-6-cf-workers/tests/tunnel.test.ts

@@ -0,0 +1,39 @@
+import { expect, test } from '@playwright/test';
+import { getSpanOp, waitForStreamedSpan } from '@sentry-internal/test-utils';
+
+test.skip(!process.env.PUBLIC_E2E_TEST_TUNNEL, 'Only runs in the tunnel variant');
+
+const TUNNEL_PATH = /^\/docs\/[a-z0-9]{1,7}\/$/;
+
+test('answers the managed tunnel under the base path, without tunnel spans', async ({ page }) => {
+  const tunnelServerSpanPromise = waitForStreamedSpan(
+    'astro-6-cf-workers',
+    span =>
+      getSpanOp(span) === 'http.server' &&
+      /\/docs\/[a-z0-9]{1,7}\/?$/.test(
+        String(span.attributes['url.path']?.value ?? span.attributes['url.full']?.value ?? span.name),
+      ),
+  );
+  const tunnelResponsePromise = page.waitForResponse(
+    response => response.request().method() === 'POST' && TUNNEL_PATH.test(new URL(response.url()).pathname),
+  );
+
+  await page.goto('/docs/');
+  const tunnelResponse = await tunnelResponsePromise;
+
+  expect(tunnelResponse.status()).toBe(200);
+  expect(tunnelResponse.headers()['x-sentry-tunnel']).toBeDefined();
+
+  // Spans flush in order, so a tunnel span would arrive before this anchor.
+  const anchorSpanPromise = waitForStreamedSpan(
+    'astro-6-cf-workers',
+    span => getSpanOp(span) === 'http.server' && span.is_segment && span.name.includes('test-ssr'),
+  );
+  await page.request.get('/docs/test-ssr/');
+
+  const winner = await Promise.race([
+    tunnelServerSpanPromise.then(() => 'tunnel' as const),
+    anchorSpanPromise.then(() => 'anchor' as const),
+  ]);
+  expect(winner).toBe('anchor');
+});

packages/astro/src/integration/cloudflare.ts

@@ -39,7 +39,7 @@ export function sentryCloudflareNodeWarningPlugin(): VitePlugin {
 
 // The Worker entry module: `@astrojs/cloudflare` v12 builds its own virtual entry, and v13+ builds
 // through `@cloudflare/vite-plugin`, whose entry ends in `export default mod.default ?? {};`.
-const WORKER_ENTRY_IDS = ['astrojs-ssr-virtual-entry', 'virtual:cloudflare/worker-entry'];
+export const WORKER_ENTRY_IDS = ['astrojs-ssr-virtual-entry', 'virtual:cloudflare/worker-entry'];
 
 /**
  * A Vite plugin that ensures the Sentry server config is loaded at the

packages/astro/src/integration/middleware/index.ts

@@ -1,5 +1,9 @@
 import { handleRequest } from '../../server/middleware';
 
+// The one `@sentry/astro` entry that resolves to server code on every runtime, so the integration's virtual module
+// imports it from here.
+export { setManagedTunnelDefaults } from '@sentry/core/server';
+
 type MiddlewareNext = () => Promise<Response>;
 type MiddlewareHandler = (ctx: unknown, next: MiddlewareNext) => Promise<Response> | Response | Promise<void> | void;
 

packages/astro/src/integration/tunnel.ts

@@ -1,7 +1,7 @@
 import type { TunnelOptions } from '@sentry/core';
 import type { AstroConfig } from 'astro';
 import { TUNNEL_OPTIONS_GLOBAL } from '../tunnel';
-import type { VitePlugin } from './cloudflare';
+import { WORKER_ENTRY_IDS, type VitePlugin } from './cloudflare';
 
 const TUNNEL_OPTIONS_MODULE = 'virtual:@sentry/astro/tunnel-options';
 const RESOLVED_TUNNEL_OPTIONS_MODULE = `\0${TUNNEL_OPTIONS_MODULE}`;
@@ -19,14 +19,25 @@ export function getAstroTunnelOptions(config: Pick<AstroConfig, 'base' | 'traili
 /** Imported first in the injected init scripts, so the options are set before `Sentry.init` runs. */
 export const TUNNEL_OPTIONS_IMPORT = `import "${TUNNEL_OPTIONS_MODULE}";\n`;
 
-/** Serves the module that hands the tunnel options to the SDKs. */
+/**
+ * Serves the module that hands the tunnel options to the SDKs. On the server it goes through core's managed tunnel
+ * defaults, because the server client isn't always `@sentry/astro`'s: on Cloudflare Workers it's `@sentry/cloudflare`'s,
+ * created per request. The Worker entry imports the module first, so the defaults are set before any client exists.
+ */
 export function makeTunnelOptionsVitePlugin(tunnelOptions: TunnelOptions): VitePlugin {
   return {
     name: 'sentry-astro-tunnel-options',
     resolveId: id => (id === TUNNEL_OPTIONS_MODULE ? RESOLVED_TUNNEL_OPTIONS_MODULE : null),
-    load: id =>
-      id === RESOLVED_TUNNEL_OPTIONS_MODULE
-        ? `globalThis[${JSON.stringify(TUNNEL_OPTIONS_GLOBAL)}] = ${JSON.stringify(tunnelOptions)};`
-        : null,
+    load: (id, options) => {
+      if (id !== RESOLVED_TUNNEL_OPTIONS_MODULE) {
+        return null;
+      }
+
+      return options?.ssr
+        ? `import { setManagedTunnelDefaults } from '@sentry/astro/middleware';\nsetManagedTunnelDefaults(${JSON.stringify({ basePath: tunnelOptions.basePath })});`
+        : `globalThis[${JSON.stringify(TUNNEL_OPTIONS_GLOBAL)}] = ${JSON.stringify(tunnelOptions)};`;
+    },
+    transform: (code, id) =>
+      WORKER_ENTRY_IDS.some(entryId => id.includes(entryId)) ? TUNNEL_OPTIONS_IMPORT + code : null,
   };
 }

packages/astro/src/server/sdk.ts

@@ -2,7 +2,6 @@ import { HTTP_SERVER } from '@sentry/conventions/op';
 import { applySdkMetadata } from '@sentry/core';
 import type { NodeClient, NodeOptions } from '@sentry/node';
 import { init as initNodeSdk } from '@sentry/node';
-import { applyAstroTunnelOptions } from '../tunnel';
 
 /**
  *
@@ -14,7 +13,6 @@ export function init(options: NodeOptions): NodeClient | undefined {
   };
 
   applySdkMetadata(opts, 'astro', ['astro', 'node']);
-  applyAstroTunnelOptions(opts);
 
   opts.ignoreSpans = [
     ...(opts.ignoreSpans || []),