Skip to content

feat(node): Add maxIncomingRequestBodySize #16225

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 4 commits into from
May 15, 2025
Merged

feat(node): Add maxIncomingRequestBodySize #16225

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
7a21af7
feat(node): Add `maxRequestBodySize`
s1gr1d May 7, 2025
bafd05f
review suggestions
s1gr1d May 8, 2025
190903a
fix import
s1gr1d May 8, 2025
0be545e
rename to `maxIncomingRequestBodySize`
s1gr1d May 13, 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
0 ...s/suites/express/with-http/instrument.mjs → ...tes/express/with-http/base/instrument.mjs
View file
Open in desktop
File renamed without changes.
0 ...sts/suites/express/with-http/scenario.mjs → ...uites/express/with-http/base/scenario.mjs
View file
Open in desktop
File renamed without changes.
0 ...on-tests/suites/express/with-http/test.ts → ...sts/suites/express/with-http/base/test.ts
View file
Open in desktop
File renamed without changes.
35 changes: 35 additions & 0 deletions ...ges/node-integration-tests/suites/express/with-http/maxRequestBodySize/generatePayload.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
// Payload for requests
export function generatePayload(sizeInBytes: number): { data: string } {
const baseSize = JSON.stringify({ data: '' }).length;
const contentLength = sizeInBytes - baseSize;

return { data: 'x'.repeat(contentLength) };
}

// Generate the "expected" body string
export function generatePayloadString(dataLength: number, truncate?: boolean): string {
const prefix = '{"data":"';
const suffix = truncate ? '...' : '"}';

const baseStructuralLength = prefix.length + suffix.length;
const dataContent = 'x'.repeat(dataLength - baseStructuralLength);

return `${prefix}${dataContent}${suffix}`;
}

// Functions for non-ASCII payloads (e.g. emojis)
export function generateEmojiPayload(sizeInBytes: number): { data: string } {
const baseSize = JSON.stringify({ data: '' }).length;
const contentLength = sizeInBytes - baseSize;

return { data: '👍'.repeat(contentLength) };
}
export function generateEmojiPayloadString(dataLength: number, truncate?: boolean): string {
const prefix = '{"data":"';
const suffix = truncate ? '...' : '"}';

const baseStructuralLength = suffix.length;
const dataContent = '👍'.repeat(dataLength - baseStructuralLength);

return `${prefix}${dataContent}${suffix}`;
}
10 changes: 10 additions & 0 deletions .../node-integration-tests/suites/express/with-http/maxRequestBodySize/instrument-always.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0',
tracesSampleRate: 1.0,
transport: loggingTransport,
integrations: [Sentry.httpIntegration({ maxRequestBodySize: 'always' })],
});
9 changes: 9 additions & 0 deletions ...node-integration-tests/suites/express/with-http/maxRequestBodySize/instrument-default.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0',
tracesSampleRate: 1.0,
transport: loggingTransport,
});
10 changes: 10 additions & 0 deletions .../node-integration-tests/suites/express/with-http/maxRequestBodySize/instrument-medium.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0',
tracesSampleRate: 1.0,
transport: loggingTransport,
integrations: [Sentry.httpIntegration({ maxRequestBodySize: 'medium' })],
});
10 changes: 10 additions & 0 deletions ...es/node-integration-tests/suites/express/with-http/maxRequestBodySize/instrument-none.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0',
tracesSampleRate: 1.0,
transport: loggingTransport,
integrations: [Sentry.httpIntegration({ maxRequestBodySize: 'none' })],
});
10 changes: 10 additions & 0 deletions ...s/node-integration-tests/suites/express/with-http/maxRequestBodySize/instrument-small.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
import * as Sentry from '@sentry/node';
import { loggingTransport } from '@sentry-internal/node-integration-tests';

