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

Warn when mutating res if not streaming #30284

Merged
merged 2 commits into from Oct 26, 2021
Merged

Warn when mutating res if not streaming #30284

merged 2 commits into from Oct 26, 2021

Conversation

kara
Copy link
Collaborator

@kara kara commented Oct 25, 2021

In #29010, we started throwing an error if the res was mutated after
getServerSideProps() returned. This was to support classic streaming,
where it would be possible to accidentally mutate the response headers
after they were already sent. However, this change also caught a few
non-streaming cases

that we don't want to break.

As such, with this change, we only throw the error if res is mutated
after gSSP returns and you've opted into using classic streaming.
Otherwise, we will only add a warning to the console.

@ijjk ijjk added created-by: Chrome Aurora PRs by the Google Chrome team: https://web.dev/aurora area: documentation type: next labels Oct 25, 2021
@kara kara marked this pull request as ready for review October 25, 2021 22:33
styfle
styfle previously approved these changes Oct 25, 2021
Copy link
Member

@styfle styfle left a comment

Choose a reason for hiding this comment

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

Thanks!

ijjk
ijjk previously approved these changes Oct 25, 2021
@ijjk

This comment has been minimized.

@ijjk

This comment has been minimized.

In vercel#29010, we started throwing an error if the res was mutated after
getServerSideProps() returned. This was to support classic streaming,
where it would be possible to accidentally mutate the response headers
after they were already sent. However, this change also caught [a few
non-streaming cases](vercel#29010 (comment)) that we don't want to break.

As such, with this change, we only throw the error if res is mutated
after gSSP returns *and* you've opted into using classic streaming.
Otherwise, we will only add a warning to the console.
ijjk
ijjk approved these changes Oct 25, 2021
@ijjk
Copy link
Member

ijjk commented Oct 25, 2021

Stats from current PR

Default Build (Increase detected ⚠️)
General Overall increase ⚠️
vercel/next.js canary kara/next.js mutate Change
buildDuration 21.6s 19.4s -2.2s
buildDurationCached 4s 4.4s ⚠️ +446ms
nodeModulesSize 475 MB 475 MB ⚠️ +561 B
Page Load Tests Overall increase ✓
vercel/next.js canary kara/next.js mutate Change
/ failed reqs 0 0
/ total time (seconds) 3.725 3.506 -0.22
/ avg req/sec 671.23 713.12 +41.89
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.843 1.858 ⚠️ +0.02
/error-in-render avg req/sec 1356.5 1345.89 ⚠️ -10.61
Client Bundles (main, webpack, commons)
vercel/next.js canary kara/next.js mutate Change
450.HASH.js gzip 179 B 179 B
framework-HASH.js gzip 42.2 kB 42.2 kB
main-HASH.js gzip 27.7 kB 27.7 kB
webpack-HASH.js gzip 1.45 kB 1.45 kB
Overall change 71.5 kB 71.5 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary kara/next.js mutate Change
polyfills-a4..dd70.js gzip 31 kB 31 kB
Overall change 31 kB 31 kB
Client Pages
vercel/next.js canary kara/next.js mutate Change
_app-HASH.js gzip 1.23 kB 1.23 kB
_error-HASH.js gzip 194 B 194 B
amp-HASH.js gzip 312 B 312 B
css-HASH.js gzip 327 B 327 B
dynamic-HASH.js gzip 2.38 kB 2.38 kB
head-HASH.js gzip 350 B 350 B
hooks-HASH.js gzip 635 B 635 B
image-HASH.js gzip 4.44 kB 4.44 kB
index-HASH.js gzip 263 B 263 B
link-HASH.js gzip 1.87 kB 1.87 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
334f979574ae..6f4.css gzip 106 B 106 B
Overall change 13.1 kB 13.1 kB
Client Build Manifests
vercel/next.js canary kara/next.js mutate Change
_buildManifest.js gzip 459 B 459 B
Overall change 459 B 459 B
Rendered Page Sizes
vercel/next.js canary kara/next.js mutate Change
index.html gzip 534 B 534 B
link.html gzip 546 B 546 B
withRouter.html gzip 528 B 528 B
Overall change 1.61 kB 1.61 kB

Default Build with SWC (Increase detected ⚠️)
General Overall increase ⚠️
vercel/next.js canary kara/next.js mutate Change
buildDuration 17.4s 17.3s -109ms
buildDurationCached 4s 4s -11ms
nodeModulesSize 475 MB 475 MB ⚠️ +561 B
Page Load Tests Overall increase ✓
vercel/next.js canary kara/next.js mutate Change
/ failed reqs 0 0
/ total time (seconds) 3.683 3.495 -0.19
/ avg req/sec 678.71 715.37 +36.66
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.871 1.849 -0.02
/error-in-render avg req/sec 1335.83 1351.88 +16.05
Client Bundles (main, webpack, commons)
vercel/next.js canary kara/next.js mutate Change
450.HASH.js gzip 179 B 179 B
framework-HASH.js gzip 42.2 kB 42.2 kB
main-HASH.js gzip 27.8 kB 27.8 kB
webpack-HASH.js gzip 1.43 kB 1.43 kB
Overall change 71.6 kB 71.6 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary kara/next.js mutate Change
polyfills-a4..dd70.js gzip 31 kB 31 kB
Overall change 31 kB 31 kB
Client Pages
vercel/next.js canary kara/next.js mutate Change
_app-HASH.js gzip 1.22 kB 1.22 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.38 kB 2.38 kB
head-HASH.js gzip 342 B 342 B
hooks-HASH.js gzip 621 B 621 B
image-HASH.js gzip 4.46 kB 4.46 kB
index-HASH.js gzip 256 B 256 B
link-HASH.js gzip 1.9 kB 1.9 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
334f979574ae..6f4.css gzip 106 B 106 B
Overall change 13.1 kB 13.1 kB
Client Build Manifests
vercel/next.js canary kara/next.js mutate Change
_buildManifest.js gzip 459 B 459 B
Overall change 459 B 459 B
Rendered Page Sizes
vercel/next.js canary kara/next.js mutate Change
index.html gzip 534 B 534 B
link.html gzip 547 B 547 B
withRouter.html gzip 528 B 528 B
Overall change 1.61 kB 1.61 kB
Commit: 2730e4b

@ijjk

This comment has been minimized.

@ijjk ijjk merged commit f6c58cb into vercel:canary Oct 26, 2021
31 of 33 checks passed
@vercel vercel locked as resolved and limited conversation to collaborators Jan 27, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area: documentation created-by: Chrome Aurora PRs by the Google Chrome team: https://web.dev/aurora type: next
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants