@testomatio/reporter 1.1.0-beta → 1.2.1-beta

package/lib/_ArtifactStorageOld.js

@@ -7,9 +7,8 @@ const { TESTOMAT_ARTIFACT_SUFFIX } = require('./constants');
 const { specificTestInfo } = require('./util');
 
 class ArtifactStorage {
-
+  
   constructor(params) {
-    this._tmpPrefix = "tsmt_reporter";
     this.isFile = false;
     this.isMemory = true;
     this.storage = params?.toFile;
@@ -21,7 +20,7 @@ class ArtifactStorage {
       // so the solution is make it opposite to isMemory (which will be retrieved from global)
       this.isFile = true;
       this.isMemory = false;
-      this.tmpDirFullpath = this.createTestomatTmpDir(this._tmpPrefix);
+      this.tmpDirFullpath = this.createTestomatTmpDir(ArtifactStorage._tmpPrefix);
       debug('SAVE to tmp folder mode enabled!');
     }
   }
@@ -113,7 +112,7 @@ class ArtifactStorage {
 
   // no need to use multiple dirs; we can implement it later if required
   static tmpTestomatDirNames() {
-    const subname = this._tmpPrefix || "tsmt_reporter";
+    const subname = ArtifactStorage._tmpPrefix || "tsmt_reporter";
 
     return fs.readdirSync(os.tmpdir(), { withFileTypes: true })
       .filter((item) => item.isDirectory())
@@ -138,4 +137,6 @@ class ArtifactStorage {
   }
 }
 
+ArtifactStorage._tmpPrefix = "tsmt_reporter";
+
 module.exports = ArtifactStorage;

package/lib/adapter/jest.js

@@ -12,6 +12,7 @@ class JestReporter {
   }
 
   static getIdOfCurrentlyRunningTest() {
+    if (!process.env.JEST_WORKER_ID) return null;
     // @ts-expect-error "expect" could only be defined inside Jest environement (forbidden to import it outside)
     return parseTest(expect?.getState()?.currentTestName) || null; // eslint-disable-line
   }

package/lib/client.js

@@ -12,7 +12,7 @@ const logger = require('./logger');
 /**
  * @typedef {import('../types').TestData} TestData
  * @typedef {import('../types').RunStatus} RunStatus
- * @typedef {import('../types').PipeResult} PipeResult  
+ * @typedef {import('../types').PipeResult} PipeResult
  */
 
 class Client {
@@ -105,6 +105,7 @@ class Client {
 
     const testLogs = logger.getLogs(test_id);
     debug(`Test logs for ${test_id}:\n`, testLogs);
+    if (stack) stack += '\n\n';
     stack += testLogs;
 
     if (Array.isArray(storeArtifacts) && storeArtifacts.length) {

package/lib/dataStorage.js

@@ -29,8 +29,8 @@ class DataStorage {
       Thus, checking environment is only reasonable when you put data to starage 
       and potentially useless when get data from storage
     */
-    const runningEnvironment = this.getRunningEnviroment();
-    if (runningEnvironment === 'jest') this.isFileStorage = true;
+    this.runningEnvironment = this.getRunningEnviroment();
+    if (this.runningEnvironment === 'jest') this.isFileStorage = true;
 
     if (this.isFileStorage) {
       this.dataDirPath = path.join(TESTOMAT_TMP_STORAGE.mainDir, this.dataDirName);
@@ -52,8 +52,12 @@ class DataStorage {
    */
   getRunningEnviroment() {
     if (process.env.JEST_WORKER_ID) return 'jest';
-    // @ts-expect-error mocha could be undefined, its ok
-    if (typeof mocha !== 'undefined') return 'mocha';
+    try {
+      // @ts-expect-error mocha is defined only in mocha environment
+      if (typeof mocha !== 'undefined') return 'mocha';
+    } catch (e) {
+      // ignore
+    }
     return undefined;
   }
 
@@ -64,6 +68,8 @@ class DataStorage {
    * @returns
    */
   putData(data, context = null) {
+    // this.isFileStorage = !global.testomatioDataStore;
+
     let testId = null;
     if (typeof context === 'string') {
       testId = context;
@@ -73,7 +79,7 @@ class DataStorage {
     }
 
     // try to get testId for Jest
-    testId = testId ?? JestReporter.getIdOfCurrentlyRunningTest();
+    if (this.runningEnvironment === 'jest') testId = testId ?? JestReporter.getIdOfCurrentlyRunningTest();
 
     // if testId is not provided, data is be saved to `{dataType}_other` file;
     if (!testId) testId = 'other';
@@ -101,7 +107,9 @@ class DataStorage {
       // testId = context...
     }
 
-    if (!testId) testId = 'other';
+    if (!testId) {
+      debug(`Cannot get test id from passed context:\n}`, context);
+    }
 
     if (this.isFileStorage) {
       return this._getDataFromFile(testId);

package/lib/logger.js

@@ -1,7 +1,18 @@
+const chalk = require('chalk');
 const debug = require('debug')('@testomatio/reporter:logger');
 const { DataStorage } = require('./dataStorage');
 
 const LOG_METHODS = ['assert', 'debug', 'error', 'info', 'log', 'trace', 'warn'];
+const LEVELS = {
+  ALL: { severity: 1, color: '' },
+  VERBOSE: { severity: 3, color: 'grey' },
+  TRACE: { severity: 5, color: 'grey' },
+  DEBUG: { severity: 7, color: 'cyan' },
+  INFO: { severity: 9, color: 'black' },
+  LOG: { severity: 11, color: 'black' },
+  WARN: { severity: 13, color: 'yellow' },
+  ERROR: { severity: 15, color: 'red' },
+};
 
 /**
  * Logger allows to:
@@ -14,7 +25,11 @@ class Logger {
   // _loggerToIntercept intercepted and reassigned immediately when added
 
   constructor(params = {}) {
+    // set default logger to be used in log, warn, error, etc methods
+    this._originalUserLogger = { ...console };
+
     this.dataStorage = new DataStorage('log', params);
+    this.logLevel = process?.env?.LOG_LEVEL?.toUpperCase() || 'ALL';
 
     // commented because prefer to use "intercept" method
     // if (params?.logger) this._loggerToIntercept = params.logger;
@@ -27,26 +42,6 @@ class Logger {
     }
   }
 
-  /**
-   * Returns the string (logs) and the context
-   * This is required because loggers take multiple arguments
-   * @param  {...any} args
-   */
-  /*
-    TODO: its difficult to distinguish context from log artument if its not a string,
-    e.g. user can use something like console.log('some log', { key: 'value' });
-    consider not to use this method at all and don't expect context from user inside default log methods;
-    instead, use custom method like $`some log` and parse it
-  */
-  // _getLogStringAndContextFromArgs(...args) {
-  //   let context = '';
-  //   if (args.length > 1 && typeof args[args.length - 1] !== 'string') {
-  //     context = args.pop();
-  //   }
-  //   const logs = args.join(' ');
-  //   return { logs, context };
-  // }
-
   /**
    * Tagget template literal. Allows to use different syntaxes:
    * 1. Tagget template: $`text ${someVar}`
@@ -65,22 +60,38 @@ class Logger {
           // it looks like: `string1 arg1 string2 arg2 string3`
           (args[index] !== undefined // eslint-disable-line no-nested-ternary
             ? typeof args[index] === 'string'
-              ? // add arg as it is
-                args[index]
-              : // stringify arg
-                this._strinfifyLogs(args[index])
-            : // add space if no arg after string
-              ' '),
+              ? args[index] // add arg as it is
+              : this._strinfifyLogs(args[index]) // stringify arg
+            : ' '), // add space if no arg after string
         // 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._strinfifyLogs(strings, ...args);
     }
     this.dataStorage.putData(logs);
   }
 
+  /**
+   * Allows you to define a step inside a test. Step name is attached to the report and
+   * helps to understand the test flow.
+   * @param {*} strings 
+   * @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 = chalk.blue(`> ${logs}`);
+    this.dataStorage.putData(logs);
+  }
+
   /**
    *
    * @param {*} context testId or test context from test runner
@@ -97,13 +108,23 @@ class Logger {
       if (typeof arg === 'string') {
         logs.push(arg);
       } else {
-        logs.push(JSON.stringify(arg));
+        try {
+          // eslint-disable-next-line no-unused-expressions
+          this.prettyObjects ? logs.push(JSON.stringify(arg, null, 2)) : logs.push(JSON.stringify(arg));
+        } catch (e) {
+          debug('Error while stringify object', e);
+          logs.push(arg);
+        }
       }
     }
     return logs.join(' ');
   }
 
   assert(...args) {
+    const level = 'ERROR';
+    const severity = LEVELS[level].severity;
+    if (severity < LEVELS[this.logLevel]?.severity) return;
+
     const logs = this._strinfifyLogs(...args);
     this.dataStorage.putData(logs);
     try {
@@ -114,8 +135,14 @@ class Logger {
   }
 
   debug(...args) {
+    const level = 'DEBUG';
+    const severity = LEVELS[level].severity;
+    if (severity < LEVELS[this.logLevel]?.severity) return;
+
+    if (this.logLevel === 'error' || this.logLevel === 'warn') return;
     const logs = this._strinfifyLogs(...args);
-    this.dataStorage.putData(logs);
+    const colorizedLogs = chalk[LEVELS[level].color](logs);
+    this.dataStorage.putData(colorizedLogs);
     try {
       this._originalUserLogger.debug(...args);
     } catch (e) {
@@ -124,8 +151,13 @@ class Logger {
   }
 
   error(...args) {
+    const level = 'ERROR';
+    const severity = LEVELS[level].severity;
+    if (severity < LEVELS[this.logLevel]?.severity) return;
+
     const logs = this._strinfifyLogs(...args);
-    this.dataStorage.putData(logs);
+    const colorizedLogs = chalk[LEVELS[level].color](logs);
+    this.dataStorage.putData(colorizedLogs);
     try {
       this._originalUserLogger.error(...args);
     } catch (e) {
@@ -134,6 +166,10 @@ class Logger {
   }
 
   info(...args) {
+    const level = 'INFO';
+    const severity = LEVELS[level].severity;
+    if (severity < LEVELS[this.logLevel]?.severity) return;
+
     const logs = this._strinfifyLogs(...args);
     this.dataStorage.putData(logs);
     try {
@@ -144,6 +180,10 @@ class Logger {
   }
 
   log(...args) {
+    const level = 'INFO';
+    const severity = LEVELS[level].severity;
+    if (severity < LEVELS[this.logLevel]?.severity) return;
+
     const logs = this._strinfifyLogs(...args);
     this.dataStorage.putData(logs);
     try {
@@ -154,8 +194,13 @@ class Logger {
   }
 
   trace(...args) {
+    const level = 'TRACE';
+    const severity = LEVELS[level].severity;
+    if (severity < LEVELS[this.logLevel]?.severity) return;
+
     const logs = this._strinfifyLogs(...args);
-    this.dataStorage.putData(logs);
+    const colorizedLogs = chalk[LEVELS[level].color](logs);
+    this.dataStorage.putData(colorizedLogs);
     try {
       this._originalUserLogger.trace(...args);
     } catch (e) {
@@ -164,8 +209,13 @@ class Logger {
   }
 
   warn(...args) {
+    const level = 'WARN';
+    const severity = LEVELS[level].severity;
+    if (severity < LEVELS[this.logLevel]?.severity) return;
+
     const logs = this._strinfifyLogs(...args);
-    this.dataStorage.putData(logs);
+    const colorizedLogs = chalk[LEVELS[level].color](logs);
+    this.dataStorage.putData(colorizedLogs);
     try {
       this._originalUserLogger.warn(...args);
     } catch (e) {
@@ -202,6 +252,20 @@ class Logger {
       this._loggerToIntercept[method] = (...args) => this[method](...args);
     }
   }
+
+  /**
+   * Allows to configure logger. Make sure you do it before the logger usage in your code.
+   *
+   * @param {Object} [config={}] - The configuration object.
+   * @param {string} [config.logLevel] - The desired log level. Valid values are 'DEBUG', 'INFO', 'WARN', and 'ERROR'.
+   * @param {boolean} [config.prettyObjects] - Specifies whether to enable pretty printing of objects.
+   * @returns {void}
+   */
+  configure(config = {}) {
+    if (!config) return;
+    if (config.prettyObjects) this.prettyObjects = config.prettyObjects;
+    if (config.logLevel) this.logLevel = config.logLevel.toUpperCase();
+  }
 }
 
 Logger.instance = null;
@@ -209,13 +273,6 @@ Logger.instance = null;
 // module.exports.Logger = Logger;
 module.exports = new Logger();
 
-// TODO: consider using fs promises instead of writeSync/appendFileSync to prevent blocking and improve performance
-// TODO: try to use method generator *
-// TODO: understand captureStackTrace in output (check on .error) (NOT SUCH IMPORTANT)
-// TODO: handle log levels to colorize logs later on UI
-// TODO: parse passed arguments as {level: 'str', message: 'str'} because some loggers use such syntax
-// TODO: add setLevel method - allows skip messages with the lower level
-// TODO: in case of unset _originalUserLogger, logger.{method} will not provide console output,
-// need to add some logger by default
+// TODO: parse passed arguments as {level: 'str', message: 'str'} because some loggers use such syntax;
+// upd: did not face such loggers, but still could be useful
 
-// TODO step method (blue color)

package/lib/reporter.js

@@ -4,10 +4,12 @@ const TRConstants = require('./constants');
 const TRArtifacts = require('./_ArtifactStorageOld');
 
 const log = logger._log.bind(logger);
+const step = logger.step.bind(logger);
 
 module.exports = {
   logger,
   log,
+  step,
   TestomatClient,
   TRConstants,
   TRArtifacts,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "1.1.0-beta",
+  "version": "1.2.1-beta",
   "description": "Testomatio Reporter Client",
   "main": "./lib/reporter.js",
   "typings": "typings/index.d.ts",