Backtestsvuerun-20261005-155915#10505
Clearing select's value in change handler behaviour changed since 3.4.15 via webdriver
Our patch was judged better than the merged fix.
In this judgment, Patch B = our agent, Patch A = the merged fix.
Both patches fix the bug at its root cause. The 3.4.15 `_assigning` flag made `updated` skip `setSelected` for the entire tick after a change event. Any model change made in the same tick, such as resetting to null in an `@change` handler, therefore never reached the DOM. Each patch records the value just assigned and calls `setSelected` in `updated` whenever the current model differs from that value. Each snapshots the array, so in-place mutation is detected, and each treats a toggle of `multiple` as a mismatch. Both resolve the issue's scenario of a single select cleared to null. Patch A replaces `_assigning` with a `[multiple, value]` tuple and compares with `looseEqual`. It also adds hardening that does not affect the reported bug: try/finally around the assigner, an identity check in the nextTick clear, and clearing the pending value inside `updated`. This works, but the extra machinery makes the fix harder to see. Its tests are numerous but drift from the issue. Several check counts of `selected`-setter writes via property-descriptor hooks, check that an error is thrown from the assigner, or check duplicate option values. Only one test directly covers the reported scenario. Patch B keeps the existing `_assigning` structure and adds a single `_assignedValue` snapshot. It compares with strict equality after `toRaw`, which handles reactive proxies of option values. This is minimal and easy to follow. Its tests target the issue directly and would fail before the change: - single select reset in `@change`, run twice - model changed back in the same tick as the change event - multiple-array reset - multiple-array spliced in the handler - Set model replaced in the handler Correctness is roughly equal. B wins on test relevance, scope and clarity.
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
9m 28s
Wall-clock time in the container
Full test suite
No new failures
3,684 passed · 6 skipped · 3,690 total
Contamination audit
Clean
No sign the agent saw the real fix
Patch size
245vs 345 merged
Changed lines, ours vs merged
The issue
View on GitHubVue version
3.4.21
Link to minimal reproduction
Steps to reproduce
👋 sorry I can only reproduce this myself when acting on chrome with webdriver, but I have narrowed it down a lot
the basic premise is we have a strange select that clears its value on change, exampled in the repo link
The bug occurs when _webdriver_ clicks the select and clicks one of the options within the value does not get cleared afterwards. If I click in the page myself it clears properly.
What is expected?
The value of the select afterwards should be null
What is actually happening?
it is whatever was selected last, ie 0 or 1
System Info
System:
OS: Linux 5.15 Ubuntu 20.04.6 LTS (Focal Fossa)
CPU: (32) x64 AMD Ryzen 9 5950X 16-Core Processor
Memory: 55.80 GB / 88.39 GB
Container: Yes
Shell: 5.0.17 - /bin/bash
Binaries:
Node: 18.16.1 - ~/.nvm/versions/node/v18.16.1/bin/node
npm: 9.5.1 - ~/.nvm/versions/node/v18.16.1/bin/npm
Browsers:
Chrome: 122.0.6261.94
Any additional comments?
I have bisected the releases and found that this first happens from 3.4.15. I suspect the change is related to the select performance improvement https://github.com/vuejs/core/commit/2ffb956efe692da059f4895669084c5278871351
further i notice the commit introduces and _assigning field which changes the behaviour until the next tick. and wrapping the clearing call in nextTick works as a workaround in my instance.
nextTick(() => { selection.value = null })
I suspect the issue relates to the fact that webdriver submits selection events in a slightly unusual manner. However I think that shouldn't mean this broke but it has
The two patches
packages/runtime-dom/__tests__/directives/vModel.spec.tsindex 590c0d7df..8825db219 100644@@ -1071,6 +1071,211 @@ describe('vModel', () => { expect(bar.selected).toEqual(true) }) + // #10412+ it('select should sync DOM when model is reset in change handler', async () => {+ const component = defineComponent({+ data() {+ return { value: null as any }+ },+ render() {+ return [+ withVModel(+ h(+ 'select',+ {+ 'onUpdate:modelValue': setValue.bind(this),+ onChange: () => {+ this.value = null+ },+ },+ [h('option', { value: 0 }), h('option', { value: 1 })],+ ),+ this.value,+ ),+ ]+ },+ })+ render(h(component), root)++ const input = root.querySelector('select')+ const options = root.querySelectorAll('option')+ const data = root._vnode.component.data+ expect(input.selectedIndex).toBe(-1)++ options[1].selected = true+ triggerEvent('change', input)+ await nextTick()+ expect(data.value).toBe(null)+ expect(input.selectedIndex).toBe(-1)+ expect(options[1].selected).toBe(false)++ options[0].selected = true+ triggerEvent('change', input)+ await nextTick()+ expect(data.value).toBe(null)+ expect(input.selectedIndex).toBe(-1)+ expect(options[0].selected).toBe(false)+ })++ it('select should sync DOM when model is changed in the same tick as change event', async () => {+ const component = defineComponent({+ data() {+ return { value: 'foo' }+ },+ render() {+ return [+ withVModel(+ h(+ 'select',+ {+ 'onUpdate:modelValue': setValue.bind(this),+ },+ [h('option', { value: 'foo' }), h('option', { value: 'bar' })],+ ),+ this.value,+ ),+ ]+ },+ })+ render(h(component), root)++ const input = root.querySelector('select')+ const [foo, bar] = root.querySelectorAll('option')+ const data = root._vnode.component.data++ bar.selected = true+ triggerEvent('change', input)+ await nextTick()+ expect(data.value).toBe('bar')+ expect(foo.selected).toBe(false)+ expect(bar.selected).toBe(true)++ // model reset in the same tick as the change event+ foo.selected = true+ triggerEvent('change', input)+ data.value = 'bar'+ await nextTick()+ expect(data.value).toBe('bar')+ expect(foo.selected).toBe(false)+ expect(bar.selected).toBe(true)+ })++ it('multiple select should sync DOM when model is reset in change handler', async () => {+ const component = defineComponent({+ data() {+ return { value: [] as string[] }+ },+ render() {+ return [+ withVModel(+ h(+ 'select',+ {+ multiple: true,+ 'onUpdate:modelValue': setValue.bind(this),+ onChange: () => {+ this.value = []+ },+ },+ [h('option', { value: 'foo' }), h('option', { value: 'bar' })],+ ),+ this.value,+ ),+ ]+ },+ })+ render(h(component), root)++ const input = root.querySelector('select')+ const [foo, bar] = root.querySelectorAll('option')+ const data = root._vnode.component.data++ foo.selected = true+ bar.selected = true+ triggerEvent('change', input)+ await nextTick()+ expect(data.value).toMatchObject([])+ expect(foo.selected).toBe(false)+ expect(bar.selected).toBe(false)+ })++ it('multiple select should sync DOM when model is mutated in change handler', async () => {+ const component = defineComponent({+ data() {+ return { value: [] as string[] }+ },+ render() {+ return [+ withVModel(+ h(+ 'select',+ {+ multiple: true,+ 'onUpdate:modelValue': setValue.bind(this),+ onChange: () => {+ this.value.splice(0, 1)+ },+ },+ [h('option', { value: 'foo' }), h('option', { value: 'bar' })],+ ),+ this.value,+ ),+ ]+ },+ })+ render(h(component), root)++ const input = root.querySelector('select')+ const [foo, bar] = root.querySelectorAll('option')+ const data = root._vnode.component.data++ foo.selected = true+ bar.selected = true+ triggerEvent('change', input)+ await nextTick()+ expect(data.value).toMatchObject(['bar'])+ expect(foo.selected).toBe(false)+ expect(bar.selected).toBe(true)+ })++ it('multiple select (model is Set) should sync DOM when model is reset in change handler', async () => {+ const component = defineComponent({+ data() {+ return { value: new Set<string>() }+ },+ render() {+ return [+ withVModel(+ h(+ 'select',+ {+ multiple: true,+ 'onUpdate:modelValue': setValue.bind(this),+ onChange: () => {+ this.value = new Set(['bar'])+ },+ },+ [h('option', { value: 'foo' }), h('option', { value: 'bar' })],+ ),+ this.value,+ ),+ ]+ },+ })+ render(h(component), root)++ const input = root.querySelector('select')+ const [foo, bar] = root.querySelectorAll('option')+ const data = root._vnode.component.data++ foo.selected = true+ triggerEvent('change', input)+ await nextTick()+ expect(data.value).toEqual(new Set(['bar']))+ expect(foo.selected).toBe(false)+ expect(bar.selected).toBe(true)+ })+ it('v-model.number should work with select tag', async () => { const component = defineComponent({ data() {packages/runtime-dom/src/directives/vModel.tsindex eeb248f28..c41f7d890 100644@@ -4,6 +4,7 @@ import { type ObjectDirective, type VNode, nextTick,+ toRaw, warn, } from '@vue/runtime-core' import { addEventListener } from '../modules/events'@@ -45,6 +46,7 @@ type ModelDirective<T, Modifiers extends string = string> = ObjectDirective< [assignKey]: AssignerFn [initialValueKey]?: string _assigning?: boolean+ _assignedValue?: any }, any, Modifiers@@ -248,8 +250,13 @@ export const vModelSelect: ModelDirective<HTMLSelectElement, 'number'> = { : selectedVal[0], ) el._assigning = true+ // snapshot of what was assigned, so that `updated` can tell whether the+ // model has since been changed to something else in the same tick+ // (e.g. reset in a @change handler)+ el._assignedValue = el.multiple ? selectedVal.slice() : selectedVal[0] nextTick(() => { el._assigning = false+ el._assignedValue = undefined }) }) el[assignKey] = getModelAssigner(vnode)@@ -264,12 +271,43 @@ export const vModelSelect: ModelDirective<HTMLSelectElement, 'number'> = { el[assignKey] = getModelAssigner(vnode) }, updated(el, { value }) {- if (!el._assigning) {+ // the DOM already reflects the value assigned from the change event, so+ // syncing can be skipped unless the model was changed to something else+ if (!el._assigning || !isAssignedSelectValue(el, value)) { setSelected(el, value) } }, } +function isAssignedSelectValue(+ el: HTMLSelectElement & { _assignedValue?: any },+ value: any,+): boolean {+ // option values may be reactive proxies, so compare raw on both sides+ const assigned = el._assignedValue+ const raw = toRaw(value)+ if (!el.multiple) {+ return raw === toRaw(assigned)+ }+ // `multiple` may have been toggled since the change event+ if (!isArray(assigned)) {+ return false+ }+ if (isArray(raw)) {+ return (+ raw.length === assigned.length &&+ raw.every((v, i) => toRaw(v) === toRaw(assigned[i]))+ )+ }+ if (isSet(raw)) {+ return (+ raw.size === assigned.length &&+ assigned.every((v: any) => raw.has(v) || raw.has(toRaw(v)))+ )+ }+ return false+}+ function setSelected(el: HTMLSelectElement, value: any) { const isMultiple = el.multiple const isArrayValue = isArray(value)
packages/runtime-dom/__tests__/directives/vModel.spec.tsindex 590c0d7df..429163126 100644@@ -1317,6 +1317,290 @@ describe('vModel', () => { expect(bar.selected).toEqual(true) }) + function mountSelectModel(+ initialValue: any,+ update: (value: any) => any,+ multiple = false,+ optionValues: any[] = ['foo', 'bar'],+ ) {+ const component = defineComponent({+ data: () => ({ value: initialValue }),+ render() {+ return withVModel(+ h(+ 'select',+ {+ multiple,+ 'onUpdate:modelValue': (value: any) => {+ this.value = update(value)+ },+ },+ optionValues.map(value => h('option', { value })),+ ),+ this.value,+ )+ },+ })+ render(h(component), root)+ const input = root.querySelector('select') as HTMLSelectElement+ return { input, options: input.options, data: root._vnode.component.data }+ }++ function trackSelectedWrites(input: HTMLSelectElement) {+ const selected = Object.getOwnPropertyDescriptor(+ HTMLOptionElement.prototype,+ 'selected',+ )!+ let writes = 0+ for (const option of input.options) {+ Object.defineProperty(option, 'selected', {+ configurable: true,+ get: selected.get,+ set(value) {+ writes+++ selected.set!.call(this, value)+ },+ })+ }+ return () => writes+ }++ it('should sync a multiple select when the Set model is overridden', async () => {+ const { input, options, data } = mountSelectModel(+ new Set<string>(),+ () => new Set(['foo']),+ true,+ )+ const foo = options[0]+ const bar = options[1]++ bar.selected = true+ triggerEvent('change', input)+ await nextTick()++ expect(Array.from(data.value)).toEqual(['foo'])+ expect(foo.selected).toBe(true)+ expect(bar.selected).toBe(false)+ })++ it('should clear a single select when a native change handler clears the model', async () => {+ const component = defineComponent({+ data() {+ return { value: null as string | null }+ },+ render() {+ return withVModel(+ h(+ 'select',+ {+ 'onUpdate:modelValue': setValue.bind(this),+ onChange: () => {+ this.value = null+ },+ },+ [h('option', { value: 'foo' }), h('option', { value: 'bar' })],+ ),+ this.value,+ )+ },+ })+ render(h(component), root)+ const input = root.querySelector('select') as HTMLSelectElement+ const data = root._vnode.component.data++ input.options[1].selected = true+ triggerEvent('change', input)+ await nextTick()++ expect(data.value).toBe(null)+ expect(input.selectedIndex).toBe(-1)+ })++ it('should preserve the selected option when duplicate values exist', async () => {+ const { input, options, data } = mountSelectModel(+ null,+ value => value,+ false,+ ['foo', 'foo'],+ )++ options[1].selected = true+ triggerEvent('change', input)+ await nextTick()++ expect(data.value).toBe('foo')+ expect(input.selectedIndex).toBe(1)+ })++ it('should resync when a multiple select becomes single during the pending update', async () => {+ const component = defineComponent({+ data() {+ return { value: [] as string[], multiple: true }+ },+ render() {+ return withVModel(+ h(+ 'select',+ {+ multiple: this.multiple,+ 'onUpdate:modelValue': (value: string[]) => {+ this.value = value+ this.multiple = false+ },+ },+ [h('option', { value: 'foo' }), h('option', { value: 'bar' })],+ ),+ this.value,+ )+ },+ })+ render(h(component), root)+ const input = root.querySelector('select') as HTMLSelectElement+ const data = root._vnode.component.data++ input.options[1].selected = true+ triggerEvent('change', input)+ await nextTick()++ expect(data.value).toEqual(['bar'])+ expect(input.multiple).toBe(false)+ expect(input.selectedIndex).toBe(-1)+ })++ it('should snapshot an emitted Array before the change handler mutates it', async () => {+ const { input, options, data } = mountSelectModel(+ ['foo'],+ (value: string[]) => {+ value.pop()+ return value+ },+ true,+ )+ const foo = options[0]+ const bar = options[1]++ foo.selected = true+ bar.selected = true+ triggerEvent('change', input)+ await nextTick()++ expect(data.value).toEqual(['foo'])+ expect(foo.selected).toBe(true)+ expect(bar.selected).toBe(false)+ })++ it('should resync after the emitted Set is mutated in the change handler', async () => {+ const { input, options, data } = mountSelectModel(+ new Set(['foo']),+ (value: Set<string>) => {+ value.delete('bar')+ return value+ },+ true,+ )+ const foo = options[0]+ const bar = options[1]++ foo.selected = true+ bar.selected = true+ triggerEvent('change', input)+ await nextTick()++ expect(Array.from(data.value)).toEqual(['foo'])+ expect(foo.selected).toBe(true)+ expect(bar.selected).toBe(false)+ })++ it('should not rewrite options after assigning a Set of objects', async () => {+ const fooValue = { id: 'foo' }+ const barValue = { id: 'bar' }+ const { input, options } = mountSelectModel(+ new Set([fooValue]),+ value => value,+ true,+ [fooValue, barValue],+ )++ options[0].selected = false+ options[1].selected = true+ const getWrites = trackSelectedWrites(input)+ triggerEvent('change', input)+ await nextTick()++ expect(getWrites()).toBe(0)+ })++ it('should not rewrite options after assigning an Array of objects', async () => {+ const fooValue = { id: 'foo' }+ const barValue = { id: 'bar' }+ const { input, options } = mountSelectModel([], value => value, true, [+ fooValue,+ barValue,+ ])++ options[1].selected = true+ const getWrites = trackSelectedWrites(input)+ triggerEvent('change', input)+ await nextTick()++ expect(getWrites()).toBe(0)+ })++ it('should not rewrite options for a primitive Array model', async () => {+ const optionValues = Array.from({ length: 10 }, (_, i) => i)+ const { input, options, data } = mountSelectModel(+ [],+ value => value,+ true,+ optionValues,+ )++ for (let i = 0; i < 5; i++) options[i].selected = true+ const getWrites = trackSelectedWrites(input)+ triggerEvent('change', input)+ await nextTick()++ expect(data.value).toHaveLength(5)+ expect(getWrites()).toBe(0)+ })++ it('should clear the pending assignment when the assigner throws', async () => {+ const error = new Error('assign failed')+ const component = defineComponent({+ data: () => ({ value: [] }),+ render() {+ return withVModel(+ h(+ 'select',+ {+ multiple: true,+ 'onUpdate:modelValue': () => {+ throw error+ },+ },+ [h('option', { value: 'foo' }), h('option', { value: 'bar' })],+ ),+ this.value,+ )+ },+ })+ render(h(component), root)+ const input = root.querySelector('select') as HTMLSelectElement+ const onError = vi.fn((event: ErrorEvent) => event.preventDefault())+ window.addEventListener('error', onError)++ try {+ input.options[1].selected = true+ triggerEvent('change', input)+ await nextTick()++ expect(onError).toHaveBeenCalled()+ expect((input as any)._pendingValue).toBeUndefined()+ } finally {+ window.removeEventListener('error', onError)+ }+ })+ it('multiple select uses current Array/Set model type', async () => { const component = defineComponent({ data() {packages/runtime-dom/src/directives/vModel.tsindex eeb248f28..041f17c5a 100644@@ -44,7 +44,7 @@ type ModelDirective<T, Modifiers extends string = string> = ObjectDirective< T & { [assignKey]: AssignerFn [initialValueKey]?: string- _assigning?: boolean+ _pendingValue?: [multiple: boolean, value: any] }, any, Modifiers@@ -240,17 +240,31 @@ export const vModelSelect: ModelDirective<HTMLSelectElement, 'number'> = { .map((o: HTMLOptionElement) => number ? looseToNumber(getValue(o)) : getValue(o), )- el[assignKey](- el.multiple- ? isSet((el as any)._modelValue)- ? new Set(selectedVal)+ const multiple = el.multiple+ const assignedValue = multiple+ ? isSet((el as any)._modelValue)+ ? new Set(selectedVal)+ : selectedVal+ : selectedVal[0]+ // Array models receive selectedVal directly, so snapshot it before user+ // code can mutate it. Set models already receive a fresh Set.+ const pending = (el._pendingValue = [+ multiple,+ multiple+ ? isArray(assignedValue)+ ? selectedVal.slice() : selectedVal- : selectedVal[0],- )- el._assigning = true- nextTick(() => {- el._assigning = false- })+ : assignedValue,+ ])+ try {+ el[assignKey](assignedValue)+ } finally {+ nextTick(() => {+ if (el._pendingValue === pending) {+ el._pendingValue = undefined+ }+ })+ } }) el[assignKey] = getModelAssigner(vnode) },@@ -264,12 +278,35 @@ export const vModelSelect: ModelDirective<HTMLSelectElement, 'number'> = { el[assignKey] = getModelAssigner(vnode) }, updated(el, { value }) {- if (!el._assigning) {+ const pending = el._pendingValue+ el._pendingValue = undefined+ if (+ !pending ||+ pending[0] !== el.multiple ||+ !isSameSelectValue(value, pending[1], pending[0])+ ) { setSelected(el, value) } }, } +function isSameSelectValue(+ value: any,+ assignedValue: any,+ multiple: boolean,+): boolean {+ if (!multiple) return looseEqual(value, assignedValue)+ if (isArray(value)) return looseEqual(value, assignedValue)+ if (isSet(value)) {+ if (value.size !== assignedValue.length) return false+ for (const item of assignedValue) {+ if (!value.has(item)) return false+ }+ return true+ }+ return false+}+ function setSelected(el: HTMLSelectElement, value: any) { const isMultiple = el.multiple const isArrayValue = isArray(value)