Add API config to allow disabling response size warning #34700

crice88 · 2022-02-23T00:39:05Z

Adds an API config option that disables warning a user when their API response body is over 4 megs. This has been added for users who'd like to stream larger amounts of data from their API acknowledging the drawbacks. This config mirrors the existing externalResolver config.

Closes: #33162

ijjk

Thanks for the PR!

kachkaev · 2022-02-23T01:15:50Z

Would it be more reasonable to allow a custom threshold? Docs might need updating too – otherwise the feature is hidden.

packages/next/types/index.d.ts

Hold

…nto add-body-limit-config

700software · 2022-02-23T16:43:36Z

#34700 (comment)

@crice88, The original implementation seems to already measure bytes?
https://github.com/vercel/next.js/pull/26831/files#diff-098f0eca63ed374378d9984a17c485bcfb01793e8f8b5bb82af4d15a28c2127bR75

Docs might need updating too – otherwise the feature is hidden.

Agreed

crice88 · 2022-02-23T17:09:22Z

Added documentation as well as a way to customize the bodyLimit

packages/next/package.json

docs/api-routes/api-middlewares.md

…precompile

crice88 · 2022-02-23T20:31:27Z

Changed bodyLimit to responseLimit. Moved bytes underneath dev deps and added the reference to the pre compile step.

docs/api-routes/api-middlewares.md

packages/next/server/api-utils/index.ts

…nto add-body-limit-config

packages/next/types/index.d.ts

ijjk · 2022-02-25T01:52:13Z

Stats from current PR

Default Build (Increase detected ⚠️)

General Overall increase ⚠️

	vercel/next.js canary	crice88/next.js add-body-limit-config	Change
buildDuration	21.4s	20.7s	-737ms
buildDurationCached	8.1s	8.1s	⚠️ +22ms
nodeModulesSize	367 MB	367 MB	⚠️ +2.39 kB

Page Load Tests Overall increase ✓

	vercel/next.js canary	crice88/next.js add-body-limit-config	Change
/ failed reqs	0	0	✓
/ total time (seconds)	4.329	4.319	-0.01
/ avg req/sec	577.55	578.86	+1.31
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	2.291	2.212	-0.08
/error-in-render avg req/sec	1091.31	1130.08	+38.77

Client Bundles (main, webpack)

	vercel/next.js canary	crice88/next.js add-body-limit-config	Change
450.HASH.js gzip	179 B	179 B	✓
framework-HASH.js gzip	42 kB	42 kB	✓
main-HASH.js gzip	27.8 kB	27.8 kB	✓
webpack-HASH.js gzip	1.44 kB	1.44 kB	✓
Overall change	71.5 kB	71.5 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	crice88/next.js add-body-limit-config	Change
polyfills-HASH.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	crice88/next.js add-body-limit-config	Change
_app-HASH.js gzip	1.36 kB	1.36 kB	✓
_error-HASH.js gzip	194 B	194 B	✓
amp-HASH.js gzip	312 B	312 B	✓
css-HASH.js gzip	326 B	326 B	✓
dynamic-HASH.js gzip	2.57 kB	2.57 kB	✓
head-HASH.js gzip	350 B	350 B	✓
hooks-HASH.js gzip	919 B	919 B	✓
image-HASH.js gzip	5.05 kB	5.05 kB	✓
index-HASH.js gzip	263 B	263 B	✓
link-HASH.js gzip	2.26 kB	2.26 kB	✓
routerDirect..HASH.js gzip	321 B	321 B	✓
script-HASH.js gzip	383 B	383 B	✓
withRouter-HASH.js gzip	318 B	318 B	✓
85e02e95b279..7e3.css gzip	107 B	107 B	✓
Overall change	14.7 kB	14.7 kB	✓

Client Build Manifests

	vercel/next.js canary	crice88/next.js add-body-limit-config	Change
_buildManifest.js gzip	460 B	460 B	✓
Overall change	460 B	460 B	✓

