From 1af3caa8cc4592405c0e1897e5c5d44342163b49 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Omar=20L=C3=B3pez?= Date: Wed, 22 Jan 2025 13:52:09 -0700 Subject: [PATCH] refactor: better observability in api routes (#18810) Co-authored-by: Keith Williams --- apps/web/pages/api/book/event.ts | 3 +-- packages/lib/server/defaultResponder.ts | 11 +++++++++-- packages/lib/server/getServerErrorFromUnknown.ts | 7 +++++++ 3 files changed, 17 insertions(+), 4 deletions(-) diff --git a/apps/web/pages/api/book/event.ts b/apps/web/pages/api/book/event.ts index 222e675fa7..58477b43cd 100644 --- a/apps/web/pages/api/book/event.ts +++ b/apps/web/pages/api/book/event.ts @@ -1,4 +1,3 @@ -import { wrapApiHandlerWithSentry } from "@sentry/nextjs"; import type { NextApiRequest, NextApiResponse } from "next"; import { getServerSession } from "@calcom/features/auth/lib/getServerSession"; @@ -30,4 +29,4 @@ async function handler(req: NextApiRequest & { userId?: number }, res: NextApiRe return booking; } -export default defaultResponder(wrapApiHandlerWithSentry(handler, "/api/book/event")); +export default defaultResponder(handler, "/api/book/event"); diff --git a/packages/lib/server/defaultResponder.ts b/packages/lib/server/defaultResponder.ts index 24fafe6c68..5b5106187a 100644 --- a/packages/lib/server/defaultResponder.ts +++ b/packages/lib/server/defaultResponder.ts @@ -1,3 +1,4 @@ +import { wrapApiHandlerWithSentry } from "@sentry/nextjs"; import type { NextApiRequest, NextApiResponse } from "next"; import { getServerErrorFromUnknown } from "./getServerErrorFromUnknown"; @@ -6,12 +7,18 @@ import { performance } from "./perfObserver"; type Handle = (req: NextApiRequest, res: NextApiResponse) => Promise; /** Allows us to get type inference from API handler responses */ -export function defaultResponder(f: Handle) { +export function defaultResponder( + f: Handle, + /** If set we will wrap the handle with sentry tracing */ + endpointRoute?: string +) { return async (req: NextApiRequest, res: NextApiResponse) => { let ok = false; try { performance.mark("Start"); - const result = await f(req, res); + const result = endpointRoute + ? await wrapApiHandlerWithSentry(f, endpointRoute)(req, res) + : await f(req, res); ok = true; if (result && !res.writableEnded) { return res.json(result); diff --git a/packages/lib/server/getServerErrorFromUnknown.ts b/packages/lib/server/getServerErrorFromUnknown.ts index f0eb8f421c..ac64f086be 100644 --- a/packages/lib/server/getServerErrorFromUnknown.ts +++ b/packages/lib/server/getServerErrorFromUnknown.ts @@ -3,6 +3,9 @@ import Stripe from "stripe"; import type { ZodIssue } from "zod"; import { ZodError } from "zod"; +import { TRPCError } from "@trpc/server"; +import { getHTTPStatusCodeFromError } from "@trpc/server/http"; + import { HttpError } from "../http-error"; import { redactError } from "../redactError"; @@ -31,6 +34,10 @@ function parseZodErrorIssues(issues: ZodIssue[]): string { } export function getServerErrorFromUnknown(cause: unknown): HttpError { + if (cause instanceof TRPCError) { + const statusCode = getHTTPStatusCodeFromError(cause); + return new HttpError({ statusCode, message: cause.message }); + } if (isZodError(cause)) { return new HttpError({ statusCode: 400,