Add writeFullyStaticExport (#60200)
## What? Moves the code for `output: 'export'` to a separate function. <!-- Thanks for opening a PR! Your contribution is much appreciated. To make sure your PR is handled as smoothly as possible we request that you follow the checklist sections below. Choose the right checklist for the change(s) that you're making: ## For Contributors ### Improving Documentation - Run `pnpm prettier-fix` to fix formatting issues before opening the PR. - Read the Docs Contribution Guide to ensure your contribution follows the docs guidelines: https://nextjs.org/docs/community/contribution-guide ### Adding or Updating Examples - The "examples guidelines" are followed from our contributing doc https://github.com/vercel/next.js/blob/canary/contributing/examples/adding-examples.md - Make sure the linting passes by running `pnpm build && pnpm lint`. See https://github.com/vercel/next.js/blob/canary/contributing/repository/linting.md ### Fixing a bug - Related issues linked using `fixes #number` - Tests added. See: https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs - Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md ### Adding a feature - Implements an existing feature request or RFC. Make sure the feature request has been accepted for implementation before opening a PR. (A discussion must be opened, see https://github.com/vercel/next.js/discussions/new?category=ideas) - Related issues/discussions are linked using `fixes #number` - e2e tests added (https://github.com/vercel/next.js/blob/canary/contributing/core/testing.md#writing-tests-for-nextjs) - Documentation added - Telemetry added. In case of a feature if it's used or not. - Errors have a helpful link attached, see https://github.com/vercel/next.js/blob/canary/contributing.md ## For Maintainers - Minimal description (aim for explaining to someone not on the team to understand the PR) - When linking to a Slack thread, you might want to share details of the conclusion - Link both the Linear (Fixes NEXT-xxx) and the GitHub issues - Add review comments if necessary to explain to the reviewer the logic behind a change ### What? ### Why? ### How? Closes NEXT- Fixes # --> Closes NEXT-1976
This commit is contained in:
parent
6f9df4a0ac
commit
3fd3d5d4b5
1 changed files with 164 additions and 143 deletions
|
@ -4,7 +4,7 @@ import type { PagesManifest } from './webpack/plugins/pages-manifest-plugin'
|
|||
import type { ExportPathMap, NextConfigComplete } from '../server/config-shared'
|
||||
import type { MiddlewareManifest } from './webpack/plugins/middleware-plugin'
|
||||
import type { ActionManifest } from './webpack/plugins/flight-client-entry-plugin'
|
||||
import type { ExportAppOptions, ExportAppWorker } from '../export/types'
|
||||
import type { ExportAppOptions } from '../export/types'
|
||||
import type { Revalidate } from '../server/lib/revalidate'
|
||||
|
||||
import '../lib/setup-exception-listeners'
|
||||
|
@ -341,30 +341,6 @@ function getCacheDir(distDir: string): string {
|
|||
return cacheDir
|
||||
}
|
||||
|
||||
function getNumberOfWorkers(config: NextConfigComplete) {
|
||||
if (
|
||||
config.experimental.cpus &&
|
||||
config.experimental.cpus !== defaultConfig.experimental!.cpus
|
||||
) {
|
||||
return config.experimental.cpus
|
||||
}
|
||||
|
||||
if (config.experimental.memoryBasedWorkersCount) {
|
||||
return Math.max(
|
||||
Math.min(config.experimental.cpus || 1, Math.floor(os.freemem() / 1e9)),
|
||||
// enforce a minimum of 4 workers
|
||||
4
|
||||
)
|
||||
}
|
||||
|
||||
if (config.experimental.cpus) {
|
||||
return config.experimental.cpus
|
||||
}
|
||||
|
||||
// Fall back to 4 workers if a count is not specified
|
||||
return 4
|
||||
}
|
||||
|
||||
async function writeFileUtf8(filePath: string, content: string): Promise<void> {
|
||||
await fs.writeFile(filePath, content, 'utf-8')
|
||||
}
|
||||
|
@ -539,6 +515,147 @@ async function writeStandaloneDirectory(
|
|||
})
|
||||
}
|
||||
|
||||
function getNumberOfWorkers(config: NextConfigComplete) {
|
||||
if (
|
||||
config.experimental.cpus &&
|
||||
config.experimental.cpus !== defaultConfig.experimental!.cpus
|
||||
) {
|
||||
return config.experimental.cpus
|
||||
}
|
||||
|
||||
if (config.experimental.memoryBasedWorkersCount) {
|
||||
return Math.max(
|
||||
Math.min(config.experimental.cpus || 1, Math.floor(os.freemem() / 1e9)),
|
||||
// enforce a minimum of 4 workers
|
||||
4
|
||||
)
|
||||
}
|
||||
|
||||
if (config.experimental.cpus) {
|
||||
return config.experimental.cpus
|
||||
}
|
||||
|
||||
// Fall back to 4 workers if a count is not specified
|
||||
return 4
|
||||
}
|
||||
|
||||
const staticWorkerPath = require.resolve('./worker')
|
||||
function createStaticWorker(
|
||||
config: NextConfigComplete,
|
||||
incrementalCacheIpcPort?: number,
|
||||
incrementalCacheIpcValidationKey?: string
|
||||
) {
|
||||
let infoPrinted = false
|
||||
const timeout = config.staticPageGenerationTimeout || 0
|
||||
|
||||
return new Worker(staticWorkerPath, {
|
||||
timeout: timeout * 1000,
|
||||
logger: Log,
|
||||
onRestart: (method, [arg], attempts) => {
|
||||
if (method === 'exportPage') {
|
||||
const pagePath = arg.path
|
||||
if (attempts >= 3) {
|
||||
throw new Error(
|
||||
`Static page generation for ${pagePath} is still timing out after 3 attempts. See more info here https://nextjs.org/docs/messages/static-page-generation-timeout`
|
||||
)
|
||||
}
|
||||
Log.warn(
|
||||
`Restarted static page generation for ${pagePath} because it took more than ${timeout} seconds`
|
||||
)
|
||||
} else {
|
||||
const pagePath = arg.path
|
||||
if (attempts >= 2) {
|
||||
throw new Error(
|
||||
`Collecting page data for ${pagePath} is still timing out after 2 attempts. See more info here https://nextjs.org/docs/messages/page-data-collection-timeout`
|
||||
)
|
||||
}
|
||||
Log.warn(
|
||||
`Restarted collecting page data for ${pagePath} because it took more than ${timeout} seconds`
|
||||
)
|
||||
}
|
||||
if (!infoPrinted) {
|
||||
Log.warn(
|
||||
'See more info here https://nextjs.org/docs/messages/static-page-generation-timeout'
|
||||
)
|
||||
infoPrinted = true
|
||||
}
|
||||
},
|
||||
numWorkers: getNumberOfWorkers(config),
|
||||
forkOptions: {
|
||||
env: {
|
||||
...process.env,
|
||||
__NEXT_INCREMENTAL_CACHE_IPC_PORT: incrementalCacheIpcPort
|
||||
? incrementalCacheIpcPort + ''
|
||||
: undefined,
|
||||
__NEXT_INCREMENTAL_CACHE_IPC_KEY: incrementalCacheIpcValidationKey,
|
||||
},
|
||||
},
|
||||
enableWorkerThreads: config.experimental.workerThreads,
|
||||
exposedMethods: [
|
||||
'hasCustomGetInitialProps',
|
||||
'isPageStatic',
|
||||
'getDefinedNamedExports',
|
||||
'exportPage',
|
||||
],
|
||||
}) as Worker &
|
||||
Pick<
|
||||
typeof import('./worker'),
|
||||
| 'hasCustomGetInitialProps'
|
||||
| 'isPageStatic'
|
||||
| 'getDefinedNamedExports'
|
||||
| 'exportPage'
|
||||
>
|
||||
}
|
||||
|
||||
async function writeFullyStaticExport(
|
||||
config: NextConfigComplete,
|
||||
incrementalCacheIpcPort: number | undefined,
|
||||
incrementalCacheIpcValidationKey: string | undefined,
|
||||
dir: string,
|
||||
enabledDirectories: NextEnabledDirectories,
|
||||
configOutDir: string,
|
||||
nextBuildSpan: Span
|
||||
): Promise<void> {
|
||||
const exportApp = require('../export')
|
||||
.default as typeof import('../export').default
|
||||
|
||||
const pagesWorker = createStaticWorker(
|
||||
config,
|
||||
incrementalCacheIpcPort,
|
||||
incrementalCacheIpcValidationKey
|
||||
)
|
||||
const appWorker = createStaticWorker(
|
||||
config,
|
||||
incrementalCacheIpcPort,
|
||||
incrementalCacheIpcValidationKey
|
||||
)
|
||||
|
||||
await exportApp(
|
||||
dir,
|
||||
{
|
||||
buildExport: false,
|
||||
nextConfig: config,
|
||||
enabledDirectories,
|
||||
silent: true,
|
||||
threads: config.experimental.cpus,
|
||||
outdir: path.join(dir, configOutDir),
|
||||
// The worker already explicitly binds `this` to each of the
|
||||
// exposed methods.
|
||||
exportAppPageWorker: appWorker?.exportPage,
|
||||
exportPageWorker: pagesWorker?.exportPage,
|
||||
endWorker: async () => {
|
||||
await pagesWorker.end()
|
||||
await appWorker.end()
|
||||
},
|
||||
},
|
||||
nextBuildSpan
|
||||
)
|
||||
|
||||
// ensure the worker is not left hanging
|
||||
pagesWorker.close()
|
||||
appWorker.close()
|
||||
}
|
||||
|
||||
export default async function build(
|
||||
dir: string,
|
||||
reactProductionProfiling = false,
|
||||
|
@ -1380,9 +1497,6 @@ export default async function build(
|
|||
? await readManifest<AppBuildManifest>(appBuildManifestPath)
|
||||
: undefined
|
||||
|
||||
const timeout = config.staticPageGenerationTimeout || 0
|
||||
const staticWorkerPath = require.resolve('./worker')
|
||||
|
||||
let appPathsManifest: Record<string, string> = {}
|
||||
const appPathRoutes: Record<string, string> = {}
|
||||
|
||||
|
@ -1402,74 +1516,6 @@ export default async function build(
|
|||
|
||||
process.env.NEXT_PHASE = PHASE_PRODUCTION_BUILD
|
||||
|
||||
const numberOfWorkers = getNumberOfWorkers(config)
|
||||
|
||||
function createStaticWorker(
|
||||
incrementalCacheIpcPort?: number,
|
||||
incrementalCacheIpcValidationKey?: string
|
||||
) {
|
||||
let infoPrinted = false
|
||||
|
||||
return new Worker(staticWorkerPath, {
|
||||
timeout: timeout * 1000,
|
||||
logger: Log,
|
||||
onRestart: (method, [arg], attempts) => {
|
||||
if (method === 'exportPage') {
|
||||
const pagePath = arg.path
|
||||
if (attempts >= 3) {
|
||||
throw new Error(
|
||||
`Static page generation for ${pagePath} is still timing out after 3 attempts. See more info here https://nextjs.org/docs/messages/static-page-generation-timeout`
|
||||
)
|
||||
}
|
||||
Log.warn(
|
||||
`Restarted static page generation for ${pagePath} because it took more than ${timeout} seconds`
|
||||
)
|
||||
} else {
|
||||
const pagePath = arg.path
|
||||
if (attempts >= 2) {
|
||||
throw new Error(
|
||||
`Collecting page data for ${pagePath} is still timing out after 2 attempts. See more info here https://nextjs.org/docs/messages/page-data-collection-timeout`
|
||||
)
|
||||
}
|
||||
Log.warn(
|
||||
`Restarted collecting page data for ${pagePath} because it took more than ${timeout} seconds`
|
||||
)
|
||||
}
|
||||
if (!infoPrinted) {
|
||||
Log.warn(
|
||||
'See more info here https://nextjs.org/docs/messages/static-page-generation-timeout'
|
||||
)
|
||||
infoPrinted = true
|
||||
}
|
||||
},
|
||||
numWorkers: numberOfWorkers,
|
||||
forkOptions: {
|
||||
env: {
|
||||
...process.env,
|
||||
__NEXT_INCREMENTAL_CACHE_IPC_PORT: incrementalCacheIpcPort
|
||||
? incrementalCacheIpcPort + ''
|
||||
: undefined,
|
||||
__NEXT_INCREMENTAL_CACHE_IPC_KEY:
|
||||
incrementalCacheIpcValidationKey,
|
||||
},
|
||||
},
|
||||
enableWorkerThreads: config.experimental.workerThreads,
|
||||
exposedMethods: [
|
||||
'hasCustomGetInitialProps',
|
||||
'isPageStatic',
|
||||
'getDefinedNamedExports',
|
||||
'exportPage',
|
||||
],
|
||||
}) as Worker &
|
||||
Pick<
|
||||
typeof import('./worker'),
|
||||
| 'hasCustomGetInitialProps'
|
||||
| 'isPageStatic'
|
||||
| 'getDefinedNamedExports'
|
||||
| 'exportPage'
|
||||
>
|
||||
}
|
||||
|
||||
let incrementalCacheIpcPort
|
||||
let incrementalCacheIpcValidationKey
|
||||
|
||||
|
@ -1517,11 +1563,14 @@ export default async function build(
|
|||
}
|
||||
|
||||
const pagesStaticWorkers = createStaticWorker(
|
||||
config,
|
||||
|
||||
incrementalCacheIpcPort,
|
||||
incrementalCacheIpcValidationKey
|
||||
)
|
||||
const appStaticWorkers = appDir
|
||||
? createStaticWorker(
|
||||
config,
|
||||
incrementalCacheIpcPort,
|
||||
incrementalCacheIpcValidationKey
|
||||
)
|
||||
|
@ -2238,7 +2287,8 @@ export default async function build(
|
|||
ssgPages,
|
||||
additionalSsgPaths
|
||||
)
|
||||
const exportApp: ExportAppWorker = require('../export').default
|
||||
const exportApp = require('../export')
|
||||
.default as typeof import('../export').default
|
||||
|
||||
const exportConfig: NextConfigComplete = {
|
||||
...config,
|
||||
|
@ -3085,49 +3135,25 @@ export default async function build(
|
|||
})
|
||||
}
|
||||
|
||||
if (config.output === 'export') {
|
||||
if (buildTracesSpinner) {
|
||||
buildTracesSpinner?.stop()
|
||||
buildTracesSpinner = undefined
|
||||
}
|
||||
|
||||
const exportApp: typeof import('../export').default =
|
||||
require('../export').default
|
||||
|
||||
const pagesWorker = createStaticWorker(
|
||||
incrementalCacheIpcPort,
|
||||
incrementalCacheIpcValidationKey
|
||||
)
|
||||
const appWorker = createStaticWorker(
|
||||
incrementalCacheIpcPort,
|
||||
incrementalCacheIpcValidationKey
|
||||
)
|
||||
|
||||
const options: ExportAppOptions = {
|
||||
buildExport: false,
|
||||
nextConfig: config,
|
||||
enabledDirectories,
|
||||
silent: true,
|
||||
threads: config.experimental.cpus,
|
||||
outdir: path.join(dir, configOutDir),
|
||||
// The worker already explicitly binds `this` to each of the
|
||||
// exposed methods.
|
||||
exportAppPageWorker: appWorker?.exportPage,
|
||||
exportPageWorker: pagesWorker?.exportPage,
|
||||
endWorker: async () => {
|
||||
await pagesWorker.end()
|
||||
await appWorker.end()
|
||||
},
|
||||
}
|
||||
|
||||
await exportApp(dir, options, nextBuildSpan)
|
||||
|
||||
// ensure the worker is not left hanging
|
||||
pagesWorker.close()
|
||||
appWorker.close()
|
||||
}
|
||||
await buildTracesPromise
|
||||
|
||||
if (buildTracesSpinner) {
|
||||
buildTracesSpinner.stopAndPersist()
|
||||
buildTracesSpinner = undefined
|
||||
}
|
||||
|
||||
if (config.output === 'export') {
|
||||
await writeFullyStaticExport(
|
||||
config,
|
||||
incrementalCacheIpcPort,
|
||||
incrementalCacheIpcValidationKey,
|
||||
dir,
|
||||
enabledDirectories,
|
||||
configOutDir,
|
||||
nextBuildSpan
|
||||
)
|
||||
}
|
||||
|
||||
if (config.output === 'standalone') {
|
||||
await writeStandaloneDirectory(
|
||||
nextBuildSpan,
|
||||
|
@ -3144,11 +3170,6 @@ export default async function build(
|
|||
)
|
||||
}
|
||||
|
||||
if (buildTracesSpinner) {
|
||||
buildTracesSpinner.stopAndPersist()
|
||||
buildTracesSpinner = undefined
|
||||
}
|
||||
|
||||
if (postBuildSpinner) postBuildSpinner.stopAndPersist()
|
||||
console.log()
|
||||
|
||||
|
|
Loading…
Reference in a new issue