`nuxt dev` reload never finishes when a Nuxt `close` hook doesn't settle

Offen
#1,659 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
72/100
Issue-Typ
Bug
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
node.js, nuxt, typescript
Bereich
backend, cli

Rechercherichtung

Start in packages/nuxt-cli/src/dev/utils.ts at #load() and close(), then read the shutdown budget in packages/nuxt-cli/src/dev/pool.ts and its closeFork logic. Check existing dev reload tests and add coverage for a Nuxt close hook that never settles. Done means reload proceeds after the shutdown deadline, reports the unfinished hooks, and the test passes.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

Environment
  • @nuxt/cli 4.0.3 (same code on main, 7d4dec6)
  • nuxt 4.6.4, nitropack 2.13.6, vite 8.3.6
  • Node 24.22.2, Linux x64
Reproduction

https://github.com/mttzzz/nuxt-reload-close-hook-hang

The app has one local module:

// modules/hang-on-close.ts
import { defineNuxtModule } from 'nuxt/kit'

export default defineNuxtModule({
  meta: { name: 'hang-on-close' },
  setup(_options, nuxt) {
    nuxt.hook('close', () => new Promise<void>(() => {}))
  },
})
  1. npm i && npx nuxt dev, the page shows marker: one
  2. change marker: 'one' to 'two' in nuxt.config.ts
Describe the bug

After step 2 the page switches to the loading screen (503) and stays there (I waited 80 s), the reload is never reported as done. Saving nuxt.config.ts again does nothing, since the config watcher is closed before the reload and only re-armed after it. Ctrl-C still exits right away, so restarting nuxt dev is the only way out.

Without the module the same edit reloads in about 1 s. The same kind of hook in a Nitro plugin (nitroApp.hooks.hook('close', () => new Promise(() => {}))) only delays the reload by about 5 s: nitropack terminates the dev worker after NITRO_SHUTDOWN_TIMEOUT, and the reload goes on.

This came up in #1328, where @danielroe asked for a separate issue.

Cause

An in-place reload (a nuxt.config change, removed build output, nuxt.callHook('restart') from a module) goes through #load(), which awaits close(), and close() awaits this.#currentNuxt.close() with no deadline:

https://github.com/nuxt/cli/blob/7d4dec65b188e549faad7c219d3766c988e5cdcb/packages/nuxt-cli/src/dev/utils.ts#L1277-L1282

nuxt.close() calls the close hooks one after another, so the hooks registered after the module (Nitro's, Vite's, the builder watchers) are never called either.

Shutting the fork down already has a budget: closeFork waits DEV_SHUTDOWN_TIMEOUT_MS (10 s), then sends SIGTERM and SIGKILL:

https://github.com/nuxt/cli/blob/7d4dec65b188e549faad7c219d3766c988e5cdcb/packages/nuxt-cli/src/dev/pool.ts#L194-L212

The reload could get the same budget: race currentNuxt.close() against DEV_SHUTDOWN_TIMEOUT_MS, warn that the close hooks didn't finish, and go on with the reload. I can send a PR for that.

Vorherrschende Sprache
TypeScript
Sterne
402
Forks
125
Ø Merge
2 T. 9 Std.
Gemergte PRs (30 T.)
37

Entwicklungsumgebung

In Codespaces öffnen

Startet den Dev-Container des Projekts im Browser, mit Ihrem eigenen GitHub-Konto.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus nuxt/cli

Alle Issues in nuxt/cli

Ähnliche Issues

Weitere Issues zu TypeScript

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.