Backtestsvuerun-20261009-161443#12569
Custom directive's unmounted event is not triggered on v-for element
The merged fix was judged better than our patch.
In this judgment, Patch B = our agent, Patch A = the merged fix.
Root cause: in a stable v-for (constant source), the child is first forced into a block, either by a dynamic `:key` or by a before-update hook / custom directive with children. Because it is a block, buildProps skips NEED_PATCH. transformFor then demotes it to a plain vnode, so it is missing from the parent's dynamicChildren and its directive/ref/vnode-hook unmount is skipped. Both patches restore NEED_PATCH on demotion, so both fix the reported `:key` + directive case. Patch A carries the decision from buildProps itself. It adds `needsPatch` and `isBlockRequired` on the VNodeCall, so the vFor transform reuses the same analysis instead of duplicating it. A also sees the deeper problem. When an element was made a block so that before-update hooks run before its children update, demoting it to a plain vnode breaks that ordering. Nested dynamic children get collected into the fragment's dynamicChildren ahead of the parent and are patched before the parent's beforeUpdate. A keeps such elements as blocks (`isBlockRequired`). It also handles the camelized `vue:beforeUpdate` spelling. Its runtime tests check this ordering, and they check unmount of directive hooks, vnode hooks, static ref arrays and setup-const function refs. Patch B re-scans the AST props in vFor with a hand-written mirror of buildProps' condition. That copy is fragile and partly odd: it checks `on` args starting with `vnode`, and only static args. B also demotes before-update/directive-with-children blocks, which keeps the hook-ordering regression. Its compiler test even asserts that `<p v-for v-foo>hi</p>` becomes a non-block vnode. B's integration tests are good for the reported scenario but never exercise ordering with nested dynamic children. Overall, A fixes the root cause more robustly and preserves the block semantics. It has broader, meaningful tests and only a modest increase in scope.
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
10m 40s
Wall-clock time in the container
Full test suite
No new failures
1,861 passed · 1 skipped · 1,862 total
Contamination audit
Clean
No sign the agent saw the real fix
Patch size
165vs 338 merged
Changed lines, ours vs merged
The issue
View on GitHubVue version
3.5.13
Link to minimal reproduction
Steps to reproduce
Press F12, Click the 'hide' button, console only logs Div's umounted event, H1's unmounted event is not logged
What is expected?
unmounted event in Directive should be triggered on elements with v-for
What is actually happening?
unmounted event in Directive is not triggered on elements with v-for
System Info
_No response_
Any additional comments?
_No response_
The two patches
packages/compiler-core/__tests__/transforms/vFor.spec.tsindex 839d9d358..e2f65059c 100644@@ -1118,6 +1118,63 @@ describe('compiler: v-for', () => { expect(generate(root).code).toMatchSnapshot() }) + describe('constant source + element forced into block', () => {+ function getInnerVNodeCall(template: string) {+ const {+ node: { codegenNode },+ } = parseWithForTransform(template, { prefixIdentifiers: true })+ expect(codegenNode.patchFlag).toBe(PatchFlags.STABLE_FRAGMENT)+ return (codegenNode.children.arguments[1] as any).returns+ }++ test('custom directive with children', () => {+ expect(+ getInnerVNodeCall('<p v-for="i in 3" v-foo>hi</p>'),+ ).toMatchObject({+ isBlock: false,+ directives: { type: NodeTypes.JS_ARRAY_EXPRESSION },+ patchFlag: PatchFlags.NEED_PATCH,+ })+ })++ test('custom directive with dynamic key', () => {+ expect(+ getInnerVNodeCall('<p v-for="i in 3" :key="i" v-foo/>'),+ ).toMatchObject({+ isBlock: false,+ patchFlag: PatchFlags.NEED_PATCH,+ })+ })++ test('custom directive with dynamic text child', () => {+ // already tracked via the TEXT flag+ expect(+ getInnerVNodeCall('<p v-for="i in 3" :key="i" v-foo>{{ i }}</p>'),+ ).toMatchObject({+ isBlock: false,+ patchFlag: PatchFlags.TEXT,+ })+ })++ test('ref with dynamic key', () => {+ expect(+ getInnerVNodeCall('<p v-for="i in 3" :key="i" ref="el"/>'),+ ).toMatchObject({+ isBlock: false,+ patchFlag: PatchFlags.NEED_PATCH,+ })+ })++ test('plain element with dynamic key', () => {+ expect(getInnerVNodeCall('<p v-for="i in 3" :key="i"/>')).toMatchObject(+ {+ isBlock: false,+ patchFlag: undefined,+ },+ )+ })+ })+ test('template v-for key w/ :key shorthand on div', () => { const { node: { codegenNode },packages/compiler-core/src/transforms/vFor.tsindex dcc31a9a9..49221c358 100644@@ -47,7 +47,7 @@ import { } from '../runtimeHelpers' import { processExpression } from './transformExpression' import { validateBrowserExpression } from '../validateExpression'-import { PatchFlags } from '@vue/shared'+import { PatchFlags, isOn, isReservedProp } from '@vue/shared' export const transformFor: NodeTransform = createStructuralDirectiveTransform( 'for',@@ -201,6 +201,19 @@ export const transformFor: NodeTransform = createStructuralDirectiveTransform( } } childBlock.isBlock = !isStableFragment+ if (+ !childBlock.isBlock &&+ needsPatchAsVNode(children[0] as PlainElementNode, childBlock)+ ) {+ // the element may have been forced into a block (e.g. by a dynamic+ // key or a custom directive with children), in which case+ // transformElement skipped the NEED_PATCH flag. Now that it's+ // demoted to a plain vnode it must still be tracked by the parent+ // block so that its ref / vnode hooks / directive hooks+ // (e.g. unmounted) are invoked.+ childBlock.patchFlag =+ (childBlock.patchFlag || 0) | PatchFlags.NEED_PATCH+ } if (childBlock.isBlock) { helper(OPEN_BLOCK) helper(getVNodeBlockHelper(context.inSSR, childBlock.isComponent))@@ -249,6 +262,35 @@ export const transformFor: NodeTransform = createStructuralDirectiveTransform( }, ) +// mirrors the NEED_PATCH condition in transformElement's buildProps, which is+// skipped for nodes that are forced into blocks.+function needsPatchAsVNode(node: PlainElementNode, vnodeCall: VNodeCall) {+ const { patchFlag } = vnodeCall+ if (patchFlag && patchFlag !== PatchFlags.NEED_HYDRATION) {+ return false+ }+ if (vnodeCall.directives && vnodeCall.directives.elements.length) {+ return true+ }+ return node.props.some(p => {+ if (p.type === NodeTypes.ATTRIBUTE) {+ return p.name === 'ref'+ }+ const arg =+ p.arg && p.arg.type === NodeTypes.SIMPLE_EXPRESSION && p.arg.isStatic+ ? p.arg.content+ : null+ if (!arg) return false+ if (p.name === 'bind') {+ return arg === 'ref' || (isOn(arg) && isReservedProp(arg))+ }+ if (p.name === 'on') {+ return arg.startsWith('vue:') || arg.startsWith('vnode')+ }+ return false+ })+}+ // target-agnostic transform used for both Client and SSR export function processFor( node: ElementNode,packages/vue/__tests__/index.spec.tsindex 79e48b775..7e44d3426 100644@@ -347,4 +347,68 @@ describe('compiler + runtime integration', () => { app.mount(root) expect(root.innerHTML).toBe('<div>60000000100000111</div>') })++ // #12569+ test('custom directive hooks on v-for element with constant source', async () => {+ const log: string[] = []+ const visible = ref(true)+ const count = ref(0)+ const container = document.createElement('div')+ createApp({+ template: `+ <template v-if="visible">+ <h1 v-for="i in 2" :key="i" v-log="count">{{ i }}</h1>+ <p v-for="i in 2" v-log="count"><span>{{ i }}</span></p>+ </template>`,+ setup: () => ({ visible, count }),+ // makes the constant v-for source compile into a stable fragment+ compilerOptions: { prefixIdentifiers: true },+ directives: {+ log: {+ mounted: (el: Element) => log.push(`mounted ${el.tagName}`),+ updated: (el: Element) => log.push(`updated ${el.tagName}`),+ unmounted: (el: Element) => log.push(`unmounted ${el.tagName}`),+ },+ },+ }).mount(container)+ expect(log).toEqual(['mounted H1', 'mounted H1', 'mounted P', 'mounted P'])++ log.length = 0+ count.value+++ await nextTick()+ expect(log).toEqual(['updated H1', 'updated H1', 'updated P', 'updated P'])++ log.length = 0+ visible.value = false+ await nextTick()+ expect(container.innerHTML).toBe('<!--v-if-->')+ expect(log).toEqual([+ 'unmounted H1',+ 'unmounted H1',+ 'unmounted P',+ 'unmounted P',+ ])+ })++ test('template ref on v-for element with constant source is unset on unmount', async () => {+ const visible = ref(true)+ const container = document.createElement('div')+ let instance: any+ createApp({+ template: `+ <template v-if="visible">+ <p v-for="i in 2" :key="i" ref="items">item</p>+ </template>`,+ setup: () => ({ visible }),+ compilerOptions: { prefixIdentifiers: true },+ mounted() {+ instance = this+ },+ }).mount(container)+ expect(instance.$refs.items.length).toBe(2)++ visible.value = false+ await nextTick()+ expect(instance.$refs.items).toEqual([])+ }) })
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()+ })+ }) })