qase-javascript-commons 2.6.6 → 2.7.1

package/changelog.md

@@ -1,3 +1,18 @@
+## 2.7.1
+
+### Fixed
+- HTTP/fetch profiler steps now emit `execution.start_time` and `execution.end_time` as Unix epoch seconds (with fractional ms), matching the Qase API contract. Previously the interceptor wrote `Date.now()` milliseconds directly into both fields, placing every captured request step ~55 years in the future on the timeline. `execution.duration` remains in milliseconds.
+- `ReportReporter` test-run summary (`report.execution.start_time` / `end_time` in the generated JSON report) is now emitted in Unix seconds instead of milliseconds; this aligns the report-mode file with the v2 API spec consumed by `reporters-validator`.
+- `QaseStep.run` (the shared user-facing `qase.step()` API used by Jest, Vitest, WebdriverIO and TestCafe) now emits `execution.start_time` / `end_time` in Unix seconds instead of raw `Date.now()` milliseconds, and populates `execution.duration` (ms). Previously every `qase.step()` call landed ~55 years in the future on the timeline and reported `null` duration.
+
+## 2.7.0
+
+### Added
+- New internal subpath `qase-javascript-commons/internal` exposing helpers for use by Qase reporters in this monorepo: `removeQaseIdsFromTitle`, `extractAndCleanStep`, `getFile`, `parseQaseIdsFromString`, `normalizeSuitePart`. The `/internal` subpath is intended for Qase-owned reporter packages and may change without a major version bump.
+
+### Changed
+- `removeQaseIdsFromTitle` regex unified across reporters to `/\(Qase ID:? ([\d,]+)\)$/i`. This is more permissive than the previous mocha/wdio variants (case-insensitive; also accepts `(Qase ID 1)` without colon) and adds a trailing-position anchor (`$`).
+
 # qase-javascript-commons@2.6.6
 
 ## Bug fixes

package/dist/internal/ids-parser.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Parses a comma-separated string of Qase IDs into an array of numbers.
+ * Whitespace around each entry is trimmed; non-numeric entries are skipped.
+ *
+ * Examples: "1,2,3" → [1, 2, 3], "42" → [42], "" → [].
+ */
+export declare function parseQaseIdsFromString(value: string): number[];

package/dist/internal/ids-parser.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseQaseIdsFromString = parseQaseIdsFromString;
+/**
+ * Parses a comma-separated string of Qase IDs into an array of numbers.
+ * Whitespace around each entry is trimmed; non-numeric entries are skipped.
+ *
+ * Examples: "1,2,3" → [1, 2, 3], "42" → [42], "" → [].
+ */
+function parseQaseIdsFromString(value) {
+    if (!value?.trim()) {
+        return [];
+    }
+    return value
+        .split(',')
+        .map((part) => parseInt(part.trim(), 10))
+        .filter((n) => !Number.isNaN(n));
+}

package/dist/internal/index.d.ts

@@ -0,0 +1,7 @@
+export { removeQaseIdsFromTitle } from './title';
+export { extractAndCleanStep } from './step-parser';
+export type { ExtractedStep } from './step-parser';
+export { getFile } from './suite-file';
+export type { FileSuiteNode } from './suite-file';
+export { parseQaseIdsFromString } from './ids-parser';
+export { normalizeSuitePart } from './suite-normalizer';

package/dist/internal/index.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeSuitePart = exports.parseQaseIdsFromString = exports.getFile = exports.extractAndCleanStep = exports.removeQaseIdsFromTitle = void 0;
+var title_1 = require("./title");
+Object.defineProperty(exports, "removeQaseIdsFromTitle", { enumerable: true, get: function () { return title_1.removeQaseIdsFromTitle; } });
+var step_parser_1 = require("./step-parser");
+Object.defineProperty(exports, "extractAndCleanStep", { enumerable: true, get: function () { return step_parser_1.extractAndCleanStep; } });
+var suite_file_1 = require("./suite-file");
+Object.defineProperty(exports, "getFile", { enumerable: true, get: function () { return suite_file_1.getFile; } });
+var ids_parser_1 = require("./ids-parser");
+Object.defineProperty(exports, "parseQaseIdsFromString", { enumerable: true, get: function () { return ids_parser_1.parseQaseIdsFromString; } });
+var suite_normalizer_1 = require("./suite-normalizer");
+Object.defineProperty(exports, "normalizeSuitePart", { enumerable: true, get: function () { return suite_normalizer_1.normalizeSuitePart; } });

package/dist/internal/step-parser.d.ts

