feat(node): Add Sentry tRPC middleware

Author: Luca Forstner

packages/node/src/index.ts

@@ -65,6 +65,8 @@ const INTEGRATIONS = {
 
 export { INTEGRATIONS as Integrations, Handlers };
 
+export { sentryTrpcMiddleware } from './trpc';
+
 // We need to patch domain on the global __SENTRY__ object to make it work for node in cross-platform packages like
 // @sentry/core. If we don't do this, browser bundlers will have troubles resolving `require('domain')`.
 const carrier = getMainCarrier();

packages/node/src/trpc.ts

@@ -0,0 +1,44 @@
+import { getCurrentHub } from '@sentry/core';
+import { normalize } from '@sentry/utils';
+
+interface SentryTrpcMiddlewareOptions {
+  attachRpcInput?: boolean;
+}
+
+interface TrpcMiddlewareArguments<T> {
+  path: string;
+  type: 'query' | 'mutation' | 'subscription';
+  next: () => Promise<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 integration or
+ * Next.js SDK)
+ */
+export async function sentryTrpcMiddleware(options: SentryTrpcMiddlewareOptions) {
+  return async function <T>({ path, type, next, rawInput }: TrpcMiddlewareArguments<T>): Promise<T> {
+    const hub = getCurrentHub();
+    const clientOptions = hub.getClient()?.getOptions();
+    const sentryTransaction = hub.getScope()?.getTransaction();
+
+    if (sentryTransaction) {
+      sentryTransaction.setName(`${path}()`, 'route');
+      sentryTransaction.op = 'rpc.server';
+
+      const trpcData: Record<string, unknown> = {
+        procedureType: type,
+      };
+
+      if (options.attachRpcInput !== undefined ? options.attachRpcInput : clientOptions?.sendDefaultPii) {
+        trpcData.procedureInput = normalize(rawInput);
+      }
+
+      sentryTransaction.setData('trpc', trpcData);
+    }
+
+    return await next();
+  };
+}