Backtestsvuerun-20261013-093701#15126
compileScript drops template imports from returned when analysis re-runs on a transformed template AST
The merged fix was judged better than our patch.
In this judgment, Patch B = our agent, Patch A = the merged fix.
Both patches fix the root cause the same way. When `template.ast.transformed` is set, the import-usage / v-model analysis re-parses a fresh AST, using the same approach as the guard in `compileTemplate`. **Correctness.** Patch A threads `options.templateOptions` (compiler, compilerOptions, ssr) into the re-parse. Patch B always calls compiler-dom's `parse` with default options. Without the user's options, B's re-parse would mis-parse templates that use custom `delimiters` or other parser options. Interpolations like `[[ foo ]]` would become plain text, so imports used only there would still be dropped from `__returned__`. That is the same bug the issue reports, in a reachable configuration. Patch A avoids it by honouring the compiler options, and its test exercises exactly this case with custom delimiters. **Structure.** Patch A moves the re-parse logic into a shared `resolveTemplateAST` helper used by both `compileTemplate` and the analysis. That keeps the two code paths consistent instead of duplicating them as B does. The refactor is modest and low-risk. **Tests.** Both add tests that would fail before the change. B's tests are broader in which template features they cover (v-for, call expressions, components, custom directives, v-model demotion). A's test simulates the issue scenario more faithfully: it populates the cache, runs `compileTemplate`, clears the cache, then recompiles the script, and it also covers custom delimiters. **Scope and craft.** A exports `templateAnalysisCache` for testing and adds a verbose type annotation, which is minor churn. B is smaller and self-contained, but its hard-coded parser options are a correctness gap. Overall, A's fix is more robust across the configurations the analysis must support, so A is the better patch.
The judge saw only the two patches, labelled A and B in random order, with issue links and version numbers removed. The reasoning above is shown verbatim.
Solve
4m 50s
Wall-clock time in the container
Full test suite
No new failures
618 passed · 1 skipped · 619 total
Contamination audit
Clean
No sign the agent saw the real fix
Patch size
83vs 173 merged
Changed lines, ours vs merged
The issue
View on GitHubVue version
3.5.40
Link to minimal reproduction
https://stackblitz.com/edit/vitejs-vite-evwepvbu?file=package.json
Steps to reproduce
Compile more than 500 unique SFCs for client + SSR (non-inline mode), share each file's descriptor between the two passes (the same way @vitejs/plugin-vue does). The client pass compileTemplate changes the shared template.ast in place, when the analysis cache (capped at 500) evicts a file entry, its SSR compileScript pass re-runs the import usage analysis on that already transformed AST
What is expected?
__returned__ contains every import the template references, same output as when fewer than 500 templates are compiled. The analysis should re-parse when the AST was already transformed, the same guard compileTemplate has with if (inAST?.transformed) in line 214.
What is actually happening?
Imports referenced only from template expressions or with v-for are dropped from __returned__. While the render function still emits $setup.foo(...) and throws TypeError: $setup.foo is not a function at runtime. Because it only happens with more than 500 unique templates it only comes up in large apps in development, in production builds the template are inlined and are unaffected.
System Info
Any additional comments?
Might be the cause for vitejs/vite-plugin-vue#764, vitest-dev/vitest#9855?
The two patches
packages/compiler-sfc/__tests__/compileScript/importUsageCheck.spec.tsindex 210fa0968..60eb44888 100644@@ -1,4 +1,5 @@-import { assertCode, compileSFCScript as compile } from '../utils'+import { compileScript, compileTemplate, parse } from '../../src'+import { assertCode, compileSFCScript as compile, mockId } from '../utils' // in dev mode, declared bindings are returned as an object from setup() // when using TS, users may import types which should not be returned as@@ -265,3 +266,53 @@ test('shorthand binding w/ kebab-case', () => { ) expect(content).toMatch('return { get fooBar() { return fooBar }') })++// when the descriptor is shared between client and SSR compilation (as+// @vitejs/plugin-vue does), compileTemplate transforms `template.ast` in place.+// The usage analysis must not be performed on the transformed AST.+describe('template AST already transformed by compileTemplate', () => {+ function compileWithTransformedAST(src: string) {+ const { descriptor } = parse(src)+ const { errors } = compileTemplate({+ id: mockId,+ filename: 'test.vue',+ source: descriptor.template!.content,+ ast: descriptor.template!.ast,+ })+ expect(errors).toHaveLength(0)+ expect(descriptor.template!.ast!.transformed).toBe(true)+ return compileScript(descriptor, { id: mockId })+ }++ test('imports used in template expressions and v-for', () => {+ const { content } = compileWithTransformedAST(`+ <script setup lang="ts">+ import { transformedFoo, transformedList, transformedFn, TransformedComp, vTransformedDir } from './x'+ </script>+ <template>+ <div v-for="item in transformedList" :key="item">{{ transformedFoo(item) }}</div>+ <TransformedComp v-transformed-dir @click="transformedFn" />+ </template>+ `)+ expect(content).toMatch(+ 'return { get transformedFoo() { return transformedFoo }, ' ++ 'get transformedList() { return transformedList }, ' ++ 'get transformedFn() { return transformedFn }, ' ++ 'get TransformedComp() { return TransformedComp }, ' ++ 'get vTransformedDir() { return vTransformedDir } }',+ )+ })++ test('v-model target demotion', () => {+ const { content } = compileWithTransformedAST(`+ <script setup lang="ts">+ import { reactive } from 'vue'+ const transformedModel = reactive({})+ </script>+ <template>+ <input v-model="transformedModel" />+ </template>+ `)+ expect(content).toMatch('let transformedModel = reactive({})')+ })+})packages/compiler-sfc/src/script/importUsageCheck.tsindex 9c087b466..82129e17a 100644@@ -1,10 +1,14 @@ import type { SFCDescriptor } from '../parse' import {+ type ElementNode, type ExpressionNode, NodeTypes,+ type RootNode, type SimpleExpressionNode, type TemplateChildNode,+ createRoot, isSimpleIdentifier,+ parse, parserOptions, walkIdentifiers, } from '@vue/compiler-dom'@@ -53,7 +57,7 @@ function resolveTemplateAnalysisResult( const ids = collectUsedIds ? new Set<string>() : undefined const vModelIds = new Set<string>() - ast!.children.forEach(walk)+ resolveUntransformedAST(ast!).children.forEach(walk) function walk(node: TemplateChildNode) { switch (node.type) {@@ -134,6 +138,30 @@ function resolveTemplateAnalysisResult( return result } +/**+ * The template AST on the descriptor may have been transformed in place by a+ * previous `compileTemplate` call (e.g. when the same descriptor is shared+ * between client and SSR compilation). A transformed AST no longer reflects+ * the original template (directives are removed, expressions are prefixed),+ * so re-parse a fresh one in that case - same as `compileTemplate` does.+ */+function resolveUntransformedAST(ast: RootNode): RootNode {+ if (!ast.transformed) {+ return ast+ }+ const newAST = parse(ast.source, {+ prefixIdentifiers: true,+ parseMode: 'sfc',+ // the same source was already parsed by `parse()`, which reported any+ // errors on the descriptor - don't throw on them again here.+ onError: () => {},+ })+ const template = newAST.children.find(+ node => node.type === NodeTypes.ELEMENT && node.tag === 'template',+ ) as ElementNode+ return createRoot(template.children, ast.source)+}+ function extractIdentifiers(ids: Set<string>, node: ExpressionNode) { if (node.ast) { walkIdentifiers(node.ast, n => ids.add(n.name))
packages/compiler-sfc/__tests__/compileScript.spec.tsindex 5e547f6b2..d54541019 100644@@ -7,6 +7,8 @@ import { mockId, } from './utils' import { type RawSourceMap, SourceMapConsumer } from 'source-map-js'+import { compileScript, compileTemplate, parse } from '../src'+import { templateAnalysisCache } from '../src/script/importUsageCheck' vi.mock('../src/warn', () => ({ warn: vi.fn(),@@ -345,6 +347,43 @@ describe('SFC compile <script setup>', () => { expect(content).toMatch(`import { useCssVars, ref } from 'vue'`) }) + test('should re-analyze a transformed template after cache invalidation', () => {+ const delimiters: [string, string] = ['[[', ']]']+ const { descriptor } = parse(+ `+ <script setup lang="ts">+ import { cachedMsg } from './cachedMsg'+ </script>+ <template><p>[[ cachedMsg ]]</p></template>+ `,+ { templateParseOptions: { delimiters } },+ )++ const templateOptions = { compilerOptions: { delimiters } }+ compileScript(descriptor, { id: mockId, templateOptions })+ expect(templateAnalysisCache.has(descriptor.template!.content)).toBe(true)++ compileTemplate({+ filename: 'example.vue',+ id: mockId,+ source: descriptor.template!.content,+ ast: descriptor.template!.ast,+ compilerOptions: { delimiters },+ })+ expect(descriptor.template!.ast!.transformed).toBe(true)++ templateAnalysisCache.clear()+ expect(templateAnalysisCache.has(descriptor.template!.content)).toBe(+ false,+ )++ const { content } = compileScript(descriptor, {+ id: mockId,+ templateOptions,+ })+ expect(content).toMatch(`return { get cachedMsg() { return cachedMsg } }`)+ })+ test('import dedupe between <script> and <script setup>', () => { const { content } = compile(` <script>packages/compiler-sfc/src/compileScript.tsindex a60aba17a..d2047c5b2 100644@@ -266,7 +266,7 @@ export function compileScript( !sfc.template.src && !sfc.template.lang ) {- isUsedInTemplate = isImportUsed(local, sfc)+ isUsedInTemplate = isImportUsed(local, sfc, options.templateOptions) } ctx.userImports[local] = {@@ -769,7 +769,10 @@ export function compileScript( // which requires a SETUP_LET binding (getter + setter) to keep script state in sync. // In inline mode, it generates `foo = $event`, which also requires `let`. if (sfc.template && !sfc.template.src && sfc.template.ast) {- const vModelIds = resolveTemplateVModelIdentifiers(sfc)+ const vModelIds = resolveTemplateVModelIdentifiers(+ sfc,+ options.templateOptions,+ ) if (vModelIds.size) { const toDemote = new Set<string>() for (const id of vModelIds) {packages/compiler-sfc/src/compileTemplate.tsindex b043cf813..6c8ad3988 100644@@ -1,14 +1,11 @@-import {- type CodegenResult,- type CompilerError,- type CompilerOptions,- type ElementNode,- type NodeTransform,- NodeTypes,- type ParserOptions,- type RawSourceMap,- type RootNode,- createRoot,+import type {+ CodegenResult,+ CompilerError,+ CompilerOptions,+ NodeTransform,+ ParserOptions,+ RawSourceMap,+ RootNode, } from '@vue/compiler-core' import { SourceMapConsumer, SourceMapGenerator } from 'source-map-js' import {@@ -28,6 +25,7 @@ import * as CompilerSSR from '@vue/compiler-ssr' import consolidate from '@vue/consolidate' import { warnOnce } from './warn' import { genCssVarsFromList } from './style/cssVars'+import { resolveTemplateAST } from './template/resolveTemplateAST' export interface TemplateCompiler { compile(source: string | RootNode, options: CompilerOptions): CodegenResult@@ -211,21 +209,12 @@ function doCompileTemplate({ inAST = undefined } - if (inAST?.transformed) {- // If input AST has already been transformed, then it cannot be reused.- // We need to parse a fresh one. Can't just use `source` here since we need- // the AST location info to be relative to the entire SFC.- const newAST = (ssr ? CompilerDOM : compiler).parse(inAST.source, {- prefixIdentifiers: true,- ...compilerOptions,- parseMode: 'sfc',- onError: e => errors.push(e),- })- const template = newAST.children.find(- node => node.type === NodeTypes.ELEMENT && node.tag === 'template',- ) as ElementNode- inAST = createRoot(template.children, inAST.source)- }+ inAST = resolveTemplateAST(inAST, {+ compiler,+ compilerOptions,+ ssr,+ onError: e => errors.push(e),+ }) let { code, ast, preamble, map } = compiler.compile(inAST || source, { mode: 'module',packages/compiler-sfc/src/script/importUsageCheck.tsindex 9c087b466..fa16a1adc 100644@@ -1,4 +1,5 @@ import type { SFCDescriptor } from '../parse'+import type { SFCTemplateCompileOptions } from '../compileTemplate' import { type ExpressionNode, NodeTypes,@@ -8,36 +9,57 @@ import { parserOptions, walkIdentifiers, } from '@vue/compiler-dom'+import type { LRUCache } from 'lru-cache' import { createCache } from '../cache' import { camelize, capitalize, isBuiltInDirective } from '@vue/shared'+import { resolveTemplateAST } from '../template/resolveTemplateAST'++type TemplateOptions = Pick<+ SFCTemplateCompileOptions,+ 'compiler' | 'compilerOptions' | 'ssr'+> /** * Check if an import is used in the SFC's template. This is used to determine * the properties that should be included in the object returned from setup() * when not using inline mode. */-export function isImportUsed(local: string, sfc: SFCDescriptor): boolean {- return resolveTemplateUsedIdentifiers(sfc).has(local)+export function isImportUsed(+ local: string,+ sfc: SFCDescriptor,+ options?: TemplateOptions,+): boolean {+ return resolveTemplateUsedIdentifiers(sfc, options).has(local) } -const templateAnalysisCache = createCache<{+type TemplateAnalysisResult = { usedIds?: Set<string> vModelIds: Set<string>-}>()+}++export const templateAnalysisCache:+ | Map<string, TemplateAnalysisResult>+ | LRUCache<string, TemplateAnalysisResult> =+ createCache<TemplateAnalysisResult>() export function resolveTemplateVModelIdentifiers( sfc: SFCDescriptor,+ options?: TemplateOptions, ): Set<string> {- return resolveTemplateAnalysisResult(sfc, false).vModelIds+ return resolveTemplateAnalysisResult(sfc, false, options).vModelIds } -function resolveTemplateUsedIdentifiers(sfc: SFCDescriptor): Set<string> {- return resolveTemplateAnalysisResult(sfc).usedIds!+function resolveTemplateUsedIdentifiers(+ sfc: SFCDescriptor,+ options?: TemplateOptions,+): Set<string> {+ return resolveTemplateAnalysisResult(sfc, true, options).usedIds! } function resolveTemplateAnalysisResult( sfc: SFCDescriptor, collectUsedIds = true,+ options?: TemplateOptions, ): { usedIds?: Set<string> vModelIds: Set<string>@@ -53,7 +75,15 @@ function resolveTemplateAnalysisResult( const ids = collectUsedIds ? new Set<string>() : undefined const vModelIds = new Set<string>() - ast!.children.forEach(walk)+ const root = resolveTemplateAST(ast, {+ compiler: options?.compiler,+ compilerOptions: options?.compilerOptions,+ ssr: options?.ssr,+ // ignore errors since they were already reported by the SFC parser+ onError: () => {},+ })++ root!.children.forEach(walk) function walk(node: TemplateChildNode) { switch (node.type) {packages/compiler-sfc/src/template/resolveTemplateAST.tsnew file mode 100644index 000000000..b2897e56d@@ -0,0 +1,40 @@+import {+ type CompilerError,+ type ElementNode,+ NodeTypes,+ type ParserOptions,+ type RootNode,+ createRoot,+} from '@vue/compiler-core'+import * as CompilerDOM from '@vue/compiler-dom'++interface TemplateParser {+ parse(template: string, options: ParserOptions): RootNode+}++export function resolveTemplateAST(+ inAST: RootNode | undefined,+ options: {+ compiler?: TemplateParser+ compilerOptions?: ParserOptions+ ssr?: boolean+ onError: (error: CompilerError) => void+ },+): RootNode | undefined {+ if (!inAST?.transformed) {+ return inAST+ }++ // Parse the full SFC source to preserve template locations relative to it.+ const { compiler = CompilerDOM, compilerOptions, ssr, onError } = options+ const newAST = (ssr ? CompilerDOM : compiler).parse(inAST.source, {+ prefixIdentifiers: true,+ ...compilerOptions,+ parseMode: 'sfc',+ onError,+ })+ const template = newAST.children.find(+ node => node.type === NodeTypes.ELEMENT && node.tag === 'template',+ ) as ElementNode+ return createRoot(template.children, inAST.source)+}