Skip to content

Commit 6f831f9

Browse files
authored
fix(server): avoid reinitializing watcher when adding file after server close (#23572)
1 parent e5d9af2 commit 6f831f9

3 files changed

Lines changed: 125 additions & 16 deletions

File tree

‎packages/vite/src/node/server/__tests__/watcher.spec.ts‎

Lines changed: 86 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,21 @@
11
import { resolve } from 'node:path'
22
import { fileURLToPath } from 'node:url'
33
import { afterEach, describe, expect, it, vi } from 'vitest'
4+
import { promiseWithResolvers } from '../../../shared/utils'
45
import { type ViteDevServer, createServer } from '../index'
56

67
const stubGetWatchedCode = /\(\)\s*\{\s*return this;\s*\}/
8+
const root = fileURLToPath(
9+
new URL('./fixtures/watcher/nested-root', import.meta.url),
10+
)
11+
const watchedFile = fileURLToPath(import.meta.url)
12+
13+
function expectWatcherToBeClosed(watcher: ViteDevServer['watcher']) {
14+
// Chokidar updates its private `closed` property synchronously in `add()`,
15+
// while `getWatched()` is populated asynchronously. Rely on the private
16+
// property here to keep these regression tests deterministic.
17+
expect(watcher).toHaveProperty('closed', true)
18+
}
719

820
describe('watcher configuration', () => {
921
let server: ViteDevServer | undefined
@@ -33,10 +45,81 @@ describe('watcher configuration', () => {
3345
expect(server.watcher.add.toString()).not.toMatch(stubGetWatchedCode)
3446
})
3547

48+
it('keeps the watcher closed when add is called after server close', async () => {
49+
server = await createServer()
50+
await server.close()
51+
52+
try {
53+
expect(server.watcher.add(watchedFile)).toBe(server.watcher)
54+
expectWatcherToBeClosed(server.watcher)
55+
} finally {
56+
await server.watcher.close()
57+
}
58+
})
59+
60+
it('keeps the watcher closed when add is called while server close is pending', async () => {
61+
const closeStarted = promiseWithResolvers<void>()
62+
const finishClose = promiseWithResolvers<void>()
63+
server = await createServer({
64+
plugins: [
65+
{
66+
name: 'delay-close',
67+
async buildEnd() {
68+
closeStarted.resolve()
69+
await finishClose.promise
70+
},
71+
},
72+
],
73+
})
74+
75+
const closePromise = server.close()
76+
await closeStarted.promise
77+
78+
try {
79+
server.watcher.add(watchedFile)
80+
expectWatcherToBeClosed(server.watcher)
81+
} finally {
82+
finishClose.resolve()
83+
await closePromise
84+
await server.watcher.close()
85+
}
86+
})
87+
88+
it('keeps the watcher closed when addWatchFile captured during buildStart is called while closing', async () => {
89+
const closeStarted = promiseWithResolvers<void>()
90+
const finishClose = promiseWithResolvers<void>()
91+
let addWatch!: (id: string) => void
92+
server = await createServer({
93+
root,
94+
plugins: [
95+
{
96+
name: 'capture-add-watch-file',
97+
buildStart() {
98+
addWatch = (id: string) => this.addWatchFile(id)
99+
},
100+
async buildEnd() {
101+
closeStarted.resolve()
102+
await finishClose.promise
103+
},
104+
},
105+
],
106+
})
107+
108+
await server.environments.client.pluginContainer.buildStart()
109+
const closePromise = server.close()
110+
await closeStarted.promise
111+
112+
try {
113+
addWatch(watchedFile)
114+
expectWatcherToBeClosed(server.watcher)
115+
} finally {
116+
finishClose.resolve()
117+
await closePromise
118+
await server.watcher.close()
119+
}
120+
})
121+
36122
it('should watch the root directory, config file dependencies, dotenv files, and the public directory', async () => {
37-
const root = fileURLToPath(
38-
new URL('./fixtures/watcher/nested-root', import.meta.url),
39-
)
40123
server = await createServer({ root })
41124
await new Promise((resolve) => server!.watcher.once('ready', resolve))
42125
// Perform retries here as chokidar may still not be completely watching all directories

‎packages/vite/src/node/server/index.ts‎

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ import {
6969
import {
7070
createNoopWatcher,
7171
getResolvedOutDirs,
72+
makeWatcherCloseFinal,
7273
resolveChokidarOptions,
7374
resolveEmptyOutDir,
7475
} from '../watch'
@@ -582,19 +583,21 @@ export async function _createServer(
582583
// eslint-disable-next-line eqeqeq
583584
const watchEnabled = serverConfig.watch !== null
584585
const watcher = watchEnabled
585-
? (chokidar.watch(
586-
// config file dependencies and env file might be outside of root
587-
[
588-
...(config.experimental.bundledDev ? [] : [root]),
589-
...config.configFileDependencies,
590-
...getEnvFilesForMode(config.mode, config.envDir),
591-
// Watch the public directory explicitly because it might be outside
592-
// of the root directory.
593-
...(publicDir && publicFiles ? [publicDir] : []),
594-
],
595-
596-
resolvedWatchOptions,
597-
) as FSWatcher)
586+
? makeWatcherCloseFinal(
587+
chokidar.watch(
588+
// config file dependencies and env file might be outside of root
589+
[
590+
...(config.experimental.bundledDev ? [] : [root]),
591+
...config.configFileDependencies,
592+
...getEnvFilesForMode(config.mode, config.envDir),
593+
// Watch the public directory explicitly because it might be outside
594+
// of the root directory.
595+
...(publicDir && publicFiles ? [publicDir] : []),
596+
],
597+
598+
resolvedWatchOptions,
599+
) as FSWatcher,
600+
)
598601
: createNoopWatcher(resolvedWatchOptions)
599602

600603
const environments: Record<string, DevEnvironment> = {}

‎packages/vite/src/node/watch.ts‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -161,3 +161,26 @@ class NoopWatcher extends EventEmitter implements FSWatcher {
161161
export function createNoopWatcher(options: WatchOptions): FSWatcher {
162162
return new NoopWatcher(options)
163163
}
164+
165+
/**
166+
* Chokidar's `add()` reopens a closed watcher. It may be called after shutdown
167+
* starts from an in-flight plugin hook or directly through the exposed watcher.
168+
* This wrapper makes `close()` final so those calls cannot create new file
169+
* system handles.
170+
*/
171+
export function makeWatcherCloseFinal(watcher: FSWatcher): FSWatcher {
172+
let closed = false
173+
const add = watcher.add
174+
watcher.add = function (...args: Parameters<FSWatcher['add']>) {
175+
if (closed) return this
176+
return add.apply(this, args)
177+
}
178+
179+
const close = watcher.close
180+
watcher.close = function (...args: Parameters<FSWatcher['close']>) {
181+
closed = true
182+
return close.apply(this, args)
183+
}
184+
185+
return watcher
186+
}

0 commit comments

Comments
 (0)