@testomatio/reporter 1.1.1-file-upload.1 → 1.1.2-beta-fix-config

package/lib/adapter/jest.js

@@ -55,8 +55,8 @@ class JestReporter {
       if (!fullSuiteTitle && testResult.testFilePath) fullSuiteTitle = path.basename(testResult.testFilePath);
 
       const logs = getTestLogs(result);
-      const artifacts = services.artifacts.get(testResult.fullName);
-      const keyValues = services.keyValues.get(testResult.fullName);
+      const artifacts = services.artifacts.get(result.fullName);
+      const keyValues = services.keyValues.get(result.fullName);
 
       const deducedStatus = status === 'pending' ? 'skipped' : status;
       // In jest if test is not matched with test name pattern it is considered as skipped.

package/lib/adapter/playwright.js

@@ -7,6 +7,8 @@ const { APP_PREFIX, STATUS: Status, TESTOMAT_TMP_STORAGE_DIR } = require('../con
 const TestomatioClient = require('../client');
 const { isArtifactsEnabled } = require('../fileUploader');
 const { parseTest, fileSystem } = require('../utils/utils');
+const { services } = require('../services');
+const { dataStorage } = require('../data-storage');
 
 const reportTestPromises = [];
 
@@ -26,6 +28,11 @@ class PlaywrightReporter {
     this.client.createRun();
   }
 
+  onTestBegin(testInfo) {
+    const fullTestTitle = getTestContextName(testInfo);
+    dataStorage.setContext(fullTestTitle);
+  }
+
   onTestEnd(test, result) {
     if (!this.client) return;
 
@@ -35,17 +42,20 @@ class PlaywrightReporter {
 
     const { error, duration } = result;
 
-    const suite_title = test.parent ? test.parent.title : null;
+    const suite_title = test.parent ? test.parent?.title : path.basename(test?.location?.file);
 
     const steps = [];
     for (const step of result.steps) {
       appendStep(step, steps);
     }
 
+    const fullTestTitle = getTestContextName(test);
     let logs = '';
     if (result.stderr.length || result.stdout.length) {
       logs = `\n\n${chalk.bold('Logs:')}\n${chalk.red(result.stderr.join(''))}\n${result.stdout.join('')}`;
     }
+    const manuallyAttachedArtifacts = services.artifacts.get(fullTestTitle);
+    const keyValues = services.keyValues.get(fullTestTitle);
 
     const reportTestPromise = this.client
       .addTestRun(checkStatus(result.status), {
@@ -56,7 +66,8 @@ class PlaywrightReporter {
         steps: steps.join('\n'),
         time: duration,
         logs,
-        // TODO: attach artifacts
+        manuallyAttachedArtifacts,
+        meta: keyValues,
       })
       .then(pipes => {
         testId = pipes?.filter(p => p.pipe.includes('Testomatio'))[0]?.result?.data?.test_id;
@@ -74,12 +85,11 @@ class PlaywrightReporter {
     reportTestPromises.push(reportTestPromise);
   }
 
-
   #getArtifactPath(artifact) {
     if (artifact.path) {
       if (path.isAbsolute(artifact.path)) return artifact.path;
 
-      return path.join(this.config.outputDir || this.config.projects[0].outputDir, artifact.path);         
+      return path.join(this.config.outputDir || this.config.projects[0].outputDir, artifact.path);
     }
 
     if (artifact.body) {
@@ -91,7 +101,7 @@ class PlaywrightReporter {
     return null;
   }
 
-  async onEnd(result, config) {
+  async onEnd(result) {
     if (!this.client) return;
 
     await Promise.all(reportTestPromises);
@@ -104,9 +114,11 @@ class PlaywrightReporter {
       for (const upload of this.uploads) {
         const { title, testId, suite_title } = upload;
 
-        const files = upload.files.map(attachment => {
-          return { path: this.#getArtifactPath(attachment), title, type: attachment.contentType };
-        });
+        const files = upload.files.map(attachment => ({
+          path: this.#getArtifactPath(attachment),
+          title,
+          type: attachment.contentType
+        }));
 
         promises.push(
           this.client.addTestRun(undefined, {
@@ -153,6 +165,15 @@ function tmpFile(prefix = 'tmp.') {
   return path.join(tmpdir, prefix + crypto.randomBytes(16).toString('hex'));
 }
 
+/**
+ * Returns filename + test title
+ * @param {*} test - testInfo object from Playwright
+ * @returns
+ */
+function getTestContextName(test) {
+  return `${test._requireFile || ''}_${test.title}`;
+}
+
 function initPlaywrightForStorage() {
   try {
     // @ts-ignore-next-line
@@ -160,12 +181,11 @@ function initPlaywrightForStorage() {
     const { test } = require('@playwright/test');
     // eslint-disable-next-line no-empty-pattern
     test.beforeEach(async ({}, testInfo) => {
-      const fullTestTitle = `${testInfo.file}_${testInfo.title}`;
-      global.testomatioTestTitle = fullTestTitle;
+      global.testomatioTestTitle = `${testInfo.file || ''}_${testInfo.title}`;
     });
   } catch (e) {
     // ignore
-  }  
+  }
 }
 
 module.exports = PlaywrightReporter;

package/lib/client.js

@@ -140,7 +140,6 @@ class Client {
     } = testData;
     let { message = '' } = testData;
 
-
     let errorFormatted = '';
     if (error) {
       errorFormatted += this.formatError(error) || '';
@@ -242,11 +241,11 @@ class Client {
             console.log(
               APP_PREFIX,
               chalk.yellow(
-                `Some artifacts were not uploaded. ${this.failedToUpload} artifacts could not be uploaded. Run tests with DEBUG="@testomatio/reporter:file-uploader" to see details"`,
+                `Some artifacts were not uploaded. ${this.failedToUpload} artifacts could not be uploaded.
+                Run tests with DEBUG="@testomatio/reporter:file-uploader" to see details"`,
               ),
             );
           }
-    
         }
       })
       .catch(err => console.log(APP_PREFIX, err));

package/lib/constants.js

@@ -3,6 +3,8 @@ const os = require('os');
 const path = require('path');
 
 const APP_PREFIX = chalk.gray('[TESTOMATIO]');
+const AXIOS_TIMEOUT = 20 * 1000; // sum = 20sec
+const AXIOS_RETRY_TIMEOUT = 5 * 1000; // sum = 5sec
 
 const TESTOMAT_TMP_STORAGE_DIR = path.join(os.tmpdir(), 'testomatio_tmp');
 
@@ -32,5 +34,7 @@ module.exports = {
   TESTOMAT_TMP_STORAGE_DIR,
   CSV_HEADERS,
   STATUS,
-  HTML_REPORT
+  HTML_REPORT,
+  AXIOS_TIMEOUT,
+  AXIOS_RETRY_TIMEOUT
 }

package/lib/data-storage.js

@@ -4,7 +4,8 @@ const path = require('path');
 const os = require('os');
 const { join } = require('path');
 const { TESTOMAT_TMP_STORAGE_DIR } = require('./constants');
-const { fileSystem, jestHelpers } = require('./utils/utils');
+const { fileSystem, testRunnerHelper } = require('./utils/utils');
+const crypto = require('crypto');
 
 class DataStorage {
   static #instance;
@@ -37,16 +38,6 @@ class DataStorage {
     this.isFileStorage = true;
   }
 
-  #stringToFilename(str) {
-    // TODO: use md5 hash later
-    const validFilenameRegex = /[^a-zA-Z0-9_.-]/g;
-    // replace all characters not in the regex above with underscore, then duplicate underscores removed
-    let filename = str.replace(validFilenameRegex, '_').replace(/_{2,}/g, '_').substring(0, 255); // max filename length
-    // remove leading and trailing underscores
-    filename = filename.replace(/^_+|_+$/g, '');
-    return filename;
-  }
-
   /**
    * Puts any data to storage (file or global variable).
    * If file: stores data as text, if global variable – stores as array of data.
@@ -59,19 +50,19 @@ class DataStorage {
   putData(dataType, data, context = null) {
     if (!dataType || !data) return;
 
-    context = context || this.context || global.testomatioTestTitle || jestHelpers.getIdOfCurrentlyRunningTest();
+    context = context || this.context || testRunnerHelper.getNameOfCurrentlyRunningTest();
     if (!context) {
       debug(`No context provided for "${dataType}" data:`, data);
       return;
     }
-    context = this.#stringToFilename(context);
+    const contextHash = stringToMD5Hash(context);
 
     if (this.isFileStorage) {
       const dataDirPath = path.join(TESTOMAT_TMP_STORAGE_DIR, dataType);
       fileSystem.createDir(dataDirPath);
-      this.#putDataToFile(dataType, data, context);
+      this.#putDataToFile(dataType, data, contextHash);
     } else {
-      this.#putDataToGlobalVar(dataType, data, context);
+      this.#putDataToGlobalVar(dataType, data, contextHash);
     }
   }
 
@@ -85,32 +76,32 @@ class DataStorage {
    */
   getData(dataType, context) {
     // TODO: think if it could be useful
-    // context = context || this.context || global.testomatioTestTitle || jestHelpers.getIdOfCurrentlyRunningTest();
+    // context = context || this.context || testRunnerHelper.getNameOfCurrentlyRunningTest();
 
     if (!context) {
       debug(`Trying to get "${dataType}" data without context`);
       return null;
     }
 
-    context = this.#stringToFilename(context);
+    const contextHash = stringToMD5Hash(context);
 
     let testDataFromFile = [];
     let testDataFromGlobalVar = [];
 
     if (global?.testomatioDataStore) {
-      testDataFromGlobalVar = this.#getDataFromGlobalVar(dataType, context);
+      testDataFromGlobalVar = this.#getDataFromGlobalVar(dataType, contextHash);
       if (testDataFromGlobalVar) {
         if (testDataFromGlobalVar.length) return testDataFromGlobalVar;
       }
       // don't return nothing if no data in global variable
     }
 
-    testDataFromFile = this.#getDataFromFile(dataType, context);
+    testDataFromFile = this.#getDataFromFile(dataType, contextHash);
 
     if (testDataFromFile.length) {
       return testDataFromFile;
     }
-    debug(`No "${dataType}" data for context "${context}" in both file and global variable`);
+    debug(`No "${dataType}" data for context "${contextHash}" in both file and global variable`);
 
     // in case no data found for context
     return null;
@@ -197,7 +188,16 @@ class DataStorage {
   }
 }
 
+function stringToMD5Hash(str) {
+  const md5 = crypto.createHash('md5');
+  md5.update(str);
+  const hash = md5.digest('hex');
+
+  return hash;
+}
+
 module.exports.dataStorage = DataStorage.getInstance();
+module.exports.stringToMD5Hash = stringToMD5Hash;
 
 // TODO: consider using fs promises instead of writeSync/appendFileSync to
 // prevent blocking and improve performance (probably queue usage will be required)

package/lib/pipe/testomatio.js

@@ -1,8 +1,12 @@
 const debug = require('debug')('@testomatio/reporter:pipe:testomatio');
 const chalk = require('chalk');
+// Retry interceptor function
+const axiosRetry = require('axios-retry');
+// Default axios instance
 const axios = require('axios');
 const JsonCycle = require('json-cycle');
-const { APP_PREFIX, STATUS } = require('../constants');
+
+const { APP_PREFIX, STATUS, AXIOS_TIMEOUT, AXIOS_RETRY_TIMEOUT } = require('../constants');
 const { isValidUrl, foundedTestLog } = require('../utils/utils');
 const { parseFilterParams, generateFilterRequestParams, setS3Credentials, } = require('../utils/pipe_utils');
 const { TESTOMATIO } = require('../config');
@@ -34,10 +38,31 @@ class TestomatioPipe {
     this.groupTitle = params.groupTitle || process.env.TESTOMATIO_RUNGROUP_TITLE;
     this.env = process.env.TESTOMATIO_ENV;
     this.label = process.env.TESTOMATIO_LABEL;
-
+    // Create a new instance of axios with a custom config
     this.axios = axios.create({
       baseURL: `${this.url.trim()}`,
-      timeout: 30000
+      timeout: AXIOS_TIMEOUT,
+    });
+    // Pass the axios instance to the retry function
+    axiosRetry(this.axios, {
+      retries: 3, // Number of retries (Defaults to 3)
+      shouldResetTimeout: true,
+      retryCondition: (error) => {
+        // Conditional check the error status code
+        switch (error.response.status) {
+          case 409:
+          case 429:
+          case 502:
+          case 503:
+            return true; // Retry request with response status code 409, 429, 502, 503
+          default:
+            return false; // Do not retry the others
+        }
+      },
+      retryDelay: (retryCount) => retryCount * AXIOS_RETRY_TIMEOUT, // sum = 15sec
+      onRetry: (retryCount) => {
+        debug(`Retry attempt #${retryCount} failed. Retrying again...`);
+      },
     });
 
     this.isEnabled = true;
@@ -150,10 +175,13 @@ class TestomatioPipe {
         maxContentLength: Infinity,
         maxBodyLength: Infinity,
       });
+
       this.runId = resp.data.uid;
       this.runUrl = `${this.url}/${resp.data.url.split('/').splice(3).join('/')}`;
       this.runPublicUrl = resp.data.public_url;
+
       if (resp.data.artifacts) setS3Credentials(resp.data.artifacts);
+
       this.store.runUrl = this.runUrl;
       this.store.runPublicUrl = this.runPublicUrl;
       this.store.runId = this.runId;

package/lib/reporter-functions.js

@@ -19,7 +19,7 @@ function saveArtifact(data, context = null) {
  * @param  {...any} args
  */
 function logMessage(...args) {
-  services.logger.templateLiteralLog(...args);
+  services.logger._templateLiteralLog(...args);
 }
 
 /**

package/lib/reporter.js

@@ -1,19 +1,19 @@
 const TestomatClient = require('./client');
 const TRConstants = require('./constants');
+const { services } = require('./services');
 
 const reporterFunctions = require('./reporter-functions');
 
 module.exports = {
   // TODO: deprecate in future; use log or testomat.log
-  logger: reporterFunctions.log,
-  testomatioLogger: reporterFunctions.log,
+  testomatioLogger: services.logger,
 
   artifact: reporterFunctions.artifact,
   log: reporterFunctions.log,
+  logger: services.logger,
   meta: reporterFunctions.keyValue,
   step: reporterFunctions.step,
 
   TestomatClient,
   TRConstants,
 };
-

package/lib/services/logger.js

@@ -26,7 +26,7 @@ class Logger {
   // set default logger to be used in log, warn, error, etc methods
   #originalUserLogger = { ...console };
 
-  #isConsoleIntercepted = false;
+  #userLoggerWithOverridenMethods;
 
   static #instance;
 
@@ -44,8 +44,7 @@ class Logger {
   logLevel = process?.env?.LOG_LEVEL?.toUpperCase() || 'ALL';
 
   constructor() {
-    // intercept console by default
-    this.intercept(console);
+    if (!dataStorage.isFileStorage || process.env.TESTOMATIO_INTERCEPT_CONSOLE_LOGS) this.intercept(console);
   }
 
   /**
@@ -106,7 +105,7 @@ class Logger {
    * 2. Standard: log(`text ${someVar}`)
    * 3. Standard with multiple arguments: log('text', someVar)
    */
-  templateLiteralLog(strings, ...args) {
+  _templateLiteralLog(strings, ...args) {
     if (Array.isArray(strings)) strings = strings.filter(item => item !== '').map(item => item.trim());
     if (Array.isArray(args)) args = args.filter(item => item !== '');
 
@@ -198,16 +197,18 @@ class Logger {
    * @param {*} userLogger
    */
   intercept(userLogger) {
-    /* prevent multiple console interceptions (cause of infinite loop)
-    actual only for "console", because its used as default output and is intercepted by default */
-    const isUserLoggerConsole = userLogger.toString?.().toLowerCase() === '[object console]';
-    if (isUserLoggerConsole && this.#isConsoleIntercepted) {
-      debug(`Try to intercept console, but it is already intercepted`);
-      return;
+    // STEP 1: reset previously intercepted logger methods to original
+    if (this.#userLoggerWithOverridenMethods) {
+      for (const method of LOG_METHODS) {
+        this.#userLoggerWithOverridenMethods[method] = this.#originalUserLogger[method];
+      }
     }
 
-    global.TESTOMATIO_LOGGER_CONSOLE_INTERCEPTED = true;
-    debug(isUserLoggerConsole ? 'console intercepted' : 'User logger intercepted');
+    // STEP 2: intercept new logger
+    this.#originalUserLogger = { ...userLogger };
+
+    const isUserLoggerConsole = userLogger.toString?.().toLowerCase() === '[object console]';
+    debug(`Intercepting ${isUserLoggerConsole ? 'console' : 'some user'} logger}`);
 
     // override user logger (any, e.g. console) methods to intercept log messages
     for (const method of LOG_METHODS) {
@@ -220,10 +221,7 @@ class Logger {
       userLogger[method] = (...args) => this[method](...args);
     }
 
-    /* Playwright
-    Playwright intercepts console messages by default. Thus when we intercept any logger and provide output by console,
-    messages are intercepted by Playwright.
-    */
+    this.#userLoggerWithOverridenMethods = userLogger;
 
     /*
     Initial idea was to intercept any logger (tracer, pino, etc),
@@ -233,11 +231,22 @@ class Logger {
     Also its difficult to understand (actually did not find the way to do it) if logger was already intercepted or not.
     Thus, decided to intercept only console by default and provide output by default console.
     It means, if user uses his own logger, its messages will be intercepted,
-    but the output will be provided by console.
+    but the output will be always provided by console.
     TODO: try to implement the providing output to terminal by user logger
     */
   }
 
+  stopInterception() {
+    debug('Stop ntercepting logs');
+
+    // restore original user logger
+    if (this.#userLoggerWithOverridenMethods) {
+      for (const method of LOG_METHODS) {
+        this.#userLoggerWithOverridenMethods[method] = this.#originalUserLogger[method];
+      }
+    }
+  }
+
   /**
    * Allows to configure logger. Make sure you do it before the logger usage in your code.
    *
@@ -270,7 +279,6 @@ I found the only ability to get any logs using .task('log', 'message') (this is
 and then intercept it with:
   on('task', {
     log (message) {
-      console.log(message)
       return null
     }
   })

package/lib/utils/utils.js

@@ -298,8 +298,11 @@ function removeColorCodes(input) {
   return input.replace(/\x1b\[[0-9;]*m/g, '');
 }
 
-const jestHelpers = {
-  getIdOfCurrentlyRunningTest: () => {
+const testRunnerHelper = {
+  // for Jest
+  getNameOfCurrentlyRunningTest: () => {
+    if (global.testomatioTestTitle) return global.testomatioTestTitle;
+
     if (!process.env.JEST_WORKER_ID) return null;
     try {
       // TODO: expect?.getState()?.testPath + ' ' + expect?.getState()?.currentTestName
@@ -329,5 +332,5 @@ module.exports = {
   humanize,
   removeColorCodes,
   foundedTestLog,
-  jestHelpers,
+  testRunnerHelper,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "1.1.1-file-upload.1",
+  "version": "1.1.2-beta-fix-config",
   "description": "Testomatio Reporter Client",
   "main": "./lib/reporter.js",
   "typings": "typings/index.d.ts",
@@ -12,7 +12,8 @@
     "@aws-sdk/lib-storage": "^3.279.0",
     "@octokit/rest": "^19.0.5",
     "aws-sdk": "^2.1072.0",
-    "axios": "^0.25.0",
+    "axios": "^1.6.2",
+    "axios-retry": "^3.9.1",
     "callsite-record": "^4.1.4",
     "chalk": "^4.1.0",
     "commander": "^4.1.1",
@@ -30,8 +31,8 @@
     "lodash.memoize": "^4.1.2",
     "lodash.merge": "^4.6.2",
     "minimatch": "^9.0.3",
-    "uuid": "^9.0.0",
-    "promise-retry": "^2.0.1"
+    "promise-retry": "^2.0.1",
+    "uuid": "^9.0.0"
   },
   "files": [
     "bin",
@@ -52,7 +53,7 @@
     "test:adapter:jasmine:example": "./tests/adapter/examples/jasmine/passReporterOpts.sh && jasmine './tests/adapter/examples/jasmine/index.test.js' --reporter=./../../../lib/adapter/jasmine.js",
     "test:adapter:codecept:example": "codeceptjs run --config='./tests/adapter/examples/codecept/codecept.conf.js'",
     "test:adapter:cucumber:example": "cd ./tests/adapter/examples/cucumber && npx cucumber-js",
-    "test:storage": "npx mocha tests-storage/artifact-storage.test.js && npx mocha tests-storage/data-storage.test.js && npx mocha tests-storage/logger.test.js && npx mocha tests-storage/reporter-functions.test.js"
+    "test:storage": "npx mocha tests-storage/artifact-storage.test.js && npx mocha tests-storage/data-storage.test.js && TESTOMATIO_INTERCEPT_CONSOLE_LOGS=true npx mocha tests-storage/logger.test.js && npx mocha tests-storage/logger-2.test.js && npx mocha tests-storage/reporter-functions.test.js"
   },
   "devDependencies": {
     "@cucumber/cucumber": "^9.3.0",