Sentry.init({
dsn: 'https://public@dsn.ingest.sentry.io/1337',
release: '1.0',
tracesSampleRate: 1.0,
transport: loggingTransport,
integrations: [Sentry.httpIntegration({ maxRequestBodySize: 'small' })],
});
23 changes: 23 additions & 0 deletions dev-packages/node-integration-tests/suites/express/with-http/maxRequestBodySize/scenario.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
import * as Sentry from '@sentry/node';
import { startExpressServerAndSendPortToRunner } from '@sentry-internal/node-integration-tests';
import bodyParser from 'body-parser';
import express from 'express';

const app = express();

// Increase limit for JSON parsing
app.use(bodyParser.json({ limit: '3mb' }));
app.use(express.json({ limit: '3mb' }));

app.post('/test-body-size', (req, res) => {
const receivedSize = JSON.stringify(req.body).length;
res.json({
success: true,
receivedSize,
message: 'Payload processed successfully',
});
});

Sentry.setupExpressErrorHandler(app);

startExpressServerAndSendPortToRunner(app);
278 changes: 278 additions & 0 deletions dev-packages/node-integration-tests/suites/express/with-http/maxRequestBodySize/test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,278 @@
import { afterAll, describe, expect } from 'vitest';
import { cleanupChildProcesses, createEsmAndCjsTests } from '../../../../utils/runner';
import {
generateEmojiPayload,
generateEmojiPayloadString,
generatePayload,
generatePayloadString,
} from './generatePayload';

// Value of MAX_BODY_BYTE_LENGTH in SentryHttpIntegration
const MAX_GENERAL = 1024 * 1024; // 1MB
const MAX_MEDIUM = 10_000;
const MAX_SMALL = 1000;

describe('express with httpIntegration and not defined maxRequestBodySize', () => {
afterAll(() => {
cleanupChildProcesses();
});

createEsmAndCjsTests(__dirname, 'scenario.mjs', 'instrument-default.mjs', (createRunner, test) => {
test('captures medium request bodies with default setting (medium)', async () => {
const runner = createRunner()
.expect({
transaction: {
transaction: 'POST /test-body-size',
request: {
data: JSON.stringify(generatePayload(MAX_MEDIUM)),
},
},
})
.start();

await runner.makeRequest('post', '/test-body-size', {
headers: { 'Content-Type': 'application/json' },
data: JSON.stringify(generatePayload(MAX_MEDIUM)),
});

await runner.completed();
});

test('truncates large request bodies with default setting (medium)', async () => {
const runner = createRunner()
.expect({
transaction: {
transaction: 'POST /test-body-size',
request: {
data: generatePayloadString(MAX_MEDIUM, true),
},
},
})
.start();

await runner.makeRequest('post', '/test-body-size', {
headers: { 'Content-Type': 'application/json' },
data: JSON.stringify(generatePayload(MAX_MEDIUM + 1)),
});

await runner.completed();
});
});
});

describe('express with httpIntegration and maxRequestBodySize: "none"', () => {
afterAll(() => {
cleanupChildProcesses();
});

createEsmAndCjsTests(
__dirname,
'scenario.mjs',
'instrument-none.mjs',
(createRunner, test) => {
test('does not capture any request bodies with none setting', async () => {
const runner = createRunner()
.expect({
transaction: {
transaction: 'POST /test-body-size',
request: expect.not.objectContaining({
data: expect.any(String),
}),
},
})
.start();

await runner.makeRequest('post', '/test-body-size', {
headers: { 'Content-Type': 'application/json' },
data: JSON.stringify(generatePayload(500)),
});

await runner.completed();
});
},
{ failsOnEsm: false },
);
});

