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.

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

Add API config to allow disabling response size warning #34700

Merged
merged 15 commits into from
Feb 25, 2022

Conversation

crice88
Copy link
Contributor

@crice88 crice88 commented Feb 23, 2022

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

This comment has been minimized.

@ijjk 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
ijjk previously approved these changes Feb 23, 2022
Copy link
Member

@ijjk ijjk left a comment

Choose a reason for hiding this comment

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

Thanks for the PR!

@kachkaev
Copy link
Contributor

kachkaev commented Feb 23, 2022

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

@ijjk

This comment has been minimized.

@700software
Copy link

700software commented Feb 23, 2022

#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
Copy link
Contributor Author

crice88 commented Feb 23, 2022

Added documentation as well as a way to customize the bodyLimit

@ijjk

This comment has been minimized.

packages/next/package.json Outdated Show resolved Hide resolved
@crice88
Copy link
Contributor Author

crice88 commented Feb 23, 2022

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

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

This comment was marked as outdated.

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
@ijjk

This comment has been minimized.

@ijjk

This comment has been minimized.

@ijjk
Copy link
Member

ijjk commented Feb 25, 2022

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

@kodiakhq kodiakhq bot merged commit 079b507 into vercel:canary Feb 25, 2022
@ijjk ijjk mentioned this pull request Feb 25, 2022
1 task
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 27, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
4 participants