@orangebeard-io/playwright-orangebeard-reporter 1.0.5 → 1.0.8

package/README.md

@@ -45,7 +45,7 @@ Create orangebeard.json (in your test projects's folder (or above))
 ```JSON
 {
   "endpoint": "https://XXX.orangebeard.app",
-  "accessToken": "00000000-0000-0000-0000-00000000",
+  "token": "00000000-0000-0000-0000-00000000",
   "project": "my_project_name",
   "testset": "My Test Set Name",
   "description": "A run from playwright",

package/dist/reporter/OrangebeardReporter.js

@@ -48,10 +48,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.OrangebeardReporter = void 0;
 const utils_1 = require("./utils");
 const OrangebeardAsyncV3Client_1 = __importDefault(require("@orangebeard-io/javascript-client/dist/client/OrangebeardAsyncV3Client"));
-const StartTest_1 = require("@orangebeard-io/javascript-client/dist/client/models/StartTest");
 const Log_1 = require("@orangebeard-io/javascript-client/dist/client/models/Log");
 const FinishStep_1 = require("@orangebeard-io/javascript-client/dist/client/models/FinishStep");
-var TestType = StartTest_1.StartTest.TestType;
 var LogFormat = Log_1.Log.LogFormat;
 var LogLevel = Log_1.Log.LogLevel;
 var Status = FinishStep_1.FinishStep.Status;
@@ -62,6 +60,7 @@ class OrangebeardReporter {
         this.tests = new Map(); //testId, uuid
         this.steps = new Map(); //testId_stepPath, uuid
         this.promises = [];
+        this.processedStepAttachments = new Map(); // testId -> set of attachment keys already uploaded on step level
         this.client = new OrangebeardAsyncV3Client_1.default();
         this.config = this.client.config;
     }
@@ -135,6 +134,34 @@ class OrangebeardReporter {
     onStepEnd(test, _result, step) {
         const testUUID = this.tests.get(test.id);
         const stepUUID = this.steps.get(test.id + "|" + step.titlePath());
+        // Handle step-level attachments (similar to test-level attachments in onTestEnd)
+        if (step.attachments && step.attachments.length > 0 && stepUUID) {
+            let message = "";
+            for (const attachment of step.attachments) {
+                message += `- ${attachment.name} (${attachment.contentType})\\n`;
+            }
+            const attachmentsLogUUID = this.client.log({
+                logFormat: LogFormat.MARKDOWN,
+                logLevel: LogLevel.INFO,
+                logTime: (0, utils_1.getTime)(),
+                message: message,
+                testRunUUID: this.testRunId,
+                testUUID: testUUID,
+                stepUUID: stepUUID,
+            });
+            for (const attachment of step.attachments) {
+                // Track that this attachment has already been uploaded on the step level,
+                // so we can skip it when handling test-level attachments in onTestEnd.
+                const key = (0, utils_1.getAttachmentKey)(attachment);
+                let processedForTest = this.processedStepAttachments.get(test.id);
+                if (!processedForTest) {
+                    processedForTest = new Set();
+                    this.processedStepAttachments.set(test.id, processedForTest);
+                }
+                processedForTest.add(key);
+                this.promises.push(this.logAttachment(attachment, testUUID, attachmentsLogUUID));
+            }
+        }
         if (step.error) {
             const message = step.error.message;
             this.client.log({
@@ -165,15 +192,59 @@ class OrangebeardReporter {
         });
         this.steps.delete(test.id + "|" + step.titlePath());
     }
-    onTestBegin(test) {
+    onTestBegin(test, result) {
+        var _a;
         //check suite
         const suiteUUID = this.getOrStartSuite(test.parent.titlePath());
         const attributes = [];
+        // Tags -> attributes without key
         for (const tag of test.tags) {
             attributes.push({ value: tag });
         }
+        // Annotations -> structured attributes
+        for (const annotation of test.annotations) {
+            const description = (_a = annotation.description) === null || _a === void 0 ? void 0 : _a.trim();
+            switch (annotation.type) {
+                case 'issue':
+                case 'bug':
+                    if (description) {
+                        attributes.push({ key: 'Issue', value: description });
+                    }
+                    break;
+                case 'tag':
+                    if (description) {
+                        attributes.push({ value: description });
+                    }
+                    break;
+                case 'skip':
+                case 'slow':
+                case 'fixme':
+                case 'fail': {
+                    const value = description && description.length > 0 ? description : annotation.type;
+                    attributes.push({ key: 'PlaywrightAnnotation', value: value });
+                    if (annotation.type === 'fail') {
+                        // Mark tests annotated as expected-to-fail
+                        attributes.push({ key: 'ExpectedStatus', value: 'failed' });
+                        attributes.push({ key: 'ExpectedToFail', value: 'true' });
+                    }
+                    break;
+                }
+                default:
+                    if (description && description.length > 0) {
+                        attributes.push({ key: `annotation:${annotation.type}`, value: description });
+                    }
+                    else {
+                        attributes.push({ value: `annotation:${annotation.type}` });
+                    }
+            }
+        }
+        // If this is a retry attempt (retry index > 0), add a Retry attribute
+        if (typeof (result === null || result === void 0 ? void 0 : result.retry) === 'number' && result.retry > 0) {
+            attributes.push({ key: 'Retry', value: result.retry.toString() });
+        }
+        const testType = (0, utils_1.determineTestType)(test.parent.titlePath().join('>'));
         const testUUID = this.client.startTest({
-            testType: TestType.TEST,
+            testType: testType,
             testRunUUID: this.testRunId,
             suiteUUID: suiteUUID,
             testName: test.title,
@@ -186,10 +257,15 @@ class OrangebeardReporter {
     onTestEnd(test, result) {
         return __awaiter(this, void 0, void 0, function* () {
             const testUUID = this.tests.get(test.id);
-            if (result.attachments.length > 0) {
+            // Filter out attachments that were already handled at step level to avoid duplicates.
+            const processedForTest = this.processedStepAttachments.get(test.id);
+            const remainingAttachments = processedForTest
+                ? result.attachments.filter((attachment) => !processedForTest.has((0, utils_1.getAttachmentKey)(attachment)))
+                : result.attachments;
+            if (remainingAttachments.length > 0) {
                 let message = "";
-                for (const attachment of result.attachments) {
-                    message += `- ${attachment.name} (${attachment.contentType})\n`;
+                for (const attachment of remainingAttachments) {
+                    message += `- ${attachment.name} (${attachment.contentType})\\n`;
                 }
                 const attachmentsLogUUID = this.client.log({
                     logFormat: LogFormat.MARKDOWN,
@@ -199,12 +275,52 @@ class OrangebeardReporter {
                     testRunUUID: this.testRunId,
                     testUUID: testUUID
                 });
-                for (const attachment of result.attachments) {
+                for (const attachment of remainingAttachments) {
                     this.promises.push(this.logAttachment(attachment, testUUID, attachmentsLogUUID));
                 }
             }
+            // Log test-level errors that are not tied to specific steps (e.g. hooks/fixtures)
+            const errors = result.errors && result.errors.length > 0
+                ? result.errors
+                : (result.error ? [result.error] : []);
+            if (errors && errors.length > 0) {
+                let errorMessage = '';
+                for (let index = 0; index < errors.length; index += 1) {
+                    const err = errors[index];
+                    if (index > 0) {
+                        errorMessage += '\n\n';
+                    }
+                    if (err.message) {
+                        errorMessage += `**Error:** ${(0, utils_1.ansiToMarkdown)(err.message)}\n`;
+                    }
+                    if (err.stack) {
+                        errorMessage += `\`\`\`\n${(0, utils_1.removeAnsi)(err.stack)}\n\`\`\``;
+                    }
+                }
+                if (errorMessage.length > 0) {
+                    this.client.log({
+                        logFormat: LogFormat.MARKDOWN,
+                        logLevel: LogLevel.ERROR,
+                        logTime: (0, utils_1.getTime)(),
+                        message: errorMessage,
+                        testRunUUID: this.testRunId,
+                        testUUID: testUUID,
+                    });
+                }
+            }
             //determine status
             const status = utils_1.testStatusMap[result.status];
