Sentry (#157)

* . * add sentry * prettier * up packages * no edge sentry --------- Co-authored-by: Aslam H <iupin5212@gmail.com>
2026-01-12 12:20:23 +01:00 · 2024-09-10 14:18:37 +03:00
parent 711fe35e1a
commit 9e28aa5995
13 changed files with 212 additions and 8 deletions
--- a/.gitignore
+++ b/.gitignore
@@ -4,6 +4,7 @@
 .env*.local
 output
 dist
+.idea

 # ts
 node_modules
--- a/api/bun.lockb
+++ b/api/bun.lockb
--- a/api/package.json
+++ b/api/package.json
@@ -7,14 +7,14 @@
 		"dev": "encore run"
 	},
 	"devDependencies": {
-		"@types/node": "^20.5.7",
-		"typescript": "^5.2.2",
-		"vitest": "^1.5.0"
+		"@types/node": "^22.5.4",
+		"typescript": "^5.6.2",
+		"vitest": "^2.0.5"
 	},
 	"dependencies": {
-		"encore.dev": "^1.35.3"
+		"encore.dev": "^1.41.0"
 	},
 	"optionalDependencies": {
-		"@rollup/rollup-linux-x64-gnu": "^4.13.0"
+		"@rollup/rollup-linux-x64-gnu": "^4.21.2"
 	}
 }
--- a/bun.lockb
+++ b/bun.lockb
--- a/web/.gitignore
+++ b/web/.gitignore
@@ -35,4 +35,6 @@ yarn-error.log*
 *.tsbuildinfo
 next-env.d.ts

-.ronin
+# Sentry Config File
+.env.sentry-build-plugin
+.ronin
--- a/web/app/api/sentry-example-api/route.ts
+++ b/web/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..." })
+}
--- a/web/app/global-error.tsx
+++ b/web/app/global-error.tsx
@@ -0,0 +1,23 @@
+"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>
+			<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>
+	)
+}
--- a/web/app/sentry-example-page/page.tsx
+++ b/web/app/sentry-example-page/page.tsx
@@ -0,0 +1,82 @@
+"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 () => {
+						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.io/organizations/learn-anything/issues/?project=4507927630118912">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>
+	)
+}
--- a/web/instrumentation.ts
+++ b/web/instrumentation.ts
@@ -0,0 +1,5 @@
+export async function register() {
+	if (process.env.NEXT_RUNTIME === "nodejs") {
+		await import("./sentry.server.config")
+	}
+}
--- a/web/next.config.mjs
+++ b/web/next.config.mjs
@@ -1,3 +1,4 @@
+import { withSentryConfig } from "@sentry/nextjs"
 /** @type {import('next').NextConfig} */

 const isTauri = process.env.TAURI_ENV_DEBUG !== undefined
@@ -41,6 +42,45 @@ const webConfig = {

 const nextConfig = isTauri ? tauriConfig : webConfig

-console.log(`Using ${isTauri ? "Tauri" : "Web"} config`)
+// console.log(`Using ${isTauri ? "Tauri" : "Web"} config`)

-export default nextConfig
+export default withSentryConfig(nextConfig, {
+	// For all available options, see:
+	// https://github.com/getsentry/sentry-webpack-plugin#options
+
+	org: "learn-anything",
+	project: "website",
+	sentryUrl: "https://sentry.io/",
+
+	// 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
+})
--- a/web/package.json
+++ b/web/package.json
@@ -95,6 +95,7 @@
    "slugify": "^1.6.6",
    "sonner": "^1.5.0",
    "streaming-markdown": "^0.0.14",
+    "@sentry/nextjs": "^8.29.0",
    "tailwind-merge": "^2.5.2",
    "tailwindcss-animate": "^1.0.7",
    "vaul": "^0.9.2",
--- a/web/sentry.client.config.ts
+++ b/web/sentry.client.config.ts
@@ -0,0 +1,26 @@
+// 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://643e210c090ea97f641b7f5fb253f16b@o301266.ingest.us.sentry.io/4507927630118912",
+
+	// 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
+})
--- a/web/sentry.server.config.ts
+++ b/web/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://643e210c090ea97f641b7f5fb253f16b@o301266.ingest.us.sentry.io/4507927630118912",
+
+	// 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
+})