diff --git a/packages/nuxt-cli/src/dev/utils.ts b/packages/nuxt-cli/src/dev/utils.ts index 79271f4a3..fe3a0125c 100644 --- a/packages/nuxt-cli/src/dev/utils.ts +++ b/packages/nuxt-cli/src/dev/utils.ts @@ -201,6 +201,19 @@ export interface DevRoute { file?: string } +/** The Nitro build hooks the dev server subscribes to when reporting rebuilds. */ +type NitroBuildHookName = 'dev:start' | 'rollup:before' | 'build:config' | 'compiled' | 'dev:reload' | 'dev:error' + +/** + * The subset of a Nitro instance the rebuild watcher registers on. Typed apart + * from `Nitro` because Nitro v3's `build:config` is not in nitropack's hook map. + */ +interface NitroBuildHooks { + hooks: { + hook: (name: NitroBuildHookName, fn: () => void) => () => void + } +} + /** A request served by the dev server, as shown in the dev UI. */ export interface DevRequestEvent { /** Identity shared with the logs attributed to this request. */ @@ -882,17 +895,22 @@ export class NuxtDevServer extends EventEmitter { * otherwise invisible: only full Nuxt reloads emit `loading`. * * In dev the rebuild is driven by rollup's watcher, which reports `dev:start` - * rather than the `rollup:before` of a one-shot build. + * rather than the `rollup:before` of a one-shot build. Nitro v3 deprecated + * `rollup:before` in favour of `build:config`, which every builder calls. */ #watchServerBuilds(nuxt: Nuxt): void { + const started: NitroBuildHookName[] = readNitroMajor(nuxt.options) === 3 + ? ['dev:start', 'build:config'] + : ['dev:start', 'rollup:before'] nuxt.hook('nitro:init', (nitro) => { - for (const started of ['dev:start', 'rollup:before'] as const) { - nitro.hooks.hook(started, () => { + const hooks = (nitro as unknown as NitroBuildHooks).hooks + for (const name of started) { + hooks.hook(name, () => { this.emit('building', true) }) } - for (const finished of ['compiled', 'dev:reload', 'dev:error'] as const) { - nitro.hooks.hook(finished, () => { + for (const name of ['compiled', 'dev:reload', 'dev:error'] as const) { + hooks.hook(name, () => { this.emit('building', false) }) } diff --git a/packages/nuxt-cli/test/unit/dev/lifecycle.spec.ts b/packages/nuxt-cli/test/unit/dev/lifecycle.spec.ts index 1f7a95f26..371bdf0ad 100644 --- a/packages/nuxt-cli/test/unit/dev/lifecycle.spec.ts +++ b/packages/nuxt-cli/test/unit/dev/lifecycle.spec.ts @@ -314,6 +314,53 @@ describe('dev server stack', () => { }) }) +describe('dev server nitro build hooks', () => { + async function registeredNitroHooks(nuxt: FakeNuxt): Promise> { + loadNuxt.mockImplementation(() => Promise.resolve(nuxt)) + const server = createServer({ captureUIEvents: true }) + await server.init() + const registered: Array<{ name: string, building: boolean }> = [] + await nuxt.callHook('nitro:init', { + hooks: { + hook: (name: string, fn: () => void) => { + const building: boolean[] = [] + const listener = (value: boolean) => building.push(value) + server.on('building', listener) + fn() + server.off('building', listener) + registered.push({ name, building: building[0]! }) + return () => {} + }, + }, + }) + return registered + } + + it('should watch `rollup:before` on Nitro v2', async () => { + const registered = await registeredNitroHooks(createNuxt()) + + expect(registered).toEqual([ + { name: 'dev:start', building: true }, + { name: 'rollup:before', building: true }, + { name: 'compiled', building: false }, + { name: 'dev:reload', building: false }, + { name: 'dev:error', building: false }, + ]) + }) + + it('should watch `build:config` on Nitro v3', async () => { + const registered = await registeredNitroHooks(createNuxt({ _nitroMajor: 3 })) + + expect(registered).toEqual([ + { name: 'dev:start', building: true }, + { name: 'build:config', building: true }, + { name: 'compiled', building: false }, + { name: 'dev:reload', building: false }, + { name: 'dev:error', building: false }, + ]) + }) +}) + describe('dev server failures', () => { it('should surface a first-run failure to the caller', async () => { loadNuxt.mockImplementation(() => Promise.reject(new Error('config exploded')))