add custom error handling and error tracer

.gitignore

@@ -43,3 +43,6 @@ bun.lockb
 /playwright/.cache/
 /playwright/.auth/
 /playwright/results
+
+# Sentry Config File
+.env.sentry-build-plugin

next.config.js

@@ -139,4 +139,51 @@ const nextConfig = {
   },
 }
 
-module.exports = nextConfig
+// Injected content via Sentry wizard below
+
+const { withSentryConfig } = require("@sentry/nextjs");
+
+module.exports = withSentryConfig(
+  nextConfig,
+  {
+    // For all available options, see:
+    // https://github.com/getsentry/sentry-webpack-plugin#options
+
+    org: "zgen",
+    project: "guildxyz",
+
+    // 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,
+
+    // Automatically annotate React components to show their full name in breadcrumbs and session replay
+    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",
+
+    // 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. (Does not yet work with App Router route handlers.)
+    // See the following for more information:
+    // https://docs.sentry.io/product/crons/
+    // https://vercel.com/docs/cron-jobs
+    automaticVercelMonitors: true,
+
+    sourcemaps: { deleteSourcemapsAfterUpload: true },
+  }
+);

package.json

@@ -30,6 +30,8 @@
     "@radix-ui/react-toggle": "^1.1.0",
     "@radix-ui/react-toggle-group": "^1.1.0",
     "@radix-ui/react-tooltip": "^1.1.4",
+    "@reflet/http": "^1.0.0",
+    "@sentry/nextjs": "^8",
     "@t3-oss/env-nextjs": "^0.11.1",
     "@tailwindcss/typography": "^0.5.15",
     "@tanstack/react-query": "^5.62.2",
@@ -48,6 +50,7 @@
     "react": "19.0.0-rc-66855b96-20241106",
     "react-canvas-confetti": "^2.0.7",
     "react-dom": "19.0.0-rc-66855b96-20241106",
+    "react-error-boundary": "^4.1.2",
     "react-hook-form": "^7.53.2",
     "react-markdown": "^9.0.1",
     "rehype-external-links": "^3.0.0",

sentry.client.config.ts

@@ -0,0 +1,28 @@
+// 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";
+
+Sentry.init({
+  dsn: "https://eba4a78ff99c793accdeb809346d12de@o4508437633171456.ingest.de.sentry.io/4508437781151824",
+
+  // Add optional integrations for additional features
+  integrations: [
+    Sentry.replayIntegration(),
+  ],
+
+  // Define how likely traces are sampled. Adjust this value in production, or use tracesSampler for greater control.
+  tracesSampleRate: 1,
+
+  // Define how likely Replay events are sampled.
+  // 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,
+
+  // Define how likely Replay events are sampled when an error occurs.
+  replaysOnErrorSampleRate: 1.0,
+
+  // Setting this option to true will print useful information to the console while you're setting up Sentry.
+  debug: false,
+});

sentry.edge.config.ts

@@ -0,0 +1,16 @@
+// This file configures the initialization of Sentry for edge features (middleware, edge routes, and so on).
+// 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";
+
+Sentry.init({
+  dsn: "https://eba4a78ff99c793accdeb809346d12de@o4508437633171456.ingest.de.sentry.io/4508437781151824",
+
+  // 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,
+});

sentry.server.config.ts

@@ -0,0 +1,15 @@
+// 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";
+
+Sentry.init({
+  dsn: "https://eba4a78ff99c793accdeb809346d12de@o4508437633171456.ingest.de.sentry.io/4508437781151824",
+
+  // 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,
+});

src/app/(dashboard)/[guildUrlName]/[pageUrlName]/page.tsx

@@ -1,16 +1,19 @@
 "use client";
 
+import { GenericError } from "@/components/GenericError";
 import { RequirementDisplayComponent } from "@/components/requirements/RequirementDisplayComponent";
 import { Button } from "@/components/ui/Button";
 import { Card } from "@/components/ui/Card";
 import { ScrollArea } from "@/components/ui/ScrollArea";
 import { Skeleton } from "@/components/ui/Skeleton";
+import { CustomError, FetchError } from "@/lib/error";
 import { rewardBatchOptions, roleBatchOptions } from "@/lib/options";
 import type { Schemas } from "@guildxyz/types";
 import { Lock } from "@phosphor-icons/react/dist/ssr";
 import { useSuspenseQuery } from "@tanstack/react-query";
 import { useParams } from "next/navigation";
 import { Suspense } from "react";
