Backtestsvuerun-20261005-155915#9239
the div which has the ref attribute inside the v-for, when I v-if toggle them, the ref value.length increase more and more
The merged fix was judged better than our patch.
In this judgment, Patch A = our agent, Patch B = the merged fix.
Both patches fix the root cause. In a stable v-for fragment, `transformFor` turns an element that was forced into a block (for example by a dynamic `:key`) back into a plain vnode. `buildProps` had skipped NEED_PATCH because `shouldUseBlock` was true, so the resulting vnode has no patch flag. It is then not tracked in `dynamicChildren`, and on unmount its ref is never unset, so the ref array keeps growing. **Patch A** removes the `!shouldUseBlock` guard, so NEED_PATCH is added unconditionally. - This fixes the reported case. - It also changes codegen for every directive or ref element that is genuinely a block. The snapshots now emit `512` on blocks. This is likely harmless at runtime, but it is broader churn than needed. - It leaves an adjacent bug in place: elements forced into blocks so that `vue:before-update` runs before children are still downgraded to plain vnodes in stable v-for. A's own test asserts `isBlock: false` for that case. - Constant (setup-const) function refs still return early in `analyzePatchFlag` before `hasRef` is set, so that variant of the issue (refs not nulled) is not fixed. - Tests: a compiler test asserting the flag, and a runtime test reproducing the issue scenario, which is good. **Patch B** records `needsPatch` and `isBlockRequired` on the VNodeCall. It applies NEED_PATCH only when `transformFor` actually converts the node to a non-block, so block codegen elsewhere is unchanged. - It preserves block status where ordering requires it (before-update hooks, including the camelized `vue:beforeUpdate` form). - It moves `hasRef = true` ahead of the constant-value early return, so setup-const function refs also get nulled on unmount. This directly matches the issue's mention of ref functions. - Tests are thorough and behavioural: - static ref array clearing - function ref called with null - directive and vnode unmounted hooks - beforeUpdate ordering for both directives and vnode hooks - compiler assertions, including that NEED_PATCH is not added when another flag already tracks the node. B is more complex but well targeted, and it keeps existing block semantics intact. It is more correct across the related scenarios and has stronger tests.
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
17m 41s
Wall-clock time in the container
Full test suite
No new failures
3,659 passed · 6 skipped · 3,666 total
Contamination audit
Clean
No sign the agent saw the real fix
Patch size
118vs 338 merged
Changed lines, ours vs merged
The issue
View on GitHubVue version
3.2.47
Link to minimal reproduction
Steps to reproduce
if I click toggleVisible many times,
- the
refDivSingletoggle between null and div - the
refCompSingletoggle between null and {} - the
refDivArr.lengthincrease more and more <-- error here - the
refCompArr.lengthtoggle between 3 and 0
if I use ref function, it don't get null
<img width="532" alt="image" src="https://github.com/vuejs/core/assets/417448/b1a09a97-2c9f-4310-9430-27aa04b79863">
What is expected?
the refDivArr.length should toggle between 3 and 0, same as the refCompArr.length
What is actually happening?
the refDivArr.length increase more and more
System Info
_No response_
Any additional comments?
_No response_
The two patches
packages/compiler-core/__tests__/transforms/__snapshots__/cacheStatic.spec.ts.snapindex 7d5e47719..ea966a937 100644@@ -217,7 +217,7 @@ return function render(_ctx, _cache) { return (_openBlock(), _createElementBlock("div", null, [ _withDirectives((_openBlock(), _createElementBlock("svg", null, [...(_cache[0] || (_cache[0] = [ _createElementVNode("path", { d: "M2,3H5.5L12" }, null, -1 /* CACHED */)- ]))])), [+ ]))], 512 /* NEED_PATCH */)), [ [_directive_foo] ]) ]))packages/compiler-core/__tests__/transforms/__snapshots__/transformText.spec.ts.snapindex 7fb49ea78..55a7d7143 100644@@ -73,7 +73,7 @@ return function render(_ctx, _cache) { return _withDirectives((_openBlock(), _createElementBlock("p", null, [ _createTextVNode(_toDisplayString(foo), 1 /* TEXT */)- ])), [+ ], 512 /* NEED_PATCH */)), [ [_directive_foo] ]) }packages/compiler-core/__tests__/transforms/vFor.spec.tsindex 839d9d358..b77f306fe 100644@@ -3,6 +3,7 @@ import { transform } from '../../src/transform' import { transformIf } from '../../src/transforms/vIf' import { transformFor } from '../../src/transforms/vFor' import { transformBind } from '../../src/transforms/vBind'+import { transformOn } from '../../src/transforms/vOn' import { transformElement } from '../../src/transforms/transformElement' import { transformSlotOutlet } from '../../src/transforms/transformSlotOutlet' import { transformExpression } from '../../src/transforms/transformExpression'@@ -874,6 +875,56 @@ describe('compiler: v-for', () => { expect(generate(root).code).toMatchSnapshot() }) + // #8348 elements forced into blocks (e.g. by a dynamic key) are turned+ // back into plain vnodes by stable v-for fragments, so they must still+ // carry NEED_PATCH to be tracked as dynamic children (ref unset,+ // directive / vnode hooks on unmount)+ describe('v-for with constant expression on element forced into block', () => {+ const assertNeedPatch = (+ template: string,+ options: CompilerOptions = {},+ ) => {+ const {+ node: { codegenNode },+ } = parseWithForTransform(template, {+ prefixIdentifiers: true,+ ...options,+ })+ const { innerVNodeCall } = assertSharedCodegen(+ codegenNode,+ false /* keyed */,+ false /* customReturn */,+ false /* disableTracking */,+ )+ expect(innerVNodeCall).toMatchObject({+ isBlock: false,+ patchFlag: PatchFlags.NEED_PATCH,+ })+ }++ test('dynamic key + ref', () => {+ assertNeedPatch('<div v-for="(item, i) in 3" :key="i" ref="foo" />')+ })++ test('dynamic key + dynamic ref', () => {+ assertNeedPatch('<div v-for="(item, i) in 3" :key="i" :ref="foo" />')+ })++ test('custom directive with children', () => {+ assertNeedPatch('<div v-for="item in 3" v-foo><span /></div>')+ })++ test('vnode before-update hook with children', () => {+ assertNeedPatch(+ '<div v-for="item in 3" @vue:before-update="foo"><span /></div>',+ {+ cacheHandlers: true,+ directiveTransforms: { bind: transformBind, on: transformOn },+ },+ )+ })+ })+ test('template v-for', () => { const { root,packages/compiler-core/src/transforms/transformElement.tsindex 40f08d45b..9ea0bed2a 100644@@ -736,8 +736,10 @@ export function buildProps( patchFlag |= PatchFlags.NEED_HYDRATION } }+ // #8348 this is needed even if the element is forced into a block, since it+ // may later be turned back into a plain vnode (e.g. by stable v-for+ // fragments) and must still be tracked as a dynamic child. if (- !shouldUseBlock && (patchFlag === 0 || patchFlag === PatchFlags.NEED_HYDRATION) && (hasRef || hasVnodeHook || runtimeDirectives.length > 0) ) {packages/vue/__tests__/index.spec.tsindex 79e48b775..1cef8b1e1 100644@@ -347,4 +347,63 @@ describe('compiler + runtime integration', () => { app.mount(root) expect(root.innerHTML).toBe('<div>60000000100000111</div>') })++ // #8348+ it('should unset template refs of keyed elements in constant v-for when unmounted', async () => {+ const container = document.createElement('div')+ const isVisible = ref(true)+ const refDivArr = ref<Element[]>([])+ const refCompArr = ref<any[]>([])+ const App = {+ components: {+ CompB: { template: `<div class="wrap">test</div>` },+ },+ setup: () => ({ isVisible, refDivArr, refCompArr }),+ // match SFC / build-time compilation where constant v-for sources+ // produce stable fragments+ compilerOptions: { prefixIdentifiers: true } as any,+ template: `+ <div>{{ refDivArr.length }}</div>+ <div v-if="isVisible">+ <div v-for="(v, index) in 3" :key="index" ref="refDivArr">+ <CompB ref="refCompArr" />+ </div>+ </div>`,+ }+ createApp(App).mount(container)+ await nextTick()+ expect(refDivArr.value.length).toBe(3)+ expect(refCompArr.value.length).toBe(3)++ for (let i = 0; i < 3; i++) {+ isVisible.value = false+ await nextTick()+ expect(refDivArr.value.length).toBe(0)+ expect(refCompArr.value.length).toBe(0)++ isVisible.value = true+ await nextTick()+ expect(refDivArr.value.length).toBe(3)+ expect(refCompArr.value.length).toBe(3)+ }+ })++ it('should call custom directive unmounted hook on elements in constant v-for', async () => {+ const container = document.createElement('div')+ const isVisible = ref(true)+ const unmounted = vi.fn()+ const App = {+ directives: { foo: { unmounted } },+ setup: () => ({ isVisible }),+ compilerOptions: { prefixIdentifiers: true } as any,+ template: `+ <div v-if="isVisible">+ <div v-for="i in 3" v-foo><span>{{ i }}</span></div>+ </div>`,+ }+ createApp(App).mount(container)+ isVisible.value = false+ await nextTick()+ expect(unmounted).toHaveBeenCalledTimes(3)+ }) })
packages/compiler-core/__tests__/transforms/transformElement.spec.tsindex bf3510a05..8215ceedb 100644@@ -74,6 +74,12 @@ function parseWithBind(template: string, options?: CompilerOptions) { }) } +function getVForChild(+ node: ReturnType<typeof parseWithForTransform>['node'],+): VNodeCall {+ return node.codegenNode.children.arguments[1].returns as VNodeCall+}+ describe('compiler: element transform', () => { test('import + resolve component', () => { const { root } = parseWithElementTransform(`<Foo/>`)@@ -1028,6 +1034,105 @@ describe('compiler: element transform', () => { expect(node.patchFlag).toBe(PatchFlags.NEED_PATCH) }) + test('NEED_PATCH (stable v-for + static ref)', () => {+ const { node } = parseWithForTransform(+ `<div v-for="i in 3" :key="i" ref="foo" />`,+ { prefixIdentifiers: true },+ )+ const child = getVForChild(node)+ expect(child.isBlock).toBe(false)+ expect(child.patchFlag).toBe(PatchFlags.NEED_PATCH)+ })++ test('NEED_PATCH (stable v-for + custom directives)', () => {+ const { node } = parseWithForTransform(+ `<div v-for="i in 3" :key="i" v-dir />`,+ { prefixIdentifiers: true },+ )+ const child = getVForChild(node)+ expect(child.isBlock).toBe(false)+ expect(child.patchFlag).toBe(PatchFlags.NEED_PATCH)+ })++ test('NEED_PATCH (stable v-for + vnode hooks)', () => {+ const { node } = parseWithForTransform(+ `<div v-for="i in 3" :key="i" @vue:unmounted="foo" />`,+ {+ prefixIdentifiers: true,+ cacheHandlers: true,+ directiveTransforms: {+ bind: transformBind,+ on: transformOn,+ },+ },+ )+ const child = getVForChild(node)+ expect(child.isBlock).toBe(false)+ expect(child.patchFlag).toBe(PatchFlags.NEED_PATCH)+ })++ test('NEED_PATCH (stable v-for + setup-const function ref)', () => {+ const { node } = parseWithForTransform(+ `<div v-for="i in 3" :key="i" :ref="setRefFn" />`,+ {+ prefixIdentifiers: true,+ bindingMetadata: {+ setRefFn: BindingTypes.SETUP_CONST,+ },+ },+ )+ const child = getVForChild(node)+ expect(child.isBlock).toBe(false)+ expect(child.patchFlag).toBe(PatchFlags.NEED_PATCH)+ })++ test('preserve block for stable v-for + custom directive with children', () => {+ const { node } = parseWithForTransform(+ `<div v-for="i in 3" v-dir>{{ i }}</div>`,+ { prefixIdentifiers: true },+ )+ const child = getVForChild(node)+ expect(child.isBlock).toBe(true)+ expect(child.patchFlag).toBe(PatchFlags.TEXT)+ })++ test.each(['before-update', 'beforeUpdate'])(+ 'preserve block for stable v-for + @vue:%s vnode hook',+ hook => {+ const { node } = parseWithForTransform(+ `<div v-for="i in 3" @vue:${hook}="foo"><span /></div>`,+ {+ prefixIdentifiers: true,+ cacheHandlers: true,+ directiveTransforms: {+ bind: transformBind,+ on: transformOn,+ },+ },+ )+ const child = getVForChild(node)+ expect(child.isBlock).toBe(true)+ expect(child.patchFlag).toBeUndefined()+ },+ )++ test('does not add NEED_PATCH when another patch flag tracks the vnode', () => {+ const { node } = parseWithForTransform(+ `<div v-for="i in 3" :key="i" @vue:unmounted="foo">{{ i }}</div>`,+ {+ prefixIdentifiers: true,+ cacheHandlers: true,+ directiveTransforms: {+ bind: transformBind,+ on: transformOn,+ },+ },+ )+ const child = getVForChild(node)+ expect(child.isBlock).toBe(false)+ expect(child.patchFlag).toBe(PatchFlags.TEXT)+ })+ test('script setup inline mode template ref (binding exists)', () => { const { node } = parseWithElementTransform(`<input ref="input"/>`, { inline: true,packages/compiler-core/src/ast.tsindex e6da01edb..f67231539 100644@@ -330,6 +330,10 @@ export interface VNodeCall extends Node { patchFlag: PatchFlags | undefined dynamicProps: string | SimpleExpressionNode | undefined directives: DirectiveArguments | undefined+ /** Whether this vnode must be patched if a later transform makes it non-block. */+ needsPatch?: boolean+ /** Whether a later transform must preserve this vnode as a block. */+ isBlockRequired?: boolean isBlock: boolean disableTracking: boolean isComponent: booleanpackages/compiler-core/src/transforms/transformElement.tsindex 40f08d45b..b2024b329 100644@@ -102,6 +102,8 @@ export const transformElement: NodeTransform = (node, context) => { let vnodeDynamicProps: VNodeCall['dynamicProps'] let dynamicPropNames: string[] | undefined let vnodeDirectives: VNodeCall['directives']+ let needsPatch = false+ let isBlockRequired = false let shouldUseBlock = // dynamic component may resolve to plain elements@@ -127,6 +129,8 @@ export const transformElement: NodeTransform = (node, context) => { vnodeProps = propsBuildResult.props patchFlag = propsBuildResult.patchFlag dynamicPropNames = propsBuildResult.dynamicPropNames+ needsPatch = propsBuildResult.needsPatch+ isBlockRequired = propsBuildResult.isBlockRequired const directives = propsBuildResult.directives vnodeDirectives = directives && directives.length@@ -206,7 +210,7 @@ export const transformElement: NodeTransform = (node, context) => { vnodeDynamicProps = stringifyDynamicPropNames(dynamicPropNames) } - node.codegenNode = createVNodeCall(+ const vnodeCall = (node.codegenNode = createVNodeCall( context, vnodeTag, vnodeProps,@@ -218,7 +222,15 @@ export const transformElement: NodeTransform = (node, context) => { false /* disableTracking */, isComponent, node.loc,- )+ ))+ needsPatch =+ needsPatch && (patchFlag === 0 || patchFlag === PatchFlags.NEED_HYDRATION)+ if (needsPatch) {+ vnodeCall.needsPatch = true+ }+ if (isBlockRequired) {+ vnodeCall.isBlockRequired = true+ } } } @@ -382,6 +394,8 @@ export function buildProps( patchFlag: number dynamicPropNames: string[] shouldUseBlock: boolean+ needsPatch: boolean+ isBlockRequired: boolean } { const { tag, loc: elementLoc, children } = node let properties: ObjectExpression['properties'] = []@@ -389,6 +403,7 @@ export function buildProps( const runtimeDirectives: DirectiveNode[] = [] const hasChildren = children.length > 0 let shouldUseBlock = false+ let isBlockRequired = false // patchFlag analysis let patchFlag = 0@@ -444,6 +459,10 @@ export function buildProps( hasVnodeHook = true } + if (name === 'ref') {+ hasRef = true+ }+ if (isEventHandler && value.type === NodeTypes.JS_CALL_EXPRESSION) { // handler wrapped with internal helper e.g. withModifiers(fn) // extract the actual expression@@ -460,13 +479,15 @@ export function buildProps( return } - if (name === 'ref') {- hasRef = true- } else if (name === 'class') {+ if (name === 'class') { hasClassBinding = true } else if (name === 'style') { hasStyleBinding = true- } else if (name !== 'key' && !dynamicPropNames.includes(name)) {+ } else if (+ name !== 'ref' &&+ name !== 'key' &&+ !dynamicPropNames.includes(name)+ ) { dynamicPropNames.push(name) } @@ -573,14 +594,21 @@ export function buildProps( continue } + // #938: elements with dynamic keys should be forced into blocks+ if (isVBind && isStaticArgOf(arg, 'key')) {+ shouldUseBlock = true+ }+ // inline before-update hooks need to remain blocks so that they are+ // invoked before children if (- // #938: elements with dynamic keys should be forced into blocks- (isVBind && isStaticArgOf(arg, 'key')) ||- // inline before-update hooks need to force block so that it is invoked- // before children- (isVOn && hasChildren && isStaticArgOf(arg, 'vue:before-update'))+ isVOn &&+ hasChildren &&+ arg &&+ isStaticExp(arg) &&+ camelize(arg.content) === 'vue:beforeUpdate' ) { shouldUseBlock = true+ isBlockRequired = true } if (isVBind && isStaticArgOf(arg, 'ref')) {@@ -691,6 +719,7 @@ export function buildProps( // to ensure before-update gets called before children update if (hasChildren) { shouldUseBlock = true+ isBlockRequired = true } } }@@ -736,11 +765,10 @@ export function buildProps( patchFlag |= PatchFlags.NEED_HYDRATION } }- if (- !shouldUseBlock &&+ const needsPatch = (patchFlag === 0 || patchFlag === PatchFlags.NEED_HYDRATION) && (hasRef || hasVnodeHook || runtimeDirectives.length > 0)- ) {+ if (!shouldUseBlock && needsPatch) { patchFlag |= PatchFlags.NEED_PATCH } @@ -825,6 +853,8 @@ export function buildProps( patchFlag, dynamicPropNames, shouldUseBlock,+ needsPatch,+ isBlockRequired, } } packages/compiler-core/src/transforms/vFor.tsindex dcc31a9a9..ebf67d3d7 100644@@ -186,7 +186,9 @@ export const transformFor: NodeTransform = createStructuralDirectiveTransform( if (isTemplate && keyProperty) { injectProp(childBlock, keyProperty, context) }- if (childBlock.isBlock !== !isStableFragment) {+ const shouldUseBlock =+ !isStableFragment || childBlock.isBlockRequired === true+ if (childBlock.isBlock !== shouldUseBlock) { if (childBlock.isBlock) { // switch from block to vnode removeHelper(OPEN_BLOCK)@@ -200,12 +202,16 @@ export const transformFor: NodeTransform = createStructuralDirectiveTransform( ) } }- childBlock.isBlock = !isStableFragment+ childBlock.isBlock = shouldUseBlock if (childBlock.isBlock) { helper(OPEN_BLOCK) helper(getVNodeBlockHelper(context.inSSR, childBlock.isComponent)) } else { helper(getVNodeHelper(context.inSSR, childBlock.isComponent))+ if (childBlock.needsPatch) {+ childBlock.patchFlag = ((childBlock.patchFlag ?? 0) |+ PatchFlags.NEED_PATCH) as PatchFlags+ } } } packages/vue/__tests__/index.spec.tsindex 79e48b775..98f00cf28 100644@@ -1,5 +1,19 @@+import { BindingTypes, type CompilerOptions } from '@vue/compiler-core'+import { compile } from '@vue/compiler-dom' import { EMPTY_ARR } from '@vue/shared'-import { createApp, nextTick, reactive, ref } from '../src'+import { type VNode, createApp, nextTick, reactive, ref } from '../src'+import * as Vue from '../src'+import type { InternalRenderFunction } from '../../runtime-core/src/component'++function compileToFunction(template: string, options?: CompilerOptions) {+ const { code } = compile(template, {+ hoistStatic: true,+ ...options,+ })+ const render = new Function('Vue', code)(Vue) as InternalRenderFunction+ render._rc = true+ return render+} describe('compiler + runtime integration', () => { it('should support runtime template compilation', () => {@@ -347,4 +361,149 @@ describe('compiler + runtime integration', () => { app.mount(root) expect(root.innerHTML).toBe('<div>60000000100000111</div>') })++ describe('stable v-for lifecycle', () => {+ test('clears static ref arrays on branch removal', async () => {+ const show = ref(true)+ const items = ref<HTMLElement[]>([])+ const app = createApp({+ setup: () => ({ items, show }),+ render: compileToFunction(+ `<template v-if="show"><div v-for="i in 3" :key="i" ref="items" /></template>`,+ { prefixIdentifiers: true },+ ),+ })+ const container = document.createElement('div')++ app.mount(container)+ expect(items.value).toHaveLength(3)++ show.value = false+ await nextTick()+ expect(items.value).toHaveLength(0)++ app.unmount()+ })++ test('calls setup-const function refs with null on branch removal', async () => {+ const show = ref(true)+ const values: (Element | null)[] = []+ const setRef = (value: Element | null) => values.push(value)+ const app = createApp({+ setup: () => ({ setRef, show }),+ render: compileToFunction(+ `<template v-if="show"><div v-for="i in 1" :ref="setRef" /></template>`,+ {+ prefixIdentifiers: true,+ bindingMetadata: {+ setRef: BindingTypes.SETUP_CONST,+ },+ },+ ),+ })+ const container = document.createElement('div')++ app.mount(container)+ expect(values).toHaveLength(1)+ expect(values[0]).toBeInstanceOf(HTMLDivElement)++ show.value = false+ await nextTick()+ expect(values).toHaveLength(2)+ expect(values[1]).toBeNull()++ app.unmount()+ })++ test('calls directive unmounted hooks on branch removal', async () => {+ const show = ref(true)+ const unmounted = vi.fn()+ const app = createApp({+ directives: { dir: { unmounted } },+ setup: () => ({ show }),+ render: compileToFunction(+ `<template v-if="show"><div v-for="i in 1" v-dir /></template>`,+ { prefixIdentifiers: true },+ ),+ })+ const container = document.createElement('div')++ app.mount(container)+ show.value = false+ await nextTick()+ expect(unmounted).toHaveBeenCalledOnce()++ app.unmount()+ })++ test('calls vnode unmounted hooks on branch removal', async () => {+ const show = ref(true)+ const onVnodeUnmounted = vi.fn()+ const app = createApp({+ setup: () => ({ onVnodeUnmounted, show }),+ render: compileToFunction(+ `<template v-if="show"><div v-for="i in 1" @vue:unmounted="onVnodeUnmounted" /></template>`,+ { prefixIdentifiers: true },+ ),+ })+ const container = document.createElement('div')++ app.mount(container)+ show.value = false+ await nextTick()+ expect(onVnodeUnmounted).toHaveBeenCalledOnce()++ app.unmount()+ })++ test('runs directive beforeUpdate before child updates', async () => {+ const value = ref('old')+ const observed: string[] = []+ const app = createApp({+ directives: {+ dir: {+ beforeUpdate(el: HTMLElement) {+ observed.push(el.textContent!)+ },+ },+ },+ setup: () => ({ value }),+ render: compileToFunction(+ `<div v-for="i in 1" v-dir>{{ value }}</div>`,+ { prefixIdentifiers: true },+ ),+ })+ const container = document.createElement('div')++ app.mount(container)+ value.value = 'new'+ await nextTick()+ expect(observed).toEqual(['old'])++ app.unmount()+ })++ test('runs vnode beforeUpdate before nested child updates', async () => {+ const value = ref('old')+ const observed: string[] = []+ const onVnodeBeforeUpdate = (vnode: VNode) => {+ observed.push((vnode.el as HTMLElement).textContent!)+ }+ const app = createApp({+ setup: () => ({ onVnodeBeforeUpdate, value }),+ render: compileToFunction(+ `<div v-for="i in 1" @vue:beforeUpdate="onVnodeBeforeUpdate"><span>{{ value }}</span></div>`,+ { prefixIdentifiers: true },+ ),+ })+ const container = document.createElement('div')++ app.mount(container)+ value.value = 'new'+ await nextTick()+ expect(observed).toEqual(['old'])++ app.unmount()+ })+ }) })