feat(node): Add setupFastifyErrorHandler utility (#11061)

For easier setup of error handling in fastify.

Author: mydea

.github/workflows/build.yml

@@ -1021,7 +1021,7 @@ jobs:
             'sveltekit',
             'sveltekit-2',
             'generic-ts3.8',
-            'node-experimental-fastify-app',
+            'node-fastify-app',
             # TODO(v8): Re-enable hapi tests
             # 'node-hapi-app',
             'node-exports-test-app',

dev-packages/e2e-tests/test-applications/node-exports-test-app/scripts/consistentExports.ts

@@ -46,6 +46,10 @@ const DEPENDENTS: Dependent[] = [
     package: '@sentry/astro',
     compareWith: nodeExports,
     exports: Object.keys(SentryAstro),
+    ignoreExports: [
+      // Not needed for Astro
+      'setupFastifyErrorHandler',
+    ],
   },
   {
     package: '@sentry/bun',
@@ -82,13 +86,23 @@ const DEPENDENTS: Dependent[] = [
     package: '@sentry/aws-serverless',
     compareWith: nodeExports,
     exports: Object.keys(SentryAWS),
-    ignoreExports: ['makeMain'],
+    ignoreExports: [
+      // legacy, to be removed...
+      'makeMain',
+      // Not needed for Serverless
+      'setupFastifyErrorHandler',
+    ],
   },
   {
     package: '@sentry/google-cloud-serverless',
     compareWith: nodeExports,
     exports: Object.keys(SentryGoogleCloud),
-    ignoreExports: ['makeMain'],
+    ignoreExports: [
+      // legacy, to be removed...
+      'makeMain',
+      // Not needed for Serverless
+      'setupFastifyErrorHandler',
+    ],
   },
   {
     package: '@sentry/sveltekit',

dev-packages/e2e-tests/test-applications/node-experimental-fastify-app/.gitignore renamed to dev-packages/e2e-tests/test-applications/node-fastify-app/.gitignore

@@ -1,5 +1,5 @@
 {
-  "name": "node-experimental-fastify-app",
+  "name": "node-fastify-app",
   "version": "1.0.0",
   "private": true,
   "scripts": {
@@ -17,7 +17,6 @@
     "@sentry/opentelemetry": "latest || *",
     "@types/node": "18.15.1",
     "fastify": "4.23.2",
-    "fastify-plugin": "4.5.1",
     "typescript": "4.9.5",
     "ts-node": "10.9.1"
   },

dev-packages/e2e-tests/test-applications/node-experimental-fastify-app/.npmrc renamed to dev-packages/e2e-tests/test-applications/node-fastify-app/.npmrc

@@ -2,21 +2,12 @@ require('./tracing');
 
 const Sentry = require('@sentry/node');
 const { fastify } = require('fastify');
-const fastifyPlugin = require('fastify-plugin');
 const http = require('http');
 
-const FastifySentry = fastifyPlugin(async (fastify, options) => {
-  fastify.decorateRequest('_sentryContext', null);
-
-  fastify.addHook('onError', async (_request, _reply, error) => {
-    Sentry.captureException(error);
-  });
-});
-
 const app = fastify();
 const port = 3030;
 
-app.register(FastifySentry);
+Sentry.setupFastifyErrorHandler(app);
 
 app.get('/test-success', function (req, res) {
   res.send({ version: 'v1' });
@@ -61,6 +52,10 @@ app.get('/test-error', async function (req, res) {
   res.send({ exceptionId });
 });
 
+app.get('/test-exception', async function (req, res) {
+  throw new Error('This is an exception');
+});
+
 app.listen({ port: port });
 
 function makeHttpRequest(url) {

dev-packages/e2e-tests/test-applications/node-experimental-fastify-app/event-proxy-server.ts renamed to dev-packages/e2e-tests/test-applications/node-fastify-app/event-proxy-server.ts

@@ -2,5 +2,5 @@ import { startEventProxyServer } from './event-proxy-server';
 
 startEventProxyServer({
   port: 3031,
-  proxyServerName: 'node-experimental-fastify-app',
+  proxyServerName: 'node-fastify-app',
 });