Add a TanStack Start tunnel route helper

Author: nikolovlazar

packages/tanstackstart-react/src/server/index.ts

@@ -9,6 +9,7 @@ export { init } from './sdk';
 export { wrapFetchWithSentry } from './wrapFetchWithSentry';
 export { wrapMiddlewaresWithSentry } from './middleware';
 export { sentryGlobalRequestMiddleware, sentryGlobalFunctionMiddleware } from './globalMiddleware';
+export { createSentryTunnelRoute } from './tunnelRoute';
 
 /**
  * A no-op stub of the browser tracing integration for the server. Router setup code is shared between client and server,

packages/tanstackstart-react/src/server/tunnelRoute.ts

@@ -0,0 +1,43 @@
+import { handleTunnelRequest } from '@sentry/core';
+
+export interface CreateSentryTunnelRouteOptions {
+  allowedDsns: string[];
+}
+
+type SentryTunnelRouteHandlerContext = {
+  request: Request;
+};
+
+type SentryTunnelRoute = {
+  handlers: {
+    POST: (context: SentryTunnelRouteHandlerContext) => Promise<Response>;
+  };
+};
+
+/**
+ * Creates a TanStack Start server route configuration for tunneling Sentry envelopes.
+ *
+ * @example
+ * ```ts
+ * import { createFileRoute } from '@tanstack/react-router';
+ * import * as Sentry from '@sentry/tanstackstart-react';
+ *
+ * export const Route = createFileRoute('/monitoring')({
+ *   server: Sentry.createSentryTunnelRoute({
+ *     allowedDsns: ['https://public@o0.ingest.sentry.io/0'],
+ *   }),
+ * });
+ * ```
+ */
+export function createSentryTunnelRoute(options: CreateSentryTunnelRouteOptions): SentryTunnelRoute {
+  return {
+    handlers: {
+      POST: async ({ request }) => {
+        return handleTunnelRequest({
+          request,
+          allowedDsns: options.allowedDsns,
+        });
+      },
+    },
+  };
+}

packages/tanstackstart-react/test/server/tunnelRoute.test.ts

@@ -0,0 +1,48 @@
+import { afterEach, describe, expect, it, vi } from 'vitest';
+
+const handleTunnelRequestSpy = vi.fn();
+
+vi.mock('@sentry/core', async importOriginal => {
+  const original = await importOriginal();
+  return {
+    ...original,
+    handleTunnelRequest: (...args: unknown[]) => handleTunnelRequestSpy(...args),
+  };
+});
+
+const { createSentryTunnelRoute } = await import('../../src/server/tunnelRoute');
+
+describe('createSentryTunnelRoute', () => {
+  afterEach(() => {
+    vi.clearAllMocks();
+  });
+
+  it('returns a server route config with only a POST handler', () => {
+    const route = createSentryTunnelRoute({
+      allowedDsns: ['https://public@o0.ingest.sentry.io/0'],
+    });
+
+    expect(Object.keys(route.handlers)).toEqual(['POST']);
+    expect(route.handlers.POST).toBeTypeOf('function');
+  });
+
+  it('forwards the request and allowed DSNs to handleTunnelRequest', async () => {
+    const request = new Request('http://localhost:3000/monitoring', { method: 'POST', body: 'envelope' });
+    const allowedDsns = ['https://public@o0.ingest.sentry.io/0'];
+    const response = new Response('ok', { status: 200 });
+
+    handleTunnelRequestSpy.mockResolvedValueOnce(response);
+
+    const route = createSentryTunnelRoute({ allowedDsns });
+    const result = await route.handlers.POST({ request });
+
+    expect(handleTunnelRequestSpy).toHaveBeenCalledTimes(1);
+    const [options] = handleTunnelRequestSpy.mock.calls[0]!;
+    expect(options).toEqual({
+      request,
+      allowedDsns,
+    });
+    expect(options.allowedDsns).toBe(allowedDsns);
+    expect(result).toBe(response);
+  });
+});