@testomatio/reporter 2.4.0 → 2.5.0

package/lib/reporter-functions.d.ts

@@ -28,9 +28,15 @@ declare function logMessage(...args: any[]): void;
 /**
  * Similar to "log" function but marks message in report as a step
  * @param {string} message - step message
+ * @param {{[key: string]: any}} [logs] optional key-value object with additional info, e.g. logs
  * @returns {void}
+ *
+ * Example:
+ * step('Get response', { logs: {status: 'success'} });
  */
-declare function addStep(message: string): void;
+declare function addStep(message: string, logs?: {
+    [key: string]: any;
+}): void;
 /**
  * Add key-value pair(s) to the test report
  * @param {{[key: string]: string} | string} keyValue - object { key: value } (multiple props allowed) or key (string)

package/lib/reporter-functions.js

@@ -25,14 +25,20 @@ function logMessage(...args) {
 /**
  * Similar to "log" function but marks message in report as a step
  * @param {string} message - step message
+ * @param {{[key: string]: any}} [logs] optional key-value object with additional info, e.g. logs
  * @returns {void}
+ *
+ * Example:
+ * step('Get response', { logs: {status: 'success'} });
  */
-function addStep(message) {
-    index_js_1.services.logger.step(message);
+function addStep(message, logs) {
     // this is done because Playwright reporter intercepts console logs and then we gather them and show on Testomat
     // if not console.log, the step message will be lost from reporter
     if (helpers_js_1.isPlaywright)
-        console.log(`Step: ${message}`);
+        index_js_1.services.logger._templateLiteralLog(message, logs);
+    // all other frameworks
+    else
+        index_js_1.services.logger.step(message, logs);
 }
 /**
  * Add key-value pair(s) to the test report

package/lib/reporter.d.ts

@@ -62,6 +62,7 @@ export const logger: {
     step(strings: any, ...values: any[]): void;
     getLogs(context: string): string[];
     "__#14@#stringifyLogs"(...args: any[]): string;
+    "__#14@#formatMessage"(strings: any, ...args: any[]): string;
     _templateLiteralLog(strings: any, ...args: any[]): void;
     "__#14@#logWrapper"(argsArray: any, level: any): void;
     assert(...args: any[]): void;
@@ -82,7 +83,9 @@ export const logger: {
 export const meta: (keyValue: {
     [key: string]: string;
 } | string, value?: string | null) => void;
-export const step: (message: string) => void;
+export const step: (message: string, logs?: {
+    [key: string]: any;
+}) => void;
 export const label: (key: string, value?: string | null) => void;
 export const linkTest: (...testIds: string[]) => void;
 export const linkJira: (...jiraIds: string[]) => void;
@@ -138,6 +141,7 @@ declare namespace _default {
         step(strings: any, ...values: any[]): void;
         getLogs(context: string): string[];
         "__#14@#stringifyLogs"(...args: any[]): string;
+        "__#14@#formatMessage"(strings: any, ...args: any[]): string;
         _templateLiteralLog(strings: any, ...args: any[]): void;
         "__#14@#logWrapper"(argsArray: any, level: any): void;
         assert(...args: any[]): void;
@@ -212,6 +216,7 @@ declare namespace _default {
         step(strings: any, ...values: any[]): void;
         getLogs(context: string): string[];
         "__#14@#stringifyLogs"(...args: any[]): string;
+        "__#14@#formatMessage"(strings: any, ...args: any[]): string;
         _templateLiteralLog(strings: any, ...args: any[]): void;
         "__#14@#logWrapper"(argsArray: any, level: any): void;
         assert(...args: any[]): void;
@@ -232,7 +237,9 @@ declare namespace _default {
     export let meta: (keyValue: {
         [key: string]: string;
     } | string, value?: string | null) => void;
-    export let step: (message: string) => void;
+    export let step: (message: string, logs?: {
+        [key: string]: any;
+    }) => void;
     export let label: (key: string, value?: string | null) => void;
     export let linkTest: (...testIds: string[]) => void;
     export let linkJira: (...jiraIds: string[]) => void;

package/lib/services/logger.d.ts

@@ -26,8 +26,8 @@ declare class Logger {
      */
     getLogs(context: string): string[];
     /**
-     * Tagget template literal. Allows to use different syntaxes:
-     * 1. Tagget template: log`text ${someVar}`
+     * Tagged template literal. Allows to use different syntaxes:
+     * 1. Tagged template: log`text ${someVar}`
      * 2. Standard: log(`text ${someVar}`)
      * 3. Standard with multiple arguments: log('text', someVar)
      */

package/lib/services/logger.js

@@ -54,14 +54,10 @@ class Logger {
      * @param  {...any} values
      */
     step(strings, ...values) {
-        let logs = '';
-        for (let i = 0; i < strings.length; i++) {
-            logs += strings[i];
-            if (i < values.length) {
-                logs += values[i];
-            }
-        }
-        logs = picocolors_1.default.blue(`> ${logs}`);
+        // Filter trailing undefined from optional params (e.g., step('message') called without second arg)
+        const filteredValues = values.filter(v => v !== undefined);
+        const message = this.#formatMessage(strings, ...filteredValues);
+        const logs = picocolors_1.default.blue(`> ${message}`);
         data_storage_js_1.dataStorage.putData('log', logs);
     }
     /**
@@ -82,7 +78,13 @@ class Logger {
             // ignore empty strings
             if (arg === '')
                 continue;
-            if (typeof arg === 'string') {
+            if (arg === undefined) {
+                logs.push('undefined');
+            }
+            else if (arg === null) {
+                logs.push('null');
+            }
+            else if (typeof arg === 'string') {
                 logs.push(arg);
             }
             else if (Array.isArray(arg)) {
@@ -101,36 +103,37 @@ class Logger {
         return logs.join(' ');
     }
     /**
-     * Tagget template literal. Allows to use different syntaxes:
-     * 1. Tagget template: log`text ${someVar}`
-     * 2. Standard: log(`text ${someVar}`)
-     * 3. Standard with multiple arguments: log('text', someVar)
+     * Formats a message from either tagged template literal or standard function call.
+     * @param {*} strings - Template strings array or first argument
+     * @param {...any} args - Template values or additional arguments
+     * @returns {string} Formatted message
      */
-    _templateLiteralLog(strings, ...args) {
-        if (Array.isArray(strings))
-            strings = strings.filter(item => item !== '').map(item => item.trim());
+    #formatMessage(strings, ...args) {
         if (Array.isArray(args))
             args = args.filter(item => item !== '');
-        let logs;
-        // this block means tagged template is used (syntax like $`text ${someVar}`)
+        // Tagged template syntax: func`text ${someVar}`
         if (Array.isArray(strings) && strings.length === args.length + 1) {
-            logs = strings.reduce((result, current, index) => result +
+            return strings.reduce((result, current, index) => result +
                 current +
-                // strings are splitted by args when use tagged template, thus we add arg after each string
-                // it looks like: `string1 arg1 string2 arg2 string3`
-                (args[index] !== undefined
-                    ? typeof args[index] === 'string'
-                        ? args[index] // add arg as it is
-                        : this.#stringifyLogs(args[index]) // stringify arg
-                    : ''), 
-            // initial accumulator value
-            '');
-        }
-        else {
-            // this block means arguments syntax is used (syntax like $('text', someVar))
-            // in this case strings represents just a first argument
-            logs = this.#stringifyLogs(strings, ...args);
+                (index < args.length
+                    ? args[index] === undefined
+                        ? 'undefined'
+                        : typeof args[index] === 'string'
+                            ? args[index]
+                            : this.#stringifyLogs(args[index])
+                    : ''), '');
         }
+        // Standard function call: func('text', someVar)
+        return this.#stringifyLogs(strings, ...args);
+    }
+    /**
+     * Tagged template literal. Allows to use different syntaxes:
+     * 1. Tagged template: log`text ${someVar}`
+     * 2. Standard: log(`text ${someVar}`)
+     * 3. Standard with multiple arguments: log('text', someVar)
+     */
+    _templateLiteralLog(strings, ...args) {
+        const logs = this.#formatMessage(strings, ...args);
         this.#originalUserLogger.log(logs);
         data_storage_js_1.dataStorage.putData('log', logs);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "2.4.0",
+  "version": "2.5.0",
   "description": "Testomatio Reporter Client",
   "engines": {
     "node": ">=18"

package/src/reporter-functions.js

@@ -25,13 +25,18 @@ function logMessage(...args) {
 /**
  * Similar to "log" function but marks message in report as a step
  * @param {string} message - step message
+ * @param {{[key: string]: any}} [logs] optional key-value object with additional info, e.g. logs
  * @returns {void}
+ *
+ * Example:
+ * step('Get response', { logs: {status: 'success'} });
  */
-function addStep(message) {
-  services.logger.step(message);
+function addStep(message, logs) {
   // this is done because Playwright reporter intercepts console logs and then we gather them and show on Testomat
   // if not console.log, the step message will be lost from reporter
-  if (isPlaywright) console.log(`Step: ${message}`);
+  if (isPlaywright) services.logger._templateLiteralLog(message, logs);
+  // all other frameworks
+  else services.logger.step(message, logs);
 }
 
 /**

package/src/services/logger.js

@@ -59,14 +59,10 @@ class Logger {
    * @param  {...any} values
    */
   step(strings, ...values) {
-    let logs = '';
-    for (let i = 0; i < strings.length; i++) {
-      logs += strings[i];
-      if (i < values.length) {
-        logs += values[i];
-      }
-    }
-    logs = pc.blue(`> ${logs}`);
+    // Filter trailing undefined from optional params (e.g., step('message') called without second arg)
+    const filteredValues = values.filter(v => v !== undefined);
+    const message = this.#formatMessage(strings, ...filteredValues);
+    const logs = pc.blue(`> ${message}`);
     dataStorage.putData('log', logs);
   }
 
@@ -87,7 +83,11 @@ class Logger {
     for (const arg of args) {
       // ignore empty strings
       if (arg === '') continue;
-      if (typeof arg === 'string') {
+      if (arg === undefined) {
+        logs.push('undefined');
+      } else if (arg === null) {
+        logs.push('null');
+      } else if (typeof arg === 'string') {
         logs.push(arg);
       } else if (Array.isArray(arg)) {
         logs.push(arg.join(' '));
@@ -104,37 +104,42 @@ class Logger {
   }
 
   /**
-   * Tagget template literal. Allows to use different syntaxes:
-   * 1. Tagget template: log`text ${someVar}`
-   * 2. Standard: log(`text ${someVar}`)
-   * 3. Standard with multiple arguments: log('text', someVar)
+   * Formats a message from either tagged template literal or standard function call.
+   * @param {*} strings - Template strings array or first argument
+   * @param {...any} args - Template values or additional arguments
+   * @returns {string} Formatted message
    */
-  _templateLiteralLog(strings, ...args) {
-    if (Array.isArray(strings)) strings = strings.filter(item => item !== '').map(item => item.trim());
+  #formatMessage(strings, ...args) {
     if (Array.isArray(args)) args = args.filter(item => item !== '');
 
-    let logs;
-    // this block means tagged template is used (syntax like $`text ${someVar}`)
+    // Tagged template syntax: func`text ${someVar}`
     if (Array.isArray(strings) && strings.length === args.length + 1) {
-      logs = strings.reduce(
+      return strings.reduce(
         (result, current, index) =>
           result +
           current +
-          // strings are splitted by args when use tagged template, thus we add arg after each string
-          // it looks like: `string1 arg1 string2 arg2 string3`
-          (args[index] !== undefined
-            ? typeof args[index] === 'string'
-              ? args[index] // add arg as it is
-              : this.#stringifyLogs(args[index]) // stringify arg
+          (index < args.length
+            ? args[index] === undefined
+              ? 'undefined'
+              : typeof args[index] === 'string'
+                ? args[index]
+                : this.#stringifyLogs(args[index])
             : ''),
-        // initial accumulator value
         '',
       );
-    } else {
-      // this block means arguments syntax is used (syntax like $('text', someVar))
-      // in this case strings represents just a first argument
-      logs = this.#stringifyLogs(strings, ...args);
     }
+    // Standard function call: func('text', someVar)
+    return this.#stringifyLogs(strings, ...args);
+  }
+
+  /**
+   * Tagged template literal. Allows to use different syntaxes:
+   * 1. Tagged template: log`text ${someVar}`
+   * 2. Standard: log(`text ${someVar}`)
+   * 3. Standard with multiple arguments: log('text', someVar)
+   */
+  _templateLiteralLog(strings, ...args) {
+    const logs = this.#formatMessage(strings, ...args);
     this.#originalUserLogger.log(logs);
     dataStorage.putData('log', logs);
   }

package/types/types.d.ts

@@ -15,8 +15,9 @@ declare module '@testomatio/reporter' {
   /**
    * Similar to "log" function but marks message in report as a step
    * @param message - step message
+   * @param logs - optional key-value object with additional info (e.g. logs)
    */
-  export function step(message: string): void;
+  export function step(message: string, logs?: {[key: string]: any}): void;
 
   /**
    * Add key-value pair(s) to the test report