fix(core): Update trpc middleware types (#13859)

getsentry · Oct 3, 2024 · 5c06bd2 · 5c06bd2
1 parent 0b739c5
commit 5c06bd2
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 10 deletions.
diff --git a/dev-packages/e2e-tests/test-applications/nextjs-t3/src/server/api/trpc.ts b/dev-packages/e2e-tests/test-applications/nextjs-t3/src/server/api/trpc.ts
@@ -70,8 +70,8 @@ export const createCallerFactory = t.createCallerFactory;
  */
 export const createTRPCRouter = t.router;
 
-const sentryMiddleware = Sentry.trpcMiddleware({
-  attachRpcInput: true,
-});
-
-export const publicProcedure = t.procedure.use(async opts => sentryMiddleware(opts));
+export const publicProcedure = t.procedure.use(
+  Sentry.trpcMiddleware({
+    attachRpcInput: true,
+  }),
+);
diff --git a/dev-packages/e2e-tests/test-applications/node-express/src/app.ts b/dev-packages/e2e-tests/test-applications/node-express/src/app.ts
@@ -105,9 +105,7 @@ Sentry.addEventProcessor(event => {
 
 export const t = initTRPC.context<Context>().create();
 
-const sentryMiddleware = Sentry.trpcMiddleware({ attachRpcInput: true });
-
-const procedure = t.procedure.use(async opts => sentryMiddleware(opts));
+const procedure = t.procedure.use(Sentry.trpcMiddleware({ attachRpcInput: true }));
 
 export const appRouter = t.router({
   getSomething: procedure.input(z.string()).query(opts => {

diff --git a/packages/core/src/trpc.ts b/packages/core/src/trpc.ts
@@ -33,11 +33,15 @@ function captureIfError(nextResult: unknown): void {
   }
 }
 
+type SentryTrpcMiddleware<T> = T extends Promise<unknown> ? T : Promise<T>;
+
 /**
  * Sentry tRPC middleware that captures errors and creates spans for tRPC procedures.
  */
 export function trpcMiddleware(options: SentryTrpcMiddlewareOptions = {}) {
-  return async function <T>(opts: SentryTrpcMiddlewareArguments<T>): Promise<T> {
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  // @ts-ignore
+  return async function <T>(opts: SentryTrpcMiddlewareArguments<T>): SentryTrpcMiddleware<T> {
     const { path, type, next, rawInput, getRawInput } = opts;
 
     const client = getClient();
@@ -85,6 +89,6 @@ export function trpcMiddleware(options: SentryTrpcMiddlewareOptions = {}) {
           throw e;
         }
       },
-    );
+    ) as SentryTrpcMiddleware<T>;
   };
 }