feat(dashboard): configure sentry for client and server

.gitignore

@@ -67,3 +67,6 @@ temp
 
 ./traefik/
 /user-config/
+
+# Sentry Config File
+.sentryclirc

Dockerfile

@@ -27,6 +27,11 @@ COPY ./next.config.mjs ./next.config.mjs
 COPY ./public ./public
 COPY ./tests ./tests
 
+# Sentry
+COPY ./sentry.client.config.ts ./sentry.client.config.ts
+COPY ./sentry.edge.config.ts ./sentry.edge.config.ts
+COPY ./sentry.server.config.ts ./sentry.server.config.ts
+
 RUN npm run build
 
 # APP

Dockerfile.dev

@@ -20,4 +20,9 @@ COPY ./tsconfig.json ./tsconfig.json
 COPY ./next.config.mjs ./next.config.mjs
 COPY ./public ./public
 
+# Sentry
+COPY ./sentry.client.config.ts ./sentry.client.config.ts
+COPY ./sentry.edge.config.ts ./sentry.edge.config.ts
+COPY ./sentry.server.config.ts ./sentry.server.config.ts
+
 CMD ["npm", "run", "dev"]

next.config.mjs

@@ -1,3 +1,4 @@
+import { withSentryConfig } from '@sentry/nextjs';
 /** @type {import('next').NextConfig} */
 const nextConfig = {
   swcMinify: true,
@@ -32,4 +33,20 @@ const nextConfig = {
   },
 };
 
-export default nextConfig;
+export default withSentryConfig(
+  nextConfig,
+  {
+    // https://github.com/getsentry/sentry-webpack-plugin#options
+    silent: false,
+    org: 'runtipi',
+    project: 'runtipi-nextjs',
+  },
+  {
+    // https://docs.sentry.io/platforms/javascript/guides/nextjs/manual-setup/
+    widenClientFileUpload: true,
+    transpileClientSDK: false,
+    tunnelRoute: '/errors',
+    hideSourceMaps: false,
+    disableLogger: true,
+  },
+);

sentry.client.config.ts

@@ -0,0 +1,22 @@
+import * as Sentry from '@sentry/nextjs';
+import { settingsSchema } from '@runtipi/shared/src/schemas/env-schemas';
+
+const inputElement = document.getElementById('client-settings') as HTMLInputElement | null;
+
+if (inputElement) {
+  try {
+    // Parse the input value
+    const parsedSettings = settingsSchema.parse(JSON.parse(inputElement.value));
+
+    if (parsedSettings.allowErrorMonitoring) {
+      Sentry.init({
+        environment: process.env.NODE_ENV,
+        dsn: 'https://7a73d72f886948478b55621e7b92c3c7@o4504242900238336.ingest.sentry.io/4504826587971584',
+        debug: process.env.NODE_ENV === 'development',
+      });
+    }
+  } catch (error) {
+    // eslint-disable-next-line no-console
+    console.error('Error parsing client settings:', error);
+  }
+}

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';
+import { getConfig } from '@/server/core/TipiConfig';
+
+if (getConfig().allowErrorMonitoring) {
+  Sentry.init({
+    environment: getConfig().NODE_ENV,
+    dsn: 'https://7a73d72f886948478b55621e7b92c3c7@o4504242900238336.ingest.sentry.io/4504826587971584',
+    tracesSampleRate: 1,
+    debug: getConfig().NODE_ENV === 'development',
+  });
+}

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';
+import { getConfig } from '@/server/core/TipiConfig';
+
+if (getConfig().allowErrorMonitoring) {
+  Sentry.init({
+    environment: getConfig().NODE_ENV,
+    dsn: 'https://7a73d72f886948478b55621e7b92c3c7@o4504242900238336.ingest.sentry.io/4504826587971584',
+    tracesSampleRate: 1,
+    debug: getConfig().NODE_ENV === 'development',
+  });
+}

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

@@ -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/global-error.jsx

@@ -0,0 +1,19 @@
+'use client';
+
+import React, { useEffect } from 'react';
+import * as Sentry from '@sentry/nextjs';
+import Error from 'next/error';
+
+export default function GlobalError({ error }) {
+  useEffect(() => {
+    Sentry.captureException(error);
+  }, [error]);
+
+  return (
+    <html lang="en">
+      <body>
+        <Error />
+      </body>
+    </html>
+  );
+}

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

@@ -0,0 +1,86 @@
+"use client";
+
+import Head from "next/head";
+import * as Sentry from "@sentry/nextjs";
+
+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 () => {
+            const transaction = Sentry.startTransaction({
+              name: "Example Frontend Transaction",
+            });
+
+            Sentry.configureScope((scope) => {
+              scope.setSpan(transaction);
+            });
+
+            try {
+              const res = await fetch("/api/sentry-example-api");
+              if (!res.ok) {
+                throw new Error("Sentry Example Frontend Error");
+              }
+            } finally {
+              transaction.finish();
+            }
+          }}
+        >
+          Throw error!
+        </button>
+
+        <p>
+          Next, look for the error on the{" "}
+          <a href="https://runtipi.sentry.io/issues/?project=4504826587971584">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>
+  );
+}