fix: use .not in the error message if it was used

vitest-dev · Nov 7, 2024 · a6a4fb5 · a6a4fb5
1 parent 7df5dc6
commit a6a4fb5
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 5 deletions.
diff --git a/packages/browser/src/client/tester/expect-element.ts b/packages/browser/src/client/tester/expect-element.ts
@@ -16,8 +16,8 @@ export async function setupExpectDom() {
       }
       chai.util.flag(this, '_poll.element', true)
 
-      const isNot = chai.util.flag(this, 'negate')
-      const name = chai.util.flag(this, '_name')
+      const isNot = chai.util.flag(this, 'negate') as boolean
+      const name = chai.util.flag(this, '_name') as string
       // special case for `toBeInTheDocument` matcher
       if (isNot && name === 'toBeInTheDocument') {
         return elementOrLocator.query()

diff --git a/packages/vitest/src/integrations/chai/poll.ts b/packages/vitest/src/integrations/chai/poll.ts
@@ -99,8 +99,12 @@ export function createExpectPoll(expect: ExpectStatic): ExpectStatic['poll'] {
           test.onFinished ??= []
           test.onFinished.push(() => {
             if (!awaited) {
+              const negated = chai.util.flag(assertion, 'negate') ? 'not.' : ''
               const name = chai.util.flag(assertion, '_poll.element') ? 'element(locator)' : 'poll(assertion)'
-              const error = new Error(`expect.${name}.${String(key)}() was not awaited. This assertion is asynchronous and must be awaited:\n\nawait expect.${name}.${String(key)}()\n`)
+              const assertionString = `expect.${name}.${negated}${String(key)}()`
+              const error = new Error(
+                `${assertionString} was not awaited. This assertion is asynchronous and must be awaited:\n\nawait ${assertionString}\n`,
+              )
               throw copyStackTrace(error, STACK_TRACE_ERROR)
             }
           })

diff --git a/test/cli/fixtures/fails/poll-no-awaited.test.ts b/test/cli/fixtures/fails/poll-no-awaited.test.ts
@@ -6,7 +6,7 @@ test('poll is not awaited once', () => {
 
 test('poll is not awaited several times', () => {
   expect.poll(() => 3).toBe(3)
-  expect.poll(() => 'string').toBe('string')
+  expect.poll(() => 'string').not.toBe('correct')
 })
 
 test('poll is not awaited but there is an async assertion afterwards', async () => {

diff --git a/test/cli/test/__snapshots__/fails.test.ts.snap b/test/cli/test/__snapshots__/fails.test.ts.snap
@@ -65,7 +65,7 @@ exports[`should fail poll-no-awaited.test.ts > poll-no-awaited.test.ts 1`] = `
 AssertionError: expected 3 to be 4 // Object.is equality
 Error: expect.poll(assertion).toBe() was not awaited. This assertion is asynchronous and must be awaited:
 Error: expect.poll(assertion).toBe() was not awaited. This assertion is asynchronous and must be awaited:
-Error: expect.poll(assertion).toBe() was not awaited. This assertion is asynchronous and must be awaited:
+Error: expect.poll(assertion).not.toBe() was not awaited. This assertion is asynchronous and must be awaited:
 Error: expect.poll(assertion).toBe() was not awaited. This assertion is asynchronous and must be awaited:"
 `;