Merge pull request #285 from waldo-vision/build(web)-sentry-cleanup

Author: Huskydog9988

apps/web/package.json

@@ -21,8 +21,7 @@
     "@marsidev/react-turnstile": "0.1.2",
     "@next-auth/prisma-adapter": "^1.0.5",
     "@sentry/integrations": "^7.48.0",
-    "@sentry/nextjs": "^7.44.1",
-    "@sentry/node": "^7.48.0",
+    "@sentry/nextjs": "^7.48.0",
     "@sentry/profiling-node": "^0.3.0",
     "@tanstack/query-core": "^4.20.4",
     "@tanstack/react-query": "^4.28.0",

apps/web/pages/api/auth/[...nextauth].ts

@@ -67,8 +67,20 @@ export const authOptions = {
   ],
   callbacks: {
     async session(sessionCallback: SessionCallback) {
+      // create a span to track the time it takes to run this callback
+      const span = Sentry.getCurrentHub()
+        .getScope()
+        .getTransaction()
+        ?.startChild({
+          op: 'nextauth.session',
+        });
+
       const session = sessionCallback.session;
       const user = sessionCallback.user;
+
+      // set the user on the sentry scope
+      Sentry.getCurrentHub().getScope().setUser({ id: user.id });
+
       if (session.user) {
         session.user.id = user.id;
         if (user) {
@@ -86,13 +98,27 @@ export const authOptions = {
           session.user.blacklisted = userAccount?.user.blacklisted as boolean;
         }
       }
+      span?.finish();
       return session;
     },
     async redirect(redirectCallback: RedirectCallback) {
       // redirects to home page instead of auth page on signup/in/ or logout.
       return redirectCallback.baseUrl;
     },
     async signIn(signInCallback: signInCallback) {
+      // create a span to track the time it takes to run this callback
+      const span = Sentry.getCurrentHub()
+        .getScope()
+        .getTransaction()
+        ?.startChild({
+          op: 'nextauth.signIn',
+        });
+
+      // set the user id to the current span
+      Sentry.getCurrentHub()
+        .getScope()
+        .setUser({ id: signInCallback.account?.userId });
+
       if (signInCallback.account?.provider === 'github') {
         if (
           signInCallback.account.providerAccountId == RicanGHId ||
@@ -124,10 +150,13 @@ export const authOptions = {
             // return true here even if error because account does not exist...
             // but still allow user otherwise they would never be able to sign in
             return true;
+          } finally {
+            span?.finish();
           }
           return true;
         }
       }
+      span?.finish();
       return true;
     },
   },

apps/web/server/db/client.ts

@@ -1,4 +1,4 @@
-import * as Sentry from '@sentry/node';
+import * as Sentry from '@sentry/nextjs';
 import { PrismaClient } from 'database';
 
 declare global {

apps/web/server/trpc/router/gameplay.ts

@@ -154,14 +154,8 @@ export const gameplayRouter = router({
     )
     .output(GameplaySchema)
     .mutation(async ({ input, ctx }) => {
-      const transaction = Sentry.startTransaction({
-        op: 'createGameplay',
-        name: 'Create a new gameplay',
-      });
-
       const isPerson = await vUser(input.tsToken);
       if (!isPerson) {
-        transaction.finish();
         throw new TRPCError({
           code: 'BAD_REQUEST',
           message:
@@ -178,7 +172,6 @@ export const gameplayRouter = router({
 
       // this needs to be handled client side
       if (existingGameplay !== null) {
-        transaction.finish();
         throw new TRPCError({
           code: 'BAD_REQUEST',
           message: 'This youtube url has already been submitted.',
@@ -189,7 +182,6 @@ export const gameplayRouter = router({
         /^(?:https?:\/\/)?(?:m\.|www\.)?(?:youtu\.be\/|youtube\.com\/(?:embed\/|v\/|watch\?v=|watch\?.+&v=))((\w|-){11})(?:\S+)?$/;
 
       if (!input.youtubeUrl.match(isValid)) {
-        transaction.finish();
         throw new TRPCError({
           code: 'BAD_REQUEST',
           message: 'This url does not seem to be from youtube.',
@@ -222,10 +214,8 @@ export const gameplayRouter = router({
             cheats: input.cheats,
           },
         });
-        transaction.finish();
         return data;
       } catch (error) {
-        transaction.finish();
         Sentry.captureException(error);
         throw new TRPCError({
           code: 'INTERNAL_SERVER_ERROR',
@@ -475,10 +465,6 @@ export const gameplayRouter = router({
     )
     .output(ReviewItemsGameplaySchema)
     .query(async ({ input, ctx }) => {
-      const transaction = Sentry.startTransaction({
-        op: 'getReviewItems',
-        name: 'Get Review Items',
-      });
       const itemCount = await ctx.prisma.gameplay.count();
       const reviewItem = await ctx.prisma.gameplay.findMany({
         where: {
@@ -507,7 +493,6 @@ export const gameplayRouter = router({
         },
       });
       if (reviewItem[0] == null || reviewItem[0] == undefined) {
-        transaction.finish();
         throw new TRPCError({ code: 'NOT_FOUND' });
       } else {
         Object.assign(reviewItem[0], {
@@ -518,7 +503,6 @@ export const gameplayRouter = router({
           },
         });
         Object.assign(reviewItem[0], { total: itemCount });
-        transaction.finish();
         return reviewItem[0] as ReviewItemOutput;
       }
     }),
@@ -534,13 +518,8 @@ export const gameplayRouter = router({
     )
     .output(z.object({ message: z.string() }))
     .mutation(async ({ input, ctx }) => {
-      const transaction = Sentry.startTransaction({
-        op: 'review',
-        name: 'Review',
-      });
       const isPerson = await vUser(input.tsToken);
       if (!isPerson) {
-        transaction.finish();
         throw new TRPCError({
           code: 'BAD_REQUEST',
           message:
@@ -558,14 +537,11 @@ export const gameplayRouter = router({
         },
       });
       if (!footageVote) {
-        transaction.finish();
         throw new TRPCError({
           code: 'NOT_FOUND',
           message: `Could not find a gameplay document with id:${input.gameplayId}.`,
         });
       }
-
-      transaction.finish();
       return { message: 'Updated the gameplay document successfully.' };
     }),
 });

apps/web/server/trpc/router/site.ts

@@ -30,24 +30,18 @@ export const siteRouter = router({
       }),
     )
     .query(async ({ input, ctx }) => {
-      const transaction = Sentry.startTransaction({
-        op: 'getPageData',
-        name: 'Get Page Data',
-      });
       const pageData = await ctx.prisma.waldoPage.findFirst({
         where: {
           name: input.name,
         },
       });
       if (pageData == null) {
-        transaction.finish();
         throw new TRPCError({
           code: 'NOT_FOUND',
           message: 'Waldo Vision Page not found in the database.',
         });
       }
       // no error checking because the docs will never be deleted.
-      transaction.finish();
       return pageData;
     }),
   getSiteData: publicProcedure
@@ -73,10 +67,6 @@ export const siteRouter = router({
       }),
     )
     .query(async ({ input, ctx }) => {
-      const transaction = Sentry.startTransaction({
-        op: 'getSiteData',
-        name: 'Get Site Data',
-      });
       const siteData = await ctx.prisma.waldoSite.findUnique({
         where: {
           name: input.siteName,
@@ -88,7 +78,6 @@ export const siteRouter = router({
           message: 'Waldo Vision Page not found in the database.',
         });
       }
-      transaction.finish();
       return siteData;
     }),
   updatePage: protectedProcedure

apps/web/server/trpc/trpc.ts

@@ -4,7 +4,7 @@ import { OpenApiMeta } from 'trpc-openapi';
 import { type Context } from './context';
 import { compareKeyAgainstHash } from '@server/utils/apiHelper';
 // import * as Sentry from '@sentry/nextjs';
-import * as Sentry from '@sentry/node';
+import * as Sentry from '@sentry/nextjs';
 
 const t = initTRPC
   .context<Context>()
@@ -18,6 +18,7 @@ const t = initTRPC
 
 export const router = t.router;
 
+// create a sentry transaction/span for each endpoint
 const sentryMiddleware = t.middleware(
   Sentry.Handlers.trpcMiddleware({
     attachRpcInput: true,
@@ -40,7 +41,9 @@ const isAuthed = t.middleware(async ({ ctx, next }) => {
 
   if (ctx.session.user.blacklisted) throw new TRPCError({ code: 'FORBIDDEN' });
 
-  Sentry.setUser({ id: ctx.session.user.id });
+  // set the user on the sentry scope
+  // so we can track effected users
+  Sentry.getCurrentHub().getScope().setUser({ id: ctx.session.user.id });
 
   return next({
     ctx: {
@@ -110,7 +113,7 @@ const isApiAuthed = t.middleware(async ({ ctx, next }) => {
   });
 });
 
-export const apiProcedure = t.procedure.use(isApiAuthed);
+export const apiProcedure = t.procedure.use(sentryMiddleware).use(isApiAuthed);
 
 export const protectedProcedure = t.procedure
   .use(sentryMiddleware)