-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(node): Add shouldHandleError option to fastify error handler #13198
base: develop
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -61,14 +61,27 @@ const _fastifyIntegration = (() => { | |
*/ | ||
export const fastifyIntegration = defineIntegration(_fastifyIntegration); | ||
|
||
interface FastifyHandlerOptions { | ||
/** | ||
* Callback method deciding whether error should be captured and sent to Sentry | ||
* @param error Captured middleware error | ||
*/ | ||
// eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
shouldHandleError?(this: void, request: any, reply: any, error: Error): boolean; | ||
} | ||
|
||
/** | ||
* Setup an error handler for Fastify. | ||
*/ | ||
export function setupFastifyErrorHandler(fastify: Fastify): void { | ||
export function setupFastifyErrorHandler(fastify: Fastify, options?: FastifyHandlerOptions): void { | ||
const plugin = Object.assign( | ||
function (fastify: Fastify, _options: unknown, done: () => void): void { | ||
fastify.addHook('onError', async (_request, _reply, error) => { | ||
captureException(error); | ||
const shouldHandleError = options?.shouldHandleError || defaultShouldHandleError; | ||
|
||
fastify.addHook('onError', async (request, reply, error) => { | ||
Comment on lines
+79
to
+81
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think, since digging into this more, that my initial suggestion was incomplete - There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is not a fastify-sentry plugin, but an immobiliare plugin for fastify. Not official. Reply and Error are not the same since the reply could have been sent before the error occurred. |
||
if (shouldHandleError(request, reply, error)) { | ||
captureException(error, { mechanism: { type: 'middleware', handled: false } }); | ||
} | ||
}); | ||
|
||
// registering `onRequest` hook here instead of using Otel `onRequest` callback b/c `onRequest` hook | ||
|
@@ -131,3 +144,10 @@ function addFastifySpanAttributes(span: Span): void { | |
span.updateName(name.replace(/^fastify -> /, '')); | ||
} | ||
} | ||
|
||
/** Returns true if response code is internal server error */ | ||
// eslint-disable-next-line @typescript-eslint/no-explicit-any | ||
function defaultShouldHandleError(_request: any, reply: any, _error: Error): boolean { | ||
// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access | ||
return reply.statusCode >= 500; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. statusCode can be undefined There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. // eslint-disable-next-line is used everywhere, it is not clear why you need eslint in the project then. |
||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is better to use explicit types instead of any
import type { FastifyRequest, FastifyReply } from 'fastify';