Skip to content
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

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

AbhiPrasad
Copy link
Member

resolves #13197

Aligns fastify error handler with the express one.

  1. Adds shouldHandleError to allow users to configure if errors should be captured
  2. Makes sure the default shouldHandleError only captures errors for 5xx status codes.

@AbhiPrasad AbhiPrasad requested review from mydea and a team August 2, 2024 14:41
@AbhiPrasad AbhiPrasad self-assigned this Aug 2, 2024
@AbhiPrasad AbhiPrasad requested review from lforst and removed request for a team August 2, 2024 14:41
@AbhiPrasad AbhiPrasad added the Integration: fastify Issues related to Fastify support for the Sentry Node SDK label Aug 2, 2024
Comment on lines +79 to +81
const shouldHandleError = options?.shouldHandleError || defaultShouldHandleError;

fastify.addHook('onError', async (request, reply, error) => {
Copy link

Choose a reason for hiding this comment

The 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 - reply.status is probably going to be 200 here, and instead there is, I think, error.statusCode, according to the fastify-sentry plugin? https://github.com/immobiliare/fastify-sentry/blob/main/lib/base.js#L43-L46

Copy link
Contributor

Choose a reason for hiding this comment

The 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.

* @param error Captured middleware error
*/
// eslint-disable-next-line @typescript-eslint/no-explicit-any
shouldHandleError?(this: void, request: any, reply: any, error: Error): boolean;
Copy link
Contributor

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';

// 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;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

statusCode can be undefined

Copy link
Contributor

Choose a reason for hiding this comment

The 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Integration: fastify Issues related to Fastify support for the Sentry Node SDK
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Sentry reports handled errors in Fastify integration
5 participants