@allurereport/plugin-api 3.21.0 → 3.22.1

package/README.md

@@ -16,6 +16,10 @@
 
 The interfaces in the package describe the entities used for building Allure Plugins.
 
+## Internal report utilities
+
+The `@allurereport/plugin-api/internal/report` subpath is reserved for Allure's bundled report generators and frontends. It is not part of the supported plugin API and may change without a major version bump. Third-party plugins should use the documented API entry points.
+
 ## Install
 
 Use your favorite package manager to install the package:

package/dist/plugin.d.ts

@@ -42,9 +42,14 @@ export interface TestResultRegistry {
 export type SummaryCheckResult = Pick<AllureCheckResult, "id" | "name" | "status">;
 export type { GlobalAttachmentLink } from "@allurereport/core-api";
 export interface PluginSummary {
+    published?: boolean;
     href?: string;
     remoteHref?: string;
     jobHref?: string;
+    ciRunName?: string;
+    ciRunHref?: string;
+    commitSha?: string;
+    commitHref?: string;
     pullRequestHref?: string;
     name: string;
     stats: Statistic;

package/dist/report.d.ts

@@ -1,4 +1,4 @@
-import type { AttachmentTestStepResult, CiDescriptor, DefaultTreeGroup, HistoryTestResult, ResolutionCategory, ResolutionIssue, TestFixtureResult, TestResult, TestStatus, TestStepResult, TreeData, WithChildren } from "@allurereport/core-api";
+import type { AttachmentTestStepResult, CiDescriptor, DefaultTreeGroup, HistoryTestResult, MutedResolutionState, ResolutionCategory, ResolutionIssue, TestFixtureResult, TestResult, TestStatus, TestStepResult, TreeData, WithChildren } from "@allurereport/core-api";
 import type { QualityGateValidationResult } from "./qualityGate.js";
 export type Layout = "base" | "split";
 export type StepTreeExpansion = "collapsed" | "expand_failed_only" | "expanded";
@@ -17,6 +17,10 @@ export type ReportExecutorInfo = {
     reportName?: string;
     reportUrl?: string;
 };
+export type ReportGitInfo = {
+    commit: string;
+    branch?: string;
+};
 export type ReportOptions = {
     id?: string;
     allureVersion: string;
@@ -32,6 +36,7 @@ export type ReportOptions = {
     sections?: string[];
     cacheKey?: string;
     ci?: CiDescriptor;
+    git?: ReportGitInfo;
     executor?: ReportExecutorInfo;
     runSummary?: ReportRunSummary;
     runSummaryByEnv?: Record<string, ReportRunSummary>;
@@ -60,7 +65,7 @@ export interface ReportCategory {
     matchedStatuses?: TestStatus[];
     flaky?: boolean;
 }
-export type ReportTestResult = Omit<TestResult, "runSelector" | "sourceMetadata" | "expectedResult" | "expectedResultHtml" | "precondition" | "preconditionHtml" | "steps" | "categories" | "environment"> & {
+export type ReportTestResult = Omit<TestResult, "runSelector" | "sourceMetadata" | "expectedResult" | "precondition" | "steps" | "categories" | "environment"> & {
     isRetry: boolean;
     setup: ReportFixtureResult[];
     teardown: ReportFixtureResult[];
@@ -78,13 +83,14 @@ export type ReportTestResult = Omit<TestResult, "runSelector" | "sourceMetadata"
     categories?: ReportCategory[];
     environment?: string | "default";
     resolutionIssue?: ResolutionIssue;
+    resolutionState?: MutedResolutionState;
     tooltips?: Record<string, string>;
     time?: Record<string, string[]>;
     extra?: {
         severity: string;
     };
 };
-export type ReportTreeLeaf = Pick<ReportTestResult, "duration" | "name" | "start" | "status" | "groupOrder" | "flaky" | "transition" | "retry" | "retriesCount" | "retriesStatusChange" | "resolution"> & {
+export type ReportTreeLeaf = Pick<ReportTestResult, "duration" | "name" | "start" | "status" | "groupOrder" | "flaky" | "transition" | "retry" | "retriesCount" | "retriesStatusChange" | "resolution" | "resolutionExpiresAt"> & {
     nodeId: string;
     id?: string;
     transitionTooltip?: string;
@@ -93,6 +99,7 @@ export type ReportTreeLeaf = Pick<ReportTestResult, "duration" | "name" | "start
     categories?: string[];
     severity?: string;
     resolutionStatus?: ResolutionCategory | "none";
+    resolutionState?: MutedResolutionState;
     parameters?: string[];
 };
 export type ReportTreeGroup = WithChildren & DefaultTreeGroup & {
@@ -126,6 +133,8 @@ export type ReportResolutionGroup = {
     resolution: ResolutionCategory;
     name: string;
     comment?: string;
+    expiresAt?: string;
+    resolutionState?: MutedResolutionState;
     issue?: ResolutionIssue;
     testResults: ReportResolutionTestResult[];
 };

package/dist/singleFileAssets.d.ts

@@ -0,0 +1,3 @@
+export declare const createSingleFileScripts: (files: ReadonlyMap<string, Buffer>, mainJs: string, { compress }?: {
+    compress?: boolean;
+}) => string;

package/dist/singleFileAssets.js

@@ -0,0 +1,89 @@
+import { gzipSync } from "node:zlib";
+import { stringifyForInlineScript } from "@allurereport/core-api";
+const embeddedAssetsElementId = "allure-single-file-assets";
+export const createSingleFileScripts = (files, mainJs, { compress = true } = {}) => {
+    const encodedScripts = Object.fromEntries([...files]
+        .filter(([fileName]) => fileName.endsWith(".js"))
+        .map(([fileName, content]) => [
+        fileName,
+        (compress ? gzipSync(content, { level: 9 }) : content).toString("base64"),
+    ]));
+    const licenses = Object.fromEntries([...files]
+        .filter(([fileName]) => fileName.endsWith(".LICENSE.txt"))
+        .map(([fileName, content]) => [fileName, content.toString("utf8")]));
+    if (!encodedScripts[mainJs]) {
+        throw new Error(`The report static assets do not contain the main script: ${mainJs}`);
+    }
+    return `
+    <script id="allure-single-file-licenses" type="application/json">${stringifyForInlineScript(licenses)}</script>
+    <script id="${embeddedAssetsElementId}" type="application/json">${stringifyForInlineScript(encodedScripts)}</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 decodeAsset(encoded) {
+          const binary = atob(encoded);
+          const bytes = new Uint8Array(binary.length);
+
+          for (let index = 0; index < binary.length; index++) {
+            bytes[index] = binary.charCodeAt(index);
+          }
+
+          ${compress
+        ? `const stream = new Response(bytes).body.pipeThrough(new DecompressionStream("gzip"));
+          return new Response(stream).text();`
+        : "return new Response(bytes).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 decodeAsset(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/dist/staticAssets.d.ts

@@ -7,3 +7,4 @@ export type ReportStaticAssets = {
 export declare const readReportStaticAssets: (archive: string | URL) => Promise<ReportStaticAssets>;
 export declare const getReportStaticAsset: (assets: ReportStaticAssets, fileName: string) => Buffer;
 export declare const copyReportStaticAssets: (assets: ReportStaticAssets, reportFiles: ReportFiles) => Promise<void>;
+export { createSingleFileScripts } from "./singleFileAssets.js";

package/dist/staticAssets.js

@@ -103,3 +103,4 @@ export const copyReportStaticAssets = async (assets, reportFiles) => {
         await reportFiles.addFile(fileName, content);
     }
 };
+export { createSingleFileScripts } from "./singleFileAssets.js";

package/dist/utils/report.d.ts

@@ -0,0 +1,11 @@
+import { type HistoryDataPoint, type TestFixtureResult, type TestStepResult } from "@allurereport/core-api";
+import type { ReportFixtureResult, ReportTestStepResult } from "../report.js";
+import type { AllureStore } from "../store.js";
+export declare const HISTORY_DATA_POINT_LIMIT = 6;
+export declare const writeConcurrently: <T>(items: readonly T[], write: (item: T) => Promise<void>, concurrency?: number) => Promise<void>;
+export declare const mapConcurrently: <T, R>(items: readonly T[], map: (item: T) => Promise<R>, concurrency?: number) => Promise<R[]>;
+export declare const convertTestStepResult: (tsr: TestStepResult) => ReportTestStepResult;
+export declare const convertFixtureResult: (fr: TestFixtureResult) => ReportFixtureResult;
+export declare const generateHistoryDataPoints: (writer: {
+    writeData: (fileName: string, data: HistoryDataPoint) => Promise<void>;
+}, store: Pick<AllureStore, "allHistoryDataPoints">) => Promise<void>;

package/dist/utils/report.js

@@ -0,0 +1,40 @@
+import { isStep, redactParameters, } from "@allurereport/core-api";
+export const HISTORY_DATA_POINT_LIMIT = 6;
+export const writeConcurrently = async (items, write, concurrency = 64) => {
+    for (let i = 0; i < items.length; i += concurrency) {
+        await Promise.all(items.slice(i, i + concurrency).map(write));
+    }
+};
+export const mapConcurrently = async (items, map, concurrency = 8) => {
+    const results = [];
+    for (let i = 0; i < items.length; i += concurrency) {
+        results.push(...(await Promise.all(items.slice(i, i + concurrency).map(map))));
+    }
+    return results;
+};
+export const convertTestStepResult = (tsr) => {
+    if (isStep(tsr)) {
+        return {
+            ...tsr,
+            parameters: redactParameters(tsr.parameters),
+            steps: (tsr.steps ?? []).map(convertTestStepResult),
+        };
+    }
+    return tsr;
+};
+export const convertFixtureResult = (fr) => {
+    return {
+        id: fr.id,
+        type: fr.type,
+        name: fr.name,
+        status: fr.status,
+        steps: fr.steps.map(convertTestStepResult),
+        duration: fr.duration,
+    };
+};
+export const generateHistoryDataPoints = async (writer, store) => {
+    const allHistoryPoints = await store.allHistoryDataPoints();
+    for (const historyPoint of allHistoryPoints.slice(0, HISTORY_DATA_POINT_LIMIT)) {
+        await writer.writeData(`history/${historyPoint.uuid}.json`, historyPoint);
+    }
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allurereport/plugin-api",
-  "version": "3.21.0",
+  "version": "3.22.1",
   "description": "Allure Plugin API",
   "keywords": [
     "allure"
@@ -17,33 +17,43 @@
   "main": "./dist/index.js",
   "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "internal/report": [
+        "dist/utils/report.d.ts"
+      ]
+    }
+  },
   "exports": {
     ".": "./dist/index.js",
-    "./static-assets": "./dist/staticAssets.js"
+    "./static-assets": "./dist/staticAssets.js",
+    "./internal/report": "./dist/utils/report.js"
   },
   "scripts": {
     "build": "run clean && tsc --project ./tsconfig.json",
     "clean": "rimraf ./dist",
-    "test": "rimraf ./out && vitest run",
+    "test": "rimraf out && vp test run",
     "test:unit": "yarn test",
-    "lint": "oxlint --import-plugin src test features stories",
-    "lint:fix": "oxlint --import-plugin --fix src test features stories"
+    "lint": "vp lint --import-plugin src test features stories",
+    "lint:fix": "vp lint --import-plugin --fix src test features stories"
   },
   "dependencies": {
-    "@allurereport/core-api": "3.21.0",
+    "@allurereport/core-api": "3.22.1",
     "tar-stream": "3.1.7"
   },
   "devDependencies": {
-    "@allurereport/test-config": "3.21.0",
+    "@allurereport/common-config": "3.22.1",
     "@types/node": "^20",
     "@types/tar-stream": "^3.1.4",
-    "@vitest/coverage-istanbul": "^4.1.0",
+    "@vitest/coverage-istanbul": "5.0.4",
     "@vitest/runner": "^2",
-    "@vitest/snapshot": "^5.0.1",
+    "@vitest/snapshot": "5.0.4",
     "allure-js-commons": "^3",
     "allure-vitest": "^3",
     "rimraf": "^6",
     "typescript": "^5",
-    "vitest": "^4.1.0"
+    "vite": "@voidzero-dev/vite-plus-core@1.2.0",
+    "vite-plus": "1.2.0",
+    "vitest": "5.0.4"
   }
 }