Fix non-concurrent function _document #31628

ijjk · 2021-11-19T17:57:24Z

This ensures functional _document is rendered correctly when not using concurrent mode.

Bug

Related issues linked using fixes #number
Integration tests added
Errors have helpful link attached, see contributing.md

Fixes: #31593
x-ref: #30156

ijjk · 2021-11-19T18:35:10Z

Failing test suites

Commit: 491dcf5

test/integration/document-functional-render-prop/tests/index.test.js

Functional Custom Document > development mode > supports render props

Expand output

● Functional Custom Document › development mode › supports render props

expect(received).toMatch(expected)

Expected pattern: /<span>from render prop<\/span>/
Received string:  "<!DOCTYPE html><html><head><style data-next-hide-fouc=\"true\">body{display:none}</style><noscript data-next-hide-fouc=\"true\"><style>body{display:block}</style></noscript><meta charSet=\"utf-8\"/><meta name=\"viewport\" content=\"width=device-width\"/><meta name=\"next-head-count\" content=\"2\"/><noscript data-n-css=\"\"></noscript><script defer=\"\" nomodule=\"\" src=\"/_next/static/chunks/polyfills.js?ts=1637346903412\"></script><script src=\"/_next/static/chunks/webpack.js?ts=1637346903412\" defer=\"\"></script><script src=\"/_next/static/chunks/main.js?ts=1637346903412\" defer=\"\"></script><script src=\"/_next/static/chunks/pages/_app.js?ts=1637346903412\" defer=\"\"></script><script src=\"/_next/static/chunks/pages/index.js?ts=1637346903412\" defer=\"\"></script><script src=\"/_next/static/development/_buildManifest.js?ts=1637346903412\" defer=\"\"></script><script src=\"/_next/static/development/_ssgManifest.js?ts=1637346903412\" defer=\"\"></script><script src=\"/_next/static/development/_middlewareManifest.js?ts=1637346903412\" defer=\"\"></script><noscript id=\"__next_css__DO_NOT_USE__\"></noscript></head><body><div id=\"__next\" data-reactroot=\"\"><span></span></div><script src=\"/_next/static/chunks/react-refresh.js?ts=1637346903412\"></script><script id=\"__NEXT_DATA__\" type=\"application/json\">{\"props\":{\"pageProps\":{}},\"page\":\"/\",\"query\":{},\"buildId\":\"development\",\"nextExport\":true,\"autoExport\":true,\"isFallback\":false,\"scriptLoader\":[]}</script></body></html>"

  15 |     })
  16 |
