@testomatio/reporter 2.7.0 → 2.7.2-beta.1

package/lib/utils/log.d.ts

@@ -0,0 +1,45 @@
+/**
+ * Get the current log level from TESTOMATIO_LOG_LEVEL environment variable.
+ * Defaults to INFO (info, warn, and error messages).
+ * @returns {number} Numeric log level (0-2)
+ */
+export function getLogLevel(): number;
+/**
+ * Check if a message should be logged based on its level.
+ * A message is logged if its level is <= the current log level,
+ * or if TESTOMATIO_DEBUG is set (for debugging with the debug package).
+ * @param {number} messageLevel - Message level (LOG_LEVELS value)
+ * @returns {boolean} True if the message should be logged
+ */
+export function shouldLog(messageLevel: number): boolean;
+/**
+ * Log an info message with [TESTOMATIO] prefix.
+ * Only logs when TESTOMATIO_LOG_LEVEL is INFO.
+ * @param {...any} args - Arguments to log
+ */
+export function info(...args: any[]): void;
+/**
+ * Log a warning message with [TESTOMATIO] prefix.
+ * Only logs when TESTOMATIO_LOG_LEVEL is WARN or INFO.
+ * @param {...any} args - Arguments to log
+ */
+export function warn(...args: any[]): void;
+/**
+ * Log an error message with [TESTOMATIO] prefix.
+ * Logs for all TESTOMATIO_LOG_LEVEL values.
+ * @param {...any} args - Arguments to log
+ */
+export function error(...args: any[]): void;
+export namespace LOG_LEVELS {
+    let ERROR: number;
+    let WARN: number;
+    let INFO: number;
+}
+export namespace log {
+    export { info };
+    export { warn };
+    export { error };
+    export { getLogLevel };
+    export { shouldLog };
+    export { LOG_LEVELS };
+}

package/lib/utils/log.js

@@ -0,0 +1,98 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.log = exports.LOG_LEVELS = void 0;
+exports.getLogLevel = getLogLevel;
+exports.shouldLog = shouldLog;
+exports.info = info;
+exports.warn = warn;
+exports.error = error;
+const constants_js_1 = require("../constants.js");
+/**
+ * Log levels for the Testomat.io reporter.
+ * A message is logged if its level is <= the current log level.
+ * @example
+ * TESTOMATIO_LOG_LEVEL=ERROR npx codeceptjs run  // Only errors
+ * TESTOMATIO_LOG_LEVEL=WARN npx codeceptjs run   // Warnings and errors
+ * TESTOMATIO_LOG_LEVEL=INFO npx codeceptjs run   // Info, warnings, errors (default)
+ */
+exports.LOG_LEVELS = {
+    ERROR: 0,
+    WARN: 1,
+    INFO: 2,
+};
+/**
+ * Get the current log level from TESTOMATIO_LOG_LEVEL environment variable.
+ * Defaults to INFO (info, warn, and error messages).
+ * @returns {number} Numeric log level (0-2)
+ */
+function getLogLevel() {
+    const envLevel = process.env.TESTOMATIO_LOG_LEVEL?.toUpperCase();
+    return exports.LOG_LEVELS[envLevel] ?? exports.LOG_LEVELS.INFO;
+}
+/**
+ * Check if a message should be logged based on its level.
+ * A message is logged if its level is <= the current log level,
+ * or if TESTOMATIO_DEBUG is set (for debugging with the debug package).
+ * @param {number} messageLevel - Message level (LOG_LEVELS value)
+ * @returns {boolean} True if the message should be logged
+ */
+function shouldLog(messageLevel) {
+    return messageLevel <= getLogLevel() || !!process.env.TESTOMATIO_DEBUG;
+}
+/**
+ * Log an info message with [TESTOMATIO] prefix.
+ * Only logs when TESTOMATIO_LOG_LEVEL is INFO.
+ * @param {...any} args - Arguments to log
+ */
+function info(...args) {
+    if (shouldLog(exports.LOG_LEVELS.INFO)) {
+        console.log(constants_js_1.APP_PREFIX, ...args);
+    }
+}
+/**
+ * Log a warning message with [TESTOMATIO] prefix.
+ * Only logs when TESTOMATIO_LOG_LEVEL is WARN or INFO.
+ * @param {...any} args - Arguments to log
+ */
+function warn(...args) {
+    if (shouldLog(exports.LOG_LEVELS.WARN)) {
+        console.warn(constants_js_1.APP_PREFIX, ...args);
+    }
+}
+/**
+ * Log an error message with [TESTOMATIO] prefix.
+ * Logs for all TESTOMATIO_LOG_LEVEL values.
+ * @param {...any} args - Arguments to log
+ */
+function error(...args) {
+    if (shouldLog(exports.LOG_LEVELS.ERROR)) {
+        console.error(constants_js_1.APP_PREFIX, ...args);
+    }
+}
+/**
+ * Logging utility for Testomat.io reporter.
+ * All messages are prefixed with [TESTOMATIO] and respect TESTOMATIO_LOG_LEVEL.
+ * @example
+ * import { log } from './utils/log.js';
+ * log.info('Test started');
+ * log.warn('This is a warning');
+ * log.error('Something went wrong');
+ */
+exports.log = {
+    info,
+    warn,
+    error,
+    getLogLevel,
+    shouldLog,
+    LOG_LEVELS: exports.LOG_LEVELS,
+};
+
+module.exports.getLogLevel = getLogLevel;
+
+module.exports.shouldLog = shouldLog;
+
+module.exports.info = info;
+
+module.exports.warn = warn;
+
+module.exports.error = error;

