@testomatio/reporter 2.3.7-beta.3-xml-import → 2.3.7-beta.4-stack-artifacts

package/src/client.js

@@ -10,7 +10,14 @@ import { glob } from 'glob';
 import path, { sep } from 'path';
 import { fileURLToPath } from 'node:url';
 import { S3Uploader } from './uploader.js';
-import { formatStep, truncate, readLatestRunId, storeRunId, validateSuiteId } from './utils/utils.js';
+import {
+  formatStep,
+  truncate,
+  readLatestRunId,
+  storeRunId,
+  validateSuiteId,
+  transformEnvVarToBoolean
+} from './utils/utils.js';
 import { filesize as prettyBytes } from 'filesize';
 
 const debug = createDebugMessages('@testomatio/reporter:client');
@@ -37,8 +44,9 @@ class Client {
     this.runId = '';
     this.queue = Promise.resolve();
 
-    // Get package.json path - use a simple approach that works in both environments
-    const pathToPackageJSON = path.join(process.cwd(), 'package.json');
+    // @ts-ignore this line will be removed in compiled code, because __dirname is defined in commonjs
+    const __dirname = path.dirname(fileURLToPath(import.meta.url));
+    const pathToPackageJSON = path.join(__dirname, '../package.json');
     try {
       this.version = JSON.parse(fs.readFileSync(pathToPackageJSON).toString()).version;
       console.log(APP_PREFIX, `Testomatio Reporter v${this.version}`);
@@ -138,19 +146,6 @@ class Client {
    * @returns {Promise<PipeResult[]>}
    */
   async addTestRun(status, testData) {
-    if (!this.pipes || !this.pipes.length)
-      this.pipes = await pipesFactory(this.paramsForPipesFactory || {}, this.pipeStore);
-
-    // all pipes disabled, skipping
-    if (!this.pipes?.filter(p => p.isEnabled).length) return [];
-
-    if (isTestShouldBeExculedFromReport(testData)) return [];
-
-    if (status === STATUS.SKIPPED && process.env.TESTOMATIO_EXCLUDE_SKIPPED) {
-      debug('Skipping test from report', testData?.title);
-      return []; // do not log skipped tests
-    }
-
     if (!testData)
       testData = {
         title: 'Unknown test',
@@ -168,15 +163,61 @@ class Client {
     const {
       rid,
       error = null,
+      steps: originalSteps,
+      title,
+      suite_title,
+    } = testData;
+    let steps = originalSteps;
+
+    const uploadedFiles = [];
+    const stackArtifactsEnabled = transformEnvVarToBoolean(process.env.TESTOMATIO_STACK_ARTIFACTS);
+
+    let formattedSteps;
+    if (stackArtifactsEnabled) {
+      const timestamp = +new Date;
+      formattedSteps = Array.isArray(steps) ? steps.map(step => formatStep(step)).flat().join('\n') : '';
+
+      if (error?.stack?.length > 5000) {
+        uploadedFiles.push(
+          this.uploader.uploadFileAsBuffer(
+            Buffer.from(error.stack, 'utf8'),
+            [this.runId, rid, `stack_${timestamp}.log`]
+          )
+        );
+      }
+      if (formattedSteps?.length > 10000) {
+        uploadedFiles.push(
+          this.uploader.uploadFileAsBuffer(
+            Buffer.from(JSON.stringify(steps, null, 2), 'utf8'),
+            [this.runId, rid, `steps_${timestamp}.json`]
+          )
+        );
+      }
+    }
+    if (!this.pipes || !this.pipes.length)
+      this.pipes = await pipesFactory(this.paramsForPipesFactory || {}, this.pipeStore);
+
+    if (!this.pipes?.filter(p => p.isEnabled).length) {
+      if (uploadedFiles.length > 0) {
+        await Promise.all(uploadedFiles);
+      }
+      return [];
+    }
+
+    if (isTestShouldBeExculedFromReport(testData)) return [];
+
+    if (status === STATUS.SKIPPED && process.env.TESTOMATIO_EXCLUDE_SKIPPED) {
+      debug('Skipping test from report', testData?.title);
+      return [];
+    }
+
+    const {
       time = 0,
       example = null,
       files = [],
       filesBuffers = [],
-      steps,
       code = null,
-      title,
       file,
-      suite_title,
       suite_id,
       test_id,
       timestamp,
@@ -187,7 +228,6 @@ class Client {
     } = testData;
     let { message = '', meta = {} } = testData;
 
-    // stringify meta values and limit keys and values length to 255
     meta = Object.entries(meta)
       .filter(([, value]) => value !== null && value !== undefined)
       .reduce((acc, [key, value]) => {
@@ -195,7 +235,6 @@ class Client {
         return acc;
       }, {});
 
-    // Get links from storage using the test context
     const testContext = suite_title ? `${suite_title} ${title}` : title;
 
     let errorFormatted = '';
@@ -204,13 +243,27 @@ class Client {
       message = error?.message;
     }
 
-    // Attach logs
-    const fullLogs = this.formatLogs({ error: errorFormatted, steps, logs: testData.logs });
+    if (stackArtifactsEnabled) {
+      if (error?.stack?.length > 5000) errorFormatted = `[Large stack saved as artifact]`;
+      if (formattedSteps?.length > 10000) steps = null;
+    } else {
+      formattedSteps = Array.isArray(steps) ? steps.map(step => formatStep(step)).flat().join('\n') : '';
+    }
 
-    // add artifacts
-    if (manuallyAttachedArtifacts?.length) files.push(...manuallyAttachedArtifacts);
+    let fullLogs = this.formatLogs({ error: errorFormatted, steps, logs: testData.logs });
 
-    const uploadedFiles = [];
+    if (stackArtifactsEnabled && fullLogs.length > 5000) {
+      const timestamp = +new Date;
+      uploadedFiles.push(
+        this.uploader.uploadFileAsBuffer(
+          Buffer.from(fullLogs, 'utf8'),
+          [this.runId, rid, `logs_${timestamp}.log`]
+        )
+      );
+      fullLogs = fullLogs.slice(0, 5000) + '\n\n[Full logs saved as artifact]';
+    }
+
+    if (manuallyAttachedArtifacts?.length) files.push(...manuallyAttachedArtifacts);
 
     for (let f of files) {
       if (!f) continue; // f === null
@@ -386,11 +439,7 @@ class Client {
    */
   formatLogs({ error, steps, logs }) {
     error = error?.trim();
-    logs = logs
-      ?.trim()
-      .split('\n')
-      .map(l => truncate(l))
-      .join('\n');
+    logs = logs?.trim().split('\n').map(l => truncate(l)).join('\n');
 
     if (Array.isArray(steps)) {
       steps = steps

package/src/junit-adapter/csharp.js

@@ -3,50 +3,18 @@ import Adapter from './adapter.js';
 
 class CSharpAdapter extends Adapter {
   formatTest(t) {
-    // Extract example from title if not already present
-    if (!t.example) {
-      const exampleMatch = t.title.match(/\((.*?)\)/);
-      if (exampleMatch) {
-        // Extract parameters as object with numeric keys for API
-        const params = exampleMatch[1].split(',').map(param => param.trim());
-        t.example = {};
-        params.forEach((param, index) => {
-          t.example[index] = param;
-        });
-      }
-    }
-
-    // Remove parameters from title to avoid duplicates in Test Suite
-    // The example field will be used for grouping on import
-    t.title = t.title.replace(/\(.*?\)/, '').trim();
-
+    const title = t.title.replace(/\(.*?\)/, '').trim();
+    const example = t.title.match(/\((.*?)\)/);
+    if (example) t.example = { ...example[1].split(',') };
     const suite = t.suite_title.split('.');
     t.suite_title = suite.pop();
     t.file = namespaceToFileName(t.file);
+    t.title = title.trim();
     return t;
   }
 
   getFilePath(t) {
-    if (!t.file) return null;
-
-    // Normalize path separators for cross-platform compatibility
-    let filePath = t.file.replace(/\\/g, '/');
-
-    // If file already has .cs extension, use it directly
-    if (filePath.endsWith('.cs')) {
-      // Make relative path if it's absolute
-      if (path.isAbsolute(filePath)) {
-        // Try to find project-relative path
-        const cwd = process.cwd().replace(/\\/g, '/');
-        if (filePath.startsWith(cwd)) {
-          filePath = path.relative(cwd, filePath).replace(/\\/g, '/');
-        }
-      }
-      return filePath;
-    }
-
-    // Convert namespace path to file path
-    const fileName = namespaceToFileName(filePath);
+    const fileName = namespaceToFileName(t.file);
     return fileName;
   }
 }
@@ -54,14 +22,7 @@ class CSharpAdapter extends Adapter {
 export default CSharpAdapter;
 
 function namespaceToFileName(fileName) {
-  if (!fileName) return '';
-
-  // If already a .cs file path, clean it up
-  if (fileName.endsWith('.cs')) {
-    return fileName.replace(/\\/g, '/');
-  }
-
   const fileParts = fileName.split('.');
   fileParts[fileParts.length - 1] = fileParts[fileParts.length - 1]?.replace(/\$.*/, '');
-  return `${fileParts.join('/')}.cs`;
+  return `${fileParts.join(path.sep)}.cs`;
 }

package/src/pipe/debug.js

@@ -15,7 +15,7 @@ export class DebugPipe {
     this.isEnabled = !!process.env.TESTOMATIO_DEBUG || !!process.env.DEBUG;
     if (this.isEnabled) {
       this.batch = {
-        isEnabled: this.params.isBatchEnabled ?? (process.env.TESTOMATIO_DISABLE_BATCH_UPLOAD ? false : true),
+        isEnabled: this.params.isBatchEnabled ?? !process.env.TESTOMATIO_DISABLE_BATCH_UPLOAD ?? true,
         intervalFunction: null,
         intervalTime: 5000,
         tests: [],
@@ -93,7 +93,8 @@ export class DebugPipe {
       const logData = { action: 'addTest', testId: data };
       if (this.store.runId) logData.runId = this.store.runId;
       this.logToFile(logData);
-    } else this.batch.tests.push(data);
+    }
+    else this.batch.tests.push(data);
 
     if (!this.batch.intervalFunction) await this.batchUpload();
   }

package/src/pipe/testomatio.js

@@ -20,7 +20,7 @@ if (process.env.TESTOMATIO_RUN) process.env.runId = process.env.TESTOMATIO_RUN;
 class TestomatioPipe {
   constructor(params, store) {
     this.batch = {
-      isEnabled: params?.isBatchEnabled ?? (process.env.TESTOMATIO_DISABLE_BATCH_UPLOAD ? false : true),
+      isEnabled: params?.isBatchEnabled ?? !process.env.TESTOMATIO_DISABLE_BATCH_UPLOAD ?? true,
       intervalFunction: null, // will be created in createRun by setInterval function
       intervalTime: 5000, // how often tests are sent
       tests: [], // array of tests in batch
@@ -60,8 +60,8 @@ class TestomatioPipe {
       retryConfig: {
         retry: REPORTER_REQUEST_RETRIES.retriesPerRequest,
         retryDelay: REPORTER_REQUEST_RETRIES.retryTimeout,
-        httpMethodsToRetry: ['GET', 'PUT', 'HEAD', 'OPTIONS', 'DELETE', 'POST'],
-        shouldRetry: error => {
+        httpMethodsToRetry: ['GET','PUT','HEAD','OPTIONS','DELETE','POST'],
+        shouldRetry: (error) => {
           if (!error.response) return false;
           switch (error.response?.status) {
             case 400: // Bad request (probably wrong API key)
@@ -73,8 +73,8 @@ class TestomatioPipe {
               break;
           }
           return error.response?.status >= 401; // Retry on 401+ and 5xx
-        },
-      },
+        }
+      }
     });
 
     this.isEnabled = true;
@@ -104,6 +104,7 @@ class TestomatioPipe {
     // add test ID + run ID
     if (data.rid) data.rid = `${this.runId}-${data.rid}`;
 
+
     if (!process.env.TESTOMATIO_STACK_PASSED && data.status === STATUS.PASSED) {
       data.stack = null;
     }
@@ -119,6 +120,7 @@ class TestomatioPipe {
     return data;
   }
 
+
   /**
    * Asynchronously prepares and retrieves the Testomat.io test grepList based on the provided options.
    * @param {Object} opts - The options for preparing the test grepList.
@@ -213,7 +215,7 @@ class TestomatioPipe {
         method: 'PUT',
         url: `/api/reporter/${this.runId}`,
         data: runParams,
-        responseType: 'json',
+        responseType: 'json'
       });
       if (resp.data.artifacts) setS3Credentials(resp.data.artifacts);
       return;
@@ -226,7 +228,7 @@ class TestomatioPipe {
         url: '/api/reporter',
         data: runParams,
         maxContentLength: Infinity,
-        responseType: 'json',
+        responseType: 'json'
       });
 
       this.runId = resp.data.uid;
@@ -285,44 +287,44 @@ class TestomatioPipe {
 
     debug('Adding test', json);
 
-    return this.client
-      .request({
-        method: 'POST',
-        url: `/api/reporter/${this.runId}/testrun`,
-        data: json,
-        headers: {
-          'Content-Type': 'application/json',
-        },
-        maxContentLength: Infinity,
-      })
-      .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: ${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.client.request({
+      method: 'POST',
+      url: `/api/reporter/${this.runId}/testrun`,
+      data: json,
+      headers: {
+        'Content-Type': 'application/json',
+      },
+      maxContentLength: Infinity
+    }).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
    */
@@ -347,42 +349,43 @@ class TestomatioPipe {
     const testsToSend = this.batch.tests.splice(0);
     debug('📨 Batch upload', testsToSend.length, 'tests');
 
-    return this.client
-      .request({
-        method: 'POST',
-        url: `/api/reporter/${this.runId}/testrun`,
-        data: {
-          api_key: this.apiKey,
-          tests: testsToSend,
-          batch_index: this.batch.batchIndex,
-        },
-        headers: {
-          'Content-Type': 'application/json',
-        },
-        maxContentLength: Infinity,
-      })
-      .catch(err => {
-        this.requestFailures++;
-        this.notReportedTestsCount += testsToSend.length;
-        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})`));
-            if (err.response?.data?.message?.includes('could not be matched')) {
-              this.hasUnmatchedTests = true;
-            }
-            return;
-          }
+    return this.client.request({
+      method: 'POST',
+      url: `/api/reporter/${this.runId}/testrun`,
+      data: {
+        api_key: this.apiKey,
+        tests: testsToSend,
+        batch_index: this.batch.batchIndex
+      },
+      headers: {
+        'Content-Type': 'application/json',
+      },
+      maxContentLength: Infinity
+    }).catch(err => {
+      this.requestFailures++;
+      this.notReportedTestsCount += testsToSend.length;
+      if (err.response) {
+        if (err.response.status >= 400) {
+          const responseData = err.response.data || { message: '' };
           console.log(
             APP_PREFIX,
-            pc.yellow(`Warning: (${err.response?.status})`),
-            `Report couldn't be processed: ${err?.response?.data?.message}`,
+            pc.yellow(`Warning: ${responseData.message} (${err.response.status})`),
           );
-          printCreateIssue(err);
-        } else {
-          console.log(APP_PREFIX, "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: (${err.response?.status})`),
+          `Report couldn't be processed: ${err?.response?.data?.message}`,
+        );
+        printCreateIssue(err);
+      } else {
+        console.log(APP_PREFIX, "Report couldn't be processed", err);
+      }
+    });
   };
 
   /**
@@ -405,9 +408,9 @@ class TestomatioPipe {
     else this.batch.tests.push(data);
 
     // if test is added after run which is already finished
-    if (!this.batch.intervalFunction) uploading = this.#batchUpload();
+     if (!this.batch.intervalFunction) uploading = this.#batchUpload();
 
-    // return promise to be able to wait for it
+     // return promise to be able to wait for it
     return uploading;
   }
 
@@ -456,7 +459,7 @@ class TestomatioPipe {
             status_event,
             detach: params.detach,
             tests: params.tests,
-          },
+          }
         });
 
         if (this.runUrl) {
@@ -469,7 +472,7 @@ class TestomatioPipe {
       if (this.runUrl && this.proceed) {
         const notFinishedMessage = pc.yellow(pc.bold('Run was not finished because of $TESTOMATIO_PROCEED'));
         console.log(APP_PREFIX, `📊 ${notFinishedMessage}. Report URL: ${pc.magenta(this.runUrl)}`);
-        console.log(APP_PREFIX, `🛬 Run to finish it: TESTOMATIO_RUN=${this.runId} npx @testomatio/reporter finish`);
+        console.log(APP_PREFIX, `🛬 Run to finish it: TESTOMATIO_RUN=${this.runId} npx start-test-run --finish`);
       }
 
       if (this.hasUnmatchedTests) {
@@ -522,6 +525,9 @@ function printCreateIssue(err) {
     console.log({ body: body?.replace(/"(tstmt_[^"]+)"/g, 'tstmt_*'), url, baseURL, method, time });
     console.log('```');
   });
+
 }
 
+
+
 export default TestomatioPipe;

package/src/reporter.js

@@ -1,8 +1,10 @@
-// import TestomatClient from './client.js';
-// import * as TRConstants from './constants.js';
+import Client from './client.js';
+import * as TestomatioConstants   from './constants.js';
 import { services } from './services/index.js';
 import reporterFunctions from './reporter-functions.js';
 
+export { Client };
+export const STATUS = TestomatioConstants.STATUS;
 export const artifact = reporterFunctions.artifact;
 export const log = reporterFunctions.log;
 export const logger = services.logger;
@@ -35,6 +37,7 @@ export default {
   linkTest: reporterFunctions.linkTest,
   linkJira: reporterFunctions.linkJira,
 
-  // TestomatClient,
-  // TRConstants,
+  TestomatioClient: Client,
+  STATUS,
+
 };