Unverified Commit b8460266 authored by JJ Kasper's avatar JJ Kasper Committed by GitHub

Handle getStaticPaths error inside worker to avoid serializing (#39032)

* Handle getStaticPaths error inside worker to avoid serializing

* handle invalid export case
parent cee2cf37
...@@ -862,117 +862,125 @@ export async function isPageStatic( ...@@ -862,117 +862,125 @@ export async function isPageStatic(
traceExcludes?: string[] traceExcludes?: string[]
}> { }> {
const isPageStaticSpan = trace('is-page-static-utils', parentId) const isPageStaticSpan = trace('is-page-static-utils', parentId)
return isPageStaticSpan.traceAsyncFn(async () => { return isPageStaticSpan
require('../shared/lib/runtime-config').setConfig(runtimeEnvConfig) .traceAsyncFn(async () => {
setHttpAgentOptions(httpAgentOptions) require('../shared/lib/runtime-config').setConfig(runtimeEnvConfig)
setHttpAgentOptions(httpAgentOptions)
const mod = await loadComponents(distDir, page, serverless) const mod = await loadComponents(distDir, page, serverless)
const Comp = mod.Component const Comp = mod.Component
if (!Comp || !isValidElementType(Comp) || typeof Comp === 'string') { if (!Comp || !isValidElementType(Comp) || typeof Comp === 'string') {
throw new Error('INVALID_DEFAULT_EXPORT') throw new Error('INVALID_DEFAULT_EXPORT')
} }
const hasGetInitialProps = !!(Comp as any).getInitialProps const hasGetInitialProps = !!(Comp as any).getInitialProps
const hasStaticProps = !!mod.getStaticProps const hasStaticProps = !!mod.getStaticProps
const hasStaticPaths = !!mod.getStaticPaths const hasStaticPaths = !!mod.getStaticPaths
const hasServerProps = !!mod.getServerSideProps const hasServerProps = !!mod.getServerSideProps
const hasLegacyServerProps = !!(await mod.ComponentMod const hasLegacyServerProps = !!(await mod.ComponentMod
.unstable_getServerProps) .unstable_getServerProps)
const hasLegacyStaticProps = !!(await mod.ComponentMod const hasLegacyStaticProps = !!(await mod.ComponentMod
.unstable_getStaticProps) .unstable_getStaticProps)
const hasLegacyStaticPaths = !!(await mod.ComponentMod const hasLegacyStaticPaths = !!(await mod.ComponentMod
.unstable_getStaticPaths) .unstable_getStaticPaths)
const hasLegacyStaticParams = !!(await mod.ComponentMod const hasLegacyStaticParams = !!(await mod.ComponentMod
.unstable_getStaticParams) .unstable_getStaticParams)
if (hasLegacyStaticParams) { if (hasLegacyStaticParams) {
throw new Error( throw new Error(
`unstable_getStaticParams was replaced with getStaticPaths. Please update your code.` `unstable_getStaticParams was replaced with getStaticPaths. Please update your code.`
) )
} }
if (hasLegacyStaticPaths) { if (hasLegacyStaticPaths) {
throw new Error( throw new Error(
`unstable_getStaticPaths was replaced with getStaticPaths. Please update your code.` `unstable_getStaticPaths was replaced with getStaticPaths. Please update your code.`
) )
} }
if (hasLegacyStaticProps) { if (hasLegacyStaticProps) {
throw new Error( throw new Error(
`unstable_getStaticProps was replaced with getStaticProps. Please update your code.` `unstable_getStaticProps was replaced with getStaticProps. Please update your code.`
) )
} }
if (hasLegacyServerProps) { if (hasLegacyServerProps) {
throw new Error( throw new Error(
`unstable_getServerProps was replaced with getServerSideProps. Please update your code.` `unstable_getServerProps was replaced with getServerSideProps. Please update your code.`
) )
} }
// A page cannot be prerendered _and_ define a data requirement. That's // A page cannot be prerendered _and_ define a data requirement. That's
// contradictory! // contradictory!
if (hasGetInitialProps && hasStaticProps) { if (hasGetInitialProps && hasStaticProps) {
throw new Error(SSG_GET_INITIAL_PROPS_CONFLICT) throw new Error(SSG_GET_INITIAL_PROPS_CONFLICT)
} }
if (hasGetInitialProps && hasServerProps) { if (hasGetInitialProps && hasServerProps) {
throw new Error(SERVER_PROPS_GET_INIT_PROPS_CONFLICT) throw new Error(SERVER_PROPS_GET_INIT_PROPS_CONFLICT)
} }
if (hasStaticProps && hasServerProps) { if (hasStaticProps && hasServerProps) {
throw new Error(SERVER_PROPS_SSG_CONFLICT) throw new Error(SERVER_PROPS_SSG_CONFLICT)
} }
const pageIsDynamic = isDynamicRoute(page) const pageIsDynamic = isDynamicRoute(page)
// A page cannot have static parameters if it is not a dynamic page. // A page cannot have static parameters if it is not a dynamic page.
if (hasStaticProps && hasStaticPaths && !pageIsDynamic) { if (hasStaticProps && hasStaticPaths && !pageIsDynamic) {
throw new Error( throw new Error(
`getStaticPaths can only be used with dynamic pages, not '${page}'.` + `getStaticPaths can only be used with dynamic pages, not '${page}'.` +
`\nLearn more: https://nextjs.org/docs/routing/dynamic-routes` `\nLearn more: https://nextjs.org/docs/routing/dynamic-routes`
) )
} }
if (hasStaticProps && pageIsDynamic && !hasStaticPaths) { if (hasStaticProps && pageIsDynamic && !hasStaticPaths) {
throw new Error( throw new Error(
`getStaticPaths is required for dynamic SSG pages and is missing for '${page}'.` + `getStaticPaths is required for dynamic SSG pages and is missing for '${page}'.` +
`\nRead more: https://nextjs.org/docs/messages/invalid-getstaticpaths-value` `\nRead more: https://nextjs.org/docs/messages/invalid-getstaticpaths-value`
) )
} }
let prerenderRoutes: Array<string> | undefined let prerenderRoutes: Array<string> | undefined
let encodedPrerenderRoutes: Array<string> | undefined let encodedPrerenderRoutes: Array<string> | undefined
let prerenderFallback: boolean | 'blocking' | undefined let prerenderFallback: boolean | 'blocking' | undefined
if (hasStaticProps && hasStaticPaths) { if (hasStaticProps && hasStaticPaths) {
;({ ;({
paths: prerenderRoutes, paths: prerenderRoutes,
fallback: prerenderFallback, fallback: prerenderFallback,
encodedPaths: encodedPrerenderRoutes, encodedPaths: encodedPrerenderRoutes,
} = await buildStaticPaths( } = await buildStaticPaths(
page, page,
mod.getStaticPaths!, mod.getStaticPaths!,
configFileName, configFileName,
locales, locales,
defaultLocale defaultLocale
)) ))
} }
const isNextImageImported = (global as any).__NEXT_IMAGE_IMPORTED const isNextImageImported = (global as any).__NEXT_IMAGE_IMPORTED
const config: PageConfig = mod.pageConfig const config: PageConfig = mod.pageConfig
return { return {
isStatic: !hasStaticProps && !hasGetInitialProps && !hasServerProps, isStatic: !hasStaticProps && !hasGetInitialProps && !hasServerProps,
isHybridAmp: config.amp === 'hybrid', isHybridAmp: config.amp === 'hybrid',
isAmpOnly: config.amp === true, isAmpOnly: config.amp === true,
prerenderRoutes, prerenderRoutes,
prerenderFallback, prerenderFallback,
encodedPrerenderRoutes, encodedPrerenderRoutes,
hasStaticProps, hasStaticProps,
hasServerProps, hasServerProps,
isNextImageImported, isNextImageImported,
traceIncludes: config.unstable_includeFiles || [], traceIncludes: config.unstable_includeFiles || [],
traceExcludes: config.unstable_excludeFiles || [], traceExcludes: config.unstable_excludeFiles || [],
} }
}) })
.catch((err) => {
if (err.message === 'INVALID_DEFAULT_EXPORT') {
throw err
}
console.error(err)
throw new Error(`Failed to collect page data for ${page}`)
})
} }
export async function hasCustomGetInitialProps( export async function hasCustomGetInitialProps(
......
/* eslint-env jest */ /* eslint-env jest */
import fs from 'fs-extra' import fs from 'fs-extra'
import { join } from 'path' import { dirname, join } from 'path'
import { nextBuild } from 'next-test-utils' import { nextBuild } from 'next-test-utils'
const appDir = join(__dirname, '..') const appDir = join(__dirname, '..')
const pagesDir = join(appDir, 'pages') const pagesDir = join(appDir, 'pages')
const testPage = join(pagesDir, 'test.js')
const writePage = async (content) => { const writePage = async (content, testPage = join(pagesDir, 'test.js')) => {
await fs.ensureDir(pagesDir) await fs.ensureDir(dirname(testPage))
await fs.writeFile(testPage, content) await fs.writeFile(testPage, content)
} }
...@@ -107,4 +106,64 @@ describe('GSP build errors', () => { ...@@ -107,4 +106,64 @@ describe('GSP build errors', () => {
expect(code).toBe(1) expect(code).toBe(1)
expect(stderr).toContain('a string error') expect(stderr).toContain('a string error')
}) })
it('should handle non-serializable error in getStaticProps', async () => {
await writePage(`
export function getStaticProps() {
const err = new Error('my custom error')
err.hello = 'world'
err.a = [1,2,3]
err.original = err
err.b = err.a
throw err
return {
props: {}
}
}
export default function () {
return null
}
`)
const { stderr, code } = await nextBuild(appDir, [], { stderr: true })
expect(code).toBe(1)
expect(stderr).toContain('my custom error')
})
it('should handle non-serializable error in getStaticPaths', async () => {
await writePage(
`
export function getStaticProps() {
return {
props: {}
}
}
export function getStaticPaths() {
const err = new Error('my custom error')
err.hello = 'world'
err.a = [1,2,3]
err.original = err
err.b = err.a
throw err
return {
paths: [],
fallback: true
}
}
export default function () {
return null
}
`,
join(pagesDir, '[slug].js')
)
const { stderr, code } = await nextBuild(appDir, [], { stderr: true })
expect(code).toBe(1)
expect(stderr).toContain('my custom error')
})
}) })
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment