Skip to content

fix(reactivity): fix WATCH_ARRAY v2 compat deep watching elements (fix #11872) #12236

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix(reactivity): fix WATCH_ARRAY v2 compat deep watching elements (fix #11872) #12236

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b4f6786
fix(reactivity): fix WATCH_ARRAY v2 compat deep watching elements
thecodewarrior Oct 22, 2024
9714124
fix(reactivity): fix WATCH_ARRAY compat not triggering on mutation
thecodewarrior Oct 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions packages/reactivity/src/watch.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,15 @@ export function watch(
: oldValue,
boundCleanup,
]

if (__COMPAT__) {
for (let i = 0; i < args.length - 1; i++) {
if (args[i] && args[i].WATCH_ARRAY_UNWRAP) {
args[i] = args[i].WATCH_ARRAY_UNWRAP
}
}
}

call
? call(cb!, WatchErrorCodes.WATCH_CALLBACK, args)
: // @ts-expect-error
Expand Down
11 changes: 2 additions & 9 deletions packages/runtime-core/src/componentOptions.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -860,22 +860,15 @@ export function createWatcher(
? currentInstance
: null

const newValue = getter()
if (
isArray(newValue) &&
isCompatEnabled(DeprecationTypes.WATCH_ARRAY, instance)
) {
options.deep = true
}

const baseGetter = getter
getter = () => {
const val = baseGetter()
if (
isArray(val) &&
checkCompatEnabled(DeprecationTypes.WATCH_ARRAY, instance)
) {
traverse(val)
traverse(val, 1)
return { WATCH_ARRAY_UNWRAP: val }
}
return val
}
Expand Down
28 changes: 28 additions & 0 deletions packages/vue-compat/__tests__/misc.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,34 @@ test('WATCH_ARRAY', async () => {
expect(spy).toHaveBeenCalledTimes(1)
})

test('WATCH_ARRAY with non-array initial value', async () => {
const spy = vi.fn()
const vm = new Vue({
data() {
return {
foo: null,
}
},
watch: {
foo: spy,
},
}) as any
expect(
deprecationData[DeprecationTypes.WATCH_ARRAY].message,
).not.toHaveBeenWarned()

expect(spy).not.toHaveBeenCalled()
vm.foo = []
await nextTick()
expect(
deprecationData[DeprecationTypes.WATCH_ARRAY].message,
).toHaveBeenWarned()
expect(spy).toHaveBeenCalledTimes(1)
vm.foo.push(1)
await nextTick()
expect(spy).toHaveBeenCalledTimes(2)
})

test('PROPS_DEFAULT_THIS', () => {
let thisCtx: any
const Child = {
Expand Down