@allurereport/plugin-awesome 3.16.1 → 3.17.0

package/dist/converters.js

@@ -24,6 +24,8 @@ export const convertTestResult = (tr, options = {}) => {
         historyId: tr.historyId,
         flaky: tr.flaky,
         muted: tr.muted,
+        resolution: tr.resolution,
+        resolutionComment: tr.resolutionComment,
         isRetry: tr.isRetry,
         labels,
         groupedLabels: mapLabelsByName(labels),

package/dist/generators.d.ts

@@ -1,4 +1,4 @@
-import { type AttachmentLink, type EnvironmentIdentity, type EnvironmentItem, type Statistic, type TestEnvGroup, type TestResult } from "@allurereport/core-api";
+import { type AttachmentLink, type EnvironmentIdentity, type EnvironmentItem, type MetricSample, type Statistic, type TestEnvGroup, type TestResult } from "@allurereport/core-api";
 import type { AllureStore, ReportExecutorInfo, ReportRunSummary, ReportTestResult, GlobalAttachmentLink, ExitCode, PluginContext, PluginGlobalError, QualityGateValidationResult, ReportFiles, ResultFile } from "@allurereport/plugin-api";
 import type { AwesomeOptions, TemplateManifest } from "./model.js";
 import type { AwesomeDataWriter, ReportFile } from "./writer.js";
@@ -14,12 +14,15 @@ export declare const getRunSummary: (testResults: Pick<TestResult, "start" | "st
 export declare const generateTree: (writer: AwesomeDataWriter, treeFilename: string, labels: string[], tests: ReportTestResult[], options?: {
     appendTitlePath?: boolean;
 }) => Promise<void>;
+export declare const generateResolutionCategories: (writer: AwesomeDataWriter, tests: ReportTestResult[], filename?: string) => Promise<void>;
 export declare const generateEnvironmentJson: (writer: AwesomeDataWriter, env: EnvironmentItem[]) => Promise<void>;
 export declare const generateEnvirontmentsList: (writer: AwesomeDataWriter, store: AllureStore) => Promise<void>;
 export declare const generateVariables: (writer: AwesomeDataWriter, store: AllureStore) => Promise<void>;
 export declare const generateStatistic: (writer: AwesomeDataWriter, data: {
     stats: Statistic;
     statsByEnv: Map<string, Statistic>;
+    pieStats?: Statistic;
+    pieStatsByEnv?: Map<string, Statistic>;
     envs: EnvironmentIdentity[];
 }) => Promise<void>;
 export declare const generateAttachmentsFiles: (writer: AwesomeDataWriter, attachmentLinks: AttachmentLink[], contentFunction: (id: string) => Promise<ResultFile | undefined>) => Promise<Map<string, string>>;
@@ -48,4 +51,15 @@ export declare const generateStaticFiles: (payload: AwesomeOptions & {
     runSummary?: ReportRunSummary;
 }) => Promise<void>;
 export declare const generateAllCharts: (writer: AwesomeDataWriter, store: AllureStore, options: AwesomeOptions, context: PluginContext) => Promise<void>;
+export type AwesomeMetricsWidget = {
+    current: MetricSample[];
+    history: {
+        uuid: string;
+        name: string;
+        timestamp: number;
+        url?: string;
+        metrics: Record<string, number>;
+    }[];
+};
+export declare const generateMetricsWidget: (writer: AwesomeDataWriter, store: AllureStore, reportUuid: string) => Promise<boolean>;
 export declare const generateTreeFilters: (writer: AwesomeDataWriter, testResults: ReportTestResult[]) => Promise<void>;

package/dist/generators.js

@@ -89,6 +89,7 @@ export const generateTestResults = async (_writer, store, trs, options = {}) =>
         const convertedTr = convertTestResult(tr, {
             hideLabels: options.hideLabels,
         });
+        const resolutionIssue = await store.resolutionIssueByTestResultId(tr.id);
         convertedTr.history = related.historyByTrId.get(tr.id) ?? [];
         convertedTr.retries = related.retriesByTrId.get(tr.id) ?? [];
         convertedTr.retriesCount = convertedTr.retries.length;
@@ -101,6 +102,7 @@ export const generateTestResults = async (_writer, store, trs, options = {}) =>
             type: "attachment",
         }));
         convertedTr.breadcrumbs = createBreadcrumbs(convertedTr);
