qase-javascript-commons 2.5.3 → 2.5.5

package/changelog.md

@@ -1,3 +1,23 @@
+# qase-javascript-commons@2.5.5
+
+## What's new
+
+Significantly improved startup performance by optimizing host data collection:
+
+- Replaced slow `npm list --depth=10 --json` fallback with fast `require.resolve()`-based package version lookup.
+- Replaced `execSync('node --version')` with `process.version`.
+- Replaced `execSync('npm --version')` with `process.env.npm_config_user_agent` parsing (with execSync fallback).
+- Eliminated duplicate `getHostInfo()` call in `ReportReporter.complete()` by passing pre-collected host data from `QaseReporter`.
+- Included `report` mode in the `needsHostData` guard so host data is collected once during init.
+
+Worst-case startup time reduced from ~10-25 seconds to ~55 ms.
+
+# qase-javascript-commons@2.5.4
+
+## What's new
+
+- Fixed an issue where non-string parameter values (e.g. numbers) were sent to the Qase API as-is, causing validation errors. The `transformParams` method now converts all parameter values to strings.
+
 # qase-javascript-commons@2.5.3
 
 ## What's new

package/dist/client/clientV2.js

@@ -146,8 +146,8 @@ class ClientV2 extends clientV1_1.ClientV1 {
     transformParams(params) {
         const transformedParams = {};
         for (const [key, value] of Object.entries(params)) {
-            if (value) {
-                transformedParams[key] = value;
+            if (value != null) {
+                transformedParams[key] = String(value);
             }
         }
         return transformedParams;

package/dist/qase.js

@@ -97,13 +97,7 @@ class QaseReporter {
         this.logger.logDebug(`Config: ${JSON.stringify(this.sanitizeOptions(composedOptions))}`);
         const effectiveMode = composedOptions.mode || options_1.ModeEnum.off;
         const effectiveFallback = composedOptions.fallback || options_1.ModeEnum.off;
-        const needsHostData = effectiveMode === options_1.ModeEnum.testops ||
-            effectiveMode === options_1.ModeEnum.testops_multi ||
-            effectiveFallback === options_1.ModeEnum.testops ||
-            effectiveFallback === options_1.ModeEnum.testops_multi;
-        this.hostData = needsHostData
-            ? (0, hostData_1.getHostInfo)(options.frameworkPackage, options.reporterName)
-            : (0, hostData_1.getMinimalHostData)();
+        this.hostData = (0, hostData_1.getHostInfo)(options.frameworkPackage, options.reporterName);
         this.logger.logDebug(`Host data: ${JSON.stringify(this.hostData)}`);
         this.captureLogs = composedOptions.captureLogs;
         try {
@@ -474,7 +468,7 @@ class QaseReporter {
             case options_1.ModeEnum.report: {
                 const localOptions = options.report?.connections?.[writer_1.DriverEnum.local];
                 const writer = new writer_1.FsWriter(localOptions);
-                return new reporters_1.ReportReporter(this.logger, writer, options.frameworkPackage, options.reporterName, options.environment, options.rootSuite, options.testops?.run?.id);
+                return new reporters_1.ReportReporter(this.logger, writer, options.frameworkPackage, options.reporterName, options.environment, options.rootSuite, options.testops?.run?.id, this.hostData);
             }
             case options_1.ModeEnum.off:
                 throw new disabled_exception_1.DisabledException();

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

@@ -2,6 +2,7 @@ import { AbstractReporter } from './abstract-reporter';
 import { Attachment } from '../models';
 import { WriterInterface } from '../writer';
 import { LoggerInterface } from '../utils/logger';
+import { HostData } from '../models/host-data';
 /**
  * @class ReportReporter
  * @extends AbstractReporter
@@ -13,6 +14,7 @@ export declare class ReportReporter extends AbstractReporter {
     private readonly environment;
     private readonly runId;
     private readonly rootSuite;
+    private readonly hostData;
     private startTime;
     /**
      * @param {LoggerInterface} logger
@@ -22,8 +24,9 @@ export declare class ReportReporter extends AbstractReporter {
      * @param {string | undefined} environment
      * @param {string | undefined} rootSuite
      * @param {number | undefined} runId
+     * @param {HostData | undefined} hostData
      */
-    constructor(logger: LoggerInterface, writer: WriterInterface, frameworkName: string, reporterName: string, environment?: string, rootSuite?: string, runId?: number);
+    constructor(logger: LoggerInterface, writer: WriterInterface, frameworkName: string, reporterName: string, environment?: string, rootSuite?: string, runId?: number, hostData?: HostData);
     /**
      * @returns {Promise<void>}
      */

package/dist/reporters/report-reporter.js

@@ -15,6 +15,7 @@ class ReportReporter extends abstract_reporter_1.AbstractReporter {
     environment;
     runId;
     rootSuite;
+    hostData;
     startTime = Date.now();
     /**
      * @param {LoggerInterface} logger
@@ -24,8 +25,9 @@ class ReportReporter extends abstract_reporter_1.AbstractReporter {
      * @param {string | undefined} environment
      * @param {string | undefined} rootSuite
      * @param {number | undefined} runId
+     * @param {HostData | undefined} hostData
      */
-    constructor(logger, writer, frameworkName, reporterName, environment, rootSuite, runId) {
+    constructor(logger, writer, frameworkName, reporterName, environment, rootSuite, runId, hostData) {
         super(logger);
         this.writer = writer;
         this.frameworkName = frameworkName;
@@ -33,6 +35,7 @@ class ReportReporter extends abstract_reporter_1.AbstractReporter {
         this.environment = environment;
         this.runId = runId;
         this.rootSuite = rootSuite;
+        this.hostData = hostData;
     }
     /**
      * @returns {Promise<void>}
@@ -103,7 +106,7 @@ class ReportReporter extends abstract_reporter_1.AbstractReporter {
             threads: [],
             suites: [],
             environment: this.environment ?? '',
-            host_data: (0, hostData_1.getHostInfo)(this.frameworkName, this.reporterName),
+            host_data: this.hostData ?? (0, hostData_1.getHostInfo)(this.frameworkName, this.reporterName),
         };
         for (const result of this.results) {
             report.stats.total++;

package/dist/utils/hostData.d.ts

@@ -1,10 +1,4 @@
 import { HostData } from '../models/host-data';
-/**
- * Returns minimal host data without slow operations (no npm list, no execSync for node/npm).
- * Use when reporter mode is "off" to avoid startup delay.
- * @returns {HostData} Minimal host information object
- */
-export declare function getMinimalHostData(): HostData;
 /**
  * Gets information about the current host environment
  * @param {string} framework The framework name to check version for

package/dist/utils/hostData.js

@@ -33,13 +33,11 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getMinimalHostData = getMinimalHostData;
 exports.getHostInfo = getHostInfo;
 const os = __importStar(require("os"));
 const cp = __importStar(require("child_process"));
 const fs = __importStar(require("fs"));
-const path = __importStar(require("path"));
-const child_process_1 = require("child_process");
+const get_package_version_1 = require("./get-package-version");
 /**
  * Gets detailed OS information based on the platform
  * @returns {string} Detailed OS information
@@ -76,110 +74,24 @@ function getDetailedOSInfo() {
     }
 }
 /**
- * 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
+ * Gets npm version from environment or by executing npm command
+ * @returns {string} npm version string
  */
-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;
-            }
+function getNpmVersion() {
+    const userAgent = process.env['npm_config_user_agent'];
+    if (userAgent) {
+        const match = userAgent.match(/^npm\/(\S+)/);
+        if (match?.[1]) {
+            return match[1];
         }
     }
-    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
-        let output = null;
-        try {
-            output = (0, child_process_1.execSync)(`npm list --depth=10 --json`, { stdio: "pipe" }).toString();
-            if (!output)
-                return null;
-        }
-        catch (error) {
-            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;
-        }
+        return cp.execSync('npm --version', { stdio: 'pipe' }).toString().trim();
     }
-    catch (error) {
-        console.error(`Error getting version for package ${packageName}:`, error);
-        return null;
+    catch {
+        return '';
     }
 }
-/**
- * Returns minimal host data without slow operations (no npm list, no execSync for node/npm).
- * Use when reporter mode is "off" to avoid startup delay.
- * @returns {HostData} Minimal host information object
- */
-function getMinimalHostData() {
-    return {
-        system: os.platform(),
-        machineName: os.hostname(),
-        release: os.release(),
-        version: '',
-        arch: os.arch(),
-        node: '',
-        npm: '',
-        framework: '',
-        reporter: '',
-        commons: '',
-        apiClientV1: '',
-        apiClientV2: '',
-    };
-}
 /**
  * Gets information about the current host environment
  * @param {string} framework The framework name to check version for
@@ -194,13 +106,13 @@ function getHostInfo(framework, reporterName) {
             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') ?? '',
-            apiClientV1: getPackageVersion('qase-api-client') ?? '',
-            apiClientV2: getPackageVersion('qase-api-v2-client') ?? '',
+            node: process.version,
+            npm: getNpmVersion(),
+            framework: (0, get_package_version_1.getPackageVersion)(framework) ?? '',
+            reporter: (0, get_package_version_1.getPackageVersion)(reporterName) ?? '',
+            commons: (0, get_package_version_1.getPackageVersion)('qase-javascript-commons') ?? '',
+            apiClientV1: (0, get_package_version_1.getPackageVersion)('qase-api-client') ?? '',
+            apiClientV2: (0, get_package_version_1.getPackageVersion)('qase-api-v2-client') ?? '',
         };
     }
     catch (error) {

package/package.json

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