Visitar URL original
feat!: fail the test when an asynchronous assertion is not awaited (#… · vitest-dev/vitest@86d4a9d · GitHub
Skip to content

Commit 86d4a9d

Browse files
sheremet-vasheremet-va
authored
feat!: fail the test when an asynchronous assertion is not awaited (#10868)
1 parent aba0f9b commit 86d4a9d

7 files changed

Lines changed: 91 additions & 62 deletions

File tree

‎docs/api/expect.md‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1872,9 +1872,7 @@ test('buyApples returns new stock id', async () => {
18721872
```
18731873

18741874
:::warning
1875-
If the assertion is not awaited, then you will have a false-positive test that will pass every time. To make sure that assertions are actually called, you may use [`expect.assertions(number)`](#expect-assertions).
1876-
1877-
Since Vitest 3, if a method is not awaited, Vitest will show a warning at the end of the test. In Vitest 4, the test will be marked as "failed" if the assertion is not awaited.
1875+
If the assertion is not awaited, the test will be marked as "failed" at the end of the test.
18781876
:::
18791877

18801878
## rejects
@@ -1903,9 +1901,7 @@ test('buyApples throws an error when no id provided', async () => {
19031901
```
19041902

19051903
:::warning
1906-
If the assertion is not awaited, then you will have a false-positive test that will pass every time. To make sure that assertions were actually called, you can use [`expect.assertions(number)`](#expect-assertions).
1907-
1908-
Since Vitest 3, if a method is not awaited, Vitest will show a warning at the end of the test. In Vitest 4, the test will be marked as "failed" if the assertion is not awaited.
1904+
If the assertion is not awaited, the test will be marked as "failed" at the end of the test.
19091905
:::
19101906

19111907
## expect.assertions

‎docs/guide/learn/async.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ test('rejects with an error', async () => {
4646
```
4747

4848
::: warning
49-
Don't forget the `await` before `expect`. Vitest will detect unawaited assertions and print a warning at the end of the test, but it's best to always include `await` explicitly. Vitest will also wait for all pending promises in `Promise.all` before starting the next test, but relying on this behavior makes tests harder to understand.
49+
Don't forget the `await` before `expect`. Vitest will detect unawaited assertions and fail the test at the end of it.
5050
:::
5151

5252
## Assertion Counting

‎docs/guide/migration.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -322,6 +322,21 @@ await expect.poll(async ({ signal }) => {
322322

323323
A poll that legitimately needs more time should raise its `timeout`. Otherwise it fails with `expect.poll() function didn't resolve in time.` (or `expect.poll() assertion didn't resolve in time.`).
324324

325+
### Unawaited Asynchronous Assertions Fail the Test
326+
327+
Asynchronous assertions, like `resolves`, `rejects` and `toMatchFileSnapshot`, now fail the test if they are not awaited. Previously, Vitest auto-awaited them at the end of the test and printed a warning:
328+
329+
```ts
330+
test('unawaited assertion', async () => {
331+
// v4: prints a warning, the test passes // [!code --]
332+
// v5: the test fails // [!code ++]
333+
expect(promise).resolves.toBe(1) // [!code --]
334+
await expect(promise).resolves.toBe(1) // [!code ++]
335+
})
336+
```
337+
338+
The reported error points to the assertion that was not awaited.
339+
325340
### Test Titles and Inspected Values Use `pretty-format`
326341

327342
Vitest now formats values with [`pretty-format`](https://www.npmjs.com/package/pretty-format) instead of `loupe` when it inspects them, including the values interpolated into [`test.each`](/api/test#test-each) and [`test.for`](/api/test#test-for) titles. The rendering of some values changes, so snapshots or assertions that capture inspected output may need updating.

‎packages/expect/src/utils.ts‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -54,14 +54,13 @@ export function recordAsyncExpect(
5454
test.onFinished ??= []
5555
test.onFinished.push(() => {
5656
if (!resolved) {
57-
const processor = (globalThis as any).__vitest_worker__?.onFilterStackTrace || ((s: string) => s || '')
58-
const stack = processor(error.stack)
59-
console.warn([
60-
`Promise returned by \`${assertion}\` was not awaited. `,
61-
'Vitest currently auto-awaits hanging assertions at the end of the test, but this will cause the test to fail in the next Vitest major. ',
62-
'Please remember to await the assertion.\n',
63-
stack,
64-
].join(''))
57+
const awaitError = new Error(
58+
`Promise returned by \`${assertion}\` was not awaited. This assertion is asynchronous and must be awaited; otherwise, it is not guaranteed to complete before the test finishes:\n\nawait ${assertion}\n`,
59+
)
60+
if (error.stack) {
61+
awaitError.stack = error.stack.replace(error.message, awaitError.message)
62+
}
63+
throw awaitError
6564
}
6665
})
6766

‎test/e2e/test/__snapshots__/fails.test.ts.snap‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
exports[`should fail .dot-folder/dot-test.test.ts 1`] = `"AssertionError: expected true to be false // Object.is equality"`;
44

55
exports[`should fail async-assertion.test.ts 1`] = `
6-
"AssertionError: expected 'xx' to be 'zz' // Object.is equality
6+
"Error: Promise returned by \`expect(actual).resolves.toBe(expected)\` was not awaited. This assertion is asynchronous and must be awaited; otherwise, it is not guaranteed to complete before the test finishes:
7+
Error: Promise returned by \`expect(actual).resolves.toBe(expected)\` was not awaited. This assertion is asynchronous and must be awaited; otherwise, it is not guaranteed to complete before the test finishes:
8+
AssertionError: expected 'xx' to be 'zz' // Object.is equality
79
AssertionError: expected 'xx' to be 'yy' // Object.is equality"
810
`;
911

@@ -98,7 +100,8 @@ exports[`should fail test-extend/test-rest-props.test.ts 1`] = `"FixtureParseErr
98100
exports[`should fail test-extend/test-without-destructuring.test.ts 1`] = `"FixtureParseError: The 1st argument inside a fixture must use object destructuring pattern, e.g. ({ task } => {}). Instead, received "context"."`;
99101
100102
exports[`should fail test-timeout.test.ts 1`] = `
101-
"Error: Test timed out in 20ms.
103+
"Error: Promise returned by \`expect(actual).resolves.toBe(expected)\` was not awaited. This assertion is asynchronous and must be awaited; otherwise, it is not guaranteed to complete before the test finishes:
104+
Error: Test timed out in 20ms.
102105
Error: Test timed out in 200ms.
103106
Error: Test timed out in 100ms.
104107
Error: Hook timed out in 17ms.

‎test/e2e/test/fails.test.ts‎

Lines changed: 58 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ it('should not report coverage when "coverage.reportOnFailure" has default value
4949
expect(stdout).not.toMatch('Coverage report from istanbul')
5050
})
5151

52-
it('prints a warning if the assertion is not awaited', async () => {
53-
const { stderr, root, errorTree } = await runInlineTests({
52+
it('fails if the assertion is not awaited', async () => {
53+
const { errorTree } = await runInlineTests({
5454
'base.test.js': ts`
5555
import { expect, test } from 'vitest';
5656
@@ -79,42 +79,54 @@ it('prints a warning if the assertion is not awaited', async () => {
7979
}, {
8080
update: true,
8181
})
82-
expect(errorTree()).toMatchInlineSnapshot(`
82+
expect(errorTree({ stackTrace: true })).toMatchInlineSnapshot(`
8383
{
8484
"base.test.js": {
8585
"not awaited and failed": [
86-
"expected 1 to be 2 // Object.is equality",
86+
"expected 1 to be 2 // Object.is equality
87+
at base.test.js:15:17",
88+
"Promise returned by \`expect(actual).resolves.toBe(expected)\` was not awaited. This assertion is asynchronous and must be awaited; otherwise, it is not guaranteed to complete before the test finishes:
89+
90+
await expect(actual).resolves.toBe(expected)
91+
92+
at base.test.js:14:33",
93+
],
94+
"several not awaited": [
95+
"Promise returned by \`expect(actual).rejects.toBe(expected)\` was not awaited. This assertion is asynchronous and must be awaited; otherwise, it is not guaranteed to complete before the test finishes:
96+
97+
await expect(actual).rejects.toBe(expected)
98+
99+
at base.test.js:10:32",
100+
"Promise returned by \`expect(actual).resolves.toBe(expected)\` was not awaited. This assertion is asynchronous and must be awaited; otherwise, it is not guaranteed to complete before the test finishes:
101+
102+
await expect(actual).resolves.toBe(expected)
103+
104+
at base.test.js:9:33",
105+
],
106+
"single not awaited": [
107+
"Promise returned by \`expect(actual).resolves.toBe(expected)\` was not awaited. This assertion is asynchronous and must be awaited; otherwise, it is not guaranteed to complete before the test finishes:
108+
109+
await expect(actual).resolves.toBe(expected)
110+
111+
at base.test.js:5:33",
112+
],
113+
"soft + toMatchFileSnapshot not awaited": [
114+
"Promise returned by \`expect.soft(actual).toMatchFileSnapshot(expected)\` was not awaited. This assertion is asynchronous and must be awaited; otherwise, it is not guaranteed to complete before the test finishes:
115+
116+
await expect.soft(actual).toMatchFileSnapshot(expected)
117+
118+
at base.test.js:23:22",
119+
],
120+
"toMatchFileSnapshot not awaited": [
121+
"Promise returned by \`expect(actual).toMatchFileSnapshot(expected)\` was not awaited. This assertion is asynchronous and must be awaited; otherwise, it is not guaranteed to complete before the test finishes:
122+
123+
await expect(actual).toMatchFileSnapshot(expected)
124+
125+
at base.test.js:19:17",
87126
],
88-
"several not awaited": "passed",
89-
"single not awaited": "passed",
90-
"soft + toMatchFileSnapshot not awaited": "passed",
91-
"toMatchFileSnapshot not awaited": "passed",
92127
},
93128
}
94129
`)
95-
const warnings: string[] = []
96-
const lines = stderr.split('\n')
97-
lines.forEach((line, index) => {
98-
if (line.includes('Promise returned by')) {
99-
warnings.push(lines.slice(index, index + 2).join('\n').replace(`${root}/`, '<rootDir>/'))
100-
}
101-
})
102-
expect(warnings).toMatchInlineSnapshot(`
103-
[
104-
"Promise returned by \`expect(actual).resolves.toBe(expected)\` was not awaited. Vitest currently auto-awaits hanging assertions at the end of the test, but this will cause the test to fail in the next Vitest major. Please remember to await the assertion.
105-
at <rootDir>/base.test.js:5:33",
106-
"Promise returned by \`expect(actual).rejects.toBe(expected)\` was not awaited. Vitest currently auto-awaits hanging assertions at the end of the test, but this will cause the test to fail in the next Vitest major. Please remember to await the assertion.
107-
at <rootDir>/base.test.js:10:32",
108-
"Promise returned by \`expect(actual).resolves.toBe(expected)\` was not awaited. Vitest currently auto-awaits hanging assertions at the end of the test, but this will cause the test to fail in the next Vitest major. Please remember to await the assertion.
109-
at <rootDir>/base.test.js:9:33",
110-
"Promise returned by \`expect(actual).resolves.toBe(expected)\` was not awaited. Vitest currently auto-awaits hanging assertions at the end of the test, but this will cause the test to fail in the next Vitest major. Please remember to await the assertion.
111-
at <rootDir>/base.test.js:14:33",
112-
"Promise returned by \`expect(actual).toMatchFileSnapshot(expected)\` was not awaited. Vitest currently auto-awaits hanging assertions at the end of the test, but this will cause the test to fail in the next Vitest major. Please remember to await the assertion.
113-
at <rootDir>/base.test.js:19:17",
114-
"Promise returned by \`expect.soft(actual).toMatchFileSnapshot(expected)\` was not awaited. Vitest currently auto-awaits hanging assertions at the end of the test, but this will cause the test to fail in the next Vitest major. Please remember to await the assertion.
115-
at <rootDir>/base.test.js:23:22",
116-
]
117-
`)
118130
})
119131

120132
it('no async tracking after then/catch/finally', async () => {
@@ -230,8 +242,8 @@ it('no async tracking after then/catch/finally', async () => {
230242
`)
231243
})
232244

233-
it('prints a warning if the assertion is not awaited in the browser mode', async () => {
234-
const { stderr } = await runInlineTests({
245+
it('fails if the assertion is not awaited in the browser mode', async () => {
246+
const { errorTree } = await runInlineTests({
235247
'base.test.js': ts`
236248
import { expect, test } from 'vitest';
237249
@@ -247,8 +259,19 @@ it('prints a warning if the assertion is not awaited in the browser mode', async
247259
headless: true,
248260
},
249261
})
250-
expect(stderr).toContain('Promise returned by \`expect(actual).resolves.toBe(expected)\` was not awaited')
251-
expect(stderr).toContain('base.test.js:5:33')
262+
expect(errorTree({ stackTrace: true })).toMatchInlineSnapshot(`
263+
{
264+
"base.test.js": {
265+
"single not awaited": [
266+
"Promise returned by \`expect(actual).resolves.toBe(expected)\` was not awaited. This assertion is asynchronous and must be awaited; otherwise, it is not guaranteed to complete before the test finishes:
267+
268+
await expect(actual).resolves.toBe(expected)
269+
270+
at base.test.js:5:33",
271+
],
272+
},
273+
}
274+
`)
252275
})
253276

254277
it('reports test file if it failed to load', async () => {

‎test/unit/test/jest-expect.test.ts‎

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import nodeAssert, { AssertionError } from 'node:assert'
33
import { stripVTControlCharacters } from 'node:util'
44
import { generateToBeMessage } from '@vitest/expect'
55
import { processError } from '@vitest/utils/error'
6-
import { assert, beforeAll, describe, expect, it, vi } from 'vitest'
6+
import { assert, describe, expect, it, vi } from 'vitest'
77

88
class TestError extends Error {}
99

@@ -1232,12 +1232,6 @@ describe('async expect', () => {
12321232
})
12331233

12341234
describe('promise auto queuing', () => {
1235-
// silence warning
1236-
beforeAll(() => {
1237-
const spy = vi.spyOn(console, 'warn').mockImplementation(() => {})
1238-
return () => spy.mockRestore()
1239-
})
1240-
12411235
it.fails('fails', () => {
12421236
expect(new Promise((resolve, reject) => setTimeout(reject, 500)))
12431237
.resolves
@@ -1246,7 +1240,7 @@ describe('async expect', () => {
12461240

12471241
let value = 0
12481242

1249-
it('pass first', () => {
1243+
it.fails('not awaited fails', () => {
12501244
expect((async () => {
12511245
await new Promise(resolve => setTimeout(resolve, 500))
12521246
value += 1
@@ -1256,8 +1250,7 @@ describe('async expect', () => {
12561250
.toBe(1)
12571251
})
12581252

1259-
it('pass second', () => {
1260-
// even if 'pass first' is sync, we will still wait the expect to resolve
1253+
it('not awaited assertion is still resolved', () => {
12611254
expect(value).toBe(1)
12621255
})
12631256
})

0 commit comments

Comments
 (0)