fix(node): Remove deprecated routerPath warning of fastify request object

dev-packages/node-integration-tests/package.json

@@ -44,6 +44,7 @@
  "cors": "^2.8.5",
  "cron": "^3.1.6",
  "express": "^4.17.3",
+ "fastify": "~4.23.2",
  "graphql": "^16.3.0",
  "http-terminator": "^3.2.0",
  "ioredis": "^5.4.1",

dev-packages/node-integration-tests/src/index.ts

@@ -1,6 +1,7 @@
 import type { AddressInfo } from 'net';
 import type { BaseTransportOptions, Envelope, Transport, TransportMakeRequestResponse } from '@sentry/types';
 import type { Express } from 'express';
+import type { FastifyInstance } from 'fastify';
 
 /**
  * Debug logging transport
@@ -34,6 +35,25 @@ export function startExpressServerAndSendPortToRunner(app: Express, port: number
  });
 }
 
+/**
+ * Starts a fastify server and sends the port to the runner
+ n("sendPortToRunner called");
+ * @param app Fastify app
+ * @param port Port to start the app on.
+ */
+export function startFastifyServerAndSendPortToRunner(
+ app: FastifyInstance,
+ port: number | undefined = undefined,
+): void {
+ app.listen({ port: port || 0 }, (_err, address) => {
+ // Fastify's address (string): http://[::1]:59752, etc.
+ const addressPort = address.slice(address.lastIndexOf(':') + 1);
+
+ // eslint-disable-next-line no-console
+ console.log(`{"port":${port || addressPort}}`);
+ });
+}
+
 /**
  * Sends the port to the runner
  */

dev-packages/node-integration-tests/suites/fastify/deprecation/server.ts

@@ -0,0 +1,22 @@
+import { loggingTransport } from '@sentry-internal/node-integration-tests';
+import * as Sentry from '@sentry/node';
+
+Sentry.init({
+ dsn: 'https://public@dsn.ingest.sentry.io/1337',
+ release: '1.0',
+ transport: loggingTransport,
+});
+
+import { startFastifyServerAndSendPortToRunner } from '@sentry-internal/node-integration-tests';
+import fastify from 'fastify';
+
+const app = fastify();
+
+app.get('/test/deprecated', (_req, res) => {
+ // eslint-disable-next-line @typescript-eslint/no-floating-promises
+ res.send({});
+});
+
+Sentry.setupFastifyErrorHandler(app);
+
+startFastifyServerAndSendPortToRunner(app);

dev-packages/node-integration-tests/suites/fastify/deprecation/test.ts

@@ -0,0 +1,32 @@
+import { AxiosError } from 'axios';
+import { cleanupChildProcesses, createRunner } from '../../../utils/runner';
+
+afterAll(() => {
+ cleanupChildProcesses();
+});
+
+/**
+ * AxiosError throws before the deprecation warning code is invoked,
+ * so mocking it would have no effect.
+ *
+ * But the deprecation warning is successfully suppressed.
+ * This can be verified by running the example code as in the original
+ * issue (https://github.com/getsentry/sentry-javascript/issues/12844)
+ */
+test('suppress fastify deprecation warning when `routerPath` property is accessed', async () => {
+ // ensures that the assertions in the catch block are called
+ expect.assertions(3);
+
+ const runner = createRunner(__dirname, 'server.ts').start();
+
+ try {
+ // Axios from `makeRequest` will throw 404.
+ await runner.makeRequest('get', '/test/deprecated/does-not-exist');
+ } catch (error) {
+ expect(error).toBeInstanceOf(AxiosError);
+ if (error instanceof AxiosError) {
+ expect(error.message).toBe('Request failed with status code 404');
+ expect(error.response?.status).toBe(404);
+ }
+ }
+});

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

@@ -30,6 +30,7 @@ interface FastifyRequestRouteInfo {
  url?: string;
  method?: string;
  };
+ // will deprecate in Fastify 5
  routerPath?: string;
 }
 
@@ -79,7 +80,10 @@ export function setupFastifyErrorHandler(fastify: Fastify): void {
 
  // Taken from Otel Fastify instrumentation:
  // https://github.com/open-telemetry/opentelemetry-js-contrib/blob/main/plugins/node/opentelemetry-instrumentation-fastify/src/instrumentation.ts#L94-L96
- const routeName = reqWithRouteInfo.routeOptions?.url || reqWithRouteInfo.routerPath;
+ const routeName = reqWithRouteInfo.routeOptions
+ ? reqWithRouteInfo.routeOptions.url
+ : reqWithRouteInfo.routerPath;
+
  const method = reqWithRouteInfo.routeOptions?.method || 'GET';
 
  getIsolationScope().setTransactionName(`${method} ${routeName}`);