@allurereport/core-api 3.20.1 → 3.21.0

package/dist/aggregate.d.ts

@@ -12,6 +12,7 @@ export type Statistic = DiffStatistic & {
     unknown?: number;
     total: number;
     retries?: number;
+    retriesStatusChange?: number;
     flaky?: number;
     resolutions?: {
         issues?: number;

package/dist/categories.d.ts

@@ -84,6 +84,7 @@ export type CategoryNodeItem = {
     value?: string;
     retryHash?: string;
     retriesCount?: number;
+    retriesStatusChange?: boolean;
     transition?: TestStatusTransition;
     tooltips?: Record<string, string>;
     statistic?: Statistic;

package/dist/history.d.ts

@@ -6,6 +6,7 @@ export interface HistoryTestResult {
     fullName?: string;
     environment?: string;
     status: TestStatus;
+    retries?: TestStatus[];
     error?: TestError;
     start?: number;
     stop?: number;

package/dist/static.d.ts

@@ -11,6 +11,11 @@ export declare const appLoaderStyles = "\n  <style>\n    .allure-app-loader {\n
 export declare const createAppLoaderMarkup: () => string;
 export declare const createBaseUrlScript: () => string;
 export declare const stringifyForInlineScript: (value: unknown) => string;
+export declare const reportDataScriptPlaceholder = "<!-- allure-report-data -->";
+export declare const injectReportDataScript: (html: string, reportFiles?: {
+    name: string;
+    value: string;
+}[]) => Buffer;
 export declare const createReportDataScript: (reportFiles?: {
     name: string;
     value: string;

package/dist/static.js

@@ -90,6 +90,58 @@ export const stringifyForInlineScript = (value) => {
         .replaceAll("\u2028", "\\u2028")
         .replaceAll("\u2029", "\\u2029");
 };
+export const reportDataScriptPlaceholder = "<!-- allure-report-data -->";
+const createReportDataScriptChunks = (reportFiles = []) => {
+    if (!reportFiles.length) {
+        return [
+            Buffer.from(`
+      <script async>
+        window.allureReportDataReady = true;
+      </script>
+    `),
+        ];
+    }
+    const chunks = [
+        Buffer.from(`
+    <script async>
+      window.allureReportDataReady = false;
+      window.allureReportData = window.allureReportData || {};
+
+      function d(name, value){
+        return new Promise(function (resolve) {
+          window.allureReportData[name] = value;
+
+          return resolve(true);
+        });
+      }
+    </script>
+    <script defer>
+      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.allureReportDataReady = true;
+        })
+    </script>
+  `));
+    return chunks;
+};
+export const injectReportDataScript = (html, reportFiles = []) => {
+    const placeholderIndex = html.indexOf(reportDataScriptPlaceholder);
+    if (placeholderIndex === -1) {
+        throw new Error("Report data script placeholder is missing from the HTML template");
+    }
+    const prefix = html.slice(0, placeholderIndex);
+    const suffix = html.slice(placeholderIndex + reportDataScriptPlaceholder.length);
+    return Buffer.concat([
+        Buffer.from(prefix, "utf8"),
+        ...createReportDataScriptChunks(reportFiles),
+        Buffer.from(suffix, "utf8"),
+    ]);
+};
 export const createReportDataScript = (reportFiles = []) => {
     if (!reportFiles?.length) {
         return `
@@ -99,7 +151,7 @@ export const createReportDataScript = (reportFiles = []) => {
     `;
     }
     const reportFilesDeclaration = reportFiles
-        .map(({ name, value }) => `d(${JSON.stringify(name)},${JSON.stringify(value)})`)
+        .map(({ name, value }) => `d(${stringifyForInlineScript(name)},${stringifyForInlineScript(value)})`)
         .join(",");
     return `
     <script async>

package/dist/utils/status.d.ts

@@ -1,4 +1,5 @@
-import type { TestStatus } from "../model.js";
+import type { TestResult, TestStatus } from "../model.js";
 export declare const StatusByPriority: TestStatus[];
 export declare const statusToPriority: (status: TestStatus | undefined) => number;
 export declare const getWorstStatus: (items: TestStatus[]) => TestStatus | undefined;
+export declare const hasRetriesStatusChange: (current: Pick<TestResult, "status">, retries: readonly Pick<TestResult, "status">[]) => boolean;

package/dist/utils/status.js

@@ -1,3 +1,4 @@
+const retryStatusChangeStatuses = new Set(["failed", "broken", "passed"]);
 export const StatusByPriority = ["failed", "broken", "passed", "skipped", "unknown"];
 export const statusToPriority = (status) => {
     if (!status) {
@@ -11,3 +12,5 @@ export const getWorstStatus = (items) => {
     }
     return items.sort((a, b) => statusToPriority(a) - statusToPriority(b))[0];
 };
+export const hasRetriesStatusChange = (current, retries) => retryStatusChangeStatuses.has(current.status) &&
+    retries.some(({ status }) => retryStatusChangeStatuses.has(status) && status !== current.status);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allurereport/core-api",
-  "version": "3.20.1",
+  "version": "3.21.0",
   "description": "Allure Core API",
   "keywords": [
     "allure"
@@ -22,6 +22,7 @@
     "build": "run clean && tsc --project ./tsconfig.json",
     "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"
   },
@@ -29,8 +30,10 @@
     "d3-shape": "^3.2.0"
   },
   "devDependencies": {
+    "@allurereport/test-config": "3.21.0",
     "@types/d3-shape": "^3.1.8",
     "@types/node": "^20",
+    "@vitest/coverage-istanbul": "^4.1.0",
     "@vitest/runner": "^2",
     "@vitest/snapshot": "^5.0.1",
     "allure-js-commons": "^3",