@vitest/runner 3.0.8 → 3.1.0-beta.1

package/dist/index.js

@@ -1,4 +1,4 @@
-import { getSafeTimers, isObject, createDefer, toArray, isNegativeNaN, format, objDisplay, objectAttr, assertTypes, shuffle } from '@vitest/utils';
+import { getSafeTimers, isObject, createDefer, toArray, isNegativeNaN, format, objectAttr, objDisplay, assertTypes, shuffle } from '@vitest/utils';
 import { parseSingleStack } from '@vitest/utils/source-map';
 import { c as createChainable, b as createFileTask, a as calculateSuiteHash, s as someTasksAreOnly, i as interpretTaskModes, l as limitConcurrency, p as partitionSuiteChildren, o as hasTests, n as hasFailed } from './chunk-tasks.js';
 import { processError } from '@vitest/utils/error';
@@ -31,7 +31,7 @@ async function runWithSuite(suite, fn) {
   await fn();
   collectorContext.currentSuite = prev;
 }
-function withTimeout(fn, timeout, isHook = false) {
+function withTimeout(fn, timeout, isHook = false, stackTraceError) {
   if (timeout <= 0 || timeout === Number.POSITIVE_INFINITY) {
     return fn;
   }
@@ -42,13 +42,16 @@ function withTimeout(fn, timeout, isHook = false) {
       var _a;
       const timer = setTimeout(() => {
         clearTimeout(timer);
-        reject(new Error(makeTimeoutMsg(isHook, timeout)));
+        rejectTimeoutError();
       }, timeout);
       (_a = timer.unref) == null ? void 0 : _a.call(timer);
+      function rejectTimeoutError() {
+        reject_(makeTimeoutError(isHook, timeout, stackTraceError));
+      }
       function resolve(result) {
         clearTimeout(timer);
         if (now$2() - startTime >= timeout) {
-          reject_(new Error(makeTimeoutMsg(isHook, timeout)));
+          rejectTimeoutError();
           return;
         }
         resolve_(result);
@@ -76,28 +79,40 @@ function createTestContext(test, runner) {
     throw new Error("done() callback is deprecated, use promise instead");
   };
   context.task = test;
-  context.skip = (note) => {
+  context.skip = (condition, note) => {
+    if (condition === false) {
+      return void 0;
+    }
     test.result ?? (test.result = { state: "skip" });
     test.result.pending = true;
-    throw new PendingError("test is skipped; abort execution", test, note);
+    throw new PendingError(
+      "test is skipped; abort execution",
+      test,
+      typeof condition === "string" ? condition : note
+    );
   };
   context.onTestFailed = (handler, timeout) => {
     test.onFailed || (test.onFailed = []);
     test.onFailed.push(
-      withTimeout(handler, timeout ?? runner.config.hookTimeout, true)
+      withTimeout(handler, timeout ?? runner.config.hookTimeout, true, new Error("STACK_TRACE_ERROR"))
     );
   };
   context.onTestFinished = (handler, timeout) => {
     test.onFinished || (test.onFinished = []);
     test.onFinished.push(
-      withTimeout(handler, timeout ?? runner.config.hookTimeout, true)
+      withTimeout(handler, timeout ?? runner.config.hookTimeout, true, new Error("STACK_TRACE_ERROR"))
     );
   };
   return ((_a = runner.extendTaskContext) == null ? void 0 : _a.call(runner, context)) || context;
 }
-function makeTimeoutMsg(isHook, timeout) {
-  return `${isHook ? "Hook" : "Test"} timed out in ${timeout}ms.
+function makeTimeoutError(isHook, timeout, stackTraceError) {
+  const message = `${isHook ? "Hook" : "Test"} timed out in ${timeout}ms.
 If this is a long-running ${isHook ? "hook" : "test"}, pass a timeout value as the last argument or configure it globally with "${isHook ? "hookTimeout" : "testTimeout"}".`;
+  const error = new Error(message);
+  if (stackTraceError == null ? void 0 : stackTraceError.stack) {
+    error.stack = stackTraceError.stack.replace(error.message, stackTraceError.message);
+  }
+  return error;
 }
 
 const fnMap = /* @__PURE__ */ new WeakMap();
@@ -426,6 +441,7 @@ function createSuiteCollector(name, factory = () => {
   initSuite(true);
   const task = function(name2 = "", options = {}) {
     var _a;
+    const timeout = (options == null ? void 0 : options.timeout) ?? runner.config.testTimeout;
     const task2 = {
       id: "",
       name: name2,
@@ -435,6 +451,7 @@ function createSuiteCollector(name, factory = () => {
       context: void 0,
       type: "test",
       file: void 0,
+      timeout,
       retry: options.retry ?? runner.config.retry,
       repeats: options.repeats,
       mode: options.only ? "only" : options.skip ? "skip" : options.todo ? "todo" : "run",
@@ -456,7 +473,7 @@ function createSuiteCollector(name, factory = () => {
         task2,
         withTimeout(
           withAwaitAsyncAssertions(withFixtures(handler, context), task2),
-          (options == null ? void 0 : options.timeout) ?? runner.config.testTimeout
+          timeout
         )
       );
     }
@@ -741,11 +758,11 @@ function createTest(fn, context) {
   return createTaskCollector(fn, context);
 }
 function formatName(name) {
-  return typeof name === "string" ? name : name instanceof Function ? name.name || "<anonymous>" : String(name);
+  return typeof name === "string" ? name : typeof name === "function" ? name.name || "<anonymous>" : String(name);
 }
 function formatTitle(template, items, idx) {
-  if (template.includes("%#")) {
-    template = template.replace(/%%/g, "__vitest_escaped_%__").replace(/%#/g, `${idx}`).replace(/__vitest_escaped_%__/g, "%%");
+  if (template.includes("%#") || template.includes("%$")) {
+    template = template.replace(/%%/g, "__vitest_escaped_%__").replace(/%#/g, `${idx}`).replace(/%\$/g, `${idx + 1}`).replace(/__vitest_escaped_%__/g, "%%");
   }
   const count = template.split("%").length - 1;
   if (template.includes("%f")) {
@@ -761,18 +778,22 @@ function formatTitle(template, items, idx) {
     });
   }
   let formatted = format(template, ...items.slice(0, count));
-  if (isObject(items[0])) {
-    formatted = formatted.replace(
-      /\$([$\w.]+)/g,
-      // https://github.com/chaijs/chai/pull/1490
-      (_, key) => {
-        var _a, _b;
-        return objDisplay(objectAttr(items[0], key), {
-          truncate: (_b = (_a = runner == null ? void 0 : runner.config) == null ? void 0 : _a.chaiConfig) == null ? void 0 : _b.truncateThreshold
-        });
+  const isObjectItem = isObject(items[0]);
+  formatted = formatted.replace(
+    /\$([$\w.]+)/g,
+    (_, key) => {
+      var _a, _b;
+      const isArrayKey = /^\d+$/.test(key);
+      if (!isObjectItem && !isArrayKey) {
+        return `$${key}`;
       }
-    );
-  }
+      const arrayElement = isArrayKey ? objectAttr(items, key) : void 0;
+      const value = isObjectItem ? objectAttr(items[0], key, arrayElement) : arrayElement;
+      return objDisplay(value, {
+        truncate: (_b = (_a = runner == null ? void 0 : runner.config) == null ? void 0 : _a.chaiConfig) == null ? void 0 : _b.truncateThreshold
+      });
+    }
+  );
   return formatted;
 }
 function formatTemplateString(cases, args) {
@@ -810,33 +831,61 @@ function getDefaultHookTimeout() {
   return getRunner().config.hookTimeout;
 }
 const CLEANUP_TIMEOUT_KEY = Symbol.for("VITEST_CLEANUP_TIMEOUT");
+const CLEANUP_STACK_TRACE_KEY = Symbol.for("VITEST_CLEANUP_STACK_TRACE");
 function getBeforeHookCleanupCallback(hook, result) {
   if (typeof result === "function") {
     const timeout = CLEANUP_TIMEOUT_KEY in hook && typeof hook[CLEANUP_TIMEOUT_KEY] === "number" ? hook[CLEANUP_TIMEOUT_KEY] : getDefaultHookTimeout();
-    return withTimeout(result, timeout, true);
+    const stackTraceError = CLEANUP_STACK_TRACE_KEY in hook && hook[CLEANUP_STACK_TRACE_KEY] instanceof Error ? hook[CLEANUP_STACK_TRACE_KEY] : void 0;
+    return withTimeout(result, timeout, true, stackTraceError);
   }
 }
 function beforeAll(fn, timeout = getDefaultHookTimeout()) {
   assertTypes(fn, '"beforeAll" callback', ["function"]);
+  const stackTraceError = new Error("STACK_TRACE_ERROR");
   return getCurrentSuite().on(
     "beforeAll",
-    Object.assign(withTimeout(fn, timeout, true), { [CLEANUP_TIMEOUT_KEY]: timeout })
+    Object.assign(
+      withTimeout(
+        fn,
+        timeout,
+        true,
+        stackTraceError
+      ),
+      {
+        [CLEANUP_TIMEOUT_KEY]: timeout,
+        [CLEANUP_STACK_TRACE_KEY]: stackTraceError
+      }
+    )
   );
 }
 function afterAll(fn, timeout) {
   assertTypes(fn, '"afterAll" callback', ["function"]);
   return getCurrentSuite().on(
     "afterAll",
-    withTimeout(fn, timeout ?? getDefaultHookTimeout(), true)
+    withTimeout(
+      fn,
+      timeout ?? getDefaultHookTimeout(),
+      true,
+      new Error("STACK_TRACE_ERROR")
+    )
   );
 }
 function beforeEach(fn, timeout = getDefaultHookTimeout()) {
   assertTypes(fn, '"beforeEach" callback', ["function"]);
+  const stackTraceError = new Error("STACK_TRACE_ERROR");
   return getCurrentSuite().on(
     "beforeEach",
     Object.assign(
-      withTimeout(withFixtures(fn), timeout ?? getDefaultHookTimeout(), true),
-      { [CLEANUP_TIMEOUT_KEY]: timeout }
+      withTimeout(
+        withFixtures(fn),
+        timeout ?? getDefaultHookTimeout(),
+        true,
+        stackTraceError
+      ),
+      {
+        [CLEANUP_TIMEOUT_KEY]: timeout,
+        [CLEANUP_STACK_TRACE_KEY]: stackTraceError
+      }
     )
   );
 }
@@ -844,7 +893,12 @@ function afterEach(fn, timeout) {
   assertTypes(fn, '"afterEach" callback', ["function"]);
   return getCurrentSuite().on(
     "afterEach",
-    withTimeout(withFixtures(fn), timeout ?? getDefaultHookTimeout(), true)
+    withTimeout(
+      withFixtures(fn),
+      timeout ?? getDefaultHookTimeout(),
+      true,
+      new Error("STACK_TRACE_ERROR")
+    )
   );
 }
 const onTestFailed = createTestHook(
@@ -852,7 +906,12 @@ const onTestFailed = createTestHook(
   (test, handler, timeout) => {
     test.onFailed || (test.onFailed = []);
     test.onFailed.push(
-      withTimeout(handler, timeout ?? getDefaultHookTimeout(), true)
+      withTimeout(
+        handler,
+        timeout ?? getDefaultHookTimeout(),
+        true,
+        new Error("STACK_TRACE_ERROR")
+      )
     );
   }
 );
@@ -861,7 +920,12 @@ const onTestFinished = createTestHook(
   (test, handler, timeout) => {
     test.onFinished || (test.onFinished = []);
     test.onFinished.push(
-      withTimeout(handler, timeout ?? getDefaultHookTimeout(), true)
+      withTimeout(
+        handler,
+        timeout ?? getDefaultHookTimeout(),
+        true,
+        new Error("STACK_TRACE_ERROR")
+      )
     );
   }
 );