@vitest/runner 3.1.0-beta.1 → 3.1.0-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.js CHANGED
@@ -6,1443 +6,1545 @@ export { processError } from '@vitest/utils/error';
6
6
  import 'pathe';
7
7
 
8
8
  class PendingError extends Error {
9
- constructor(message, task, note) {
10
- super(message);
11
- this.message = message;
12
- this.note = note;
13
- this.taskId = task.id;
14
- }
15
- code = "VITEST_PENDING";
16
- taskId;
9
+ code = "VITEST_PENDING";
10
+ taskId;
11
+ constructor(message, task, note) {
12
+ super(message);
13
+ this.message = message;
14
+ this.note = note;
15
+ this.taskId = task.id;
16
+ }
17
17
  }
18
18
 
19
19
  const now$2 = Date.now;
20
20
  const collectorContext = {
21
- tasks: [],
22
- currentSuite: null
21
+ tasks: [],
22
+ currentSuite: null
23
23
  };
24
24
  function collectTask(task) {
25
- var _a;
26
- (_a = collectorContext.currentSuite) == null ? void 0 : _a.tasks.push(task);
25
+ var _collectorContext$cur;
26
+ (_collectorContext$cur = collectorContext.currentSuite) === null || _collectorContext$cur === void 0 ? void 0 : _collectorContext$cur.tasks.push(task);
27
27
  }
28
28
  async function runWithSuite(suite, fn) {
29
- const prev = collectorContext.currentSuite;
30
- collectorContext.currentSuite = suite;
31
- await fn();
32
- collectorContext.currentSuite = prev;
29
+ const prev = collectorContext.currentSuite;
30
+ collectorContext.currentSuite = suite;
31
+ await fn();
32
+ collectorContext.currentSuite = prev;
33
33
  }
34
34
  function withTimeout(fn, timeout, isHook = false, stackTraceError) {
35
- if (timeout <= 0 || timeout === Number.POSITIVE_INFINITY) {
36
- return fn;
37
- }
38
- const { setTimeout, clearTimeout } = getSafeTimers();
39
- return function runWithTimeout(...args) {
40
- const startTime = now$2();
41
- return new Promise((resolve_, reject_) => {
42
- var _a;
43
- const timer = setTimeout(() => {
44
- clearTimeout(timer);
45
- rejectTimeoutError();
46
- }, timeout);
47
- (_a = timer.unref) == null ? void 0 : _a.call(timer);
48
- function rejectTimeoutError() {
49
- reject_(makeTimeoutError(isHook, timeout, stackTraceError));
50
- }
51
- function resolve(result) {
52
- clearTimeout(timer);
53
- if (now$2() - startTime >= timeout) {
54
- rejectTimeoutError();
55
- return;
56
- }
57
- resolve_(result);
58
- }
59
- function reject(error) {
60
- clearTimeout(timer);
61
- reject_(error);
62
- }
63
- try {
64
- const result = fn(...args);
65
- if (typeof result === "object" && result != null && typeof result.then === "function") {
66
- result.then(resolve, reject);
67
- } else {
68
- resolve(result);
69
- }
70
- } catch (error) {
71
- reject(error);
72
- }
73
- });
74
- };
35
+ if (timeout <= 0 || timeout === Number.POSITIVE_INFINITY) {
36
+ return fn;
37
+ }
38
+ const { setTimeout, clearTimeout } = getSafeTimers();
39
+ return function runWithTimeout(...args) {
40
+ const startTime = now$2();
41
+ return new Promise((resolve_, reject_) => {
42
+ var _timer$unref;
43
+ const timer = setTimeout(() => {
44
+ clearTimeout(timer);
45
+ rejectTimeoutError();
46
+ }, timeout);
47
+ (_timer$unref = timer.unref) === null || _timer$unref === void 0 ? void 0 : _timer$unref.call(timer);
48
+ function rejectTimeoutError() {
49
+ reject_(makeTimeoutError(isHook, timeout, stackTraceError));
50
+ }
51
+ function resolve(result) {
52
+ clearTimeout(timer);
53
+ if (now$2() - startTime >= timeout) {
54
+ rejectTimeoutError();
55
+ return;
56
+ }
57
+ resolve_(result);
58
+ }
59
+ function reject(error) {
60
+ clearTimeout(timer);
61
+ reject_(error);
62
+ }
63
+ try {
64
+ const result = fn(...args);
65
+ if (typeof result === "object" && result != null && typeof result.then === "function") {
66
+ result.then(resolve, reject);
67
+ } else {
68
+ resolve(result);
69
+ }
70
+ } catch (error) {
71
+ reject(error);
72
+ }
73
+ });
74
+ };
75
75
  }
76
76
  function createTestContext(test, runner) {
77
- var _a;
78
- const context = function() {
79
- throw new Error("done() callback is deprecated, use promise instead");
80
- };
81
- context.task = test;
82
- context.skip = (condition, note) => {
83
- if (condition === false) {
84
- return void 0;
85
- }
86
- test.result ?? (test.result = { state: "skip" });
87
- test.result.pending = true;
88
- throw new PendingError(
89
- "test is skipped; abort execution",
90
- test,
91
- typeof condition === "string" ? condition : note
92
- );
93
- };
94
- context.onTestFailed = (handler, timeout) => {
95
- test.onFailed || (test.onFailed = []);
96
- test.onFailed.push(
97
- withTimeout(handler, timeout ?? runner.config.hookTimeout, true, new Error("STACK_TRACE_ERROR"))
98
- );
99
- };
100
- context.onTestFinished = (handler, timeout) => {
101
- test.onFinished || (test.onFinished = []);
102
- test.onFinished.push(
103
- withTimeout(handler, timeout ?? runner.config.hookTimeout, true, new Error("STACK_TRACE_ERROR"))
104
- );
105
- };
106
- return ((_a = runner.extendTaskContext) == null ? void 0 : _a.call(runner, context)) || context;
77
+ var _runner$extendTaskCon;
78
+ const context = function() {
79
+ throw new Error("done() callback is deprecated, use promise instead");
80
+ };
81
+ context.task = test;
82
+ context.skip = (condition, note) => {
83
+ if (condition === false) {
84
+ return undefined;
85
+ }
86
+ test.result ?? (test.result = { state: "skip" });
87
+ test.result.pending = true;
88
+ throw new PendingError("test is skipped; abort execution", test, typeof condition === "string" ? condition : note);
89
+ };
90
+ context.onTestFailed = (handler, timeout) => {
91
+ test.onFailed || (test.onFailed = []);
92
+ test.onFailed.push(withTimeout(handler, timeout ?? runner.config.hookTimeout, true, new Error("STACK_TRACE_ERROR")));
93
+ };
94
+ context.onTestFinished = (handler, timeout) => {
95
+ test.onFinished || (test.onFinished = []);
96
+ test.onFinished.push(withTimeout(handler, timeout ?? runner.config.hookTimeout, true, new Error("STACK_TRACE_ERROR")));
97
+ };
98
+ return ((_runner$extendTaskCon = runner.extendTaskContext) === null || _runner$extendTaskCon === void 0 ? void 0 : _runner$extendTaskCon.call(runner, context)) || context;
107
99
  }
108
100
  function makeTimeoutError(isHook, timeout, stackTraceError) {
109
- const message = `${isHook ? "Hook" : "Test"} timed out in ${timeout}ms.
110
- 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"}".`;
111
- const error = new Error(message);
112
- if (stackTraceError == null ? void 0 : stackTraceError.stack) {
113
- error.stack = stackTraceError.stack.replace(error.message, stackTraceError.message);
114
- }
115
- return error;
101
+ const message = `${isHook ? "Hook" : "Test"} timed out in ${timeout}ms.\nIf this is a long-running ${isHook ? "hook" : "test"}, pass a timeout value as the last argument or configure it globally with "${isHook ? "hookTimeout" : "testTimeout"}".`;
102
+ const error = new Error(message);
103
+ if (stackTraceError === null || stackTraceError === void 0 ? void 0 : stackTraceError.stack) {
104
+ error.stack = stackTraceError.stack.replace(error.message, stackTraceError.message);
105
+ }
106
+ return error;
116
107
  }
117
108
 
118
- const fnMap = /* @__PURE__ */ new WeakMap();
119
- const fixtureMap = /* @__PURE__ */ new WeakMap();
120
- const hooksMap = /* @__PURE__ */ new WeakMap();
109
+ const fnMap = new WeakMap();
110
+ const testFixtureMap = new WeakMap();
111
+ const hooksMap = new WeakMap();
121
112
  function setFn(key, fn) {
122
- fnMap.set(key, fn);
113
+ fnMap.set(key, fn);
123
114
  }
124
115
  function getFn(key) {
125
- return fnMap.get(key);
116
+ return fnMap.get(key);
126
117
  }
