Skip to content

fix(vitest-plugin): stop calling the root suite's beforeAll/afterAll twice #108

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
prisis wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix(vitest-plugin): stop calling the root suite's beforeAll/afterAll twice #108

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 42 additions & 1 deletion packages/vitest-plugin/src/__tests__/instrumented.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { fromPartial } from "@total-typescript/shoehorn";
import { describe, expect, it, vi, type RunnerTestSuite } from "vitest";
import { AnalysisRunner as CodSpeedRunner } from "../legacy/analysis";
import { getBenchFn, getBenchOptions } from "../legacy/compat";
import { getBenchFn, getBenchOptions, getHooks } from "../legacy/compat";

const coreMocks = vi.hoisted(() => {
return {
Expand Down Expand Up @@ -45,6 +45,7 @@ vi.mock("../legacy/compat", () => {
});
const mockedGetBenchFn = vi.mocked(getBenchFn);
const mockedGetBenchOptions = vi.mocked(getBenchOptions);
const mockedGetHooks = vi.mocked(getHooks);

describe("CodSpeedRunner", () => {
it("should run the bench function", async () => {
Expand Down Expand Up @@ -188,4 +189,44 @@ describe("CodSpeedRunner", () => {
"teardown:run:test bench",
]);
});
it("should leave the root suite's beforeAll/afterAll to vitest", async () => {
mockedGetBenchFn.mockReturnValue(vi.fn());
const calls: string[] = [];
const hooksFor = (name: string) => ({
beforeAll: [() => calls.push(`beforeAll:${name}`)],
afterAll: [() => calls.push(`afterAll:${name}`)],
beforeEach: [],
afterEach: [],
});
mockedGetHooks.mockImplementation((suite) =>
hooksFor((suite as RunnerTestSuite).name),
);

const runner = new CodSpeedRunner(fromPartial({}));
const rootSuite = fromPartial<RunnerTestSuite>({
file: { filepath: __filename },
name: "root",
tasks: [
{
type: "suite",
name: "nested",
mode: "run",
tasks: [
{
type: "test",
mode: "run",
meta: { benchmark: true },
name: "test bench",
},
],
},
],
});

await runner.runSuite(rootSuite);

// Vitest calls the root suite's hooks around `runSuite`, so the runner
// must only call the nested suite's, once each.
expect(calls).toEqual(["beforeAll:nested", "afterAll:nested"]);
});
});
9 changes: 7 additions & 2 deletions packages/vitest-plugin/src/legacy/analysis.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,12 @@ async function runAnalysisBenchmarkSuite(
? parentSuiteName + "::" + suite.name
: suite.name;

await callSuiteHook(suite, suite, "beforeAll");
// Vitest runs the root (file) suite's beforeAll/afterAll itself, around
// `runSuite`; calling them here too would run them twice. Nested suites are
// only reached through this runner, so their hooks are ours to call.
const isRoot = parentSuiteName === undefined;

if (!isRoot) await callSuiteHook(suite, suite, "beforeAll");

for (const task of suite.tasks) {
if (task.mode !== "run") continue;
Expand All @@ -97,7 +102,7 @@ async function runAnalysisBenchmarkSuite(
}
}

await callSuiteHook(suite, suite, "afterAll");
if (!isRoot) await callSuiteHook(suite, suite, "afterAll");
}

export class AnalysisRunner extends NodeBenchmarkRunner {
Expand Down