fix(dev): watch publicDir explicitly to include it outside the root (#16502)

Shakeskeyboarde · web-flow · commit 4d83eb58cdea · 2024-04-23T12:42:37.000+09:00
diff --git a/packages/vite/src/node/server/__tests__/watcher.spec.ts b/packages/vite/src/node/server/__tests__/watcher.spec.ts
@@ -1,9 +1,47 @@
-import { describe, expect, it } from 'vitest'
+import { resolve } from 'node:path'
+import {
+  type MockInstance,
+  afterEach,
+  beforeEach,
+  describe,
+  expect,
+  it,
+  vi,
+} from 'vitest'
+import chokidar from 'chokidar'
 import { createServer } from '../index'
 
 const stubGetWatchedCode = /getWatched\(\) \{.+?return \{\};.+?\}/s
 
+let watchSpy: MockInstance<
+  Parameters<typeof chokidar.watch>,
+  ReturnType<typeof chokidar.watch>
+>
+
+vi.mock('../../config', async () => {
+  const config: typeof import('../../config') =
+    await vi.importActual('../../config')
+  const resolveConfig = config.resolveConfig
+  vi.spyOn(config, 'resolveConfig').mockImplementation(async (...args) => {
+    const resolved: Awaited<ReturnType<typeof resolveConfig>> =
+      await resolveConfig.call(config, ...args)
+    resolved.configFileDependencies.push(
+      resolve('fake/config/dependency.js').replace(/\\/g, '/'),
+    )
+    return resolved
+  })
+  return config
+})
+
 describe('watcher configuration', () => {
+  beforeEach(() => {
+    watchSpy = vi.spyOn(chokidar, 'watch')
+  })
+
+  afterEach(() => {
+    watchSpy.mockRestore()
+  })
+
   it('when watcher is disabled, return noop watcher', async () => {
     const server = await createServer({
       server: {
@@ -21,4 +59,27 @@ describe('watcher configuration', () => {
     })
     expect(server.watcher.getWatched.toString()).not.toMatch(stubGetWatchedCode)
   })
+
+  it('should watch the root directory, config file dependencies, dotenv files, and the public directory', async () => {
+    await createServer({
+      server: {
+        watch: {},
+      },
+      publicDir: '__test_public__',
+    })
+    expect(watchSpy).toHaveBeenLastCalledWith(
+      expect.arrayContaining(
+        [
+          process.cwd(),
+          resolve('fake/config/dependency.js'),
+          resolve('.env'),
+          resolve('.env.local'),
+          resolve('.env.development'),
+          resolve('.env.development.local'),
+          resolve('__test_public__'),
+        ].map((file) => file.replace(/\\/g, '/')),
+      ),
+      expect.anything(),
+    )
+  })
 })
diff --git a/packages/vite/src/node/server/index.ts b/packages/vite/src/node/server/index.ts
@@ -466,6 +466,9 @@ export async function _createServer(
     config.server.hmr.channels.forEach((channel) => hot.addChannel(channel))
   }
 
+  const publicFiles = await initPublicFilesPromise
+  const { publicDir } = config
+
   if (httpServer) {
     setClientErrorHandler(httpServer, config.logger)
   }
@@ -479,6 +482,9 @@ export async function _createServer(
           root,
           ...config.configFileDependencies,
           ...getEnvFilesForMode(config.mode, config.envDir),
+          // Watch the public directory explicitly because it might be outside
+          // of the root directory.
+          ...(publicDir && publicFiles ? [publicDir] : []),
         ],
         resolvedWatchOptions,
       ) as FSWatcher)
@@ -745,8 +751,6 @@ export async function _createServer(
     }
   }
 
-  const publicFiles = await initPublicFilesPromise
-
   const onHMRUpdate = async (
     type: 'create' | 'delete' | 'update',
     file: string,
@@ -763,8 +767,6 @@ export async function _createServer(
     }
   }
 
-  const { publicDir } = config
-
   const onFileAddUnlink = async (file: string, isUnlink: boolean) => {
     file = normalizePath(file)
     await container.watchChange(file, { event: isUnlink ? 'delete' : 'create' })

Original file line number	Diff line number	Diff line change
`@@ -466,6 +466,9 @@ export async function _createServer(`
`466`	`466`	`config.server.hmr.channels.forEach((channel) => hot.addChannel(channel))`
`467`	`467`	`}`
`468`	`468`
	`469`	`+ const publicFiles = await initPublicFilesPromise`
	`470`	`+ const { publicDir } = config`
	`471`	`+`
`469`	`472`	`if (httpServer) {`
`470`	`473`	`setClientErrorHandler(httpServer, config.logger)`
`471`	`474`	`}`
`@@ -479,6 +482,9 @@ export async function _createServer(`
`479`	`482`	`root,`
`480`	`483`	`...config.configFileDependencies,`
`481`	`484`	`...getEnvFilesForMode(config.mode, config.envDir),`
	`485`	`+ // Watch the public directory explicitly because it might be outside`
	`486`	`+ // of the root directory.`
	`487`	`+ ...(publicDir && publicFiles ? [publicDir] : []),`
`482`	`488`	`],`
`483`	`489`	`resolvedWatchOptions,`
`484`	`490`	`) as FSWatcher)`
`@@ -745,8 +751,6 @@ export async function _createServer(`
`745`	`751`	`}`
`746`	`752`	`}`
`747`	`753`
`748`		`- const publicFiles = await initPublicFilesPromise`
`749`		`-`
`750`	`754`	`const onHMRUpdate = async (`
`751`	`755`	`type: 'create' \| 'delete' \| 'update',`
`752`	`756`	`file: string,`
`@@ -763,8 +767,6 @@ export async function _createServer(`
`763`	`767`	`}`
`764`	`768`	`}`
`765`	`769`
`766`		`- const { publicDir } = config`
`767`		`-`
`768`	`770`	`const onFileAddUnlink = async (file: string, isUnlink: boolean) => {`
`769`	`771`	`file = normalizePath(file)`
`770`	`772`	`await container.watchChange(file, { event: isUnlink ? 'delete' : 'create' })`