after production compile

Author: gaojude

packages/next/src/build/after-production-compile.ts

@@ -0,0 +1,61 @@
+import type { NextConfigComplete } from '../server/config-shared'
+import type { Span } from '../trace'
+
+import * as Log from './output/log'
+import createSpinner from './spinner'
+import isError from '../lib/is-error'
+import type { Telemetry } from '../telemetry/storage'
+import { EVENT_BUILD_FEATURE_USAGE } from '../telemetry/events/build'
+
+// TODO: refactor this to account for more compiler lifecycle events
+// such as beforeProductionBuild, but for now this is the only one that is needed
+export async function runAfterProductionCompile({
+  config,
+  buildSpan,
+  telemetry,
+  metadata,
+}: {
+  config: NextConfigComplete
+  buildSpan: Span
+  telemetry: Telemetry
+  metadata: {
+    projectDir: string
+    distDir: string
+  }
+}): Promise<void> {
+  const run = config.compiler.runAfterProductionCompile
+  if (!run) {
+    return
+  }
+  telemetry.record([
+    {
+      eventName: EVENT_BUILD_FEATURE_USAGE,
+      payload: {
+        featureName: 'runAfterProductionCompile',
+        invocationCount: 1,
+      },
+    },
+  ])
+  const afterBuildSpinner = createSpinner('Running runAfterProductionCompile')
+
+  try {
+    const startTime = performance.now()
+    await buildSpan
+      .traceChild('after-production-compile')
+      .traceAsyncFn(async () => {
+        await run(metadata)
+      })
+    const duration = performance.now() - startTime
+    const formattedDuration = `${Math.round(duration)}ms`
+    Log.event(`Completed runAfterProductionCompile in ${formattedDuration}`)
+  } catch (err) {
+    // Handle specific known errors differently if needed
+    if (isError(err)) {
+      Log.error(`Failed to run runAfterProductionCompile: ${err.message}`)
+    }
+
+    throw err
+  } finally {
+    afterBuildSpinner?.stop()
+  }
+}

packages/next/src/build/index.ts

@@ -213,6 +213,7 @@ import { populateStaticEnv } from '../lib/static-env'
 import { durationToString } from './duration-to-string'
 import { traceGlobals } from '../trace/shared'
 import { extractNextErrorCode } from '../lib/error-telemetry-utils'
+import { runAfterProductionCompile } from './after-production-compile'
 
 type Fallback = null | boolean | string
 
@@ -1586,6 +1587,15 @@ export default async function build(
             )
           }
         }
+        await runAfterProductionCompile({
+          config,
+          buildSpan: nextBuildSpan,
+          telemetry,
+          metadata: {
+            projectDir: dir,
+            distDir,
+          },
+        })
       }
 
       // For app directory, we run type checking after build.

packages/next/src/server/config-schema.ts

@@ -220,6 +220,10 @@ export const configSchema: zod.ZodType<NextConfig> = z.lazy(() =>
           }),
         ]),
         define: z.record(z.string(), z.string()).optional(),
+        runAfterProductionCompile: z
+          .function()
+          .returns(z.promise(z.void()))
+          .optional(),
       })
       .optional(),
     compress: z.boolean().optional(),

packages/next/src/server/config-shared.ts