> 17 |     afterAll(() => killApp(app))
     |                          ^
  18 |
  19 |     it('supports render props', async () => {
  20 |       const html = await renderViaHTTP(appPort, '/')

  at Object.<anonymous> (integration/document-functional-render-prop/tests/index.test.js:17:26)

ijjk · 2021-11-19T19:19:16Z

Stats from current PR

Default Build (Decrease detected ✓)

General Overall increase ⚠️

	vercel/next.js canary	ijjk/next.js fix/non-concurrent-document	Change
buildDuration	23.2s	23.7s	⚠️ +518ms
buildDurationCached	4.4s	4.6s	⚠️ +173ms
nodeModulesSize	339 MB	339 MB	⚠️ +1.61 kB

Page Load Tests Overall decrease ⚠️

	vercel/next.js canary	ijjk/next.js fix/non-concurrent-document	Change
/ failed reqs	0	0	✓
/ total time (seconds)	3.925	4.018	⚠️ +0.09
/ avg req/sec	637.01	622.21	⚠️ -14.8
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	2.001	2.098	⚠️ +0.1
/error-in-render avg req/sec	1249.27	1191.49	⚠️ -57.78

Client Bundles (main, webpack, commons)

	vercel/next.js canary	ijjk/next.js fix/non-concurrent-document	Change
450.HASH.js gzip	179 B	179 B	✓
framework-HASH.js gzip	42.2 kB	42.2 kB	✓
main-HASH.js gzip	28.3 kB	28.3 kB	✓
webpack-HASH.js gzip	1.45 kB	1.45 kB	✓
Overall change	72.2 kB	72.2 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	ijjk/next.js fix/non-concurrent-document	Change
polyfills-HASH.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	ijjk/next.js fix/non-concurrent-document	Change
_app-HASH.js gzip	1.37 kB	1.37 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.45 kB	4.45 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	✓
85e02e95b279..7e3.css gzip	107 B	107 B	✓
Overall change	13.3 kB	13.3 kB	✓

Client Build Manifests

	vercel/next.js canary	ijjk/next.js fix/non-concurrent-document	Change
_buildManifest.js gzip	460 B	460 B	✓
Overall change	460 B	460 B	✓

Rendered Page Sizes

	vercel/next.js canary	ijjk/next.js fix/non-concurrent-document	Change
index.html gzip	532 B	532 B	✓
link.html gzip	545 B	545 B	✓
withRouter.html gzip	526 B	526 B	✓
Overall change	1.6 kB	1.6 kB	✓

Default Build with SWC (Increase detected ⚠️)

General Overall increase ⚠️

	vercel/next.js canary	ijjk/next.js fix/non-concurrent-document	Change
buildDuration	24.8s	25.1s	⚠️ +298ms
buildDurationCached	4.5s	4.5s	-3ms
nodeModulesSize	339 MB	339 MB	⚠️ +1.61 kB

Page Load Tests Overall increase ✓

	vercel/next.js canary	ijjk/next.js fix/non-concurrent-document	Change
/ failed reqs	0	0	✓
/ total time (seconds)	4.007	3.897	-0.11
/ avg req/sec	623.86	641.45	+17.59
/error-in-render failed reqs	0	0	✓
/error-in-render total time (seconds)	2.064	2.055	-0.01
/error-in-render avg req/sec	1211.17	1216.5	+5.33

Client Bundles (main, webpack, commons)

	vercel/next.js canary	ijjk/next.js fix/non-concurrent-document	Change
450.HASH.js gzip	179 B	179 B	✓
framework-HASH.js gzip	42.3 kB	42.3 kB	✓
main-HASH.js gzip	28.6 kB	28.6 kB	✓
webpack-HASH.js gzip	1.44 kB	1.44 kB	✓
Overall change	72.5 kB	72.5 kB	✓

Legacy Client Bundles (polyfills)

	vercel/next.js canary	ijjk/next.js fix/non-concurrent-document	Change
polyfills-HASH.js gzip	31 kB	31 kB	✓
Overall change	31 kB	31 kB	✓

Client Pages

	vercel/next.js canary	ijjk/next.js fix/non-concurrent-document	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.38 kB	2.38 kB	✓
head-HASH.js gzip	342 B	342 B	✓
hooks-HASH.js gzip	622 B	622 B	✓
image-HASH.js gzip	4.47 kB	4.47 kB	✓
index-HASH.js gzip	256 B	256 B	✓
link-HASH.js gzip	1.91 kB	1.91 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	13.2 kB	13.2 kB	✓

Client Build Manifests

	vercel/next.js canary	ijjk/next.js fix/non-concurrent-document	Change
_buildManifest.js gzip	459 B	459 B	✓
Overall change	459 B	459 B	✓

Rendered Page Sizes

	vercel/next.js canary	ijjk/next.js fix/non-concurrent-document	Change
index.html gzip	532 B	532 B	✓
link.html gzip	545 B	545 B	✓
withRouter.html gzip	526 B	526 B	✓
Overall change	1.6 kB	1.6 kB	✓

Commit: 3c256de

Fix non-concurrent function _document

eb3a1a2

ijjk added created-by: Next.js team PRs by the Next.js team type: next labels Nov 19, 2021

ijjk added 2 commits November 19, 2021 12:01

ensure wrapper is added for non-concurrent

0c63755

ensure __next div is present

d967c99

shuding previously approved these changes Nov 19, 2021

View reviewed changes

ijjk marked this pull request as ready for review November 19, 2021 18:07

ijjk requested review from huozhi and timneutkens as code owners November 19, 2021 18:07

pacocoursey previously approved these changes Nov 19, 2021

View reviewed changes

huozhi previously approved these changes Nov 19, 2021

View reviewed changes

lint-fix

491dcf5

ijjk dismissed stale reviews from huozhi, pacocoursey, and shuding via 491dcf5 November 19, 2021 18:18

This comment has been minimized.

Sign in to view

shuding previously approved these changes Nov 19, 2021

View reviewed changes

timneutkens previously approved these changes Nov 19, 2021

View reviewed changes

This comment has been minimized.

Sign in to view

Update previous test

3c256de

ijjk dismissed stale reviews from timneutkens and shuding via 3c256de November 19, 2021 18:59

huozhi approved these changes Nov 19, 2021

View reviewed changes

kodiakhq bot merged commit e8ca334 into vercel:canary Nov 19, 2021

ijjk deleted the fix/non-concurrent-document branch November 19, 2021 19:45

vercel locked as resolved and limited conversation to collaborators Jan 27, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix non-concurrent function _document #31628

Fix non-concurrent function _document #31628

ijjk commented Nov 19, 2021 •

edited

This comment has been minimized.

ijjk commented Nov 19, 2021

This comment has been minimized.

ijjk commented Nov 19, 2021

Fix non-concurrent function _document #31628

Fix non-concurrent function _document #31628

Conversation

ijjk commented Nov 19, 2021 • edited

Bug

This comment has been minimized.

ijjk commented Nov 19, 2021

Failing test suites

This comment has been minimized.

ijjk commented Nov 19, 2021

Stats from current PR

ijjk commented Nov 19, 2021 •

edited