fix(nextjs): Ignore tunnelRoute when doing static exports (#8471)

getsentry · Jul 7, 2023 · 86ffdf4 · 86ffdf4
1 parent 97694e7
commit 86ffdf4
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 2 deletions.
diff --git a/packages/nextjs/src/config/types.ts b/packages/nextjs/src/config/types.ts
@@ -49,6 +49,8 @@ export type NextConfigObject = {
   publicRuntimeConfig?: { [key: string]: unknown };
   // File extensions that count as pages in the `pages/` directory
   pageExtensions?: string[];
+  // Whether Next.js should do a static export
+  output?: string;
   // Paths to reroute when requested
   rewrites?: () => Promise<
     | NextRewrite[]

diff --git a/packages/nextjs/src/config/webpack.ts b/packages/nextjs/src/config/webpack.ts
@@ -866,7 +866,7 @@ function addValueInjectionLoader(
   const isomorphicValues = {
     // `rewritesTunnel` set by the user in Next.js config
     __sentryRewritesTunnelPath__:
-      userSentryOptions.tunnelRoute !== undefined
+      userSentryOptions.tunnelRoute !== undefined && userNextConfig.output !== 'export'
         ? `${userNextConfig.basePath ?? ''}${userSentryOptions.tunnelRoute}`
         : undefined,
 

diff --git a/packages/nextjs/src/config/withSentryConfig.ts b/packages/nextjs/src/config/withSentryConfig.ts
@@ -8,6 +8,8 @@ import type {
 } from './types';
 import { constructWebpackConfigFunction } from './webpack';
 
+let showedExportModeTunnelWarning = false;
+
 /**
  * Add Sentry options to the config to be exported from the user's `next.config.js` file.
  *
@@ -48,7 +50,17 @@ function getFinalConfigObject(
   delete incomingUserNextConfigObject.sentry;
 
   if (userSentryOptions?.tunnelRoute) {
-    setUpTunnelRewriteRules(incomingUserNextConfigObject, userSentryOptions.tunnelRoute);
+    if (incomingUserNextConfigObject.output === 'export') {
+      if (!showedExportModeTunnelWarning) {
+        showedExportModeTunnelWarning = true;
+        // eslint-disable-next-line no-console
+        console.warn(
+          '[@sentry/nextjs] The Sentry Next.js SDK `tunnelRoute` option will not work in combination with Next.js static exports. The `tunnelRoute` option uses serverside features that cannot be accessed in export mode. If you still want to tunnel Sentry events, set up your own tunnel: https://docs.sentry.io/platforms/javascript/troubleshooting/#using-the-tunnel-option',
+        );
+      }
+    } else {
+      setUpTunnelRewriteRules(incomingUserNextConfigObject, userSentryOptions.tunnelRoute);
+    }
   }
 
   return {