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 RequestContext #27303

Merged
merged 24 commits into from
Jul 20, 2021
Merged

Add RequestContext #27303

merged 24 commits into from
Jul 20, 2021

Conversation

devknoll
Copy link
Contributor

@devknoll devknoll commented Jul 19, 2021

How a page is rendered depends on whether or not we're streaming. For example, if we're just rendering to a string or we're generating a response for a crawler or other robot, we don't want React 18 to dynamically flush <script> tags to update Suspense boundaries as they resolve. Instead, we just want to wait for the full HTML to resolve and return a result similar to renderToString.

This is what RequestContext and the new/refactored pipe and getStaticHTML methods allow. They add a requireStaticHTML option that gets passed down. A follow-up PR will make sure this is true when serving a robot, and also ensure React is invoked appropriately.

@ijjk ijjk added created-by: Chrome Aurora PRs by the Google Chrome team: https://web.dev/aurora type: next labels Jul 19, 2021
@ijjk

This comment has been minimized.

@ijjk

This comment has been minimized.

@ijjk

This comment has been minimized.

@ijjk

This comment has been minimized.

@ijjk

This comment has been minimized.

@ijjk
Copy link
Member

ijjk commented Jul 19, 2021

Failing test suites

Commit: 9abb6a7

test/integration/build-indicator/test/index.test.js

  • Build Activity Indicator > Enabled > Shows build indicator when page is built from modifying
Expand output

● Build Activity Indicator › Enabled › Shows build indicator when page is built from modifying

expect(received).toBe(expected) // Object.is equality

Expected: true
Received: null

  62 |       const wasVisible = await browser.eval('window.showedBuilder')
  63 |
> 64 |       expect(wasVisible).toBe(true)
     |                          ^
  65 |       await fs.writeFile(pagePath, origContent, 'utf8')
  66 |       await browser.close()
  67 |     })

  at Object.<anonymous> (integration/build-indicator/test/index.test.js:64:26)

@ijjk

This comment has been minimized.

@devknoll devknoll changed the title Add RequestContext and simplify 404 handling Add RequestContext Jul 20, 2021
@devknoll devknoll mentioned this pull request Jul 20, 2021
@devknoll devknoll marked this pull request as ready for review July 20, 2021 03:31
shuding
shuding previously approved these changes Jul 20, 2021
huozhi
huozhi previously approved these changes Jul 20, 2021
ijjk
ijjk previously approved these changes Jul 20, 2021
@devknoll devknoll dismissed stale reviews from ijjk, huozhi, and shuding via 30eed17 July 20, 2021 15:15
@ijjk

This comment has been minimized.

@ijjk
Copy link
Member

ijjk commented Jul 20, 2021

Stats from current PR

Default Build (Increase detected ⚠️)
General Overall increase ⚠️
vercel/next.js canary azukaru/next.js simplify-404-response Change
buildDuration 13s 12.9s -102ms
buildDurationCached 3s 3s -80ms
nodeModulesSize 49.5 MB 49.5 MB ⚠️ +2.01 kB
Page Load Tests Overall increase ✓
vercel/next.js canary azukaru/next.js simplify-404-response Change
/ failed reqs 0 0
/ total time (seconds) 2.092 2.081 -0.01
/ avg req/sec 1195.12 1201.13 +6.01
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.148 1.109 -0.04
/error-in-render avg req/sec 2177 2253.89 +76.89
Client Bundles (main, webpack, commons)
vercel/next.js canary azukaru/next.js simplify-404-response Change
359.HASH.js gzip 2.96 kB 2.96 kB
745.HASH.js gzip 180 B 180 B
framework-HASH.js gzip 42.2 kB 42.2 kB
main-HASH.js gzip 20.9 kB 20.9 kB
webpack-HASH.js gzip 1.53 kB 1.53 kB
Overall change 67.8 kB 67.8 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary azukaru/next.js simplify-404-response Change
polyfills-HASH.js gzip 31.1 kB 31.1 kB
Overall change 31.1 kB 31.1 kB
Client Pages
vercel/next.js canary azukaru/next.js simplify-404-response Change
_app-HASH.js gzip 803 B 803 B
_error-HASH.js gzip 3.06 kB 3.06 kB
amp-HASH.js gzip 554 B 554 B
css-HASH.js gzip 329 B 329 B
dynamic-HASH.js gzip 2.52 kB 2.52 kB
head-HASH.js gzip 2.28 kB 2.28 kB
hooks-HASH.js gzip 903 B 903 B
image-HASH.js gzip 5.61 kB 5.61 kB
index-HASH.js gzip 261 B 261 B
link-HASH.js gzip 1.66 kB 1.66 kB
routerDirect..HASH.js gzip 319 B 319 B
script-HASH.js gzip 387 B 387 B
withRouter-HASH.js gzip 320 B 320 B
bb14e60e810b..30f.css gzip 125 B 125 B
Overall change 19.1 kB 19.1 kB
Client Build Manifests
vercel/next.js canary azukaru/next.js simplify-404-response Change
_buildManifest.js gzip 490 B 490 B
Overall change 490 B 490 B
Rendered Page Sizes
vercel/next.js canary azukaru/next.js simplify-404-response Change
index.html gzip 529 B 529 B
link.html gzip 543 B 543 B
withRouter.html gzip 523 B 523 B
Overall change 1.59 kB 1.59 kB

