Skip to content
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.

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

feat(benchmark): only mode #2039

Merged
merged 11 commits into from Sep 18, 2022
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 7 additions & 3 deletions packages/vitest/src/runtime/run.ts
Expand Up @@ -238,8 +238,9 @@ export async function runSuite(suite: Suite) {
else {
try {
const beforeAllCleanups = await callSuiteHook(suite, suite, 'beforeAll', [suite])

if (isRunningInBenchmark()) {
await runBenchmarkSuit(suite)
await runBenchmarkSuite(suite)
}
else {
for (let tasksGroup of partitionSuiteChildren(suite)) {
Expand Down Expand Up @@ -301,21 +302,24 @@ function createBenchmarkResult(name: string): BenchmarkResult {
} as BenchmarkResult
}

async function runBenchmarkSuit(suite: Suite) {
async function runBenchmarkSuite(suite: Suite) {
const { Task, Bench } = await importTinybench()
const start = performance.now()

const benchmarkGroup = []
const benchmarkSuiteGroup = []
for (const task of suite.tasks) {
if (task.mode !== 'run')
continue

if (task.type === 'benchmark')
benchmarkGroup.push(task)
else if (task.type === 'suite')
benchmarkSuiteGroup.push(task)
}

if (benchmarkSuiteGroup.length)
await Promise.all(benchmarkSuiteGroup.map(subSuite => runBenchmarkSuit(subSuite)))
await Promise.all(benchmarkSuiteGroup.map(subSuite => runBenchmarkSuite(subSuite)))

if (benchmarkGroup.length) {
const defer = createDefer()
Expand Down
6 changes: 3 additions & 3 deletions packages/vitest/src/runtime/suite.ts
Expand Up @@ -116,7 +116,7 @@ function createSuiteCollector(name: string, factory: SuiteFactory = () => { }, m
})

const benchmark = createBenchmark(function (name: string, fn = noop, options: BenchOptions) {
const mode = this.skip ? 'skip' : 'run'
const mode = this.only ? 'only' : this.skip ? 'skip' : 'run'

if (!isRunningInBenchmark())
throw new Error('`bench()` is only available in benchmark mode. Run with `vitest bench` instead.')
Expand Down Expand Up @@ -251,14 +251,14 @@ function createTest(fn: (

function createBenchmark(fn: (
(
this: Record<'skip', boolean | undefined>,
this: Record<'skip' | 'only', boolean | undefined>,
name: string,
fn: BenchFunction,
options: BenchOptions
) => void
)) {
const benchmark = createChainable(
['skip'],
['skip', 'only'],
fn,
) as BenchmarkAPI

Expand Down
2 changes: 1 addition & 1 deletion packages/vitest/src/types/benchmark.ts
Expand Up @@ -53,7 +53,7 @@ export interface BenchmarkResult extends TinybenchResult {

export type BenchFunction = (this: BenchFactory) => Promise<void> | void
export type BenchmarkAPI = ChainableFunction<
'skip',
'skip' | 'only',
[name: string, fn: BenchFunction, options?: BenchOptions],
void
> & {
Expand Down