@testomatio/reporter 2.0.0-beta-esm → 2.0.1-beta-esm

package/src/pipe/testomatio.js

@@ -11,18 +11,17 @@ import JsonCycle from 'json-cycle';
 import { APP_PREFIX, STATUS, AXIOS_TIMEOUT, REPORTER_REQUEST_RETRIES } from '../constants.js';
 import { isValidUrl, foundedTestLog } from '../utils/utils.js';
 import { parseFilterParams, generateFilterRequestParams, setS3Credentials } from '../utils/pipe_utils.js';
-import {config} from '../config.js';
+import { config } from '../config.js';
 
 const debug = createDebugMessages('@testomatio/reporter:pipe:testomatio');
 
-
 if (process.env.TESTOMATIO_RUN) {
   // process.env.runId = process.env.TESTOMATIO_RUN;
 }
 
 /**
- * @typedef {import('../../types').Pipe} Pipe
- * @typedef {import('../../types').TestData} TestData
+ * @typedef {import('../../types/types.js').Pipe} Pipe
+ * @typedef {import('../../types/types.js').TestData} TestData
  * @class TestomatioPipe
  * @implements {Pipe}
  */
@@ -64,11 +63,13 @@ class TestomatioPipe {
     this.axios = axios.create({
       baseURL: `${this.url.trim()}`,
       timeout: AXIOS_TIMEOUT,
-      proxy: proxy ? {
-        host: proxy.hostname,
-        port: parseInt(proxy.port, 10),
-        protocol: proxy.protocol,
-      } : false,
+      proxy: proxy
+        ? {
+            host: proxy.hostname,
+            port: parseInt(proxy.port, 10),
+            protocol: proxy.protocol,
+          }
+        : false,
     });
 
     // Pass the axios instance to the retry function
@@ -104,6 +105,7 @@ class TestomatioPipe {
     this.runId = params.runId || process.env.runId;
     this.createNewTests = params.createNewTests ?? !!process.env.TESTOMATIO_CREATE;
     this.hasUnmatchedTests = false;
+    this.requestFailures = 0;
 
     if (!isValidUrl(this.url.trim())) {
       this.isEnabled = false;
@@ -155,9 +157,9 @@ class TestomatioPipe {
    */
   async createRun(params = {}) {
     this.batch.isEnabled = params.isBatchEnabled ?? this.batch.isEnabled;
-    debug('Creating run...');
     if (!this.isEnabled) return;
-    if (this.batch.isEnabled) this.batch.intervalFunction = setInterval(this.#batchUpload, this.batch.intervalTime);
+    if (this.batch.isEnabled && this.isEnabled)
+      this.batch.intervalFunction = setInterval(this.#batchUpload, this.batch.intervalTime);
 
     let buildUrl = process.env.BUILD_URL || process.env.CI_JOB_URL || process.env.CIRCLE_BUILD_URL;
 
@@ -197,12 +199,14 @@ class TestomatioPipe {
     debug(' >>>>>> Run params', JSON.stringify(runParams, null, 2));
 
     if (this.runId) {
+      this.store.runId = this.runId;
       debug(`Run with id ${this.runId} already created, updating...`);
       const resp = await this.axios.put(`/api/reporter/${this.runId}`, runParams);
       if (resp.data.artifacts) setS3Credentials(resp.data.artifacts);
       return;
     }
 
+    debug('Creating run...');
     try {
       const resp = await this.axios.post(`/api/reporter`, runParams, {
         maxContentLength: Infinity,
@@ -222,10 +226,14 @@ class TestomatioPipe {
       process.env.runId = this.runId;
       debug('Run created', this.runId);
     } catch (err) {
+      const errorText = err.response?.data?.message || err.message;
+      console.log(errorText || err);
+      if (!this.apiKey) console.error('Testomat.io API key is not set');
+      if (!this.apiKey?.startsWith('tstmt')) console.error('Testomat.io API key is invalid');
+
       console.error(
         APP_PREFIX,
-        'Error creating Testomat.io report, please check if your API key is valid. Skipping report | ',
-        err?.response?.statusText || err?.status || err.message,
+        'Error creating Testomat.io report (see details above), please check if your API key is valid. Skipping report',
       );
       printCreateIssue(err);
     }
@@ -234,37 +242,25 @@ class TestomatioPipe {
 
   /**
    * Decides whether to skip test reporting in case of too many request failures
-   * @param {TestData} testData
    * @returns {boolean}
    */
-  #cancelTestReportingInCaseOfTooManyReqFailures(testData) {
-    if (this.reportingCanceledDueToReqFailures) return true;
-
-    const retriesCountWithinTime = this.retriesTimestamps.filter(
-      timestamp => Date.now() - timestamp < REPORTER_REQUEST_RETRIES.withinTimeSeconds * 1000,
-    ).length;
-    debug(`${retriesCountWithinTime} failed requests within ${REPORTER_REQUEST_RETRIES.withinTimeSeconds}s`);
-
-    if (retriesCountWithinTime > REPORTER_REQUEST_RETRIES.maxTotalRetries) {
-      const errorMessage = pc.yellow(
-        `${retriesCountWithinTime} requests were failed within ${REPORTER_REQUEST_RETRIES.withinTimeSeconds}s,\
- reporting for test "${testData.title}" to Testomat is skipped`,
-      );
-      console.warn(`${APP_PREFIX} ${errorMessage}`);
+  #cancelTestReportingInCaseOfTooManyReqFailures() {
+    if (!process.env.TESTOMATIO_MAX_REQUEST_FAILURES) return;
 
+    const cancelReporting = this.requestFailures >= parseInt(process.env.TESTOMATIO_MAX_REQUEST_FAILURES, 10);
+    if (cancelReporting) {
       this.reportingCanceledDueToReqFailures = true;
-      this.notReportedTestsCount++;
-
-      return true;
+      let errorMessage = `⚠️ ${process.env.TESTOMATIO_MAX_REQUEST_FAILURES}`;
+      errorMessage += ' requests were failed, reporting to Testomat aborted.';
+      console.warn(`${APP_PREFIX} ${pc.yellow(errorMessage)}`);
     }
-
-    return false;
+    return cancelReporting;
   }
 
   #uploadSingleTest = async data => {
     if (!this.isEnabled) return;
     if (!this.runId) return;
-    if (this.#cancelTestReportingInCaseOfTooManyReqFailures(data)) return;
+    if (this.#cancelTestReportingInCaseOfTooManyReqFailures()) return;
 
     data.api_key = this.apiKey;
     data.create = this.createNewTests;
@@ -277,40 +273,41 @@ class TestomatioPipe {
 
     debug('Adding test', json);
 
-    return this.axios
-      .post(`/api/reporter/${this.runId}/testrun`, json, axiosAddTestrunRequestConfig)
-      .catch(err => {
-        if (err.response) {
-          if (err.response.status >= 400) {
-            const responseData = err.response.data || { message: '' };
-            console.log(
-              APP_PREFIX,
-              pc.yellow(`Warning: ${responseData.message} (${err.response.status})`),
-              pc.gray(data?.title || ''),
-            );
-            if (err.response?.data?.message?.includes('could not be matched')) {
-              this.hasUnmatchedTests = true;
-            }
-            return;
-          }
+    return this.axios.post(`/api/reporter/${this.runId}/testrun`, json, axiosAddTestrunRequestConfig).catch(err => {
+      this.requestFailures++;
+      this.notReportedTestsCount++;
+      if (err.response) {
+        if (err.response.status >= 400) {
+          const responseData = err.response.data || { message: '' };
           console.log(
             APP_PREFIX,
-            pc.yellow(`Warning: ${data?.title || ''} (${err.response?.status})`),
-            `Report couldn't be processed: ${err?.response?.data?.message}`,
+            pc.yellow(`Warning: ${responseData.message} (${err.response.status})`),
+            pc.gray(data?.title || ''),
           );
-          printCreateIssue(err);
-        } else {
-          console.log(APP_PREFIX, pc.blue(data?.title || ''), "Report couldn't be processed", err);
+          if (err.response?.data?.message?.includes('could not be matched')) {
+            this.hasUnmatchedTests = true;
+          }
+          return;
         }
-      });
-    };
-    
+        console.log(
+          APP_PREFIX,
+          pc.yellow(`Warning: ${data?.title || ''} (${err.response?.status})`),
+          `Report couldn't be processed: ${err?.response?.data?.message}`,
+        );
+        printCreateIssue(err);
+      } else {
+        console.log(APP_PREFIX, pc.blue(data?.title || ''), "Report couldn't be processed", err);
+      }
+    });
+  };
 
   /**
    * Uploads tests as a batch (multiple tests at once). Intended to be used with a setInterval
    */
   #batchUpload = async () => {
     if (!this.batch.isEnabled) return;
+    if (!this.batch.tests.length) return;
+    if (this.#cancelTestReportingInCaseOfTooManyReqFailures()) return;
     // prevent infinite loop
     if (this.batch.numberOfTimesCalledWithoutTests > 10) {
       debug('📨 Batch upload: no tests to send for 10 times, stopping batch');
@@ -322,7 +319,7 @@ class TestomatioPipe {
       this.batch.numberOfTimesCalledWithoutTests++;
       return;
     }
-    
+
     this.batch.batchIndex++;
     // get tests from batch and clear batch
     const testsToSend = this.batch.tests.splice(0);
@@ -335,6 +332,8 @@ class TestomatioPipe {
         axiosAddTestrunRequestConfig,
       )
       .catch(err => {
+        this.requestFailures++;
+        this.notReportedTestsCount += testsToSend.length;
         if (err.response) {
           if (err.response.status >= 400) {
             const responseData = err.response.data || { message: '' };
@@ -380,14 +379,21 @@ class TestomatioPipe {
   }
 
   /**
-   * @param {import('../../types').RunData} params
+   * @param {import('../../types/types.js').RunData} params
    * @returns
    */
   async finishRun(params) {
     if (!this.isEnabled) return;
-    
-    if (this.batch.intervalFunction) clearInterval(this.batch.intervalFunction);
+
     await this.#batchUpload();
+    if (this.batch.intervalFunction) {
+      clearInterval(this.batch.intervalFunction);
+      // this code is required in case test is added after run is finished
+      // (e.g. if test has artifacts, add test function will be invoked only after artifacts are uploaded)
+      // batch stops working after run is finished; thus, disable it to use single test uploading
+      this.batch.intervalFunction = null;
+      this.batch.isEnabled = false;
+    }
 
     debug('Finishing run...');
 
@@ -411,7 +417,9 @@ class TestomatioPipe {
       if (this.runId && !this.proceed) {
         await this.axios.put(`/api/reporter/${this.runId}`, {
           api_key: this.apiKey,
+          duration: params.duration,
           status_event,
+          detach: params.detach,
           tests: params.tests,
         });
         if (this.runUrl) {
@@ -426,6 +434,7 @@ class TestomatioPipe {
         console.log(APP_PREFIX, `📊 ${notFinishedMessage}. Report URL: ${pc.magenta(this.runUrl)}`);
         console.log(APP_PREFIX, `🛬 Run to finish it: TESTOMATIO_RUN=${this.runId} npx start-test-run --finish`);
       }
+
       if (this.hasUnmatchedTests) {
         console.log('');
         // eslint-disable-next-line max-len
@@ -445,11 +454,7 @@ class TestomatioPipe {
         console.log(APP_PREFIX, pc.bold('npx check-tests ... --update-ids'), 'See: https://bit.ly/js-update-ids');
         console.log(APP_PREFIX, 'or for Cucumber:');
         // eslint-disable-next-line max-len
-        console.log(
-          APP_PREFIX,
-          pc.bold('npx check-cucumber ... --update-ids'),
-          'See: https://bit.ly/bdd-update-ids',
-        );
+        console.log(APP_PREFIX, pc.bold('npx check-cucumber ... --update-ids'), 'See: https://bit.ly/bdd-update-ids');
       }
     } catch (err) {
       console.log(APP_PREFIX, 'Error updating status, skipping...', err);

package/src/reporter-functions.js

@@ -1,38 +1,49 @@
 import { services } from './services/index.js';
-import { initPlaywrightForStorage } from './adapter/playwright.js';
-
-if (process.env.PLAYWRIGHT_TEST_BASE_URL) initPlaywrightForStorage();
 
 /**
  * Stores path to file as artifact and uploads it to the S3 storage
  * @param {string | {path: string, type: string, name: string}} data - path to file or object with path, type and name
  */
 function saveArtifact(data, context = null) {
+  if (process.env.IS_PLAYWRIGHT)
+    throw new Error(`This function is not available in Playwright framework.
+    /Playwright supports artifacts out of the box`);
   if (!data) return;
   services.artifacts.put(data, context);
 }
 
 /**
  * Attach log message(s) to the test report
- * @param  {...any} args
+ * @param  string
  */
 function logMessage(...args) {
+  if (process.env.IS_PLAYWRIGHT) throw new Error('This function is not available in Playwright framework');
   services.logger._templateLiteralLog(...args);
 }
 
 /**
  * Similar to "log" function but marks message in report as a step
- * @param {*} message
+ * @param {string} message
  */
 function addStep(message) {
+  if (process.env.IS_PLAYWRIGHT)
+    throw new Error('This function is not available in Playwright framework. Use playwright steps');
+
   services.logger.step(message);
 }
 
 /**
  * Add key-value pair(s) to the test report
- * @param {*} keyValue
+ * @param {{[key: string]: string} | string} keyValue object { key: value } (multiple props allowed) or key (string)
+ * @param {string?} value
  */
-function setKeyValue(keyValue) {
+function setKeyValue(keyValue, value = null) {
+  if (process.env.IS_PLAYWRIGHT)
+    throw new Error('This function is not available in Playwright framework. Use test tag instead.');
+
+  if (typeof keyValue === 'string') {
+    keyValue = { [keyValue]: value };
+  }
   services.keyValues.put(keyValue);
 }
 

package/src/reporter.cjs_decprecated

@@ -0,0 +1,21 @@
+// const _reporter = require('../lib/reporter.js');
+
+
+// /**
+//  * @typedef {import('../lib/reporter-functions.js').saveArtifact} artifact
+//  * @typedef {import('../lib/reporter-functions.js').log} log
+//  * @typedef {import('../lib/reporter-functions.js').logger} logger
+//  * @typedef {import('../lib/reporter-functions.js')} meta
+//  * @typedef {import('../lib/reporter-functions.js')} step
+//  * 
+//  * "Reporter" type which is object containing all types from the above
+//  * @typedef {{artifact: artifact, log: log, logger: logger, meta: meta, step: step, }} Reporter
+//  */
+
+// // const reporter = _reporter;
+
+// /**
+//  * @type {Reporter}
+//  */
+// const reporter = _reporter;
+// module.exports = reporter;

package/src/reporter.js

@@ -1,10 +1,25 @@
-import TestomatClient from './client.js';
-import * as TRConstants from './constants.js';
+// import TestomatClient from './client.js';
+// import * as TRConstants from './constants.js';
 import { services } from './services/index.js';
 import reporterFunctions from './reporter-functions.js';
 
+export const artifact = reporterFunctions.artifact;
+export const log = reporterFunctions.log;
+export const logger = services.logger;
+export const meta = reporterFunctions.keyValue;
+export const step = reporterFunctions.step;
+
+/**
+ * @typedef {import('./reporter-functions.js')} artifact
+ * @typedef {import('./reporter-functions.js')} log
+ * @typedef {import('./services/index.js')} logger
+ * @typedef {import('./reporter-functions.js')} meta
+ * @typedef {import('./reporter-functions.js')} step
+ */
 export default {
-  // TODO: deprecate in future; use log or testomat.log
+  /**
+   * @deprecated Use `log` or `testomat.log`
+   */
   testomatioLogger: services.logger,
 
   artifact: reporterFunctions.artifact,
@@ -13,12 +28,6 @@ export default {
   meta: reporterFunctions.keyValue,
   step: reporterFunctions.step,
 
-  TestomatClient,
-  TRConstants,
+  // TestomatClient,
+  // TRConstants,
 };
-
-export const artifact = reporterFunctions.artifact;
-export const log = reporterFunctions.log;
-export const logger = services.logger;
-export const meta = reporterFunctions.keyValue;
-export const step = reporterFunctions.step;

package/src/services/key-values.js

@@ -18,7 +18,7 @@ class KeyValueStorage {
 
   /**
    * Stores key-value pair and passes it to reporter
-   * @param {{key: string}} keyValue - key-value pair(s) as object
+   * @param {{[key: string]: string}} keyValue - key-value pair(s) as object
    * @param {*} context - full test title
    */
   put(keyValue, context = null) {

package/src/services/logger.js

@@ -45,8 +45,10 @@ class Logger {
   logLevel = process?.env?.LOG_LEVEL?.toUpperCase() || 'ALL';
 
   constructor() {
-    if (!dataStorage.isFileStorage ||
-      (process.env.TESTOMATIO_INTERCEPT_CONSOLE_LOGS&& process.env.TESTOMATIO_INTERCEPT_CONSOLE_LOGS !== 'false'))
+    if (
+      !dataStorage.isFileStorage ||
+      (process.env.TESTOMATIO_INTERCEPT_CONSOLE_LOGS && process.env.TESTOMATIO_INTERCEPT_CONSOLE_LOGS !== 'false')
+    )
       this.intercept(console);
   }