@testomatio/reporter 2.6.0 → 2.6.2

package/lib/utils/log-formatter.d.ts

@@ -25,4 +25,5 @@ export function formatError(error: Error & {
     actual?: any;
     expected?: any;
 }, message?: string): string;
-export function stripColors(str: string): string;
+export const stripColors: typeof stripVTControlCharacters;
+import { stripVTControlCharacters } from 'util';

package/lib/utils/log-formatter.js

@@ -114,10 +114,14 @@ function formatError(error, message) {
  * @returns {boolean}
  */
 function isNotInternalFrame(frame) {
-    return (frame.getFileName() &&
-        frame.getFileName().includes(path_1.sep) &&
-        !frame.getFileName().includes('node_modules') &&
-        !frame.getFileName().includes('internal'));
+    const fileName = frame.getFileName();
+    if (!fileName)
+        return false;
+    const isFileUrl = fileName.startsWith('file://');
+    const hasPathSeparator = fileName.includes(path_1.sep) || fileName.includes('/') || isFileUrl;
+    return (hasPathSeparator &&
+        !fileName.includes('node_modules') &&
+        !fileName.includes('internal'));
 }
 
 module.exports.formatLogs = formatLogs;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "2.6.0",
+  "version": "2.6.2",
   "description": "Testomatio Reporter Client",
   "engines": {
     "node": ">=18"
@@ -24,7 +24,7 @@
     "csv-writer": "^1.6.0",
     "debug": "4.3.4",
     "dotenv": "^16.0.1",
-    "fast-xml-parser": "^4.4.1",
+    "fast-xml-parser": "^5.3.4",
     "file-url": "3.0.0",
     "filesize": "^10.1.6",
     "gaxios": ">=6.0 || >=7.0.0-rc.4 || <8",
@@ -44,6 +44,9 @@
     "strip-ansi": "7.1.0",
     "uuid": "^9.0.0"
   },
+  "overrides": {
+    "fast-xml-parser": "^5.3.4"
+  },
   "files": [
     "bin",
     "lib",

package/src/adapter/playwright.js

@@ -1,4 +1,3 @@
-import createDebugMessages from 'debug';
 import crypto from 'crypto';
 import os from 'os';
 import path from 'path';
@@ -11,9 +10,9 @@ import { services } from '../services/index.js';
 import { dataStorage } from '../data-storage.js';
 import { extensionMap } from '../utils/constants.js';
 import pc from 'picocolors';
+import { fetchLinksFromLogs } from './utils/playwright.js';
 
 const reportTestPromises = [];
-const debug = createDebugMessages('@testomatio/reporter:adapter-playwright');
 
 class PlaywrightReporter {
   constructor(config = {}) {
@@ -43,6 +42,16 @@ class PlaywrightReporter {
 
     const { title } = test;
     const { error, duration } = result;
+    const pwAttachments = (result.attachments || []).filter(a => a.body || a.path);
+
+    const files = pwAttachments
+      .map(att => ({
+        path: this.#getArtifactPath(att),
+        title: att.name || title,
+        type: att.contentType,
+      }))
+      .filter(f => f.path);
+
     const suite_title = test.parent ? test.parent?.title : path.basename(test?.location?.file);
 
     const steps = [];
@@ -60,7 +69,7 @@ class PlaywrightReporter {
 
     let logs = '';
     // get links along with filtered logs (liks related logs removed)
-    const { stdout: filteredStdout, links } = fetchLinksFromLogs(result.stdout);
+    const { stdout: filteredStdout, links, meta } = fetchLinksFromLogs(result.stdout);
     if (filteredStdout?.length || result.stderr?.length) {
       logs = `\n\n${pc.bold('Logs:')}\n${pc.red(result.stderr.join(''))}\n${filteredStdout.join('')}`;
     }
@@ -117,12 +126,14 @@ class PlaywrightReporter {
       logs,
       links,
       manuallyAttachedArtifacts,
+      files: files.length ? files : undefined,
       meta: {
         browser: project.browser,
         isMobile: project.isMobile,
         project: project.name,
         projectDependencies: project.dependencies?.length ? project.dependencies : null,
         ...testMeta,
+        ...meta,
         ...project.metadata, // metadata has any type (in playwright), but we will stringify it in client.js
         ...test.annotations?.reduce((acc, annotation) => {
           acc[annotation.type] = annotation.description;
@@ -135,7 +146,7 @@ class PlaywrightReporter {
     this.uploads.push({
       rid: `${rid}-${project.name}`,
       title: test.title,
-      files: result.attachments.filter(a => a.body || a.path),
+      files: pwAttachments,
       file: test.location?.file,
     });
     // remove empty uploads
@@ -303,80 +314,5 @@ function getTestContextName(test) {
   return `${test._requireFile || ''}_${test.title}`;
 }
 
-/**
- * Fetches links from stdout. Returns links and filtered stdout (without data containing markers)
- *
- * @param {(string | Buffer)[]} stdout
- * @returns {{ links: { [key: 'test' | 'jira']: string }[], stdout: (string | Buffer)[] }}
- */
-function fetchLinksFromLogs(stdout) {
-  const links = [];
-
-  const markers = [
-    { key: '[TESTOMATIO-LINK-TESTS]', type: 'test' },
-    { key: '[TESTOMATIO-LINK-JIRA]', type: 'jira' },
-  ];
-
-  const filteredStdout = [];
-
-  stdout.forEach(entry => {
-    if (typeof entry !== 'string') {
-      filteredStdout.push(entry);
-      return;
-    }
-
-    // check if entry contains any of markers
-    if (!markers.some(m => entry.includes(m.key))) {
-      filteredStdout.push(entry);
-      return;
-    }
-
-    const newEntryLines = [];
-    entry.split('\n').forEach(line => {
-      line = line.trim();
-      let hasMarker = false;
-      for (const marker of markers) {
-        if (line.includes(marker.key)) {
-          hasMarker = true;
-          try {
-            const rawJson = line.split(marker.key)[1]?.trim();
-            if (!rawJson) continue;
-
-            // smart JSON extraction: take until the last ']', otherwise take the whole string
-            const lastBracketIndex = rawJson.lastIndexOf(']');
-            const jsonStr = lastBracketIndex !== -1 ? rawJson.substring(0, lastBracketIndex + 1) : rawJson;
-
-            // test ids or jira ids
-            const ids = JSON.parse(jsonStr);
-            links.push(
-              ...ids
-                // filter non-truthy ids
-                .filter(id => !!id)
-                .map(id => ({
-                  // marker type is either 'test' or 'jira'
-                  [marker.type]: id,
-                })),
-            );
-          } catch (e) {
-            debug('Error parsing links from string:', line, '\n', e);
-          }
-        }
-      }
-      if (!hasMarker && line) {
-        newEntryLines.push(line);
-      }
-    });
-
-    if (newEntryLines.length) {
-      filteredStdout.push(newEntryLines.join('\n'));
-    }
-  });
-
-  return {
-    stdout: filteredStdout,
-    links,
-  };
-}
-
 export default PlaywrightReporter;
 export { extractTags, fetchLinksFromLogs };

package/src/adapter/utils/playwright.js

@@ -0,0 +1,121 @@
+import createDebugMessages from 'debug';
+const debug = createDebugMessages('@testomatio/reporter:adapter-playwright-utils');
+
+export const playwrightLogsMarkers = {
+  label: '[TESTOMATIO-LABEL]',
+  meta: '[TESTOMATIO-META]',
+  linkTest: '[TESTOMATIO-LINK-TEST]',
+  linkJira: '[TESTOMATIO-LINK-JIRA]',
+};
+
+/**
+ * Fetches links from stdout. Returns links and filtered stdout (without data containing markers)
+ *
+ * @param {(string | Buffer)[]} stdout
+ * @returns {{
+ *   links: { [key: 'test' | 'jira' | 'label']: string }[],
+ *   meta: { [key: string]: any },
+ *   stdout: (string | Buffer)[]
+ * }}
+ */
+export function fetchLinksFromLogs(stdout) {
+  const links = [];
+  const meta = {};
+
+  const markers = [
+    { key: playwrightLogsMarkers.linkTest, type: 'test' },
+    { key: playwrightLogsMarkers.linkJira, type: 'jira' },
+    { key: playwrightLogsMarkers.label, type: 'label' },
+    { key: playwrightLogsMarkers.meta, type: 'meta' },
+  ];
+
+  const filteredStdout = [];
+
+  stdout.forEach(entry => {
+    if (typeof entry !== 'string') {
+      filteredStdout.push(entry);
+      return;
+    }
+
+    // check if entry contains any of markers
+    if (!markers.some(m => entry.includes(m.key))) {
+      filteredStdout.push(entry);
+      return;
+    }
+
+    const newEntryLines = [];
+    entry.split('\n').forEach(line => {
+      line = line.trim();
+      let hasMarker = false;
+      for (const marker of markers) {
+        // links (test/jira/label) stored as array of objects
+        if (line.includes(marker.key)) {
+          hasMarker = true;
+          try {
+            const rawData = line.split(marker.key)[1]?.trim();
+            if (!rawData) continue;
+
+            let data;
+            try {
+              data = JSON.parse(rawData);
+            } catch (e) {
+              // Try to extract JSON from the beginning of the string (to handle trailing text)
+              const jsonMatch = rawData.match(/^\s*(\[.*?\]|\{.*?\})/);
+              if (jsonMatch) {
+                try {
+                  data = JSON.parse(jsonMatch[1]);
+                } catch (jsonError) {
+                  // If JSON extraction fails, skip this entry
+                  debug('Error parsing links from string:', line, '\n', jsonError);
+                  continue;
+                }
+              } else {
+                // No JSON found, skip this entry
+                debug('No valid JSON found in:', line);
+                continue;
+              }
+            }
+
+            if (marker.type === 'meta') {
+              // meta stored as an object, thus make it similar to links
+              Object.assign(meta, data);
+            } else {
+              const ids = Array.isArray(data) ? data : [data];
+              links.push(
+                ...ids
+                  // filter non-truthy ids
+                  .filter(id => !!id)
+                  .map(id => {
+                    // If id is already an object with the marker type key, return it as is
+                    if (typeof id === 'object' && id !== null && marker.type in id) {
+                      return id;
+                    }
+                    // Otherwise, wrap it with the marker type key
+                    return {
+                      // marker type is either 'test' or 'jira' or 'label'
+                      [marker.type]: id,
+                    };
+                  }),
+              );
+            }
+          } catch (e) {
+            debug('Error parsing links from string:', line, '\n', e);
+          }
+        }
+      }
+      if (!hasMarker && line) {
+        newEntryLines.push(line);
+      }
+    });
+
+    if (newEntryLines.length) {
+      filteredStdout.push(newEntryLines.join('\n'));
+    }
+  });
+
+  return {
+    stdout: filteredStdout,
+    links,
+    meta,
+  };
+}

package/src/adapter/vitest.js

@@ -101,7 +101,7 @@ class VitestReporter {
    *
    * @param {VitestTest} test
    *
-   * @returns {TestData & {status: string}}
+   * @returns {TestData & {status: 'passed' | 'failed' | 'skipped'}}
    */
   #getDataFromTest(test) {
     return {
@@ -109,6 +109,7 @@ class VitestReporter {
       file: test.file.name,
       logs: test.logs ? transformLogsToString(test.logs) : '',
       meta: test.meta,
+      // @ts-ignore - STATUS values are string literals but type system sees them as string
       status: getTestStatus(test),
       suite_title: test.suite.name || test.file?.name,
       test_id: getTestomatIdFromTestTitle(test.name),

package/src/bin/cli.js

@@ -15,7 +15,7 @@ import { filesize as prettyBytes } from 'filesize';
 import dotenv from 'dotenv';
 import Replay from '../replay.js';
 
-const debug = createDebugMessages('@testomatio/reporter:xml-cli');
+const debug = createDebugMessages('@testomatio/reporter:cli');
 const version = getPackageVersion();
 console.log(pc.cyan(pc.bold(` 🤩 Testomat.io Reporter v${version}`)));
 const program = new Command();

package/src/data-storage.js

@@ -139,6 +139,7 @@ class DataStorage {
         const testDataAsText = fs.readFileSync(filepath, 'utf-8');
         if (testDataAsText) debug('<=', dataType, 'file', context, testDataAsText);
         const testDataArr = testDataAsText?.split(os.EOL) || [];
+        debug('<=', dataType, 'file', context, testDataArr);
         return testDataArr;
       }
       // debug(`No ${this.dataType} data for ${context} in <file> storage`);

package/src/pipe/debug.js

@@ -15,7 +15,7 @@ export class DebugPipe {
     this.isEnabled = !!process.env.TESTOMATIO_DEBUG || !!process.env.DEBUG;
     if (this.isEnabled) {
       this.batch = {
-        isEnabled: this.params.isBatchEnabled ?? !process.env.TESTOMATIO_DISABLE_BATCH_UPLOAD ?? true,
+        isEnabled: this.params.isBatchEnabled ?? !process.env.TESTOMATIO_DISABLE_BATCH_UPLOAD,
         intervalFunction: null,
         intervalTime: 5000,
         tests: [],