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.

Sign up for GitHub

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

Jump to bottom

feat(nestjs): Filter RPC exceptions #13227

Merged
merged 7 commits into from
Aug 5, 2024
Merged

feat(nestjs): Filter RPC exceptions #13227

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
0faa467
Add nestjs microservices dependency
nicohrubec Aug 5, 2024
cebcd44
Filter rpc exceptions in sentry/nest + make tests go brrr
nicohrubec Aug 5, 2024
1db607f
Make tests slow again
nicohrubec Aug 5, 2024
da797a7
Filter rpc exceptions in sentry node
nicohrubec Aug 5, 2024
b1ac229
Merge branch 'develop' into nh/filter-rpc-exceptions
nicohrubec Aug 5, 2024
979d7e7
Fix tests?
nicohrubec Aug 5, 2024
619e8fe
Address pr comments
nicohrubec Aug 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions dev-packages/e2e-tests/test-applications/nestjs-basic/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
"dependencies": {
"@nestjs/common": "^10.0.0",
"@nestjs/core": "^10.0.0",
"@nestjs/microservices": "^10.0.0",
"@nestjs/schedule": "^4.1.0",
"@nestjs/platform-express": "^10.0.0",
"@sentry/nestjs": "latest || *",
Expand Down
5 changes: 5 additions & 0 deletions dev-packages/e2e-tests/test-applications/nestjs-basic/src/app.controller.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,11 @@ export class AppController {
return this.appService.testExpected500Exception(id);
}

@Get('test-expected-rpc-exception/:id')
async testExpectedRpcException(@Param('id') id: string) {
return this.appService.testExpectedRpcException(id);
}

@Get('test-span-decorator-async')
async testSpanDecoratorAsync() {
return { result: await this.appService.testSpanDecoratorAsync() };
Expand Down
5 changes: 5 additions & 0 deletions dev-packages/e2e-tests/test-applications/nestjs-basic/src/app.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { HttpException, HttpStatus, Injectable } from '@nestjs/common';
import { RpcException } from '@nestjs/microservices';
import { Cron, SchedulerRegistry } from '@nestjs/schedule';
import * as Sentry from '@sentry/nestjs';
import { SentryCron, SentryTraced } from '@sentry/nestjs';
Expand Down Expand Up @@ -38,6 +39,10 @@ export class AppService {
throw new HttpException(`This is an expected 500 exception with id ${id}`, HttpStatus.INTERNAL_SERVER_ERROR);
}

testExpectedRpcException(id: string) {
throw new RpcException(`This is an expected RPC exception with id ${id}`);
}

@SentryTraced('wait and return a string')
async wait() {
await new Promise(resolve => setTimeout(resolve, 500));
Expand Down
25 changes: 25 additions & 0 deletions dev-packages/e2e-tests/test-applications/nestjs-basic/tests/errors.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,3 +69,28 @@ test('Does not send HttpExceptions to Sentry', async ({ baseURL }) => {

expect(errorEventOccurred).toBe(false);
});

test('Does not send RpcExceptions to Sentry', async ({ baseURL }) => {
let errorEventOccurred = false;

waitForError('nestjs-basic', event => {
if (!event.type && event.exception?.values?.[0]?.value === 'This is an expected RPC exception with id 123') {
errorEventOccurred = true;
}

return event?.transaction === 'GET /test-expected-rpc-exception/:id';
});

const transactionEventPromise = waitForTransaction('nestjs-basic', transactionEvent => {
return transactionEvent?.transaction === 'GET /test-expected-rpc-exception/:id';
});

const response = await fetch(`${baseURL}/test-expected-rpc-exception/123`);
expect(response.status).toBe(500);

await transactionEventPromise;

await new Promise(resolve => setTimeout(resolve, 10000));

expect(errorEventOccurred).toBe(false);
});
1 change: 1 addition & 0 deletions dev-packages/e2e-tests/test-applications/node-nestjs-basic/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
"dependencies": {
"@nestjs/common": "^10.0.0",
"@nestjs/core": "^10.0.0",
"@nestjs/microservices": "^10.0.0",
"@nestjs/schedule": "^4.1.0",
"@nestjs/platform-express": "^10.0.0",
"@sentry/nestjs": "latest || *",
Expand Down
5 changes: 5 additions & 0 deletions dev-packages/e2e-tests/test-applications/node-nestjs-basic/src/app.controller.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,11 @@ export class AppController {
return this.appService.testExpected500Exception(id);
}

@Get('test-expected-rpc-exception/:id')
async testExpectedRpcException(@Param('id') id: string) {
return this.appService.testExpectedRpcException(id);
}

@Get('test-span-decorator-async')
async testSpanDecoratorAsync() {
return { result: await this.appService.testSpanDecoratorAsync() };
Expand Down
5 changes: 5 additions & 0 deletions dev-packages/e2e-tests/test-applications/node-nestjs-basic/src/app.service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { HttpException, HttpStatus, Injectable } from '@nestjs/common';
import { RpcException } from '@nestjs/microservices';
import { Cron, SchedulerRegistry } from '@nestjs/schedule';
import * as Sentry from '@sentry/nestjs';
import { SentryCron, SentryTraced } from '@sentry/nestjs';
Expand Down Expand Up @@ -38,6 +39,10 @@ export class AppService {
throw new HttpException(`This is an expected 500 exception with id ${id}`, HttpStatus.INTERNAL_SERVER_ERROR);
}

testExpectedRpcException(id: string) {
throw new RpcException(`This is an expected RPC exception with id ${id}`);
}

@SentryTraced('wait and return a string')
async wait() {
await new Promise(resolve => setTimeout(resolve, 500));
Expand Down
25 changes: 25 additions & 0 deletions dev-packages/e2e-tests/test-applications/node-nestjs-basic/tests/errors.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,3 +69,28 @@ test('Does not send HttpExceptions to Sentry', async ({ baseURL }) => {

expect(errorEventOccurred).toBe(false);
});

test('Does not send RpcExceptions to Sentry', async ({ baseURL }) => {
let errorEventOccurred = false;

waitForError('node-nestjs-basic', event => {
if (!event.type && event.exception?.values?.[0]?.value === 'This is an expected RPC exception with id 123') {
errorEventOccurred = true;
}

return event?.transaction === 'GET /test-expected-rpc-exception/:id';
});

const transactionEventPromise = waitForTransaction('node-nestjs-basic', transactionEvent => {
return transactionEvent?.transaction === 'GET /test-expected-rpc-exception/:id';
});

const response = await fetch(`${baseURL}/test-expected-rpc-exception/123`);
expect(response.status).toBe(500);

await transactionEventPromise;

await new Promise(resolve => setTimeout(resolve, 10000));

expect(errorEventOccurred).toBe(false);
});
6 changes: 4 additions & 2 deletions packages/nestjs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,13 @@
},
"devDependencies": {
"@nestjs/common": "^8.0.0 || ^9.0.0 || ^10.0.0",
"@nestjs/core": "^8.0.0 || ^9.0.0 || ^10.0.0"
"@nestjs/core": "^8.0.0 || ^9.0.0 || ^10.0.0",
"@nestjs/microservices": "^8.0.0 || ^9.0.0 || ^10.0.0"
},
"peerDependencies": {
"@nestjs/common": "^8.0.0 || ^9.0.0 || ^10.0.0",
"@nestjs/core": "^8.0.0 || ^9.0.0 || ^10.0.0"
"@nestjs/core": "^8.0.0 || ^9.0.0 || ^10.0.0",
"@nestjs/microservices": "^8.0.0 || ^9.0.0 || ^10.0.0"
},
"scripts": {
"build": "run-p build:transpile build:types",
Expand Down
3 changes: 2 additions & 1 deletion packages/nestjs/src/setup.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import { Catch } from '@nestjs/common';
import { Injectable } from '@nestjs/common';
import { Global, Module } from '@nestjs/common';
import { APP_FILTER, APP_INTERCEPTOR, BaseExceptionFilter } from '@nestjs/core';
import { RpcException } from '@nestjs/microservices';
Copy link

Choose a reason for hiding this comment

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

This breaks NestJS projects which don't use @nestjs/microservices.

I've tried creating an issue, but couldn't submit it because GH kept showing "Something went wrong" popup.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks for writing in! I am currently working on a fix for the nest SDK and will remove the dependency again as part of that PR. ref

import {
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
Expand Down Expand Up @@ -68,7 +69,7 @@ class SentryGlobalFilter extends BaseExceptionFilter {
*/
public catch(exception: unknown, host: ArgumentsHost): void {
// don't report expected errors
if (exception instanceof HttpException) {
if (exception instanceof HttpException || exception instanceof RpcException) {
return super.catch(exception, host);
}

Expand Down
7 changes: 4 additions & 3 deletions packages/node/src/integrations/tracing/nest/nest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import type { IntegrationFn, Span } from '@sentry/types';
import { logger } from '@sentry/utils';
import { generateInstrumentOnce } from '../../../otel/instrument';
import { SentryNestInstrumentation } from './sentry-nest-instrumentation';
import type { MinimalNestJsApp, NestJsErrorFilter } from './types';
import type { ExpectedException, MinimalNestJsApp, NestJsErrorFilter } from './types';

const INTEGRATION_NAME = 'Nest';

Expand Down Expand Up @@ -87,10 +87,11 @@ export function setupNestErrorHandler(app: MinimalNestJsApp, baseFilter: NestJsE
const originalCatch = Reflect.get(target, prop, receiver);

return (exception: unknown, host: unknown) => {
const status_code = (exception as { status?: number }).status;
const status_code = (exception as ExpectedException).status;
const error_property = (exception as ExpectedException).error;

// don't report expected errors
if (status_code !== undefined) {
if (status_code !== undefined || error_property !== undefined) {
return originalCatch.apply(target, [exception, host]);
}

Copy link
Member

Choose a reason for hiding this comment

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

h: Let's go for something like the following here:

const exceptionIsObject = typeof exception === 'object' && exception !== null;
const exceptionStatusCode = exceptionIsObject && 'status' in exception ? exception.status : null;
const exceptionErrorProperty = exceptionIsObject && 'error' in exception ? exception.error : null;

// Only report expected errors
// - ExpectedNestJS control flow errors that with status codes like NestJS' `HttpException` errors will have a `status` property.
// - NestJS' expected `RpcExceptions` will have an `error` property
if (exceptionStatusCode === null && exceptionErrorProperty === null) {
    captureException(exception, {
        mechanism: {
        handled: false,
        },
    });
}

return originalCatch.apply(target, [exception, host]);

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Why? It's not immediately obvious to me how that improves the current implementation

Copy link
Member

@lforst lforst Aug 5, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

The current implementation will throw if the error is nullish, which can always happen. We should avoid doing any type casts (as) as much as possible. The change I suggested does runtime checks not to throw when nullish values are passed.

Also, we should add documentation. Somebody who comes across the code is basically in the dark what it means to look on the status or error props.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok sure, thanks for clarifying. Will update

Expand Down
10 changes: 10 additions & 0 deletions packages/node/src/integrations/tracing/nest/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,16 @@ export interface MinimalNestJsApp {
}) => void;
}

/**
* Interface for an expected exception in nest.
*
* Expected exceptions in nest are HttpExceptions (have a status property) or RpcExceptions (have an error property).
*/
export interface ExpectedException {
status?: number;
error?: string | object;
}

/**
* A minimal interface for an Observable.
*/
Expand Down
8 changes: 8 additions & 0 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6135,6 +6135,14 @@
path-to-regexp "3.2.0"
tslib "2.6.3"

"@nestjs/microservices@^8.0.0 || ^9.0.0 || ^10.0.0":
version "10.3.10"
resolved "https://registry.yarnpkg.com/@nestjs/microservices/-/microservices-10.3.10.tgz#e00957e0c22b0cc8b041242a40538e2d862255fb"
integrity sha512-zZrilhZmXU2Ik5Usrcy4qEX262Uhvz0/9XlIdX6SRn8I39ns1EE9tAhEBmmkMwh7lsEikRFa4aaa05loi8Gsow==
dependencies:
iterare "1.2.1"
tslib "2.6.3"

"@nestjs/platform-express@^10.3.3":
version "10.3.3"
resolved "https://registry.yarnpkg.com/@nestjs/platform-express/-/platform-express-10.3.3.tgz#c1484d30d1e7666c4c8d0d7cde31cfc0b9d166d7"
Expand Down
Loading