Webpack 4 Mode (Decrease detected ✓)
General Overall increase ⚠️
vercel/next.js canary azukaru/next.js simplify-404-response Change
buildDuration 10.3s 10.4s ⚠️ +151ms
buildDurationCached 4s 4s ⚠️ +41ms
nodeModulesSize 49.5 MB 49.5 MB ⚠️ +2.01 kB
Page Load Tests Overall decrease ⚠️
vercel/next.js canary azukaru/next.js simplify-404-response Change
/ failed reqs 0 0
/ total time (seconds) 2.12 2.116 0
/ avg req/sec 1179.46 1181.26 +1.8
/error-in-render failed reqs 0 0
/error-in-render total time (seconds) 1.111 1.177 ⚠️ +0.07
/error-in-render avg req/sec 2250.06 2124.26 ⚠️ -125.8
Client Bundles (main, webpack, commons)
vercel/next.js canary azukaru/next.js simplify-404-response Change
17.HASH.js gzip 2.98 kB 2.98 kB
18.HASH.js gzip 185 B 185 B
677f882d2ed8..HASH.js gzip 13.7 kB 13.7 kB
framework.HASH.js gzip 41.9 kB 41.9 kB
main-HASH.js gzip 8.4 kB 8.4 kB
webpack-HASH.js gzip 1.22 kB 1.22 kB
Overall change 68.4 kB 68.4 kB
Legacy Client Bundles (polyfills)
vercel/next.js canary azukaru/next.js simplify-404-response Change
polyfills-HASH.js gzip 31.3 kB 31.3 kB
Overall change 31.3 kB 31.3 kB
Client Pages
vercel/next.js canary azukaru/next.js simplify-404-response Change
_app-HASH.js gzip 791 B 791 B
_error-HASH.js gzip 3.76 kB 3.76 kB
amp-HASH.js gzip 552 B 552 B
css-HASH.js gzip 333 B 333 B
dynamic-HASH.js gzip 2.71 kB 2.71 kB
head-HASH.js gzip 2.97 kB 2.97 kB
hooks-HASH.js gzip 911 B 911 B
index-HASH.js gzip 231 B 231 B
link-HASH.js gzip 1.64 kB 1.64 kB
routerDirect..HASH.js gzip 298 B 298 B
script-HASH.js gzip 3.02 kB 3.02 kB
withRouter-HASH.js gzip 294 B 294 B
e025d2764813..52f.css gzip 125 B 125 B
Overall change 17.6 kB 17.6 kB
Client Build Manifests
vercel/next.js canary azukaru/next.js simplify-404-response Change
_buildManifest.js gzip 500 B 500 B
Overall change 500 B 500 B
Rendered Page Sizes
vercel/next.js canary azukaru/next.js simplify-404-response Change
index.html gzip 577 B 577 B
link.html gzip 588 B 588 B
withRouter.html gzip 570 B 570 B
Overall change 1.74 kB 1.74 kB
Commit: ea6c622

@kodiakhq kodiakhq bot merged commit ade5255 into vercel:canary Jul 20, 2021
flybayer pushed a commit to blitz-js/next.js that referenced this pull request Aug 19, 2021
How a page is rendered depends on whether or not we're streaming. For example, if we're just rendering to a `string` or we're generating a response for a crawler or other robot, we don't want React 18 to dynamically flush `<script>` tags to update Suspense boundaries as they resolve. Instead, we just want to wait for the full HTML to resolve and return a result similar to `renderToString`.

This is what `RequestContext` and the new/refactored `pipe` and `getStaticHTML` methods allow.  They add a `requireStaticHTML` option that gets passed down. A follow-up PR will make sure this is `true` when serving a robot, and also ensure React is invoked appropriately.
@vercel vercel locked as resolved and limited conversation to collaborators Jan 28, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
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.

4 participants