feat: support step-level attachments (#21)

Author: aslushnikov

package.json

@@ -34,7 +34,7 @@
     "node": "^20.17.0 || >=22.9.0"
   },
   "devDependencies": {
-    "@flakiness/flakiness-report": "^0.28.0",
+    "@flakiness/flakiness-report": "^0.31.0",
     "@flakiness/playwright": "^1.3.3",
     "@playwright/test": "^1.58.2",
     "@types/debug": "^4.1.12",

pnpm-lock.yaml

@@ -54,6 +54,7 @@ export function normalizeReport(report: FlakinessReport.Report): FlakinessReport
     return {
       ...step,
       duration: step.duration === 0 ? undefined : step.duration,
+      attachments: step.attachments && step.attachments.length ? step.attachments : undefined,
       steps: step.steps && step.steps.length ? step.steps.map(cleanupTestStep) : undefined,
     }
   }

src/normalizeReport.ts

@@ -69,21 +69,31 @@ export async function readReport(reportFolder: string): Promise<{
   const filenameToPath = new Map(attachmentFiles.map(file => [path.basename(file), file]));
   const attachmentIdToPath = new Map<FlakinessReport.AttachmentId, FileAttachment>();
   const missingAttachments = new Map<FlakinessReport.AttachmentId, FlakinessReport.Attachment>();
+  const visitAttachment = (attachment: FlakinessReport.Attachment) => {
+    const attachmentPath = filenameToPath.get(attachment.id);
+    if (!attachmentPath) {
+      missingAttachments.set(attachment.id, attachment);
+    } else {
+      attachmentIdToPath.set(attachment.id, {
+        contentType: attachment.contentType,
+        id: attachment.id,
+        path: attachmentPath,
+        type: 'file',
+      });
+    }
+  };
+  const visitStep = (step: FlakinessReport.TestStep) => {
+    for (const attachment of step.attachments ?? [])
+      visitAttachment(attachment);
+    for (const childStep of step.steps ?? [])
+      visitStep(childStep);
+  };
   visitTests(report, (test) => {
     for (const attempt of test.attempts) {
-      for (const attachment of attempt.attachments ?? []) {
-        const attachmentPath = filenameToPath.get(attachment.id);
-        if (!attachmentPath) {
-          missingAttachments.set(attachment.id, attachment);
-        } else {
-          attachmentIdToPath.set(attachment.id, {
-            contentType: attachment.contentType,
-            id: attachment.id,
-            path: attachmentPath,
-            type: 'file',
-          });
-        }
-      }
+      for (const attachment of attempt.attachments ?? [])
+        visitAttachment(attachment);
+      for (const step of attempt.steps ?? [])
+        visitStep(step);
     }
   });
   return {