+        convertedTr.resolutionIssue = resolutionIssue;
         convertedTrs.push(convertedTr);
     }
     convertedTrs = convertedTrs.sort(nullsLast(compareBy("start", ordinal()))).map((tr, idx) => ({
@@ -265,7 +267,7 @@ const buildTreeByTitlePath = (tests) => {
     };
 };
 const buildTreeByLabelsAndTitlePathCombined = (tests, labels) => collapseTreeGroups(createTreeByLabelsAndTitlePath(tests, labels, leafFactory, undefined, (group, leaf) => incrementStatistic(group.statistic, leaf.status)));
-const leafFactory = ({ id, name, status, duration, flaky, start, retry, retriesCount, transition, tooltips, historyId, groupedLabels, categories, }) => {
+const leafFactory = ({ id, name, status, duration, flaky, start, retry, retriesCount, resolution, transition, tooltips, historyId, groupedLabels, categories, }) => {
     const leaf = {
         nodeId: id,
         id: historyId ?? id,
@@ -276,6 +278,7 @@ const leafFactory = ({ id, name, status, duration, flaky, start, retry, retriesC
         start,
         retry,
         retriesCount,
+        resolution,
         transition,
         tooltips,
     };
@@ -287,6 +290,53 @@ const leafFactory = ({ id, name, status, duration, flaky, start, retry, retriesC
     }
     return leaf;
 };
+const resolutionOrder = ["issue", "muted", "accepted"];
+const getResolutionGroupName = (test) => {
+    if (test.resolution === "issue") {
+        return test.resolutionIssue?.id ?? test.resolution;
+    }
+    return test.resolutionComment ?? test.resolution ?? "";
+};
+const resolutionTestResultFactory = (test, index) => ({
+    nodeId: test.id,
+    id: test.historyId ?? test.id,
+    name: test.name,
+    status: test.status,
+    duration: test.duration,
+    flaky: test.flaky,
+    transition: test.transition,
+    retry: test.retry,
+    retriesCount: test.retriesCount,
+    resolution: test.resolution,
+    groupOrder: index + 1,
+    tooltips: test.tooltips,
+});
+export const generateResolutionCategories = async (writer, tests, filename = "resolution-categories.json") => {
+    const groupsById = new Map();
+    tests
+        .filter((test) => !test.isRetry && test.resolution)
+        .forEach((test) => {
+        const resolution = test.resolution;
+        const groupId = resolution === "issue"
+            ? `${resolution}:${test.resolutionIssue?.id ?? test.id}`
+            : `${resolution}:${test.resolutionComment ?? test.id}`;
+        const group = groupsById.get(groupId) ?? {
+            id: groupId,
+            resolution,
+            name: getResolutionGroupName(test),
+            comment: test.resolutionComment ?? test.resolutionIssue?.comment,
+            issue: test.resolutionIssue,
+            testResults: [],
+        };
+        group.testResults.push(resolutionTestResultFactory(test, group.testResults.length));
+        groupsById.set(groupId, group);
+    });
+    const groups = [...groupsById.values()].sort((a, b) => {
+        const resolutionDiff = resolutionOrder.indexOf(a.resolution) - resolutionOrder.indexOf(b.resolution);
+        return resolutionDiff || a.name.localeCompare(b.name);
+    });
+    await writer.writeWidget(filename, { groups });
+};
 export const generateEnvironmentJson = async (writer, env) => {
     await writer.writeWidget("allure_environment.json", env);
 };
@@ -304,16 +354,16 @@ export const generateVariables = async (writer, store) => {
     }
 };
 export const generateStatistic = async (writer, data) => {
-    const { stats, statsByEnv, envs } = data;
+    const { stats, statsByEnv, pieStats = stats, pieStatsByEnv, envs } = data;
     await writer.writeWidget("statistic.json", stats);
-    await writer.writeWidget("pie_chart.json", getPieChartValues(stats));
+    await writer.writeWidget("pie_chart.json", getPieChartValues(pieStats));
     for (const env of envs) {
         const envStats = statsByEnv.get(env.id);
         if (!envStats) {
             continue;
         }
         await writer.writeWidget(joinPosixPath(env.id, "statistic.json"), envStats);
-        await writer.writeWidget(joinPosixPath(env.id, "pie_chart.json"), envStats);
+        await writer.writeWidget(joinPosixPath(env.id, "pie_chart.json"), getPieChartValues(pieStatsByEnv?.get(env.id) ?? envStats));
     }
 };
 export const generateAttachmentsFiles = async (writer, attachmentLinks, contentFunction) => {
@@ -402,7 +452,7 @@ export const generateStaticFiles = async (payload) => {
     const { manifest } = staticAssets;
     const headTags = [];
     const bodyTags = [];
-    const sections = ["charts", "timeline"];
+    const sections = payload.sections?.length ? payload.sections : ["charts", "timeline"];
     if (!payload.singleFile) {
         for (const key in manifest) {
             const fileName = manifest[key];
@@ -478,6 +528,26 @@ export const generateAllCharts = async (writer, store, options, context) => {
         await writer.writeWidget("charts.json", generatedChartsData);
     }
 };
+export const generateMetricsWidget = async (writer, store, reportUuid) => {
+    const current = await store.allMetrics();
+    if (current.length === 0) {
+        return false;
+    }
+    const history = (await store.allHistoryDataPoints())
+        .filter(({ uuid, metrics = {} }) => uuid !== reportUuid && Object.keys(metrics).length > 0)
+        .map(({ uuid, name, timestamp, url, metrics = {} }) => ({
+        uuid,
+        name,
+        timestamp,
+        ...(url ? { url } : {}),
+        metrics,
+    }));
+    await writer.writeWidget("metrics.json", {
+        current,
+        history,
+    });
+    return true;
+};
 export const generateTreeFilters = async (writer, testResults) => {
     const trTags = new Set();
     const trCategories = new Set();

package/dist/plugin.js

@@ -9,17 +9,31 @@ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
     return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
 };
-var _AwesomePlugin_writer, _AwesomePlugin_generate;
-import { incrementStatistic, joinPosixPath } from "@allurereport/core-api";
+var _AwesomePlugin_writer, _AwesomePlugin_generateAfterStart, _AwesomePlugin_generate;
+import { incrementStatistic, joinPosixPath, } from "@allurereport/core-api";
 import { createPluginSummary, } from "@allurereport/plugin-api";
 import { preciseTreeLabels } from "@allurereport/plugin-api";
 import { applyCategoriesToTestResults, generateCategories } from "./categories.js";
 import { generateTimeline } from "./generateTimeline.js";
-import { generateAllCharts, generateAttachmentsFiles, generateEnvironmentJson, generateEnvirontmentsList, generateGlobals, generateHistoryDataPoints, generateNav, generateQualityGateResults, generateSearchIndex, generateStaticFiles, generateStatistic, generateTestCases, generateTestEnvGroups, generateTestResults, generateTree, generateTreeFilters, generateVariables, getRunSummary, } from "./generators.js";
+import { generateAllCharts, generateAttachmentsFiles, generateEnvironmentJson, generateEnvirontmentsList, generateGlobals, generateHistoryDataPoints, generateMetricsWidget, generateNav, generateQualityGateResults, generateResolutionCategories, generateSearchIndex, generateStaticFiles, generateStatistic, generateTestCases, generateTestEnvGroups, generateTestResults, generateTree, generateTreeFilters, generateVariables, getRunSummary, } from "./generators.js";
 import { InMemoryReportDataWriter, ReportFileDataWriter } from "./writer.js";
 const statisticByTestResults = async (store, testResults) => {
     const statistic = { total: 0 };
     const related = await store.relatedByTestResultIds(testResults.map(({ id }) => id));
+    const incrementResolution = (testResult) => {
+        if (testResult.resolution === "issue") {
+            statistic.resolutions ?? (statistic.resolutions = {});
+            statistic.resolutions.issues = (statistic.resolutions.issues ?? 0) + 1;
+        }
+        if (testResult.resolution === "muted") {
+            statistic.resolutions ?? (statistic.resolutions = {});
+            statistic.resolutions.muted = (statistic.resolutions.muted ?? 0) + 1;
+        }
+        if (testResult.resolution === "accepted") {
+            statistic.resolutions ?? (statistic.resolutions = {});
+            statistic.resolutions.accepted = (statistic.resolutions.accepted ?? 0) + 1;
+        }
+    };
     for (const testResult of testResults) {
         if (testResult.isRetry) {
             continue;
@@ -34,13 +48,21 @@ const statisticByTestResults = async (store, testResults) => {
         if (testResult.transition === "new") {
             statistic.new = (statistic.new ?? 0) + 1;
         }
+        incrementResolution(testResult);
     }
     return statistic;
 };
+const isActiveStatisticTestResult = (testResult) => testResult.resolution !== "muted" && testResult.resolution !== "accepted";
 export class AwesomePlugin {
     constructor(options = {}) {
         this.options = options;
         _AwesomePlugin_writer.set(this, void 0);
+        _AwesomePlugin_generateAfterStart.set(this, async (context, store) => {
+            if (!__classPrivateFieldGet(this, _AwesomePlugin_writer, "f")) {
+                throw new Error("call start first");
+            }
+            await __classPrivateFieldGet(this, _AwesomePlugin_generate, "f").call(this, context, store);
+        });
         _AwesomePlugin_generate.set(this, async (context, store) => {
             const { singleFile, groupBy = [], filter, appendTitlePath } = this.options ?? {};
             const hideLabels = context.hideLabels;
@@ -53,6 +75,8 @@ export class AwesomePlugin {
             const statistics = await store.testsStatistic(filter);
             const environments = await store.allEnvironmentIdentities();
             const envStatistics = new Map();
+            const pieStatistics = await statisticByTestResults(store, allTrs.filter(isActiveStatisticTestResult));
+            const pieEnvStatistics = new Map();
             const allTestEnvGroups = await store.allTestEnvGroups();
             const globalAttachments = await store.allGlobalAttachments();
             const globalAttachmentsByEnv = await store.allGlobalAttachmentsByEnv();
@@ -83,14 +107,19 @@ export class AwesomePlugin {
                 }
             }
             await Promise.all(environments.map(async ({ id }) => {
-                envStatistics.set(id, await statisticByTestResults(store, trsByEnvId.get(id) ?? []));
+                const envTrs = trsByEnvId.get(id) ?? [];
+                envStatistics.set(id, await statisticByTestResults(store, envTrs));
+                pieEnvStatistics.set(id, await statisticByTestResults(store, envTrs.filter(isActiveStatisticTestResult)));
             }));
             await generateStatistic(__classPrivateFieldGet(this, _AwesomePlugin_writer, "f"), {
                 stats: statistics,
                 statsByEnv: envStatistics,
+                pieStats: pieStatistics,
+                pieStatsByEnv: pieEnvStatistics,
                 envs: environments,
             });
             await generateAllCharts(__classPrivateFieldGet(this, _AwesomePlugin_writer, "f"), store, this.options, context);
+            const hasMetrics = await generateMetricsWidget(__classPrivateFieldGet(this, _AwesomePlugin_writer, "f"), store, context.reportUuid);
             const convertedTrs = await generateTestResults(__classPrivateFieldGet(this, _AwesomePlugin_writer, "f"), store, allTrs, { hideLabels });
             applyCategoriesToTestResults(convertedTrs, categories);
             await generateCategories(__classPrivateFieldGet(this, _AwesomePlugin_writer, "f"), {
@@ -101,6 +130,7 @@ export class AwesomePlugin {
                 defaultEnvironment: "default",
                 selectedEnvironmentCount: environments.length,
             });
+            await generateResolutionCategories(__classPrivateFieldGet(this, _AwesomePlugin_writer, "f"), convertedTrs);
             const hasGroupBy = groupBy.length > 0;
             await generateTimeline(__classPrivateFieldGet(this, _AwesomePlugin_writer, "f"), allTrs, this.options, envIdByTrId);
             const treeLabels = hasGroupBy
@@ -131,6 +161,7 @@ export class AwesomePlugin {
                     selectedEnvironmentCount: 1,
                     filename: joinPosixPath(reportEnvironment.id, "categories.json"),
                 });
+                await generateResolutionCategories(__classPrivateFieldGet(this, _AwesomePlugin_writer, "f"), envConvertedTrs, joinPosixPath(reportEnvironment.id, "resolution-categories.json"));
             }
             await generateTreeFilters(__classPrivateFieldGet(this, _AwesomePlugin_writer, "f"), convertedTrs);
             await generateEnvirontmentsList(__classPrivateFieldGet(this, _AwesomePlugin_writer, "f"), store);
@@ -153,8 +184,13 @@ export class AwesomePlugin {
                 contentFunction: (id) => store.attachmentContentById(id),
             });
             const reportDataFiles = singleFile ? __classPrivateFieldGet(this, _AwesomePlugin_writer, "f").reportFiles() : [];
+            const configuredSections = this.options.sections ?? ["charts", "timeline"];
+            const sections = hasMetrics
+                ? [...new Set([...configuredSections, "metrics"])]
+                : configuredSections.filter((section) => section !== "metrics");
             await generateStaticFiles({
                 ...this.options,
+                sections,
                 id: context.id,
                 allureVersion: context.allureVersion,
                 reportFiles: context.reportFiles,
@@ -176,16 +212,10 @@ export class AwesomePlugin {
             await Promise.resolve();
         };
         this.update = async (context, store) => {
-            if (!__classPrivateFieldGet(this, _AwesomePlugin_writer, "f")) {
-                throw new Error("call start first");
-            }
-            await __classPrivateFieldGet(this, _AwesomePlugin_generate, "f").call(this, context, store);
+            await __classPrivateFieldGet(this, _AwesomePlugin_generateAfterStart, "f").call(this, context, store);
         };
         this.done = async (context, store) => {
-            if (!__classPrivateFieldGet(this, _AwesomePlugin_writer, "f")) {
-                throw new Error("call start first");
-            }
-            await __classPrivateFieldGet(this, _AwesomePlugin_generate, "f").call(this, context, store);
+            await __classPrivateFieldGet(this, _AwesomePlugin_generateAfterStart, "f").call(this, context, store);
         };
     }
     async info(context, store) {
@@ -204,4 +234,4 @@ export class AwesomePlugin {
         });
     }
 }
-_AwesomePlugin_writer = new WeakMap(), _AwesomePlugin_generate = new WeakMap();
+_AwesomePlugin_writer = new WeakMap(), _AwesomePlugin_generateAfterStart = new WeakMap(), _AwesomePlugin_generate = new WeakMap();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allurereport/plugin-awesome",
-  "version": "3.16.1",
+  "version": "3.17.0",
   "description": "Allure Awesome Plugin – brand new HTML report with modern design and new features",
   "keywords": [
     "allure",
@@ -30,16 +30,16 @@
     "lint:fix": "oxlint --import-plugin --fix src test features stories"
   },
   "dependencies": {
-    "@allurereport/charts-api": "3.16.1",
-    "@allurereport/core-api": "3.16.1",
-    "@allurereport/plugin-api": "3.16.1",
-    "@allurereport/web-commons": "3.16.1",
+    "@allurereport/charts-api": "3.17.0",
+    "@allurereport/core-api": "3.17.0",
+    "@allurereport/plugin-api": "3.17.0",
+    "@allurereport/web-commons": "3.17.0",
     "d3-shape": "^3.2.0",
     "handlebars": "^4.7.9",
     "markdown-it": "^14.2.0"
   },
   "devDependencies": {
-    "@allurereport/web-awesome": "3.16.1",
+    "@allurereport/web-awesome": "3.17.0",
     "@types/d3-shape": "^3.1.8",
     "@types/markdown-it": "^14.1.2",
     "@types/node": "^20",