fix(scheduler): sort jobs before flushing

This fixes the case where a child component is added to the queue before
its parent, but should be invalidated by its parent's update. Same logic
was present in Vue 2.

Properly fixes #910
ref: https://github.com/vuejs/vue-next/issues/910#issuecomment-613097539
This commit is contained in:
Evan You
2020-04-14 17:31:35 -04:00
parent c80b857eb5
commit 78977c3997
3 changed files with 46 additions and 9 deletions

View File

@@ -1,7 +1,12 @@
import { ErrorCodes, callWithErrorHandling } from './errorHandling'
import { isArray } from '@vue/shared'
const queue: (Function | null)[] = []
export interface Job {
(): void
id?: number
}
const queue: (Job | null)[] = []
const postFlushCbs: Function[] = []
const p = Promise.resolve()
@@ -9,20 +14,20 @@ let isFlushing = false
let isFlushPending = false
const RECURSION_LIMIT = 100
type CountMap = Map<Function, number>
type CountMap = Map<Job | Function, number>
export function nextTick(fn?: () => void): Promise<void> {
return fn ? p.then(fn) : p
}
export function queueJob(job: () => void) {
export function queueJob(job: Job) {
if (!queue.includes(job)) {
queue.push(job)
queueFlush()
}
}
export function invalidateJob(job: () => void) {
export function invalidateJob(job: Job) {
const i = queue.indexOf(job)
if (i > -1) {
queue[i] = null
@@ -45,11 +50,9 @@ function queueFlush() {
}
}
const dedupe = (cbs: Function[]): Function[] => [...new Set(cbs)]
export function flushPostFlushCbs(seen?: CountMap) {
if (postFlushCbs.length) {
const cbs = dedupe(postFlushCbs)
const cbs = [...new Set(postFlushCbs)]
postFlushCbs.length = 0
if (__DEV__) {
seen = seen || new Map()
@@ -63,6 +66,8 @@ export function flushPostFlushCbs(seen?: CountMap) {
}
}
const getId = (job: Job) => (job.id == null ? Infinity : job.id)
function flushJobs(seen?: CountMap) {
isFlushPending = false
isFlushing = true
@@ -70,6 +75,18 @@ function flushJobs(seen?: CountMap) {
if (__DEV__) {
seen = seen || new Map()
}
// Sort queue before flush.
// This ensures that:
// 1. Components are updated from parent to child. (because parent is always
// created before the child so its render effect will have smaller
// priority number)
// 2. If a component is unmounted during a parent component's update,
// its update can be skipped.
// Jobs can never be null before flush starts, since they are only invalidated
// during execution of another flushed job.
queue.sort((a, b) => getId(a!) - getId(b!))
while ((job = queue.shift()) !== undefined) {
if (job === null) {
continue
@@ -88,7 +105,7 @@ function flushJobs(seen?: CountMap) {
}
}
function checkRecursiveUpdates(seen: CountMap, fn: Function) {
function checkRecursiveUpdates(seen: CountMap, fn: Job | Function) {
if (!seen.has(fn)) {
seen.set(fn, 1)
} else {