@@ -998,6 +998,22 @@ export interface NextConfig extends Record<string, any> {
      * replaced with the respective values.
      */
     define?: Record<string, string>
+
+    /**
+     * A hook function that executes after production build compilation finishes,
+     * but before running post-compilation tasks such as type checking and
+     * static page generation.
+     */
+    runAfterProductionCompile?: (metadata: {
+      /**
+       * The root directory of the project
+       */
+      projectDir: string
+      /**
+       * The build output directory (defaults to `.next`)
+       */
+      distDir: string
+    }) => Promise<void>
   }
 
   /**
@@ -1138,6 +1154,7 @@ export const defaultConfig: NextConfig = {
     keepAlive: true,
   },
   logging: {},
+  compiler: {},
   expireTime: process.env.NEXT_PRIVATE_CDN_CONSUMED_SWR_CACHE_CONTROL
     ? undefined
     : 31536000, // one year

packages/next/src/telemetry/events/build.ts

@@ -195,6 +195,7 @@ export type EventBuildFeatureUsage = {
     | 'webpackPlugins'
     | UseCacheTrackerKey
     | 'turbopackPersistentCaching'
+    | 'runAfterProductionCompile'
   invocationCount: number
 }
 export function eventBuildFeatureUsage(

test/production/build-lifecycle-hooks/after.ts

@@ -0,0 +1,21 @@
+import fs from 'fs/promises'
+
+export async function after({
+  distDir,
+  projectDir,
+}: {
+  distDir: string
+  projectDir: string
+}) {
+  try {
+    console.log(`Using distDir: ${distDir}`)
+    console.log(`Using projectDir: ${projectDir}`)
+
+    await new Promise((resolve) => setTimeout(resolve, 5000))
+
+    const files = await fs.readdir(distDir, { recursive: true })
+    console.log(`Total files in ${distDir} folder: ${files.length}`)
+  } catch (err) {
+    console.error(`Error reading ${distDir} directory:`, err)
+  }
+}

test/production/build-lifecycle-hooks/app/layout.tsx

@@ -0,0 +1,13 @@
+import React from 'react'
+
+export default function RootLayout({
+  children,
+}: {
+  children: React.ReactNode
+}) {
+  return (
+    <html>
+      <body>{children}</body>
+    </html>
+  )
+}

test/production/build-lifecycle-hooks/app/page.tsx

@@ -0,0 +1,9 @@
+import React from 'react'
+
+export default function Page() {
+  return (
+    <div>
+      <h1>Hello, World!</h1>
+    </div>
+  )
+}

test/production/build-lifecycle-hooks/bad-after.ts

@@ -0,0 +1,9 @@
+export async function after({
+  distDir,
+  projectDir,
+}: {
+  distDir: string
+  projectDir: string
+}) {
+  throw new Error('error after production build')
+}

test/production/build-lifecycle-hooks/index.test.ts

@@ -0,0 +1,74 @@
+import { nextTestSetup } from 'e2e-utils'
+import { findAllTelemetryEvents } from 'next-test-utils'
+
+describe('build-lifecycle-hooks', () => {
+  const { next } = nextTestSetup({
+    files: __dirname,
+    env: {
+      NEXT_TELEMETRY_DEBUG: '1',
+    },
+  })
+
+  it('should run runAfterProductionCompile', async () => {
+    const output = next.cliOutput
+
+    expect(output).toContain('')
+    expect(output).toContain(`Using distDir: ${next.testDir}/.next`)
+    expect(output).toContain(`Using projectDir: ${next.testDir}`)
+    expect(output).toContain(`Total files in ${next.testDir}/.next folder:`)
+    expect(output).toContain('Completed runAfterProductionCompile in')
+
+    // Ensure telemetry event is recorded
+    const events = findAllTelemetryEvents(output, 'NEXT_BUILD_FEATURE_USAGE')
+    expect(events).toContainEqual({
+      featureName: 'runAfterProductionCompile',
+      invocationCount: 1,
+    })
+  })
+
+  it('should not execute runAfterProductionCompile if compilation fails', async () => {
+    try {
+      await next.stop()
+      await next.patchFile('app/layout.tsx', (content) => {
+        return content + '{'
+      })
+
+      const getCliOutput = next.getCliOutputFromHere()
+      await next.build()
+      expect(getCliOutput()).not.toContain('Total files in .next folder')
+      expect(getCliOutput()).not.toContain(
+        'Completed runAfterProductionCompile in'
+      )
+    } finally {
+      await next.patchFile('app/layout.tsx', (content) => {
+        return content.slice(0, -1)
+      })
+    }
+  })
+
+  it('should throw an error', async () => {
+    try {
+      await next.stop()
+      await next.patchFile('next.config.ts', (content) => {
+        return content.replace(
+          `import { after } from './after'`,
+          `import { after } from './bad-after'`
+        )
+      })
+
+      const getCliOutput = next.getCliOutputFromHere()
+      await next.build()
+      expect(getCliOutput()).toContain('error after production build')
+      expect(getCliOutput()).not.toContain(
+        'Completed runAfterProductionCompile in'
+      )
+    } finally {
+      await next.patchFile('next.config.ts', (content) => {
+        return content.replace(
+          `import { after } from './bad-after'`,
+          `import { after } from './after'`
+        )
+      })
+    }
+  })
+})