Rendered Page Sizes

	vercel/next.js canary	crice88/next.js add-body-limit-config	Change
index.html gzip	531 B	531 B	✓
link.html gzip	544 B	544 B	✓
withRouter.html gzip	526 B	526 B	✓
Overall change	1.6 kB	1.6 kB	✓

Default Build with SWC (Decrease detected ✓)

General Overall increase ⚠️

	vercel/next.js canary	crice88/next.js add-body-limit-config	Change
buildDuration	25.7s	25.8s	⚠️ +118ms
buildDurationCached	8.2s	8s	-162ms
nodeModulesSize	367 MB	367 MB	⚠️ +2.39 kB

Page Load Tests Overall decrease ⚠️

	vercel/next.js canary	crice88/next.js add-body-limit-config	Change
/ failed reqs	0	0	✓
/ total time (seconds)	4.304	4.266	-0.04
/ avg req/sec	580.92	586.06	+5.14
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	2.23	2.243	⚠️ +0.01
/error-in-render avg req/sec	1121.27	1114.77	⚠️ -6.5

Client Bundles (main, webpack)

	vercel/next.js canary	crice88/next.js add-body-limit-config	Change
450.HASH.js gzip	179 B	179 B	✓
framework-HASH.js gzip	42.1 kB	42.1 kB	✓
main-HASH.js gzip	27.8 kB	27.8 kB	✓
webpack-HASH.js gzip	1.44 kB	1.44 kB	✓
Overall change	71.6 kB	71.6 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	crice88/next.js add-body-limit-config	Change
polyfills-HASH.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	crice88/next.js add-body-limit-config	Change
_app-HASH.js gzip	1.35 kB	1.35 kB	✓
_error-HASH.js gzip	180 B	180 B	✓
amp-HASH.js gzip	305 B	305 B	✓
css-HASH.js gzip	321 B	321 B	✓
dynamic-HASH.js gzip	2.56 kB	2.56 kB	✓
head-HASH.js gzip	342 B	342 B	✓
hooks-HASH.js gzip	911 B	911 B	✓
image-HASH.js gzip	5.08 kB	5.08 kB	✓
index-HASH.js gzip	256 B	256 B	✓
link-HASH.js gzip	2.28 kB	2.28 kB	✓
routerDirect..HASH.js gzip	314 B	314 B	✓
script-HASH.js gzip	375 B	375 B	✓
withRouter-HASH.js gzip	309 B	309 B	✓
85e02e95b279..7e3.css gzip	107 B	107 B	✓
Overall change	14.7 kB	14.7 kB	✓

Client Build Manifests

	vercel/next.js canary	crice88/next.js add-body-limit-config	Change
_buildManifest.js gzip	459 B	459 B	✓
Overall change	459 B	459 B	✓

Rendered Page Sizes

	vercel/next.js canary	crice88/next.js add-body-limit-config	Change
index.html gzip	534 B	534 B	✓
link.html gzip	547 B	547 B	✓
withRouter.html gzip	527 B	527 B	✓
Overall change	1.61 kB	1.61 kB	✓

Commit: ba3990b

crice88 added 2 commits February 22, 2022 16:28

adding api config to allow disabling body limit warning

95a72e2

fixing test verbiage

8388864

crice88 requested review from timneutkens, ijjk, shuding and huozhi as code owners February 23, 2022 00:39

ijjk added the type: next label Feb 23, 2022

This comment has been minimized.

Sign in to view

ijjk changed the title ~~adding api config to allow disabling body limit warning~~ Add API config to allow disabling response size warning Feb 23, 2022

ijjk previously approved these changes Feb 23, 2022

View reviewed changes

Merge branch 'canary' into add-body-limit-config

3c3212b

kachkaev reviewed Feb 23, 2022

View reviewed changes

packages/next/types/index.d.ts Outdated Show resolved Hide resolved

