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

Author: wyattjoh

packages/next-swc/crates/next-core/js/src/internal/nodejs-proxy-handler.ts

@@ -42,7 +42,7 @@ export default (routeModule: AppRouteRouteModule) => {
           previewModeId: 'development-id',
         } as any,
       },
-      staticGenerationContext: {
+      renderOpts: {
         supportsDynamicHTML: true,
       },
     }

packages/next/src/build/index.ts

@@ -5,14 +5,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 chalk from 'next/dist/compiled/chalk'
 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'
@@ -151,21 +152,29 @@ import { defaultOverrides } from '../server/require-hook'
 import { initialize as initializeIncrementalCache } from '../server/lib/incremental-cache-server'
 import { nodeFs } from '../server/lib/node-fs-methods'
 
-export type SsgRoute = {
+interface ExperimentalBypassForInfo {
+  experimentalBypassFor?: RouteHas[]
+}
+
+interface DataRouteRouteInfo {
+  dataRoute: string | null
+}
+
+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 = {
@@ -2489,15 +2498,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
@@ -2619,7 +2623,7 @@ export default async function build(
             },
           }
 
-          const exportOptions: ExportOptions = {
+          const exportOptions: ExportAppOptions = {
             isInvokedFromCli: false,
             nextConfig: exportConfig,
             hasAppDir,
@@ -2644,10 +2648,17 @@ export default async function build(
               : undefined,
           }
 
-          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 = exportResult.ssgNotFoundPaths
 
           // remove server bundles that were exported
           for (const page of staticPages) {
@@ -2659,8 +2670,7 @@ export default async function build(
             const page = appNormalizedPaths.get(originalAppPath) || ''
             const appConfig = appDefaultConfigs.get(originalAppPath) || {}
             let hasDynamicData =
-              appConfig.revalidate === 0 ||
-              exportConfig.initialPageRevalidationMap[page] === 0
+              appConfig.revalidate === 0 || exportResult.revalidate[page] === 0
 
             if (hasDynamicData && pageInfos.get(page)?.static) {
               // if the page was marked as being static, but it contains dynamic data
@@ -2689,7 +2699,7 @@ export default async function build(
               if (isDynamicRoute(page) && route === page) return
               if (route === '/_not-found') return
 
-              let revalidate = exportConfig.initialPageRevalidationMap[route]
+              let revalidate = exportResult.revalidate[page]
 
               if (typeof revalidate === 'undefined') {
                 revalidate =
@@ -2714,15 +2724,13 @@ export default async function build(
 
                 const routeMeta: Partial<SsgRoute> = {}
 
-                const exportRouteMeta: {
-                  status?: number
-                  headers?: Record<string, string>
-                } = exportConfig.initialPageMetaMap[route] || {}
+                const metadata = exportResult.metadata[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) {
@@ -2956,7 +2964,7 @@ export default async function build(
             const file = normalizePagePath(page)
 
             const pageInfo = pageInfos.get(page)
-            const durationInfo = exportConfig.pageDurationMap[page]
+            const durationInfo = exportResult.durations[page]
             if (pageInfo && durationInfo) {
               // Set Build Duration
               if (pageInfo.ssgPageRoutes) {
@@ -2996,9 +3004,14 @@ export default async function build(
                   for (const locale of i18n.locales) {
                     const localePage = `/${locale}${page === '/' ? '' : page}`
 
+                    const initialRevalidateSeconds =
+                      exportResult.revalidate[localePage]
+                    if (typeof initialRevalidateSeconds === 'undefined') {
+                      throw new Error("Invariant: locale page wasn't built")
+                    }
+
                     finalPrerenderRoutes[localePage] = {
-                      initialRevalidateSeconds:
-                        exportConfig.initialPageRevalidationMap[localePage],
+                      initialRevalidateSeconds,
                       srcRoute: null,
                       dataRoute: path.posix.join(
                         '/_next/data',
@@ -3008,9 +3021,13 @@ export default async function build(
                     }
                   }
                 } else {
+                  const initialRevalidateSeconds = exportResult.revalidate[page]
+                  if (typeof initialRevalidateSeconds === 'undefined') {
+                    throw new Error("Invariant: page wasn't built")
+                  }
+
                   finalPrerenderRoutes[page] = {
-                    initialRevalidateSeconds:
-                      exportConfig.initialPageRevalidationMap[page],
+                    initialRevalidateSeconds,
                     srcRoute: null,
                     dataRoute: path.posix.join(
                       '/_next/data',
@@ -3021,8 +3038,12 @@ export default async function build(
                 }
                 // Set Page Revalidation Interval
                 if (pageInfo) {
-                  pageInfo.initialRevalidateSeconds =
-                    exportConfig.initialPageRevalidationMap[page]
+                  const initialRevalidateSeconds = exportResult.revalidate[page]
+                  if (typeof initialRevalidateSeconds === 'undefined') {
+                    throw new Error("Invariant: page wasn't built")
+                  }
+
+                  pageInfo.initialRevalidateSeconds = initialRevalidateSeconds
                 }
               } else {
                 // For a dynamic SSG page, we did not copy its data exports and only
@@ -3069,9 +3090,14 @@ export default async function build(
                     )
                   }
 
+                  const initialRevalidateSeconds =
+                    exportResult.revalidate[route]
+                  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',
@@ -3082,8 +3108,7 @@ export default async function build(
 
                   // Set route Revalidation Interval
                   if (pageInfo) {
-                    pageInfo.initialRevalidateSeconds =
-                      exportConfig.initialPageRevalidationMap[route]
+                    pageInfo.initialRevalidateSeconds = initialRevalidateSeconds
                   }
                 }
               }
@@ -3296,7 +3321,7 @@ export default async function build(
         )
         if (appDir) {
           const originalServerApp = path.join(distDir, SERVER_DIRECTORY, 'app')
-          if (fsExistsSync(originalServerApp)) {
+          if (await fileExists(originalServerApp)) {
             await recursiveCopy(
               originalServerApp,
               path.join(
@@ -3353,8 +3378,7 @@ export default async function build(
       }
 
       if (config.output === 'export') {
-        const exportApp: typeof import('../export').default =
-          require('../export').default
+        const exportApp: ExportAppWorker = require('../export').default
 
         const pagesWorker = createStaticWorker(
           incrementalCacheIpcPort,
@@ -3365,7 +3389,7 @@ export default async function build(
           incrementalCacheIpcValidationKey
         )
 
-        const options: ExportOptions = {
+        const options: ExportAppOptions = {
           isInvokedFromCli: false,
           buildExport: false,
           nextConfig: config,

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 chalk from 'next/dist/compiled/chalk'
-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'),