@testomatio/reporter 2.3.7-beta.4-stack-artifacts → 2.3.7-beta.5-stack-artifacts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@testomatio/reporter",
-  "version": "2.3.7-beta.4-stack-artifacts",
+  "version": "2.3.7-beta.5-stack-artifacts",
   "description": "Testomatio Reporter Client",
   "engines": {
     "node": ">=18"

package/src/bin/startTest.js

@@ -18,7 +18,7 @@ const newArgs = ['run'];
 let i = 0;
 while (i < args.length) {
   const arg = args[i];
-  
+
   if (arg === '-c' || arg === '--command') {
     // Map -c/--command to positional argument for run command
     i++;
@@ -33,7 +33,7 @@ while (i < args.length) {
     // Map --launch to start command
     newArgs[0] = 'start';
   } else if (arg === '--finish') {
-    // Map --finish to finish command  
+    // Map --finish to finish command
     newArgs[0] = 'finish';
   } else {
     // Pass through other arguments
@@ -45,9 +45,9 @@ while (i < args.length) {
 // Execute the main CLI with mapped arguments
 
 const child = spawn(process.execPath, [cliPath, ...newArgs], {
-  stdio: 'inherit'
+  stdio: 'inherit',
 });
 
-child.on('exit', (code) => {
+child.on('exit', code => {
   process.exit(code);
-});
+});

package/src/client.js

@@ -10,14 +10,7 @@ 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,
-  transformEnvVarToBoolean
-} from './utils/utils.js';
+import { formatStep, truncate, readLatestRunId, storeRunId, validateSuiteId } from './utils/utils.js';
 import { filesize as prettyBytes } from 'filesize';
 
 const debug = createDebugMessages('@testomatio/reporter:client');
@@ -146,6 +139,19 @@ 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',
@@ -163,61 +169,15 @@ 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,
@@ -228,6 +188,7 @@ 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]) => {
@@ -235,6 +196,7 @@ class Client {
         return acc;
       }, {});
 
+    // Get links from storage using the test context
     const testContext = suite_title ? `${suite_title} ${title}` : title;
 
     let errorFormatted = '';
@@ -243,28 +205,14 @@ class Client {
       message = error?.message;
     }
 
-    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') : '';
-    }
-
-    let fullLogs = this.formatLogs({ error: errorFormatted, steps, logs: testData.logs });
-
-    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]';
-    }
+    // Attach logs
+    const fullLogs = this.formatLogs({ error: errorFormatted, steps, logs: testData.logs });
 
+    // add artifacts
     if (manuallyAttachedArtifacts?.length) files.push(...manuallyAttachedArtifacts);
 
+    const uploadedFiles = [];
+
     for (let f of files) {
       if (!f) continue; // f === null
       if (typeof f === 'object') {

package/src/pipe/testomatio.js

@@ -472,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 start-test-run --finish`);
+        console.log(APP_PREFIX, `🛬 Run to finish it: TESTOMATIO_RUN=${this.runId} npx @testomatio/reporter finish`);
       }
 
       if (this.hasUnmatchedTests) {

package/src/reporter.js

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