@allurereport/core-api 3.20.1 → 3.22.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;
@@ -104,7 +105,7 @@ export declare const matchCategoryMatcher: (matcher: Matcher, d: CategoryMatchin
 export declare const matchCategory: (categories: CategoryDefinition[], d: CategoryMatchingData) => CategoryDefinition | undefined;
 export declare const extractErrorMatchingData: (tr: Pick<TestResult, "status" | "labels" | "error" | "flaky" | "duration" | "transition" | "environment">) => CategoryMatchingData;
 export declare const buildEnvironmentSortOrder: (environmentNames: string[], defaultEnvironmentName: string) => Map<string, number>;
-export declare const compareNumbers: (left: number, right: number) => 0 | 1 | -1;
+export declare const compareNumbers: (left: number, right: number) => 1 | -1 | 0;
 export declare const compareStrings: (left: string, right: string) => number;
 export declare const isMissingValue: (value: string | undefined) => boolean;
 export declare const getGroupSortKey: (groupKey: string | undefined, groupValue: string | undefined, environmentOrderMap?: Map<string, number>) => GroupSortKey;

package/dist/ci.d.ts

@@ -21,6 +21,8 @@ export interface CiDescriptor {
     jobRunUrl: string;
     jobRunName: string;
     jobRunBranch: string;
+    pipelineRunName?: string;
+    pipelineRunUrl?: string;
     pullRequestName: string;
     pullRequestUrl: string;
     provider?: GitProvider;
@@ -28,4 +30,6 @@ export interface CiDescriptor {
     sourceBranch?: string;
     targetBranch?: string;
     pullRequest?: GitPullRequestRef;
+    commitSha?: string;
+    commitUrl?: string;
 }

package/dist/config.d.ts

@@ -1,6 +1,7 @@
 export type DefaultLabelsConfig = Record<string, string | string[]>;
 export type FlakyDetectionConfig = {
     historyDepth?: number;
+    stabilizationPeriod?: number;
     includePassedTests?: boolean;
 };
 export declare const parseIntegerConfigValue: (value: unknown, minValue?: number) => number | undefined;

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/index.d.ts

@@ -4,7 +4,7 @@ export * from "./ci.js";
 export * from "./gitFlow.js";
 export type * from "./environment.js";
 export type * from "./history.js";
-export type * from "./resolutions.js";
+export * from "./resolutions.js";
 export type * from "./metadata.js";
 export * from "./metrics.js";
 export type * from "./model.js";
@@ -25,6 +25,7 @@ export * from "./utils/status.js";
 export * from "./utils/successRate.js";
 export * from "./utils/environment.js";
 export * from "./utils/history.js";
+export * from "./utils/flaky.js";
 export * from "./utils/identity.js";
 export * from "./utils/strings.js";
 export * from "./utils/dictionary.js";

package/dist/index.js

@@ -1,6 +1,7 @@
 export * from "./constants.js";
 export * from "./ci.js";
 export * from "./gitFlow.js";
+export * from "./resolutions.js";
 export * from "./metrics.js";
 export * from "./config.js";
 export * from "./static.js";
@@ -16,6 +17,7 @@ export * from "./utils/status.js";
 export * from "./utils/successRate.js";
 export * from "./utils/environment.js";
 export * from "./utils/history.js";
+export * from "./utils/flaky.js";
 export * from "./utils/identity.js";
 export * from "./utils/strings.js";
 export * from "./utils/dictionary.js";

package/dist/model.d.ts

@@ -57,6 +57,7 @@ export interface TestResult {
     known: boolean;
     resolution?: ResolutionCategory;
     resolutionComment?: string;
+    resolutionExpiresAt?: string;
     transition?: TestStatusTransition;
     retryHash: string | null;
     isRetry: boolean;

package/dist/resolutions.d.ts

@@ -1,6 +1,7 @@
 import type { TestLink } from "./metadata.js";
-import type { TestError, TestStatus } from "./model.js";
+import type { TestError, TestResult, TestStatus } from "./model.js";
 export type ResolutionCategory = "issue" | "muted" | "accepted";
+export type MutedResolutionState = "active" | "outdated" | "permanent";
 export interface ResolutionLinkTemplate {
     nameTemplate?: string;
     urlTemplate: string;
@@ -22,8 +23,19 @@ export interface IssueResolutionRule extends ResolutionMatcher {
 export interface IgnoredResolutionRule extends ResolutionMatcher {
     resolution: "muted" | "accepted";
     comment: string;
+    expiresAt?: string;
+}
+export interface MutedResolutionRule extends IgnoredResolutionRule {
+    resolution: "muted";
+}
+export interface AcceptedResolutionRule extends IgnoredResolutionRule {
+    resolution: "accepted";
 }
 export type ResolutionRule = IssueResolutionRule | IgnoredResolutionRule;
+type ResolutionStateSource = Pick<TestResult, "resolution" | "resolutionExpiresAt">;
+export declare const parseResolutionExpiresAt: (value: string) => number | undefined;
+export declare const getMutedResolutionState: (testResult: ResolutionStateSource, now?: number) => MutedResolutionState | undefined;
+export declare const isIgnoredResolution: (testResult: ResolutionStateSource, now?: number) => boolean;
 export interface ResolutionsConfig {
     knownIssuesPath?: string;
     links?: Record<string, ResolutionLinkTemplate>;
@@ -48,3 +60,4 @@ export interface KnownIssueRecord extends ResolutionIssue {
 export interface KnownIssuesFile {
     resolutionIssues: KnownIssueRecord[];
 }
+export {};

package/dist/resolutions.js

@@ -1 +1,39 @@
-export {};
+export const parseResolutionExpiresAt = (value) => {
+    const match = /^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})(?:\.\d+)?(?:Z|[+-](\d{2}):(\d{2}))$/.exec(value);
+    if (!match) {
+        return undefined;
+    }
+    const [, yearValue, monthValue, dayValue, hourValue, minuteValue, secondValue, offsetHour, offsetMinute] = match;
+    const year = Number(yearValue);
+    const month = Number(monthValue);
+    const day = Number(dayValue);
+    const hour = Number(hourValue);
+    const minute = Number(minuteValue);
+    const second = Number(secondValue);
+    const leapYear = year % 4 === 0 && (year % 100 !== 0 || year % 400 === 0);
+    const daysInMonth = [31, leapYear ? 29 : 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31][month - 1];
+    if (year <= 0 ||
+        daysInMonth === undefined ||
+        day < 1 ||
+        day > daysInMonth ||
+        hour > 23 ||
+        minute > 59 ||
+        second > 59 ||
+        (offsetHour !== undefined && (Number(offsetHour) > 23 || Number(offsetMinute) > 59))) {
+        return undefined;
+    }
+    const timestamp = new Date(value).getTime();
+    return Number.isFinite(timestamp) ? timestamp : undefined;
+};
+export const getMutedResolutionState = (testResult, now = Date.now()) => {
+    if (testResult.resolution !== "muted") {
+        return undefined;
+    }
+    if (testResult.resolutionExpiresAt === undefined) {
+        return "permanent";
+    }
+    const expiresAt = parseResolutionExpiresAt(testResult.resolutionExpiresAt);
+    return expiresAt === undefined || now >= expiresAt ? "outdated" : "active";
+};
+export const isIgnoredResolution = (testResult, now = Date.now()) => testResult.resolution === "accepted" ||
+    (testResult.resolution === "muted" && getMutedResolutionState(testResult, now) !== "outdated");

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/flaky.d.ts

@@ -0,0 +1,5 @@
+import type { FlakyDetectionConfig } from "../config.js";
+import type { HistoryTestResult } from "../history.js";
+import type { TestResult } from "../model.js";
+export type FlakinessOptions = Pick<FlakyDetectionConfig, "historyDepth" | "stabilizationPeriod">;
+export declare const getTestFlakiness: (current: TestResult, history: (HistoryTestResult | undefined)[], options?: FlakinessOptions) => boolean | undefined;

package/dist/utils/flaky.js

@@ -0,0 +1,44 @@
+const SIGNIFICANT_STATUSES = new Set(["passed", "failed", "broken"]);
+export const getTestFlakiness = (current, history, options = {}) => {
+    const { historyDepth = 10, stabilizationPeriod = 5 } = options;
+    if (historyDepth === -1 || !SIGNIFICANT_STATUSES.has(current.status)) {
+        return undefined;
+    }
+    const statuses = [];
+    for (const result of history) {
+        if (result === undefined) {
+            break;
+        }
+        if (result.id === current.id || !SIGNIFICANT_STATUSES.has(result.status)) {
+            continue;
+        }
+        statuses.push(result.status);
+        if (historyDepth > 0 && statuses.length === historyDepth) {
+            break;
+        }
+    }
+    if (statuses.length === 0) {
+        return undefined;
+    }
+    statuses.reverse();
+    statuses.push(current.status);
+    const period = historyDepth > 0 ? Math.min(stabilizationPeriod, historyDepth + 1) : stabilizationPeriod;
+    let anchor = 0;
+    let streak = 0;
+    for (let index = 0; index < statuses.length; index++) {
+        streak = index > 0 && statuses[index] === statuses[index - 1] ? streak + 1 : 1;
+        if (streak >= period) {
+            anchor = index;
+        }
+    }
+    let changes = 0;
+    for (let index = anchor + 1; index < statuses.length; index++) {
+        if (statuses[index] !== statuses[index - 1]) {
+            changes++;
+        }
+    }
+    if (changes <= 1) {
+        return false;
+    }
+    return !(changes === 2 && statuses[anchor] === "passed" && current.status === "passed");
+};

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.22.0",
   "description": "Allure Core API",
   "keywords": [
     "allure"
@@ -21,22 +21,27 @@
   "scripts": {
     "build": "run clean && tsc --project ./tsconfig.json",
     "clean": "rimraf ./dist",
-    "test": "rimraf ./out && vitest run",
-    "lint": "oxlint --import-plugin src test features stories",
-    "lint:fix": "oxlint --import-plugin --fix src test features stories"
+    "test": "rimraf out && vp test run",
+    "test:unit": "yarn test",
+    "lint": "vp lint --import-plugin src test features stories",
+    "lint:fix": "vp lint --import-plugin --fix src test features stories"
   },
   "dependencies": {
     "d3-shape": "^3.2.0"
   },
   "devDependencies": {
+    "@allurereport/common-config": "3.22.0",
     "@types/d3-shape": "^3.1.8",
     "@types/node": "^20",
+    "@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"
   }
 }