Skip to content

Commit 7d622e3

Browse files
sheremet-vasheremet-va
authored
feat: support meta in test options (#9535)
1 parent 687b633 commit 7d622e3

8 files changed

Lines changed: 938 additions & 16 deletions

File tree

‎docs/api/advanced/test-case.md‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,13 @@ test('the validation works correctly', ({ task }) => {
143143
})
144144
```
145145

146-
If the test did not finish running yet, the meta will be an empty object.
146+
If the test did not finish running yet, the meta will be an empty object, unless it has static meta:
147+
148+
```ts
149+
test('the validation works correctly', { meta: { decorated: true } })
150+
```
151+
152+
Since Vitest 4.1, Vitest inherits [`meta`](/api/advanced/test-suite#meta) property defined on the [suite](/api/advanced/test-suite).
147153

148154
## result
149155

‎docs/api/advanced/test-suite.md‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -198,24 +198,25 @@ Note that errors are serialized into simple objects: `instanceof Error` will alw
198198
function meta(): TaskMeta
199199
```
200200

201-
Custom [metadata](/api/advanced/metadata) that was attached to the suite during its execution or collection. The meta can be attached by assigning a property to the `suite.meta` object during a test run:
201+
Custom [metadata](/api/advanced/metadata) that was attached to the suite during its execution or collection. Since Vitest 4.1, the meta can be attached by providing a `meta` object during test collection:
202202

203-
```ts {7,12}
203+
```ts {7,10}
204204
import { describe, test, TestRunner } from 'vitest'
205205
206-
describe('the validation works correctly', () => {
207-
// assign "decorated" during collection
208-
const { suite } = TestRunner.getCurrentSuite()
209-
suite!.meta.decorated = true
210-
206+
describe('the validation works correctly', { meta: { decorated: true } }, () => {
211207
test('some test', ({ task }) => {
212208
// assign "decorated" during test run, it will be available
213209
// only in onTestCaseReady hook
214210
task.suite.meta.decorated = false
211+
212+
// tests inherit suite's metadata
213+
task.meta.decorated === true
215214
})
216215
})
217216
```
218217

218+
Note that suite metadata will be inherited by tests since Vitest 4.1.
219+
219220
:::tip
220221
If metadata was attached during collection (outside of the `test` function), then it will be available in [`onTestModuleCollected`](./reporters#ontestmodulecollected) hook in the custom reporter.
221222
:::

‎docs/api/test.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -170,6 +170,45 @@ it('user returns data from db', { tags: ['db', 'flaky'] }, () => {
170170
})
171171
```
172172

173+
### meta <Version>4.1.0</Version> {#meta}
174+
175+
- **Type:** `TaskMeta`
176+
177+
Attaches custom [metadata](/api/advanced/metadata) available in reporters.
178+
179+
::: warning
180+
Vitest merges top-level properties inherited from suites or tags. However, it does not perform a deep merge of nested objects.
181+
182+
```ts
183+
import { describe, test } from 'vitest'
184+
185+
describe(
186+
'nested meta',
187+
{
188+
meta: {
189+
nested: { object: true, array: false },
190+
},
191+
},
192+
() => {
193+
test(
194+
'overrides part of meta',
195+
{
196+
meta: {
197+
nested: { object: false }
198+
},
199+
},
200+
({ task }) => {
201+
// task.meta === { nested: { object: false } }
202+
// notice array got lost because "nested" object was overriden
203+
}
204+
)
205+
}
206+
)
207+
```
208+
209+
Prefer using non-nested meta, if possible.
210+
:::
211+
173212
### concurrent
174213

175214
- **Type:** `boolean`

‎packages/runner/src/suite.ts‎

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -331,16 +331,32 @@ function createSuiteCollector(
331331
// higher priority should be last, run 1, 2, 3, ... etc
332332
.sort((tag1, tag2) => (tag2.priority ?? POSITIVE_INFINITY) - (tag1.priority ?? POSITIVE_INFINITY))
333333
.reduce((acc, tag) => {
334-
const { name, description, priority, ...options } = tag
334+
const { name, description, priority, meta, ...options } = tag
335335
Object.assign(acc, options)
336+
if (meta) {
337+
acc.meta = Object.assign(acc.meta ?? Object.create(null), meta)
338+
}
336339
return acc
337340
}, {} as TestOptions)
338341

342+
const testOwnMeta = options.meta
339343
options = {
340344
...tagsOptions,
341345
...options,
342346
}
343347
const timeout = options.timeout ?? runner.config.testTimeout
348+
const parentMeta = currentSuite?.meta
349+
const tagMeta = tagsOptions.meta
350+
const testMeta = Object.create(null)
351+
if (tagMeta) {
352+
Object.assign(testMeta, tagMeta)
353+
}
354+
if (parentMeta) {
355+
Object.assign(testMeta, parentMeta)
356+
}
357+
if (testOwnMeta) {
358+
Object.assign(testMeta, testOwnMeta)
359+
}
344360
const task: Test = {
345361
id: '',
346362
name,
@@ -365,7 +381,7 @@ function createSuiteCollector(
365381
: options.todo
366382
? 'todo'
367383
: 'run',
368-
meta: options.meta ?? Object.create(null),
384+
meta: testMeta,
369385
annotations: [],
370386
artifacts: [],
371387
tags: testTags,
@@ -513,7 +529,7 @@ function createSuiteCollector(
513529
file: (currentSuite?.file ?? collectorContext.currentSuite?.file)!,
514530
shuffle: suiteOptions?.shuffle,
515531
tasks: [],
516-
meta: Object.create(null),
532+
meta: suiteOptions?.meta ?? Object.create(null),
517533
concurrent: suiteOptions?.concurrent,
518534
tags: unique([...parentTask?.tags || [], ...suiteTags]),
519535
}
@@ -604,9 +620,10 @@ function createSuite() {
604620
const isConcurrentSpecified = options.concurrent || this.concurrent || options.sequential === false
605621
const isSequentialSpecified = options.sequential || this.sequential || options.concurrent === false
606622

623+
const { meta: parentMeta, ...parentOptions } = currentSuite?.options || {}
607624
// inherit options from current suite
608625
options = {
609-
...currentSuite?.options,
626+
...parentOptions,
610627
...options,
611628
}
612629

@@ -638,6 +655,10 @@ function createSuite() {
638655
options.sequential = isSequential && !isConcurrent
639656
}
640657

658+
if (parentMeta) {
659+
options.meta = Object.assign(Object.create(null), parentMeta, options.meta)
660+
}
661+
641662
return createSuiteCollector(
642663
formatName(name),
643664
factory,

‎packages/runner/src/types/tasks.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -570,6 +570,10 @@ export interface TestOptions {
570570
tags?: keyof TestTags extends never
571571
? string[] | string
572572
: TestTags[keyof TestTags] | TestTags[keyof TestTags][]
573+
/**
574+
* Custom test metadata available to reporters.
575+
*/
576+
meta?: Partial<TaskMeta>
573577
}
574578

575579
export interface TestTags {}
@@ -735,10 +739,6 @@ export interface TaskCustomOptions extends TestOptions {
735739
* Whether the task was produced with `.each()` method.
736740
*/
737741
each?: boolean
738-
/**
739-
* Custom metadata for the task that will be assigned to `task.meta`.
740-
*/
741-
meta?: Record<string, unknown>
742742
/**
743743
* Task fixtures.
744744
*/

0 commit comments

Comments
 (0)