Config @sentry/nextjs (#1411)

* Config @sentry/nextjs

* Upgrade @sentry/nextjs to v8

* Update CORS config

* Add  sentry tunnelRoute

.gitignore

@@ -45,3 +45,6 @@ next-env.d.ts
 /src/app/blog/[blogId]/data.json
 /src/assets/blog/main.data.json
 /src/assets/blog/research.data.json
+
+# Sentry Config File
+.env.sentry-build-plugin

next.config.mjs

@@ -1,3 +1,4 @@
+import {withSentryConfig} from "@sentry/nextjs";
 /** @type {import('next').NextConfig} */
 
 // eslint-disable-next-line prettier/prettier
@@ -197,12 +198,36 @@ const nextConfig = {
 // })
 
 const withMDX = createMDX({
-  // Add markdown plugins here, as desired
   options: {
     remarkPlugins: [remarkGfm, remarkMath],
     rehypePlugins: [rehypeKatex, rehypeRaw],
   },
 })
 
 // Merge MDX config with Next.js config
-export default withMDX(nextConfig)
+const configWithMDX = withMDX(nextConfig)
+
+// Add Sentry configuration
+export default withSentryConfig(configWithMDX, {
+  sentryUrl: process.env.SENTRY_URL,
+  org: process.env.SENTRY_ORG,
+  project: process.env.SENTRY_PROJECT,
+  authToken: process.env.SENTRY_AUTH_TOKEN,
+
+  // Only print logs for uploading source maps in CI
+  silent: !process.env.CI,
+
+  // Upload a larger set of source maps for prettier stack traces (increases build time)
+  widenClientFileUpload: true,
+
+  // Hides source maps from generated client bundles
+  hideSourceMaps: true,
+
+  // Automatically tree-shake Sentry logger statements to reduce bundle size
+  disableLogger: true,
+
+  // Enables automatic instrumentation of Vercel Cron Monitors
+  automaticVercelMonitors: true,
+
+  tunnelRoute: "/monitoring",
+})

package.json

@@ -29,7 +29,7 @@
     "@next/mdx": "^15.1.5",
     "@next/third-parties": "^15.1.5",
     "@rainbow-me/rainbowkit": "^2.1.2",
-    "@sentry/nextjs": "^7.95.0",
+    "@sentry/nextjs": "^8",
     "@tailwindcss/postcss": "^4.0.6",
     "@tanstack/react-query": "^5.55.3",
     "@tanstack/react-virtual": "^3.11.2",

sentry.client.config.ts

@@ -1,55 +1,56 @@
 // This file configures the initialization of Sentry on the client.
 // The config you add here will be used whenever a users loads a page in their browser.
 // https://docs.sentry.io/platforms/javascript/guides/nextjs/
-// import * as Sentry from "@sentry/nextjs"
-
-window.onerror = function (message, source, lineno, colno, error) {
-  console.log("Global error captured:", error)
-}
-
-window.addEventListener("unhandledrejection", function (event) {
-  console.log("Unhandled rejection captured:", event.reason)
+import * as Sentry from "@sentry/nextjs"
+
+Sentry.init({
+  enabled: ["Staging", "Sepolia", "Mainnet"].includes(process.env.NEXT_PUBLIC_SCROLL_ENVIRONMENT),
+  environment: process.env.NEXT_PUBLIC_SCROLL_ENVIRONMENT,
+  dsn: process.env.NEXT_PUBLIC_SENTRY_DSN,
+  release: process.env.NEXT_PUBLIC_VERSION,
+  autoSessionTracking: false,
+  allowUrls: [/scroll\.io/, /localhost/, /vercel\.app/],
+
+  // Define how likely traces are sampled. Adjust this value in production, or use tracesSampler for greater control.
+  tracesSampleRate: 1,
+
+  // Setting this option to true will print useful information to the console while you're setting up Sentry.
+  debug: false,
+
+  // Ignore specific error messages
+  ignoreErrors: [
+    // MetaMask and other wallet plugin common errors
+    "MetaMask",
+    "Non-Error promise rejection captured",
+    "User rejected the request",
+    "User denied transaction signature",
+    // Extension injected errors
+    "Extension context invalidated",
+    "The message port closed before a response was received",
+    "Failed to fetch",
+    // RPC related errors
+    "Internal JSON-RPC error",
+    "JsonRpcEngine",
+    // Common Web3 errors
+    "User denied message signature",
+    "Transaction was rejected",
+  ],
+
+  // Ignore errors from specific sources
+  denyUrls: [
+    // Common wallet extension sources
+    /extensions\//i,
+    /^chrome:\/\//i,
+    /^chrome-extension:\/\//i,
+    /^moz-extension:\/\//i,
+  ],
+
+  // Only capture errors we really care about
+  beforeSend(event) {
+    // Return null if error comes from extension to prevent sending to Sentry
+    if (event.exception?.values?.[0]?.stacktrace?.frames?.some(frame => frame.filename?.includes("extension://"))) {
+      return null
+    }
+    return event
+  },
 })
-
-// Sentry.init({
-//   enabled: ["Staging", "Sepolia", "Mainnet"].includes(process.env.NEXT_PUBLIC_SCROLL_ENVIRONMENT),
-//   environment: process.env.NEXT_PUBLIC_SCROLL_ENVIRONMENT,
-
-//   dsn: process.env.NEXT_PUBLIC_SENTRY_DSN,
-//   release: process.env.NEXT_PUBLIC_VERSION,
-//   autoSessionTracking: false,
-//   // Adjust this value in production, or use tracesSampler for greater control
-//   tracesSampleRate: 1,
-
-//   // Setting this option to true will print useful information to the console while you're setting up Sentry.
-//   debug: false,
-
-//   replaysOnErrorSampleRate: 1.0,
-
-//   // This sets the sample rate to be 10%. You may want this to be 100% while
-//   // in development and sample at a lower rate in production
-//   replaysSessionSampleRate: 0.1,
-
-//   // You can remove this option if you're not planning to use the Sentry Session Replay feature:
-//   integrations: [
-//     new Sentry.Integrations.Breadcrumbs({
-//       console: false,
-//       dom: false,
-//       fetch: false,
-//       history: false,
-//       sentry: false,
-//       xhr: false,
-//     }),
-//     new Sentry.Replay({
-//       // Additional Replay configuration goes in here, for example:
-//       maskAllText: true,
-//       blockAllMedia: true,
-//     }),
-//   ],
-//   beforeSend(event) {
-//     if (!event.exception) {
-//       return null
-//     }
-//     return event
-//   },
-// })

sentry.edge.config.ts

@@ -2,16 +2,14 @@
 // The config you add here will be used whenever one of the edge features is loaded.
 // Note that this config is unrelated to the Vercel Edge Runtime and is also required when running locally.
 // https://docs.sentry.io/platforms/javascript/guides/nextjs/
-// import * as Sentry from "@sentry/nextjs"
+import * as Sentry from "@sentry/nextjs"
 
-// Sentry.init({
-//   enabled: ["Sepolia", "Mainnet"].includes(process.env.NEXT_PUBLIC_SCROLL_ENVIRONMENT),
+Sentry.init({
+  enabled: ["Sepolia", "Mainnet"].includes(process.env.NEXT_PUBLIC_SCROLL_ENVIRONMENT),
+  dsn: process.env.NEXT_PUBLIC_SENTRY_DSN,
+  // Define how likely traces are sampled. Adjust this value in production, or use tracesSampler for greater control.
+  tracesSampleRate: 1,
 
-//   dsn: process.env.NEXT_PUBLIC_SENTRY_DSN,
-
-//   // Adjust this value in production, or use tracesSampler for greater control
-//   tracesSampleRate: 1,
-
-//   // Setting this option to true will print useful information to the console while you're setting up Sentry.
-//   debug: false,
-// })
+  // Setting this option to true will print useful information to the console while you're setting up Sentry.
+  debug: false,
+})

sentry.server.config.ts

@@ -1,16 +1,14 @@
 // This file configures the initialization of Sentry on the server.
 // The config you add here will be used whenever the server handles a request.
 // https://docs.sentry.io/platforms/javascript/guides/nextjs/
-// import * as Sentry from "@sentry/nextjs"
+import * as Sentry from "@sentry/nextjs"
 
-// Sentry.init({
-//   enabled: ["Sepolia", "Mainnet"].includes(process.env.NEXT_PUBLIC_SCROLL_ENVIRONMENT),
+Sentry.init({
+  enabled: ["Sepolia", "Mainnet"].includes(process.env.NEXT_PUBLIC_SCROLL_ENVIRONMENT),
+  dsn: process.env.NEXT_PUBLIC_SENTRY_DSN,
+  // Define how likely traces are sampled. Adjust this value in production, or use tracesSampler for greater control.
+  tracesSampleRate: 1,
 
-//   dsn: process.env.NEXT_PUBLIC_SENTRY_DSN,
-
-//   // Adjust this value in production, or use tracesSampler for greater control
-//   tracesSampleRate: 1,
-
-//   // Setting this option to true will print useful information to the console while you're setting up Sentry.
-//   debug: false,
-// })
+  // Setting this option to true will print useful information to the console while you're setting up Sentry.
+  debug: false,
+})

src/app/api/sentry-example-api/route.ts

@@ -0,0 +1,9 @@
+import { NextResponse } from "next/server"
+
+export const dynamic = "force-dynamic"
+
+// A faulty API route to test Sentry's error monitoring
+export function GET() {
+  throw new Error("Sentry Example API Route Error")
+  return NextResponse.json({ data: "Testing Sentry Error..." })
+}

src/app/sentry-example-page/page.tsx

@@ -0,0 +1,79 @@
+"use client"
+
+import * as Sentry from "@sentry/nextjs"
+import Head from "next/head"
+
+export default function Page() {
+  return (
+    <div>
+      <Head>
+        <title>Sentry Onboarding</title>
+        <meta name="description" content="Test Sentry for your Next.js app!" />
+      </Head>
+
+      <main
+        style={{
+          minHeight: "100vh",
+          display: "flex",
+          flexDirection: "column",
+          justifyContent: "center",
+          alignItems: "center",
+        }}
+      >
+        <h1 style={{ fontSize: "4rem", margin: "14px 0" }}>
+          <svg
+            style={{
+              height: "1em",
+            }}
+            xmlns="http://www.w3.org/2000/svg"
+            viewBox="0 0 200 44"
+          >
+            <path
+              fill="currentColor"
+              d="M124.32,28.28,109.56,9.22h-3.68V34.77h3.73V15.19l15.18,19.58h3.26V9.22h-3.73ZM87.15,23.54h13.23V20.22H87.14V12.53h14.93V9.21H83.34V34.77h18.92V31.45H87.14ZM71.59,20.3h0C66.44,19.06,65,18.08,65,15.7c0-2.14,1.89-3.59,4.71-3.59a12.06,12.06,0,0,1,7.07,2.55l2-2.83a14.1,14.1,0,0,0-9-3c-5.06,0-8.59,3-8.59,7.27,0,4.6,3,6.19,8.46,7.52C74.51,24.74,76,25.78,76,28.11s-2,3.77-5.09,3.77a12.34,12.34,0,0,1-8.3-3.26l-2.25,2.69a15.94,15.94,0,0,0,10.42,3.85c5.48,0,9-2.95,9-7.51C79.75,23.79,77.47,21.72,71.59,20.3ZM195.7,9.22l-7.69,12-7.64-12h-4.46L186,24.67V34.78h3.84V24.55L200,9.22Zm-64.63,3.46h8.37v22.1h3.84V12.68h8.37V9.22H131.08ZM169.41,24.8c3.86-1.07,6-3.77,6-7.63,0-4.91-3.59-8-9.38-8H154.67V34.76h3.8V25.58h6.45l6.48,9.2h4.44l-7-9.82Zm-10.95-2.5V12.6h7.17c3.74,0,5.88,1.77,5.88,4.84s-2.29,4.86-5.84,4.86Z M29,2.26a4.67,4.67,0,0,0-8,0L14.42,13.53A32.21,32.21,0,0,1,32.17,40.19H27.55A27.68,27.68,0,0,0,12.09,17.47L6,28a15.92,15.92,0,0,1,9.23,12.17H4.62A.76.76,0,0,1,4,39.06l2.94-5a10.74,10.74,0,0,0-3.36-1.9l-2.91,5a4.54,4.54,0,0,0,1.69,6.24A4.66,4.66,0,0,0,4.62,44H19.15a19.4,19.4,0,0,0-8-17.31l2.31-4A23.87,23.87,0,0,1,23.76,44H36.07a35.88,35.88,0,0,0-16.41-31.8l4.67-8a.77.77,0,0,1,1.05-.27c.53.29,20.29,34.77,20.66,35.17a.76.76,0,0,1-.68,1.13H40.6q.09,1.91,0,3.81h4.78A4.59,4.59,0,0,0,50,39.43a4.49,4.49,0,0,0-.62-2.28Z"
+            ></path>
+          </svg>
+        </h1>
+
+        <p>Get started by sending us a sample error:</p>
+        <button
+          type="button"
+          style={{
+            padding: "12px",
+            cursor: "pointer",
+            backgroundColor: "#AD6CAA",
+            borderRadius: "4px",
+            border: "none",
+            color: "white",
+            fontSize: "14px",
+            margin: "18px",
+          }}
+          onClick={async () => {
+            await Sentry.startSpan(
+              {
+                name: "Example Frontend Span",
+                op: "test",
+              },
+              async () => {
+                const res = await fetch("/api/sentry-example-api")
+                if (!res.ok) {
+                  throw new Error("Sentry Example Frontend Error")
+                }
+              },
+            )
+          }}
+        >
+          Throw error!
+        </button>
+
+        <p>
+          Next, look for the error on the <a href="https://sentry.scroll.io/organizations/scroll/issues/?project=2">Issues Page</a>.
+        </p>
+        <p style={{ marginTop: "24px" }}>
+          For more information, see{" "}
+          <a href="https://docs.sentry.io/platforms/javascript/guides/nextjs/">https://docs.sentry.io/platforms/javascript/guides/nextjs/</a>
+        </p>
+      </main>
+    </div>
+  )
+}

src/instrumentation.ts

@@ -0,0 +1,13 @@
+import * as Sentry from "@sentry/nextjs"
+
+export async function register() {
+  if (process.env.NEXT_RUNTIME === "nodejs") {
+    await import("../sentry.server.config")
+  }
+
+  if (process.env.NEXT_RUNTIME === "edge") {
+    await import("../sentry.edge.config")
+  }
+}
+
+export const onRequestError = Sentry.captureRequestError