fix(nestjs): Exception filters in main app module are not being executed #13278

nicohrubec · 2024-08-08T12:47:07Z

This PR moves the SentryGlobalFilter out of the root module, which led to the filter overriding user exception filters in certain scenarios. Now there is two ways to setup sentry error monitoring:

If users have no catch-all exception filter in their application they add the SentryGlobalFilter as a provider in their main module.
If users have a catch-all exception filter (annotated with @Catch() they can use the newly introduced SentryCaptureException() decorator to capture alle exceptions caught by this filter.

Testing:
Added a new sample application to test the second setup option and expanded the test suite in general.

Side note:

Also removed the @sentry/microservices dependency again, since it does not come out of the box with every nest application so we cannot rely on it.

github-actions · 2024-08-08T13:55:00Z

size-limit report 📦

Path	Size
@sentry/browser	22.5 KB (0%)
@sentry/browser (incl. Tracing)	34.85 KB (0%)
@sentry/browser (incl. Tracing, Replay)	71.18 KB (0%)
@sentry/browser (incl. Tracing, Replay) - with treeshaking flags	64.45 KB (0%)
@sentry/browser (incl. Tracing, Replay with Canvas)	75.53 KB (0%)
@sentry/browser (incl. Tracing, Replay, Feedback)	88.17 KB (0%)
@sentry/browser (incl. Tracing, Replay, Feedback, metrics)	90 KB (0%)
@sentry/browser (incl. metrics)	26.81 KB (0%)
@sentry/browser (incl. Feedback)	39.47 KB (0%)
@sentry/browser (incl. sendFeedback)	27.13 KB (0%)
@sentry/browser (incl. FeedbackAsync)	31.79 KB (0%)
@sentry/react	25.26 KB (0%)
@sentry/react (incl. Tracing)	37.83 KB (0%)
@sentry/vue	26.65 KB (0%)
@sentry/vue (incl. Tracing)	36.67 KB (0%)
@sentry/svelte	22.64 KB (0%)
CDN Bundle	23.73 KB (0%)
CDN Bundle (incl. Tracing)	36.49 KB (0%)
CDN Bundle (incl. Tracing, Replay)	70.81 KB (0%)
CDN Bundle (incl. Tracing, Replay, Feedback)	76.06 KB (0%)
CDN Bundle - uncompressed	69.61 KB (0%)
CDN Bundle (incl. Tracing) - uncompressed	108.27 KB (0%)
CDN Bundle (incl. Tracing, Replay) - uncompressed	219.52 KB (0%)
CDN Bundle (incl. Tracing, Replay, Feedback) - uncompressed	232.41 KB (0%)
@sentry/nextjs (client)	37.59 KB (0%)
@sentry/sveltekit (client)	35.45 KB (0%)
@sentry/node	115.61 KB (0%)
@sentry/node - without tracing	90 KB (0%)
@sentry/aws-serverless	99.42 KB (0%)

…hing)

wodCZ · 2024-08-12T09:10:32Z

Feel free to ping me if you'd like testers for this. I have two NestJS projects in production running on various setups:

NestJS + Fastify + Mercurius GraphQL driver (this one breaks a lot with recent @sentry/node or @sentry/nestjs, something about res.reply not being a function when any error happens)
NestJS + Express + TsRest Nest (this one works quite fine with recent releases)

Thank you for pushing the NestJS integration forward, very much appreciated ❤️

lforst · 2024-08-13T14:10:36Z

packages/nestjs/src/helpers.ts