This comment has been minimized.

Sign in to view

crice88 added 2 commits February 22, 2022 18:49

adding a configurable bodyLimit object

bd49d16

Merge branch 'add-body-limit-config' of github.com:/crice88/next.js i…

f8fac1e

…nto add-body-limit-config

updating api-middlewares documentation

e1d053a

crice88 requested review from styfle, padmaia and leerob as code owners February 23, 2022 17:00

ijjk added the area: documentation label Feb 23, 2022

crice88 requested a review from ijjk February 23, 2022 17:03

This comment has been minimized.

Sign in to view

ijjk reviewed Feb 23, 2022

View reviewed changes

packages/next/package.json Outdated Show resolved Hide resolved

ijjk reviewed Feb 23, 2022

View reviewed changes

docs/api-routes/api-middlewares.md Outdated Show resolved Hide resolved

crice88 added 2 commits February 23, 2022 12:27

updating name of config object, pushing bytes into dev deps to allow …

a0ffd06

…precompile

Merge branch 'canary' into add-body-limit-config

6f31935

crice88 requested a review from ijjk February 23, 2022 20:32

This comment was marked as outdated.

Sign in to view

700software reviewed Feb 24, 2022

View reviewed changes

docs/api-routes/api-middlewares.md Outdated Show resolved Hide resolved

docs/api-routes/api-middlewares.md Outdated Show resolved Hide resolved

packages/next/server/api-utils/index.ts Outdated Show resolved Hide resolved

crice88 and others added 3 commits February 24, 2022 08:53

updating documentation

3f92114

Merge branch 'add-body-limit-config' of github.com:/crice88/next.js i…

a70302f

…nto add-body-limit-config

update compiled

18c2f95

This comment has been minimized.

Sign in to view

ijjk reviewed Feb 24, 2022

View reviewed changes

packages/next/types/index.d.ts Outdated Show resolved Hide resolved

crice88 added 2 commits February 24, 2022 15:00

flattening responseLimit object structure

6b6f6b0

Merge branch 'canary' into add-body-limit-config

f83b48c

This comment has been minimized.

Sign in to view

ensure previous link keeps working

abca418

ijjk approved these changes Feb 25, 2022

View reviewed changes

Merge branch 'canary' into add-body-limit-config

ba3990b

kodiakhq bot merged commit 079b507 into vercel:canary Feb 25, 2022

ijjk mentioned this pull request Feb 25, 2022

Add redirect for error doc rename #34791

Merged

1 task

github-actions bot locked as resolved and limited conversation to collaborators Mar 27, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add API config to allow disabling response size warning #34700

Add API config to allow disabling response size warning #34700

crice88 commented Feb 23, 2022 •

edited by ijjk

This comment has been minimized.

ijjk left a comment

kachkaev commented Feb 23, 2022 •

edited

This comment has been minimized.

700software commented Feb 23, 2022 •

edited

crice88 commented Feb 23, 2022

This comment has been minimized.

crice88 commented Feb 23, 2022

This comment was marked as outdated.

This comment has been minimized.

This comment has been minimized.

ijjk commented Feb 25, 2022

Add API config to allow disabling response size warning #34700

Add API config to allow disabling response size warning #34700

Conversation

crice88 commented Feb 23, 2022 • edited by ijjk

This comment has been minimized.

ijjk left a comment

Choose a reason for hiding this comment

kachkaev commented Feb 23, 2022 • edited

This comment has been minimized.

700software commented Feb 23, 2022 • edited

crice88 commented Feb 23, 2022

This comment has been minimized.

crice88 commented Feb 23, 2022

This comment was marked as outdated.

This comment has been minimized.

This comment has been minimized.

ijjk commented Feb 25, 2022

Stats from current PR

crice88 commented Feb 23, 2022 •

edited by ijjk

kachkaev commented Feb 23, 2022 •

edited

700software commented Feb 23, 2022 •

edited