127
- function setFixture(key, fixture) {
128
- fixtureMap.set(key, fixture);
118
+ function setTestFixture(key, fixture) {
119
+ testFixtureMap.set(key, fixture);
129
120
  }
130
- function getFixture(key) {
131
- return fixtureMap.get(key);
121
+ function getTestFixture(key) {
122
+ return testFixtureMap.get(key);
132
123
  }
133
124
  function setHooks(key, hooks) {
134
- hooksMap.set(key, hooks);
125
+ hooksMap.set(key, hooks);
135
126
  }
136
127
  function getHooks(key) {
137
- return hooksMap.get(key);
128
+ return hooksMap.get(key);
138
129
  }
139
130
 
131
+ function mergeScopedFixtures(testFixtures, scopedFixtures) {
132
+ const scopedFixturesMap = scopedFixtures.reduce((map, fixture) => {
133
+ map[fixture.prop] = fixture;
134
+ return map;
135
+ }, {});
136
+ const newFixtures = {};
137
+ testFixtures.forEach((fixture) => {
138
+ const useFixture = scopedFixturesMap[fixture.prop] || { ...fixture };
139
+ newFixtures[useFixture.prop] = useFixture;
140
+ });
141
+ for (const fixtureKep in newFixtures) {
142
+ var _fixture$deps;
143
+ const fixture = newFixtures[fixtureKep];
144
+ fixture.deps = (_fixture$deps = fixture.deps) === null || _fixture$deps === void 0 ? void 0 : _fixture$deps.map((dep) => newFixtures[dep.prop]);
145
+ }
146
+ return Object.values(newFixtures);
147
+ }
140
148
  function mergeContextFixtures(fixtures, context, inject) {
141
- const fixtureOptionKeys = ["auto", "injected"];
142
- const fixtureArray = Object.entries(fixtures).map(
143
- ([prop, value]) => {
144
- const fixtureItem = { value };
145
- if (Array.isArray(value) && value.length >= 2 && isObject(value[1]) && Object.keys(value[1]).some((key) => fixtureOptionKeys.includes(key))) {
146
- Object.assign(fixtureItem, value[1]);
147
- const userValue = value[0];
148
- fixtureItem.value = fixtureItem.injected ? inject(prop) ?? userValue : userValue;
149
- }
150
- fixtureItem.prop = prop;
151
- fixtureItem.isFn = typeof fixtureItem.value === "function";
152
- return fixtureItem;
153
- }
154
- );
155
- if (Array.isArray(context.fixtures)) {
156
- context.fixtures = context.fixtures.concat(fixtureArray);
157
- } else {
158
- context.fixtures = fixtureArray;
159
- }
160
- fixtureArray.forEach((fixture) => {
161
- if (fixture.isFn) {
162
- const usedProps = getUsedProps(fixture.value);
163
- if (usedProps.length) {
164
- fixture.deps = context.fixtures.filter(
165
- ({ prop }) => prop !== fixture.prop && usedProps.includes(prop)
166
- );
167
- }
168
- }
169
- });
170
- return context;
171
- }
172
- const fixtureValueMaps = /* @__PURE__ */ new Map();
173
- const cleanupFnArrayMap = /* @__PURE__ */ new Map();
149
+ const fixtureOptionKeys = ["auto", "injected"];
150
+ const fixtureArray = Object.entries(fixtures).map(([prop, value]) => {
151
+ const fixtureItem = { value };
152
+ if (Array.isArray(value) && value.length >= 2 && isObject(value[1]) && Object.keys(value[1]).some((key) => fixtureOptionKeys.includes(key))) {
153
+ Object.assign(fixtureItem, value[1]);
154
+ const userValue = value[0];
155
+ fixtureItem.value = fixtureItem.injected ? inject(prop) ?? userValue : userValue;
156
+ }
157
+ fixtureItem.prop = prop;
158
+ fixtureItem.isFn = typeof fixtureItem.value === "function";
159
+ return fixtureItem;
160
+ });
161
+ if (Array.isArray(context.fixtures)) {
162
+ context.fixtures = context.fixtures.concat(fixtureArray);
163
+ } else {
164
+ context.fixtures = fixtureArray;
165
+ }
166
+ fixtureArray.forEach((fixture) => {
167
+ if (fixture.isFn) {
168
+ const usedProps = getUsedProps(fixture.value);
169
+ if (usedProps.length) {
170
+ fixture.deps = context.fixtures.filter(({ prop }) => prop !== fixture.prop && usedProps.includes(prop));
171
+ }
172
+ }
173
+ });
174
+ return context;
175
+ }
176
+ const fixtureValueMaps = new Map();
177
+ const cleanupFnArrayMap = new Map();
174
178
  async function callFixtureCleanup(context) {
175
- const cleanupFnArray = cleanupFnArrayMap.get(context) ?? [];
176
- for (const cleanup of cleanupFnArray.reverse()) {
177
- await cleanup();
178
- }
179
- cleanupFnArrayMap.delete(context);
179
+ const cleanupFnArray = cleanupFnArrayMap.get(context) ?? [];
180
+ for (const cleanup of cleanupFnArray.reverse()) {
181
+ await cleanup();
182
+ }
183
+ cleanupFnArrayMap.delete(context);
180
184
  }
181
185
  function withFixtures(fn, testContext) {
182
- return (hookContext) => {
183
- const context = hookContext || testContext;
184
- if (!context) {
185
- return fn({});
186
- }
187
- const fixtures = getFixture(context);
188
- if (!(fixtures == null ? void 0 : fixtures.length)) {
189
- return fn(context);
190
- }
191
- const usedProps = getUsedProps(fn);
192
- const hasAutoFixture = fixtures.some(({ auto }) => auto);
193
- if (!usedProps.length && !hasAutoFixture) {
194
- return fn(context);
195
- }
196
- if (!fixtureValueMaps.get(context)) {
197
- fixtureValueMaps.set(context, /* @__PURE__ */ new Map());
198
- }
199
- const fixtureValueMap = fixtureValueMaps.get(context);
200
- if (!cleanupFnArrayMap.has(context)) {
201
- cleanupFnArrayMap.set(context, []);
202
- }
203
- const cleanupFnArray = cleanupFnArrayMap.get(context);
204
- const usedFixtures = fixtures.filter(
205
- ({ prop, auto }) => auto || usedProps.includes(prop)
206
- );
207
- const pendingFixtures = resolveDeps(usedFixtures);
208
- if (!pendingFixtures.length) {
209
- return fn(context);
210
- }
211
- async function resolveFixtures() {
212
- for (const fixture of pendingFixtures) {
213
- if (fixtureValueMap.has(fixture)) {
214
- continue;
215
- }
216
- const resolvedValue = fixture.isFn ? await resolveFixtureFunction(fixture.value, context, cleanupFnArray) : fixture.value;
217
- context[fixture.prop] = resolvedValue;
218
- fixtureValueMap.set(fixture, resolvedValue);
219
- cleanupFnArray.unshift(() => {
220
- fixtureValueMap.delete(fixture);
221
- });
222
- }
223
- }
224
- return resolveFixtures().then(() => fn(context));
225
- };
186
+ return (hookContext) => {
187
+ const context = hookContext || testContext;
188
+ if (!context) {
189
+ return fn({});
190
+ }
191
+ const fixtures = getTestFixture(context);
192
+ if (!(fixtures === null || fixtures === void 0 ? void 0 : fixtures.length)) {
193
+ return fn(context);
194
+ }
195
+ const usedProps = getUsedProps(fn);
196
+ const hasAutoFixture = fixtures.some(({ auto }) => auto);
197
+ if (!usedProps.length && !hasAutoFixture) {
198
+ return fn(context);
199
+ }
200
+ if (!fixtureValueMaps.get(context)) {
201
+ fixtureValueMaps.set(context, new Map());
202
+ }
203
+ const fixtureValueMap = fixtureValueMaps.get(context);
204
+ if (!cleanupFnArrayMap.has(context)) {
205
+ cleanupFnArrayMap.set(context, []);
206
+ }
207
+ const cleanupFnArray = cleanupFnArrayMap.get(context);
208
+ const usedFixtures = fixtures.filter(({ prop, auto }) => auto || usedProps.includes(prop));
209
+ const pendingFixtures = resolveDeps(usedFixtures);
210
+ if (!pendingFixtures.length) {
211
+ return fn(context);
212
+ }
213
+ async function resolveFixtures() {
214
+ for (const fixture of pendingFixtures) {
215
+ if (fixtureValueMap.has(fixture)) {
216
+ continue;
217
+ }
218
+ const resolvedValue = fixture.isFn ? await resolveFixtureFunction(fixture.value, context, cleanupFnArray) : fixture.value;
219
+ context[fixture.prop] = resolvedValue;
220
+ fixtureValueMap.set(fixture, resolvedValue);
221
+ cleanupFnArray.unshift(() => {
222
+ fixtureValueMap.delete(fixture);
223
+ });
224
+ }
225
+ }
226
+ return resolveFixtures().then(() => fn(context));
227
+ };
226
228
  }
227
229
  async function resolveFixtureFunction(fixtureFn, context, cleanupFnArray) {
228
- const useFnArgPromise = createDefer();
229
- let isUseFnArgResolved = false;
230
- const fixtureReturn = fixtureFn(context, async (useFnArg) => {
231
- isUseFnArgResolved = true;
232
- useFnArgPromise.resolve(useFnArg);
233
- const useReturnPromise = createDefer();
234
- cleanupFnArray.push(async () => {
235
- useReturnPromise.resolve();
236
- await fixtureReturn;
237
- });
238
- await useReturnPromise;
239
- }).catch((e) => {
240
- if (!isUseFnArgResolved) {
241
- useFnArgPromise.reject(e);
242
- return;
243
- }
244
- throw e;
245
- });
246
- return useFnArgPromise;
247
- }
248
- function resolveDeps(fixtures, depSet = /* @__PURE__ */ new Set(), pendingFixtures = []) {
249
- fixtures.forEach((fixture) => {
250
- if (pendingFixtures.includes(fixture)) {
251
- return;
252
- }
253
- if (!fixture.isFn || !fixture.deps) {
254
- pendingFixtures.push(fixture);
255
- return;
256
- }
257
- if (depSet.has(fixture)) {
258
- throw new Error(
259
- `Circular fixture dependency detected: ${fixture.prop} <- ${[...depSet].reverse().map((d) => d.prop).join(" <- ")}`
260
- );
261
- }
262
- depSet.add(fixture);
263
- resolveDeps(fixture.deps, depSet, pendingFixtures);
264
- pendingFixtures.push(fixture);
265
- depSet.clear();
266
- });
267
- return pendingFixtures;
230
+ const useFnArgPromise = createDefer();
231
+ let isUseFnArgResolved = false;
232
+ const fixtureReturn = fixtureFn(context, async (useFnArg) => {
233
+ isUseFnArgResolved = true;
234
+ useFnArgPromise.resolve(useFnArg);
235
+ const useReturnPromise = createDefer();
236
+ cleanupFnArray.push(async () => {
237
+ useReturnPromise.resolve();
238
+ await fixtureReturn;
239
+ });
240
+ await useReturnPromise;
241
+ }).catch((e) => {
242
+ if (!isUseFnArgResolved) {
243
+ useFnArgPromise.reject(e);
244
+ return;
245
+ }
246
+ throw e;
247
+ });
248
+ return useFnArgPromise;
249
+ }
250
+ function resolveDeps(fixtures, depSet = new Set(), pendingFixtures = []) {
251
+ fixtures.forEach((fixture) => {
252
+ if (pendingFixtures.includes(fixture)) {
253
+ return;
254
+ }
255
+ if (!fixture.isFn || !fixture.deps) {
256
+ pendingFixtures.push(fixture);
257
+ return;
258
+ }
259
+ if (depSet.has(fixture)) {
260
+ throw new Error(`Circular fixture dependency detected: ${fixture.prop} <- ${[...depSet].reverse().map((d) => d.prop).join(" <- ")}`);
261
+ }
262
+ depSet.add(fixture);
263
+ resolveDeps(fixture.deps, depSet, pendingFixtures);
264
+ pendingFixtures.push(fixture);
265
+ depSet.clear();
266
+ });
267
+ return pendingFixtures;
268
268
  }
269
269
  function getUsedProps(fn) {
270
- let fnString = fn.toString();
271
- if (/__async\(this, (?:null|arguments|\[[_0-9, ]*\]), function\*/.test(fnString)) {
272
- fnString = fnString.split("__async(this,")[1];
273
- }
274
- const match = fnString.match(/[^(]*\(([^)]*)/);
275
- if (!match) {
276
- return [];
277
- }
278
- const args = splitByComma(match[1]);
279
- if (!args.length) {
280
- return [];
281
- }
282
- let first = args[0];
283
- if ("__VITEST_FIXTURE_INDEX__" in fn) {
284
- first = args[fn.__VITEST_FIXTURE_INDEX__];
285
- if (!first) {
286
- return [];
287
- }
288
- }
289
- if (!(first.startsWith("{") && first.endsWith("}"))) {
290
- throw new Error(
291
- `The first argument inside a fixture must use object destructuring pattern, e.g. ({ test } => {}). Instead, received "${first}".`
292
- );
293
- }
294
- const _first = first.slice(1, -1).replace(/\s/g, "");
295
- const props = splitByComma(_first).map((prop) => {
296
- return prop.replace(/:.*|=.*/g, "");
297
- });
298
- const last = props.at(-1);
299
- if (last && last.startsWith("...")) {
300
- throw new Error(
301
- `Rest parameters are not supported in fixtures, received "${last}".`
302
- );
303
- }
304
- return props;
270
+ let fnString = fn.toString();
271
+ if (/__async\(this, (?:null|arguments|\[[_0-9, ]*\]), function\*/.test(fnString)) {
272
+ fnString = fnString.split("__async(this,")[1];
273
+ }
274
+ const match = fnString.match(/[^(]*\(([^)]*)/);
275
+ if (!match) {
276
+ return [];
277
+ }
278
+ const args = splitByComma(match[1]);
279
+ if (!args.length) {
280
+ return [];
281
+ }
282
+ let first = args[0];
283
+ if ("__VITEST_FIXTURE_INDEX__" in fn) {
284
+ first = args[fn.__VITEST_FIXTURE_INDEX__];
285
+ if (!first) {
286
+ return [];
287
+ }
288
+ }
289
+ if (!(first.startsWith("{") && first.endsWith("}"))) {
290
+ throw new Error(`The first argument inside a fixture must use object destructuring pattern, e.g. ({ test } => {}). Instead, received "${first}".`);
291
+ }
292
+ const _first = first.slice(1, -1).replace(/\s/g, "");
293
+ const props = splitByComma(_first).map((prop) => {
294
+ return prop.replace(/:.*|=.*/g, "");
295
+ });
296
+ const last = props.at(-1);
297
+ if (last && last.startsWith("...")) {
298
+ throw new Error(`Rest parameters are not supported in fixtures, received "${last}".`);
299
+ }
300
+ return props;
305
301
  }
306
302
  function splitByComma(s) {
307
- const result = [];
308
- const stack = [];
309
- let start = 0;
310
- for (let i = 0; i < s.length; i++) {
311
- if (s[i] === "{" || s[i] === "[") {
312
- stack.push(s[i] === "{" ? "}" : "]");
313
- } else if (s[i] === stack[stack.length - 1]) {
314
- stack.pop();
315
- } else if (!stack.length && s[i] === ",") {
316
- const token = s.substring(start, i).trim();
317
- if (token) {
318
- result.push(token);
319
- }
320
- start = i + 1;
321
- }
322
- }
323
- const lastToken = s.substring(start).trim();
324
- if (lastToken) {
325
- result.push(lastToken);
326
- }
327
- return result;
303
+ const result = [];
304
+ const stack = [];
305
+ let start = 0;
306
+ for (let i = 0; i < s.length; i++) {
307
+ if (s[i] === "{" || s[i] === "[") {
308
+ stack.push(s[i] === "{" ? "}" : "]");
309
+ } else if (s[i] === stack[stack.length - 1]) {
310
+ stack.pop();
311
+ } else if (!stack.length && s[i] === ",") {
312
+ const token = s.substring(start, i).trim();
313
+ if (token) {
314
+ result.push(token);
315
+ }
316
+ start = i + 1;
317
+ }
318
+ }
319
+ const lastToken = s.substring(start).trim();
320
+ if (lastToken) {
321
+ result.push(lastToken);
322
+ }
323
+ return result;
328
324
  }
329
325
 
330
326
  let _test;
331
327
  function setCurrentTest(test) {
332
- _test = test;
328
+ _test = test;
333
329
  }
334
330
  function getCurrentTest() {
335
- return _test;
331
+ return _test;
336
332
  }
337
333
 
334
+ /**
335
+ * Creates a suite of tests, allowing for grouping and hierarchical organization of tests.
336
+ * Suites can contain both tests and other suites, enabling complex test structures.
337
+ *
338
+ * @param {string} name - The name of the suite, used for identification and reporting.
339
+ * @param {Function} fn - A function that defines the tests and suites within this suite.
340
+ * @example
341
+ * ```ts
342
+ * // Define a suite with two tests
343
+ * suite('Math operations', () => {
344
+ * test('should add two numbers', () => {
345
+ * expect(add(1, 2)).toBe(3);
346
+ * });
347
+ *
348
+ * test('should subtract two numbers', () => {
349
+ * expect(subtract(5, 2)).toBe(3);
350
+ * });
351
+ * });
352
+ * ```
353
+ * @example
354
+ * ```ts
355
+ * // Define nested suites
356
+ * suite('String operations', () => {
357
+ * suite('Trimming', () => {
358
+ * test('should trim whitespace from start and end', () => {
359
+ * expect(' hello '.trim()).toBe('hello');
360
+ * });
361
+ * });
362
+ *
363
+ * suite('Concatenation', () => {
364
+ * test('should concatenate two strings', () => {
365
+ * expect('hello' + ' ' + 'world').toBe('hello world');
366
+ * });
367
+ * });
368
+ * });
369
+ * ```
370
+ */
338
371
  const suite = createSuite();
372
+ /**
373
+ * Defines a test case with a given name and test function. The test function can optionally be configured with test options.
374
+ *
375
+ * @param {string | Function} name - The name of the test or a function that will be used as a test name.
376
+ * @param {TestOptions | TestFunction} [optionsOrFn] - Optional. The test options or the test function if no explicit name is provided.
377
+ * @param {number | TestOptions | TestFunction} [optionsOrTest] - Optional. The test function or options, depending on the previous parameters.
378
+ * @throws {Error} If called inside another test function.
379
+ * @example
380
+ * ```ts
381
+ * // Define a simple test
382
+ * test('should add two numbers', () => {
383
+ * expect(add(1, 2)).toBe(3);
384
+ * });
385
+ * ```
386
+ * @example
387
+ * ```ts
388
+ * // Define a test with options
389
+ * test('should subtract two numbers', { retry: 3 }, () => {
390
+ * expect(subtract(5, 2)).toBe(3);
391
+ * });
392
+ * ```
393
+ */
339
394
  const test = createTest(function(name, optionsOrFn, optionsOrTest) {
340
- if (getCurrentTest()) {
341
- throw new Error(
342
- 'Calling the test function inside another test function is not allowed. Please put it inside "describe" or "suite" so it can be properly collected.'
343
- );
344
- }
345
- getCurrentSuite().test.fn.call(
346
- this,
347
- formatName(name),
348
- optionsOrFn,
349
- optionsOrTest
350
- );
395
+ if (getCurrentTest()) {
396
+ throw new Error("Calling the test function inside another test function is not allowed. Please put it inside \"describe\" or \"suite\" so it can be properly collected.");
397
+ }
398
+ getCurrentSuite().test.fn.call(this, formatName(name), optionsOrFn, optionsOrTest);
351
399
  });
400
+ /**
401
+ * Creates a suite of tests, allowing for grouping and hierarchical organization of tests.
402
+ * Suites can contain both tests and other suites, enabling complex test structures.
403
+ *
404
+ * @param {string} name - The name of the suite, used for identification and reporting.
405
+ * @param {Function} fn - A function that defines the tests and suites within this suite.
406
+ * @example
407
+ * ```ts
408
+ * // Define a suite with two tests
409
+ * describe('Math operations', () => {
410
+ * test('should add two numbers', () => {
411
+ * expect(add(1, 2)).toBe(3);
412
+ * });
413
+ *
414
+ * test('should subtract two numbers', () => {
415
+ * expect(subtract(5, 2)).toBe(3);
416
+ * });
417
+ * });
418
+ * ```
419
+ * @example
420
+ * ```ts
421
+ * // Define nested suites
422
+ * describe('String operations', () => {
423
+ * describe('Trimming', () => {
424
+ * test('should trim whitespace from start and end', () => {
425
+ * expect(' hello '.trim()).toBe('hello');
426
+ * });
427
+ * });
428
+ *
429
+ * describe('Concatenation', () => {
430
+ * test('should concatenate two strings', () => {
431
+ * expect('hello' + ' ' + 'world').toBe('hello world');
432
+ * });
433
+ * });
434
+ * });
435
+ * ```
436
+ */
352
437
  const describe = suite;
438
+ /**
439
+ * Defines a test case with a given name and test function. The test function can optionally be configured with test options.
440
+ *
441
+ * @param {string | Function} name - The name of the test or a function that will be used as a test name.
442
+ * @param {TestOptions | TestFunction} [optionsOrFn] - Optional. The test options or the test function if no explicit name is provided.
443
+ * @param {number | TestOptions | TestFunction} [optionsOrTest] - Optional. The test function or options, depending on the previous parameters.
444
+ * @throws {Error} If called inside another test function.
445
+ * @example
446
+ * ```ts
447
+ * // Define a simple test
448
+ * it('adds two numbers', () => {
449
+ * expect(add(1, 2)).toBe(3);
450
+ * });
451
+ * ```
452
+ * @example
453
+ * ```ts
454
+ * // Define a test with options
455
+ * it('subtracts two numbers', { retry: 3 }, () => {
456
+ * expect(subtract(5, 2)).toBe(3);
457
+ * });
458
+ * ```
459
+ */
353
460
  const it = test;
354
461
  let runner;
355
462
  let defaultSuite;
356
463
  let currentTestFilepath;
357
464
  function assert(condition, message) {
358
- if (!condition) {
359
- throw new Error(`Vitest failed to find ${message}. This is a bug in Vitest. Please, open an issue with reproduction.`);
360
- }
465
+ if (!condition) {
466
+ throw new Error(`Vitest failed to find ${message}. This is a bug in Vitest. Please, open an issue with reproduction.`);
467
+ }
361
468
  }
362
469
  function getDefaultSuite() {
363
- assert(defaultSuite, "the default suite");
364
- return defaultSuite;
470
+ assert(defaultSuite, "the default suite");
471
+ return defaultSuite;
365
472
  }
366
473
  function getTestFilepath() {
367
- return currentTestFilepath;
474
+ return currentTestFilepath;
368
475
  }
369
476
  function getRunner() {
370
- assert(runner, "the runner");
371
- return runner;
477
+ assert(runner, "the runner");
478
+ return runner;
372
479
  }
373
- function createDefaultSuite(runner2) {
374
- const config = runner2.config.sequence;
375
- const collector = suite("", { concurrent: config.concurrent }, () => {
376
- });
377
- delete collector.suite;
378
- return collector;
480
+ function createDefaultSuite(runner) {
481
+ const config = runner.config.sequence;
482
+ const collector = suite("", { concurrent: config.concurrent }, () => {});
483
+ delete collector.suite;
484
+ return collector;
379
485
  }
380
486
  function clearCollectorContext(filepath, currentRunner) {
381
- if (!defaultSuite) {
382
- defaultSuite = createDefaultSuite(currentRunner);
383
- }
384
- runner = currentRunner;
385
- currentTestFilepath = filepath;
386
- collectorContext.tasks.length = 0;
387
- defaultSuite.clear();
388
- collectorContext.currentSuite = defaultSuite;
487
+ if (!defaultSuite) {
488
+ defaultSuite = createDefaultSuite(currentRunner);
489
+ }
490
+ runner = currentRunner;
491
+ currentTestFilepath = filepath;
492
+ collectorContext.tasks.length = 0;
493
+ defaultSuite.clear();
494
+ collectorContext.currentSuite = defaultSuite;
389
495
  }
390
496
  function getCurrentSuite() {
391
- const currentSuite = collectorContext.currentSuite || defaultSuite;
392
- assert(currentSuite, "the current suite");
393
- return currentSuite;
497
+ const currentSuite = collectorContext.currentSuite || defaultSuite;
498
+ assert(currentSuite, "the current suite");
499
+ return currentSuite;
394
500
  }
395
501
  function createSuiteHooks() {
396
- return {
397
- beforeAll: [],
398
- afterAll: [],
399
- beforeEach: [],
400
- afterEach: []
401
- };
502
+ return {
503
+ beforeAll: [],
504
+ afterAll: [],
505
+ beforeEach: [],
506
+ afterEach: []
507
+ };
402
508
  }
403
509
  function parseArguments(optionsOrFn, optionsOrTest) {
404
- let options = {};
405
- let fn = () => {
406
- };
407
- if (typeof optionsOrTest === "object") {
408
- if (typeof optionsOrFn === "object") {
409
- throw new TypeError(
410
- "Cannot use two objects as arguments. Please provide options and a function callback in that order."
411
- );
412
- }
413
- console.warn(
414
- "Using an object as a third argument is deprecated. Vitest 4 will throw an error if the third argument is not a timeout number. Please use the second argument for options. See more at https://vitest.dev/guide/migration"
415
- );
416
- options = optionsOrTest;
417
- } else if (typeof optionsOrTest === "number") {
418
- options = { timeout: optionsOrTest };
419
- } else if (typeof optionsOrFn === "object") {
420
- options = optionsOrFn;
421
- }
422
- if (typeof optionsOrFn === "function") {
423
- if (typeof optionsOrTest === "function") {
424
- throw new TypeError(
425
- "Cannot use two functions as arguments. Please use the second argument for options."
426
- );
427
- }
428
- fn = optionsOrFn;
429
- } else if (typeof optionsOrTest === "function") {
430
- fn = optionsOrTest;
431
- }
432
- return {
433
- options,
434
- handler: fn
435
- };
436
- }
437
- function createSuiteCollector(name, factory = () => {
438
- }, mode, each, suiteOptions) {
439
- const tasks = [];
440
- let suite2;
441
- initSuite(true);
442
- const task = function(name2 = "", options = {}) {
443
- var _a;
444
- const timeout = (options == null ? void 0 : options.timeout) ?? runner.config.testTimeout;
445
- const task2 = {
446
- id: "",
447
- name: name2,
448
- suite: (_a = collectorContext.currentSuite) == null ? void 0 : _a.suite,
449
- each: options.each,
450
- fails: options.fails,
451
- context: void 0,
452
- type: "test",
453
- file: void 0,
454
- timeout,
455
- retry: options.retry ?? runner.config.retry,
456
- repeats: options.repeats,
457
- mode: options.only ? "only" : options.skip ? "skip" : options.todo ? "todo" : "run",
458
- meta: options.meta ?? /* @__PURE__ */ Object.create(null)
459
- };
460
- const handler = options.handler;
461
- if (options.concurrent || !options.sequential && runner.config.sequence.concurrent) {
462
- task2.concurrent = true;
463
- }
464
- task2.shuffle = suiteOptions == null ? void 0 : suiteOptions.shuffle;
465
- const context = createTestContext(task2, runner);
466
- Object.defineProperty(task2, "context", {
467
- value: context,
468
- enumerable: false
469
- });
470
- setFixture(context, options.fixtures);
471
- if (handler) {
472
- setFn(
473
- task2,
474
- withTimeout(
475
- withAwaitAsyncAssertions(withFixtures(handler, context), task2),
476
- timeout
477
- )
478
- );
479
- }
480
- if (runner.config.includeTaskLocation) {
481
- const limit = Error.stackTraceLimit;
482
- Error.stackTraceLimit = 15;
483
- const error = new Error("stacktrace").stack;
484
- Error.stackTraceLimit = limit;
485
- const stack = findTestFileStackTrace(error, task2.each ?? false);
486
- if (stack) {
487
- task2.location = stack;
488
- }
489
- }
490
- tasks.push(task2);
491
- return task2;
492
- };
493
- const test2 = createTest(function(name2, optionsOrFn, optionsOrTest) {
494
- let { options, handler } = parseArguments(optionsOrFn, optionsOrTest);
495
- if (typeof suiteOptions === "object") {
496
- options = Object.assign({}, suiteOptions, options);
497
- }
498
- options.concurrent = this.concurrent || !this.sequential && (options == null ? void 0 : options.concurrent);
499
- options.sequential = this.sequential || !this.concurrent && (options == null ? void 0 : options.sequential);
500
- const test3 = task(formatName(name2), {
501
- ...this,
502
- ...options,
503
- handler
504
- });
505
- test3.type = "test";
506
- });
507
- const collector = {
508
- type: "collector",
509
- name,
510
- mode,
511
- suite: suite2,
512
- options: suiteOptions,
513
- test: test2,
514
- tasks,
515
- collect,
516
- task,
517
- clear,
518
- on: addHook
519
- };
520
- function addHook(name2, ...fn) {
521
- getHooks(suite2)[name2].push(...fn);
522
- }
523
- function initSuite(includeLocation) {
524
- var _a;
525
- if (typeof suiteOptions === "number") {
526
- suiteOptions = { timeout: suiteOptions };
527
- }
528
- suite2 = {
529
- id: "",
530
- type: "suite",
531
- name,
532
- suite: (_a = collectorContext.currentSuite) == null ? void 0 : _a.suite,
533
- mode,
534
- each,
535
- file: void 0,
536
- shuffle: suiteOptions == null ? void 0 : suiteOptions.shuffle,
537
- tasks: [],
538
- meta: /* @__PURE__ */ Object.create(null),
539
- concurrent: suiteOptions == null ? void 0 : suiteOptions.concurrent
540
- };
541
- if (runner && includeLocation && runner.config.includeTaskLocation) {
542
- const limit = Error.stackTraceLimit;
543
- Error.stackTraceLimit = 15;
544
- const error = new Error("stacktrace").stack;
545
- Error.stackTraceLimit = limit;
546
- const stack = findTestFileStackTrace(error, suite2.each ?? false);
547
- if (stack) {
548
- suite2.location = stack;
549
- }
550
- }
551
- setHooks(suite2, createSuiteHooks());
552
- }
553
- function clear() {
554
- tasks.length = 0;
555
- initSuite(false);
556
- }
557
- async function collect(file) {
558
- if (!file) {
559
- throw new TypeError("File is required to collect tasks.");
560
- }
561
- if (factory) {
562
- await runWithSuite(collector, () => factory(test2));
563
- }
564
- const allChildren = [];
565
- for (const i of tasks) {
566
- allChildren.push(i.type === "collector" ? await i.collect(file) : i);
567
- }
568
- suite2.file = file;
569
- suite2.tasks = allChildren;
570
- allChildren.forEach((task2) => {
571
- task2.file = file;
572
- });
573
- return suite2;
574
- }
575
- collectTask(collector);
576
- return collector;
510
+ let options = {};
511
+ let fn = () => {};
512
+ if (typeof optionsOrTest === "object") {
513
+ if (typeof optionsOrFn === "object") {
514
+ throw new TypeError("Cannot use two objects as arguments. Please provide options and a function callback in that order.");
515
+ }
516
+ console.warn("Using an object as a third argument is deprecated. Vitest 4 will throw an error if the third argument is not a timeout number. Please use the second argument for options. See more at https://vitest.dev/guide/migration");
517
+ options = optionsOrTest;
518
+ } else if (typeof optionsOrTest === "number") {
519
+ options = { timeout: optionsOrTest };
520
+ } else if (typeof optionsOrFn === "object") {
521
+ options = optionsOrFn;
522
+ }
523
+ if (typeof optionsOrFn === "function") {
524
+ if (typeof optionsOrTest === "function") {
525
+ throw new TypeError("Cannot use two functions as arguments. Please use the second argument for options.");
526
+ }
527
+ fn = optionsOrFn;
528
+ } else if (typeof optionsOrTest === "function") {
529
+ fn = optionsOrTest;
530
+ }
531
+ return {
532
+ options,
533
+ handler: fn
534
+ };
535
+ }
536
+ function createSuiteCollector(name, factory = () => {}, mode, each, suiteOptions) {
537
+ const tasks = [];
538
+ let suite;
539
+ initSuite(true);
540
+ const task = function(name = "", options = {}) {
541
+ var _collectorContext$cur;
542
+ const timeout = (options === null || options === void 0 ? void 0 : options.timeout) ?? runner.config.testTimeout;
543
+ const task = {
544
+ id: "",
545
+ name,
546
+ suite: (_collectorContext$cur = collectorContext.currentSuite) === null || _collectorContext$cur === void 0 ? void 0 : _collectorContext$cur.suite,
547
+ each: options.each,
548
+ fails: options.fails,
549
+ context: undefined,
550
+ type: "test",
551
+ file: undefined,
552
+ timeout,
553
+ retry: options.retry ?? runner.config.retry,
554
+ repeats: options.repeats,
555
+ mode: options.only ? "only" : options.skip ? "skip" : options.todo ? "todo" : "run",
556
+ meta: options.meta ?? Object.create(null)
557
+ };
558
+ const handler = options.handler;
559
+ if (options.concurrent || !options.sequential && runner.config.sequence.concurrent) {
560
+ task.concurrent = true;
561
+ }
562
+ task.shuffle = suiteOptions === null || suiteOptions === void 0 ? void 0 : suiteOptions.shuffle;
563
+ const context = createTestContext(task, runner);
564
+ Object.defineProperty(task, "context", {
565
+ value: context,
566
+ enumerable: false
567
+ });
568
+ setTestFixture(context, options.fixtures);
569
+ if (handler) {
570
+ setFn(task, withTimeout(withAwaitAsyncAssertions(withFixtures(handler, context), task), timeout));
571
+ }
572
+ if (runner.config.includeTaskLocation) {
573
+ const limit = Error.stackTraceLimit;
574
+ Error.stackTraceLimit = 15;
575
+ const error = new Error("stacktrace").stack;
576
+ Error.stackTraceLimit = limit;
577
+ const stack = findTestFileStackTrace(error, task.each ?? false);
578
+ if (stack) {
579
+ task.location = stack;
580
+ }
581
+ }
582
+ tasks.push(task);
583
+ return task;
584
+ };
585
+ const test = createTest(function(name, optionsOrFn, optionsOrTest) {
586
+ let { options, handler } = parseArguments(optionsOrFn, optionsOrTest);
587
+ if (typeof suiteOptions === "object") {
588
+ options = Object.assign({}, suiteOptions, options);
589
+ }
590
+ options.concurrent = this.concurrent || !this.sequential && (options === null || options === void 0 ? void 0 : options.concurrent);
591
+ options.sequential = this.sequential || !this.concurrent && (options === null || options === void 0 ? void 0 : options.sequential);
592
+ const test = task(formatName(name), {
593
+ ...this,
594
+ ...options,
595
+ handler
596
+ });
597
+ test.type = "test";
598
+ });
599
+ let collectorFixtures;
600
+ const collector = {
601
+ type: "collector",
602
+ name,
603
+ mode,
604
+ suite,
605
+ options: suiteOptions,
606
+ test,
607
+ tasks,
608
+ collect,
609
+ task,
610
+ clear,
611
+ on: addHook,
612
+ fixtures() {
613
+ return collectorFixtures;
614
+ },
615
+ scoped(fixtures) {
616
+ const parsed = mergeContextFixtures(fixtures, { fixtures: collectorFixtures }, (key) => {
617
+ var _getRunner$injectValu, _getRunner;
618
+ return (_getRunner$injectValu = (_getRunner = getRunner()).injectValue) === null || _getRunner$injectValu === void 0 ? void 0 : _getRunner$injectValu.call(_getRunner, key);
619
+ });
620
+ if (parsed.fixtures) {
621
+ collectorFixtures = parsed.fixtures;
622
+ }
623
+ }
624
+ };
625
+ function addHook(name, ...fn) {
626
+ getHooks(suite)[name].push(...fn);
627
+ }
628
+ function initSuite(includeLocation) {
629
+ var _collectorContext$cur2;
630
+ if (typeof suiteOptions === "number") {
631
+ suiteOptions = { timeout: suiteOptions };
632
+ }
633
+ suite = {
634
+ id: "",
635
+ type: "suite",
636
+ name,
637
+ suite: (_collectorContext$cur2 = collectorContext.currentSuite) === null || _collectorContext$cur2 === void 0 ? void 0 : _collectorContext$cur2.suite,
638
+ mode,
639
+ each,
640
+ file: undefined,
641
+ shuffle: suiteOptions === null || suiteOptions === void 0 ? void 0 : suiteOptions.shuffle,
642
+ tasks: [],
643
+ meta: Object.create(null),
644
+ concurrent: suiteOptions === null || suiteOptions === void 0 ? void 0 : suiteOptions.concurrent
645
+ };
646
+ if (runner && includeLocation && runner.config.includeTaskLocation) {
647
+ const limit = Error.stackTraceLimit;
648
+ Error.stackTraceLimit = 15;
649
+ const error = new Error("stacktrace").stack;
650
+ Error.stackTraceLimit = limit;
651
+ const stack = findTestFileStackTrace(error, suite.each ?? false);
652
+ if (stack) {
653
+ suite.location = stack;
654
+ }
655
+ }
656
+ setHooks(suite, createSuiteHooks());
657
+ }
658
+ function clear() {
659
+ tasks.length = 0;
660
+ initSuite(false);
661
+ }
662
+ async function collect(file) {
663
+ if (!file) {
664
+ throw new TypeError("File is required to collect tasks.");
665
+ }
666
+ if (factory) {
667
+ await runWithSuite(collector, () => factory(test));
668
+ }
669
+ const allChildren = [];
670
+ for (const i of tasks) {
671
+ allChildren.push(i.type === "collector" ? await i.collect(file) : i);
672
+ }
673
+ suite.file = file;
674
+ suite.tasks = allChildren;
675
+ allChildren.forEach((task) => {
676
+ task.file = file;
677
+ });
678
+ return suite;
679
+ }
680
+ collectTask(collector);
681
+ return collector;
577
682
  }
578
683
  function withAwaitAsyncAssertions(fn, task) {
579
- return async (...args) => {
580
- const fnResult = await fn(...args);
581
- if (task.promises) {
582
- const result = await Promise.allSettled(task.promises);
583
- const errors = result.map((r) => r.status === "rejected" ? r.reason : void 0).filter(Boolean);
584
- if (errors.length) {
585
- throw errors;
586
- }
587
- }
588
- return fnResult;
589
- };
684
+ return async (...args) => {
685
+ const fnResult = await fn(...args);
686
+ if (task.promises) {
687
+ const result = await Promise.allSettled(task.promises);
688
+ const errors = result.map((r) => r.status === "rejected" ? r.reason : undefined).filter(Boolean);
689
+ if (errors.length) {
690
+ throw errors;
691
+ }
692
+ }
693
+ return fnResult;
694
+ };
590
695
  }
591
696
  function createSuite() {
592
- function suiteFn(name, factoryOrOptions, optionsOrFactory) {
593
- var _a;
594
- const mode = this.only ? "only" : this.skip ? "skip" : this.todo ? "todo" : "run";
595
- const currentSuite = collectorContext.currentSuite || defaultSuite;
596
- let { options, handler: factory } = parseArguments(
597
- factoryOrOptions,
598
- optionsOrFactory
599
- );
600
- const isConcurrentSpecified = options.concurrent || this.concurrent || options.sequential === false;
601
- const isSequentialSpecified = options.sequential || this.sequential || options.concurrent === false;
602
- options = {
603
- ...currentSuite == null ? void 0 : currentSuite.options,
604
- ...options,
605
- shuffle: this.shuffle ?? options.shuffle ?? ((_a = currentSuite == null ? void 0 : currentSuite.options) == null ? void 0 : _a.shuffle) ?? (runner == null ? void 0 : runner.config.sequence.shuffle)
606
- };
607
- const isConcurrent = isConcurrentSpecified || options.concurrent && !isSequentialSpecified;
608
- const isSequential = isSequentialSpecified || options.sequential && !isConcurrentSpecified;
609
- options.concurrent = isConcurrent && !isSequential;
610
- options.sequential = isSequential && !isConcurrent;
611
- return createSuiteCollector(
612
- formatName(name),
613
- factory,
614
- mode,
615
- this.each,
616
- options
617
- );
618
- }
619
- suiteFn.each = function(cases, ...args) {
620
- const suite2 = this.withContext();
621
- this.setContext("each", true);
622
- if (Array.isArray(cases) && args.length) {
623
- cases = formatTemplateString(cases, args);
624
- }
625
- return (name, optionsOrFn, fnOrOptions) => {
626
- const _name = formatName(name);
627
- const arrayOnlyCases = cases.every(Array.isArray);
628
- const { options, handler } = parseArguments(optionsOrFn, fnOrOptions);
629
- const fnFirst = typeof optionsOrFn === "function" && typeof fnOrOptions === "object";
630
- cases.forEach((i, idx) => {
631
- const items = Array.isArray(i) ? i : [i];
632
- if (fnFirst) {
633
- if (arrayOnlyCases) {
634
- suite2(
635
- formatTitle(_name, items, idx),
636
- () => handler(...items),
637
- options
638
- );
639
- } else {
640
- suite2(formatTitle(_name, items, idx), () => handler(i), options);
641
- }
642
- } else {
643
- if (arrayOnlyCases) {
644
- suite2(formatTitle(_name, items, idx), options, () => handler(...items));
645
- } else {
646
- suite2(formatTitle(_name, items, idx), options, () => handler(i));
647
- }
648
- }
649
- });
650
- this.setContext("each", void 0);
651
- };
652
- };
653
- suiteFn.for = function(cases, ...args) {
654
- if (Array.isArray(cases) && args.length) {
655
- cases = formatTemplateString(cases, args);
656
- }
657
- return (name, optionsOrFn, fnOrOptions) => {
658
- const name_ = formatName(name);
659
- const { options, handler } = parseArguments(optionsOrFn, fnOrOptions);
660
- cases.forEach((item, idx) => {
661
- suite(formatTitle(name_, toArray(item), idx), options, () => handler(item));
662
- });
663
- };
664
- };
665
- suiteFn.skipIf = (condition) => condition ? suite.skip : suite;
666
- suiteFn.runIf = (condition) => condition ? suite : suite.skip;
667
- return createChainable(
668
- ["concurrent", "sequential", "shuffle", "skip", "only", "todo"],
669
- suiteFn
670
- );
697
+ function suiteFn(name, factoryOrOptions, optionsOrFactory) {
698
+ var _currentSuite$options;
699
+ const mode = this.only ? "only" : this.skip ? "skip" : this.todo ? "todo" : "run";
700
+ const currentSuite = collectorContext.currentSuite || defaultSuite;
701
+ let { options, handler: factory } = parseArguments(factoryOrOptions, optionsOrFactory);
702
+ const isConcurrentSpecified = options.concurrent || this.concurrent || options.sequential === false;
703
+ const isSequentialSpecified = options.sequential || this.sequential || options.concurrent === false;
704
+ options = {
705
+ ...currentSuite === null || currentSuite === void 0 ? void 0 : currentSuite.options,
706
+ ...options,
707
+ shuffle: this.shuffle ?? options.shuffle ?? (currentSuite === null || currentSuite === void 0 || (_currentSuite$options = currentSuite.options) === null || _currentSuite$options === void 0 ? void 0 : _currentSuite$options.shuffle) ?? (runner === null || runner === void 0 ? void 0 : runner.config.sequence.shuffle)
708
+ };
709
+ const isConcurrent = isConcurrentSpecified || options.concurrent && !isSequentialSpecified;
710
+ const isSequential = isSequentialSpecified || options.sequential && !isConcurrentSpecified;
711
+ options.concurrent = isConcurrent && !isSequential;
712
+ options.sequential = isSequential && !isConcurrent;
713
+ return createSuiteCollector(formatName(name), factory, mode, this.each, options);
714
+ }
715
+ suiteFn.each = function(cases, ...args) {
716
+ const suite = this.withContext();
717
+ this.setContext("each", true);
718
+ if (Array.isArray(cases) && args.length) {
719
+ cases = formatTemplateString(cases, args);
720
+ }
721
+ return (name, optionsOrFn, fnOrOptions) => {
722
+ const _name = formatName(name);
723
+ const arrayOnlyCases = cases.every(Array.isArray);
724
+ const { options, handler } = parseArguments(optionsOrFn, fnOrOptions);
725
+ const fnFirst = typeof optionsOrFn === "function" && typeof fnOrOptions === "object";
726
+ cases.forEach((i, idx) => {
727
+ const items = Array.isArray(i) ? i : [i];
728
+ if (fnFirst) {
729
+ if (arrayOnlyCases) {
730
+ suite(formatTitle(_name, items, idx), () => handler(...items), options);
731
+ } else {
732
+ suite(formatTitle(_name, items, idx), () => handler(i), options);
733
+ }
734
+ } else {
735
+ if (arrayOnlyCases) {
736
+ suite(formatTitle(_name, items, idx), options, () => handler(...items));
737
+ } else {
738
+ suite(formatTitle(_name, items, idx), options, () => handler(i));
739
+ }
740
+ }
741
+ });
742
+ this.setContext("each", undefined);
743
+ };
744
+ };
745
+ suiteFn.for = function(cases, ...args) {
746
+ if (Array.isArray(cases) && args.length) {
747
+ cases = formatTemplateString(cases, args);
748
+ }
749
+ return (name, optionsOrFn, fnOrOptions) => {
750
+ const name_ = formatName(name);
751
+ const { options, handler } = parseArguments(optionsOrFn, fnOrOptions);
752
+ cases.forEach((item, idx) => {
753
+ suite(formatTitle(name_, toArray(item), idx), options, () => handler(item));
754
+ });
755
+ };
756
+ };
757
+ suiteFn.skipIf = (condition) => condition ? suite.skip : suite;
758
+ suiteFn.runIf = (condition) => condition ? suite : suite.skip;
759
+ return createChainable([
760
+ "concurrent",
761
+ "sequential",
762
+ "shuffle",
763
+ "skip",
764
+ "only",
765
+ "todo"
766
+ ], suiteFn);
671
767
  }
672
768
  function createTaskCollector(fn, context) {
673
- const taskFn = fn;
674
- taskFn.each = function(cases, ...args) {
675
- const test2 = this.withContext();
676
- this.setContext("each", true);
677
- if (Array.isArray(cases) && args.length) {
678
- cases = formatTemplateString(cases, args);
679
- }
680
- return (name, optionsOrFn, fnOrOptions) => {
681
- const _name = formatName(name);
682
- const arrayOnlyCases = cases.every(Array.isArray);
683
- const { options, handler } = parseArguments(optionsOrFn, fnOrOptions);
684
- const fnFirst = typeof optionsOrFn === "function" && typeof fnOrOptions === "object";
685
- cases.forEach((i, idx) => {
686
- const items = Array.isArray(i) ? i : [i];
687
- if (fnFirst) {
688
- if (arrayOnlyCases) {
689
- test2(
690
- formatTitle(_name, items, idx),
691
- () => handler(...items),
692
- options
693
- );
694
- } else {
695
- test2(formatTitle(_name, items, idx), () => handler(i), options);
696
- }
697
- } else {
698
- if (arrayOnlyCases) {
699
- test2(formatTitle(_name, items, idx), options, () => handler(...items));
700
- } else {
701
- test2(formatTitle(_name, items, idx), options, () => handler(i));
702
- }
703
- }
704
- });
705
- this.setContext("each", void 0);
706
- };
707
- };
708
- taskFn.for = function(cases, ...args) {
709
- const test2 = this.withContext();
710
- if (Array.isArray(cases) && args.length) {
711
- cases = formatTemplateString(cases, args);
712
- }
713
- return (name, optionsOrFn, fnOrOptions) => {
714
- const _name = formatName(name);
715
- const { options, handler } = parseArguments(optionsOrFn, fnOrOptions);
716
- cases.forEach((item, idx) => {
717
- const handlerWrapper = (ctx) => handler(item, ctx);
718
- handlerWrapper.__VITEST_FIXTURE_INDEX__ = 1;
719
- handlerWrapper.toString = () => handler.toString();
720
- test2(formatTitle(_name, toArray(item), idx), options, handlerWrapper);
721
- });
722
- };
723
- };
724
- taskFn.skipIf = function(condition) {
725
- return condition ? this.skip : this;
726
- };
727
- taskFn.runIf = function(condition) {
728
- return condition ? this : this.skip;
729
- };
730
- taskFn.extend = function(fixtures) {
731
- const _context = mergeContextFixtures(
732
- fixtures,
733
- context || {},
734
- (key) => {
735
- var _a, _b;
736
- return (_b = (_a = getRunner()).injectValue) == null ? void 0 : _b.call(_a, key);
737
- }
738
- );
739
- return createTest(function fn2(name, optionsOrFn, optionsOrTest) {
740
- getCurrentSuite().test.fn.call(
741
- this,
742
- formatName(name),
743
- optionsOrFn,
744
- optionsOrTest
745
- );
746
- }, _context);
747
- };
748
- const _test = createChainable(
749
- ["concurrent", "sequential", "skip", "only", "todo", "fails"],
750
- taskFn
751
- );
752
- if (context) {
753
- _test.mergeContext(context);
754
- }
755
- return _test;
769
+ const taskFn = fn;
770
+ taskFn.each = function(cases, ...args) {
771
+ const test = this.withContext();
772
+ this.setContext("each", true);
773
+ if (Array.isArray(cases) && args.length) {
774
+ cases = formatTemplateString(cases, args);
775
+ }
776
+ return (name, optionsOrFn, fnOrOptions) => {
777
+ const _name = formatName(name);
778
+ const arrayOnlyCases = cases.every(Array.isArray);
779
+ const { options, handler } = parseArguments(optionsOrFn, fnOrOptions);
780
+ const fnFirst = typeof optionsOrFn === "function" && typeof fnOrOptions === "object";
781
+ cases.forEach((i, idx) => {
782
+ const items = Array.isArray(i) ? i : [i];
783
+ if (fnFirst) {
784
+ if (arrayOnlyCases) {
785
+ test(formatTitle(_name, items, idx), () => handler(...items), options);
786
+ } else {
787
+ test(formatTitle(_name, items, idx), () => handler(i), options);
788
+ }
789
+ } else {
790
+ if (arrayOnlyCases) {
791
+ test(formatTitle(_name, items, idx), options, () => handler(...items));
792
+ } else {
793
+ test(formatTitle(_name, items, idx), options, () => handler(i));
794
+ }
795
+ }
796
+ });
797
+ this.setContext("each", undefined);
798
+ };
799
+ };
800
+ taskFn.for = function(cases, ...args) {
801
+ const test = this.withContext();
802
+ if (Array.isArray(cases) && args.length) {
803
+ cases = formatTemplateString(cases, args);
804
+ }
805
+ return (name, optionsOrFn, fnOrOptions) => {
806
+ const _name = formatName(name);
807
+ const { options, handler } = parseArguments(optionsOrFn, fnOrOptions);
808
+ cases.forEach((item, idx) => {
809
+ const handlerWrapper = (ctx) => handler(item, ctx);
810
+ handlerWrapper.__VITEST_FIXTURE_INDEX__ = 1;
811
+ handlerWrapper.toString = () => handler.toString();
812
+ test(formatTitle(_name, toArray(item), idx), options, handlerWrapper);
813
+ });
814
+ };
815
+ };
816
+ taskFn.skipIf = function(condition) {
817
+ return condition ? this.skip : this;
818
+ };
819
+ taskFn.runIf = function(condition) {
820
+ return condition ? this : this.skip;
821
+ };
822
+ taskFn.scoped = function(fixtures) {
823
+ const collector = getCurrentSuite();
824
+ collector.scoped(fixtures);
825
+ };
826
+ taskFn.extend = function(fixtures) {
827
+ const _context = mergeContextFixtures(fixtures, context || {}, (key) => {
828
+ var _getRunner$injectValu2, _getRunner2;
829
+ return (_getRunner$injectValu2 = (_getRunner2 = getRunner()).injectValue) === null || _getRunner$injectValu2 === void 0 ? void 0 : _getRunner$injectValu2.call(_getRunner2, key);
830
+ });
831
+ return createTest(function fn(name, optionsOrFn, optionsOrTest) {
832
+ const collector = getCurrentSuite();
833
+ const scopedFixtures = collector.fixtures();
834
+ if (scopedFixtures) {
835
+ this.fixtures = mergeScopedFixtures(this.fixtures || [], scopedFixtures);
836
+ }
837
+ collector.test.fn.call(this, formatName(name), optionsOrFn, optionsOrTest);
838
+ }, _context);
839
+ };
840
+ const _test = createChainable([
841
+ "concurrent",
842
+ "sequential",
843
+ "skip",
844
+ "only",
845
+ "todo",
846
+ "fails"
847
+ ], taskFn);
848
+ if (context) {
849
+ _test.mergeContext(context);
850
+ }
851
+ return _test;
756
852
  }
757
853
  function createTest(fn, context) {
758
- return createTaskCollector(fn, context);
854
+ return createTaskCollector(fn, context);
759
855
  }
760
856
  function formatName(name) {
761
- return typeof name === "string" ? name : typeof name === "function" ? name.name || "<anonymous>" : String(name);
857
+ return typeof name === "string" ? name : typeof name === "function" ? name.name || "<anonymous>" : String(name);
762
858
  }
763
859
  function formatTitle(template, items, idx) {
764
- if (template.includes("%#") || template.includes("%$")) {
765
- template = template.replace(/%%/g, "__vitest_escaped_%__").replace(/%#/g, `${idx}`).replace(/%\$/g, `${idx + 1}`).replace(/__vitest_escaped_%__/g, "%%");
766
- }
767
- const count = template.split("%").length - 1;
768
- if (template.includes("%f")) {
769
- const placeholders = template.match(/%f/g) || [];
770
- placeholders.forEach((_, i) => {
771
- if (isNegativeNaN(items[i]) || Object.is(items[i], -0)) {
772
- let occurrence = 0;
773
- template = template.replace(/%f/g, (match) => {
774
- occurrence++;
775
- return occurrence === i + 1 ? "-%f" : match;
776
- });
777
- }
778
- });
779
- }
780
- let formatted = format(template, ...items.slice(0, count));
781
- const isObjectItem = isObject(items[0]);
782
- formatted = formatted.replace(
783
- /\$([$\w.]+)/g,
784
- (_, key) => {
785
- var _a, _b;
786
- const isArrayKey = /^\d+$/.test(key);
787
- if (!isObjectItem && !isArrayKey) {
788
- return `$${key}`;
789
- }
790
- const arrayElement = isArrayKey ? objectAttr(items, key) : void 0;
791
- const value = isObjectItem ? objectAttr(items[0], key, arrayElement) : arrayElement;
792
- return objDisplay(value, {
793
- truncate: (_b = (_a = runner == null ? void 0 : runner.config) == null ? void 0 : _a.chaiConfig) == null ? void 0 : _b.truncateThreshold
794
- });
795
- }
796
- );
797
- return formatted;
860
+ if (template.includes("%#") || template.includes("%$")) {
861
+ template = template.replace(/%%/g, "__vitest_escaped_%__").replace(/%#/g, `${idx}`).replace(/%\$/g, `${idx + 1}`).replace(/__vitest_escaped_%__/g, "%%");
862
+ }
863
+ const count = template.split("%").length - 1;
864
+ if (template.includes("%f")) {
865
+ const placeholders = template.match(/%f/g) || [];
866
+ placeholders.forEach((_, i) => {
867
+ if (isNegativeNaN(items[i]) || Object.is(items[i], -0)) {
868
+ let occurrence = 0;
869
+ template = template.replace(/%f/g, (match) => {
870
+ occurrence++;
871
+ return occurrence === i + 1 ? "-%f" : match;
872
+ });
873
+ }
874
+ });
875
+ }
876
+ let formatted = format(template, ...items.slice(0, count));
877
+ const isObjectItem = isObject(items[0]);
878
+ formatted = formatted.replace(/\$([$\w.]+)/g, (_, key) => {
879
+ var _runner$config;
880
+ const isArrayKey = /^\d+$/.test(key);
881
+ if (!isObjectItem && !isArrayKey) {
882
+ return `$${key}`;
883
+ }
884
+ const arrayElement = isArrayKey ? objectAttr(items, key) : undefined;
885
+ const value = isObjectItem ? objectAttr(items[0], key, arrayElement) : arrayElement;
886
+ return objDisplay(value, { truncate: runner === null || runner === void 0 || (_runner$config = runner.config) === null || _runner$config === void 0 || (_runner$config = _runner$config.chaiConfig) === null || _runner$config === void 0 ? void 0 : _runner$config.truncateThreshold });
887
+ });
888
+ return formatted;
798
889
  }
799
890
  function formatTemplateString(cases, args) {
800
- const header = cases.join("").trim().replace(/ /g, "").split("\n").map((i) => i.split("|"))[0];
801
- const res = [];
802
- for (let i = 0; i < Math.floor(args.length / header.length); i++) {
803
- const oneCase = {};
804
- for (let j = 0; j < header.length; j++) {
805
- oneCase[header[j]] = args[i * header.length + j];
806
- }
807
- res.push(oneCase);
808
- }
809
- return res;
891
+ const header = cases.join("").trim().replace(/ /g, "").split("\n").map((i) => i.split("|"))[0];
892
+ const res = [];
893
+ for (let i = 0; i < Math.floor(args.length / header.length); i++) {
894
+ const oneCase = {};
895
+ for (let j = 0; j < header.length; j++) {
896
+ oneCase[header[j]] = args[i * header.length + j];
897
+ }
898
+ res.push(oneCase);
899
+ }
900
+ return res;
810
901
  }
811
902
  function findTestFileStackTrace(error, each) {
812
- const lines = error.split("\n").slice(1);
813
- for (const line of lines) {
814
- const stack = parseSingleStack(line);
815
- if (stack && stack.file === getTestFilepath()) {
816
- return {
817
- line: stack.line,
818
- /**
819
- * test.each([1, 2])('name')
820
- * ^ leads here, but should
821
- * ^ lead here
822
- * in source maps it's the same boundary, so it just points to the start of it
823
- */
824
- column: each ? stack.column + 1 : stack.column
825
- };
826
- }
827
- }
903
+ const lines = error.split("\n").slice(1);
904
+ for (const line of lines) {
905
+ const stack = parseSingleStack(line);
906
+ if (stack && stack.file === getTestFilepath()) {
907
+ return {
908
+ line: stack.line,
909
+ column: each ? stack.column + 1 : stack.column
910
+ };
911
+ }
912
+ }
828
913
  }
829
914
 
830
915
  function getDefaultHookTimeout() {
831
- return getRunner().config.hookTimeout;
916
+ return getRunner().config.hookTimeout;
832
917
  }
833
918
  const CLEANUP_TIMEOUT_KEY = Symbol.for("VITEST_CLEANUP_TIMEOUT");
834
919
  const CLEANUP_STACK_TRACE_KEY = Symbol.for("VITEST_CLEANUP_STACK_TRACE");
835
920
  function getBeforeHookCleanupCallback(hook, result) {
836
- if (typeof result === "function") {
837
- const timeout = CLEANUP_TIMEOUT_KEY in hook && typeof hook[CLEANUP_TIMEOUT_KEY] === "number" ? hook[CLEANUP_TIMEOUT_KEY] : getDefaultHookTimeout();
838
- const stackTraceError = CLEANUP_STACK_TRACE_KEY in hook && hook[CLEANUP_STACK_TRACE_KEY] instanceof Error ? hook[CLEANUP_STACK_TRACE_KEY] : void 0;
839
- return withTimeout(result, timeout, true, stackTraceError);
840
- }
841
- }
921
+ if (typeof result === "function") {
922
+ const timeout = CLEANUP_TIMEOUT_KEY in hook && typeof hook[CLEANUP_TIMEOUT_KEY] === "number" ? hook[CLEANUP_TIMEOUT_KEY] : getDefaultHookTimeout();
923
+ const stackTraceError = CLEANUP_STACK_TRACE_KEY in hook && hook[CLEANUP_STACK_TRACE_KEY] instanceof Error ? hook[CLEANUP_STACK_TRACE_KEY] : undefined;
924
+ return withTimeout(result, timeout, true, stackTraceError);
925
+ }
926
+ }
927
+ /**
928
+ * Registers a callback function to be executed once before all tests within the current suite.
929
+ * This hook is useful for scenarios where you need to perform setup operations that are common to all tests in a suite, such as initializing a database connection or setting up a test environment.
930
+ *
931
+ * **Note:** The `beforeAll` hooks are executed in the order they are defined one after another. You can configure this by changing the `sequence.hooks` option in the config file.
932
+ *
933
+ * @param {Function} fn - The callback function to be executed before all tests.
934
+ * @param {number} [timeout] - Optional timeout in milliseconds for the hook. If not provided, the default hook timeout from the runner's configuration is used.
935
+ * @returns {void}
936
+ * @example
937
+ * ```ts
938
+ * // Example of using beforeAll to set up a database connection
939
+ * beforeAll(async () => {
940
+ * await database.connect();
941
+ * });
942
+ * ```
943
+ */
842
944
  function beforeAll(fn, timeout = getDefaultHookTimeout()) {
843
- assertTypes(fn, '"beforeAll" callback', ["function"]);
844
- const stackTraceError = new Error("STACK_TRACE_ERROR");
845
- return getCurrentSuite().on(
846
- "beforeAll",
847
- Object.assign(
848
- withTimeout(
849
- fn,
850
- timeout,
851
- true,
852
- stackTraceError
853
- ),
854
- {
855
- [CLEANUP_TIMEOUT_KEY]: timeout,
856
- [CLEANUP_STACK_TRACE_KEY]: stackTraceError
857
- }
858
- )
859
- );
860
- }
945
+ assertTypes(fn, "\"beforeAll\" callback", ["function"]);
946
+ const stackTraceError = new Error("STACK_TRACE_ERROR");
947
+ return getCurrentSuite().on("beforeAll", Object.assign(withTimeout(fn, timeout, true, stackTraceError), {
948
+ [CLEANUP_TIMEOUT_KEY]: timeout,
949
+ [CLEANUP_STACK_TRACE_KEY]: stackTraceError
950
+ }));
951
+ }
952
+ /**
953
+ * Registers a callback function to be executed once after all tests within the current suite have completed.
954
+ * This hook is useful for scenarios where you need to perform cleanup operations after all tests in a suite have run, such as closing database connections or cleaning up temporary files.
955
+ *
956
+ * **Note:** The `afterAll` hooks are running in reverse order of their registration. You can configure this by changing the `sequence.hooks` option in the config file.
957
+ *
958
+ * @param {Function} fn - The callback function to be executed after all tests.
959
+ * @param {number} [timeout] - Optional timeout in milliseconds for the hook. If not provided, the default hook timeout from the runner's configuration is used.
960
+ * @returns {void}
961
+ * @example
962
+ * ```ts
963
+ * // Example of using afterAll to close a database connection
964
+ * afterAll(async () => {
965
+ * await database.disconnect();
966
+ * });
967
+ * ```
968
+ */
861
969
  function afterAll(fn, timeout) {
862
- assertTypes(fn, '"afterAll" callback', ["function"]);
863
- return getCurrentSuite().on(
864
- "afterAll",
865
- withTimeout(
866
- fn,
867
- timeout ?? getDefaultHookTimeout(),
868
- true,
869
- new Error("STACK_TRACE_ERROR")
870
- )
871
- );
872
- }
970
+ assertTypes(fn, "\"afterAll\" callback", ["function"]);
971
+ return getCurrentSuite().on("afterAll", withTimeout(fn, timeout ?? getDefaultHookTimeout(), true, new Error("STACK_TRACE_ERROR")));
972
+ }
973
+ /**
974
+ * Registers a callback function to be executed before each test within the current suite.
975
+ * This hook is useful for scenarios where you need to reset or reinitialize the test environment before each test runs, such as resetting database states, clearing caches, or reinitializing variables.
976
+ *
977
+ * **Note:** The `beforeEach` hooks are executed in the order they are defined one after another. You can configure this by changing the `sequence.hooks` option in the config file.
978
+ *
979
+ * @param {Function} fn - The callback function to be executed before each test. This function receives an `TestContext` parameter if additional test context is needed.
980
+ * @param {number} [timeout] - Optional timeout in milliseconds for the hook. If not provided, the default hook timeout from the runner's configuration is used.
981
+ * @returns {void}
982
+ * @example
983
+ * ```ts
984
+ * // Example of using beforeEach to reset a database state
985
+ * beforeEach(async () => {
986
+ * await database.reset();
987
+ * });
988
+ * ```
989
+ */
873
990
  function beforeEach(fn, timeout = getDefaultHookTimeout()) {
874
- assertTypes(fn, '"beforeEach" callback', ["function"]);
875
- const stackTraceError = new Error("STACK_TRACE_ERROR");
876
- return getCurrentSuite().on(
877
- "beforeEach",
878
- Object.assign(
879
- withTimeout(
880
- withFixtures(fn),
881
- timeout ?? getDefaultHookTimeout(),
882
- true,
883
- stackTraceError
884
- ),
885
- {
886
- [CLEANUP_TIMEOUT_KEY]: timeout,
887
- [CLEANUP_STACK_TRACE_KEY]: stackTraceError
888
- }
889
- )
890
- );
891
- }
991
+ assertTypes(fn, "\"beforeEach\" callback", ["function"]);
992
+ const stackTraceError = new Error("STACK_TRACE_ERROR");
993
+ return getCurrentSuite().on("beforeEach", Object.assign(withTimeout(withFixtures(fn), timeout ?? getDefaultHookTimeout(), true, stackTraceError), {
994
+ [CLEANUP_TIMEOUT_KEY]: timeout,
995
+ [CLEANUP_STACK_TRACE_KEY]: stackTraceError
996
+ }));
997
+ }
998
+ /**
999
+ * Registers a callback function to be executed after each test within the current suite has completed.
1000
+ * This hook is useful for scenarios where you need to clean up or reset the test environment after each test runs, such as deleting temporary files, clearing test-specific database entries, or resetting mocked functions.
1001
+ *
1002
+ * **Note:** The `afterEach` hooks are running in reverse order of their registration. You can configure this by changing the `sequence.hooks` option in the config file.
1003
+ *
1004
+ * @param {Function} fn - The callback function to be executed after each test. This function receives an `TestContext` parameter if additional test context is needed.
1005
+ * @param {number} [timeout] - Optional timeout in milliseconds for the hook. If not provided, the default hook timeout from the runner's configuration is used.
1006
+ * @returns {void}
1007
+ * @example
1008
+ * ```ts
1009
+ * // Example of using afterEach to delete temporary files created during a test
1010
+ * afterEach(async () => {
1011
+ * await fileSystem.deleteTempFiles();
1012
+ * });
1013
+ * ```
1014
+ */
892
1015
  function afterEach(fn, timeout) {
893
- assertTypes(fn, '"afterEach" callback', ["function"]);
894
- return getCurrentSuite().on(
895
- "afterEach",
896
- withTimeout(
897
- withFixtures(fn),
898
- timeout ?? getDefaultHookTimeout(),
899
- true,
900
- new Error("STACK_TRACE_ERROR")
901
- )
902
- );
903
- }
904
- const onTestFailed = createTestHook(
905
- "onTestFailed",
906
- (test, handler, timeout) => {
907
- test.onFailed || (test.onFailed = []);
908
- test.onFailed.push(
909
- withTimeout(
910
- handler,
911
- timeout ?? getDefaultHookTimeout(),
912
- true,
913
- new Error("STACK_TRACE_ERROR")
914
- )
915
- );
916
- }
917
- );
918
- const onTestFinished = createTestHook(
919
- "onTestFinished",
920
- (test, handler, timeout) => {
921
- test.onFinished || (test.onFinished = []);
922
- test.onFinished.push(
923
- withTimeout(
924
- handler,
925
- timeout ?? getDefaultHookTimeout(),
926
- true,
927
- new Error("STACK_TRACE_ERROR")
928
- )
929
- );
930
- }
931
- );
1016
+ assertTypes(fn, "\"afterEach\" callback", ["function"]);
1017
+ return getCurrentSuite().on("afterEach", withTimeout(withFixtures(fn), timeout ?? getDefaultHookTimeout(), true, new Error("STACK_TRACE_ERROR")));
1018
+ }
1019
+ /**
1020
+ * Registers a callback function to be executed when a test fails within the current suite.
1021
+ * This function allows for custom actions to be performed in response to test failures, such as logging, cleanup, or additional diagnostics.
1022
+ *
1023
+ * **Note:** The `onTestFailed` hooks are running in reverse order of their registration. You can configure this by changing the `sequence.hooks` option in the config file.
1024
+ *
1025
+ * @param {Function} fn - The callback function to be executed upon a test failure. The function receives the test result (including errors).
1026
+ * @param {number} [timeout] - Optional timeout in milliseconds for the hook. If not provided, the default hook timeout from the runner's configuration is used.
1027
+ * @throws {Error} Throws an error if the function is not called within a test.
1028
+ * @returns {void}
1029
+ * @example
1030
+ * ```ts
1031
+ * // Example of using onTestFailed to log failure details
1032
+ * onTestFailed(({ errors }) => {
1033
+ * console.log(`Test failed: ${test.name}`, errors);
1034
+ * });
1035
+ * ```
1036
+ */
1037
+ const onTestFailed = createTestHook("onTestFailed", (test, handler, timeout) => {
1038
+ test.onFailed || (test.onFailed = []);
1039
+ test.onFailed.push(withTimeout(handler, timeout ?? getDefaultHookTimeout(), true, new Error("STACK_TRACE_ERROR")));
1040
+ });
1041
+ /**
1042
+ * Registers a callback function to be executed when the current test finishes, regardless of the outcome (pass or fail).
1043
+ * This function is ideal for performing actions that should occur after every test execution, such as cleanup, logging, or resetting shared resources.
1044
+ *
1045
+ * This hook is useful if you have access to a resource in the test itself and you want to clean it up after the test finishes. It is a more compact way to clean up resources than using the combination of `beforeEach` and `afterEach`.
1046
+ *
1047
+ * **Note:** The `onTestFinished` hooks are running in reverse order of their registration. You can configure this by changing the `sequence.hooks` option in the config file.
1048
+ *
1049
+ * **Note:** The `onTestFinished` hook is not called if the test is canceled with a dynamic `ctx.skip()` call.
1050
+ *
1051
+ * @param {Function} fn - The callback function to be executed after a test finishes. The function can receive parameters providing details about the completed test, including its success or failure status.
1052
+ * @param {number} [timeout] - Optional timeout in milliseconds for the hook. If not provided, the default hook timeout from the runner's configuration is used.
1053
+ * @throws {Error} Throws an error if the function is not called within a test.
1054
+ * @returns {void}
1055
+ * @example
1056
+ * ```ts
1057
+ * // Example of using onTestFinished for cleanup
1058
+ * const db = await connectToDatabase();
1059
+ * onTestFinished(async () => {
1060
+ * await db.disconnect();
1061
+ * });
1062
+ * ```
1063
+ */
1064
+ const onTestFinished = createTestHook("onTestFinished", (test, handler, timeout) => {
1065
+ test.onFinished || (test.onFinished = []);
1066
+ test.onFinished.push(withTimeout(handler, timeout ?? getDefaultHookTimeout(), true, new Error("STACK_TRACE_ERROR")));
1067
+ });
932
1068
  function createTestHook(name, handler) {
933
- return (fn, timeout) => {
934
- assertTypes(fn, `"${name}" callback`, ["function"]);
935
- const current = getCurrentTest();
936
- if (!current) {
937
- throw new Error(`Hook ${name}() can only be called inside a test`);
938
- }
939
- return handler(current, fn, timeout);
940
- };
1069
+ return (fn, timeout) => {
1070
+ assertTypes(fn, `"${name}" callback`, ["function"]);
1071
+ const current = getCurrentTest();
1072
+ if (!current) {
1073
+ throw new Error(`Hook ${name}() can only be called inside a test`);
1074
+ }
1075
+ return handler(current, fn, timeout);
1076
+ };
941
1077
  }
942
1078
 
943
1079
  async function runSetupFiles(config, files, runner) {
944
- if (config.sequence.setupFiles === "parallel") {
945
- await Promise.all(
946
- files.map(async (fsPath) => {
947
- await runner.importFile(fsPath, "setup");
948
- })
949
- );
950
- } else {
951
- for (const fsPath of files) {
952
- await runner.importFile(fsPath, "setup");
953
- }
954
- }
1080
+ if (config.sequence.setupFiles === "parallel") {
1081
+ await Promise.all(files.map(async (fsPath) => {
1082
+ await runner.importFile(fsPath, "setup");
1083
+ }));
1084
+ } else {
1085
+ for (const fsPath of files) {
1086
+ await runner.importFile(fsPath, "setup");
1087
+ }
1088
+ }
955
1089
  }
956
1090
 
957
1091
  const now$1 = globalThis.performance ? globalThis.performance.now.bind(globalThis.performance) : Date.now;
958
1092
  async function collectTests(specs, runner) {
959
- var _a;
960
- const files = [];
961
- const config = runner.config;
962
- for (const spec of specs) {
963
- const filepath = typeof spec === "string" ? spec : spec.filepath;
964
- const testLocations = typeof spec === "string" ? void 0 : spec.testLocations;
965
- const file = createFileTask(filepath, config.root, config.name, runner.pool);
966
- file.shuffle = config.sequence.shuffle;
967
- (_a = runner.onCollectStart) == null ? void 0 : _a.call(runner, file);
968
- clearCollectorContext(filepath, runner);
969
- try {
970
- const setupFiles = toArray(config.setupFiles);
971
- if (setupFiles.length) {
972
- const setupStart = now$1();
973
- await runSetupFiles(config, setupFiles, runner);
974
- const setupEnd = now$1();
975
- file.setupDuration = setupEnd - setupStart;
976
- } else {
977
- file.setupDuration = 0;
978
- }
979
- const collectStart = now$1();
980
- await runner.importFile(filepath, "collect");
981
- const defaultTasks = await getDefaultSuite().collect(file);
982
- const fileHooks = createSuiteHooks();
983
- mergeHooks(fileHooks, getHooks(defaultTasks));
984
- for (const c of [...defaultTasks.tasks, ...collectorContext.tasks]) {
985
- if (c.type === "test" || c.type === "suite") {
986
- file.tasks.push(c);
987
- } else if (c.type === "collector") {
988
- const suite = await c.collect(file);
989
- if (suite.name || suite.tasks.length) {
990
- mergeHooks(fileHooks, getHooks(suite));
991
- file.tasks.push(suite);
992
- }
993
- } else {
994
- c;
995
- }
996
- }
997
- setHooks(file, fileHooks);
998
- file.collectDuration = now$1() - collectStart;
999
- } catch (e) {
1000
- const error = processError(e);
1001
- file.result = {
1002
- state: "fail",
1003
- errors: [error]
1004
- };
1005
- }
1006
- calculateSuiteHash(file);
1007
- const hasOnlyTasks = someTasksAreOnly(file);
1008
- interpretTaskModes(
1009
- file,
1010
- config.testNamePattern,
1011
- testLocations,
1012
- hasOnlyTasks,
1013
- false,
1014
- config.allowOnly
1015
- );
1016
- if (file.mode === "queued") {
1017
- file.mode = "run";
1018
- }
1019
- files.push(file);
1020
- }
1021
- return files;
1093
+ const files = [];
1094
+ const config = runner.config;
1095
+ for (const spec of specs) {
1096
+ var _runner$onCollectStar;
1097
+ const filepath = typeof spec === "string" ? spec : spec.filepath;
1098
+ const testLocations = typeof spec === "string" ? undefined : spec.testLocations;
1099
+ const file = createFileTask(filepath, config.root, config.name, runner.pool);
1100
+ file.shuffle = config.sequence.shuffle;
1101
+ (_runner$onCollectStar = runner.onCollectStart) === null || _runner$onCollectStar === void 0 ? void 0 : _runner$onCollectStar.call(runner, file);
1102
+ clearCollectorContext(filepath, runner);
1103
+ try {
1104
+ const setupFiles = toArray(config.setupFiles);
1105
+ if (setupFiles.length) {
1106
+ const setupStart = now$1();
1107
+ await runSetupFiles(config, setupFiles, runner);
1108
+ const setupEnd = now$1();
1109
+ file.setupDuration = setupEnd - setupStart;
1110
+ } else {
1111
+ file.setupDuration = 0;
1112
+ }
1113
+ const collectStart = now$1();
1114
+ await runner.importFile(filepath, "collect");
1115
+ const defaultTasks = await getDefaultSuite().collect(file);
1116
+ const fileHooks = createSuiteHooks();
1117
+ mergeHooks(fileHooks, getHooks(defaultTasks));
1118
+ for (const c of [...defaultTasks.tasks, ...collectorContext.tasks]) {
1119
+ if (c.type === "test" || c.type === "suite") {
1120
+ file.tasks.push(c);
1121
+ } else if (c.type === "collector") {
1122
+ const suite = await c.collect(file);
1123
+ if (suite.name || suite.tasks.length) {
1124
+ mergeHooks(fileHooks, getHooks(suite));
1125
+ file.tasks.push(suite);
1126
+ }
1127
+ } else {
1128
+ c;
1129
+ }
1130
+ }
1131
+ setHooks(file, fileHooks);
1132
+ file.collectDuration = now$1() - collectStart;
1133
+ } catch (e) {
1134
+ const error = processError(e);
1135
+ file.result = {
1136
+ state: "fail",
1137
+ errors: [error]
1138
+ };
1139
+ }
1140
+ calculateSuiteHash(file);
1141
+ const hasOnlyTasks = someTasksAreOnly(file);
1142
+ interpretTaskModes(file, config.testNamePattern, testLocations, hasOnlyTasks, false, config.allowOnly);
1143
+ if (file.mode === "queued") {
1144
+ file.mode = "run";
1145
+ }
1146
+ files.push(file);
1147
+ }
1148
+ return files;
1022
1149
  }
1023
1150
  function mergeHooks(baseHooks, hooks) {
1024
- for (const _key in hooks) {
1025
- const key = _key;
1026
- baseHooks[key].push(...hooks[key]);
1027
- }
1028
- return baseHooks;
1151
+ for (const _key in hooks) {
1152
+ const key = _key;
1153
+ baseHooks[key].push(...hooks[key]);
1154
+ }
1155
+ return baseHooks;
1029
1156
  }
1030
1157
 
1031
1158
  const now = globalThis.performance ? globalThis.performance.now.bind(globalThis.performance) : Date.now;
1032
1159
  const unixNow = Date.now;
1033
1160
  function updateSuiteHookState(task, name, state, runner) {
1034
- if (!task.result) {
1035
- task.result = { state: "run" };
1036
- }
1037
- if (!task.result.hooks) {
1038
- task.result.hooks = {};
1039
- }
1040
- const suiteHooks = task.result.hooks;
1041
- if (suiteHooks) {
1042
- suiteHooks[name] = state;
1043
- let event = state === "run" ? "before-hook-start" : "before-hook-end";
1044
- if (name === "afterAll" || name === "afterEach") {
1045
- event = state === "run" ? "after-hook-start" : "after-hook-end";
1046
- }
1047
- updateTask(
1048
- event,
1049
- task,
1050
- runner
1051
- );
1052
- }
1161
+ if (!task.result) {
1162
+ task.result = { state: "run" };
1163
+ }
1164
+ if (!task.result.hooks) {
1165
+ task.result.hooks = {};
1166
+ }
1167
+ const suiteHooks = task.result.hooks;
1168
+ if (suiteHooks) {
1169
+ suiteHooks[name] = state;
1170
+ let event = state === "run" ? "before-hook-start" : "before-hook-end";
1171
+ if (name === "afterAll" || name === "afterEach") {
1172
+ event = state === "run" ? "after-hook-start" : "after-hook-end";
1173
+ }
1174
+ updateTask(event, task, runner);
1175
+ }
1053
1176
  }
1054
1177
  function getSuiteHooks(suite, name, sequence) {
1055
- const hooks = getHooks(suite)[name];
1056
- if (sequence === "stack" && (name === "afterAll" || name === "afterEach")) {
1057
- return hooks.slice().reverse();
1058
- }
1059
- return hooks;
1178
+ const hooks = getHooks(suite)[name];
1179
+ if (sequence === "stack" && (name === "afterAll" || name === "afterEach")) {
1180
+ return hooks.slice().reverse();
1181
+ }
1182
+ return hooks;
1060
1183
  }
1061
1184
  async function callTestHooks(runner, test, hooks, sequence) {
1062
- if (sequence === "stack") {
1063
- hooks = hooks.slice().reverse();
1064
- }
1065
- if (!hooks.length) {
1066
- return;
1067
- }
1068
- const onTestFailed = test.context.onTestFailed;
1069
- const onTestFinished = test.context.onTestFinished;
1070
- test.context.onTestFailed = () => {
1071
- throw new Error(`Cannot call "onTestFailed" inside a test hook.`);
1072
- };
1073
- test.context.onTestFinished = () => {
1074
- throw new Error(`Cannot call "onTestFinished" inside a test hook.`);
1075
- };
1076
- if (sequence === "parallel") {
1077
- try {
1078
- await Promise.all(hooks.map((fn) => fn(test.context)));
1079
- } catch (e) {
1080
- failTask(test.result, e, runner.config.diffOptions);
1081
- }
1082
- } else {
1083
- for (const fn of hooks) {
1084
- try {
1085
- await fn(test.context);
1086
- } catch (e) {
1087
- failTask(test.result, e, runner.config.diffOptions);
1088
- }
1089
- }
1090
- }
1091
- test.context.onTestFailed = onTestFailed;
1092
- test.context.onTestFinished = onTestFinished;
1185
+ if (sequence === "stack") {
1186
+ hooks = hooks.slice().reverse();
1187
+ }
1188
+ if (!hooks.length) {
1189
+ return;
1190
+ }
1191
+ const onTestFailed = test.context.onTestFailed;
1192
+ const onTestFinished = test.context.onTestFinished;
1193
+ test.context.onTestFailed = () => {
1194
+ throw new Error(`Cannot call "onTestFailed" inside a test hook.`);
1195
+ };
1196
+ test.context.onTestFinished = () => {
1197
+ throw new Error(`Cannot call "onTestFinished" inside a test hook.`);
1198
+ };
1199
+ if (sequence === "parallel") {
1200
+ try {
1201
+ await Promise.all(hooks.map((fn) => fn(test.context)));
1202
+ } catch (e) {
1203
+ failTask(test.result, e, runner.config.diffOptions);
1204
+ }
1205
+ } else {
1206
+ for (const fn of hooks) {
1207
+ try {
1208
+ await fn(test.context);
1209
+ } catch (e) {
1210
+ failTask(test.result, e, runner.config.diffOptions);
1211
+ }
1212
+ }
1213
+ }
1214
+ test.context.onTestFailed = onTestFailed;
1215
+ test.context.onTestFinished = onTestFinished;
1093
1216
  }
1094
1217
  async function callSuiteHook(suite, currentTask, name, runner, args) {
1095
- const sequence = runner.config.sequence.hooks;
1096
- const callbacks = [];
1097
- const parentSuite = "filepath" in suite ? null : suite.suite || suite.file;
1098
- if (name === "beforeEach" && parentSuite) {
1099
- callbacks.push(
1100
- ...await callSuiteHook(parentSuite, currentTask, name, runner, args)
1101
- );
1102
- }
1103
- const hooks = getSuiteHooks(suite, name, sequence);
1104
- if (hooks.length > 0) {
1105
- updateSuiteHookState(currentTask, name, "run", runner);
1106
- }
1107
- async function runHook(hook) {
1108
- return getBeforeHookCleanupCallback(hook, await hook(...args));
1109
- }
1110
- if (sequence === "parallel") {
1111
- callbacks.push(
1112
- ...await Promise.all(hooks.map((hook) => runHook(hook)))
1113
- );
1114
- } else {
1115
- for (const hook of hooks) {
1116
- callbacks.push(await runHook(hook));
1117
- }
1118
- }
1119
- if (hooks.length > 0) {
1120
- updateSuiteHookState(currentTask, name, "pass", runner);
1121
- }
1122
- if (name === "afterEach" && parentSuite) {
1123
- callbacks.push(
1124
- ...await callSuiteHook(parentSuite, currentTask, name, runner, args)
1125
- );
1126
- }
1127
- return callbacks;
1128
- }
1129
- const packs = /* @__PURE__ */ new Map();
1218
+ const sequence = runner.config.sequence.hooks;
1219
+ const callbacks = [];
1220
+ const parentSuite = "filepath" in suite ? null : suite.suite || suite.file;
1221
+ if (name === "beforeEach" && parentSuite) {
1222
+ callbacks.push(...await callSuiteHook(parentSuite, currentTask, name, runner, args));
1223
+ }
1224
+ const hooks = getSuiteHooks(suite, name, sequence);
1225
+ if (hooks.length > 0) {
1226
+ updateSuiteHookState(currentTask, name, "run", runner);
1227
+ }
1228
+ async function runHook(hook) {
1229
+ return getBeforeHookCleanupCallback(hook, await hook(...args));
1230
+ }
1231
+ if (sequence === "parallel") {
1232
+ callbacks.push(...await Promise.all(hooks.map((hook) => runHook(hook))));
1233
+ } else {
1234
+ for (const hook of hooks) {
1235
+ callbacks.push(await runHook(hook));
1236
+ }
1237
+ }
1238
+ if (hooks.length > 0) {
1239
+ updateSuiteHookState(currentTask, name, "pass", runner);
1240
+ }
1241
+ if (name === "afterEach" && parentSuite) {
1242
+ callbacks.push(...await callSuiteHook(parentSuite, currentTask, name, runner, args));
1243
+ }
1244
+ return callbacks;
1245
+ }
1246
+ const packs = new Map();
1130
1247
  const eventsPacks = [];
1131
1248
  let updateTimer;
1132
1249
  let previousUpdate;
1133
1250
  function updateTask(event, task, runner) {
1134
- eventsPacks.push([task.id, event]);
1135
- packs.set(task.id, [task.result, task.meta]);
1136
- const { clearTimeout, setTimeout } = getSafeTimers();
1137
- clearTimeout(updateTimer);
1138
- updateTimer = setTimeout(() => {
1139
- previousUpdate = sendTasksUpdate(runner);
1140
- }, 10);
1251
+ eventsPacks.push([task.id, event]);
1252
+ packs.set(task.id, [task.result, task.meta]);
1253
+ const { clearTimeout, setTimeout } = getSafeTimers();
1254
+ clearTimeout(updateTimer);
1255
+ updateTimer = setTimeout(() => {
1256
+ previousUpdate = sendTasksUpdate(runner);
1257
+ }, 10);
1141
1258
  }
1142
1259
  async function sendTasksUpdate(runner) {
1143
- var _a;
1144
- const { clearTimeout } = getSafeTimers();
1145
- clearTimeout(updateTimer);
1146
- await previousUpdate;
1147
- if (packs.size) {
1148
- const taskPacks = Array.from(packs).map(([id, task]) => {
1149
- return [id, task[0], task[1]];
1150
- });
1151
- const p = (_a = runner.onTaskUpdate) == null ? void 0 : _a.call(runner, taskPacks, eventsPacks);
1152
- eventsPacks.length = 0;
1153
- packs.clear();
1154
- return p;
1155
- }
1260
+ const { clearTimeout } = getSafeTimers();
1261
+ clearTimeout(updateTimer);
1262
+ await previousUpdate;
1263
+ if (packs.size) {
1264
+ var _runner$onTaskUpdate;
1265
+ const taskPacks = Array.from(packs).map(([id, task]) => {
1266
+ return [
1267
+ id,
1268
+ task[0],
1269
+ task[1]
1270
+ ];
1271
+ });
1272
+ const p = (_runner$onTaskUpdate = runner.onTaskUpdate) === null || _runner$onTaskUpdate === void 0 ? void 0 : _runner$onTaskUpdate.call(runner, taskPacks, eventsPacks);
1273
+ eventsPacks.length = 0;
1274
+ packs.clear();
1275
+ return p;
1276
+ }
1156
1277
  }
1157
1278
  async function callCleanupHooks(cleanups) {
1158
- await Promise.all(
1159
- cleanups.map(async (fn) => {
1160
- if (typeof fn !== "function") {
1161
- return;
1162
- }
1163
- await fn();
1164
- })
1165
- );
1279
+ await Promise.all(cleanups.map(async (fn) => {
1280
+ if (typeof fn !== "function") {
1281
+ return;
1282
+ }
1283
+ await fn();
1284
+ }));
1166
1285
  }
1167
1286
  async function runTest(test, runner) {
1168
- var _a, _b, _c, _d, _e, _f, _g, _h, _i;
1169
- await ((_a = runner.onBeforeRunTask) == null ? void 0 : _a.call(runner, test));
1170
- if (test.mode !== "run" && test.mode !== "queued") {
1171
- return;
1172
- }
1173
- if (((_b = test.result) == null ? void 0 : _b.state) === "fail") {
1174
- updateTask("test-failed-early", test, runner);
1175
- return;
1176
- }
1177
- const start = now();
1178
- test.result = {
1179
- state: "run",
1180
- startTime: unixNow(),
1181
- retryCount: 0
1182
- };
1183
- updateTask("test-prepare", test, runner);
1184
- setCurrentTest(test);
1185
- const suite = test.suite || test.file;
1186
- const repeats = test.repeats ?? 0;
1187
- for (let repeatCount = 0; repeatCount <= repeats; repeatCount++) {
1188
- const retry = test.retry ?? 0;
1189
- for (let retryCount = 0; retryCount <= retry; retryCount++) {
1190
- let beforeEachCleanups = [];
1191
- try {
1192
- await ((_c = runner.onBeforeTryTask) == null ? void 0 : _c.call(runner, test, {
1193
- retry: retryCount,
1194
- repeats: repeatCount
1195
- }));
1196
- test.result.repeatCount = repeatCount;
1197
- beforeEachCleanups = await callSuiteHook(
1198
- suite,
1199
- test,
1200
- "beforeEach",
1201
- runner,
1202
- [test.context, suite]
1203
- );
1204
- if (runner.runTask) {
1205
- await runner.runTask(test);
1206
- } else {
1207
- const fn = getFn(test);
1208
- if (!fn) {
1209
- throw new Error(
1210
- "Test function is not found. Did you add it using `setFn`?"
1211
- );
1212
- }
1213
- await fn();
1214
- }
1215
- await ((_d = runner.onAfterTryTask) == null ? void 0 : _d.call(runner, test, {
1216
- retry: retryCount,
1217
- repeats: repeatCount
1218
- }));
1219
- if (test.result.state !== "fail") {
1220
- if (!test.repeats) {
1221
- test.result.state = "pass";
1222
- } else if (test.repeats && retry === retryCount) {
1223
- test.result.state = "pass";
1224
- }
1225
- }
1226
- } catch (e) {
1227
- failTask(test.result, e, runner.config.diffOptions);
1228
- }
1229
- if (((_e = test.result) == null ? void 0 : _e.pending) || ((_f = test.result) == null ? void 0 : _f.state) === "skip") {
1230
- test.mode = "skip";
1231
- test.result = { state: "skip", note: (_g = test.result) == null ? void 0 : _g.note, pending: true };
1232
- updateTask("test-finished", test, runner);
1233
- setCurrentTest(void 0);
1234
- return;
1235
- }
1236
- try {
1237
- await ((_h = runner.onTaskFinished) == null ? void 0 : _h.call(runner, test));
1238
- } catch (e) {
1239
- failTask(test.result, e, runner.config.diffOptions);
1240
- }
1241
- try {
1242
- await callSuiteHook(suite, test, "afterEach", runner, [
1243
- test.context,
1244
- suite
1245
- ]);
1246
- await callCleanupHooks(beforeEachCleanups);
1247
- await callFixtureCleanup(test.context);
1248
- } catch (e) {
1249
- failTask(test.result, e, runner.config.diffOptions);
1250
- }
1251
- await callTestHooks(runner, test, test.onFinished || [], "stack");
1252
- if (test.result.state === "fail") {
1253
- await callTestHooks(
1254
- runner,
1255
- test,
1256
- test.onFailed || [],
1257
- runner.config.sequence.hooks
1258
- );
1259
- }
1260
- test.onFailed = void 0;
1261
- test.onFinished = void 0;
1262
- if (test.result.state === "pass") {
1263
- break;
1264
- }
1265
- if (retryCount < retry) {
1266
- test.result.state = "run";
1267
- test.result.retryCount = (test.result.retryCount ?? 0) + 1;
1268
- }
1269
- updateTask("test-retried", test, runner);
1270
- }
1271
- }
1272
- if (test.fails) {
1273
- if (test.result.state === "pass") {
1274
- const error = processError(new Error("Expect test to fail"));
1275
- test.result.state = "fail";
1276
- test.result.errors = [error];
1277
- } else {
1278
- test.result.state = "pass";
1279
- test.result.errors = void 0;
1280
- }
1281
- }
1282
- setCurrentTest(void 0);
1283
- test.result.duration = now() - start;
1284
- await ((_i = runner.onAfterRunTask) == null ? void 0 : _i.call(runner, test));
1285
- updateTask("test-finished", test, runner);
1287
+ var _runner$onBeforeRunTa, _test$result, _runner$onAfterRunTas;
1288
+ await ((_runner$onBeforeRunTa = runner.onBeforeRunTask) === null || _runner$onBeforeRunTa === void 0 ? void 0 : _runner$onBeforeRunTa.call(runner, test));
1289
+ if (test.mode !== "run" && test.mode !== "queued") {
1290
+ return;
1291
+ }
1292
+ if (((_test$result = test.result) === null || _test$result === void 0 ? void 0 : _test$result.state) === "fail") {
1293
+ updateTask("test-failed-early", test, runner);
1294
+ return;
1295
+ }
1296
+ const start = now();
1297
+ test.result = {
1298
+ state: "run",
1299
+ startTime: unixNow(),
1300
+ retryCount: 0
1301
+ };
1302
+ updateTask("test-prepare", test, runner);
1303
+ setCurrentTest(test);
1304
+ const suite = test.suite || test.file;
1305
+ const repeats = test.repeats ?? 0;
1306
+ for (let repeatCount = 0; repeatCount <= repeats; repeatCount++) {
1307
+ const retry = test.retry ?? 0;
1308
+ for (let retryCount = 0; retryCount <= retry; retryCount++) {
1309
+ var _test$result2, _test$result3;
1310
+ let beforeEachCleanups = [];
1311
+ try {
1312
+ var _runner$onBeforeTryTa, _runner$onAfterTryTas;
1313
+ await ((_runner$onBeforeTryTa = runner.onBeforeTryTask) === null || _runner$onBeforeTryTa === void 0 ? void 0 : _runner$onBeforeTryTa.call(runner, test, {
1314
+ retry: retryCount,
1315
+ repeats: repeatCount
1316
+ }));
1317
+ test.result.repeatCount = repeatCount;
1318
+ beforeEachCleanups = await callSuiteHook(suite, test, "beforeEach", runner, [test.context, suite]);
1319
+ if (runner.runTask) {
1320
+ await runner.runTask(test);
1321
+ } else {
1322
+ const fn = getFn(test);
1323
+ if (!fn) {
1324
+ throw new Error("Test function is not found. Did you add it using `setFn`?");
1325
+ }
1326
+ await fn();
1327
+ }
1328
+ await ((_runner$onAfterTryTas = runner.onAfterTryTask) === null || _runner$onAfterTryTas === void 0 ? void 0 : _runner$onAfterTryTas.call(runner, test, {
1329
+ retry: retryCount,
1330
+ repeats: repeatCount
1331
+ }));
1332
+ if (test.result.state !== "fail") {
1333
+ if (!test.repeats) {
1334
+ test.result.state = "pass";
1335
+ } else if (test.repeats && retry === retryCount) {
1336
+ test.result.state = "pass";
1337
+ }
1338
+ }
1339
+ } catch (e) {
1340
+ failTask(test.result, e, runner.config.diffOptions);
1341
+ }
1342
+ if (((_test$result2 = test.result) === null || _test$result2 === void 0 ? void 0 : _test$result2.pending) || ((_test$result3 = test.result) === null || _test$result3 === void 0 ? void 0 : _test$result3.state) === "skip") {
1343
+ var _test$result4;
1344
+ test.mode = "skip";
1345
+ test.result = {
1346
+ state: "skip",
1347
+ note: (_test$result4 = test.result) === null || _test$result4 === void 0 ? void 0 : _test$result4.note,
1348
+ pending: true
1349
+ };
1350
+ updateTask("test-finished", test, runner);
1351
+ setCurrentTest(undefined);
1352
+ return;
1353
+ }
1354
+ try {
1355
+ var _runner$onTaskFinishe;
1356
+ await ((_runner$onTaskFinishe = runner.onTaskFinished) === null || _runner$onTaskFinishe === void 0 ? void 0 : _runner$onTaskFinishe.call(runner, test));
1357
+ } catch (e) {
1358
+ failTask(test.result, e, runner.config.diffOptions);
1359
+ }
1360
+ try {
1361
+ await callSuiteHook(suite, test, "afterEach", runner, [test.context, suite]);
1362
+ await callCleanupHooks(beforeEachCleanups);
1363
+ await callFixtureCleanup(test.context);
1364
+ } catch (e) {
1365
+ failTask(test.result, e, runner.config.diffOptions);
1366
+ }
1367
+ await callTestHooks(runner, test, test.onFinished || [], "stack");
1368
+ if (test.result.state === "fail") {
1369
+ await callTestHooks(runner, test, test.onFailed || [], runner.config.sequence.hooks);
1370
+ }
1371
+ test.onFailed = undefined;
1372
+ test.onFinished = undefined;
1373
+ if (test.result.state === "pass") {
1374
+ break;
1375
+ }
1376
+ if (retryCount < retry) {
1377
+ test.result.state = "run";
1378
+ test.result.retryCount = (test.result.retryCount ?? 0) + 1;
1379
+ }
1380
+ updateTask("test-retried", test, runner);
1381
+ }
1382
+ }
1383
+ if (test.fails) {
1384
+ if (test.result.state === "pass") {
1385
+ const error = processError(new Error("Expect test to fail"));
1386
+ test.result.state = "fail";
1387
+ test.result.errors = [error];
1388
+ } else {
1389
+ test.result.state = "pass";
1390
+ test.result.errors = undefined;
1391
+ }
1392
+ }
1393
+ setCurrentTest(undefined);
1394
+ test.result.duration = now() - start;
1395
+ await ((_runner$onAfterRunTas = runner.onAfterRunTask) === null || _runner$onAfterRunTas === void 0 ? void 0 : _runner$onAfterRunTas.call(runner, test));
1396
+ updateTask("test-finished", test, runner);
1286
1397
  }
1287
1398
  function failTask(result, err, diffOptions) {
1288
- if (err instanceof PendingError) {
1289
- result.state = "skip";
1290
- result.note = err.note;
1291
- result.pending = true;
1292
- return;
1293
- }
1294
- result.state = "fail";
1295
- const errors = Array.isArray(err) ? err : [err];
1296
- for (const e of errors) {
1297
- const error = processError(e, diffOptions);
1298
- result.errors ?? (result.errors = []);
1299
- result.errors.push(error);
1300
- }
1399
+ if (err instanceof PendingError) {
1400
+ result.state = "skip";
1401
+ result.note = err.note;
1402
+ result.pending = true;
1403
+ return;
1404
+ }
1405
+ result.state = "fail";
1406
+ const errors = Array.isArray(err) ? err : [err];
1407
+ for (const e of errors) {
1408
+ const error = processError(e, diffOptions);
1409
+ result.errors ?? (result.errors = []);
1410
+ result.errors.push(error);
1411
+ }
1301
1412
  }
1302
1413
  function markTasksAsSkipped(suite, runner) {
1303
- suite.tasks.forEach((t) => {
1304
- t.mode = "skip";
1305
- t.result = { ...t.result, state: "skip" };
1306
- updateTask("test-finished", t, runner);
1307
- if (t.type === "suite") {
1308
- markTasksAsSkipped(t, runner);
1309
- }
1310
- });
1414
+ suite.tasks.forEach((t) => {
1415
+ t.mode = "skip";
1416
+ t.result = {
1417
+ ...t.result,
1418
+ state: "skip"
1419
+ };
1420
+ updateTask("test-finished", t, runner);
1421
+ if (t.type === "suite") {
1422
+ markTasksAsSkipped(t, runner);
1423
+ }
1424
+ });
1311
1425
  }
1312
1426
  async function runSuite(suite, runner) {
1313
- var _a, _b, _c, _d;
1314
- await ((_a = runner.onBeforeRunSuite) == null ? void 0 : _a.call(runner, suite));
1315
- if (((_b = suite.result) == null ? void 0 : _b.state) === "fail") {
1316
- markTasksAsSkipped(suite, runner);
1317
- updateTask("suite-failed-early", suite, runner);
1318
- return;
1319
- }
1320
- const start = now();
1321
- const mode = suite.mode;
1322
- suite.result = {
1323
- state: mode === "skip" || mode === "todo" ? mode : "run",
1324
- startTime: unixNow()
1325
- };
1326
- updateTask("suite-prepare", suite, runner);
1327
- let beforeAllCleanups = [];
1328
- if (suite.mode === "skip") {
1329
- suite.result.state = "skip";
1330
- updateTask("suite-finished", suite, runner);
1331
- } else if (suite.mode === "todo") {
1332
- suite.result.state = "todo";
1333
- updateTask("suite-finished", suite, runner);
1334
- } else {
1335
- try {
1336
- try {
1337
- beforeAllCleanups = await callSuiteHook(
1338
- suite,
1339
- suite,
1340
- "beforeAll",
1341
- runner,
1342
- [suite]
1343
- );
1344
- } catch (e) {
1345
- markTasksAsSkipped(suite, runner);
1346
- throw e;
1347
- }
1348
- if (runner.runSuite) {
1349
- await runner.runSuite(suite);
1350
- } else {
1351
- for (let tasksGroup of partitionSuiteChildren(suite)) {
1352
- if (tasksGroup[0].concurrent === true) {
1353
- await Promise.all(tasksGroup.map((c) => runSuiteChild(c, runner)));
1354
- } else {
1355
- const { sequence } = runner.config;
1356
- if (suite.shuffle) {
1357
- const suites = tasksGroup.filter(
1358
- (group) => group.type === "suite"
1359
- );
1360
- const tests = tasksGroup.filter((group) => group.type === "test");
1361
- const groups = shuffle([suites, tests], sequence.seed);
1362
- tasksGroup = groups.flatMap(
1363
- (group) => shuffle(group, sequence.seed)
1364
- );
1365
- }
1366
- for (const c of tasksGroup) {
1367
- await runSuiteChild(c, runner);
1368
- }
1369
- }
1370
- }
1371
- }
1372
- } catch (e) {
1373
- failTask(suite.result, e, runner.config.diffOptions);
1374
- }
1375
- try {
1376
- await callSuiteHook(suite, suite, "afterAll", runner, [suite]);
1377
- await callCleanupHooks(beforeAllCleanups);
1378
- } catch (e) {
1379
- failTask(suite.result, e, runner.config.diffOptions);
1380
- }
1381
- if (suite.mode === "run" || suite.mode === "queued") {
1382
- if (!runner.config.passWithNoTests && !hasTests(suite)) {
1383
- suite.result.state = "fail";
1384
- if (!((_c = suite.result.errors) == null ? void 0 : _c.length)) {
1385
- const error = processError(
1386
- new Error(`No test found in suite ${suite.name}`)
1387
- );
1388
- suite.result.errors = [error];
1389
- }
1390
- } else if (hasFailed(suite)) {
1391
- suite.result.state = "fail";
1392
- } else {
1393
- suite.result.state = "pass";
1394
- }
1395
- }
1396
- suite.result.duration = now() - start;
1397
- updateTask("suite-finished", suite, runner);
1398
- await ((_d = runner.onAfterRunSuite) == null ? void 0 : _d.call(runner, suite));
1399
- }
1427
+ var _runner$onBeforeRunSu, _suite$result;
1428
+ await ((_runner$onBeforeRunSu = runner.onBeforeRunSuite) === null || _runner$onBeforeRunSu === void 0 ? void 0 : _runner$onBeforeRunSu.call(runner, suite));
1429
+ if (((_suite$result = suite.result) === null || _suite$result === void 0 ? void 0 : _suite$result.state) === "fail") {
1430
+ markTasksAsSkipped(suite, runner);
1431
+ updateTask("suite-failed-early", suite, runner);
1432
+ return;
1433
+ }
1434
+ const start = now();
1435
+ const mode = suite.mode;
1436
+ suite.result = {
1437
+ state: mode === "skip" || mode === "todo" ? mode : "run",
1438
+ startTime: unixNow()
1439
+ };
1440
+ updateTask("suite-prepare", suite, runner);
1441
+ let beforeAllCleanups = [];
1442
+ if (suite.mode === "skip") {
1443
+ suite.result.state = "skip";
1444
+ updateTask("suite-finished", suite, runner);
1445
+ } else if (suite.mode === "todo") {
1446
+ suite.result.state = "todo";
1447
+ updateTask("suite-finished", suite, runner);
1448
+ } else {
1449
+ var _runner$onAfterRunSui;
1450
+ try {
1451
+ try {
1452
+ beforeAllCleanups = await callSuiteHook(suite, suite, "beforeAll", runner, [suite]);
1453
+ } catch (e) {
1454
+ markTasksAsSkipped(suite, runner);
1455
+ throw e;
1456
+ }
1457
+ if (runner.runSuite) {
1458
+ await runner.runSuite(suite);
1459
+ } else {
1460
+ for (let tasksGroup of partitionSuiteChildren(suite)) {
1461
+ if (tasksGroup[0].concurrent === true) {
1462
+ await Promise.all(tasksGroup.map((c) => runSuiteChild(c, runner)));
1463
+ } else {
1464
+ const { sequence } = runner.config;
1465
+ if (suite.shuffle) {
1466
+ const suites = tasksGroup.filter((group) => group.type === "suite");
1467
+ const tests = tasksGroup.filter((group) => group.type === "test");
1468
+ const groups = shuffle([suites, tests], sequence.seed);
1469
+ tasksGroup = groups.flatMap((group) => shuffle(group, sequence.seed));
1470
+ }
1471
+ for (const c of tasksGroup) {
1472
+ await runSuiteChild(c, runner);
1473
+ }
1474
+ }
1475
+ }
1476
+ }
1477
+ } catch (e) {
1478
+ failTask(suite.result, e, runner.config.diffOptions);
1479
+ }
1480
+ try {
1481
+ await callSuiteHook(suite, suite, "afterAll", runner, [suite]);
1482
+ await callCleanupHooks(beforeAllCleanups);
1483
+ } catch (e) {
1484
+ failTask(suite.result, e, runner.config.diffOptions);
1485
+ }
1486
+ if (suite.mode === "run" || suite.mode === "queued") {
1487
+ if (!runner.config.passWithNoTests && !hasTests(suite)) {
1488
+ var _suite$result$errors;
1489
+ suite.result.state = "fail";
1490
+ if (!((_suite$result$errors = suite.result.errors) === null || _suite$result$errors === void 0 ? void 0 : _suite$result$errors.length)) {
1491
+ const error = processError(new Error(`No test found in suite ${suite.name}`));
1492
+ suite.result.errors = [error];
1493
+ }
1494
+ } else if (hasFailed(suite)) {
1495
+ suite.result.state = "fail";
1496
+ } else {
1497
+ suite.result.state = "pass";
1498
+ }
1499
+ }
1500
+ suite.result.duration = now() - start;
1501
+ updateTask("suite-finished", suite, runner);
1502
+ await ((_runner$onAfterRunSui = runner.onAfterRunSuite) === null || _runner$onAfterRunSui === void 0 ? void 0 : _runner$onAfterRunSui.call(runner, suite));
1503
+ }
1400
1504
  }
1401
1505
  let limitMaxConcurrency;
1402
1506
  async function runSuiteChild(c, runner) {
1403
- if (c.type === "test") {
1404
- return limitMaxConcurrency(() => runTest(c, runner));
1405
- } else if (c.type === "suite") {
1406
- return runSuite(c, runner);
1407
- }
1507
+ if (c.type === "test") {
1508
+ return limitMaxConcurrency(() => runTest(c, runner));
1509
+ } else if (c.type === "suite") {
1510
+ return runSuite(c, runner);
1511
+ }
1408
1512
  }
1409
1513
  async function runFiles(files, runner) {
1410
- var _a, _b;
1411
- limitMaxConcurrency ?? (limitMaxConcurrency = limitConcurrency(runner.config.maxConcurrency));
1412
- for (const file of files) {
1413
- if (!file.tasks.length && !runner.config.passWithNoTests) {
1414
- if (!((_b = (_a = file.result) == null ? void 0 : _a.errors) == null ? void 0 : _b.length)) {
1415
- const error = processError(
1416
- new Error(`No test suite found in file ${file.filepath}`)
1417
- );
1418
- file.result = {
1419
- state: "fail",
1420
- errors: [error]
1421
- };
1422
- }
1423
- }
1424
- await runSuite(file, runner);
1425
- }
1514
+ limitMaxConcurrency ?? (limitMaxConcurrency = limitConcurrency(runner.config.maxConcurrency));
1515
+ for (const file of files) {
1516
+ if (!file.tasks.length && !runner.config.passWithNoTests) {
1517
+ var _file$result;
1518
+ if (!((_file$result = file.result) === null || _file$result === void 0 || (_file$result = _file$result.errors) === null || _file$result === void 0 ? void 0 : _file$result.length)) {
1519
+ const error = processError(new Error(`No test suite found in file ${file.filepath}`));
1520
+ file.result = {
1521
+ state: "fail",
1522
+ errors: [error]
1523
+ };
1524
+ }
1525
+ }
1526
+ await runSuite(file, runner);
1527
+ }
1426
1528
  }
1427
1529
  async function startTests(specs, runner) {
1428
- var _a, _b, _c, _d;
1429
- const paths = specs.map((f) => typeof f === "string" ? f : f.filepath);
1430
- await ((_a = runner.onBeforeCollect) == null ? void 0 : _a.call(runner, paths));
1431
- const files = await collectTests(specs, runner);
1432
- await ((_b = runner.onCollected) == null ? void 0 : _b.call(runner, files));
1433
- await ((_c = runner.onBeforeRunFiles) == null ? void 0 : _c.call(runner, files));
1434
- await runFiles(files, runner);
1435
- await ((_d = runner.onAfterRunFiles) == null ? void 0 : _d.call(runner, files));
1436
- await sendTasksUpdate(runner);
1437
- return files;
1530
+ var _runner$onBeforeColle, _runner$onCollected, _runner$onBeforeRunFi, _runner$onAfterRunFil;
1531
+ const paths = specs.map((f) => typeof f === "string" ? f : f.filepath);
1532
+ await ((_runner$onBeforeColle = runner.onBeforeCollect) === null || _runner$onBeforeColle === void 0 ? void 0 : _runner$onBeforeColle.call(runner, paths));
1533
+ const files = await collectTests(specs, runner);
1534
+ await ((_runner$onCollected = runner.onCollected) === null || _runner$onCollected === void 0 ? void 0 : _runner$onCollected.call(runner, files));
1535
+ await ((_runner$onBeforeRunFi = runner.onBeforeRunFiles) === null || _runner$onBeforeRunFi === void 0 ? void 0 : _runner$onBeforeRunFi.call(runner, files));
1536
+ await runFiles(files, runner);
1537
+ await ((_runner$onAfterRunFil = runner.onAfterRunFiles) === null || _runner$onAfterRunFil === void 0 ? void 0 : _runner$onAfterRunFil.call(runner, files));
1538
+ await sendTasksUpdate(runner);
1539
+ return files;
1438
1540
  }
1439
1541
  async function publicCollect(specs, runner) {
1440
- var _a, _b;
1441
- const paths = specs.map((f) => typeof f === "string" ? f : f.filepath);
1442
- await ((_a = runner.onBeforeCollect) == null ? void 0 : _a.call(runner, paths));
1443
- const files = await collectTests(specs, runner);
1444
- await ((_b = runner.onCollected) == null ? void 0 : _b.call(runner, files));
1445
- return files;
1542
+ var _runner$onBeforeColle2, _runner$onCollected2;
1543
+ const paths = specs.map((f) => typeof f === "string" ? f : f.filepath);
1544
+ await ((_runner$onBeforeColle2 = runner.onBeforeCollect) === null || _runner$onBeforeColle2 === void 0 ? void 0 : _runner$onBeforeColle2.call(runner, paths));
1545
+ const files = await collectTests(specs, runner);
1546
+ await ((_runner$onCollected2 = runner.onCollected) === null || _runner$onCollected2 === void 0 ? void 0 : _runner$onCollected2.call(runner, files));
1547
+ return files;
1446
1548
  }
1447
1549
 
1448
1550
  export { afterAll, afterEach, beforeAll, beforeEach, publicCollect as collectTests, createTaskCollector, describe, getCurrentSuite, getCurrentTest, getFn, getHooks, it, onTestFailed, onTestFinished, setFn, setHooks, startTests, suite, test, updateTask };