disambiguate onCleanup

vercel · Nov 18, 2024 · ded0ec1 · ded0ec1
1 parent 5476f49
commit ded0ec1
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 12 deletions.
diff --git a/packages/next/src/server/base-server.ts b/packages/next/src/server/base-server.ts
@@ -255,6 +255,10 @@ export interface Options {
    * The HTTP Server that Next.js is running behind
    */
   httpServer?: HTTPServer
+  /**
+   * Allows scheduling callback to run before the server shuts down.
+   * (only available in `next start` or in custom servers)
+   */
   onCleanup?: (cb: () => Promise<void>) => void
 }
 

diff --git a/packages/next/src/server/dev/hot-reloader-turbopack.ts b/packages/next/src/server/dev/hot-reloader-turbopack.ts
@@ -185,7 +185,7 @@ export async function createHotReloaderTurbopack(
       memoryLimit: opts.nextConfig.experimental.turbo?.memoryLimit,
     }
   )
-  opts.onCleanup(() => project.onExit())
+  opts.onDevServerCleanup?.(() => project.onExit())
   const entrypointsSubscription = project.entrypointsSubscribe()
 
   const currentWrittenEntrypoints: Map<EntryKey, WrittenEndpoint> = new Map()

diff --git a/packages/next/src/server/lib/render-server.ts b/packages/next/src/server/lib/render-server.ts
@@ -86,7 +86,6 @@ async function initializeImpl(opts: {
   bundlerService: DevBundlerService | undefined
   startServerSpan: Span | undefined
   quiet?: boolean
-  onCleanup: (listener: () => Promise<void>) => void
 }) {
   const type = process.env.__NEXT_PRIVATE_RENDER_WORKER
   if (type) {

diff --git a/packages/next/src/server/lib/router-server.ts b/packages/next/src/server/lib/router-server.ts
@@ -70,7 +70,7 @@ export async function initialize(opts: {
   dir: string
   port: number
   dev: boolean
-  onCleanup: (listener: () => Promise<void>) => void
+  onDevServerCleanup: ((listener: () => Promise<void>) => void) | undefined
   server?: import('http').Server
   minimalMode?: boolean
   hostname?: string
@@ -145,7 +145,7 @@ export async function initialize(opts: {
         isCustomServer: opts.customServer,
         turbo: !!process.env.TURBOPACK,
         port: opts.port,
-        onCleanup: opts.onCleanup,
+        onDevServerCleanup: opts.onDevServerCleanup,
         resetFetch,
       })
     )
@@ -626,7 +626,6 @@ export async function initialize(opts: {
     bundlerService: devBundlerService,
     startServerSpan: opts.startServerSpan,
     quiet: opts.quiet,
-    onCleanup: opts.onCleanup,
   }
   renderServerOpts.serverFields.routerServerHandler = requestHandlerImpl
 

diff --git a/packages/next/src/server/lib/router-utils/setup-dev-bundler.ts b/packages/next/src/server/lib/router-utils/setup-dev-bundler.ts
@@ -106,7 +106,7 @@ export type SetupOpts = {
   >
   nextConfig: NextConfigComplete
   port: number
-  onCleanup: (listener: () => Promise<void>) => void
+  onDevServerCleanup: ((listener: () => Promise<void>) => void) | undefined
   resetFetch: () => void
 }
 

diff --git a/packages/next/src/server/lib/start-server.ts b/packages/next/src/server/lib/start-server.ts
@@ -53,7 +53,7 @@ export async function getRequestHandlers({
   dir,
   port,
   isDev,
-  onCleanup,
+  onDevServerCleanup,
   server,
   hostname,
   minimalMode,
@@ -64,7 +64,7 @@ export async function getRequestHandlers({
   dir: string
   port: number
   isDev: boolean
-  onCleanup: (listener: () => Promise<void>) => void
+  onDevServerCleanup: ((listener: () => Promise<void>) => void) | undefined
   server?: import('http').Server
   hostname?: string
   minimalMode?: boolean
@@ -76,7 +76,7 @@ export async function getRequestHandlers({
     dir,
     port,
     hostname,
-    onCleanup,
+    onDevServerCleanup,
     dev: isDev,
     minimalMode,
     server,
@@ -333,7 +333,7 @@ export async function startServer(
           dir,
           port,
           isDev,
-          onCleanup,
+          onDevServerCleanup: isDev ? onCleanup : undefined,
           server,
           hostname,
           minimalMode,
@@ -344,6 +344,9 @@ export async function startServer(
         upgradeHandler = initResult[1]
         const nextServer = initResult[2]
 
+        // NOTE: `NextServer` also has a method called `onCleanup`,
+        // (used e.g. for implementing `waitUntil` in `next start`)
+        // and this is what actually makes those cleanups execute
         onCleanup(() => nextServer.close())
 
         const startServerProcessDuration =

diff --git a/packages/next/src/server/next.ts b/packages/next/src/server/next.ts
@@ -38,7 +38,7 @@ const getServerImpl = async () => {
 export type NextServerOptions = Omit<
   ServerOptions | DevServerOptions,
   // This is assigned in this server abstraction.
-  'conf'
+  'conf' | 'onCleanup'
 > &
   Partial<Pick<ServerOptions | DevServerOptions, 'conf'>>
 
@@ -287,7 +287,9 @@ class NextCustomServer extends NextServer {
       dir: this.options.dir!,
       port: this.options.port || 3000,
       isDev: !!this.options.dev,
-      onCleanup: this.onCleanup.bind(this),
+      onDevServerCleanup: this.options.dev
+        ? this.onCleanup.bind(this)
+        : undefined,
       hostname: this.options.hostname || 'localhost',
       minimalMode: this.options.minimalMode,
       quiet: this.options.quiet,