fix: disable sentry when debugging with vscode

Author: ixartz

.vscode/launch.json

@@ -6,13 +6,20 @@
   "configurations": [
     {
       "name": "Next.js: debug full stack",
-      "type": "node-terminal",
+      "type": "node",
       "request": "launch",
-      "command": "npm run dev",
+      "program": "${workspaceFolder}/node_modules/next/dist/bin/next",
+      "runtimeArgs": ["--inspect"],
+      "skipFiles": ["<node_internals>/**"],
+      "env": {
+        "NEXT_PUBLIC_SENTRY_DISABLED": "true"
+      },
       "serverReadyAction": {
+        "action": "debugWithChrome",
+        "killOnServerStop": true,
         "pattern": "- Local:.+(https?://.+)",
         "uriFormat": "%s",
-        "action": "debugWithChrome"
+        "webRoot": "${workspaceFolder}"
       }
     }
   ]

next.config.ts

@@ -5,7 +5,7 @@ import createNextIntlPlugin from 'next-intl/plugin';
 import './src/libs/Env';
 
 // Define the base Next.js configuration
-let nextConfig: NextConfig = {
+const baseConfig: NextConfig = {
   eslint: {
     dirs: ['.'],
   },
@@ -15,46 +15,49 @@ let nextConfig: NextConfig = {
 };
 
 // Initialize the Next-Intl plugin
-nextConfig = createNextIntlPlugin('./src/libs/i18n.ts')(nextConfig);
+let configWithPlugins = createNextIntlPlugin('./src/libs/i18n.ts')(baseConfig);
 
 // Conditionally enable bundle analysis
 if (process.env.ANALYZE === 'true') {
-  nextConfig = withBundleAnalyzer()(nextConfig);
+  configWithPlugins = withBundleAnalyzer()(configWithPlugins);
 }
 
-// Sentry configuration
-const sentryOptions = {
-  // For all available options, see:
-  // https://www.npmjs.com/package/@sentry/webpack-plugin#options
-  // FIXME: Add your Sentry organization and project names
-  org: 'nextjs-boilerplate-org',
-  project: 'nextjs-boilerplate',
-
-  // Only print logs for uploading source maps in CI
-  silent: !process.env.CI,
-
-  // For all available options, see:
-  // https://docs.sentry.io/platforms/javascript/guides/nextjs/manual-setup/
-
-  // Upload a larger set of source maps for prettier stack traces (increases build time)
-  widenClientFileUpload: true,
-
-  // Upload a larger set of source maps for prettier stack traces (increases build time)
-  reactComponentAnnotation: {
-    enabled: true,
-  },
-
-  // Route browser requests to Sentry through a Next.js rewrite to circumvent ad-blockers.
-  // This can increase your server load as well as your hosting bill.
-  // Note: Check that the configured route will not match with your Next.js middleware, otherwise reporting of client-
-  // side errors will fail.
-  tunnelRoute: '/monitoring',
-
-  // Automatically tree-shake Sentry logger statements to reduce bundle size
-  disableLogger: true,
-
-  // Disable Sentry telemetry
-  telemetry: false,
-};
+// Conditionally enable Sentry configuration
+if (!process.env.NEXT_PUBLIC_SENTRY_DISABLED) {
+  configWithPlugins = withSentryConfig(configWithPlugins, {
+    // For all available options, see:
+    // https://www.npmjs.com/package/@sentry/webpack-plugin#options
+    // FIXME: Add your Sentry organization and project names
+    org: 'nextjs-boilerplate-org',
+    project: 'nextjs-boilerplate',
+
+    // Only print logs for uploading source maps in CI
+    silent: !process.env.CI,
+
+    // For all available options, see:
+    // https://docs.sentry.io/platforms/javascript/guides/nextjs/manual-setup/
+
+    // Upload a larger set of source maps for prettier stack traces (increases build time)
+    widenClientFileUpload: true,
+
+    // Upload a larger set of source maps for prettier stack traces (increases build time)
+    reactComponentAnnotation: {
+      enabled: true,
+    },
+
+    // Route browser requests to Sentry through a Next.js rewrite to circumvent ad-blockers.
+    // This can increase your server load as well as your hosting bill.
+    // Note: Check that the configured route will not match with your Next.js middleware, otherwise reporting of client-
+    // side errors will fail.
+    tunnelRoute: '/monitoring',
+
+    // Automatically tree-shake Sentry logger statements to reduce bundle size
+    disableLogger: true,
+
+    // Disable Sentry telemetry
+    telemetry: false,
+  });
+}
 
-export default withSentryConfig(nextConfig, sentryOptions);
+const nextConfig = configWithPlugins;
+export default nextConfig;

src/instrumentation.ts

@@ -18,14 +18,16 @@ const sentryOptions: Sentry.NodeOptions | Sentry.EdgeOptions = {
 };
 
 export async function register() {
-  if (process.env.NEXT_RUNTIME === 'nodejs') {
+  if (!process.env.NEXT_PUBLIC_SENTRY_DISABLED) {
+    if (process.env.NEXT_RUNTIME === 'nodejs') {
     // Node.js Sentry configuration
-    Sentry.init(sentryOptions);
-  }
+      Sentry.init(sentryOptions);
+    }
 
-  if (process.env.NEXT_RUNTIME === 'edge') {
+    if (process.env.NEXT_RUNTIME === 'edge') {
     // Edge Sentry configuration
-    Sentry.init(sentryOptions);
+      Sentry.init(sentryOptions);
+    }
   }
 }