describe('express with httpIntegration and maxRequestBodySize: "always"', () => {
afterAll(() => {
cleanupChildProcesses();
});

createEsmAndCjsTests(
__dirname,
'scenario.mjs',
'instrument-always.mjs',
(createRunner, test) => {
test('captures maximum allowed request body length with "always" setting', async () => {
const runner = createRunner()
.expect({
transaction: {
transaction: 'POST /test-body-size',
request: {
data: JSON.stringify(generatePayload(MAX_GENERAL)),
},
},
})
.start();

await runner.makeRequest('post', '/test-body-size', {
headers: { 'Content-Type': 'application/json' },
data: JSON.stringify(generatePayload(MAX_GENERAL)),
});

await runner.completed();
});

test('captures large request bodies with "always" setting but respects maximum size limit', async () => {
const runner = createRunner()
.expect({
transaction: {
transaction: 'POST /test-body-size',
request: {
data: generatePayloadString(MAX_GENERAL, true),
},
},
})
.start();

await runner.makeRequest('post', '/test-body-size', {
headers: { 'Content-Type': 'application/json' },
data: JSON.stringify(generatePayload(MAX_GENERAL + 1)),
});

await runner.completed();
});
},
{ failsOnEsm: false },
);
});

describe('express with httpIntegration and maxRequestBodySize: "small"', () => {
afterAll(() => {
cleanupChildProcesses();
});

createEsmAndCjsTests(
__dirname,
'scenario.mjs',
'instrument-small.mjs',
(createRunner, test) => {
test('keeps small request bodies with "small" setting', async () => {
const runner = createRunner()
.expect({
transaction: {
transaction: 'POST /test-body-size',
request: {
data: JSON.stringify(generatePayload(MAX_SMALL)),
},
},
})
.start();

await runner.makeRequest('post', '/test-body-size', {
headers: { 'Content-Type': 'application/json' },
data: JSON.stringify(generatePayload(MAX_SMALL)),
});

await runner.completed();
});

test('truncates too large request bodies with "small" setting', async () => {
const runner = createRunner()
.expect({
transaction: {
transaction: 'POST /test-body-size',
request: {
data: generatePayloadString(MAX_SMALL, true),
},
},
})
.start();

await runner.makeRequest('post', '/test-body-size', {
headers: { 'Content-Type': 'application/json' },
data: JSON.stringify(generatePayload(MAX_SMALL + 1)),
});

await runner.completed();
});

test('truncates too large non-ASCII request bodies with "small" setting', async () => {
const runner = createRunner()
.expect({
transaction: {
transaction: 'POST /test-body-size',
request: {
// 250 emojis, each 4 bytes in UTF-8 (resulting in 1000 bytes --> MAX_SMALL)
data: generateEmojiPayloadString(250, true),
},
},
})
.start();

await runner.makeRequest('post', '/test-body-size', {
headers: { 'Content-Type': 'application/json' },
data: JSON.stringify(generateEmojiPayload(MAX_SMALL + 1)),
});

await runner.completed();
});
},
{ failsOnEsm: false },
);
});

describe('express with httpIntegration and maxRequestBodySize: "medium"', () => {
afterAll(() => {
cleanupChildProcesses();
});

createEsmAndCjsTests(
__dirname,
'scenario.mjs',
'instrument-medium.mjs',
(createRunner, test) => {
test('keeps medium request bodies with "medium" setting', async () => {
const runner = createRunner()
.expect({
transaction: {
transaction: 'POST /test-body-size',
request: {
data: JSON.stringify(generatePayload(MAX_MEDIUM)),
},
},
})
.start();

await runner.makeRequest('post', '/test-body-size', {
headers: { 'Content-Type': 'application/json' },
data: JSON.stringify(generatePayload(MAX_MEDIUM)),
});

await runner.completed();
});

test('truncates large request bodies with "medium" setting', async () => {
const runner = createRunner()
.expect({
transaction: {
transaction: 'POST /test-body-size',
request: {
data: generatePayloadString(MAX_MEDIUM, true),
},
},
})
.start();

await runner.makeRequest('post', '/test-body-size', {
headers: { 'Content-Type': 'application/json' },
data: JSON.stringify(generatePayload(MAX_MEDIUM + 1)),
});

await runner.completed();
});
},
{ failsOnEsm: false },
);
});
Loading
Loading