fix(tanstackstart-react): Fail the build when a fixed tunnelRoute collides with an app route, as on develop

Author: logaretm

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

@@ -54,6 +54,15 @@ export function normalizeTunnelRouteOptions(options: TunnelRouteOptions): Tunnel
   };
 }
 
+// `routeTree.gen.ts` quote style follows `tsr.config.json#quoteStyle` (`single` | `double`),
+// so we check both forms for each route-identifying key.
+const ROUTE_CONFLICT_KEYS = ['fullPath', 'path', 'id'] as const;
+
+function hasRouteConflict(source: string, tunnelPath: string): boolean {
+  const literals = [`'${tunnelPath}'`, `"${tunnelPath}"`];
+  return ROUTE_CONFLICT_KEYS.some(key => literals.some(literal => source.includes(`${key}: ${literal}`)));
+}
+
 /**
  * Tells the client SDK which tunnel to use. The server entry wrapper serves it.
  */
@@ -70,6 +79,17 @@ export function makeTunnelRoutePlugin(options: TunnelRouteOptions, debug?: boole
     config() {
       return { define: { __SENTRY_TANSTACKSTART_TUNNEL_ROUTE__: path ? JSON.stringify(path) : 'true' } };
     },
+    // The server entry wrapper answers POSTs to a fixed path before Start's routing, so an app route on that path
+    // would silently lose them.
+    transform(source, id) {
+      if (path && /[\\/]routeTree\.gen\.ts$/.test(id) && hasRouteConflict(source, path)) {
+        throw new Error(
+          `[@sentry/tanstackstart-react] Cannot register managed tunnel route "${path}" because an existing TanStack Start route already uses that path.`,
+        );
+      }
+
+      return null;
+    },
   };
 }
 

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

@@ -45,6 +45,28 @@ describe('tunnelRoute vite plugin', () => {
       define: { __SENTRY_TANSTACKSTART_TUNNEL_ROUTE__: 'true' },
     });
   });
+
+  it('fails when a static tunnel route conflicts with an existing route', () => {
+    const transform = (path: string, source: string): unknown =>
+      (makeTunnelRoutePlugin(path).transform as (source: string, id: string) => unknown)(
+        source,
+        '/app/src/routeTree.gen.ts',
+      );
+    const singleQuoted = "const MonitorRoute = MonitorRouteImport.update({\n  id: '/monitor',\n  path: '/monitor',";
+    const doubleQuoted = singleQuoted.replace(/'/g, '"');
+
+    expect(() => transform('/monitor', singleQuoted)).toThrow(
+      'Cannot register managed tunnel route "/monitor" because an existing TanStack Start route already uses that path.',
+    );
+    expect(() => transform('/monitor', doubleQuoted)).toThrow('already uses that path');
+    expect(transform('/other', singleQuoted)).toBeNull();
+    expect(
+      (makeTunnelRoutePlugin(true).transform as (s: string, id: string) => unknown)(
+        singleQuoted,
+        '/app/src/routeTree.gen.ts',
+      ),
+    ).toBeNull();
+  });
 });
 
 describe('server entry tunnel vite plugin', () => {