Skip to content

test(e2e): Port the nestjs-fastify E2E app to span streaming #24100

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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
chargome wants to merge 1 commit into
base: develop
Choose a base branch
from
Draft

test(e2e): Port the nestjs-fastify E2E app to span streaming #24100

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 0 additions & 1 deletion dev-packages/e2e-tests/test-applications/nestjs-fastify/src/instrument.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
import * as Sentry from '@sentry/nestjs';

Sentry.init({
traceLifecycle: 'static',
environment: 'qa', // dynamic sampling bias to keep transactions
dsn: process.env.E2E_TEST_DSN,
tunnel: `http://localhost:3031/`, // proxy server
Expand Down
58 changes: 28 additions & 30 deletions dev-packages/e2e-tests/test-applications/nestjs-fastify/tests/errors.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,18 @@
import { expect, test } from '@playwright/test';
import { waitForError, waitForTransaction } from '@sentry-internal/test-utils';
import { waitForError, waitForStreamedSpan } from '@sentry-internal/test-utils';

const APP_NAME = 'nestjs-fastify';

/**
* Resolves once the request's segment span has been streamed, which is how these specs know the
* request finished and any error it would have produced had its chance to be sent.
*/
function waitForSegmentSpan(name: string): Promise<unknown> {
return waitForStreamedSpan(APP_NAME, span => span.is_segment && span.name === name);
}
Comment on lines +10 to +12

@andreiborza andreiborza Sep 4, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

We keep repeating this helper, can we just pull it up and use it across our e2e suote?


test('Sends exception to Sentry', async ({ baseURL }) => {
const errorEventPromise = waitForError('nestjs-fastify', event => {
const errorEventPromise = waitForError(APP_NAME, event => {
return !event.type && event.exception?.values?.[0]?.value === 'This is an exception with id 123';
});

Expand All @@ -13,7 +23,6 @@ test('Sends exception to Sentry', async ({ baseURL }) => {

expect(errorEvent.exception?.values).toHaveLength(1);
expect(errorEvent.exception?.values?.[0]?.value).toBe('This is an exception with id 123');

expect(errorEvent.exception?.values?.[0]?.mechanism).toEqual({
handled: false,
type: 'auto.http.nestjs.global_filter',
Expand All @@ -29,47 +38,42 @@ test('Sends exception to Sentry', async ({ baseURL }) => {
expect(errorEvent.transaction).toEqual('GET /test-exception/:id');

expect(errorEvent.contexts?.trace).toEqual({
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
span_id: expect.stringMatching(/[a-f0-9]{16}/),
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
});
});

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

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

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

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

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

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

const transactionEventPromise500 = waitForTransaction('nestjs-fastify', transactionEvent => {
return transactionEvent?.transaction === 'GET /test-expected-500-exception/:id';
});
const segmentSpanPromise400 = waitForSegmentSpan('GET /test-expected-400-exception/:id');
const segmentSpanPromise500 = waitForSegmentSpan('GET /test-expected-500-exception/:id');

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

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

await transactionEventPromise400;
await transactionEventPromise500;
await segmentSpanPromise400;
await segmentSpanPromise500;

(await fetch(`${baseURL}/flush`)).text();

Expand All @@ -79,22 +83,20 @@ test('Does not send HttpExceptions to Sentry', async ({ baseURL }) => {
test('Does not send RpcExceptions to Sentry', async ({ baseURL }) => {
let errorEventOccurred = false;

waitForError('nestjs-fastify', event => {
waitForError(APP_NAME, 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-fastify', transactionEvent => {
return transactionEvent?.transaction === 'GET /test-expected-rpc-exception/:id';
});
const segmentSpanPromise = waitForSegmentSpan('GET /test-expected-rpc-exception/:id');

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

await transactionEventPromise;
await segmentSpanPromise;

(await fetch(`${baseURL}/flush`)).text();

Expand All @@ -106,17 +108,15 @@ test('Global exception filter registered in main module is applied and exception
}) => {
let errorEventOccurred = false;

waitForError('nestjs-fastify', event => {
waitForError(APP_NAME, event => {
if (!event.type && event.exception?.values?.[0]?.value === 'Example exception was handled by global filter!') {
errorEventOccurred = true;
}

return event?.transaction === 'GET /example-exception-global-filter';
});

const transactionEventPromise = waitForTransaction('nestjs-fastify', transactionEvent => {
return transactionEvent?.transaction === 'GET /example-exception-global-filter';
});
const segmentSpanPromise = waitForSegmentSpan('GET /example-exception-global-filter');

const response = await fetch(`${baseURL}/example-exception-global-filter`);
const responseBody = await response.json();
Expand All @@ -129,7 +129,7 @@ test('Global exception filter registered in main module is applied and exception
message: 'Example exception was handled by global filter!',
});

await transactionEventPromise;
await segmentSpanPromise;

(await fetch(`${baseURL}/flush`)).text();

Expand All @@ -141,17 +141,15 @@ test('Local exception filter registered in main module is applied and exception
}) => {
let errorEventOccurred = false;

waitForError('nestjs-fastify', event => {
waitForError(APP_NAME, event => {
if (!event.type && event.exception?.values?.[0]?.value === 'Example exception was handled by local filter!') {
errorEventOccurred = true;
}

return event?.transaction === 'GET /example-exception-local-filter';
});

const transactionEventPromise = waitForTransaction('nestjs-fastify', transactionEvent => {
return transactionEvent?.transaction === 'GET /example-exception-local-filter';
});
const segmentSpanPromise = waitForSegmentSpan('GET /example-exception-local-filter');

const response = await fetch(`${baseURL}/example-exception-local-filter`);
const responseBody = await response.json();
Expand All @@ -164,7 +162,7 @@ test('Local exception filter registered in main module is applied and exception
message: 'Example exception was handled by local filter!',
});

await transactionEventPromise;
await segmentSpanPromise;

(await fetch(`${baseURL}/flush`)).text();

Expand Down
76 changes: 27 additions & 49 deletions dev-packages/e2e-tests/test-applications/nestjs-fastify/tests/span-decorator.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,73 +1,51 @@
import { expect, test } from '@playwright/test';
import { waitForTransaction } from '@sentry-internal/test-utils';
import { collectStreamedSpansUntilSegment } from '@sentry-internal/test-utils';

test('Transaction includes span and correct value for decorated async function', async ({ baseURL }) => {
const transactionEventPromise = waitForTransaction('nestjs-fastify', transactionEvent => {
return (
transactionEvent?.contexts?.trace?.op === 'http.server' &&
transactionEvent?.transaction === 'GET /test-span-decorator-async'
);
});
const APP_NAME = 'nestjs-fastify';

test('Trace includes span and correct value for decorated async function', async ({ baseURL }) => {
const spansPromise = collectStreamedSpansUntilSegment(APP_NAME, 'GET /test-span-decorator-async');

const response = await fetch(`${baseURL}/test-span-decorator-async`);
const body = await response.json();

expect(body.result).toEqual('test');

const transactionEvent = await transactionEventPromise;
const spans = await spansPromise;

expect(transactionEvent.spans).toEqual(
expect.arrayContaining([
expect.objectContaining({
span_id: expect.stringMatching(/[a-f0-9]{16}/),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
data: {
'sentry.origin': 'auto.function.nestjs.sentry_traced',
'sentry.op': 'wait and return a string',
},
description: 'wait',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
status: 'ok',
op: 'wait and return a string',
origin: 'auto.function.nestjs.sentry_traced',
expect(spans).toContainEqual(
expect.objectContaining({
name: 'wait',
is_segment: false,
status: 'ok',
attributes: expect.objectContaining({
'sentry.origin': { type: 'string', value: 'auto.function.nestjs.sentry_traced' },
'sentry.op': { type: 'string', value: 'wait and return a string' },
}),
]),
}),
);
});

test('Transaction includes span and correct value for decorated sync function', async ({ baseURL }) => {
const transactionEventPromise = waitForTransaction('nestjs-fastify', transactionEvent => {
return (
transactionEvent?.contexts?.trace?.op === 'http.server' &&
transactionEvent?.transaction === 'GET /test-span-decorator-sync'
);
});
test('Trace includes span and correct value for decorated sync function', async ({ baseURL }) => {
const spansPromise = collectStreamedSpansUntilSegment(APP_NAME, 'GET /test-span-decorator-sync');

const response = await fetch(`${baseURL}/test-span-decorator-sync`);
const body = await response.json();

expect(body.result).toEqual('test');

const transactionEvent = await transactionEventPromise;
const spans = await spansPromise;

expect(transactionEvent.spans).toEqual(
expect.arrayContaining([
expect.objectContaining({
span_id: expect.stringMatching(/[a-f0-9]{16}/),
trace_id: expect.stringMatching(/[a-f0-9]{32}/),
data: {
'sentry.origin': 'auto.function.nestjs.sentry_traced',
'sentry.op': 'return a string',
},
description: 'getString',
parent_span_id: expect.stringMatching(/[a-f0-9]{16}/),
start_timestamp: expect.any(Number),
status: 'ok',
op: 'return a string',
origin: 'auto.function.nestjs.sentry_traced',
expect(spans).toContainEqual(
expect.objectContaining({
name: 'getString',
is_segment: false,
status: 'ok',
attributes: expect.objectContaining({
'sentry.origin': { type: 'string', value: 'auto.function.nestjs.sentry_traced' },
'sentry.op': { type: 'string', value: 'return a string' },
}),
]),
}),
);
});

Expand Down
Loading
Loading