+ *
+ * @returns `true` if the exception is expected and should not be reported to Sentry, otherwise `false`.
+ */
+export function isExpectedError(exception: unknown): boolean {


m: Rename to isProbablyNestjsHttpException()?

I don't think that's a good name because it's already responsible for filtering both RpcExceptions and HttpExceptions and maybe others in the future so should be a more general name

lforst · 2024-08-13T14:12:11Z

packages/node/src/integrations/tracing/nest/sentry-nest-instrumentation.ts

- * This hooks into the @Injectable decorator, which is applied on class middleware, interceptors and guards.
+ * This hooks into
+ * 1. @Injectable decorator, which is applied on class middleware, interceptors and guards.
+ * 2. @Catch decorator, which is applied on exception filters.


This is left over I think

no I forgot to update that comment when I added the exception filter tracing so that's fine

nicohrubec · 2024-08-13T15:18:19Z

@wodCZ Thanks for offering to help with testing! I'll be merging this PR now to fix some issues we are seeing with the nest SDK and also the dependency on @nestjs/microservices is resolved then. If you have time to test it in your apps either directly on develop or with the next release that would be amazing. If you find anything let us know and we will fix it :)

…ted (getsentry#13278) [ref](getsentry#12351) This PR moves the `SentryGlobalFilter` out of the root module, which led to the filter overriding user exception filters in certain scenarios. Now there is two ways to setup sentry error monitoring: - If users have no catch-all exception filter in their application they add the `SentryGlobalFilter` as a provider in their main module. - If users have a catch-all exception filter (annotated with `@Catch()` they can use the newly introduced `SentryCaptureException()` decorator to capture alle exceptions caught by this filter. Testing: Added a new sample application to test the second setup option and expanded the test suite in general. Side note: - Also removed the `@sentry/microservices` dependency again, since it does not come out of the box with every nest application so we cannot rely on it.

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@sentry/node](https://github.com/getsentry/sentry-javascript/tree/master/packages/node) ([source](https://github.com/getsentry/sentry-javascript)) | dependencies | minor | [`8.26.0` -> `8.30.0`](https://renovatebot.com/diffs/npm/@sentry%2fnode/8.26.0/8.30.0) | | [@sentry/react](https://github.com/getsentry/sentry-javascript/tree/master/packages/react) ([source](https://github.com/getsentry/sentry-javascript)) | dependencies | minor | [`8.26.0` -> `8.30.0`](https://renovatebot.com/diffs/npm/@sentry%2freact/8.26.0/8.30.0) | --- ### Release Notes <details> <summary>getsentry/sentry-javascript (@sentry/node)</summary> ### [`v8.30.0`](https://github.com/getsentry/sentry-javascript/blob/HEAD/CHANGELOG.md#8300) [Compare Source](getsentry/sentry-javascript@8.29.0...8.30.0) ##### Important Changes - *feat(node): Add `kafkajs` integration ([#13528](getsentry/sentry-javascript#13528 This release adds a new integration that instruments `kafkajs` library with spans and traces. This integration is automatically enabled by default, but can be included with the `Sentry.kafkaIntegration()` import. ```js Sentry.init({ integrations: [Sentry.kafkaIntegration()], }); ``` ##### Other Changes - feat(core): Allow adding measurements without global client ([#13612](getsentry/sentry-javascript#13612)) - feat(deps): Bump [@opentelemetry/instrumentation-undici](https://github.com/opentelemetry/instrumentation-undici) from 0.5.0 to 0.6.0 ([#13622](getsentry/sentry-javascript#13622)) - feat(deps): Bump [@sentry/cli](https://github.com/sentry/cli) from 2.33.0 to 2.35.0 ([#13624](getsentry/sentry-javascript#13624)) - feat(node): Use `@opentelemetry/instrumentation-undici` for fetch tracing ([#13485](getsentry/sentry-javascript#13485)) - feat(nuxt): Add server config to root folder ([#13583](getsentry/sentry-javascript#13583)) - feat(otel): Upgrade [@opentelemetry/semantic-conventions](https://github.com/opentelemetry/semantic-conventions) to 1.26.0 ([#13631](getsentry/sentry-javascript#13631)) - fix(browser): check supportedEntryTypes before caling the function ([#13541](getsentry/sentry-javascript#13541)) - fix(browser): Ensure Standalone CLS span timestamps are correct ([#13649](getsentry/sentry-javascript#13649)) - fix(nextjs): Widen removal of 404 transactions ([#13628](getsentry/sentry-javascript#13628)) - fix(node): Remove ambiguity and race conditions when matching local variables to exceptions ([#13501](getsentry/sentry-javascript#13501)) - fix(node): Update OpenTelemetry instrumentation package for solidstart and opentelemetry ([#13640](getsentry/sentry-javascript#13640)) - fix(node): Update OpenTelemetry instrumentation package for solidstart and opentelemetry ([#13642](getsentry/sentry-javascript#13642)) - fix(vue): Ensure Vue `trackComponents` list matches components with or without `<>` ([#13543](getsentry/sentry-javascript#13543)) - ref(profiling): Conditionally shim cjs globals ([#13267](getsentry/sentry-javascript#13267)) Work in this release was contributed by [@Zen-cronic](https://github.com/Zen-cronic) and [@odanado](https://github.com/odanado). Thank you for your contributions! ### [`v8.29.0`](https://github.com/getsentry/sentry-javascript/blob/HEAD/CHANGELOG.md#8290) [Compare Source](getsentry/sentry-javascript@8.28.0...8.29.0) ##### Important Changes - **Beta releases of official Solid and SolidStart Sentry SDKs** This release marks the beta releases of the `@sentry/solid` and `@sentry/solidstart` Sentry SDKs. For details on how to use them, check out the [Sentry Solid SDK README](https://github.com/getsentry/sentry-javascript/tree/develop/packages/solid) and the [Sentry SolidStart SDK README](https://github.com/getsentry/sentry-javascript/tree/develop/packages/solidstart) respectively. Please reach out on [GitHub](https://github.com/getsentry/sentry-javascript/issues/new/choose) if you have any feedback or concerns. - **feat(node): Option to only wrap instrumented modules ([#13139](getsentry/sentry-javascript#13139 Adds the SDK option to only wrap ES modules with `import-in-the-middle` that specifically need to be instrumented. ```javascript import * as Sentry from '@sentry/node'; Sentry.init({ dsn: '__PUBLIC_DSN__', registerEsmLoaderHooks: { onlyIncludeInstrumentedModules: true }, }); ``` - **feat(node): Update OpenTelemetry packages to instrumentation v0.53.0 ([#13587](getsentry/sentry-javascript#13587 All internal OpenTelemetry instrumentation was updated to their latest version. This adds support for Mongoose v7 and v8 and fixes various bugs related to ESM mode. ##### Other Changes - feat(nextjs): Emit warning when using turbopack ([#13566](getsentry/sentry-javascript#13566)) - feat(nextjs): Future-proof Next.js config options overriding ([#13586](getsentry/sentry-javascript#13586)) - feat(node): Add `generic-pool` integration ([#13465](getsentry/sentry-javascript#13465)) - feat(nuxt): Upload sourcemaps generated by Nitro ([#13382](getsentry/sentry-javascript#13382)) - feat(solidstart): Add `browserTracingIntegration` by default ([#13561](getsentry/sentry-javascript#13561)) - feat(solidstart): Add `sentrySolidStartVite` plugin to simplify source maps upload ([#13493](getsentry/sentry-javascript#13493)) - feat(vue): Only start UI spans if parent is available ([#13568](getsentry/sentry-javascript#13568)) - fix(cloudflare): Guard `context.waitUntil` call in request handler ([#13549](getsentry/sentry-javascript#13549)) - fix(gatsby): Fix assets path for sourcemaps upload ([#13592](getsentry/sentry-javascript#13592)) - fix(nextjs): Use posix paths for sourcemap uploads ([#13603](getsentry/sentry-javascript#13603)) - fix(node-fetch): Use stringified origin url ([#13581](getsentry/sentry-javascript#13581)) - fix(node): Replace dashes in `generic-pool` span origins with underscores ([#13579](getsentry/sentry-javascript#13579)) - fix(replay): Fix types in WebVitalData ([#13573](getsentry/sentry-javascript#13573)) - fix(replay): Improve replay web vital types ([#13602](getsentry/sentry-javascript#13602)) - fix(utils): Keep logger on carrier ([#13570](getsentry/sentry-javascript#13570)) Work in this release was contributed by [@Zen-cronic](https://github.com/Zen-cronic). Thank you for your contribution! ### [`v8.28.0`](https://github.com/getsentry/sentry-javascript/blob/HEAD/CHANGELOG.md#8280) [Compare Source](getsentry/sentry-javascript@8.27.0...8.28.0) ##### Important Changes - **Beta release of official NestJS SDK** This release contains the beta version of `@sentry/nestjs`! For details on how to use it, check out the [README](https://github.com/getsentry/sentry-javascript/blob/master/packages/nestjs/README.md). Any feedback/bug reports are greatly appreciated, please reach out on GitHub. - **fix(browser): Remove faulty LCP, FCP and FP normalization logic ([#13502](getsentry/sentry-javascript#13502 This release fixes a bug in the `@sentry/browser` package and all SDKs depending on this package (e.g. `@sentry/react` or `@sentry/nextjs`) that caused the SDK to send incorrect web vital values for the LCP, FCP and FP vitals. The SDK previously incorrectly processed the original values as they were reported from the browser. When updating your SDK to this version, you might experience an increase in LCP, FCP and FP values, which potentially leads to a decrease in your performance score in the Web Vitals Insights module in Sentry. This is because the previously reported values were smaller than the actually measured values. We apologize for the inconvenience! ##### Other Changes - feat(nestjs): Add `SentryGlobalGraphQLFilter` ([#13545](getsentry/sentry-javascript#13545)) - feat(nestjs): Automatic instrumentation of nestjs interceptors after route execution ([#13264](getsentry/sentry-javascript#13264)) - feat(nextjs): Add `bundleSizeOptimizations` to build options ([#13323](getsentry/sentry-javascript#13323)) - feat(nextjs): Stabilize `captureRequestError` ([#13550](getsentry/sentry-javascript#13550)) - feat(nuxt): Wrap config in nuxt context ([#13457](getsentry/sentry-javascript#13457)) - feat(profiling): Expose profiler as top level primitive ([#13512](getsentry/sentry-javascript#13512)) - feat(replay): Add layout shift to CLS replay data ([#13386](getsentry/sentry-javascript#13386)) - feat(replay): Upgrade rrweb packages to 2.26.0 ([#13483](getsentry/sentry-javascript#13483)) - fix(cdn): Do not mangle \_metadata ([#13426](getsentry/sentry-javascript#13426)) - fix(cdn): Fix SDK source for CDN bundles ([#13475](getsentry/sentry-javascript#13475)) - fix(nestjs): Check arguments before instrumenting with `@Injectable` ([#13544](getsentry/sentry-javascript#13544)) - fix(nestjs): Ensure exception and host are correctly passed on when using [@WithSentry](https://github.com/WithSentry) ([#13564](getsentry/sentry-javascript#13564)) - fix(node): Suppress tracing for transport request execution rather than transport creation ([#13491](getsentry/sentry-javascript#13491)) - fix(replay): Consider more things as DOM mutations for dead clicks ([#13518](getsentry/sentry-javascript#13518)) - fix(vue): Correctly obtain component name ([#13484](getsentry/sentry-javascript#13484)) Work in this release was contributed by [@leopoldkristjansson](https://github.com/leopoldkristjansson), [@mhuggins](https://github.com/mhuggins) and [@filips123](https://github.com/filips123). Thank you for your contributions! ### [`v8.27.0`](https://github.com/getsentry/sentry-javascript/blob/HEAD/CHANGELOG.md#8270) [Compare Source](getsentry/sentry-javascript@8.26.0...8.27.0) ##### Important Changes - **fix(nestjs): Exception filters in main app module are not being executed ([#13278](getsentry/sentry-javascript#13278 With this release nestjs error monitoring is no longer automatically set up after adding the `SentryModule` to your application, which led to issues in certain scenarios. You will now have to either add the `SentryGlobalFilter` to your main module providers or decorate the `catch()` method in your existing global exception filters with the newly released `@WithSentry()` decorator. See the [docs](https://docs.sentry.io/platforms/javascript/guides/nestjs/) for more details. ##### Other Changes - feat: Add options for passing nonces to feedback integration ([#13347](getsentry/sentry-javascript#13347)) - feat: Add support for SENTRY_SPOTLIGHT env var in Node ([#13325](getsentry/sentry-javascript#13325)) - feat(deps): bump [@prisma/instrumentation](https://github.com/prisma/instrumentation) from 5.17.0 to 5.18.0 ([#13327](getsentry/sentry-javascript#13327)) - feat(feedback): Improve error message for 403 errors ([#13441](getsentry/sentry-javascript#13441)) - fix(deno): Don't rely on `Deno.permissions.querySync` ([#13378](getsentry/sentry-javascript#13378)) - fix(replay): Ensure we publish replay CDN bundles ([#13437](getsentry/sentry-javascript#13437)) Work in this release was contributed by [@charpeni](https://github.com/charpeni). Thank you for your contribution! </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://git.tristess.app/alexandresoro/ouca/pulls/61 Reviewed-by: Alexandre Soro <code@soro.dev> Co-authored-by: renovate <renovate@git.tristess.app> Co-committed-by: renovate <renovate@git.tristess.app>

Add test that demonstrates wrong behavior

6e6b32e

nicohrubec self-assigned this Aug 8, 2024

nicohrubec added 4 commits August 8, 2024 15:01

Use example exception instead of bad request

fd3a30a

Rename

1bcaf37

Add local filter test

22eadbe

Fix tests

61d5fe6

nicohrubec added 7 commits August 9, 2024 10:21

Start on base exception filter patch

885fb6b

Basic patch for base exception filter seems to work (we can log somet…

d4ab597

…hing)

This works! (I think)

c9b690f

Adding correct logic to patch

e73698a

Cleanup

f71297e

Fix tests to reflect new working state

1c87a97

Remove nest microservice dependency

83998d2

nicohrubec mentioned this pull request Aug 12, 2024

feat(nestjs): Filter RPC exceptions #13227

Merged

nicohrubec added 2 commits August 12, 2024 10:51

Add docstrings and improve deprecation message

5be4440

Pass all arguments

daf1156

nicohrubec added 7 commits August 12, 2024 11:22

Add test for instrumentation in module registered before Sentry

468fb30

Lint2

1f47da1

Remove note about registration order from readme

75058b4

Add tests to node sdk

20891b3

Rename error isntrumentation

6d1a150

Default base filter to undefined

ddf23b2

Add comment

2b5d119

nicohrubec marked this pull request as ready for review August 12, 2024 11:11

nicohrubec requested review from a team, stephanie-anderson and s1gr1d and removed request for a team August 12, 2024 11:12

nicohrubec added 7 commits August 12, 2024 17:47

Revert some stuff

8fa920a

Update to decorator and explicit sentry global filter provider

d7a6263

make stuff not broken

47481fa

Revert node tests

2d4dc35

Update tests

eb72826

Add sample application with new decorator setup

66fa8bb

Fix tests?

38d0093

nicohrubec marked this pull request as draft August 13, 2024 11:43

nicohrubec added 6 commits August 13, 2024 13:56

Add test: Unexpected exception not caught by local filter is reported

fbc5a7a

Add specific filter test

b09bb16

Add test local filter

878ee0b

Rename decorator

56a823c

Make decorator nicer

45de32e

Update readme

0b49d0d

nicohrubec marked this pull request as ready for review August 13, 2024 13:49

lforst and others added 2 commits August 13, 2024 14:28

Update readme

570de0e

Remove useless files

242e62e

lforst approved these changes Aug 13, 2024

View reviewed changes

nicohrubec merged commit 51ef02d into develop Aug 13, 2024
129 checks passed

nicohrubec deleted the nh/nest-global-filter-test branch August 13, 2024 15:31

OKEAMAH mentioned this pull request Sep 17, 2024

[Snyk] Upgrade: , commander, pino, prom-client https-github-com-okeamah/optimism#12

Open

bagulm123 mentioned this pull request Sep 18, 2024

[Snyk] Upgrade: , , , chart.js, classnames, cytoscape, next, typescript bagulm123/komiser#20

Open

onsails mentioned this pull request Sep 18, 2024

[Snyk] Upgrade: , , , next haqq-network/islamic-website#37

Open

mohamed-helmy22020 mentioned this pull request Sep 18, 2024

[Snyk] Upgrade @sentry/nextjs from 8.26.0 to 8.27.0 mohamed-helmy22020/banking#4

Open

OKEAMAH mentioned this pull request Sep 19, 2024

[Snyk] Upgrade: , commander, pino, prom-client https-github-com-okeamah/ope#12

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(nestjs): Exception filters in main app module are not being executed #13278

fix(nestjs): Exception filters in main app module are not being executed #13278

nicohrubec commented Aug 8, 2024 •

edited

Loading

github-actions bot commented Aug 8, 2024 •

edited

Loading

wodCZ commented Aug 12, 2024

lforst Aug 13, 2024

nicohrubec Aug 13, 2024

lforst Aug 13, 2024

nicohrubec Aug 13, 2024

nicohrubec commented Aug 13, 2024

fix(nestjs): Exception filters in main app module are not being executed #13278

fix(nestjs): Exception filters in main app module are not being executed #13278

Conversation

nicohrubec commented Aug 8, 2024 • edited Loading

github-actions bot commented Aug 8, 2024 • edited Loading

size-limit report 📦

wodCZ commented Aug 12, 2024

lforst Aug 13, 2024

Choose a reason for hiding this comment

nicohrubec Aug 13, 2024

Choose a reason for hiding this comment

lforst Aug 13, 2024

Choose a reason for hiding this comment

nicohrubec Aug 13, 2024

Choose a reason for hiding this comment

nicohrubec commented Aug 13, 2024

nicohrubec commented Aug 8, 2024 •

edited

Loading

github-actions bot commented Aug 8, 2024 •

edited

Loading