feat(nextjs): Add note about tunnelRoute and Next.js middleware inc…

…ompatibility (#544)
getsentry · Mar 5, 2024 · f54094d · f54094d
1 parent b60907c
commit f54094d
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## Unreleased
+
+- Add note about `tunnelRoute` and Next.js middleware incompatibility (#544)
+
 ## 3.20.5
 
 - fix: Update `@clack/core` to fix selection error on Windows (#539)

diff --git a/src/nextjs/templates.ts b/src/nextjs/templates.ts
@@ -28,7 +28,9 @@ export function getNextjsSentryBuildOptionsTemplate(): string {
     // Transpiles SDK to be compatible with IE11 (increases bundle size)
     transpileClientSDK: true,
 
-    // Routes browser requests to Sentry through a Next.js rewrite to circumvent ad-blockers (increases server load)
+    // Routes browser requests to Sentry through a Next.js rewrite to circumvent ad-blockers. (increases server load)
+    // Note: Check that the configured route will not match with your Next.js middleware, otherwise reporting of client-
+    // side errors will fail.
     tunnelRoute: "/monitoring",
 
     // Hides source maps from generated client bundles