@testomatio/reporter 2.7.5 → 2.7.8

package/lib/constants.d.ts

@@ -15,7 +15,8 @@ export namespace HTML_REPORT {
     let REPORT_DEFAULT_NAME: string;
     let TEMPLATE_NAME: string;
 }
-export const AXIOS_TIMEOUT: number;
+export const REQUEST_TIMEOUT: number;
+export function getCreateRunRequestTimeout(): number;
 export const testomatLogoURL: "https://avatars.githubusercontent.com/u/59105116?s=36&v=4";
 export namespace REPORTER_REQUEST_RETRIES {
     let retryTimeout: number;

package/lib/constants.js

@@ -3,7 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SCREENSHOTS_ON_STEPS = exports.REPORTER_REQUEST_RETRIES = exports.testomatLogoURL = exports.AXIOS_TIMEOUT = exports.HTML_REPORT = exports.STATUS = exports.CSV_HEADERS = exports.TESTOMAT_TMP_STORAGE_DIR = exports.APP_PREFIX = void 0;
+exports.SCREENSHOTS_ON_STEPS = exports.REPORTER_REQUEST_RETRIES = exports.testomatLogoURL = exports.REQUEST_TIMEOUT = exports.HTML_REPORT = exports.STATUS = exports.CSV_HEADERS = exports.TESTOMAT_TMP_STORAGE_DIR = exports.APP_PREFIX = void 0;
+exports.getCreateRunRequestTimeout = getCreateRunRequestTimeout;
 const picocolors_1 = __importDefault(require("picocolors"));
 const os_1 = __importDefault(require("os"));
 const path_1 = __importDefault(require("path"));
@@ -14,8 +15,8 @@ const TESTOMATIO_REQUEST_TIMEOUT = parseInt(process.env.TESTOMATIO_REQUEST_TIMEO
 if (TESTOMATIO_REQUEST_TIMEOUT) {
     console.log(`${APP_PREFIX} Request timeout is set to ${TESTOMATIO_REQUEST_TIMEOUT / 1000}s`);
 }
-const AXIOS_TIMEOUT = TESTOMATIO_REQUEST_TIMEOUT || 20 * 1000;
-exports.AXIOS_TIMEOUT = AXIOS_TIMEOUT;
+const REQUEST_TIMEOUT = TESTOMATIO_REQUEST_TIMEOUT || 20 * 1000;
+exports.REQUEST_TIMEOUT = REQUEST_TIMEOUT;
 const SCREENSHOTS_ON_STEPS = process.env.TESTOMATIO_SCREENSHOTS_ON_STEPS == null
     || (0, utils_js_1.transformEnvVarToBoolean)(process.env.TESTOMATIO_SCREENSHOTS_ON_STEPS);
 exports.SCREENSHOTS_ON_STEPS = SCREENSHOTS_ON_STEPS;
@@ -52,10 +53,15 @@ const REPORTER_REQUEST_RETRIES = {
     withinTimeSeconds: Number(process.env.TESTOMATIO_MAX_REQUEST_RETRIES_WITHIN_TIME_SECONDS) || 60,
 };
 exports.REPORTER_REQUEST_RETRIES = REPORTER_REQUEST_RETRIES;
+function getCreateRunRequestTimeout() {
+    return Math.max(REQUEST_TIMEOUT, 80 * 1000);
+}
+
+module.exports.getCreateRunRequestTimeout = getCreateRunRequestTimeout;
 
 module.exports.APP_PREFIX = APP_PREFIX;
 
-module.exports.AXIOS_TIMEOUT = AXIOS_TIMEOUT;
+module.exports.REQUEST_TIMEOUT = REQUEST_TIMEOUT;
 
 module.exports.SCREENSHOTS_ON_STEPS = SCREENSHOTS_ON_STEPS;
 

package/lib/pipe/coverage.js

@@ -67,7 +67,7 @@ class CoveragePipe {
         // Create a new instance of gaxios with a custom config
         this.client = new gaxios_1.Gaxios({
             baseURL: `${this.url.trim()}`,
-            timeout: constants_js_1.AXIOS_TIMEOUT,
+            timeout: constants_js_1.REQUEST_TIMEOUT,
             proxy: proxy ? proxy.toString() : undefined,
             retry: true,
             retryConfig: {

package/lib/pipe/testomatio.js

@@ -70,7 +70,7 @@ class TestomatioPipe {
         // Create a new instance of gaxios with a custom config
         this.client = new gaxios_1.Gaxios({
             baseURL: `${this.url.trim()}`,
-            timeout: constants_js_1.AXIOS_TIMEOUT,
+            timeout: constants_js_1.REQUEST_TIMEOUT,
             proxy: proxy ? proxy.toString() : undefined,
             retry: true,
             retryConfig: {
@@ -225,6 +225,7 @@ class TestomatioPipe {
                 method: 'PUT',
                 url: `/api/reporter/${this.runId}`,
                 data: runParams,
+                timeout: (0, constants_js_1.getCreateRunRequestTimeout)(),
                 responseType: 'json',
             });
             if (resp.data.artifacts)
@@ -246,6 +247,7 @@ class TestomatioPipe {
                 method: 'POST',
                 url: '/api/reporter',
                 data: runParams,
+                timeout: (0, constants_js_1.getCreateRunRequestTimeout)(),
                 maxContentLength: Infinity,
                 responseType: 'json',
             });
@@ -262,17 +264,14 @@ class TestomatioPipe {
             debug('Run created', this.runId);
         }
         catch (err) {
+            if (!this.apiKey)
+                console.error('Testomat.io API key is not set');
             const errorText = err.response?.data?.message || err.message;
             debug('Error creating run', err);
-            console.log(errorText || err);
+            console.log(constants_js_1.APP_PREFIX, errorText || err);
             if (err.response?.status === 403)
                 this.#disablePipe();
-            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');
-            if (process.env.DEBUG || process.env.TESTOMATIO_DEBUG)
-                this.#logFailedResponse(err);
+            this.#logFailedResponse(err);
             console.error(constants_js_1.APP_PREFIX, 'Error creating Testomat.io report (see details above), please check if your API key is valid. Skipping report');
             printCreateIssue();
         }
@@ -477,9 +476,8 @@ class TestomatioPipe {
             }
         }
         catch (err) {
-            log_js_1.log.info('Error updating status, skipping...', err);
-            if (process.env.DEBUG || process.env.TESTOMATIO_DEBUG)
-                this.#logFailedResponse(err);
+            console.log(constants_js_1.APP_PREFIX, 'Error updating status, skipping...', err);
+            this.#logFailedResponse(err);
             printCreateIssue();
         }
         debug('Run finished');
@@ -501,18 +499,23 @@ class TestomatioPipe {
             responseBody = '<empty>';
         responseBody = hideTestomatioToken(responseBody);
         const statusCode = error.status || error.code || error.response?.status || '<unknown status code>';
-        const method = error.response?.config.method || '<unknown method>';
-        const url = error.response?.config.url || '<unknown url>';
-        let message = picocolors_1.default.yellow('\n⚠️ Request to Testomat.io failed:\n');
-        message += picocolors_1.default.bold(`${picocolors_1.default.red(statusCode)} ${method} ${url}\n`);
+        const method = error.response?.config?.method || '<unknown method>';
+        const url = String(error.response?.config?.url || '<unknown url>');
+        let message = picocolors_1.default.yellow('⚠️ Request to Testomat.io failed:\n');
+        message += picocolors_1.default.bold(`${picocolors_1.default.red(statusCode)} ${method} ${picocolors_1.default.gray(url)}\n`);
+        if (statusCode === 403) {
+            message += `\t${picocolors_1.default.red('Please check your API token. It might be invalid or expired.')}\n`;
+        }
         message += `\t${picocolors_1.default.bold('response: ')}${picocolors_1.default.gray(responseBody)}\n`;
         const requestBody = hideTestomatioToken(stringify(error.response?.config?.data));
-        if (process.env.DEBUG || process.env.TESTOMATIO_DEBUG) {
+        if (process.env.DEBUG || process.env.TESTOMATIO_DEBUG || requestBody.length < 1000) {
+            // full body
             message += `\t${picocolors_1.default.bold('request: ')}${picocolors_1.default.gray(requestBody)}\n`;
         }
         else {
+            // cut body
             const requestBodyCut = requestBody.slice(0, 1000);
-            message += `\t${picocolors_1.default.bold('request: ')}${picocolors_1.default.gray(`${requestBodyCut}.....`)}\n`;
+            message += `\t${picocolors_1.default.bold('request: ')}${picocolors_1.default.gray(`${requestBodyCut}...`)}\n`;
             message += '\trequest body is cut, run with TESTOMATIO_DEBUG=1 to see full body\n';
         }
         console.log(message);

package/lib/xmlReader.js

@@ -22,15 +22,25 @@ const log_js_1 = require("./utils/log.js");
 const debug = (0, debug_1.default)('@testomatio/reporter:xml');
 const ridRunId = (0, crypto_1.randomUUID)();
 const TESTOMATIO_URL = process.env.TESTOMATIO_URL || 'https://app.testomat.io';
-const { TESTOMATIO_RUNGROUP_TITLE, TESTOMATIO_SUITE, TESTOMATIO_MAX_STACK_TRACE, TESTOMATIO_TITLE, TESTOMATIO_ENV, TESTOMATIO_RUN, TESTOMATIO_MARK_DETACHED, TESTOMATIO_LEGACY_NUNIT, } = process.env;
+const { TESTOMATIO_RUNGROUP_TITLE, TESTOMATIO_SUITE, TESTOMATIO_MAX_STACK_TRACE, TESTOMATIO_TITLE, TESTOMATIO_ENV, TESTOMATIO_RUN, TESTOMATIO_MARK_DETACHED, TESTOMATIO_LEGACY_NUNIT, TESTOMATIO_MAX_ENTITY_EXPANSIONS, } = process.env;
+const MAX_OUTPUT_LENGTH = parseInt(TESTOMATIO_MAX_STACK_TRACE, 10) || 10000;
+const MAX_ENTITY_EXPANSIONS = parseInt(TESTOMATIO_MAX_ENTITY_EXPANSIONS, 10) || 10000;
+const ENTITY_EXPANSION_LIMIT_REGEXP = /Entity expansion limit exceeded/i;
 const options = {
     ignoreDeclaration: true,
     ignoreAttributes: false,
     alwaysCreateTextNode: false,
     attributeNamePrefix: '',
     parseTagValue: true,
+    processEntities: {
+        enabled: true,
+        maxEntitySize: 10000,
+        maxExpansionDepth: 10,
+        maxTotalExpansions: MAX_ENTITY_EXPANSIONS,
+        maxExpandedLength: 100000,
+        maxEntityCount: 10000,
+    },
 };
-const MAX_OUTPUT_LENGTH = parseInt(TESTOMATIO_MAX_STACK_TRACE, 10) || 10000;
 const reduceOptions = {};
 class XmlReader {
     constructor(opts = {}) {
@@ -84,7 +94,19 @@ class XmlReader {
         for (const regex of cutRegexes) {
             xmlData = xmlData.replace(regex, (_, p1, p2, p3) => `${p1}${p2.substring(0, MAX_OUTPUT_LENGTH)}${p3}`);
         }
-        const jsonResult = this.parser.parse(xmlData);
+        let jsonResult;
+        try {
+            jsonResult = this.parser.parse(xmlData);
+        }
+        catch (error) {
+            if (ENTITY_EXPANSION_LIMIT_REGEXP.test(error.message)) {
+                throw new Error(`${error.message}\n\n` +
+                    `XML report contains more entity references than the current limit (${MAX_ENTITY_EXPANSIONS}). ` +
+                    'If this XML report is trusted, increase the limit with TESTOMATIO_MAX_ENTITY_EXPANSIONS, for example:\n' +
+                    `TESTOMATIO_MAX_ENTITY_EXPANSIONS=${MAX_ENTITY_EXPANSIONS * 2} npx report-xml "{pattern}" --lang={lang}`);
+            }
+            throw error;
+        }
         let jsonSuite;
         if (jsonResult.testsuites) {
             jsonSuite = jsonResult.testsuites;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "2.7.5",
+  "version": "2.7.8",
   "description": "Testomatio Reporter Client",
   "engines": {
     "node": ">=18"
@@ -17,7 +17,6 @@
     "@aws-sdk/lib-storage": "^3.279.0",
     "@cucumber/cucumber": "^10.9.0",
     "@octokit/rest": "^21.1.1",
-    "aws-sdk": "^2.1072.0",
     "callsite-record": "^4.1.4",
     "commander": "^12",
     "cross-spawn": "^7.0.3",

package/src/constants.js

@@ -8,7 +8,7 @@ const TESTOMATIO_REQUEST_TIMEOUT = parseInt(process.env.TESTOMATIO_REQUEST_TIMEO
 if (TESTOMATIO_REQUEST_TIMEOUT) {
   console.log(`${APP_PREFIX} Request timeout is set to ${TESTOMATIO_REQUEST_TIMEOUT / 1000}s`);
 }
-const AXIOS_TIMEOUT = TESTOMATIO_REQUEST_TIMEOUT || 20 * 1000;
+const REQUEST_TIMEOUT = TESTOMATIO_REQUEST_TIMEOUT || 20 * 1000;
 const SCREENSHOTS_ON_STEPS = process.env.TESTOMATIO_SCREENSHOTS_ON_STEPS == null
   || transformEnvVarToBoolean(process.env.TESTOMATIO_SCREENSHOTS_ON_STEPS);
 
@@ -44,13 +44,18 @@ const REPORTER_REQUEST_RETRIES = {
   withinTimeSeconds: Number(process.env.TESTOMATIO_MAX_REQUEST_RETRIES_WITHIN_TIME_SECONDS) || 60,
 };
 
+function getCreateRunRequestTimeout() {
+  return Math.max(REQUEST_TIMEOUT, 80 * 1000);
+}
+
 export {
   APP_PREFIX,
   TESTOMAT_TMP_STORAGE_DIR,
   CSV_HEADERS,
   STATUS,
   HTML_REPORT,
-  AXIOS_TIMEOUT,
+  REQUEST_TIMEOUT,
+  getCreateRunRequestTimeout,
   testomatLogoURL,
   REPORTER_REQUEST_RETRIES,
   SCREENSHOTS_ON_STEPS,

package/src/pipe/coverage.js

@@ -4,7 +4,7 @@ import yaml from 'js-yaml';
 import { execSync } from 'child_process';
 import { Gaxios } from 'gaxios';
 import { minimatch } from 'minimatch';
-import { APP_PREFIX, AXIOS_TIMEOUT, REPORTER_REQUEST_RETRIES } from '../constants.js';
+import { APP_PREFIX, REQUEST_TIMEOUT, REPORTER_REQUEST_RETRIES } from '../constants.js';
 import { generateFilterRequestParams } from '../utils/pipe_utils.js';
 import { parsePipeOptions } from '../utils/pipe_utils.js';
 import { config } from '../config.js';
@@ -76,7 +76,7 @@ class CoveragePipe { // or Changes for the future???
         // Create a new instance of gaxios with a custom config
         this.client = new Gaxios({
             baseURL: `${this.url.trim()}`,
-            timeout: AXIOS_TIMEOUT,
+            timeout: REQUEST_TIMEOUT,
             proxy: proxy ? proxy.toString() : undefined,
             retry: true,
             retryConfig: {

package/src/pipe/testomatio.js

@@ -2,7 +2,13 @@ import createDebugMessages from 'debug';
 import pc from 'picocolors';
 import { Gaxios } from 'gaxios';
 import JsonCycle from 'json-cycle';
-import { APP_PREFIX, STATUS, AXIOS_TIMEOUT, REPORTER_REQUEST_RETRIES } from '../constants.js';
+import {
+  APP_PREFIX,
+  STATUS,
+  REQUEST_TIMEOUT,
+  getCreateRunRequestTimeout,
+  REPORTER_REQUEST_RETRIES,
+} from '../constants.js';
 import {
   isValidUrl,
   foundedTestLog,
@@ -81,7 +87,7 @@ class TestomatioPipe {
     // Create a new instance of gaxios with a custom config
     this.client = new Gaxios({
       baseURL: `${this.url.trim()}`,
-      timeout: AXIOS_TIMEOUT,
+      timeout: REQUEST_TIMEOUT,
       proxy: proxy ? proxy.toString() : undefined,
       retry: true,
       retryConfig: {
@@ -256,6 +262,7 @@ class TestomatioPipe {
         method: 'PUT',
         url: `/api/reporter/${this.runId}`,
         data: runParams,
+        timeout: getCreateRunRequestTimeout(),
         responseType: 'json',
       });
       if (resp.data.artifacts) setS3Credentials(resp.data.artifacts);
@@ -277,6 +284,7 @@ class TestomatioPipe {
         method: 'POST',
         url: '/api/reporter',
         data: runParams,
+        timeout: getCreateRunRequestTimeout(),
         maxContentLength: Infinity,
         responseType: 'json',
       });
@@ -294,14 +302,13 @@ class TestomatioPipe {
       process.env.runId = this.runId;
       debug('Run created', this.runId);
     } catch (err) {
+      if (!this.apiKey) console.error('Testomat.io API key is not set');
       const errorText = err.response?.data?.message || err.message;
       debug('Error creating run', err);
-      console.log(errorText || err);
+      console.log(APP_PREFIX, errorText || err);
       if (err.response?.status === 403) this.#disablePipe();
-      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');
 
-      if (process.env.DEBUG || process.env.TESTOMATIO_DEBUG) this.#logFailedResponse(err);
+      this.#logFailedResponse(err);
 
       console.error(
         APP_PREFIX,
@@ -532,8 +539,8 @@ class TestomatioPipe {
         );
       }
     } catch (err) {
-      log.info('Error updating status, skipping...', err);
-      if (process.env.DEBUG || process.env.TESTOMATIO_DEBUG) this.#logFailedResponse(err);
+      console.log(APP_PREFIX, 'Error updating status, skipping...', err);
+      this.#logFailedResponse(err);
       printCreateIssue();
     }
     debug('Run finished');
@@ -558,19 +565,26 @@ class TestomatioPipe {
     responseBody = hideTestomatioToken(responseBody);
 
     const statusCode = error.status || error.code || error.response?.status || '<unknown status code>';
-    const method = error.response?.config.method || '<unknown method>';
-    const url = error.response?.config.url || '<unknown url>';
+    const method = error.response?.config?.method || '<unknown method>';
+    const url = String(error.response?.config?.url || '<unknown url>');
+
+    let message = pc.yellow('⚠️ Request to Testomat.io failed:\n');
+    message += pc.bold(`${pc.red(statusCode)} ${method} ${pc.gray(url)}\n`);
+
+    if (statusCode === 403) {
+      message += `\t${pc.red('Please check your API token. It might be invalid or expired.')}\n`;
+    }
 
-    let message = pc.yellow('\n⚠️ Request to Testomat.io failed:\n');
-    message += pc.bold(`${pc.red(statusCode)} ${method} ${url}\n`);
     message += `\t${pc.bold('response: ')}${pc.gray(responseBody)}\n`;
 
     const requestBody = hideTestomatioToken(stringify(error.response?.config?.data));
-    if (process.env.DEBUG || process.env.TESTOMATIO_DEBUG) {
+    if (process.env.DEBUG || process.env.TESTOMATIO_DEBUG || requestBody.length < 1000) {
+      // full body
       message += `\t${pc.bold('request: ')}${pc.gray(requestBody)}\n`;
     } else {
+      // cut body
       const requestBodyCut = requestBody.slice(0, 1000);
-      message += `\t${pc.bold('request: ')}${pc.gray(`${requestBodyCut}.....`)}\n`;
+      message += `\t${pc.bold('request: ')}${pc.gray(`${requestBodyCut}...`)}\n`;
       message += '\trequest body is cut, run with TESTOMATIO_DEBUG=1 to see full body\n';
     }
 

package/src/xmlReader.js

@@ -39,18 +39,29 @@ const {
   TESTOMATIO_RUN,
   TESTOMATIO_MARK_DETACHED,
   TESTOMATIO_LEGACY_NUNIT,
+  TESTOMATIO_MAX_ENTITY_EXPANSIONS,
 } = process.env;
 
+const MAX_OUTPUT_LENGTH = parseInt(TESTOMATIO_MAX_STACK_TRACE, 10) || 10000;
+const MAX_ENTITY_EXPANSIONS = parseInt(TESTOMATIO_MAX_ENTITY_EXPANSIONS, 10) || 10000;
+const ENTITY_EXPANSION_LIMIT_REGEXP = /Entity expansion limit exceeded/i;
+
 const options = {
   ignoreDeclaration: true,
   ignoreAttributes: false,
   alwaysCreateTextNode: false,
   attributeNamePrefix: '',
   parseTagValue: true,
+  processEntities: {
+    enabled: true,
+    maxEntitySize: 10000,
+    maxExpansionDepth: 10,
+    maxTotalExpansions: MAX_ENTITY_EXPANSIONS,
+    maxExpandedLength: 100000,
+    maxEntityCount: 10000,
+  },
 };
 
-const MAX_OUTPUT_LENGTH = parseInt(TESTOMATIO_MAX_STACK_TRACE, 10) || 10000;
-
 const reduceOptions = {};
 
 class XmlReader {
@@ -113,7 +124,20 @@ class XmlReader {
       xmlData = xmlData.replace(regex, (_, p1, p2, p3) => `${p1}${p2.substring(0, MAX_OUTPUT_LENGTH)}${p3}`);
     }
 
-    const jsonResult = this.parser.parse(xmlData);
+    let jsonResult;
+    try {
+      jsonResult = this.parser.parse(xmlData);
+    } catch (error) {
+      if (ENTITY_EXPANSION_LIMIT_REGEXP.test(error.message)) {
+        throw new Error(
+          `${error.message}\n\n` +
+            `XML report contains more entity references than the current limit (${MAX_ENTITY_EXPANSIONS}). ` +
+            'If this XML report is trusted, increase the limit with TESTOMATIO_MAX_ENTITY_EXPANSIONS, for example:\n' +
+            `TESTOMATIO_MAX_ENTITY_EXPANSIONS=${MAX_ENTITY_EXPANSIONS * 2} npx report-xml "{pattern}" --lang={lang}`,
+        );
+      }
+      throw error;
+    }
     let jsonSuite;
 
     if (jsonResult.testsuites) {