package/lib/utils/pipe_utils.js

@@ -7,7 +7,7 @@ exports.setS3Credentials = setS3Credentials;
 exports.statusEmoji = statusEmoji;
 exports.fullName = fullName;
 exports.parsePipeOptions = parsePipeOptions;
-const constants_js_1 = require("../constants.js");
+const log_js_1 = require("./log.js");
 /**
  * Set S3 credentials from the provided artifacts object.
  * @param {Object} artifacts - The artifacts object containing S3 credentials.
@@ -15,7 +15,7 @@ const constants_js_1 = require("../constants.js");
 function setS3Credentials(artifacts) {
     if (!Object.keys(artifacts).length)
         return;
-    console.log(constants_js_1.APP_PREFIX, 'S3 credentials obtained from Testomat.io...');
+    log_js_1.log.info('S3 credentials obtained from Testomat.io...');
     if (artifacts.ACCESS_KEY_ID)
         process.env.S3_ACCESS_KEY_ID = artifacts.ACCESS_KEY_ID;
     if (artifacts.SECRET_ACCESS_KEY)
@@ -41,7 +41,7 @@ function setS3Credentials(artifacts) {
 function generateFilterRequestParams(params) {
     // Defensive check: ensure params is an object
     if (!params || typeof params !== 'object') {
-        console.error(constants_js_1.APP_PREFIX, `Invalid parameters provided. Expected an object, got: ${typeof params}`);
+        log_js_1.log.error(`Invalid parameters provided. Expected an object, got: ${typeof params}`);
         return;
     }
     const { type, id, apiKey } = params;
@@ -49,7 +49,7 @@ function generateFilterRequestParams(params) {
         return;
     }
     if (!id) {
-        console.error(constants_js_1.APP_PREFIX, `Please make sure your settings "${type.toUpperCase()}"= "${id}" is correct!`);
+        log_js_1.log.error(`Please make sure your settings "${type.toUpperCase()}"= "${id}" is correct!`);
         return;
     }
     return {
@@ -100,7 +100,7 @@ function updateFilterType(type) {
         // "ims-issue", //TODO: WIP
     ];
     if (!filterTypes.includes(typeLowerCase)) {
-        console.log(constants_js_1.APP_PREFIX, `❗❗❗ Invalid filter: "${type}" start settings! Available option list: ${filterTypes}`);
+        log_js_1.log.error(`❗ Invalid filter: "${type}" start settings! Available option list: ${filterTypes}`);
         return;
     }
     const index = filterTypes.indexOf(typeLowerCase);

package/lib/utils/utils.d.ts

@@ -29,6 +29,16 @@ export function getGitCommitSha(): string | null;
  */
 export function getTestomatIdFromTestTitle(testTitle: string): string | null;
 export function humanize(text: any): any;
