Fix Allure metadata attribution in concurrent Vitest tests (#1471)

baev · web-flow · commit d49b9ab7d323 · 2026-05-14T14:44:02.000Z
Co-authored-by: Dmitry Baev &lt;baev@users.noreply.github.com&gt;
diff --git a/packages/allure-vitest/README.md b/packages/allure-vitest/README.md
@@ -54,14 +54,13 @@ Install Allure Report separately when you want to render the generated `allure-r
 
 ## Usage
 
-Add next changes to your config file if you want to use vitest to run NodeJS tests only:
+Add the reporter to your config file if you want to use Vitest to run Node.js tests only:
 
 ```diff
 import { defineConfig } from "vitest/config";
 
 export default defineConfig({
   test: {
-+    setupFiles: ["allure-vitest/setup"],
     reporters: [
       "default",
       "allure-vitest/reporter",
@@ -70,15 +69,17 @@ export default defineConfig({
 });
 ```
 
-In case if you want to use [vitest for browser testing](https://vitest.dev/guide/browser/) add next changes:
+The reporter registers the Allure setup module automatically. If your project already lists `allure-vitest/setup` in
+`setupFiles`, you can keep it for compatibility or remove it from the config.
+
+If you want to use [Vitest for browser testing](https://vitest.dev/guide/browser/), add the browser provider config:
 
 ```diff
 import { defineConfig } from "vitest/config";
-+ import { commands } from "allure-vitest/browser"
++ import { playwright } from "@vitest/browser-playwright";
 
 export default defineConfig({
   test: {
-+    setupFiles: ["allure-vitest/browser/setup"],
     reporters: [
       "default",
       "allure-vitest/reporter",
@@ -91,13 +92,17 @@ export default defineConfig({
     instances: [
       { browser: "chromium" },
     ],
-+    commands: {
-+      ...commands,
-+    }
   },
 });
 ```
 
+The reporter also registers `allure-vitest/browser/setup` and the Allure browser command automatically when browser
+mode is enabled. If your project already lists them in the config, you can keep them for compatibility or remove them.
+
+Browser mode does not have a stable async context primitive equivalent to Node.js `AsyncLocalStorage`, so Allure runtime
+API calls in `describe.concurrent` browser tests may still be attributed incorrectly after async boundaries. Prefer
+non-concurrent browser tests when using the context-free Allure runtime API.
+
 ### View the report
 
 Use Allure Report 2:
diff --git a/packages/allure-vitest/src/reporter.ts b/packages/allure-vitest/src/reporter.ts
@@ -1,3 +1,5 @@
+import { fileURLToPath } from "node:url";
+
 import { Stage, Status } from "allure-js-commons";
 import type { RuntimeMessage } from "allure-js-commons/sdk";
 import { getMessageAndTraceFromError, getStatusFromError } from "allure-js-commons/sdk";
@@ -16,12 +18,20 @@ import {
   md5,
 } from "allure-js-commons/sdk/reporter";
 import type { RunnerTask as Task } from "vitest";
-import type { TestModule } from "vitest/node";
+import type { TestModule, Vitest } from "vitest/node";
 import type { Reporter } from "vitest/reporters";
 
+import { commands as allureBrowserCommands } from "./browser/index.js";
 import { takeGlobalRuntimeMessages } from "./runtime.js";
 import { getTestMetadata } from "./utils.js";
 
+const setupModulePath = fileURLToPath(new URL("./setup.js", import.meta.url));
+
+const browserSetupModulePath = fileURLToPath(new URL("./browser/setup.js", import.meta.url));
+
+const normalizeSetupFilePath = (setupFilePath: string) =>
+  setupFilePath.startsWith("file://") ? fileURLToPath(setupFilePath) : setupFilePath;
+
 export default class AllureVitestReporter implements Reporter {
   private allureReporterRuntime?: ReporterRuntime;
   private config: ReporterConfig;
@@ -31,7 +41,9 @@ export default class AllureVitestReporter implements Reporter {
     this.config = config;
   }
 
-  onInit() {
+  onInit(vitest: Vitest) {
+    this.registerSetupFile(vitest);
+
     const { listeners, resultsDir, ...config } = this.config;
 
     this.allureReporterRuntime = new ReporterRuntime({
@@ -45,6 +57,28 @@ export default class AllureVitestReporter implements Reporter {
     this.globalRuntimeMessages = [];
   }
 
+  private registerSetupFile(vitest: Vitest) {
+    for (const project of vitest.projects) {
+      const setupFilePath = project.config.browser.enabled ? browserSetupModulePath : setupModulePath;
+
+      const hasSetupFile = project.config.setupFiles.some(
+        (setupFile) => normalizeSetupFilePath(setupFile) === setupFilePath,
+      );
+
+      if (!hasSetupFile) {
+        project.config.setupFiles.unshift(setupFilePath);
+      }
+
+      if (project.config.browser.enabled) {
+        project.config.browser.commands ??= {};
+
+        for (const [name, command] of Object.entries(allureBrowserCommands)) {
+          project.config.browser.commands[name] ??= command;
+        }
+      }
+    }
+  }
+
   // eslint-disable-next-line @typescript-eslint/array-type
   onTestRunEnd(tests: ReadonlyArray<TestModule>) {
     for (const test of tests) {
diff --git a/packages/allure-vitest/src/runtime.ts b/packages/allure-vitest/src/runtime.ts
@@ -9,6 +9,8 @@ export const ALLURE_VITEST_GLOBAL_RUNTIME_MESSAGES_META_KEY = "allureGlobalRunti
 
 export const ALLURE_VITEST_RUNTIME_MESSAGES_META_KEY = "allureRuntimeMessages";
 
+export const ALLURE_VITEST_ASYNC_CONTEXT_KEY = "__allureVitestAsyncContext";
+
 export type RuntimeMessageMetaKey =
   | typeof ALLURE_VITEST_GLOBAL_RUNTIME_MESSAGES_META_KEY
   | typeof ALLURE_VITEST_RUNTIME_MESSAGES_META_KEY;
@@ -18,6 +20,27 @@ export type RuntimeMessageTaskMeta = TaskMeta & {
   [ALLURE_VITEST_RUNTIME_MESSAGES_META_KEY]?: RuntimeMessage[];
 };
 
+type AllureVitestAsyncContext = {
+  currentTaskStorage: {
+    getStore: () => Task | undefined;
+  };
+  activeTasks?: {
+    has: (task: Task) => boolean;
+  };
+};
+
+const getCurrentTask = (): Task | undefined => {
+  const holder = globalThis as unknown as Record<string, AllureVitestAsyncContext | undefined>;
+  const asyncContext = holder[ALLURE_VITEST_ASYNC_CONTEXT_KEY];
+  const task = asyncContext?.currentTaskStorage.getStore();
+
+  if (task) {
+    return (asyncContext?.activeTasks?.has(task) ?? true) ? task : undefined;
+  }
+
+  return getCurrentTest();
+};
+
 export const addGlobalMessage = (message: RuntimeMessage) => {
   const holder = globalThis as unknown as Record<string, RuntimeMessage[] | undefined>;
   const messages = (holder[ALLURE_VITEST_GLOBAL_RUNTIME_MESSAGES_KEY] ??= []);
@@ -101,7 +124,7 @@ export class BaseVitestTestRuntime extends BaseMessageTestRuntime {
   }
 
   protected processMessage(message: RuntimeMessage): boolean {
-    const currentTest = getCurrentTest();
+    const currentTest = getCurrentTask();
 
     if (isGlobalRuntimeMessage(message)) {
       if (currentTest) {
diff --git a/packages/allure-vitest/src/setup.ts b/packages/allure-vitest/src/setup.ts
@@ -1,11 +1,98 @@
+import { AsyncLocalStorage } from "node:async_hooks";
+
+import type { Task, Test } from "@vitest/runner";
 import { parseTestPlan } from "allure-js-commons/sdk/reporter";
 import { setGlobalTestRuntime } from "allure-js-commons/sdk/runtime";
 import { afterAll, afterEach, beforeAll, beforeEach } from "vitest";
+import { VitestTestRunner } from "vitest/runners";
 
 import { allureVitestLegacyApi } from "./legacy.js";
+import { ALLURE_VITEST_ASYNC_CONTEXT_KEY } from "./runtime.js";
 import { existsInTestPlan } from "./utils.js";
 import { VitestTestRuntime } from "./VitestTestRuntime.js";
 
+const ALLURE_VITEST_RUNNER_PATCHED_KEY = Symbol.for("allure-vitest.runnerPatched");
+
+type AllureVitestAsyncContext = {
+  currentTaskStorage: AsyncLocalStorage<Test>;
+  activeTasks: WeakSet<Test>;
+};
+
+type PatchedRunner = typeof VitestTestRunner.prototype & {
+  [ALLURE_VITEST_RUNNER_PATCHED_KEY]?: true;
+  onAfterRetryTask?: (test: Task, retryInfo: { retry: number; repeats: number }) => unknown;
+};
+
+const getAsyncContext = (): AllureVitestAsyncContext => {
+  const holder = globalThis as unknown as Record<string, AllureVitestAsyncContext | undefined>;
+
+  return (holder[ALLURE_VITEST_ASYNC_CONTEXT_KEY] ??= {
+    currentTaskStorage: new AsyncLocalStorage<Test>(),
+    activeTasks: new WeakSet<Test>(),
+  });
+};
+
+const patchVitestRunner = () => {
+  const prototype = VitestTestRunner.prototype as PatchedRunner;
+
+  if (prototype[ALLURE_VITEST_RUNNER_PATCHED_KEY]) {
+    return;
+  }
+
+  const originalOnBeforeRunTask = prototype.onBeforeRunTask;
+  const originalOnAfterRetryTask = prototype.onAfterRetryTask;
+  const originalOnAfterRunTask = prototype.onAfterRunTask;
+
+  const releaseTask = (test: Task) => {
+    getAsyncContext().activeTasks.delete(test as Test);
+  };
+
+  const releaseNonRunnableTask = (test: Task) => {
+    if (test.mode !== "run" && test.mode !== "queued") {
+      releaseTask(test);
+    }
+  };
+
+  const releaseDynamicallySkippedTask = (test: Task) => {
+    const result = (test as Test).result as { pending?: boolean; state?: string } | undefined;
+
+    if (result?.pending || result?.state === "skip") {
+      releaseTask(test);
+    }
+  };
+
+  prototype.onBeforeRunTask = async function allureOnBeforeRunTask(test: Task) {
+    const asyncContext = getAsyncContext();
+
+    asyncContext.activeTasks.add(test as Test);
+    asyncContext.currentTaskStorage.enterWith(test as Test);
+
+    await originalOnBeforeRunTask.call(this, test);
+
+    releaseNonRunnableTask(test);
+  };
+
+  prototype.onAfterRetryTask = function allureOnAfterRetryTask(test: Task, retryInfo) {
+    try {
+      return originalOnAfterRetryTask?.call(this, test, retryInfo);
+    } finally {
+      releaseDynamicallySkippedTask(test);
+    }
+  };
+
+  prototype.onAfterRunTask = async function allureOnAfterRunTask(test: Task) {
+    try {
+      return await originalOnAfterRunTask.call(this, test);
+    } finally {
+      releaseTask(test);
+    }
+  };
+
+  prototype[ALLURE_VITEST_RUNNER_PATCHED_KEY] = true;
+};
+
+patchVitestRunner();
+
 beforeAll(() => {
   globalThis.allureTestPlan = parseTestPlan();
   setGlobalTestRuntime(new VitestTestRuntime());
diff --git a/packages/allure-vitest/test/spec/categories.test.ts b/packages/allure-vitest/test/spec/categories.test.ts
@@ -1,12 +1,6 @@
 import { beforeAll, describe, expect, it } from "vitest";
 
-import {
-  type TestFileAccessor,
-  browserSetupModulePath,
-  reporterModulePath,
-  runVitestInlineTest,
-  setupModulePath,
-} from "../utils.js";
+import { type TestFileAccessor, reporterModulePath, runVitestInlineTest } from "../utils.js";
 
 describe("categories", () => {
   for (const env of ["node", "browser"]) {
@@ -21,7 +15,6 @@ describe("categories", () => {
 
           export default defineConfig({
             test: {
-              setupFiles: ["${setupModulePath}"],
               reporters: [
                 "default",
                 [
@@ -42,13 +35,11 @@ describe("categories", () => {
           }
           return `
           import { defineConfig } from "vitest/config";
-          import { commands } from "allure-vitest/browser";
           import { playwright } from "@vitest/browser-playwright";
 
           export default defineConfig({
             test: {
               openTelemetry: { enabled: false },
-              setupFiles: ["${browserSetupModulePath}"],
               reporters: [
                 "default",
                 [
@@ -68,7 +59,6 @@ describe("categories", () => {
                 enabled: true,
                 headless: true,
                 instances: [{ browser: "chromium" }],
-                commands: { ...commands },
               },
             },
           });
diff --git a/packages/allure-vitest/test/spec/environmentInfo.test.ts b/packages/allure-vitest/test/spec/environmentInfo.test.ts
@@ -1,12 +1,6 @@
 import { beforeAll, describe, expect, it } from "vitest";
 
-import {
-  type TestFileAccessor,
-  browserSetupModulePath,
-  reporterModulePath,
-  runVitestInlineTest,
-  setupModulePath,
-} from "../utils.js";
+import { type TestFileAccessor, reporterModulePath, runVitestInlineTest } from "../utils.js";
 
 describe("environment info", () => {
   for (const env of ["node", "browser"]) {
@@ -21,7 +15,6 @@ describe("environment info", () => {
 
         export default defineConfig({
           test: {
-            setupFiles: ["${setupModulePath}"],
             reporters: [
               "default",
               [
@@ -41,13 +34,11 @@ describe("environment info", () => {
           }
           return `
         import { defineConfig } from "vitest/config";
-        import { commands } from "allure-vitest/browser";
         import { playwright } from "@vitest/browser-playwright";
 
         export default defineConfig({
           test: {
             openTelemetry: { enabled: false },
-            setupFiles: ["${browserSetupModulePath}"],
             reporters: [
               "default",
               [
@@ -66,7 +57,6 @@ describe("environment info", () => {
               enabled: true,
               headless: true,
               instances: [{ browser: "chromium" }],
-              commands: { ...commands },
             },
           },
         });
diff --git a/packages/allure-vitest/test/spec/globalLabels.test.ts b/packages/allure-vitest/test/spec/globalLabels.test.ts
diff --git a/packages/allure-vitest/test/spec/runtime/modern/steps.test.ts b/packages/allure-vitest/test/spec/runtime/modern/steps.test.ts
diff --git a/packages/allure-vitest/test/utils.ts b/packages/allure-vitest/test/utils.ts
