Skip to content

fix: update test stats regularly #7700

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

Merged
sheremet-va merged 4 commits into from
Mar 23, 2025
Merged

fix: update test stats regularly #7700

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
631421d
fix: update test stats regularly
hi-ogawa Mar 19, 2025
c1a8f23
chore: lint
hi-ogawa Mar 19, 2025
44ff2a0
fix: ensure all updates awaited
hi-ogawa Mar 19, 2025
51664f4
fix: avoid unhandled rejection
hi-ogawa Mar 20, 2025
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
60 changes: 38 additions & 22 deletions packages/runner/src/run.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import type {
Test,
TestContext,
} from './types/tasks'
import { getSafeTimers, shuffle } from '@vitest/utils'
import { shuffle } from '@vitest/utils'
import { processError } from '@vitest/utils/error'
import { collectTests } from './collect'
import { PendingError } from './errors'
Expand Down Expand Up @@ -174,37 +174,53 @@ export async function callSuiteHook<T extends keyof SuiteHooks>(

const packs = new Map<string, [TaskResult | undefined, TaskMeta]>()
const eventsPacks: [string, TaskUpdateEvent][] = []
let updateTimer: any
let previousUpdate: Promise<void> | undefined

export function updateTask(event: TaskUpdateEvent, task: Task, runner: VitestRunner): void {
eventsPacks.push([task.id, event])
packs.set(task.id, [task.result, task.meta])

const { clearTimeout, setTimeout } = getSafeTimers()

clearTimeout(updateTimer)
updateTimer = setTimeout(() => {
previousUpdate = sendTasksUpdate(runner)
}, 10)
}

async function sendTasksUpdate(runner: VitestRunner) {
const { clearTimeout } = getSafeTimers()
clearTimeout(updateTimer)
await previousUpdate
const pendingTasksUpdates: Promise<void>[] = []

function sendTasksUpdate(runner: VitestRunner): void {
if (packs.size) {
const taskPacks = Array.from(packs).map<TaskResultPack>(([id, task]) => {
return [id, task[0], task[1]]
})
const p = runner.onTaskUpdate?.(taskPacks, eventsPacks)
if (p) {
pendingTasksUpdates.push(p)
// remove successful promise to not grow array indefnitely,
// but keep rejections so finishSendTasksUpdate can handle them
p.then(
() => pendingTasksUpdates.splice(pendingTasksUpdates.indexOf(p), 1),
() => {},
)
}
eventsPacks.length = 0
packs.clear()
return p
}
}

async function finishSendTasksUpdate(runner: VitestRunner) {
sendTasksUpdate(runner)
await Promise.all(pendingTasksUpdates)
}

function throttle<T extends (...args: any[]) => void>(fn: T, ms: number): T {
let last = 0
return function (this: any, ...args: any[]) {
const now = unixNow()
if (now - last > ms) {
last = now
return fn.apply(this, args)
}
} as any
}

// throttle based on summary reporter's DURATION_UPDATE_INTERVAL_MS
const sendTasksUpdateThrottled = throttle(sendTasksUpdate, 100)

export function updateTask(event: TaskUpdateEvent, task: Task, runner: VitestRunner): void {
eventsPacks.push([task.id, event])
packs.set(task.id, [task.result, task.meta])
sendTasksUpdateThrottled(runner)
}

async function callCleanupHooks(cleanups: unknown[]) {
await Promise.all(
cleanups.map(async (fn) => {
Expand Down Expand Up @@ -561,7 +577,7 @@ export async function startTests(specs: string[] | FileSpecification[], runner:

await runner.onAfterRunFiles?.(files)

await sendTasksUpdate(runner)
await finishSendTasksUpdate(runner)

return files
}
Expand Down