Skip to content

feat(v9/react-router): Automatically flush on serverless for request handler #17242

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

Merged
merged 3 commits into from
Jul 31, 2025
+129 −54
Merged

feat(v9/react-router): Automatically flush on serverless for request handler #17242

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9582aa4
feat(core): Add shared `flushIfServerless` function (#17177)
s1gr1d Jul 30, 2025
68b30af
feat(react-router): Automatically flush on Vercel for request handler…
chargome Jul 30, 2025
65b1a4a
Merge branch 'v9' into cg-v9backport-rr-flush-requesthandler
chargome Jul 31, 2025
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
8 changes: 7 additions & 1 deletion packages/react-router/src/server/wrapSentryHandleRequest.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ import { context } from '@opentelemetry/api';
import { getRPCMetadata, RPCType } from '@opentelemetry/core';
import { ATTR_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
import {
flushIfServerless,
getActiveSpan,
getRootSpan,
getTraceMetaTags,
Expand Down Expand Up @@ -58,10 +59,15 @@ export function wrapSentryHandleRequest(originalHandle: OriginalHandleRequest):
});
}

return originalHandle(request, responseStatusCode, responseHeaders, routerContext, loadContext);
try {
return await originalHandle(request, responseStatusCode, responseHeaders, routerContext, loadContext);
} finally {
await flushIfServerless();
}
};
}

// todo(v11): remove this
/** @deprecated Use `wrapSentryHandleRequest` instead. */
export const sentryHandleRequest = wrapSentryHandleRequest;