+import { ErrorBoundary } from "react-error-boundary";
 
 const GuildPage = () => {
   const { pageUrlName, guildUrlName } = useParams<{
@@ -26,19 +29,30 @@ const GuildPage = () => {
 
   return (
     <div className="my-4 space-y-4">
-      {roles.map((role) => (
+      {[...roles, { id: "fake" }].map((role) => (
         <Suspense
           fallback={<Skeleton className="h-40 w-full rounded-xl" />}
           key={role.id}
         >
-          <RoleCard role={role} />
+          <ErrorBoundary FallbackComponent={GenericError}>
+            {/* @ts-ignore: intentional error placed for testing */}
+            <RoleCard role={role} />
+          </ErrorBoundary>
         </Suspense>
       ))}
     </div>
   );
 };
 
 const RoleCard = ({ role }: { role: Schemas["Role"] }) => {
+  const blacklistedRoleName = "Member";
+  if (role.name === blacklistedRoleName) {
+    throw new FetchError({
+      recoverable: true,
+      message: `Failed to show ${role.name} role`,
+      cause: FetchError.expected`${{ roleName: role.name }} to not match ${{ blacklistedRoleName }}`,
+    });
+  }
   const { data: rewards } = useSuspenseQuery(
     rewardBatchOptions({ roleId: role.id }),
   );
@@ -63,7 +77,9 @@ const RoleCard = ({ role }: { role: Schemas["Role"] }) => {
           <ScrollArea className="mt-8 h-64 rounded-lg border pr-3">
             <div className="flex flex-col gap-4">
               {rewards.map((reward) => (
-                <Reward reward={reward} key={reward.id} />
+                <ErrorBoundary FallbackComponent={GenericError} key={reward.id}>
+                  <Reward reward={reward} />
+                </ErrorBoundary>
               ))}
             </div>
           </ScrollArea>
@@ -96,6 +112,9 @@ const RoleCard = ({ role }: { role: Schemas["Role"] }) => {
 };
 
 const Reward = ({ reward }: { reward: Schemas["Reward"] }) => {
+  if (reward.name === "Admin - update") {
+    throw new CustomError();
+  }
   return (
     <div className="border-b p-4 last:border-b-0">
       <div className="mb-2 font-medium">{reward.name}</div>

src/app/(dashboard)/[guildUrlName]/layout.tsx

@@ -9,7 +9,9 @@
   userOptions,
 } from "@/lib/options";
 import type { DynamicRoute } from "@/lib/types";
+import { Status } from "@reflet/http";
 import { HydrationBoundary, dehydrate } from "@tanstack/react-query";
+import { notFound } from "next/navigation";
 import { type PropsWithChildren, Suspense } from "react";
 import { GuildTabs, GuildTabsSkeleton } from "./components/GuildTabs";
 import { JoinButton } from "./components/JoinButton";
@@ -37,7 +39,7 @@
   );
   const roleBatchOptionsCollection = pageBatch?.map((page) => {
     return roleBatchOptions({
       pageIdLike: page.urlName!,
       guildIdLike: guildUrlName,
     });
   });
@@ -65,8 +67,11 @@
     }).queryKey,
   );
 
-  if (guild?.error || !guild?.data) {
-    throw new Error(`Failed to fetch guild ${guild?.error?.status || ""}`);
+  if (guild?.error?.partialResponse.status === Status.NotFound) {
+    notFound();
+  }
+  if (!guild?.data) {
+    throw new Error("Failed to fetch guild");
   }
 
   return (

src/app/(dashboard)/explorer/components/InfiniteScrollGuilds.tsx

@@ -51,7 +51,7 @@ export const InfiniteScrollGuilds = () => {
           ? // biome-ignore lint: it's safe to use index as key in this case
             [...Array(PAGE_SIZE)].map((_, i) => <GuildCardSkeleton key={i} />)
           : guilds.map((guild, _i) => (
-              <GuildCard key={guild.urlName} guild={guild} />
+              <GuildCard key={guild.id} guild={guild} />
             ))}
       </div>
       <div

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

@@ -0,0 +1,10 @@
+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");
+  // biome-ignore lint/correctness/noUnreachable: <explanation>
+  return NextResponse.json({ data: "Testing Sentry Error..." });
+}

src/app/error.tsx

@@ -7,7 +7,8 @@ const ErrorBoundary = ({
 }: {
   error: Error & { digest?: string; statusCode?: string };
 }) => {
-  console.log(error.cause);
+  if (error.cause) console.log(error.cause);
+
   return (
     <ErrorPage
       title="Something went wrong!"

src/app/global-error.tsx

@@ -0,0 +1,25 @@
+"use client";
+
+import * as Sentry from "@sentry/nextjs";
+import NextError from "next/error";
+import { useEffect } from "react";
+
+export default function GlobalError({
+  error,
+}: { error: Error & { digest?: string } }) {
+  useEffect(() => {
+    Sentry.captureException(error);
+  }, [error]);
+
+  return (
+    <html lang="en">
+      <body>
+        {/* `NextError` is the default Next.js error page component. Its type
+        definition requires a `statusCode` prop. However, since the App Router
+        does not expose status codes for errors, we simply pass 0 to render a
+        generic error message. */}
+        <NextError statusCode={0} />
+      </body>
+    </html>
+  );
+}

src/app/not-found.tsx

@@ -1,12 +1,14 @@
 import "server-only";
 import { ErrorPage } from "@/components/ErrorPage";
 
-export default function NotFound() {
+const NotFound = () => {
   return (
     <ErrorPage
       errorCode="404"
       title="Page not found"
       description="We couldn't find the page you were looking for"
     />
   );
-}
+};
+
+export default NotFound;

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

@@ -0,0 +1,86 @@
+"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" }}>
+          {/* biome-ignore lint/a11y/noSvgWithoutTitle: <explanation> */}
+          <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"
+            />
+          </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://zgen.sentry.io/issues/?project=4508437781151824">
+            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>
+  );
+}