@testomatio/reporter 2.3.6 → 2.3.7-beta.-stack-artifacts

package/lib/client.js

@@ -51,7 +51,9 @@ const node_url_1 = require("node:url");
 const uploader_js_1 = require("./uploader.js");
 const utils_js_1 = require("./utils/utils.js");
 const filesize_1 = require("filesize");
+const util_1 = require("util");
 const debug = (0, debug_1.default)('@testomatio/reporter:client');
+const stripColors = util_1.stripVTControlCharacters || ((str) => str?.replace(/\x1b\[[0-9;]*m/g, '') || '');
 // removed __dirname usage, because:
 // 1. replaced with ESM syntax (import.meta.url), but it throws an error on tsc compilation;
 // 2. got error "__dirname already defined" in compiles js code (cjs dir)
@@ -158,17 +160,6 @@ class Client {
      * @returns {Promise<PipeResult[]>}
      */
     async addTestRun(status, testData) {
-        if (!this.pipes || !this.pipes.length)
-            this.pipes = await (0, index_js_1.pipesFactory)(this.paramsForPipesFactory || {}, this.pipeStore);
-        // all pipes disabled, skipping
-        if (!this.pipes?.filter(p => p.isEnabled).length)
-            return [];
-        if (isTestShouldBeExculedFromReport(testData))
-            return [];
-        if (status === constants_js_1.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',
@@ -181,9 +172,12 @@ class Client {
         /**
          * @type {TestData}
          */
-        const { rid, error = null, time = 0, example = null, files = [], filesBuffers = [], steps, code = null, title, file, suite_title, suite_id, test_id, timestamp, links, manuallyAttachedArtifacts, overwrite, tags, } = testData;
+        const { rid, error = null, steps: originalSteps, title, suite_title, } = testData;
+        const steps = originalSteps;
+        const uploadedFiles = [];
+        const stackArtifactsEnabled = (0, utils_js_1.transformEnvVarToBoolean)(process.env.TESTOMATIO_STACK_ARTIFACTS);
+        const { time = 0, example = null, files = [], filesBuffers = [], code = null, file, suite_id, test_id, timestamp, links, manuallyAttachedArtifacts, overwrite, tags, } = 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]) => {
@@ -191,19 +185,34 @@ class Client {
                 acc[key] = value;
             return acc;
         }, {});
-        // Get links from storage using the test context
         const testContext = suite_title ? `${suite_title} ${title}` : title;
         let errorFormatted = '';
         if (error) {
             errorFormatted += this.formatError(error) || '';
             message = error?.message;
         }
-        // Attach logs
-        const fullLogs = this.formatLogs({ error: errorFormatted, steps, logs: testData.logs });
-        // add artifacts
+        let fullLogs = this.formatLogs({ error: errorFormatted, steps, logs: testData.logs });
+        if (stackArtifactsEnabled) {
+            const timestamp = +new Date;
+            uploadedFiles.push(this.uploader.uploadFileAsBuffer(Buffer.from(stripColors(fullLogs), 'utf8'), [this.runId, rid, `logs_${timestamp}.log`]));
+            fullLogs = '';
+        }
+        if (!this.pipes || !this.pipes.length)
+            this.pipes = await (0, index_js_1.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 === constants_js_1.STATUS.SKIPPED && process.env.TESTOMATIO_EXCLUDE_SKIPPED) {
+            debug('Skipping test from report', testData?.title);
+            return [];
+        }
         if (manuallyAttachedArtifacts?.length)
             files.push(...manuallyAttachedArtifacts);
-        const uploadedFiles = [];
         for (let f of files) {
             if (!f)
                 continue; // f === null

package/lib/reporter.d.ts

@@ -1,3 +1,10 @@
+export { Client };
+export const STATUS: {
+    PASSED: string;
+    FAILED: string;
+    SKIPPED: string;
+    FINISHED: string;
+};
 export const artifact: (data: string | {
     path: string;
     type: string;
@@ -80,7 +87,7 @@ export const label: (key: string, value?: string | null) => void;
 export const linkTest: (...testIds: string[]) => void;
 export const linkJira: (...jiraIds: string[]) => void;
 declare namespace _default {
-    let testomatioLogger: {
+    export let testomatioLogger: {
         "__#13@#originalUserLogger": {
             assert(condition?: boolean, ...data: any[]): void;
             assert(value: any, message?: string, ...optionalParams: any[]): void;
@@ -148,13 +155,13 @@ declare namespace _default {
         }): void;
         prettyObjects: boolean;
     };
-    let artifact: (data: string | {
+    export let artifact: (data: string | {
         path: string;
         type: string;
         name: string;
     }, context?: any) => void;
-    let log: (...args: any[]) => void;
-    let logger: {
+    export let log: (...args: any[]) => void;
+    export let logger: {
         "__#13@#originalUserLogger": {
             assert(condition?: boolean, ...data: any[]): void;
             assert(value: any, message?: string, ...optionalParams: any[]): void;
@@ -222,13 +229,15 @@ declare namespace _default {
         }): void;
         prettyObjects: boolean;
     };
-    let meta: (keyValue: {
+    export let meta: (keyValue: {
         [key: string]: string;
     } | string, value?: string | null) => void;
-    let step: (message: string) => void;
-    let label: (key: string, value?: string | null) => void;
-    let linkTest: (...testIds: string[]) => void;
-    let linkJira: (...jiraIds: string[]) => void;
+    export let step: (message: string) => void;
+    export let label: (key: string, value?: string | null) => void;
+    export let linkTest: (...testIds: string[]) => void;
+    export let linkJira: (...jiraIds: string[]) => void;
+    export { Client as TestomatioClient };
+    export { STATUS };
 }
 export default _default;
 export type ArtifactFunction = typeof import("./reporter-functions.js").default.artifact;
@@ -237,3 +246,4 @@ export type LoggerService = typeof import("./services/index.js").services.logger
 export type MetaFunction = typeof import("./reporter-functions.js").default.keyValue;
 export type StepFunction = typeof import("./reporter-functions.js").default.step;
 export type LabelFunction = typeof import("./reporter-functions.js").default.label;
+import Client from './client.js';

package/lib/reporter.js

@@ -1,13 +1,48 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.linkJira = exports.linkTest = exports.label = exports.step = exports.meta = exports.logger = exports.log = exports.artifact = void 0;
-// import TestomatClient from './client.js';
-// import * as TRConstants from './constants.js';
+exports.linkJira = exports.linkTest = exports.label = exports.step = exports.meta = exports.logger = exports.log = exports.artifact = exports.STATUS = exports.Client = void 0;
+const client_js_1 = __importDefault(require("./client.js"));
+exports.Client = client_js_1.default;
+const TestomatioConstants = __importStar(require("./constants.js"));
 const index_js_1 = require("./services/index.js");
 const reporter_functions_js_1 = __importDefault(require("./reporter-functions.js"));
+exports.STATUS = TestomatioConstants.STATUS;
 exports.artifact = reporter_functions_js_1.default.artifact;
 exports.log = reporter_functions_js_1.default.log;
 exports.logger = index_js_1.services.logger;
@@ -37,6 +72,6 @@ module.exports = {
     label: reporter_functions_js_1.default.label,
     linkTest: reporter_functions_js_1.default.linkTest,
     linkJira: reporter_functions_js_1.default.linkJira,
-    // TestomatClient,
-    // TRConstants,
+    TestomatioClient: client_js_1.default,
+    STATUS: exports.STATUS,
 };

package/package.json

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

package/src/client.js

@@ -10,11 +10,21 @@ 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';
+import { stripVTControlCharacters } from 'util';
 
 const debug = createDebugMessages('@testomatio/reporter:client');
 
+const stripColors = stripVTControlCharacters || ((str) => str?.replace(/\x1b\[[0-9;]*m/g, '') || '');
+
 // removed __dirname usage, because:
 // 1. replaced with ESM syntax (import.meta.url), but it throws an error on tsc compilation;
 // 2. got error "__dirname already defined" in compiles js code (cjs dir)
@@ -139,19 +149,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',
@@ -169,15 +166,23 @@ class Client {
     const {
       rid,
       error = null,
+      steps: originalSteps,
+      title,
+      suite_title,
+    } = testData;
+    const steps = originalSteps;
+
+    const uploadedFiles = [];
+    const stackArtifactsEnabled = transformEnvVarToBoolean(process.env.TESTOMATIO_STACK_ARTIFACTS);
+
+    
+    const {
       time = 0,
       example = null,
       files = [],
       filesBuffers = [],
-      steps,
       code = null,
-      title,
       file,
-      suite_title,
       suite_id,
       test_id,
       timestamp,
@@ -188,7 +193,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]) => {
@@ -196,7 +200,6 @@ class Client {
         return acc;
       }, {});
 
-    // Get links from storage using the test context
     const testContext = suite_title ? `${suite_title} ${title}` : title;
 
     let errorFormatted = '';
@@ -205,13 +208,38 @@ class Client {
       message = error?.message;
     }
 
-    // Attach logs
-    const fullLogs = this.formatLogs({ error: errorFormatted, steps, logs: testData.logs });
+    let fullLogs = this.formatLogs({ error: errorFormatted, steps, logs: testData.logs });
 
-    // add artifacts
-    if (manuallyAttachedArtifacts?.length) files.push(...manuallyAttachedArtifacts);
+    if (stackArtifactsEnabled) {
+      const timestamp = +new Date;
+      uploadedFiles.push(
+        this.uploader.uploadFileAsBuffer(
+          Buffer.from(stripColors(fullLogs), 'utf8'),
+          [this.runId, rid, `logs_${timestamp}.log`]
+        )
+      );
+      fullLogs = '';
+    }
 
-    const uploadedFiles = [];
+    
+    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 [];
+    }
+
+    if (manuallyAttachedArtifacts?.length) files.push(...manuallyAttachedArtifacts);
 
     for (let f of files) {
       if (!f) continue; // f === null

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,
+
 };