Expand Down
175 changes: 122 additions & 53 deletions packages/react-router/test/server/wrapSentryHandleRequest.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { RPCType } from '@opentelemetry/core';
import { ATTR_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
import {
flushIfServerless,
getActiveSpan,
getRootSpan,
getTraceMetaTags,
Expand All @@ -15,13 +16,13 @@ vi.mock('@opentelemetry/core', () => ({
RPCType: { HTTP: 'http' },
getRPCMetadata: vi.fn(),
}));

vi.mock('@sentry/core', () => ({
SEMANTIC_ATTRIBUTE_SENTRY_SOURCE: 'sentry.source',
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN: 'sentry.origin',
getActiveSpan: vi.fn(),
getRootSpan: vi.fn(),
getTraceMetaTags: vi.fn(),
flushIfServerless: vi.fn(),
}));

describe('wrapSentryHandleRequest', () => {
Expand Down Expand Up @@ -62,7 +63,8 @@ describe('wrapSentryHandleRequest', () => {
(getActiveSpan as unknown as ReturnType<typeof vi.fn>).mockReturnValue(mockActiveSpan);
(getRootSpan as unknown as ReturnType<typeof vi.fn>).mockReturnValue(mockRootSpan);
const getRPCMetadata = vi.fn().mockReturnValue(mockRpcMetadata);
vi.mocked(vi.importActual('@opentelemetry/core')).getRPCMetadata = getRPCMetadata;
(vi.importActual('@opentelemetry/core') as unknown as { getRPCMetadata: typeof getRPCMetadata }).getRPCMetadata =
getRPCMetadata;

const routerContext = {
staticHandlerContext: {
Expand Down Expand Up @@ -110,7 +112,8 @@ describe('wrapSentryHandleRequest', () => {
(getActiveSpan as unknown as ReturnType<typeof vi.fn>).mockReturnValue(null);

const getRPCMetadata = vi.fn().mockReturnValue(mockRpcMetadata);
vi.mocked(vi.importActual('@opentelemetry/core')).getRPCMetadata = getRPCMetadata;
(vi.importActual('@opentelemetry/core') as unknown as { getRPCMetadata: typeof getRPCMetadata }).getRPCMetadata =
getRPCMetadata;

const routerContext = {
staticHandlerContext: {
Expand All @@ -122,6 +125,76 @@ describe('wrapSentryHandleRequest', () => {

expect(getRPCMetadata).not.toHaveBeenCalled();
});

test('should call flushIfServerless on successful execution', async () => {
const originalHandler = vi.fn().mockResolvedValue('success response');
const wrappedHandler = wrapSentryHandleRequest(originalHandler);

const request = new Request('https://example.com');
const responseStatusCode = 200;
const responseHeaders = new Headers();
const routerContext = { staticHandlerContext: { matches: [] } } as any;
const loadContext = {} as any;

await wrappedHandler(request, responseStatusCode, responseHeaders, routerContext, loadContext);

expect(flushIfServerless).toHaveBeenCalled();
});

test('should call flushIfServerless even when original handler throws an error', async () => {
const mockError = new Error('Handler failed');
const originalHandler = vi.fn().mockRejectedValue(mockError);
const wrappedHandler = wrapSentryHandleRequest(originalHandler);

const request = new Request('https://example.com');
const responseStatusCode = 200;
const responseHeaders = new Headers();
const routerContext = { staticHandlerContext: { matches: [] } } as any;
const loadContext = {} as any;

await expect(
wrappedHandler(request, responseStatusCode, responseHeaders, routerContext, loadContext),
).rejects.toThrow('Handler failed');

expect(flushIfServerless).toHaveBeenCalled();
});

test('should propagate errors from original handler', async () => {
const mockError = new Error('Test error');
const originalHandler = vi.fn().mockRejectedValue(mockError);
const wrappedHandler = wrapSentryHandleRequest(originalHandler);

const request = new Request('https://example.com');
const responseStatusCode = 500;
const responseHeaders = new Headers();
const routerContext = { staticHandlerContext: { matches: [] } } as any;
const loadContext = {} as any;

await expect(wrappedHandler(request, responseStatusCode, responseHeaders, routerContext, loadContext)).rejects.toBe(
mockError,
);
});
});

test('should not set span attributes when parameterized path does not exist', async () => {
const mockActiveSpan = {};
const mockRootSpan = { setAttributes: vi.fn() };

(getActiveSpan as unknown as ReturnType<typeof vi.fn>).mockReturnValue(mockActiveSpan);
(getRootSpan as unknown as ReturnType<typeof vi.fn>).mockReturnValue(mockRootSpan);

const originalHandler = vi.fn().mockResolvedValue('test');
const wrappedHandler = wrapSentryHandleRequest(originalHandler);

const routerContext = {
staticHandlerContext: {
matches: [],
},
} as any;

await wrappedHandler(new Request('https://guapo.chulo'), 200, new Headers(), routerContext, {} as any);

expect(mockRootSpan.setAttributes).not.toHaveBeenCalled();
});

describe('getMetaTagTransformer', () => {
Expand All @@ -132,68 +205,64 @@ describe('getMetaTagTransformer', () => {
);
});

test('should inject meta tags before closing head tag', done => {
const outputStream = new PassThrough();
const bodyStream = new PassThrough();
const transformer = getMetaTagTransformer(bodyStream);
test('should inject meta tags before closing head tag', () => {
return new Promise<void>(resolve => {
const bodyStream = new PassThrough();
const transformer = getMetaTagTransformer(bodyStream);

let outputData = '';
outputStream.on('data', chunk => {
outputData += chunk.toString();
});

outputStream.on('end', () => {
expect(outputData).toContain('<meta name="sentry-trace" content="test-trace-id"></head>');
expect(outputData).not.toContain('</head></head>');
done();
});
let outputData = '';
bodyStream.on('data', chunk => {
outputData += chunk.toString();
});

transformer.pipe(outputStream);
bodyStream.on('end', () => {
expect(outputData).toContain('<meta name="sentry-trace" content="test-trace-id"></head>');
expect(outputData).not.toContain('</head></head>');
resolve();
});

bodyStream.write('<html><head></head><body>Test</body></html>');
bodyStream.end();
transformer.write('<html><head></head><body>Test</body></html>');
transformer.end();
});
});

test('should not modify chunks without head closing tag', done => {
const outputStream = new PassThrough();
const bodyStream = new PassThrough();
const transformer = getMetaTagTransformer(bodyStream);

let outputData = '';
outputStream.on('data', chunk => {
outputData += chunk.toString();
});
test('should not modify chunks without head closing tag', () => {
return new Promise<void>(resolve => {
const bodyStream = new PassThrough();
const transformer = getMetaTagTransformer(bodyStream);

outputStream.on('end', () => {
expect(outputData).toBe('<html><body>Test</body></html>');
expect(getTraceMetaTags).toHaveBeenCalled();
done();
});
let outputData = '';
bodyStream.on('data', chunk => {
outputData += chunk.toString();
});

transformer.pipe(outputStream);
bodyStream.on('end', () => {
expect(outputData).toBe('<html><body>Test</body></html>');
resolve();
});

bodyStream.write('<html><body>Test</body></html>');
bodyStream.end();
transformer.write('<html><body>Test</body></html>');
transformer.end();
});
});

test('should handle buffer input', done => {
const outputStream = new PassThrough();
const bodyStream = new PassThrough();
const transformer = getMetaTagTransformer(bodyStream);

let outputData = '';
outputStream.on('data', chunk => {
outputData += chunk.toString();
});
test('should handle buffer input', () => {
return new Promise<void>(resolve => {
const bodyStream = new PassThrough();
const transformer = getMetaTagTransformer(bodyStream);

outputStream.on('end', () => {
expect(outputData).toContain('<meta name="sentry-trace" content="test-trace-id"></head>');
done();
});
let outputData = '';
bodyStream.on('data', chunk => {
outputData += chunk.toString();
});

transformer.pipe(outputStream);
bodyStream.on('end', () => {
expect(outputData).toContain('<meta name="sentry-trace" content="test-trace-id"></head>');
resolve();
});

bodyStream.write(Buffer.from('<html><head></head><body>Test</body></html>'));
bodyStream.end();
transformer.write(Buffer.from('<html><head></head><body>Test</body></html>'));
transformer.end();
});
});
});
Loading