feat: uncaught errors to indicate env teardown (#2982)

vitest-dev · Mar 10, 2023 · 1fe8286 · 1fe8286
1 parent f01c783
commit 1fe8286
Show file tree

Hide file tree

Showing 5 changed files with 12 additions and 16 deletions.
diff --git a/packages/vitest/src/node/error.ts b/packages/vitest/src/node/error.ts
@@ -72,6 +72,7 @@ export async function printError(error: unknown, ctx: Vitest, options: PrintErro
 
   const testPath = (e as any).VITEST_TEST_PATH
   const testName = (e as any).VITEST_TEST_NAME
+  const afterEnvTeardown = (e as any).VITEST_AFTER_ENV_TEARDOWN
   // testName has testPath inside
   if (testPath)
     ctx.logger.error(c.red(`This error originated in "${c.bold(testPath)}" test file. It doesn't mean the error was thrown inside the file itself, but while it was running.`))
@@ -80,6 +81,11 @@ export async function printError(error: unknown, ctx: Vitest, options: PrintErro
     + '\n- The error was thrown, while Vitest was running this test.'
     + '\n- This was the last recorded test before the error was thrown, if error originated after test finished its execution.'))
   }
+  if (afterEnvTeardown) {
+    ctx.logger.error(c.red('This error was caught after test environment was torn down. Make sure to cancel any running tasks before test finishes:'
+    + '\n- cancel timeouts using clearTimeout and clearInterval'
+    + '\n- wait for promises to resolve using the await keyword'))
+  }
 
   if (typeof e.cause === 'object' && e.cause && 'name' in e.cause) {
     (e.cause as any).name = `Caused by: ${(e.cause as any).name}`
@@ -117,6 +123,7 @@ const skipErrorProperties = new Set([
   'expected',
   'VITEST_TEST_NAME',
   'VITEST_TEST_PATH',
+  'VITEST_AFTER_ENV_TEARDOWN',
   ...Object.getOwnPropertyNames(Error.prototype),
   ...Object.getOwnPropertyNames(Object.prototype),
 ])

diff --git a/packages/vitest/src/runtime/entry.ts b/packages/vitest/src/runtime/entry.ts
@@ -100,4 +100,6 @@ export async function run(files: string[], config: ResolvedConfig, environment:
 
     await stopCoverageInsideWorker(config.coverage, executor)
   })
+
+  workerState.environmentTeardownRun = true
 }
diff --git a/packages/vitest/src/runtime/execute.ts b/packages/vitest/src/runtime/execute.ts
@@ -53,6 +53,8 @@ export async function startViteNode(ctx: ContextRPC) {
       error.VITEST_TEST_NAME = worker.current?.name
       error.VITEST_TEST_PATH = relative(config.root, worker.filepath)
     }
+    error.VITEST_AFTER_ENV_TEARDOWN = worker.environmentTeardownRun
+
     rpc().onUnhandledError(error, type)
   }
 

diff --git a/packages/vitest/src/types/worker.ts b/packages/vitest/src/types/worker.ts
@@ -23,6 +23,7 @@ export interface WorkerGlobalState {
   rpc: BirpcReturn<RuntimeRPC>
   current?: Test
   filepath?: string
+  environmentTeardownRun?: boolean
   moduleCache: ModuleCacheMap
   mockMap: MockMap
 }
diff --git a/test/core/test/dom.test.ts b/test/core/test/dom.test.ts
@@ -171,19 +171,3 @@ it('doesn\'t throw, if listening for error', () => {
   dispatchEvent(new Event('custom'))
   expect(spy).toHaveBeenCalled()
 })
-
-it('timers are not run after environment teardown', async () => {
-  setInterval(() => {
-    try {
-      window.document.createElement('div')
-    }
-    catch (err) {
-      if (/window is not defined/.test((err as any).message))
-        throw new Error('setInterval was called after environment teardown')
-
-      throw err
-    }
-  }, 1)
-
-  expect(window.document).toBeDefined()
-})