added playwright trace hook attachments to test results (#1456)

Author: formaceft-93

packages/allure-cucumberjs/src/reporter.ts

@@ -516,6 +516,18 @@ export default class AllureCucumberReporter extends Formatter {
     }
 
     if (message.mediaType === ALLURE_RUNTIME_MESSAGE_CONTENT_TYPE) {
+      if (fixtureUuid && testUuid) {
+        const runtimeMessages = this.parseRuntimeMessages(message.body);
+        const hasPlaywrightTrace = runtimeMessages.some(
+          (msg) =>
+            (msg.type === "attachment_content" || msg.type === "attachment_path") &&
+            msg.data.contentType === ContentType.PLAYWRIGHT_TRACE,
+        );
+        if (hasPlaywrightTrace) {
+          this.applyRuntimeAttachmentMessages(testUuid, message.body);
+          return;
+        }
+      }
       this.applyRuntimeAttachmentMessages(rootUuid, message.body);
       return;
     }

packages/allure-cucumberjs/test/samples/features/hookAttachments.feature

@@ -0,0 +1,9 @@
+Feature: Hook Attachments
+
+  @trace
+  Scenario: trace attachment in after hook
+    Given a passed step
+
+  @regular
+  Scenario: regular attachment in after hook
+    Given a passed step

packages/allure-cucumberjs/test/samples/support/hookAttachments.cjs

@@ -0,0 +1,16 @@
+const { Given, After } = require("@cucumber/cucumber");
+const { attachment, ContentType } = require("allure-js-commons");
+
+After("@trace", async () => {
+  await attachment("Playwright Trace", "trace-content", {
+    contentType: ContentType.PLAYWRIGHT_TRACE,
+  });
+});
+
+After("@regular", async () => {
+  await attachment("Text attachment", "some text", {
+    contentType: "text/plain",
+  });
+});
+
+Given("a passed step", () => {});

packages/allure-cucumberjs/test/spec/hookAttachments.test.ts

@@ -0,0 +1,71 @@
+import { ContentType } from "allure-js-commons";
+import { expect, it } from "vitest";
+
+import { runCucumberInlineTest } from "../utils.js";
+
+it("handles playwright trace attachments in after hooks", async () => {
+  const { tests, groups, attachments } = await runCucumberInlineTest(["hookAttachments"], ["hookAttachments"]);
+
+  expect(tests).toHaveLength(2);
+
+  const traceTest = tests.find((t) => t.name === "trace attachment in after hook");
+  const regularTest = tests.find((t) => t.name === "regular attachment in after hook");
+
+  expect(traceTest).toBeDefined();
+  expect(regularTest).toBeDefined();
+
+  // playwright trace attachment should be in the test result
+  expect(traceTest!.steps).toEqual(
+    expect.arrayContaining([
+      expect.objectContaining({
+        name: "Given a passed step",
+        status: "passed",
+      }),
+      expect.objectContaining({
+        name: "Playwright Trace",
+        attachments: expect.arrayContaining([
+          expect.objectContaining({
+            name: "Playwright Trace",
+            type: ContentType.PLAYWRIGHT_TRACE,
+          }),
+        ]),
+      }),
+    ]),
+  );
+
+  // regular attachment should not be in the test result
+  expect(regularTest!.steps).toEqual(
+    expect.arrayContaining([
+      expect.objectContaining({
+        name: "Given a passed step",
+        status: "passed",
+      }),
+    ]),
+  );
+  expect(regularTest!.steps!.find((s) => s.name === "Text attachment")).toBeUndefined();
+  expect(regularTest!.attachments).toHaveLength(0);
+
+  // regular attachment should be in the after fixture of the group
+  expect(groups).toHaveLength(2);
+  const regularGroup = groups.find((g) => g.afters?.some((a) => a.steps?.some((s) => s.name === "Text attachment")));
+  expect(regularGroup).toBeDefined();
+  expect(regularGroup!.afters).toEqual(
+    expect.arrayContaining([
+      expect.objectContaining({
+        steps: expect.arrayContaining([
+          expect.objectContaining({
+            name: "Text attachment",
+            attachments: expect.arrayContaining([
+              expect.objectContaining({
+                name: "Text attachment",
+                type: "text/plain",
+              }),
+            ]),
+          }),
+        ]),
+      }),
+    ]),
+  );
+
+  expect(Object.keys(attachments as object)).toHaveLength(2);
+});

packages/allure-js-commons/src/facade.ts

@@ -1,5 +1,5 @@
 import type { Status, StatusDetails } from "./model.js";
-import { type ContentType } from "./model.js";
+import { ContentType } from "./model.js";
 import { type AttachmentOptions, type Label, type Link, type ParameterMode, type ParameterOptions } from "./model.js";
 import { LabelName, LinkType } from "./model.js";
 import { getGlobalTestRuntimeWithAutoconfig } from "./sdk/runtime/runtime.js";
@@ -100,7 +100,7 @@ export const globalError = (details: StatusDetails) => {
 
 export const attachTrace = (name: string, path: string) => {
   return callRuntimeMethod("attachmentFromPath", name, path, {
-    contentType: "application/vnd.allure.playwright-trace",
+    contentType: ContentType.PLAYWRIGHT_TRACE,
   });
 };
 

packages/allure-js-commons/src/model.ts

@@ -168,6 +168,7 @@ export enum ContentType {
   JPEG = "image/jpeg",
   MP4 = "video/mp4",
   IMAGEDIFF = "application/vnd.allure.image.diff",
+  PLAYWRIGHT_TRACE = "application/vnd.allure.playwright-trace",
 }
 
 /* eslint-disable no-shadow */

packages/allure-playwright/src/index.ts

@@ -768,7 +768,7 @@ export class AllureReporter implements ReporterV2 {
     } else {
       const contentType =
         attachment.name === "trace" && attachment.contentType === "application/zip"
-          ? "application/vnd.allure.playwright-trace"
+          ? ContentType.PLAYWRIGHT_TRACE
           : attachment.contentType;
 
       this.allureRuntime!.writeAttachment(testUuid, parentUuid, attachment.name, attachment.path!, {