@@ -0,0 +1,11 @@
+export interface ExtractedStep {
+    expectedResult: string | null;
+    data: string | null;
+    cleanedString: string;
+}
+/**
+ * Parses a step string for inline `QaseExpRes:` (expected result) and `QaseData:`
+ * (data) markers. Returns the extracted parts and the input string with markers
+ * removed. If no markers are present, returns nulls and the original string.
+ */
+export declare function extractAndCleanStep(input: string): ExtractedStep;

package/dist/internal/step-parser.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractAndCleanStep = extractAndCleanStep;
+/**
+ * Parses a step string for inline `QaseExpRes:` (expected result) and `QaseData:`
+ * (data) markers. Returns the extracted parts and the input string with markers
+ * removed. If no markers are present, returns nulls and the original string.
+ */
+function extractAndCleanStep(input) {
+    let expectedResult = null;
+    let data = null;
+    let cleanedString = input;
+    const hasExpectedResult = input.includes('QaseExpRes:');
+    const hasData = input.includes('QaseData:');
+    if (hasExpectedResult || hasData) {
+        const regex = /QaseExpRes:\s*:?\s*(.*?)\s*(?=QaseData:|$)QaseData:\s*:?\s*(.*)?/;
+        const match = input.match(regex);
+        if (match) {
+            expectedResult = match[1]?.trim() ?? null;
+            data = match[2]?.trim() ?? null;
+            cleanedString = input
+                .replace(/QaseExpRes:\s*:?\s*.*?(?=QaseData:|$)/, '')
+                .replace(/QaseData:\s*:?\s*.*/, '')
+                .trim();
+        }
+    }
+    return { expectedResult, data, cleanedString };
+}

package/dist/internal/suite-file.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Minimal structural shape compatible with both Mocha's `Suite` (used by
+ * qase-mocha) and Cypress's runner Suite (used by qase-cypress).
+ */
+export interface FileSuiteNode {
+    file?: string;
+    parent?: FileSuiteNode;
+}
+/**
+ * Walks up `node.parent` until a node with a non-empty `file` property is
+ * reached. Returns the file path, or undefined if no ancestor has one.
+ */
+export declare function getFile(node: FileSuiteNode): string | undefined;

package/dist/internal/suite-file.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getFile = getFile;
+/**
+ * Walks up `node.parent` until a node with a non-empty `file` property is
+ * reached. Returns the file path, or undefined if no ancestor has one.
+ */
+function getFile(node) {
+    if (node.file) {
+        return node.file;
+    }
+    if (node.parent) {
+        return getFile(node.parent);
+    }
+    return undefined;
+}

package/dist/internal/suite-normalizer.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Lowercases the input and replaces every whitespace character with an
+ * underscore. Used by reporters to normalize suite/title segments before
+ * passing them into `generateSignature`.
+ */
+export declare function normalizeSuitePart(value: string): string;

package/dist/internal/suite-normalizer.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeSuitePart = normalizeSuitePart;
+/**
+ * Lowercases the input and replaces every whitespace character with an
+ * underscore. Used by reporters to normalize suite/title segments before
+ * passing them into `generateSignature`.
+ */
+function normalizeSuitePart(value) {
+    return value.toLowerCase().replace(/\s/g, '_');
+}

package/dist/internal/title.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Strips a trailing `(Qase ID: 1,2,3)` (or `(Qase ID 1)` without colon) from a test title.
+ * Returns the original title untouched if no match is found.
+ */
+export declare function removeQaseIdsFromTitle(title: string): string;

package/dist/internal/title.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.removeQaseIdsFromTitle = removeQaseIdsFromTitle;
+const QASE_ID_TRAILER_REGEXP = /\(Qase ID:? ([\d,]+)\)$/i;
+/**
+ * Strips a trailing `(Qase ID: 1,2,3)` (or `(Qase ID 1)` without colon) from a test title.
+ * Returns the original title untouched if no match is found.
+ */
+function removeQaseIdsFromTitle(title) {
+    const match = title.match(QASE_ID_TRAILER_REGEXP);
+    if (match) {
+        return title.replace(match[0], '').trimEnd();
+    }
+    return title;
+}

package/dist/profilers/http-interceptor.d.ts

