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.

Sign up for GitHub

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

Jump to bottom

Fixes #32338 missing Document components trigger an error for production builds #32345

Merged
merged 7 commits into from Dec 13, 2021
Merged

Fixes #32338 missing Document components trigger an error for production builds #32345

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
6b269a3
Only validate _document subcomponents in dev environment
oriolcp Dec 9, 2021
f118d29
Merge branch 'vercel:canary' into canary
oriolcp Dec 9, 2021
616f8b3
Merge branch 'canary' into canary
oriolcp Dec 12, 2021
7a4e4d2
Replace error by a warning
oriolcp Dec 12, 2021
972f827
Merge branch 'canary' into canary
oriolcp Dec 13, 2021
9426974
Merge branch 'canary' into canary
oriolcp Dec 13, 2021
7e1f3f4
Merge branch 'canary' into canary
ijjk Dec 13, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
34 changes: 18 additions & 16 deletions packages/next/server/render.tsx
View file
Open in desktop
Expand Up @@ -1375,25 +1375,27 @@ export async function renderToHTML(
documentHTML = ReactDOMServer.renderToStaticMarkup(document)
}

const nonRenderedComponents = []
const expectedDocComponents = ['Main', 'Head', 'NextScript', 'Html']
if (process.env.NODE_ENV !== 'production') {
const nonRenderedComponents = []
const expectedDocComponents = ['Main', 'Head', 'NextScript', 'Html']

for (const comp of expectedDocComponents) {
if (!(docComponentsRendered as any)[comp]) {
nonRenderedComponents.push(comp)
for (const comp of expectedDocComponents) {
if (!(docComponentsRendered as any)[comp]) {
nonRenderedComponents.push(comp)
}
}
}

if (nonRenderedComponents.length) {
const missingComponentList = nonRenderedComponents
.map((e) => `<${e} />`)
.join(', ')
const plural = nonRenderedComponents.length !== 1 ? 's' : ''
throw new Error(
`Your custom Document (pages/_document) did not render all the required subcomponent${plural}.\n` +
`Missing component${plural}: ${missingComponentList}\n` +
'Read how to fix here: https://nextjs.org/docs/messages/missing-document-component'
)
if (nonRenderedComponents.length) {
const missingComponentList = nonRenderedComponents
.map((e) => `<${e} />`)
.join(', ')
const plural = nonRenderedComponents.length !== 1 ? 's' : ''
console.warn(
`Your custom Document (pages/_document) did not render all the required subcomponent${plural}.\n` +
`Missing component${plural}: ${missingComponentList}\n` +
'Read how to fix here: https://nextjs.org/docs/messages/missing-document-component'
)
}
}

const [renderTargetPrefix, renderTargetSuffix] = documentHTML.split(
Expand Down