feat(node): Add Sentry tRPC middleware (getsentry#7511)

lforst · kamilogorek · web-flow · commit bb11a2eed239 · 2023-03-30T11:09:30.000+02:00
Co-authored-by: Kamil Ogórek &lt;kamil.ogorek@gmail.com&gt;
diff --git a/packages/node/src/handlers.ts b/packages/node/src/handlers.ts
@@ -10,6 +10,7 @@ import {
   extractTraceparentData,
   isString,
   logger,
+  normalize,
 } from '@sentry/utils';
 import * as domain from 'domain';
 import type * as http from 'http';
@@ -315,6 +316,49 @@ export function errorHandler(options?: {
   };
 }
 
+interface SentryTrpcMiddlewareOptions {
+  /** Whether to include procedure inputs in reported events. Defaults to `false`. */
+  attachRpcInput?: boolean;
+}
+
+interface TrpcMiddlewareArguments<T> {
+  path: string;
+  type: 'query' | 'mutation' | 'subscription';
+  next: () => T;
+  rawInput: unknown;
+}
+
+/**
+ * Sentry tRPC middleware that names the handling transaction after the called procedure.
+ *
+ * Use the Sentry tRPC middleware in combination with the Sentry server integration,
+ * e.g. Express Request Handlers or Next.js SDK.
+ */
+export async function trpcMiddleware(options: SentryTrpcMiddlewareOptions = {}) {
+  return function <T>({ path, type, next, rawInput }: TrpcMiddlewareArguments<T>): T {
+    const hub = getCurrentHub();
+    const clientOptions = hub.getClient()?.getOptions();
+    const sentryTransaction = hub.getScope()?.getTransaction();
+
+    if (sentryTransaction) {
+      sentryTransaction.setName(`trcp/${path}`, 'route');
+      sentryTransaction.op = 'rpc.server';
+
+      const trpcContext: Record<string, unknown> = {
+        procedure_type: type,
+      };
+
+      if (options.attachRpcInput !== undefined ? options.attachRpcInput : clientOptions?.sendDefaultPii) {
+        trpcContext.input = normalize(rawInput);
+      }
+
+      sentryTransaction.setContext('trpc', trpcContext);
+    }
+
+    return next();
+  };
+}
+
 // TODO (v8 / #5257): Remove this
 // eslint-disable-next-line deprecation/deprecation
 export type { ParseRequestOptions, ExpressRequest } from './requestDataDeprecated';
