refactor: add more typings and clean up export/build flows

Author: wyattjoh

packages/next/src/build/index.ts

@@ -4,14 +4,15 @@ 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 { ExportOptions } from '../export'
+import type { ExportAppOptions, ExportAppWorker } from '../export/types'
 
 import '../lib/setup-exception-listeners'
+
 import { loadEnvConfig } from '@next/env'
 import { bold, yellow, green } from '../lib/picocolors'
 import crypto from 'crypto'
 import { isMatch, makeRe } from 'next/dist/compiled/micromatch'
-import { promises as fs, existsSync as fsExistsSync } from 'fs'
+import fs from 'fs/promises'
 import os from 'os'
 import { Worker } from '../lib/worker'
 import { defaultConfig } from '../server/config-shared'
@@ -147,22 +148,31 @@ import { initialize as initializeIncrementalCache } from '../server/lib/incremen
 import { nodeFs } from '../server/lib/node-fs-methods'
 import { collectBuildTraces } from './collect-build-traces'
 import { BuildTraceContext } from './webpack/plugins/next-trace-entrypoints-plugin'
+import { formatManifest } from './manifests/formatter/format-manifest'
+
+interface ExperimentalBypassForInfo {
+  experimentalBypassFor?: RouteHas[]
+}
+
+interface DataRouteRouteInfo {
+  dataRoute: string | null
+}
 
