@allurereport/plugin-awesome 3.20.1 → 3.21.0

package/dist/categories.js

@@ -198,6 +198,7 @@ export const generateCategories = async (writer, { tests, categories, filename =
             duration: tr.duration,
             flaky: tr.flaky,
             retriesCount: tr.retriesCount,
+            retriesStatusChange: tr.retriesStatusChange,
             transition: tr.transition,
             tooltips: tr.tooltips,
         });

package/dist/generators.d.ts

@@ -50,6 +50,7 @@ export declare const generateStaticFiles: (payload: AwesomeOptions & {
     reportDataFiles: ReportFile[];
     reportUuid: string;
     reportName: string;
+    overviewHref?: string;
     executor?: ReportExecutorInfo;
     runSummary?: ReportRunSummary;
     runSummaryByEnv?: Record<string, ReportRunSummary>;

package/dist/generators.js

@@ -1,11 +1,12 @@
 import { randomUUID } from "node:crypto";
 import { defaultChartsConfig } from "@allurereport/charts-api";
-import { appLoaderFaviconDataUri, appLoaderStyles, compareBy, createAppLoaderMarkup, createBaseUrlScript, createFaviconLinkTag, createFontLinkTag, createReportDataScript, stringifyForInlineScript, createScriptTag, createStylesLinkTag, incrementStatistic, joinPosixPath, nullsLast, ordinal, redactParameters, severityLabelName, } from "@allurereport/core-api";
+import { appLoaderFaviconDataUri, appLoaderStyles, compareBy, createAppLoaderMarkup, createBaseUrlScript, createFaviconLinkTag, createFontLinkTag, injectReportDataScript, reportDataScriptPlaceholder, stringifyForInlineScript, createScriptTag, createStylesLinkTag, hasRetriesStatusChange, incrementStatistic, joinPosixPath, nullsLast, ordinal, redactParameters, severityLabelName, } from "@allurereport/core-api";
 import { collapseTreeGroups, createTreeByLabels, createTreeByLabelsAndTitlePath, createTreeByTitlePath, preciseTreeLabels, processTree, } from "@allurereport/plugin-api";
 import { copyReportStaticAssets, getReportStaticAsset, readReportStaticAssets, } from "@allurereport/plugin-api/static-assets";
 import { generateCharts, getPieChartValues } from "@allurereport/web-commons";
 import Handlebars from "handlebars";
 import { convertFixtureResult, convertTestResult } from "./converters.js";
+import { createSingleFileScripts } from "./singleFileAssets.js";
 const reportStaticArchive = new URL("../dist/static/report.tar", import.meta.url);
 const template = `<!DOCTYPE html>
 <html dir="ltr" lang="en">
@@ -104,6 +105,7 @@ export const generateTestResults = async (_writer, store, trs, options) => {
         convertedTr.retries = related.retriesByTrId.get(tr.id) ?? [];
         convertedTr.retriesCount = convertedTr.retries.length;
         convertedTr.retry = convertedTr.retriesCount > 0;
+        convertedTr.retriesStatusChange = hasRetriesStatusChange(tr, convertedTr.retries);
         convertedTr.isRetry = tr.isRetry;
         convertedTr.setup = convertedTrFixtures.filter((f) => f.type === "before");
         convertedTr.teardown = convertedTrFixtures.filter((f) => f.type === "after");
@@ -137,7 +139,9 @@ export const generateNav = async (writer, trs, filename = "nav.json") => {
 };
 const SEARCHABLE_LABELS = new Set([
     "owner",
+    "parentSuite",
     "suite",
+    "subSuite",
     "package",
     "testClass",
     "testMethod",
@@ -175,6 +179,7 @@ const searchDocumentFactory = (test) => {
         id: test.id,
         nodeId: test.id,
         name: test.name,
+        titlePath: joinSearchValues(test.titlePath ?? []),
         fullName: test.fullName,
         retryHash: test.retryHash,
         labels: joinSearchValues(labels),
@@ -282,7 +287,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, resolution, transition, tooltips, retryHash, groupedLabels, categories, parameters, }) => {
+const leafFactory = ({ id, name, status, duration, flaky, start, retry, retriesCount, retriesStatusChange, resolution, transition, tooltips, retryHash, groupedLabels, categories, parameters, }) => {
     const unresolvedFailure = (status === "failed" || status === "broken") && !resolution;
     const parameterValues = redactParameters(parameters).flatMap(({ value }) => (value ? [value] : []));
     const leaf = {
@@ -295,6 +300,7 @@ const leafFactory = ({ id, name, status, duration, flaky, start, retry, retriesC
         start,
         retry,
         retriesCount,
+        retriesStatusChange,
         resolution,
         resolutionStatus: resolution ?? (unresolvedFailure ? "none" : undefined),
         transition,
@@ -332,6 +338,7 @@ const resolutionTestResultFactory = (test, index) => ({
     transition: test.transition,
     retry: test.retry,
     retriesCount: test.retriesCount,
+    retriesStatusChange: test.retriesStatusChange,
     resolution: test.resolution,
     groupOrder: index + 1,
     tooltips: test.tooltips,
@@ -478,7 +485,7 @@ export const generateQualityGateResults = async (writer, qualityGateResults = {}
     await writer.writeWidget("quality-gate.json", resultsWithTrees);
 };
 export const generateStaticFiles = async (payload) => {
-    const { id, reportName = "Allure Report", reportLanguage = "en", logo = "", theme = "auto", groupBy, reportFiles, reportDataFiles, reportUuid, allureVersion, layout = "base", defaultSection = "", ci, executor, runSummary, runSummaryByEnv, stepTreeExpansion, defaultSortBy, } = payload;
+    const { id, reportName = "Allure Report", reportLanguage = "en", logo = "", theme = "auto", groupBy, reportFiles, reportDataFiles, reportUuid, allureVersion, layout = "base", defaultSection = "", ci, executor, runSummary, runSummaryByEnv, stepTreeExpansion, defaultSortBy, overviewHref, } = payload;
     const staticAssets = await readReportStaticAssets(reportStaticArchive);
     const { manifest } = staticAssets;
     const headTags = [];
@@ -506,8 +513,7 @@ export const generateStaticFiles = async (payload) => {
             const mainCssContent = getReportStaticAsset(staticAssets, mainCss);
             headTags.push(createStylesLinkTag(`data:text/css;base64,${mainCssContent.toString("base64")}`));
         }
-        const mainJsContent = getReportStaticAsset(staticAssets, mainJs);
-        bodyTags.push(createScriptTag(`data:text/javascript;base64,${mainJsContent.toString("base64")}`));
+        bodyTags.push(createSingleFileScripts(staticAssets.files, mainJs));
     }
     const now = Date.now();
     const reportOptions = {
@@ -530,12 +536,13 @@ export const generateStaticFiles = async (payload) => {
         defaultSection,
         stepTreeExpansion,
         defaultSortBy,
+        overviewHref,
     };
     try {
         const html = compiledTemplate({
             headTags: headTags.join("\n"),
             bodyTags: bodyTags.join("\n"),
-            reportFilesScript: createReportDataScript(reportDataFiles),
+            reportFilesScript: reportDataScriptPlaceholder,
             reportOptions: stringifyForInlineScript(reportOptions),
             analyticsEnable: true,
             allureVersion,
@@ -543,7 +550,7 @@ export const generateStaticFiles = async (payload) => {
             reportName,
             singleFile: payload.singleFile,
         });
-        await reportFiles.addFile("index.html", Buffer.from(html, "utf8"));
+        await reportFiles.addFile("index.html", injectReportDataScript(html, reportDataFiles));
     }
     catch (err) {
         if (err instanceof RangeError) {

package/dist/plugin.js

@@ -10,14 +10,14 @@ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (
     return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
 };
 var _AwesomePlugin_writer, _AwesomePlugin_generateAfterStart, _AwesomePlugin_generate;
-import { incrementStatistic, validateEnvironmentId, joinPosixPath, } from "@allurereport/core-api";
+import { incrementStatistic, hasRetriesStatusChange, validateEnvironmentId, 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, 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 = (testResults, trIdsWithRetries) => {
+const statisticByTestResults = (testResults, retriesByTrId) => {
     const statistic = { total: 0 };
     const incrementResolution = (testResult) => {
         if (testResult.resolution === "issue") {
@@ -38,9 +38,13 @@ const statisticByTestResults = (testResults, trIdsWithRetries) => {
             continue;
         }
         incrementStatistic(statistic, testResult.status);
-        if (trIdsWithRetries.has(testResult.id)) {
+        const retries = retriesByTrId.get(testResult.id) ?? [];
+        if (retries.length > 0) {
             statistic.retries = (statistic.retries ?? 0) + 1;
         }
+        if (hasRetriesStatusChange(testResult, retries)) {
+            statistic.retriesStatusChange = (statistic.retriesStatusChange ?? 0) + 1;
+        }
         if (testResult.flaky) {
             statistic.flaky = (statistic.flaky ?? 0) + 1;
         }
@@ -117,15 +121,9 @@ export class AwesomePlugin {
             });
             const trsByEnvId = new Map();
             await measure("stats", async () => {
-                const trIdsWithRetries = new Set();
                 const envStatistics = new Map();
                 const pieEnvStatistics = new Map();
-                related.retriesByTrId.forEach((retries, trId) => {
-                    if (retries.length > 0) {
-                        trIdsWithRetries.add(trId);
-                    }
-                });
-                const pieStatistics = statisticByTestResults(allTrs.filter(isActiveStatisticTestResult), trIdsWithRetries);
+                const pieStatistics = statisticByTestResults(allTrs.filter(isActiveStatisticTestResult), related.retriesByTrId);
                 for (const tr of allTrs) {
                     const environmentId = envIdByTrId.get(tr.id);
                     if (!environmentId) {
@@ -141,8 +139,8 @@ export class AwesomePlugin {
                 }
                 await Promise.all(environments.map(async ({ id }) => {
                     const envTrs = trsByEnvId.get(id) ?? [];
-                    envStatistics.set(id, statisticByTestResults(envTrs, trIdsWithRetries));
-                    pieEnvStatistics.set(id, statisticByTestResults(envTrs.filter(isActiveStatisticTestResult), trIdsWithRetries));
+                    envStatistics.set(id, statisticByTestResults(envTrs, related.retriesByTrId));
+                    pieEnvStatistics.set(id, statisticByTestResults(envTrs.filter(isActiveStatisticTestResult), related.retriesByTrId));
                 }));
                 await generateStatistic(__classPrivateFieldGet(this, _AwesomePlugin_writer, "f"), {
                     stats: statistics,
@@ -263,6 +261,7 @@ export class AwesomePlugin {
                 reportFiles: context.reportFiles,
                 reportUuid: context.reportUuid,
                 reportName: context.reportName,
+                overviewHref: context.overviewHref,
                 ci: context.ci,
                 executor,
                 runSummary,

package/dist/singleFileAssets.d.ts

@@ -0,0 +1 @@
+export declare const createSingleFileScripts: (files: ReadonlyMap<string, Buffer>, mainJs: string) => string;

package/dist/singleFileAssets.js

@@ -0,0 +1,81 @@
+import { gzipSync } from "node:zlib";
+import { stringifyForInlineScript } from "@allurereport/core-api";
+const embeddedAssetsElementId = "allure-single-file-assets";
+export const createSingleFileScripts = (files, mainJs) => {
+    const compressedScripts = Object.fromEntries([...files]
+        .filter(([fileName]) => fileName.endsWith(".js"))
+        .map(([fileName, content]) => [fileName, gzipSync(content, { level: 9 }).toString("base64")]));
+    if (!compressedScripts[mainJs]) {
+        throw new Error(`The report static assets do not contain the main script: ${mainJs}`);
+    }
+    return `
+    <script id="${embeddedAssetsElementId}" type="application/json">${stringifyForInlineScript(compressedScripts)}</script>
+    <script>
+      (function () {
+        const assetsElement = document.getElementById(${stringifyForInlineScript(embeddedAssetsElementId)});
+        const assets = JSON.parse(assetsElement.textContent || "{}");
+        const appendChild = document.head.appendChild;
+
+        assetsElement.remove();
+
+        function embeddedAssetName(script) {
+          const source = script.getAttribute("src");
+
+          if (!source) {
+            return undefined;
+          }
+
+          const path = source.split(/[?#]/, 1)[0];
+
+          return path.slice(path.lastIndexOf("/") + 1);
+        }
+
+        async function decompressAsset(encoded) {
+          const binary = atob(encoded);
+          const compressed = new Uint8Array(binary.length);
+
+          for (let index = 0; index < binary.length; index++) {
+            compressed[index] = binary.charCodeAt(index);
+          }
+
+          const stream = new Blob([compressed]).stream().pipeThrough(new DecompressionStream("gzip"));
+
+          return new Response(stream).text();
+        }
+
+        document.head.appendChild = function (node) {
+          if (node.tagName !== "SCRIPT") {
+            return appendChild.call(this, node);
+          }
+
+          const fileName = embeddedAssetName(node);
+          const encoded = fileName && Object.hasOwn(assets, fileName) ? assets[fileName] : undefined;
+
+          if (!encoded) {
+            return appendChild.call(this, node);
+          }
+
+          void decompressAsset(encoded)
+            .then(function (source) {
+              node.removeAttribute("src");
+              node.text = source;
+              delete assets[fileName];
+              appendChild.call(document.head, node);
+              node.dispatchEvent(new Event("load"));
+            })
+            .catch(function (error) {
+              console.error("Failed to load embedded report asset " + fileName, error);
+              node.dispatchEvent(new Event("error"));
+            });
+
+          return node;
+        };
+
+        const mainScript = document.createElement("script");
+
+        mainScript.src = ${stringifyForInlineScript(mainJs)};
+        document.head.appendChild(mainScript);
+      })();
+    </script>
+  `;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allurereport/plugin-awesome",
-  "version": "3.20.1",
+  "version": "3.21.0",
   "description": "Allure Awesome Plugin – brand new HTML report with modern design and new features",
   "keywords": [
     "allure",
@@ -23,26 +23,29 @@
     ".": "./dist/index.js"
   },
   "scripts": {
-    "build": "run clean && tsc --project ./tsconfig.json && node ../../scripts/pack-report-static.mjs ../web-awesome/dist/multi ./dist/static/report.tar",
+    "build": "run clean && tsc --project ./tsconfig.json && node ../../scripts/pack-report-static.mjs ../web-awesome/dist/multi ./dist/static/report.tar --allow-chunks",
     "clean": "rimraf ./dist",
     "test": "rimraf ./out && vitest run",
+    "test:unit": "yarn test",
     "lint": "oxlint --import-plugin src test features stories",
     "lint:fix": "oxlint --import-plugin --fix src test features stories"
   },
   "dependencies": {
-    "@allurereport/charts-api": "3.20.1",
-    "@allurereport/core-api": "3.20.1",
-    "@allurereport/plugin-api": "3.20.1",
-    "@allurereport/web-commons": "3.20.1",
+    "@allurereport/charts-api": "3.21.0",
+    "@allurereport/core-api": "3.21.0",
+    "@allurereport/plugin-api": "3.21.0",
+    "@allurereport/web-commons": "3.21.0",
     "d3-shape": "^3.2.0",
-    "handlebars": "^4.7.9",
-    "markdown-it": "^14.2.0"
+    "handlebars": "4.7.10",
+    "markdown-it": "^15.0.2"
   },
   "devDependencies": {
-    "@allurereport/web-awesome": "3.20.1",
+    "@allurereport/test-config": "3.21.0",
+    "@allurereport/web-awesome": "3.21.0",
     "@types/d3-shape": "^3.1.8",
     "@types/markdown-it": "^14.1.2",
     "@types/node": "^20",
+    "@vitest/coverage-istanbul": "^4.1.0",
     "@vitest/runner": "^2",
     "allure-js-commons": "^3",
     "allure-vitest": "^3",