+            // If the test passed after one or more retries, mark it as flaky in the logs
+            if (typeof result.retry === 'number' && result.retry > 0 && status === Status.PASSED) {
+                this.client.log({
+                    logFormat: LogFormat.PLAIN_TEXT,
+                    logLevel: LogLevel.INFO,
+                    logTime: (0, utils_1.getTime)(),
+                    message: `Test passed after ${result.retry} retr${result.retry === 1 ? 'y' : 'ies'}`,
+                    testRunUUID: this.testRunId,
+                    testUUID: testUUID,
+                });
+            }
             //finish test
             this.client.finishTest(testUUID, {
                 testRunUUID: this.testRunId,
@@ -212,6 +328,7 @@ class OrangebeardReporter {
                 endTime: (0, utils_1.getTime)()
             });
             this.tests.delete(test.id);
+            this.processedStepAttachments.delete(test.id);
         });
     }
     printsToStdio() {
@@ -253,30 +370,38 @@ class OrangebeardReporter {
     }
     logAttachment(attachment, testUUID, logUUID) {
         return __awaiter(this, void 0, void 0, function* () {
-            let content;
-            if (attachment.body) {
-                content = attachment.body;
-            }
-            else if (attachment.path) {
-                content = yield (0, utils_1.getBytes)(attachment.path);
+            try {
+                let content;
+                if (attachment.body) {
+                    content = attachment.body;
+                }
+                else if (attachment.path) {
+                    content = yield (0, utils_1.getBytes)(attachment.path);
+                }
+                else {
+                    throw new Error("Attachment must have either body or path defined.");
+                }
+                const orangebeardAttachment = {
+                    file: {
+                        name: path.basename(attachment.path),
+                        content: content,
+                        contentType: attachment.contentType,
+                    },
+                    metaData: {
+                        testRunUUID: this.testRunId,
+                        testUUID: testUUID,
+                        logUUID: logUUID,
+                        attachmentTime: (0, utils_1.getTime)()
+                    },
+                };
+                yield this.client.sendAttachment(orangebeardAttachment);
             }
-            else {
-                throw new Error("Attachment must have either body or path defined.");
+            catch (err) {
+                // Avoid failing the entire test run due to a single attachment failure.
+                // Log to stderr so issues are visible during test execution.
+                // eslint-disable-next-line no-console
+                console.error('Error sending attachment to Orangebeard:', err);
             }
-            const orangebeardAttachment = {
-                file: {
-                    name: path.basename(attachment.path),
-                    content: content,
-                    contentType: attachment.contentType,
-                },
-                metaData: {
-                    testRunUUID: this.testRunId,
-                    testUUID: testUUID,
-                    logUUID: logUUID,
-                    attachmentTime: (0, utils_1.getTime)()
-                },
-            };
-            this.client.sendAttachment(orangebeardAttachment);
         });
     }
 }

package/dist/reporter/utils.js

@@ -47,11 +47,15 @@ exports.getTime = getTime;
 exports.removeAnsi = removeAnsi;
 exports.ansiToMarkdown = ansiToMarkdown;
 exports.getCodeSnippet = getCodeSnippet;
+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 util_1 = require("util");
 var Status = FinishTest_1.FinishTest.Status;
+const StartTest_1 = require("@orangebeard-io/javascript-client/dist/client/models/StartTest");
+var TestType = StartTest_1.StartTest.TestType;
 const stat = (0, util_1.promisify)(fs.stat);
 const access = (0, util_1.promisify)(fs.access);
 function getTime() {
@@ -175,3 +179,25 @@ const getBytes = (filePath) => __awaiter(void 0, void 0, void 0, function* () {
     }
 });
 exports.getBytes = getBytes;
+function getAttachmentKey(attachment) {
+    var _a, _b;
+    const size = attachment.body ? attachment.body.byteLength : undefined;
+    const pathOrSize = (_b = (_a = attachment.path) !== null && _a !== void 0 ? _a : size) !== null && _b !== void 0 ? _b : 'no-path-no-size';
+    return `${attachment.name}|${attachment.contentType}|${pathOrSize}`;
+}
+function determineTestType(parentTitlePath) {
+    const lower = parentTitlePath.toLowerCase();
+    if (lower.includes('beforeall') || lower.includes('before all')) {
+        return TestType.BEFORE;
+    }
+    if (lower.includes('afterall') || lower.includes('after all')) {
+        return TestType.AFTER;
+    }
+    if (lower.includes('setup')) {
+        return TestType.BEFORE;
+    }
+    if (lower.includes('teardown')) {
+        return TestType.AFTER;
+    }
+    return TestType.TEST;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@orangebeard-io/playwright-orangebeard-reporter",
-  "version": "1.0.5",
+  "version": "1.0.8",
   "description": "A Playwright reporter to report to Orangebeard.io",
   "main": "dist/index.js",
   "files": [
@@ -13,10 +13,7 @@
     "format:md": "prettier --write README.md",
     "format": "npm run format:js && npm run format:md",
     "test": "jest --unhandled-rejections=none --config ./jest.config.js",
-    "test:coverage": "jest --unhandled-rejections=none --coverage",
-    "get-version": "echo $npm_package_version",
-    "update-version": "release-it --ci --no-git --no-npm.publish",
-    "create-changelog": "auto-changelog --template changelog-template.hbs --starting-version v$npm_package_version"
+    "test:coverage": "jest --unhandled-rejections=none --coverage"
   },
   "repository": {
     "type": "git",
@@ -35,20 +32,18 @@
   },
   "homepage": "https://github.com/orangebeard-io/playwright-listener#readme",
   "devDependencies": {
-    "@playwright/test": "^1.49.0",
+    "@playwright/test": "^1.57.0",
     "@types/node": "^22.10.9",
     "@typescript-eslint/parser": "^8.15.0",
-    "auto-changelog": "^2.5.0",
     "eslint": "^9.15.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-prettier": "^5.2.1",
     "prettier": "^3.3.3",
-    "release-it": "^17.10.0",
     "rimraf": "^6.0.1",
     "typescript": "^5.6.3"
   },
   "dependencies": {
     "@js-joda/core": "^5.6.3",
-    "@orangebeard-io/javascript-client": "^2.0.7"
+    "@orangebeard-io/javascript-client": "^2.0.8"
   }
 }