qase-javascript-commons 2.2.16 → 2.2.17

package/changelog.md

@@ -1,3 +1,10 @@
+# qase-javascript-commons@2.2.17
+
+## What's new
+
+- Logging of host system details to improve debugging and traceability.
+- Output of installed packages in logs for better environment visibility.
+
 # qase-javascript-commons@2.2.16
 
 ## What's new

package/dist/models/host-data.d.ts

@@ -1,11 +1,13 @@
-export type HostData = {
+export interface HostData {
     system: string;
-    node: string;
+    machineName: string;
     release: string;
     version: string;
-    machine: string;
-    python: string;
-    pip: string;
-    node_version: string;
+    arch: string;
+    node: string;
     npm: string;
-};
+    framework: string;
+    reporter: string;
+    commons: string;
+    apiClient: string;
+}

package/dist/qase.d.ts

@@ -15,14 +15,6 @@ export interface ReporterInterface {
  */
 export declare class QaseReporter implements ReporterInterface {
     private static instance;
-    /**
-     * @param {string} frameworkPackage
-     * @param {string} frameworkName
-     * @param {string} reporterName
-     * @returns {Record<string, string>}
-     * @private
-     */
-    private static createHeaders;
     /**
      * @type {InternalReporterInterface}
      * @private

package/dist/qase.js

@@ -4,7 +4,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.QaseReporter = void 0;
-const child_process_1 = require("child_process");
 const env_schema_1 = __importDefault(require("env-schema"));
 const chalk_1 = __importDefault(require("chalk"));
 const qaseio_1 = require("qaseio");
@@ -13,11 +12,11 @@ const options_1 = require("./options");
 const env_1 = require("./env");
 const models_1 = require("./models");
 const writer_1 = require("./writer");
-const get_package_version_1 = require("./utils/get-package-version");
 const custom_boundary_1 = require("./utils/custom-boundary");
 const disabled_exception_1 = require("./utils/disabled-exception");
 const logger_1 = require("./utils/logger");
 const state_1 = require("./state/state");
+const hostData_1 = require("./utils/hostData");
 /**
  * @type {Record<TestStatusEnum, (test: TestResultType) => string>}
  */
@@ -35,38 +34,6 @@ const resultLogMap = {
  */
 class QaseReporter {
     static instance;
-    /**
-     * @param {string} frameworkPackage
-     * @param {string} frameworkName
-     * @param {string} reporterName
-     * @returns {Record<string, string>}
-     * @private
-     */
-    static createHeaders(frameworkPackage, frameworkName, reporterName) {
-        const { version: nodeVersion, platform: os, arch } = process;
-        const npmVersion = (0, child_process_1.execSync)('npm -v', { encoding: 'utf8' }).replace(/['"\n]+/g, '');
-        const qaseApiVersion = (0, get_package_version_1.getPackageVersion)('qaseio');
-        const qaseReporterVersion = (0, get_package_version_1.getPackageVersion)('qase-javascript-commons');
-        const frameworkVersion = (0, get_package_version_1.getPackageVersion)(frameworkPackage);
-        const reporterVersion = (0, get_package_version_1.getPackageVersion)(reporterName);
-        const client = [];
-        if (frameworkVersion) {
-            client.push(`${frameworkName}=${frameworkVersion}`);
-        }
-        if (reporterVersion) {
-            client.push(`qase-${frameworkName}=${reporterVersion}`);
-        }
-        if (qaseReporterVersion) {
-            client.push(`qase-core-reporter=${qaseReporterVersion}`);
-        }
-        if (qaseApiVersion) {
-            client.push(`qaseio=${String(qaseApiVersion)}`);
-        }
-        return {
-            'X-Client': client.join('; '),
-            'X-Platform': `node=${nodeVersion}; npm=${npmVersion}; os=${os}; arch=${arch}`,
-        };
-    }
     /**
      * @type {InternalReporterInterface}
      * @private
@@ -117,6 +84,8 @@ class QaseReporter {
         this.options = composedOptions;
         this.logger = new logger_1.Logger({ debug: composedOptions.debug });
         this.logger.logDebug(`Config: ${JSON.stringify(this.sanitizeOptions(composedOptions))}`);
+        const hostData = (0, hostData_1.getHostInfo)(options.frameworkPackage, options.reporterName);
+        this.logger.logDebug(`Host data: ${JSON.stringify(hostData)}`);
         this.captureLogs = composedOptions.captureLogs;
         try {
             this.upstreamReporter = this.createReporter(
@@ -253,7 +222,6 @@ class QaseReporter {
      */
     startTestRun() {
         if (this.withState) {
-            console.log("Clean state");
             state_1.StateManager.clearState();
         }
         if (!this.disabled) {
@@ -413,7 +381,7 @@ class QaseReporter {
      * @private
      */
     createReporter(mode, options) {
-        const { frameworkPackage, frameworkName, reporterName, environment, rootSuite, report = {}, testops = {}, } = options;
+        const { frameworkPackage, reporterName, environment, rootSuite, report = {}, testops = {}, } = options;
         switch (mode) {
             case options_1.ModeEnum.testops: {
                 const { api: { token, headers, ...api } = {}, project, run: { title, description, ...run } = {}, plan = {}, batch = {}, useV2, defect, uploadAttachments, } = testops;
@@ -427,7 +395,6 @@ class QaseReporter {
                     token,
                     headers: {
                         ...headers,
-                        ...QaseReporter.createHeaders(frameworkPackage, frameworkName, reporterName),
                     },
                     ...api,
                 }, custom_boundary_1.CustomBoundaryFormData);
@@ -448,7 +415,7 @@ class QaseReporter {
             case options_1.ModeEnum.report: {
                 const localOptions = report.connections?.[writer_1.DriverEnum.local];
                 const writer = new writer_1.FsWriter(localOptions);
-                return new reporters_1.ReportReporter(this.logger, writer, environment, rootSuite, testops.run?.id);
+                return new reporters_1.ReportReporter(this.logger, writer, frameworkPackage, reporterName, environment, rootSuite, testops.run?.id);
             }
             case options_1.ModeEnum.off:
                 throw new disabled_exception_1.DisabledException();

package/dist/reporters/report-reporter.d.ts

@@ -7,6 +7,8 @@ import { LoggerInterface } from '../utils/logger';
  */
 export declare class ReportReporter extends AbstractReporter {
     private writer;
+    private frameworkName;
+    private reporterName;
     private readonly environment;
     private readonly runId;
     private readonly rootSuite;
@@ -14,11 +16,13 @@ export declare class ReportReporter extends AbstractReporter {
     /**
      * @param {LoggerInterface} logger
      * @param {WriterInterface} writer
+     * @param {string} frameworkName
+     * @param {string} reporterName
      * @param {string | undefined} environment
      * @param {string | undefined} rootSuite
      * @param {number | undefined} runId
      */
-    constructor(logger: LoggerInterface, writer: WriterInterface, environment?: string, rootSuite?: string, runId?: number);
+    constructor(logger: LoggerInterface, writer: WriterInterface, frameworkName: string, reporterName: string, environment?: string, rootSuite?: string, runId?: number);
     /**
      * @returns {Promise<void>}
      */
@@ -35,16 +39,4 @@ export declare class ReportReporter extends AbstractReporter {
      * @returns {TestStepType[]}
      */
     private copyStepAttachments;
-    /**
-     * @returns {HostData}
-     */
-    private getHostInfo;
-    /**
-     * @returns {string}
-     */
-    private getComputerName;
-    /**
-     * @returns {string}
-     */
-    private getDetailedOSInfo;
 }

package/dist/reporters/report-reporter.js

@@ -1,40 +1,17 @@
 "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 (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReportReporter = void 0;
 const abstract_reporter_1 = require("./abstract-reporter");
 const models_1 = require("../models");
-const os = __importStar(require("os"));
-const cp = __importStar(require("child_process"));
-const process = __importStar(require("process"));
+const hostData_1 = require("../utils/hostData");
 /**
  * @class ReportReporter
  * @extends AbstractReporter
  */
 class ReportReporter extends abstract_reporter_1.AbstractReporter {
     writer;
+    frameworkName;
+    reporterName;
     environment;
     runId;
     rootSuite;
@@ -42,13 +19,17 @@ class ReportReporter extends abstract_reporter_1.AbstractReporter {
     /**
      * @param {LoggerInterface} logger
      * @param {WriterInterface} writer
+     * @param {string} frameworkName
+     * @param {string} reporterName
      * @param {string | undefined} environment
      * @param {string | undefined} rootSuite
      * @param {number | undefined} runId
      */
-    constructor(logger, writer, environment, rootSuite, runId) {
+    constructor(logger, writer, frameworkName, reporterName, environment, rootSuite, runId) {
         super(logger);
         this.writer = writer;
+        this.frameworkName = frameworkName;
+        this.reporterName = reporterName;
         this.environment = environment;
         this.runId = runId;
         this.rootSuite = rootSuite;
@@ -120,7 +101,7 @@ class ReportReporter extends abstract_reporter_1.AbstractReporter {
             threads: [],
             suites: [],
             environment: this.environment ?? '',
-            host_data: this.getHostInfo(),
+            host_data: (0, hostData_1.getHostInfo)(this.frameworkName, this.reporterName),
         };
         for (const result of this.results) {
             report.stats.total++;
@@ -168,49 +149,5 @@ class ReportReporter extends abstract_reporter_1.AbstractReporter {
         }
         return steps;
     }
-    /**
-     * @returns {HostData}
-     */
-    getHostInfo() {
-        return {
-            system: process.platform,
-            node: this.getComputerName(),
-            release: os.release(),
-            version: this.getDetailedOSInfo(),
-            machine: os.arch(),
-            python: '',
-            pip: '',
-            node_version: cp.execSync('node --version').toString().trim(),
-            npm: cp.execSync('npm --version').toString().trim(),
-        };
-    }
-    /**
-     * @returns {string}
-     */
-    getComputerName() {
-        switch (process.platform) {
-            case 'win32':
-                return process.env['COMPUTERNAME'] ?? '';
-            case 'darwin':
-                return cp.execSync('scutil --get ComputerName').toString().trim();
-            case 'linux': {
-                const prettyname = cp.execSync('hostnamectl --pretty').toString().trim();
-                return prettyname === '' ? os.hostname() : prettyname;
-            }
-            default:
-                return os.hostname();
-        }
-    }
-    /**
-     * @returns {string}
-     */
-    getDetailedOSInfo() {
-        if (process.platform === 'darwin') {
-            return cp.execSync('uname -a').toString().trim();
-        }
-        else {
-            return `${os.type()} ${os.release()} ${os.arch()}`;
-        }
-    }
 }
 exports.ReportReporter = ReportReporter;

package/dist/utils/hostData.d.ts

@@ -0,0 +1,8 @@
+import { HostData } from '../models/host-data';
+/**
+ * Gets information about the current host environment
+ * @param {string} framework The framework name to check version for
+ * @param {string} reporterName The reporter name to check version for
+ * @returns {HostData} Host information object
+ */
+export declare function getHostInfo(framework: string, reporterName: string): HostData;

package/dist/utils/hostData.js

@@ -0,0 +1,182 @@
+"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 (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getHostInfo = void 0;
+const os = __importStar(require("os"));
+const cp = __importStar(require("child_process"));
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+/**
+ * Gets detailed OS information based on the platform
+ * @returns {string} Detailed OS information
+ */
+function getDetailedOSInfo() {
+    const platform = process.platform;
+    try {
+        if (platform === 'win32') {
+            // Windows
+            return cp.execSync('ver').toString().trim();
+        }
+        else if (platform === 'darwin') {
+            // macOS
+            return cp.execSync('sw_vers -productVersion').toString().trim();
+        }
+        else {
+            // Linux and others
+            try {
+                const osRelease = fs.readFileSync('/etc/os-release', 'utf8');
+                const prettyName = osRelease.match(/PRETTY_NAME="(.+)"/);
+                if (prettyName?.[1]) {
+                    return prettyName[1];
+                }
+            }
+            catch {
+                // Fallback if /etc/os-release doesn't exist or can't be read
+            }
+            return os.release();
+        }
+    }
+    catch (error) {
+        console.error('Error getting detailed OS info:', error);
+        return os.release();
+    }
+}
+/**
+ * Executes a command and returns its trimmed output
+ * @param {string} command Command to execute
+ * @param {string} defaultValue Default value if command fails
+ * @returns {string} Command output or default value
+ */
+function execCommand(command, defaultValue = '') {
+    try {
+        return cp.execSync(command).toString().trim();
+    }
+    catch (error) {
+        console.error(`Error executing command '${command}':`, error);
+        return defaultValue;
+    }
+}
+/**
+ * Recursively searches for a package in dependencies tree
+ * @param {Record<string, PackageInfo>} dependencies The dependencies object to search in
+ * @param {string} packageName The name of the package to find
+ * @returns {string | null} The package version or null if not found
+ */
+function findPackageInDependencies(dependencies, packageName) {
+    // If no dependencies, return null
+    if (!dependencies)
+        return null;
+    // Check if the package exists at the current level
+    if (packageName in dependencies) {
+        return dependencies[packageName]?.version ?? null;
+    }
+    // Recursively search in nested dependencies
+    for (const dep of Object.values(dependencies)) {
+        if (dep.dependencies) {
+            const foundVersion = findPackageInDependencies(dep.dependencies, packageName);
+            if (foundVersion) {
+                return foundVersion;
+            }
+        }
+    }
+    return null;
+}
+/**
+ * Gets the version of a Node.js package
+ * @param {string} packageName The name of the package
+ * @returns {string | null} The package version or null if not found
+ */
+function getPackageVersion(packageName) {
+    if (!packageName)
+        return null;
+    try {
+        // First try to get from node_modules
+        const packagePath = path.resolve(process.cwd(), 'node_modules', packageName, 'package.json');
+        if (fs.existsSync(packagePath)) {
+            const packageJson = JSON.parse(fs.readFileSync(packagePath, 'utf8'));
+            return packageJson.version;
+        }
+        // Try using npm list as fallback with recursive search
+        const output = execCommand(`npm list --depth=10 --json`);
+        if (!output)
+            return null;
+        try {
+            const npmList = JSON.parse(output);
+            // Try direct dependency
+            const directVersion = npmList.dependencies?.[packageName]?.version;
+            if (directVersion)
+                return directVersion;
+            // Try recursive search
+            return findPackageInDependencies(npmList.dependencies, packageName);
+        }
+        catch (parseError) {
+            console.error('Error parsing npm list output:', parseError);
+            return null;
+        }
+    }
+    catch (error) {
+        console.error(`Error getting version for package ${packageName}:`, error);
+        return null;
+    }
+}
+/**
+ * Gets information about the current host environment
+ * @param {string} framework The framework name to check version for
+ * @param {string} reporterName The reporter name to check version for
+ * @returns {HostData} Host information object
+ */
+function getHostInfo(framework, reporterName) {
+    try {
+        return {
+            system: process.platform,
+            machineName: os.hostname(),
+            release: os.release(),
+            version: getDetailedOSInfo(),
+            arch: os.arch(),
+            node: execCommand('node --version'),
+            npm: execCommand('npm --version'),
+            framework: getPackageVersion(framework) ?? '',
+            reporter: getPackageVersion(reporterName) ?? '',
+            commons: getPackageVersion('qase-javascript-commons') ?? '',
+            apiClient: getPackageVersion('qaseio') ?? '',
+        };
+    }
+    catch (error) {
+        return {
+            system: process.platform,
+            machineName: os.hostname() || '',
+            release: os.release(),
+            version: '',
+            arch: os.arch(),
+            node: '',
+            npm: '',
+            framework: '',
+            reporter: '',
+            commons: '',
+            apiClient: '',
+        };
+    }
+}
+exports.getHostInfo = getHostInfo;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "qase-javascript-commons",
-  "version": "2.2.16",
+  "version": "2.2.17",
   "description": "Qase JS Reporters",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",