fix: distinguish HMR and transform descriptor

vitejs/vite-plugin-vue@9119d4d
vitejs/vite-plugin-vue@b7b1383

Author: sxzz

src/core/handleHotUpdate.ts

@@ -4,7 +4,7 @@ import { type SFCBlock, type SFCDescriptor } from 'vue/compiler-sfc'
 import {
   createDescriptor,
   getDescriptor,
-  setPrevDescriptor,
+  invalidateDescriptor,
 } from './utils/descriptorCache'
 import {
   getResolvedScript,
@@ -25,16 +25,14 @@ export async function handleHotUpdate(
   { file, modules, read }: HmrContext,
   options: ResolvedOptions
 ): Promise<ModuleNode[] | undefined> {
-  const prevDescriptor = getDescriptor(file, options, false)
+  const prevDescriptor = getDescriptor(file, options, false, true)
   if (!prevDescriptor) {
     // file hasn't been requested yet (e.g. async component)
     return
   }
 
-  setPrevDescriptor(file, prevDescriptor)
-
   const content = await read()
-  const { descriptor } = createDescriptor(file, content, options)
+  const { descriptor } = createDescriptor(file, content, options, true)
 
   let needRerender = false
   const affectedModules = new Set<ModuleNode | undefined>()
@@ -147,6 +145,9 @@ export async function handleHotUpdate(
     updateType.push(`style`)
   }
   if (updateType.length > 0) {
+    // invalidate the descriptor cache so that the next transform will
+    // re-analyze the file and pick up the changes.
+    invalidateDescriptor(file)
     debug(`[vue:update(${updateType.join('&')})] ${file}`)
   }
   return [...affectedModules].filter(Boolean) as ModuleNode[]

src/core/main.ts

@@ -1,4 +1,5 @@
 import path from 'node:path'
+import fs from 'node:fs'
 import { normalizePath, transformWithEsbuild } from 'vite'
 import { type RawSourceMap } from 'source-map'
 import {
@@ -16,6 +17,7 @@ import { type PluginContext } from 'rollup'
 import { type SFCBlock, type SFCDescriptor } from 'vue/compiler-sfc'
 import {
   createDescriptor,
+  getDescriptor,
   getPrevDescriptor,
   setSrcDescriptor,
 } from './utils/descriptorCache'
@@ -41,10 +43,13 @@ export async function transformMain(
 ) {
   const { devServer, isProduction, devToolsEnabled } = options
 
-  // prev descriptor is only set and used for hmr
   const prevDescriptor = getPrevDescriptor(filename)
   const { descriptor, errors } = createDescriptor(filename, code, options)
 
+  if (fs.existsSync(filename))
+    // set descriptor for HMR if it's not set yet
+    getDescriptor(filename, options, true, true)
+
   if (errors.length > 0) {
     errors.forEach((error) =>
       pluginContext.error(createRollupError(filename, error))

src/core/utils/descriptorCache.ts

@@ -12,12 +12,14 @@ export interface SFCParseResult {
 }
 
 export const cache = new Map<string, SFCDescriptor>()
+export const hmrCache = new Map<string, SFCDescriptor>()
 const prevCache = new Map<string, SFCDescriptor | undefined>()
 
 export function createDescriptor(
   filename: string,
   source: string,
-  { root, isProduction, sourceMap, compiler }: ResolvedOptions
+  { root, isProduction, sourceMap, compiler }: ResolvedOptions,
+  hmr = false
 ): SFCParseResult {
   const { descriptor, errors } = compiler.parse(source, {
     filename,
@@ -28,37 +30,41 @@ export function createDescriptor(
   // project (relative to root) and on different systems.
   const normalizedPath = slash(path.normalize(path.relative(root, filename)))
   descriptor.id = getHash(normalizedPath + (isProduction ? source : ''))
-
-  cache.set(filename, descriptor)
+  ;(hmr ? hmrCache : cache).set(filename, descriptor)
   return { descriptor, errors }
 }
 
 export function getPrevDescriptor(filename: string): SFCDescriptor | undefined {
   return prevCache.get(filename)
 }
 
-export function setPrevDescriptor(
-  filename: string,
-  entry: SFCDescriptor
-): void {
-  prevCache.set(filename, entry)
+export function invalidateDescriptor(filename: string, hmr = false): void {
+  const _cache = hmr ? hmrCache : cache
+  const prev = _cache.get(filename)
+  _cache.delete(filename)
+  if (prev) {
+    prevCache.set(filename, prev)
+  }
 }
 
 export function getDescriptor(
   filename: string,
   options: ResolvedOptions,
-  createIfNotFound = true
+  createIfNotFound = true,
+  hmr = false
 ): SFCDescriptor | undefined {
-  if (cache.has(filename)) {
-    return cache.get(filename)!
+  const _cache = hmr ? hmrCache : cache
+  if (_cache.has(filename)) {
+    return _cache.get(filename)!
   }
   if (createIfNotFound) {
     const { descriptor, errors } = createDescriptor(
       filename,
       fs.readFileSync(filename, 'utf-8'),
-      options
+      options,
+      hmr
     )
-    if (errors.length > 0) {
+    if (errors.length > 0 && !hmr) {
       throw errors[0]
     }
     return descriptor