@allurereport/plugin-allure2 3.20.1 → 3.21.0

package/dist/converters.js

@@ -1,4 +1,4 @@
-import { isStep, redactParameters } from "@allurereport/core-api";
+import { hasRetriesStatusChange, isStep, redactParameters } from "@allurereport/core-api";
 import { matchCategories } from "./categories.js";
 import { severityValues } from "./model.js";
 import { createStatistic, updateStatistic } from "./utils.js";
@@ -170,8 +170,7 @@ export const convertTestResult = (context, test) => {
             duration: retry.duration,
         },
     }));
-    const retriesStatusChange = isImportantStatus(status) &&
-        retries.find((retry) => isImportantStatus(retry.status) && retry.status !== status) !== undefined;
+    const retriesStatusChange = hasRetriesStatusChange(test, context.retries);
     const historyItems = context.legacyHistory
         ? context.legacyHistory.items.map((item) => ({
             uid: item.uid,

package/dist/generators.d.ts

@@ -1,5 +1,5 @@
 import type { AttachmentLink, GlobalAttachmentLink, HistoryDataPoint, TestError } from "@allurereport/core-api";
-import type { ReportFiles, ResultFile } from "@allurereport/plugin-api";
+import type { ExitCode, ReportFiles, ResultFile } from "@allurereport/plugin-api";
 import type { ReportStaticManifest } from "@allurereport/plugin-api/static-assets";
 import type { Allure2CategoriesTrendItem, Allure2DurationTrendItem, Allure2ExecutorInfo, Allure2LegacyHistoryTrendItem, Allure2RetryTrendItem, Allure2TestResult } from "./model.js";
 import type { Allure2DataWriter, ReportFile } from "./writer.js";
@@ -13,6 +13,7 @@ export declare const generateStaticFiles: (payload: {
     reportFiles: ReportFiles;
     reportDataFiles: ReportFile[];
     reportUuid: string;
+    overviewHref?: string;
 }) => Promise<void>;
 export declare const generateTree: (writer: Allure2DataWriter, name: string, labelNames: string[], tests: Allure2TestResult[]) => Promise<void>;
 export declare const generatePackagesData: (writer: Allure2DataWriter, tests: Allure2TestResult[]) => Promise<void>;
@@ -31,4 +32,4 @@ export declare const generateDurationTrendData: (writer: Allure2DataWriter, test
 export declare const generateRetryTrendData: (writer: Allure2DataWriter, tests: Allure2TestResult[], history?: Allure2RetryTrendItem[], executor?: Partial<Allure2ExecutorInfo>) => Promise<void>;
 export declare const generateCategoriesTrendData: (writer: Allure2DataWriter, tests: Allure2TestResult[], history?: Allure2CategoriesTrendItem[], executor?: Partial<Allure2ExecutorInfo>) => Promise<void>;
 export declare const generateAttachmentsData: (writer: Allure2DataWriter, attachmentLinks: AttachmentLink[], contentFunction: (id: string) => Promise<ResultFile | undefined>) => Promise<Map<string, string>>;
-export declare const generateGlobalsData: (writer: Allure2DataWriter, globalErrors: TestError[], globalAttachments: GlobalAttachmentLink[], attachmentMap: Map<string, string>, attachmentTimestamps?: Record<string, number>, errorTimestamps?: Array<number | undefined>) => Promise<void>;
+export declare const generateGlobalsData: (writer: Allure2DataWriter, globalErrors: TestError[], globalAttachments: GlobalAttachmentLink[], attachmentMap: Map<string, string>, attachmentTimestamps?: Record<string, number>, errorTimestamps?: Array<number | undefined>, exitCode?: ExitCode) => Promise<void>;

package/dist/generators.js

@@ -1,4 +1,4 @@
-import { createBaseUrlScript, createScriptTag, createStylesLinkTag } from "@allurereport/core-api";
+import { createBaseUrlScript, createScriptTag, createStylesLinkTag, stringifyForInlineScript, } from "@allurereport/core-api";
 import { copyReportStaticAssets, getReportStaticAsset, readReportStaticAssets, } from "@allurereport/plugin-api/static-assets";
 import Handlebars from "handlebars";
 import { byLabels, collapseTree, createTree, createWidget } from "./tree.js";
@@ -38,6 +38,11 @@ const template = `<!DOCTYPE html>
       }
     </script>
     ${createBaseUrlScript()}
+    {{#if reportOptions}}
+    <script>
+      window.allureReportOptions = {{{ reportOptions }}}
+    </script>
+    {{/if}}
     {{#if analyticsEnable}}
     <script async src="https://www.googletagmanager.com/gtag/js?id=G-FVWC4GKEYS"></script>
     <script>
@@ -56,11 +61,15 @@ const template = `<!DOCTYPE html>
 </html>
 `;
 const compiledTemplate = Handlebars.compile(template);
-const createEmbeddedReportDataScript = (reportFiles) => {
-    const reportFilesDeclaration = reportFiles
-        .map(({ name, value }) => `d(${JSON.stringify(name)},${JSON.stringify(value)})`)
-        .join(",");
-    return `
+const reportDataScriptPlaceholder = "<!-- allure2-report-data -->";
+const injectEmbeddedReportDataScript = (html, reportFiles) => {
+    const placeholderIndex = html.indexOf(reportDataScriptPlaceholder);
+    if (placeholderIndex === -1) {
+        throw new Error("Report data script placeholder is missing from the Allure 2 HTML template");
+    }
+    const chunks = [
+        Buffer.from(html.slice(0, placeholderIndex), "utf8"),
+        Buffer.from(`
     <script>
       window.reportDataReady = false;
       window.reportData = window.reportData || {};
@@ -73,18 +82,24 @@ const createEmbeddedReportDataScript = (reportFiles) => {
       }
     </script>
     <script>
-      Promise.allSettled([${reportFilesDeclaration}]).then(function () {
+      Promise.allSettled([`),
+    ];
+    reportFiles.forEach(({ name, value }, index) => {
+        chunks.push(Buffer.from(`${index === 0 ? "" : ","}d(${stringifyForInlineScript(name)},${stringifyForInlineScript(value)})`));
+    });
+    chunks.push(Buffer.from(`]).then(function () {
         window.reportDataReady = true;
       });
     </script>
-  `;
+  `), Buffer.from(html.slice(placeholderIndex + reportDataScriptPlaceholder.length), "utf8"));
+    return Buffer.concat(chunks);
 };
 export const readTemplateManifest = async () => {
     const { manifest } = await readReportStaticAssets(reportStaticArchive);
     return manifest;
 };
 export const generateStaticFiles = async (payload) => {
-    const { reportName, reportLanguage, singleFile, reportFiles, reportDataFiles, reportUuid, allureVersion } = payload;
+    const { reportName, reportLanguage, singleFile, reportFiles, reportDataFiles, reportUuid, allureVersion, overviewHref, } = payload;
     const staticAssets = await readReportStaticAssets(reportStaticArchive);
     const { manifest } = staticAssets;
     const mainJs = manifest["main.js"];
@@ -110,15 +125,16 @@ export const generateStaticFiles = async (payload) => {
         const html = compiledTemplate({
             headTags: headTags.join("\n"),
             bodyTags: bodyTags.join("\n"),
-            reportFilesScript: singleFile ? createEmbeddedReportDataScript(reportDataFiles) : "",
+            reportFilesScript: singleFile ? reportDataScriptPlaceholder : "",
             analyticsEnable: process.env.ALLURE_NO_ANALYTICS?.toLowerCase() !== "true",
             allureVersion,
             reportLanguage,
             reportUuid,
             reportName,
             singleFile,
+            reportOptions: overviewHref ? stringifyForInlineScript({ overviewHref }) : undefined,
         });
-        await reportFiles.addFile("index.html", Buffer.from(html, "utf8"));
+        await reportFiles.addFile("index.html", singleFile ? injectEmbeddedReportDataScript(html, reportDataFiles) : Buffer.from(html, "utf8"));
     }
     catch (err) {
         if (err instanceof RangeError) {
@@ -308,7 +324,7 @@ export const generateAttachmentsData = async (writer, attachmentLinks, contentFu
     }
     return result;
 };
-export const generateGlobalsData = async (writer, globalErrors, globalAttachments, attachmentMap, attachmentTimestamps = {}, errorTimestamps = []) => {
+export const generateGlobalsData = async (writer, globalErrors, globalAttachments, attachmentMap, attachmentTimestamps = {}, errorTimestamps = [], exitCode) => {
     const data = {
         errors: globalErrors.map(({ message, trace, actual, expected }, index) => ({
             message,
@@ -334,5 +350,8 @@ export const generateGlobalsData = async (writer, globalErrors, globalAttachment
             ];
         }),
     };
+    if (exitCode) {
+        data.exitCode = exitCode;
+    }
     await writer.writeWidget("globals.json", data);
 };

package/dist/model.d.ts

@@ -1,4 +1,5 @@
 import type { Statistic } from "@allurereport/core-api";
+import type { ExitCode } from "@allurereport/plugin-api";
 export type Allure2Status = "failed" | "broken" | "passed" | "skipped" | "unknown";
 export interface Allure2Time {
     start?: number;
@@ -38,6 +39,7 @@ export interface Allure2GlobalAttachment extends Allure2Attachment {
     timestamp?: number;
 }
 export interface Allure2GlobalsData {
+    exitCode?: ExitCode;
     errors: Allure2GlobalError[];
     attachments: Allure2GlobalAttachment[];
 }

package/dist/plugin.js

@@ -16,13 +16,14 @@ export class Allure2Plugin {
             const writer = singleFile ? new InMemoryReportDataWriter() : new ReportFileDataWriter(context.reportFiles);
             const attachmentLinks = await store.allAttachments();
             const attachmentMap = await generateAttachmentsData(writer, attachmentLinks, (id) => store.attachmentContentById(id));
-            const [globalErrors, globalAttachments] = await Promise.all([
+            const [globalErrors, globalAttachments, globalExitCode] = await Promise.all([
                 store.allGlobalErrors(),
                 store.allGlobalAttachments(),
+                store.globalExitCode(),
             ]);
             const globalAttachmentTimestamps = (await store.metadataByKey("allure2_global_attachment_timestamps")) ?? {};
             const globalErrorTimestamps = (await store.metadataByKey("allure2_global_error_timestamps")) ?? [];
-            await generateGlobalsData(writer, globalErrors, globalAttachments, attachmentMap, globalAttachmentTimestamps, globalErrorTimestamps);
+            await generateGlobalsData(writer, globalErrors, globalAttachments, attachmentMap, globalAttachmentTimestamps, globalErrorTimestamps, globalExitCode);
             const categories = (await store.metadataByKey("allure2_categories")) ?? [];
             const legacyHistory = (await store.metadataByKey("allure2_history")) ?? {};
             const environmentItems = (await store.metadataByKey("allure_environment")) ?? [];
@@ -80,6 +81,7 @@ export class Allure2Plugin {
                 reportFiles: context.reportFiles,
                 reportDataFiles,
                 reportUuid: context.reportUuid,
+                overviewHref: context.overviewHref,
             });
         });
         this.update = async (context, store) => {

package/dist/tree.js

@@ -1,5 +1,5 @@
-import { createHash } from "node:crypto";
 import { byStatistic, compareBy } from "@allurereport/core-api";
+import { md5 } from "@allurereport/plugin-api";
 import { calculateStatisticByLeafs } from "./utils.js";
 const rootNodeUid = "__ROOT__";
 const createLeaf = (endNode, test) => {
@@ -72,7 +72,6 @@ const groupByLabels = (test, labelNames) => {
 const groupUid = (parentUid, groupName) => {
     return md5(parentUid ? `${parentUid}.${groupName}` : groupName);
 };
-const md5 = (data) => createHash("md5").update(data).digest("hex");
 export const collapseTree = (treeGroup, separator = ".") => {
     const newChildren = treeGroup.children.map((c) => {
         if (!("children" in c)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allurereport/plugin-allure2",
-  "version": "3.20.1",
+  "version": "3.21.0",
   "description": "The Allure 2-compatible HTML report",
   "keywords": [
     "allure",
@@ -26,17 +26,20 @@
     "build": "run clean && tsc --project ./tsconfig.json && node ../../scripts/pack-report-static.mjs ../web-allure2/dist/multi ./dist/static/report.tar",
     "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/core-api": "3.20.1",
-    "@allurereport/plugin-api": "3.20.1",
-    "handlebars": "^4.7.9"
+    "@allurereport/core-api": "3.21.0",
+    "@allurereport/plugin-api": "3.21.0",
+    "handlebars": "4.7.10"
   },
   "devDependencies": {
-    "@allurereport/web-allure2": "3.20.1",
+    "@allurereport/test-config": "3.21.0",
+    "@allurereport/web-allure2": "3.21.0",
     "@types/node": "^20",
+    "@vitest/coverage-istanbul": "^4.1.0",
     "@vitest/runner": "^2",
     "allure-js-commons": "^3",
     "allure-vitest": "^3",