@@ -28,6 +28,13 @@ export declare function extractRequestInfo(args: [
  * to `Record<string, string>`. Multi-value headers joined with `', '`. Undefined values skipped.
  */
 export declare function headersToRecord(headers: http.IncomingHttpHeaders): Record<string, string>;
+/**
+ * Builds a REQUEST-type step from raw timing data.
+ *
+ * `startTime` / `endTime` are expected as `Date.now()` values (ms since epoch).
+ * They are normalized to Unix seconds (with fractional ms) for `step.execution.start_time` /
+ * `end_time` per Qase API spec; `duration` stays in ms.
+ */
 export declare function buildRequestStep(params: {
     method: string;
     url: string;

package/dist/profilers/http-interceptor.js

@@ -68,6 +68,13 @@ function headersToRecord(headers) {
     return result;
 }
 // ─── Utility: buildRequestStep ───────────────────────────────────────────────
+/**
+ * Builds a REQUEST-type step from raw timing data.
+ *
+ * `startTime` / `endTime` are expected as `Date.now()` values (ms since epoch).
+ * They are normalized to Unix seconds (with fractional ms) for `step.execution.start_time` /
+ * `end_time` per Qase API spec; `duration` stays in ms.
+ */
 function buildRequestStep(params) {
     const step = new test_step_1.TestStepType(test_step_1.StepType.REQUEST);
     step.id = (0, uuid_1.v4)();
@@ -79,8 +86,8 @@ function buildRequestStep(params) {
     data.status_code = params.statusCode;
     data.response_body = params.responseBody;
     data.response_headers = params.responseHeaders;
-    step.execution.start_time = params.startTime;
-    step.execution.end_time = params.endTime;
+    step.execution.start_time = params.startTime / 1000;
+    step.execution.end_time = params.endTime / 1000;
     step.execution.duration = params.endTime - params.startTime;
     step.execution.status = params.statusCode >= 400 ? step_execution_1.StepStatusEnum.failed : step_execution_1.StepStatusEnum.passed;
     return step;

package/dist/reporters/report-reporter.js

@@ -89,12 +89,13 @@ class ReportReporter extends abstract_reporter_1.AbstractReporter {
         }
     }
     async complete() {
+        const endTime = Date.now();
         const report = {
             title: 'Test run',
             execution: {
-                start_time: this.startTime,
-                end_time: Date.now(),
-                duration: Date.now() - this.startTime,
+                start_time: this.startTime / 1000,
+                end_time: endTime / 1000,
+                duration: endTime - this.startTime,
                 cumulative_duration: 0,
             },
             stats: {

package/dist/steps/step.js

@@ -52,32 +52,30 @@ class QaseStep {
         });
     }
     async run(body, messageEmitter) {
-        const startDate = new Date().getTime();
+        const startMs = Date.now();
         const step = new models_1.TestStepType();
         step.data = {
             action: this.name,
             expected_result: null,
             data: null,
         };
+        // Per Qase API spec: start_time / end_time are Unix epoch seconds (with
+        // fractional ms); duration is milliseconds.
+        const buildExecution = (status, endMs) => ({
+            start_time: startMs / 1000,
+            end_time: endMs / 1000,
+            status,
+            duration: endMs - startMs,
+        });
         try {
             await body.call(this, this);
-            step.execution = {
-                start_time: startDate,
-                end_time: new Date().getTime(),
-                status: models_1.StepStatusEnum.passed,
-                duration: null,
-            };
+            step.execution = buildExecution(models_1.StepStatusEnum.passed, Date.now());
             step.attachments = this.attachments;
             step.steps = this.steps;
             await messageEmitter(step);
         }
         catch (error) {
-            step.execution = {
-                start_time: startDate,
-                end_time: new Date().getTime(),
-                status: models_1.StepStatusEnum.failed,
-                duration: null,
-            };
+            step.execution = buildExecution(models_1.StepStatusEnum.failed, Date.now());
             step.attachments = this.attachments;
             step.steps = this.steps;
             await messageEmitter(step);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "qase-javascript-commons",
-  "version": "2.6.6",
+  "version": "2.7.1",
   "description": "Qase JS Reporters",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
@@ -13,11 +13,16 @@
       "types": "./dist/profilers/index.d.ts",
       "default": "./dist/profilers/index.js"
     },
+    "./internal": {
+      "types": "./dist/internal/index.d.ts",
+      "default": "./dist/internal/index.js"
+    },
     "./package.json": "./package.json"
   },
   "typesVersions": {
     "*": {
-      "profilers": ["./dist/profilers/index.d.ts"]
+      "profilers": ["./dist/profilers/index.d.ts"],
+      "internal": ["./dist/internal/index.d.ts"]
     }
   },
   "homepage": "https://github.com/qase-tms/qase-javascript",
@@ -63,7 +68,7 @@
     "@types/mime-types": "^2.1.4",
     "@types/minimatch": "^6.0.0",
     "@types/uuid": "^9.0.8",
-    "axios": "^1.15.0",
+    "axios": "^1.15.2",
     "jest": "^29.7.0",
     "ts-jest": "^29.4.5"
   }