@allurereport/ci 3.19.0 → 3.19.1

package/dist/reportContext.js

@@ -27,6 +27,7 @@ const emptyResolutionStats = () => ({
 });
 const isRecord = (value) => typeof value === "object" && value !== null && !Array.isArray(value);
 const isTestStatus = (value) => typeof value === "string" && TEST_STATUSES.includes(value);
+const getFiniteNumber = (value, fallback = 0) => typeof value === "number" && Number.isFinite(value) ? value : fallback;
 const normalizePath = (filePath) => filePath.split(sep).join("/");
 const readOptionalJson = async (filePath, onError) => {
     if (!existsSync(filePath)) {
@@ -40,12 +41,43 @@ const readOptionalJson = async (filePath, onError) => {
         return undefined;
     }
 };
+const getReportName = (summary) => {
+    if (typeof summary.name === "string" && summary.name.trim()) {
+        return summary.name;
+    }
+    return "Allure Report";
+};
+const hasPluginSummarySignal = (value) => typeof value.name === "string" ||
+    typeof value.plugin === "string" ||
+    typeof value.href === "string" ||
+    typeof value.remoteHref === "string" ||
+    isRecord(value.stats);
 const isPluginSummary = (value) => {
-    if (!isRecord(value) || typeof value.name !== "string" || !isRecord(value.stats)) {
+    if (!isRecord(value) || !hasPluginSummarySignal(value)) {
         return false;
     }
-    return typeof value.duration === "number" && isTestStatus(value.status);
+    return true;
+};
+const normalizePluginSummaryStats = (summary) => {
+    const rawStats = isRecord(summary.stats) ? summary.stats : {};
+    const stats = {
+        ...rawStats,
+        failed: getFiniteNumber(rawStats.failed),
+        broken: getFiniteNumber(rawStats.broken),
+        passed: getFiniteNumber(rawStats.passed),
+        skipped: getFiniteNumber(rawStats.skipped),
+        unknown: getFiniteNumber(rawStats.unknown),
+    };
+    stats.total = getFiniteNumber(rawStats.total, TEST_STATUSES.reduce((acc, status) => acc + getFiniteNumber(stats[status]), 0));
+    return stats;
 };
+const normalizePluginSummary = (summary) => ({
+    ...summary,
+    name: getReportName(summary),
+    stats: normalizePluginSummaryStats(summary),
+    status: isTestStatus(summary.status) ? summary.status : "passed",
+    duration: getFiniteNumber(summary.duration),
+});
 const getReportPath = (reportDir, summaryFile) => normalizePath(relative(resolve(reportDir), dirname(resolve(summaryFile))));
 const readPluginSummary = async (reportDir, filePath, onError) => {
     const value = await readOptionalJson(filePath, onError);
@@ -57,7 +89,7 @@ const readPluginSummary = async (reportDir, filePath, onError) => {
         return undefined;
     }
     return {
-        ...value,
+        ...normalizePluginSummary(value),
         summaryFile: filePath,
         reportPath: getReportPath(reportDir, filePath),
     };
@@ -204,8 +236,10 @@ const createEnvironmentContext = (registry, summaries) => {
     });
     return [...environmentsByName.values()].toSorted((left, right) => left.name.localeCompare(right.name));
 };
-const createReport = (summary) => ({ ...summary });
-const sortReports = (reports) => reports.toSorted((left, right) => left.name.localeCompare(right.name));
+const createReport = (summary) => normalizePluginSummary(summary);
+const sortReports = (reports) => reports
+    .map((report) => normalizePluginSummary(report))
+    .toSorted((left, right) => left.name.localeCompare(right.name));
 const getResolutionStats = (summaries) => {
     const stats = emptyResolutionStats();
     summaries.forEach((summary) => {

package/dist/reportMarkdown.d.ts

@@ -1,6 +1,16 @@
-import type { ReportContext } from "./reportContext.js";
+import type { ReportContext, ReportContextFlagStats, ReportContextTestReport, ReportContextResolutionStats, ReportContextStatusStats } from "./reportContext.js";
+export type ReportSummaryMarkdownRow = {
+    kind: "total" | "environment" | "report";
+    name: string;
+    duration: number;
+    stats: ReportContextStatusStats;
+    flags: ReportContextFlagStats;
+    resolutions?: ReportContextResolutionStats;
+    report?: ReportContextTestReport;
+};
 export type RenderReportSummaryMarkdownOptions = {
     title?: string;
     includeArtifacts?: boolean;
+    getReportFilterHref?: (filter: keyof ReportContextFlagStats, row: ReportSummaryMarkdownRow) => string | undefined;
 };
 export declare const renderReportSummaryMarkdown: (context: ReportContext, options?: RenderReportSummaryMarkdownOptions) => string;

package/dist/reportMarkdown.js

@@ -10,6 +10,7 @@ const STATUS_ICON_BASE_URL = "https://allurecharts.qameta.workers.dev/dot";
 const STATUS_PIE_BASE_URL = "https://allurecharts.qameta.workers.dev/pie";
 const escapeHtml = (value) => value.replaceAll("&", "&amp;").replaceAll("<", "&lt;").replaceAll(">", "&gt;").replaceAll('"', "&quot;");
 const tableCell = (value) => escapeHtml(String(value)).replaceAll("|", "&#124;").replaceAll("\n", "<br>");
+const inlineCode = (value) => `<code>${escapeHtml(value)}</code>`;
 const isSafeHref = (href) => {
     try {
         const url = new URL(href);
@@ -82,11 +83,19 @@ const formatResolutions = (resolutions) => {
     return lines.join("<br>");
 };
 const hasResolutions = (resolutions) => resolutions.issues > 0 || resolutions.muted > 0 || resolutions.accepted > 0;
-const formatFlag = (value) => (value > 0 ? String(value) : "0");
-const renderTable = (rows, includeResolutions) => {
+const formatFlag = (flag, row, options) => {
+    const value = row.flags[flag];
+    if (value <= 0) {
+        return "0";
+    }
+    const label = String(value);
+    const href = options.getReportFilterHref?.(flag, row);
+    return href ? link(label, href) : label;
+};
+const renderTable = (rows, includeResolutions, options) => {
     const headers = [
         "&nbsp;&nbsp;&nbsp;&nbsp;",
-        "Scope",
+        "Environment",
         "Duration",
         "Stats",
         ...(includeResolutions ? ["Resolutions"] : []),
@@ -101,14 +110,31 @@ const renderTable = (rows, includeResolutions) => {
         tableCell(formatDuration(row.duration)),
         formatStats(row.stats),
         ...(includeResolutions ? [formatResolutions(row.resolutions)] : []),
-        tableCell(formatFlag(row.flags.new)),
-        tableCell(formatFlag(row.flags.flaky)),
-        tableCell(formatFlag(row.flags.retry)),
+        formatFlag("new", row, options),
+        formatFlag("flaky", row, options),
+        formatFlag("retry", row, options),
     ].join(" | "));
     return [`| ${headers.join(" | ")} |`, `| ${divider.join(" | ")} |`, ...body.map((row) => `| ${row} |`)].join("\n");
 };
 const reportHref = (report) => report.remoteHref ?? report.href;
 const reportLabel = (report) => report.plugin ?? report.name;
+const isAwesomeReport = (report) => report?.pluginId?.toLowerCase() === "awesome" || report?.plugin?.toLowerCase() === "awesome";
+const appendReportFilter = (href, filter) => {
+    const hashIndex = href.indexOf("#");
+    const base = hashIndex === -1 ? href : href.slice(0, hashIndex);
+    const hash = hashIndex === -1 ? "" : href.slice(hashIndex);
+    const separator = base.includes("?") ? "&" : "?";
+    const query = filter === "new" ? "transition=new" : `${filter}=true`;
+    return `${base}${separator}${query}${hash}`;
+};
+const createDefaultReportFilterHref = (reports) => {
+    const defaultReport = reports.find(isAwesomeReport);
+    return (filter, row) => {
+        const report = isAwesomeReport(row.report) ? row.report : defaultReport;
+        const href = report ? reportHref(report) : undefined;
+        return href ? appendReportFilter(href, filter) : undefined;
+    };
+};
 const reportLinkKind = (report) => report.plugin?.toLowerCase() === "testops" ? "testops" : "report";
 const toReportLink = (report) => {
     const href = reportHref(report);
@@ -151,43 +177,46 @@ const pluginSummaryToResolutions = (report) => ({
     muted: report.stats.resolutions?.muted ?? 0,
     accepted: report.stats.resolutions?.accepted ?? 0,
 });
-const renderFilteredReports = (reports) => {
+const renderFilteredReports = (reports, options) => {
     const rows = reports.map((report) => ({
+        kind: "report",
         name: report.name,
         duration: report.duration,
         stats: pluginSummaryToStatusStats(report),
         flags: pluginSummaryToFlags(report),
         resolutions: pluginSummaryToResolutions(report),
+        report,
     }));
     if (!rows.length) {
         return undefined;
     }
     const includeResolutions = rows.some(({ resolutions }) => resolutions && hasResolutions(resolutions));
     const links = renderReportLinks(reports);
-    return ["**Filtered Reports**", renderTable(rows, includeResolutions), ...links].join("\n\n");
+    return ["**Filtered Reports**", renderTable(rows, includeResolutions, options), ...links].join("\n\n");
 };
 const renderArtifacts = (artifacts) => {
     if (!artifacts.length) {
         return undefined;
     }
-    const rows = artifacts.map(({ name, path }) => `| ${tableCell(name)} | ${tableCell(path)} |`);
-    return [
-        `<details>`,
-        `<summary>Artifacts used (${artifacts.length})</summary>`,
-        "",
-        "| Name | Path |",
-        "| --- | --- |",
-        ...rows,
-        "",
-        "</details>",
-    ].join("\n");
+    const rows = artifacts.map(({ name, path }) => {
+        const normalizedPath = path.replaceAll("\\", "/");
+        const isDuplicateName = name === path || normalizedPath.endsWith(`/${name}`);
+        const label = isDuplicateName ? inlineCode(path) : `${inlineCode(name)} &mdash; ${inlineCode(path)}`;
+        return `- ${label}`;
+    });
+    return [`<details>`, `<summary>Artifacts used (${artifacts.length})</summary>`, "", ...rows, "", "</details>"].join("\n");
 };
 export const renderReportSummaryMarkdown = (context, options = {}) => {
     const { title = "Allure Report Summary", includeArtifacts = true } = options;
     const regularReports = context.reports.filter((report) => report.filtered !== true);
     const filteredReports = context.reports.filter((report) => report.filtered === true);
+    const renderOptions = {
+        ...options,
+        getReportFilterHref: options.getReportFilterHref ?? createDefaultReportFilterHref(regularReports),
+    };
     const aggregateRows = [
         {
+            kind: "total",
             name: "All tests",
             duration: context.totals.duration,
             stats: context.totals.stats,
@@ -195,6 +224,7 @@ export const renderReportSummaryMarkdown = (context, options = {}) => {
             resolutions: context.totals.resolutions,
         },
         ...context.environments.map((environment) => ({
+            kind: "environment",
             name: environment.name,
             duration: environment.duration,
             stats: environment.stats,
@@ -204,9 +234,9 @@ export const renderReportSummaryMarkdown = (context, options = {}) => {
     const includeResolutions = hasResolutions(context.totals.resolutions);
     const sections = [
         `# ${escapeHtml(title)}`,
-        renderTable(aggregateRows, includeResolutions),
+        renderTable(aggregateRows, includeResolutions, renderOptions),
         ...renderReportLinks(regularReports),
-        renderFilteredReports(filteredReports),
+        renderFilteredReports(filteredReports, renderOptions),
         includeArtifacts ? renderArtifacts(context.artifacts) : undefined,
     ].filter((section) => Boolean(section));
     return `${sections.join("\n\n")}\n`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allurereport/ci",
-  "version": "3.19.0",
+  "version": "3.19.1",
   "description": "Utilities set to get useful report data from different CI",
   "keywords": [
     "allure",
@@ -32,15 +32,15 @@
     "lint:fix": "oxlint --import-plugin --fix src test features stories"
   },
   "dependencies": {
-    "@allurereport/core-api": "3.19.0",
-    "@allurereport/plugin-api": "3.19.0",
+    "@allurereport/core-api": "3.19.1",
+    "@allurereport/plugin-api": "3.19.1",
     "axios": "^1.20.0",
     "glob": "^13.0.6"
   },
   "devDependencies": {
     "@types/node": "^20",
     "@vitest/runner": "^2.1.8",
-    "@vitest/snapshot": "^2.1.8",
+    "@vitest/snapshot": "^5.0.1",
     "allure-js-commons": "^3",
     "allure-vitest": "^3",
     "rimraf": "^6",