@allurereport/core 3.16.0 → 3.17.0

package/dist/utils/perf.js

@@ -1,7 +1,9 @@
+import { randomUUID } from "node:crypto";
 import { mkdir, writeFile } from "node:fs/promises";
 import { join } from "node:path";
 import { performance } from "node:perf_hooks";
-export const PERF_METRICS_FILE = "allure-perf-metrics.json";
+export const PERF_METRICS_FILE = "performance.json";
+export const perfMetricsFileName = (reportUuid) => `${reportUuid}-perf.json`;
 const MARK_PREFIX = "allure:perf:";
 const ENABLED_VALUES = new Set(["1", "true", "yes", "on"]);
 const SPANS = [];
@@ -10,6 +12,7 @@ const MEASURES = new Set();
 let sequence = 0;
 const round = (value) => Number(value.toFixed(3));
 export const PERF_METRIC_NAMES = {
+    allureTotal: "allure.total",
     restoreStateTotal: "restoreState.total",
     restoreStateDump: "restoreState.dump",
     restoreStateAttachments: "restoreState.attachments",
@@ -24,6 +27,22 @@ export const PERF_METRIC_PREFIXES = {
     generatePluginDone: "generate.plugin.done.",
     publishUploadPlugin: "publish.upload.plugin.",
 };
+const getCoveredDurationSummary = () => {
+    if (SPANS.length === 0) {
+        return undefined;
+    }
+    const startTimeMs = Math.min(...SPANS.map(({ startTimeMs }) => startTimeMs));
+    const endTimeMs = Math.max(...SPANS.map(({ startTimeMs, durationMs }) => startTimeMs + durationMs));
+    const durationMs = round(endTimeMs - startTimeMs);
+    return {
+        name: PERF_METRIC_NAMES.allureTotal,
+        count: 1,
+        totalMs: durationMs,
+        minMs: durationMs,
+        maxMs: durationMs,
+        avgMs: durationMs,
+    };
+};
 export const isPerfMetricsEnabled = () => ENABLED_VALUES.has((process.env.ALLURE_PERF_METRICS ?? "").toLowerCase());
 export const startPerfSpan = (name) => {
     if (!isPerfMetricsEnabled()) {
@@ -72,39 +91,33 @@ export const measurePerf = async (name, fn) => {
         end();
     }
 };
-export const getPerfMetricsPayload = () => {
-    const byName = new Map();
-    for (const span of SPANS) {
-        const current = byName.get(span.name) ?? [];
-        current.push(span);
-        byName.set(span.name, current);
+export const getPerfMetricsResults = () => {
+    const totalSummary = getCoveredDurationSummary();
+    const results = SPANS.map((span) => ({
+        id: randomUUID(),
+        key: span.name,
+        value: span.durationMs,
+        start: round(performance.timeOrigin + span.startTimeMs),
+        stop: round(performance.timeOrigin + span.startTimeMs + span.durationMs),
+    }));
+    if (totalSummary) {
+        results.unshift({
+            id: randomUUID(),
+            key: PERF_METRIC_NAMES.allureTotal,
+            value: totalSummary.avgMs,
+            start: round(performance.timeOrigin + Math.min(...SPANS.map(({ startTimeMs }) => startTimeMs))),
+            stop: round(performance.timeOrigin + Math.max(...SPANS.map(({ startTimeMs, durationMs }) => startTimeMs + durationMs))),
+        });
     }
-    return {
-        version: 1,
-        generatedAt: new Date().toISOString(),
-        timeOriginMs: round(performance.timeOrigin),
-        spans: [...SPANS],
-        summary: [...byName.entries()].map(([name, group]) => {
-            const durations = group.map(({ durationMs }) => durationMs);
-            const totalMs = durations.reduce((acc, duration) => acc + duration, 0);
-            return {
-                name,
-                count: group.length,
-                totalMs: round(totalMs),
-                minMs: round(Math.min(...durations)),
-                maxMs: round(Math.max(...durations)),
-                avgMs: round(totalMs / group.length),
-            };
-        }),
-    };
+    return results;
 };
-export const writePerfMetrics = async (output) => {
+export const writePerfMetrics = async (output, fileName = PERF_METRICS_FILE) => {
     if (!isPerfMetricsEnabled()) {
         return false;
     }
-    const payload = getPerfMetricsPayload();
+    const results = getPerfMetricsResults();
     await mkdir(output, { recursive: true });
-    await writeFile(join(output, PERF_METRICS_FILE), `${JSON.stringify(payload, null, 2)}\n`, "utf8");
+    await writeFile(join(output, fileName), `${JSON.stringify(results, null, 2)}\n`, "utf8");
     resetPerfMetrics();
     return true;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allurereport/core",
-  "version": "3.16.0",
+  "version": "3.17.0",
   "description": "Collection of generic Allure utilities used across the entire project",
   "keywords": [
     "allure"
@@ -25,26 +25,26 @@
     "lint:fix": "oxlint --import-plugin --fix src test features stories"
   },
   "dependencies": {
-    "@allurereport/ci": "3.16.0",
-    "@allurereport/cli-commons": "3.16.0",
-    "@allurereport/core-api": "3.16.0",
-    "@allurereport/plugin-agent": "3.16.0",
-    "@allurereport/plugin-allure2": "3.16.0",
-    "@allurereport/plugin-api": "3.16.0",
-    "@allurereport/plugin-awesome": "3.16.0",
-    "@allurereport/plugin-classic": "3.16.0",
-    "@allurereport/plugin-csv": "3.16.0",
-    "@allurereport/plugin-dashboard": "3.16.0",
-    "@allurereport/plugin-jira": "3.16.0",
-    "@allurereport/plugin-log": "3.16.0",
-    "@allurereport/plugin-progress": "3.16.0",
-    "@allurereport/plugin-slack": "3.16.0",
-    "@allurereport/plugin-testops": "3.16.0",
-    "@allurereport/plugin-testplan": "3.16.0",
-    "@allurereport/reader": "3.16.0",
-    "@allurereport/reader-api": "3.16.0",
-    "@allurereport/service": "3.16.0",
-    "@allurereport/summary": "3.16.0",
+    "@allurereport/ci": "3.17.0",
+    "@allurereport/cli-commons": "3.17.0",
+    "@allurereport/core-api": "3.17.0",
+    "@allurereport/plugin-agent": "3.17.0",
+    "@allurereport/plugin-allure2": "3.17.0",
+    "@allurereport/plugin-api": "3.17.0",
+    "@allurereport/plugin-awesome": "3.17.0",
+    "@allurereport/plugin-classic": "3.17.0",
+    "@allurereport/plugin-csv": "3.17.0",
+    "@allurereport/plugin-dashboard": "3.17.0",
+    "@allurereport/plugin-jira": "3.17.0",
+    "@allurereport/plugin-log": "3.17.0",
+    "@allurereport/plugin-progress": "3.17.0",
+    "@allurereport/plugin-slack": "3.17.0",
+    "@allurereport/plugin-testops": "3.17.0",
+    "@allurereport/plugin-testplan": "3.17.0",
+    "@allurereport/reader": "3.17.0",
+    "@allurereport/reader-api": "3.17.0",
+    "@allurereport/service": "3.17.0",
+    "@allurereport/summary": "3.17.0",
     "glob": "^13.0.6",
     "handlebars": "^4.7.9",
     "jiti": "^2.5.1",

package/dist/known.d.ts

@@ -1,8 +0,0 @@
-import type { KnownIssuesConfig, KnownTestFailure, TestResult } from "@allurereport/core-api";
-import type { AllureStore } from "@allurereport/plugin-api";
-export declare const DEFAULT_KNOWN_ISSUES_PATH = "known-issues.json";
-export declare const hasKnownIssueRules: (knownIssues?: KnownIssuesConfig) => boolean;
-export declare const getKnownIssueByRules: (testResult: TestResult, knownIssues: KnownIssuesConfig | undefined, environmentId?: string) => KnownTestFailure | undefined;
-export declare const resolveExactIssuesFilePath: (pathOrDir: string | undefined, label: string) => Promise<string | undefined>;
-export declare const readKnownIssues: (knownIssuePath: string) => Promise<KnownTestFailure[]>;
-export declare const writeKnownIssues: (store: AllureStore, knownIssuesPath?: string) => Promise<void>;

package/dist/known.js

@@ -1,86 +0,0 @@
-import { mkdir, readFile, stat, writeFile } from "node:fs/promises";
-import { dirname, extname, resolve } from "node:path";
-import { isFileNotFoundError } from "./utils/misc.js";
-export const DEFAULT_KNOWN_ISSUES_PATH = "known-issues.json";
-export const hasKnownIssueRules = (knownIssues) => (knownIssues?.rules?.length ?? 0) > 0;
-const messageMatches = (rule, testResult) => {
-    if (!rule.messageRegexp) {
-        return true;
-    }
-    const message = testResult.error?.message;
-    return typeof message === "string" && new RegExp(rule.messageRegexp).test(message);
-};
-const testCaseIdMatches = (rule, testResult) => {
-    const { id, allureId, externalId } = testResult.testCase ?? {};
-    return !rule.testCaseId || [id, allureId, externalId].includes(rule.testCaseId);
-};
-const retryHashMatches = (rule, testResult) => {
-    return !rule.retryHash || rule.retryHash === testResult.retryHash;
-};
-const environmentMatches = (rule, testResult) => {
-    return !rule.environmentId || rule.environmentId === testResult.environment;
-};
-export const getKnownIssueByRules = (testResult, knownIssues, environmentId) => {
-    if (!testResult.historyId || !hasKnownIssueRules(knownIssues)) {
-        return undefined;
-    }
-    const matchedRule = knownIssues.rules.find((rule) => [messageMatches, testCaseIdMatches, environmentMatches, retryHashMatches].every((matcher) => matcher(rule, testResult)));
-    if (!matchedRule) {
-        return undefined;
-    }
-    return {
-        historyId: testResult.historyId,
-        reason: matchedRule.decision.reason,
-        links: matchedRule.decision.links,
-        error: testResult.error,
-    };
-};
-export const resolveExactIssuesFilePath = async (pathOrDir, label) => {
-    if (!pathOrDir) {
-        return undefined;
-    }
-    const path = resolve(pathOrDir);
-    if (extname(path).toLowerCase() !== ".json") {
-        throw new Error(`Invalid ${label} path ${JSON.stringify(pathOrDir)}: expected exact .json file path`);
-    }
-    try {
-        const pathStats = await stat(path);
-        if (pathStats.isDirectory()) {
-            throw new Error(`Invalid ${label} path ${JSON.stringify(pathOrDir)}: expected file, got directory`);
-        }
-    }
-    catch (e) {
-        if (!isFileNotFoundError(e)) {
-            throw e;
-        }
-    }
-    return path;
-};
-export const readKnownIssues = async (knownIssuePath) => {
-    const path = await resolveExactIssuesFilePath(knownIssuePath, "known issues");
-    if (!path) {
-        return [];
-    }
-    try {
-        const content = await readFile(path, { encoding: "utf-8" });
-        return JSON.parse(content);
-    }
-    catch (e) {
-        if (isFileNotFoundError(e)) {
-            return [];
-        }
-        throw e;
-    }
-};
-const writeKnownIssueRecords = async (knownIssues, knownIssuesPath) => {
-    const path = await resolveExactIssuesFilePath(knownIssuesPath, "known issues");
-    if (!path) {
-        return;
-    }
-    await mkdir(dirname(path), { recursive: true });
-    await writeFile(path, `${JSON.stringify(knownIssues)}\n`, "utf-8");
-};
-export const writeKnownIssues = async (store, knownIssuesPath) => {
-    const knownIssues = await store.allKnownIssues();
-    await writeKnownIssueRecords(knownIssues, knownIssuesPath);
-};