fix: vi.waitFor/vi.waitUntil interval is now cleared after it times o…

…ut (#5875)
vitest-dev · Jun 12, 2024 · 041076e · 041076e
1 parent a663c7b
commit 041076e
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 0 deletions.
diff --git a/packages/vitest/src/integrations/wait.ts b/packages/vitest/src/integrations/wait.ts
@@ -45,6 +45,8 @@ export function waitFor<T>(callback: WaitForCallback<T>, options: number | WaitF
     }
 
     const handleTimeout = () => {
+      if (intervalId)
+        clearInterval(intervalId)
       let error = lastError
       if (!error)
         error = copyStackTrace(new Error('Timed out in waitFor!'), STACK_TRACE_ERROR)
@@ -113,6 +115,8 @@ export function waitUntil<T>(callback: WaitUntilCallback<T>, options: number | W
     let intervalId: ReturnType<typeof setInterval>
 
     const onReject = (error?: Error) => {
+      if (intervalId)
+        clearInterval(intervalId)
       if (!error)
         error = copyStackTrace(new Error('Timed out in waitUntil!'), STACK_TRACE_ERROR)
       reject(error)

diff --git a/test/core/test/wait.test.ts b/test/core/test/wait.test.ts
@@ -99,6 +99,28 @@ describe('waitFor', () => {
 
     vi.useRealTimers()
   })
+
+  test('callback stops running after timeout', async () => {
+    vi.useFakeTimers()
+    let timedOut = false
+    let callbackRanAfterTimeout = false
+    try {
+      await vi.waitFor(() => {
+        callbackRanAfterTimeout = timedOut
+        throw new Error('waitFor error')
+      }, {
+        interval: 100,
+        timeout: 200,
+      })
+    }
+    catch (error) {
+      timedOut = true
+    }
+    await vi.advanceTimersByTimeAsync(100)
+    expect(timedOut).toBe(true)
+    expect(callbackRanAfterTimeout).toBe(false)
+    vi.useRealTimers()
+  })
 })
 
 describe('waitUntil', () => {
@@ -180,4 +202,26 @@ describe('waitUntil', () => {
 
     vi.useRealTimers()
   })
+
+  test('callback stops running after timeout', async () => {
+    vi.useFakeTimers()
+    let timedOut = false
+    let callbackRanAfterTimeout = false
+    try {
+      await vi.waitUntil(() => {
+        callbackRanAfterTimeout = timedOut
+        return false
+      }, {
+        interval: 100,
+        timeout: 200,
+      })
+    }
+    catch (error) {
+      timedOut = true
+    }
+    await vi.advanceTimersByTimeAsync(100)
+    expect(timedOut).toBe(true)
+    expect(callbackRanAfterTimeout).toBe(false)
+    vi.useRealTimers()
+  })
 })