improve request types

Author: chargome

packages/nestjs/src/setup.ts

@@ -22,6 +22,7 @@ import {
 } from '@sentry/core';
 import type { Observable } from 'rxjs';
 import { isExpectedError } from './helpers';
+import type { FastifyRequest, ExpressRequest } from '@sentry/node';
 
 /**
  * Note: We cannot use @ syntax to add the decorators, so we add them directly below the classes as function wrappers.
@@ -52,18 +53,16 @@ class SentryTracingInterceptor implements NestInterceptor {
     }
 
     if (context.getType() === 'http') {
-      const req = context.switchToHttp().getRequest();
-      /* eslint-disable @typescript-eslint/no-unsafe-member-access, @sentry-internal/sdk/no-optional-chaining */
-      if (req.routeOptions && req.routeOptions.url) {
+      const req = context.switchToHttp().getRequest() as FastifyRequest | ExpressRequest;
+      if ('routeOptions' in req && req.routeOptions && req.routeOptions.url) {
         // fastify case
         getIsolationScope().setTransactionName(
-          `${req.routeOptions.method?.toUpperCase() || 'GET'} ${req.routeOptions.url}`,
+          `${(req.routeOptions.method || 'GET').toUpperCase()} ${req.routeOptions.url}`,
         );
-      } else if (req.route && req.route.path) {
+      } else if ('route' in req && req.route && req.route.path) {
         // express case
-        getIsolationScope().setTransactionName(`${req.method?.toUpperCase() || 'GET'} ${req.route.path}`);
+        getIsolationScope().setTransactionName(`${(req.method || 'GET').toUpperCase()} ${req.route.path}`);
       }
-      /* eslint-enable @typescript-eslint/no-unsafe-member-access, @sentry-internal/sdk/no-optional-chaining */
     }
 
     return next.handle();

packages/node/src/index.ts

@@ -166,3 +166,5 @@ export type {
   User,
   Span,
 } from '@sentry/core';
+
+export type { FastifyRequest, ExpressRequest } from './integrations/tracing/nest/types';

packages/node/src/integrations/tracing/nest/nest.ts

@@ -87,18 +87,17 @@ export function setupNestErrorHandler(app: MinimalNestJsApp, baseFilter: NestJsE
       }
 
       if (context.getType() === 'http') {
+        // getRequest() returns either a FastifyRequest or ExpressRequest, depending on the used adapter
         const req = context.switchToHttp().getRequest();
-        /* eslint-disable @typescript-eslint/no-unsafe-member-access */
-        if (req.routeOptions && req.routeOptions.url) {
+        if ('routeOptions' in req && req.routeOptions && req.routeOptions.url) {
           // fastify case
           getIsolationScope().setTransactionName(
             `${req.routeOptions.method?.toUpperCase() || 'GET'} ${req.routeOptions.url}`,
           );
-        } else if (req.route && req.route.path) {
+        } else if ('route' in req && req.route && req.route.path) {
           // express case
           getIsolationScope().setTransactionName(`${req.method?.toUpperCase() || 'GET'} ${req.route.path}`);
         }
-        /* eslint-enable @typescript-eslint/no-unsafe-member-access, @sentry-internal/sdk/no-optional-chaining */
       }
 
       return next.handle();

packages/node/src/integrations/tracing/nest/types.ts

@@ -1,19 +1,30 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 
+// Partial extract of FastifyRequest interface
+// https://github.com/fastify/fastify/blob/87f9f20687c938828f1138f91682d568d2a31e53/types/request.d.ts#L41
+export interface FastifyRequest {
+  routeOptions?: {
+    method?: string;
+    url?: string;
+  };
+}
+
+// Partial extract of ExpressRequest interface
+export interface ExpressRequest {
+  route?: {
+    path?: string;
+  };
+  method?: string;
+}
+
 export interface MinimalNestJsExecutionContext {
   getType: () => string;
 
   switchToHttp: () => {
     // minimal request object
     // according to official types, all properties are required but
     // let's play it safe and assume they're optional
-    getRequest: () => {
-      routeOptions?: any;
-      route?: {
-        path?: string;
-      };
-      method?: string;
-    };
+    getRequest: () => FastifyRequest | ExpressRequest;
   };
 
   _sentryInterceptorInstrumented?: boolean;