Merge pull request #81 from argos-ci/fix-screenshot-metadata

fix(playwright): fix screenshot metadata in reporter
argos-ci · Nov 8, 2023 · 1ab191c · 1ab191c
2 parents 47a9394 + f8a6552
commit 1ab191c
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 4 deletions.
diff --git a/packages/playwright/src/attachment.ts b/packages/playwright/src/attachment.ts
@@ -22,6 +22,9 @@ export type Attachment = TestResult["attachments"][number];
 export type ArgosScreenshotAttachment = Attachment & {
   body: Buffer;
 };
+export type ArgosMetadataAttachment = Attachment & {
+  body: Buffer;
+};
 export type AutomaticScreenshotAttachment = Attachment & {
   name: "screenshot";
   path: string;
@@ -51,6 +54,16 @@ export function checkIsArgosScreenshot(
   );
 }
 
+export function checkIsArgosScreenshotMetadata(
+  attachment: Attachment,
+): attachment is ArgosMetadataAttachment {
+  return (
+    attachment.name.startsWith("argos/") &&
+    attachment.contentType === "application/json" &&
+    Boolean(attachment.body)
+  );
+}
+
 export function checkIsAutomaticScreenshot(
   attachment: Attachment,
 ): attachment is AutomaticScreenshotAttachment {

diff --git a/packages/playwright/src/reporter.ts b/packages/playwright/src/reporter.ts
@@ -13,6 +13,7 @@ import { tmpdir } from "node:os";
 import { dirname, join } from "node:path";
 import {
   checkIsArgosScreenshot,
+  checkIsArgosScreenshotMetadata,
   checkIsAutomaticScreenshot,
   checkIsTrace,
   getAttachementFilename,
@@ -80,10 +81,10 @@ class ArgosReporter implements Reporter {
   async onTestEnd(test: TestCase, result: TestResult) {
     await Promise.all(
       result.attachments.map(async (attachment) => {
-        if (checkIsArgosScreenshot(attachment)) {
-          if (!attachment.body) {
-            throw new Error("Missing attachment body");
-          }
+        if (
+          checkIsArgosScreenshot(attachment) ||
+          checkIsArgosScreenshotMetadata(attachment)
+        ) {
           const path = join(
             this.uploadDir,
             getAttachementFilename(attachment.name),