+/**
+ * Checks whether a value is an HTTP(S) URL.
+ *
+ * Used for artifact handling: if a step artifact is already a remote URL,
+ * it should not be uploaded again as a local file path.
+ *
+ * @param {*} value - Artifact value to validate
+ * @returns {boolean} true when value starts with http:// or https://
+ */
+export function isHttpUrl(value: any): boolean;
 export function isValidUrl(s: any): boolean;
 /**
  * @param {String} suiteTitle - suite title

package/lib/utils/utils.js

@@ -36,7 +36,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateSuiteId = exports.testRunnerHelper = exports.specificTestInfo = exports.parseSuite = exports.isValidUrl = exports.humanize = exports.getTestomatIdFromTestTitle = exports.getGitCommitSha = exports.getCurrentDateTime = exports.foundedTestLog = exports.fileSystem = exports.fetchFilesFromStackTrace = exports.fetchIdFromOutput = exports.fetchIdFromCode = exports.fetchSourceCodeFromStackTrace = exports.fetchSourceCode = exports.isSameTest = exports.ansiRegExp = exports.SUITE_ID_REGEX = exports.TEST_ID_REGEX = void 0;
+exports.validateSuiteId = exports.testRunnerHelper = exports.specificTestInfo = exports.parseSuite = exports.isValidUrl = exports.isHttpUrl = exports.humanize = exports.getTestomatIdFromTestTitle = exports.getGitCommitSha = exports.getCurrentDateTime = exports.foundedTestLog = exports.fileSystem = exports.fetchFilesFromStackTrace = exports.fetchIdFromOutput = exports.fetchIdFromCode = exports.fetchSourceCodeFromStackTrace = exports.fetchSourceCode = exports.isSameTest = exports.ansiRegExp = exports.SUITE_ID_REGEX = exports.TEST_ID_REGEX = void 0;
 exports.getPackageVersion = getPackageVersion;
 exports.truncate = truncate;
 exports.cleanLatestRunId = cleanLatestRunId;
@@ -134,6 +134,19 @@ const isValidUrl = s => {
     }
 };
 exports.isValidUrl = isValidUrl;
+/**
+ * Checks whether a value is an HTTP(S) URL.
+ *
+ * Used for artifact handling: if a step artifact is already a remote URL,
+ * it should not be uploaded again as a local file path.
+ *
+ * @param {*} value - Artifact value to validate
+ * @returns {boolean} true when value starts with http:// or https://
+ */
+const isHttpUrl = value => {
+    return /^https?:\/\//i.test(String(value || ''));
+};
+exports.isHttpUrl = isHttpUrl;
 const fileMatchRegex = /file:(\/*)([A-Za-z]:[\\/].*?|\/.*?)\.(png|avi|webm|jpg|html|txt)/gi;
 const fetchFilesFromStackTrace = (stack = '', checkExists = true) => {
     let files = Array.from(stack.matchAll(fileMatchRegex))
@@ -738,6 +751,8 @@ module.exports.ansiRegExp = ansiRegExp;
 
 module.exports.isValidUrl = isValidUrl;
 
+module.exports.isHttpUrl = isHttpUrl;
+
 module.exports.fetchFilesFromStackTrace = fetchFilesFromStackTrace;
 
 module.exports.fetchSourceCodeFromStackTrace = fetchSourceCodeFromStackTrace;

package/lib/xmlReader.js

@@ -17,6 +17,7 @@ const index_js_1 = require("./pipe/index.js");
 const index_js_2 = __importDefault(require("./junit-adapter/index.js"));
 const config_js_1 = require("./config.js");
 const uploader_js_1 = require("./uploader.js");
+const log_js_1 = require("./utils/log.js");
 // @ts-ignore this line will be removed in compiled code, because __dirname is defined in commonjs
 const debug = (0, debug_1.default)('@testomatio/reporter:xml');
 const ridRunId = (0, crypto_1.randomUUID)();
@@ -62,7 +63,7 @@ class XmlReader {
         // @ts-ignore
         const packageJsonPath = path_1.default.resolve(__dirname, '..', 'package.json');
         this.version = JSON.parse(fs_1.default.readFileSync(packageJsonPath).toString()).version;
-        console.log(constants_js_1.APP_PREFIX, `Testomatio Reporter v${this.version}`);
+        log_js_1.log.info(`Testomatio Reporter v${this.version}`);
     }
     connectAdapter() {
         if (this.opts.javaTests) {
@@ -435,7 +436,7 @@ class XmlReader {
                 continue;
             const runId = this.runId || this.store.runId || Date.now().toString();
             test.artifacts = await Promise.all(files.map(f => this.uploader.uploadFileByPath(f, [runId, path_1.default.basename(f)])));
-            console.log(constants_js_1.APP_PREFIX, `🗄️ Uploaded ${picocolors_1.default.bold(`${files.length} artifacts`)} for test ${test.title}`);
+            log_js_1.log.info(`🗄️ Uploaded ${picocolors_1.default.bold(`${files.length} artifacts`)} for test ${test.title}`);
         }
     }
     async createRun() {
@@ -528,10 +529,10 @@ class XmlReader {
             debug(`Uploaded ${uploadedTests}/${totalTests} tests`);
         }
         if (totalChunks > 1) {
-            console.log(constants_js_1.APP_PREFIX, `✅ Successfully uploaded ${uploadedTests} tests in ${totalChunks} chunks`);
+            log_js_1.log.info(`✅ Successfully uploaded ${uploadedTests} tests in ${totalChunks} chunks`);
         }
         else {
-            console.log(constants_js_1.APP_PREFIX, `✅ Successfully uploaded ${uploadedTests} tests`);
+            log_js_1.log.info(`✅ Successfully uploaded ${uploadedTests} tests`);
         }
         const finishData = {
             api_key: this.requestParams.apiKey,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "2.7.0",
+  "version": "2.7.2-beta.1",
   "description": "Testomatio Reporter Client",
   "engines": {
     "node": ">=18"

package/src/adapter/codecept.js

@@ -1,11 +1,13 @@
 import createDebugMessages from 'debug';
 import pc from 'picocolors';
 import TestomatClient from '../client.js';
-import { STATUS, APP_PREFIX, TESTOMAT_TMP_STORAGE_DIR } from '../constants.js';
+import { STATUS, APP_PREFIX, TESTOMAT_TMP_STORAGE_DIR, SCREENSHOTS_ON_STEPS } from '../constants.js';
 import { getTestomatIdFromTestTitle, truncate, fileSystem } from '../utils/utils.js';
 import { services } from '../services/index.js';
 import { dataStorage } from '../data-storage.js';
+import { formatStep, addStatusToStep, addArtifactsToStep, addArtifactPathToStep } from './utils/step-formatter.js';
 import codeceptjs from 'codeceptjs';
+import { log } from '../utils/log.js';
 
 const debug = createDebugMessages('@testomatio/reporter:adapter:codeceptjs');
 // @ts-ignore
@@ -48,6 +50,7 @@ function CodeceptReporter(config) {
   let videos = [];
   let traces = [];
   const reportTestPromises = [];
+  let isRunFinalized = false;
 
   const testTimeMap = {};
   const { apiKey } = config;
@@ -84,6 +87,19 @@ function CodeceptReporter(config) {
   const hookSteps = new Map();
   let currentHook = null;
 
+  const finalizeRun = async origin => {
+    if (isRunFinalized) return;
+    isRunFinalized = true;
+
+    debug(`finalizing run from ${origin}`);
+    debug('waiting for all tests to be reported');
+
+    await Promise.allSettled(reportTestPromises);
+    await uploadAttachments(client, videos, '🎞️ Uploading', 'video');
+    await uploadAttachments(client, traces, '📁 Uploading', 'trace');
+    await client.updateRunStatus('finished');
+  };
+
   event.dispatcher.on(event.workers.before, () => {
     recorder.add('Creating new run', async () => {
       await client.createRun();
@@ -94,7 +110,9 @@ function CodeceptReporter(config) {
   });
 
   event.dispatcher.on(event.workers.after, () => {
-    client.updateRunStatus('finished');
+    recorder.add('Finishing run', async () => {
+      await finalizeRun('workers.after');
+    });
   });
 
   // Listening to events
@@ -108,6 +126,8 @@ function CodeceptReporter(config) {
     });
     videos = [];
     traces = [];
+    isRunFinalized = false;
+    reportTestPromises.length = 0;
 
     if (!global.testomatioDataStore) global.testomatioDataStore = {};
   });
@@ -141,7 +161,7 @@ function CodeceptReporter(config) {
     const error = hook?.ctx?.currentTest?.err;
 
     for (const test of suite.tests) {
-      client.addTestRun('failed', {
+      const reportTestPromise = client.addTestRun('failed', {
         ...stripExampleFromTitle(test.title),
         rid: test.uid,
         test_id: getTestomatIdFromTestTitle(test.title),
@@ -149,6 +169,7 @@ function CodeceptReporter(config) {
         error,
         time: hook?.runnable?.duration,
       });
+      reportTestPromises.push(reportTestPromise);
     }
   });
 
@@ -170,15 +191,10 @@ function CodeceptReporter(config) {
     testTimeMap[test.uid] = Date.now();
   });
 
-  event.dispatcher.on(event.all.result, async result => {
-    debug('waiting for all tests to be reported');
-    // all tests were reported and we can upload videos
-    await Promise.all(reportTestPromises);
-
-    await uploadAttachments(client, videos, '🎞️ Uploading', 'video');
-    await uploadAttachments(client, traces, '📁 Uploading', 'trace');
-
-    client.updateRunStatus('finished');
+  event.dispatcher.on(event.all.after, () => {
+    recorder.add('Finishing run', async () => {
+      await finalizeRun('all.after');
+    });
   });
 
   event.dispatcher.on(event.test.after, test => {
@@ -190,12 +206,19 @@ function CodeceptReporter(config) {
     const logs = getTestLogs(test);
     const manuallyAttachedArtifacts = services.artifacts.get(test.fullTitle());
     const keyValues = services.keyValues.get(test.fullTitle());
-    const stepHierarchy = buildUnifiedStepHierarchy(test.steps, hookSteps);
     const links = services.links.get(test.fullTitle());
+    const screenshotOnFailPath = artifacts.screenshot || null;
+
+    // Build step hierarchy with screenshot from screenshotOnFail
+    const stepHierarchy = buildUnifiedStepHierarchy(
+      test.steps, 
+      hookSteps, 
+      screenshotOnFailPath
+    );
 
     services.setContext(null);
 
-    client.addTestRun(test.state, {
+    const reportTestPromise = client.addTestRun(test.state, {
       ...stripExampleFromTitle(title),
       rid: uid,
       test_id: getTestomatIdFromTestTitle(`${title} ${tags?.join(' ')}`),
@@ -210,6 +233,7 @@ function CodeceptReporter(config) {
       manuallyAttachedArtifacts,
       meta: { ...keyValues, ...test.meta },
     });
+    reportTestPromises.push(reportTestPromise);
 
     processArtifactsForUpload(artifacts, uid, title, videos, traces);
   });
@@ -229,7 +253,7 @@ async function uploadAttachments(client, attachments, messagePrefix, attachmentT
   if (!attachments?.length) return;
 
   if (client.uploader.isEnabled) {
-    console.log(APP_PREFIX, `Attachments: ${messagePrefix} ${attachments.length} ${attachmentType} ...`);
+    log.info(`Attachments: ${messagePrefix} ${attachments.length} ${attachmentType} ...`);
   }
 
   const promises = attachments.map(async attachment => {
@@ -372,7 +396,7 @@ function getTestLogs(test) {
 }
 
 // Build step hierarchy using CodeceptJS built-in methods
-function buildUnifiedStepHierarchy(steps, hookSteps) {
+function buildUnifiedStepHierarchy(steps, hookSteps, screenshotOnFailPath = null) {
   const hierarchy = [];
 
   // Add pre-test hooks
@@ -380,7 +404,7 @@ function buildUnifiedStepHierarchy(steps, hookSteps) {
 
   // Process test steps if they exist
   if (steps && steps.length > 0) {
-    processTestSteps(steps, hierarchy);
+    processTestSteps(steps, hierarchy, screenshotOnFailPath);
   }
 
   // Add post-test hooks
@@ -398,11 +422,18 @@ function addHooksToHierarchy(hierarchy, hookSteps, hookNames) {
   }
 }
 
-function processTestSteps(steps, hierarchy) {
+function processTestSteps(steps, hierarchy, screenshotOnFailPath = null) {
   const sectionMap = new Map();
+  let screenshotAttached = false;
 
   for (const step of steps) {
-    const formattedStep = formatCodeceptStep(step);
+    let stepScreenshotPath = null;
+    if (screenshotOnFailPath && !screenshotAttached && step.status === 'failed') {
+      stepScreenshotPath = screenshotOnFailPath;
+      screenshotAttached = true;
+    }
+
+    const formattedStep = formatCodeceptStep(step, stepScreenshotPath);
     if (!formattedStep) continue;
 
     if (step.metaStep) {
@@ -460,27 +491,45 @@ function formatHookName(hookName) {
 }
 
 // Format CodeceptJS step using its built-in methods
-function formatCodeceptStep(step) {
+function formatCodeceptStep(step, screenshotOnFailPath = null) {
   if (!step) return null;
 
   const category = step.constructor.name === 'HelperStep' ? 'framework' : 'user';
-  const title = truncate(step); // Use built-in toString
-  const duration = step.duration || 0; // Use built-in duration
+  const title = truncate(String(step));
+  const duration = step.duration || 0;
 
-  const formattedStep = {
+  const formattedStep = formatStep({
     category,
     title,
     duration,
-  };
+  });
+
+  // Add status
+  addStatusToStep(formattedStep, step.status, step.err);
 
   // Add error if step failed
   if (step.status === 'failed' && step.err) {
     formattedStep.error = {
-      message: step.err.message || 'Step failed',
-      stack: step.err.stack || '',
+      message: truncate(String(step.err.message || 'Step failed'), 250),
+      stack: truncate(String(step.err.stack || ''), 250),
     };
   }
 
+  // Add artifacts
+  if (step.artifacts && SCREENSHOTS_ON_STEPS) {
+    addArtifactsToStep(formattedStep, step.artifacts);
+  }
+
+  // Add screenshot from screenshotOnFail plugin
+  if (screenshotOnFailPath && SCREENSHOTS_ON_STEPS) {
+    addArtifactPathToStep(formattedStep, screenshotOnFailPath);
+  }
+
+  // Add log if present
+  if (step.log) {
+    formattedStep.log = truncate(String(step.log), 250);
+  }
+
   return formattedStep;
 }
 
@@ -492,17 +541,38 @@ function formatHookStep(step) {
   if (step.actor && step.name) {
     title = `${step.actor} ${step.name}`;
     if (step.args && step.args.length > 0) {
-      const argsStr = step.args.map(arg => truncate(JSON.stringify(arg))).join(', ');
+      const argsStr = step.args.map(arg => truncate(JSON.stringify(arg), 250)).join(', ');
       title += ` ${argsStr}`;
     }
   }
   title = truncate(title);
 
-  return {
+  const formattedStep = formatStep({
     category: 'hook',
     title,
     duration: step.duration || 0,
-  };
+  });
+
+  addStatusToStep(formattedStep, step.status, step.err);
+
+  if (step.status === 'failed' && step.err) {
+    formattedStep.error = {
+      message: truncate(String(step.err.message || 'Hook failed'), 250),
+      stack: truncate(String(step.err.stack || ''), 250),
+    };
+  }
+
+  // Add artifacts
+  if (step.artifacts && SCREENSHOTS_ON_STEPS) {
+    addArtifactsToStep(formattedStep, step.artifacts);
+  }
+
+  // Add log if present
+  if (step.log) {
+    formattedStep.log = truncate(String(step.log), 250);
+  }
+
+  return formattedStep;
 }
 
 export { CodeceptReporter };