@orangebeard-io/playwright-orangebeard-reporter 1.0.9 → 1.0.10

package/dist/reporter/OrangebeardReporter.js

@@ -383,7 +383,7 @@ class OrangebeardReporter {
                 }
                 const orangebeardAttachment = {
                     file: {
-                        name: path.basename(attachment.path),
+                        name: (0, utils_1.getAttachmentFileName)(attachment),
                         content: content,
                         contentType: attachment.contentType,
                     },

package/dist/reporter/utils.js

@@ -47,11 +47,13 @@ exports.getTime = getTime;
 exports.removeAnsi = removeAnsi;
 exports.ansiToMarkdown = ansiToMarkdown;
 exports.getCodeSnippet = getCodeSnippet;
+exports.getAttachmentFileName = getAttachmentFileName;
 exports.getAttachmentKey = getAttachmentKey;
 exports.determineTestType = determineTestType;
 const core_1 = require("@js-joda/core");
 const FinishTest_1 = require("@orangebeard-io/javascript-client/dist/client/models/FinishTest");
 const fs = __importStar(require("node:fs"));
+const path = __importStar(require("node:path"));
 const util_1 = require("util");
 var Status = FinishTest_1.FinishTest.Status;
 const StartTest_1 = require("@orangebeard-io/javascript-client/dist/client/models/StartTest");
@@ -179,6 +181,35 @@ const getBytes = (filePath) => __awaiter(void 0, void 0, void 0, function* () {
     }
 });
 exports.getBytes = getBytes;
+const EXTENSION_BY_CONTENT_TYPE = {
+    'image/png': '.png',
+    'image/jpeg': '.jpg',
+    'image/gif': '.gif',
+    'image/webp': '.webp',
+    'application/zip': '.zip',
+    'video/webm': '.webm',
+    'video/mp4': '.mp4',
+    'text/plain': '.txt',
+    'application/json': '.json',
+    'application/pdf': '.pdf',
+};
+/**
+ * Derives the file name to upload an attachment as. Path-backed attachments
+ * (screenshots/traces/videos written to disk by Playwright) use the basename
+ * of that path. Body-only attachments (e.g. from `testInfo.attach(name, { body })`)
+ * have no path, so `attachment.name` is used instead, adding an extension
+ * inferred from `contentType` if the name doesn't already have one.
+ */
+function getAttachmentFileName(attachment) {
+    if (attachment.path) {
+        return path.basename(attachment.path);
+    }
+    if (path.extname(attachment.name)) {
+        return attachment.name;
+    }
+    const extension = EXTENSION_BY_CONTENT_TYPE[attachment.contentType];
+    return extension ? `${attachment.name}${extension}` : attachment.name;
+}
 function getAttachmentKey(attachment) {
     var _a, _b;
     const size = attachment.body ? attachment.body.byteLength : undefined;

package/dist/reporter/utils.test.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("./utils");
+describe('getAttachmentFileName', () => {
+    it('uses the basename of attachment.path when a path is present', () => {
+        const name = (0, utils_1.getAttachmentFileName)({
+            name: 'trace',
+            path: '/tmp/playwright-artifacts/abc123/trace.zip',
+            contentType: 'application/zip',
+        });
+        expect(name).toBe('trace.zip');
+    });
+    it('does not crash for a body-only attachment with no path', () => {
+        expect(() => (0, utils_1.getAttachmentFileName)({
+            name: 'homepage-screenshot',
+            contentType: 'image/png',
+        })).not.toThrow();
+    });
+    it('appends an extension derived from contentType when the name has none', () => {
+        const name = (0, utils_1.getAttachmentFileName)({
+            name: 'homepage-screenshot',
+            contentType: 'image/png',
+        });
+        expect(name).toBe('homepage-screenshot.png');
+    });
+    it('leaves the name untouched when it already has an extension', () => {
+        const name = (0, utils_1.getAttachmentFileName)({
+            name: 'homepage-screenshot.png',
+            contentType: 'image/png',
+        });
+        expect(name).toBe('homepage-screenshot.png');
+    });
+    it('falls back to the bare name for an unrecognized content type', () => {
+        const name = (0, utils_1.getAttachmentFileName)({
+            name: 'custom-data',
+            contentType: 'application/x-custom',
+        });
+        expect(name).toBe('custom-data');
+    });
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orangebeard-io/playwright-orangebeard-reporter",
-  "version": "1.0.9",
+  "version": "1.0.10",
   "description": "A Playwright reporter to report to Orangebeard.io",
   "main": "dist/index.js",
   "files": [
@@ -33,13 +33,16 @@
   "homepage": "https://github.com/orangebeard-io/playwright-listener#readme",
   "devDependencies": {
     "@playwright/test": "^1.57.0",
+    "@types/jest": "^30.0.0",
     "@types/node": "^22.10.9",
     "@typescript-eslint/parser": "^8.15.0",
     "eslint": "^9.15.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-prettier": "^5.2.1",
+    "jest": "^30.4.2",
     "prettier": "^3.3.3",
     "rimraf": "^6.0.1",
+    "ts-jest": "^29.4.12",
     "typescript": "^5.6.3"
   },
   "dependencies": {