-export type SsgRoute = {
+export interface SsgRoute
+  extends ExperimentalBypassForInfo,
+    DataRouteRouteInfo {
   initialRevalidateSeconds: number | false
   srcRoute: string | null
-  dataRoute: string | null
   initialStatus?: number
   initialHeaders?: Record<string, string>
-  experimentalBypassFor?: RouteHas[]
 }
 
-export type DynamicSsgRoute = {
+export interface DynamicSsgRoute
+  extends ExperimentalBypassForInfo,
+    DataRouteRouteInfo {
   routeRegex: string
   fallback: string | null | false
-  dataRoute: string | null
   dataRouteRegex: string | null
-  experimentalBypassFor?: RouteHas[]
 }
 
 export type PrerenderManifest = {
@@ -877,7 +887,7 @@ export default async function build(
         .traceAsyncFn(() =>
           fs.writeFile(
             routesManifestPath,
-            JSON.stringify(routesManifest),
+            formatManifest(routesManifest),
             'utf8'
           )
         )
@@ -1091,7 +1101,8 @@ export default async function build(
         })
         await fs.writeFile(
           path.join(distDir, APP_PATH_ROUTES_MANIFEST),
-          JSON.stringify(appPathRoutes, null, 2)
+          formatManifest(appPathRoutes),
+          'utf-8'
         )
       }
 
@@ -1745,7 +1756,8 @@ export default async function build(
 
         await fs.writeFile(
           path.join(distDir, SERVER_DIRECTORY, FUNCTIONS_CONFIG_MANIFEST),
-          JSON.stringify(manifest, null, 2)
+          formatManifest(manifest),
+          'utf8'
         )
       }
 
@@ -1781,7 +1793,7 @@ export default async function build(
 
         await fs.writeFile(
           routesManifestPath,
-          JSON.stringify(routesManifest),
+          formatManifest(routesManifest),
           'utf8'
         )
       }
@@ -1856,7 +1868,7 @@ export default async function build(
 
       await fs.writeFile(
         path.join(distDir, SERVER_FILES_MANIFEST),
-        JSON.stringify(requiredServerFiles),
+        formatManifest(requiredServerFiles),
         'utf8'
       )
 
@@ -1915,15 +1927,10 @@ export default async function build(
             ssgPages,
             additionalSsgPaths
           )
-          const exportApp: typeof import('../export').default =
-            require('../export').default
+          const exportApp: ExportAppWorker = require('../export').default
 
           const exportConfig: NextConfigComplete = {
             ...config,
-            initialPageRevalidationMap: {},
-            initialPageMetaMap: {},
-            pageDurationMap: {},
-            ssgNotFoundPaths: [] as string[],
             // Default map will be the collection of automatic statically exported
             // pages and incremental pages.
             // n.b. we cannot handle this above in combinedPages because the dynamic
@@ -2036,7 +2043,7 @@ export default async function build(
             },
           }
 
-          const exportOptions: ExportOptions = {
+          const exportOptions: ExportAppOptions = {
             isInvokedFromCli: false,
             nextConfig: exportConfig,
             hasAppDir,
@@ -2057,10 +2064,17 @@ export default async function build(
             },
           }
 
-          await exportApp(dir, exportOptions, nextBuildSpan)
+          const exportResult = await exportApp(
+            dir,
+            exportOptions,
+            nextBuildSpan
+          )
+
+          // If there was no result, there's nothing more to do.
+          if (!exportResult) return
 
           const postBuildSpinner = createSpinner('Finalizing page optimization')
-          ssgNotFoundPaths = exportConfig.ssgNotFoundPaths
+          ssgNotFoundPaths = Array.from(exportResult.ssgNotFoundPaths)
 
           // remove server bundles that were exported
           for (const page of staticPages) {
@@ -2073,8 +2087,9 @@ export default async function build(
             const appConfig = appDefaultConfigs.get(originalAppPath) || {}
             let hasDynamicData =
               appConfig.revalidate === 0 ||
-              exportConfig.initialPageRevalidationMap[page] === 0
+              exportResult.byPath.get(page)?.revalidate === 0
 
+            // TODO: (wyattjoh) maybe change behavior for postpone?
             if (hasDynamicData && pageInfos.get(page)?.static) {
               // if the page was marked as being static, but it contains dynamic data
               // (ie, in the case of a static generation bailout), then it should be marked dynamic
@@ -2102,22 +2117,10 @@ export default async function build(
               if (isDynamicRoute(page) && route === page) return
               if (route === '/_not-found') return
 
-              let revalidate = exportConfig.initialPageRevalidationMap[route]
-
-              if (typeof revalidate === 'undefined') {
-                revalidate =
-                  typeof appConfig.revalidate !== 'undefined'
-                    ? appConfig.revalidate
-                    : false
-              }
-
-              // ensure revalidate is normalized correctly
-              if (
-                typeof revalidate !== 'number' &&
-                typeof revalidate !== 'boolean'
-              ) {
-                revalidate = false
-              }
+              const {
+                revalidate = appConfig.revalidate ?? false,
+                metadata = {},
+              } = exportResult.byPath.get(route) ?? {}
 
               if (revalidate !== 0) {
                 const normalizedRoute = normalizePagePath(route)
@@ -2127,15 +2130,11 @@ export default async function build(
 
                 const routeMeta: Partial<SsgRoute> = {}
 
-                const exportRouteMeta: {
-                  status?: number
-                  headers?: Record<string, string>
-                } = exportConfig.initialPageMetaMap[route] || {}
-
-                if (exportRouteMeta.status !== 200) {
-                  routeMeta.initialStatus = exportRouteMeta.status
+                if (metadata.status !== 200) {
+                  routeMeta.initialStatus = metadata.status
                 }
-                const exportHeaders = exportRouteMeta.headers
+
+                const exportHeaders = metadata.headers
                 const headerKeys = Object.keys(exportHeaders || {})
 
                 if (exportHeaders && headerKeys.length) {
@@ -2369,15 +2368,22 @@ export default async function build(
             const file = normalizePagePath(page)
 
             const pageInfo = pageInfos.get(page)
-            const durationInfo = exportConfig.pageDurationMap[page]
+            const durationInfo = exportResult.byPage.get(page)
             if (pageInfo && durationInfo) {
               // Set Build Duration
               if (pageInfo.ssgPageRoutes) {
                 pageInfo.ssgPageDurations = pageInfo.ssgPageRoutes.map(
-                  (pagePath) => durationInfo[pagePath]
+                  (pagePath) => {
+                    const duration = durationInfo.durationsByPath.get(pagePath)
+                    if (typeof duration === 'undefined') {
+                      throw new Error("Invariant: page wasn't built")
+                    }
+
+                    return duration
+                  }
                 )
               }
-              pageInfo.pageDuration = durationInfo[page]
+              pageInfo.pageDuration = durationInfo.durationsByPath.get(page)
             }
 
             // The dynamic version of SSG pages are only prerendered if the
@@ -2411,7 +2417,8 @@ export default async function build(
 
                     finalPrerenderRoutes[localePage] = {
                       initialRevalidateSeconds:
-                        exportConfig.initialPageRevalidationMap[localePage],
+                        exportResult.byPath.get(localePage)?.revalidate ??
+                        false,
                       srcRoute: null,
                       dataRoute: path.posix.join(
                         '/_next/data',
@@ -2423,7 +2430,7 @@ export default async function build(
                 } else {
                   finalPrerenderRoutes[page] = {
                     initialRevalidateSeconds:
-                      exportConfig.initialPageRevalidationMap[page],
+                      exportResult.byPath.get(page)?.revalidate ?? false,
                     srcRoute: null,
                     dataRoute: path.posix.join(
                       '/_next/data',
@@ -2435,7 +2442,7 @@ export default async function build(
                 // Set Page Revalidation Interval
                 if (pageInfo) {
                   pageInfo.initialRevalidateSeconds =
-                    exportConfig.initialPageRevalidationMap[page]
+                    exportResult.byPath.get(page)?.revalidate ?? false
                 }
               } else {
                 // For a dynamic SSG page, we did not copy its data exports and only
@@ -2482,9 +2489,15 @@ export default async function build(
                     )
                   }
 
+                  const initialRevalidateSeconds =
+                    exportResult.byPath.get(route)?.revalidate ?? false
+
+                  if (typeof initialRevalidateSeconds === 'undefined') {
+                    throw new Error("Invariant: page wasn't built")
+                  }
+
                   finalPrerenderRoutes[route] = {
-                    initialRevalidateSeconds:
-                      exportConfig.initialPageRevalidationMap[route],
+                    initialRevalidateSeconds,
                     srcRoute: page,
                     dataRoute: path.posix.join(
                       '/_next/data',
@@ -2495,8 +2508,7 @@ export default async function build(
 
                   // Set route Revalidation Interval
                   if (pageInfo) {
-                    pageInfo.initialRevalidateSeconds =
-                      exportConfig.initialPageRevalidationMap[route]
+                    pageInfo.initialRevalidateSeconds = initialRevalidateSeconds
                   }
                 }
               }
@@ -2507,7 +2519,7 @@ export default async function build(
           await fs.rm(exportOptions.outdir, { recursive: true, force: true })
           await fs.writeFile(
             manifestPath,
-            JSON.stringify(pagesManifest, null, 2),
+            formatManifest(pagesManifest),
             'utf8'
           )
 
@@ -2601,7 +2613,7 @@ export default async function build(
 
         await fs.writeFile(
           path.join(distDir, PRERENDER_MANIFEST),
-          JSON.stringify(prerenderManifest),
+          formatManifest(prerenderManifest),
           'utf8'
         )
         await fs.writeFile(
@@ -2626,7 +2638,7 @@ export default async function build(
         }
         await fs.writeFile(
           path.join(distDir, PRERENDER_MANIFEST),
-          JSON.stringify(prerenderManifest),
+          formatManifest(prerenderManifest),
           'utf8'
         )
         await fs.writeFile(
@@ -2653,15 +2665,15 @@ export default async function build(
 
       await fs.writeFile(
         path.join(distDir, IMAGES_MANIFEST),
-        JSON.stringify({
+        formatManifest({
           version: 1,
           images,
         }),
         'utf8'
       )
       await fs.writeFile(
         path.join(distDir, EXPORT_MARKER),
-        JSON.stringify({
+        formatManifest({
           version: 1,
           hasExportPathMap: typeof config.exportPathMap === 'function',
           exportTrailingSlash: config.trailingSlash === true,
@@ -2734,7 +2746,7 @@ export default async function build(
           incrementalCacheIpcValidationKey
         )
 
-        const options: ExportOptions = {
+        const options: ExportAppOptions = {
           isInvokedFromCli: false,
           buildExport: false,
           nextConfig: config,
@@ -2813,7 +2825,7 @@ export default async function build(
                   SERVER_DIRECTORY,
                   'app'
                 )
-                if (fsExistsSync(originalServerApp)) {
+                if (await fileExists(originalServerApp)) {
                   await recursiveCopy(
                     originalServerApp,
                     path.join(

packages/next/src/build/manifests/formatter/format-manifest.ts

@@ -0,0 +1,12 @@
+/**
+ * Formats the manifest depending on the environment variable
+ * `NODE_ENV`. If it's set to `development`, it will return a pretty printed
+ * JSON string, otherwise it will return a minified JSON string.
+ */
+export function formatManifest<T extends object>(manifest: T): string {
+  if (process.env.NODE_ENV === 'development') {
+    return JSON.stringify(manifest, null, 2)
+  }
+
+  return JSON.stringify(manifest)
+}

packages/next/src/cli/next-export.ts

@@ -1,8 +1,10 @@
 #!/usr/bin/env node
+import type { ExportAppOptions } from '../export/types'
+
 import { resolve, join } from 'path'
 import { existsSync } from 'fs'
 import { cyan } from '../lib/picocolors'
-import exportApp, { ExportError, ExportOptions } from '../export'
+import exportApp, { ExportError } from '../export'
 import * as Log from '../build/output/log'
 import { printAndExit } from '../server/lib/utils'
 import { CliCommand } from '../lib/commands'
@@ -43,7 +45,7 @@ const nextExport: CliCommand = (args) => {
     printAndExit(`> No such directory exists as the project root: ${dir}`)
   }
 
-  const options: ExportOptions = {
+  const options: ExportAppOptions = {
     silent: args['--silent'] || false,
     threads: args['--threads'],
     outdir: args['--outdir'] ? resolve(args['--outdir']) : join(dir, 'out'),