From 86ffdf4123cc734d8e730e26294c7d628054d6c9 Mon Sep 17 00:00:00 2001 From: Luca Forstner Date: Fri, 7 Jul 2023 13:58:42 +0200 Subject: [PATCH] fix(nextjs): Ignore `tunnelRoute` when doing static exports (#8471) --- packages/nextjs/src/config/types.ts | 2 ++ packages/nextjs/src/config/webpack.ts | 2 +- packages/nextjs/src/config/withSentryConfig.ts | 14 +++++++++++++- 3 files changed, 16 insertions(+), 2 deletions(-) diff --git a/packages/nextjs/src/config/types.ts b/packages/nextjs/src/config/types.ts index 28f70d62dc05..5bab88555056 100644 --- 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 index 6eac3d702d00..fd5b36f9a789 100644 --- 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 index c35e069eea1e..86f8c5a67031 100644 --- 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 {