refactor: avoid direct mutate chunk at metadata plugin

underfin · underfin · commit c3f2b85cfa5e · 2024-07-30T15:14:39.000+08:00
diff --git a/packages/vite/src/node/plugins/asset.ts b/packages/vite/src/node/plugins/asset.ts
@@ -31,6 +31,7 @@ import {
 import { DEFAULT_ASSETS_INLINE_LIMIT, FS_PREFIX } from '../constants'
 import type { ModuleGraph } from '../server/moduleGraph'
 import { cleanUrl, withTrailingSlash } from '../../shared/utils'
+import { getChunkMetadata } from './metadata'
 
 // referenceId is base64url but replaces - with $
 export const assetUrlRE = /__VITE_ASSET__([\w$]+)__(?:\$_(.*?)__)?/g
@@ -89,7 +90,7 @@ export function renderAssetUrlInJS(
     s ||= new MagicString(code)
     const [full, referenceId, postfix = ''] = match
     const file = ctx.getFileName(referenceId)
-    chunk.viteMetadata!.importedAssets.add(cleanUrl(file))
+    getChunkMetadata(chunk.fileName)!.importedAssets.add(cleanUrl(file))
     const filename = file + postfix
     const replacement = toOutputFilePathInJS(
       filename,
diff --git a/packages/vite/src/node/plugins/css.ts b/packages/vite/src/node/plugins/css.ts
@@ -83,6 +83,7 @@ import {
 } from './asset'
 import type { ESBuildOptions } from './esbuild'
 import { getChunkOriginalFileName } from './manifest'
+import { getChunkMetadata } from './metadata'
 
 const decoder = new TextDecoder()
 // const debug = createDebugger('vite:css')
@@ -600,7 +601,7 @@ export function cssPostPlugin(config: ResolvedConfig): Plugin {
         // replace asset url references with resolved url.
         chunkCSS = chunkCSS.replace(assetUrlRE, (_, fileHash, postfix = '') => {
           const filename = this.getFileName(fileHash) + postfix
-          chunk.viteMetadata!.importedAssets.add(cleanUrl(filename))
+          getChunkMetadata(chunk.fileName)!.importedAssets.add(cleanUrl(filename))
           return encodeURIPath(
             toOutputFilePathInCss(
               filename,
@@ -771,7 +772,7 @@ export function cssPostPlugin(config: ResolvedConfig): Plugin {
             generatedAssets
               .get(config)!
               .set(referenceId, { originalName: originalFilename, isEntry })
-            chunk.viteMetadata!.importedCss.add(this.getFileName(referenceId))
+              getChunkMetadata(chunk.fileName)!.importedCss.add(this.getFileName(referenceId))
           } else if (!config.build.ssr) {
             // legacy build and inline css
 
@@ -831,9 +832,9 @@ export function cssPostPlugin(config: ResolvedConfig): Plugin {
     },
 
     augmentChunkHash(chunk) {
-      if (chunk.viteMetadata?.importedCss.size) {
+      if (getChunkMetadata(chunk.fileName)?.importedCss.size) {
         let hash = ''
-        for (const id of chunk.viteMetadata.importedCss) {
+        for (const id of getChunkMetadata(chunk.fileName)!.importedCss) {
           hash += id
         }
         return hash
@@ -924,14 +925,12 @@ export function cssPostPlugin(config: ResolvedConfig): Plugin {
             // chunks instead.
             chunk.imports = chunk.imports.filter((file) => {
               if (pureCssChunkNames.includes(file)) {
-                const { importedCss, importedAssets } = (
-                  bundle[file] as OutputChunk
-                ).viteMetadata!
+                const { importedCss, importedAssets } =  getChunkMetadata((bundle[file] as OutputChunk).fileName)!
                 importedCss.forEach((file) =>
-                  chunk.viteMetadata!.importedCss.add(file),
+                  getChunkMetadata(chunk.fileName)!.importedCss.add(file),
                 )
                 importedAssets.forEach((file) =>
-                  chunk.viteMetadata!.importedAssets.add(file),
+                  getChunkMetadata(chunk.fileName)!.importedAssets.add(file),
                 )
                 chunkImportsPureCssChunk = true
                 return false
diff --git a/packages/vite/src/node/plugins/html.ts b/packages/vite/src/node/plugins/html.ts
@@ -39,6 +39,7 @@ import {
 } from './asset'
 import { isCSSRequest } from './css'
 import { modulePreloadPolyfillId } from './modulePreloadPolyfill'
+import { getChunkMetadata } from './metadata'
 
 interface ScriptAssetsUrl {
   start: number
@@ -758,7 +759,7 @@ export function buildHtmlPlugin(config: ResolvedConfig): Plugin {
           })
         }
 
-        chunk.viteMetadata!.importedCss.forEach((file) => {
+        getChunkMetadata(chunk.fileName)!.importedCss.forEach((file) => {
           if (!seen.has(file)) {
             seen.add(file)
             tags.push({
@@ -906,7 +907,7 @@ export function buildHtmlPlugin(config: ResolvedConfig): Plugin {
         result = result.replace(assetUrlRE, (_, fileHash, postfix = '') => {
           const file = this.getFileName(fileHash)
           if (chunk) {
-            chunk.viteMetadata!.importedAssets.add(cleanUrl(file))
+            getChunkMetadata(chunk.fileName)!.importedAssets.add(cleanUrl(file))
           }
           return encodeURIPath(toOutputAssetFilePath(file)) + postfix
         })
diff --git a/packages/vite/src/node/plugins/importAnalysisBuild.ts b/packages/vite/src/node/plugins/importAnalysisBuild.ts
@@ -20,6 +20,7 @@ import { toOutputFilePathInJS } from '../build'
 import { genSourceMapUrl } from '../server/sourcemap'
 import { removedPureCssFilesCache } from './css'
 import { createParseErrorInfo } from './importAnalysis'
+import { getChunkMetadata } from './metadata'
 
 type FileDep = {
   url: string
@@ -542,7 +543,7 @@ export function buildImportAnalysisPlugin(config: ResolvedConfig): Plugin {
                       chunk.imports.forEach(addDeps)
                       // Ensure that the css imported by current chunk is loaded after the dependencies.
                       // So the style of current chunk won't be overwritten unexpectedly.
-                      chunk.viteMetadata!.importedCss.forEach((file) => {
+                      getChunkMetadata(chunk.fileName)!.importedCss.forEach((file) => {
                         deps.add(file)
                       })
                     }
@@ -551,8 +552,8 @@ export function buildImportAnalysisPlugin(config: ResolvedConfig): Plugin {
                       removedPureCssFilesCache.get(config)!
                     const chunk = removedPureCssFiles.get(filename)
                     if (chunk) {
-                      if (chunk.viteMetadata!.importedCss.size) {
-                        chunk.viteMetadata!.importedCss.forEach((file) => {
+                      if (getChunkMetadata(chunk.fileName)!.importedCss.size) {
+                        getChunkMetadata(chunk.fileName)!.importedCss.forEach((file) => {
                           deps.add(file)
                         })
                         hasRemovedPureCssChunk = true
diff --git a/packages/vite/src/node/plugins/manifest.ts b/packages/vite/src/node/plugins/manifest.ts
@@ -10,6 +10,7 @@ import type { Plugin } from '../plugin'
 import { normalizePath, sortObjectKeys } from '../utils'
 import { generatedAssets } from './asset'
 import type { GeneratedAssetMeta } from './asset'
+import { getChunkMetadata } from './metadata'
 
 const endsWithJSRE = /\.[cm]?js$/
 
@@ -88,11 +89,11 @@ export function manifestPlugin(config: ResolvedConfig): Plugin {
           }
         }
 
-        if (chunk.viteMetadata?.importedCss.size) {
-          manifestChunk.css = [...chunk.viteMetadata.importedCss]
+        if (getChunkMetadata(chunk.fileName)?.importedCss.size) {
+          manifestChunk.css = [...getChunkMetadata(chunk.fileName)!.importedCss]
         }
-        if (chunk.viteMetadata?.importedAssets.size) {
-          manifestChunk.assets = [...chunk.viteMetadata.importedAssets]
+        if (getChunkMetadata(chunk.fileName)?.importedAssets.size) {
+          manifestChunk.assets = [...getChunkMetadata(chunk.fileName)!.importedAssets]
         }
 
         return manifestChunk
diff --git a/packages/vite/src/node/plugins/metadata.ts b/packages/vite/src/node/plugins/metadata.ts
@@ -1,5 +1,12 @@
 import type { Plugin } from '../plugin'
 
+interface ChunkMetadata {
+  importedAssets: Set<string>
+  importedCss: Set<string>
+}
+
+const chunkMetadataMap = new Map<string, ChunkMetadata>()
+
 /**
  * Prepares the rendered chunks to contain additional metadata during build.
  */
@@ -8,11 +15,17 @@ export function metadataPlugin(): Plugin {
     name: 'vite:build-metadata',
 
     async renderChunk(_code, chunk) {
-      chunk.viteMetadata = {
+      // Since the chunk come from rust side, mutate it directly will not sync back to rust side.
+      // The next usage will lost the metadata
+      chunkMetadataMap.set(chunk.fileName, {
         importedAssets: new Set(),
         importedCss: new Set(),
-      }
+      })
       return null
     },
   }
 }
+
+export function getChunkMetadata(fileName: string): ChunkMetadata | undefined {
+  return chunkMetadataMap.get(fileName)
+}
diff --git a/packages/vite/src/node/ssr/ssrManifestPlugin.ts b/packages/vite/src/node/ssr/ssrManifestPlugin.ts
@@ -15,6 +15,7 @@ import {
   numberToPos,
   sortObjectKeys,
 } from '../utils'
+import { getChunkMetadata } from '../plugins/metadata'
 
 export function ssrManifestPlugin(config: ResolvedConfig): Plugin {
   // module id => preload assets mapping
@@ -35,11 +36,11 @@ export function ssrManifestPlugin(config: ResolvedConfig): Plugin {
               mappedChunks.push(joinUrlSegments(base, chunk.fileName))
               // <link> tags for entry chunks are already generated in static HTML,
               // so we only need to record info for non-entry chunks.
-              chunk.viteMetadata!.importedCss.forEach((file) => {
+              getChunkMetadata(chunk.fileName)!.importedCss.forEach((file) => {
                 mappedChunks.push(joinUrlSegments(base, file))
               })
             }
-            chunk.viteMetadata!.importedAssets.forEach((file) => {
+            getChunkMetadata(chunk.fileName)!.importedAssets.forEach((file) => {
               mappedChunks.push(joinUrlSegments(base, file))
             })
           }
@@ -77,7 +78,7 @@ export function ssrManifestPlugin(config: ResolvedConfig): Plugin {
                   analyzed.add(filename)
                   const chunk = bundle[filename] as OutputChunk | undefined
                   if (chunk) {
-                    chunk.viteMetadata!.importedCss.forEach((file) => {
+                    getChunkMetadata(chunk.fileName)!.importedCss.forEach((file) => {
                       deps.push(joinUrlSegments(base, file)) // TODO:base
                     })
                     chunk.imports.forEach(addDeps)

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,7 @@ import type { Plugin } from '../plugin'`
`10`	`10`	`import { normalizePath, sortObjectKeys } from '../utils'`
`11`	`11`	`import { generatedAssets } from './asset'`
`12`	`12`	`import type { GeneratedAssetMeta } from './asset'`
	`13`	`+import { getChunkMetadata } from './metadata'`
`13`	`14`
`14`	`15`	`const endsWithJSRE = /\.[cm]?js$/`
`15`	`16`
`@@ -88,11 +89,11 @@ export function manifestPlugin(config: ResolvedConfig): Plugin {`
`88`	`89`	`}`
`89`	`90`	`}`
`90`	`91`
`91`		`- if (chunk.viteMetadata?.importedCss.size) {`
`92`		`- manifestChunk.css = [...chunk.viteMetadata.importedCss]`
	`92`	`+ if (getChunkMetadata(chunk.fileName)?.importedCss.size) {`
	`93`	`+ manifestChunk.css = [...getChunkMetadata(chunk.fileName)!.importedCss]`
`93`	`94`	`}`
`94`		`- if (chunk.viteMetadata?.importedAssets.size) {`
`95`		`- manifestChunk.assets = [...chunk.viteMetadata.importedAssets]`
	`95`	`+ if (getChunkMetadata(chunk.fileName)?.importedAssets.size) {`
	`96`	`+ manifestChunk.assets = [...getChunkMetadata(chunk.fileName)!.importedAssets]`
`96`	`97`	`}`
`97`	`98`
`98`	`99`	`return manifestChunk`