@allurereport/core 3.21.0 → 3.22.0

package/dist/config.js

@@ -190,10 +190,13 @@ const validateFlakyDetectionConfig = (config) => {
     if (config === undefined) {
         return;
     }
-    const { historyDepth, includePassedTests } = config;
+    const { historyDepth, includePassedTests, stabilizationPeriod } = config;
     if (historyDepth !== undefined && (!Number.isInteger(historyDepth) || historyDepth < -1)) {
         throw new Error("flakyDetection.historyDepth must be an integer greater than or equal to -1");
     }
+    if (stabilizationPeriod !== undefined && (!Number.isInteger(stabilizationPeriod) || stabilizationPeriod < 1)) {
+        throw new Error("flakyDetection.stabilizationPeriod must be a positive integer");
+    }
     if (includePassedTests !== undefined && typeof includePassedTests !== "boolean") {
         throw new TypeError("flakyDetection.includePassedTests must be a boolean");
     }

package/dist/history.js

@@ -93,16 +93,6 @@ const closeStream = async (stream) => {
         stream.destroy();
     });
 };
-const closeFileHandle = async (file) => {
-    try {
-        await file.close();
-    }
-    catch (err) {
-        if (err?.code !== "EBADF") {
-            throw err;
-        }
-    }
-};
 export class AllureLocalHistory {
     constructor(params) {
         this.params = params;
@@ -221,7 +211,7 @@ export class AllureLocalHistory {
         }
         finally {
             await __classPrivateFieldGet(this, _AllureLocalHistory_closeStreams, "f").call(this, openedStreams);
-            await closeFileHandle(historyFile);
+            await historyFile.close();
         }
     }
     async appendHistory(data) {
@@ -255,7 +245,7 @@ export class AllureLocalHistory {
         }
         finally {
             await __classPrivateFieldGet(this, _AllureLocalHistory_closeStreams, "f").call(this, openedStreams);
-            await closeFileHandle(historyFile);
+            await historyFile.close();
             if (limit !== 0) {
                 __classPrivateFieldGet(this, _AllureLocalHistory_cachedHistory, "f").push(normalizedData);
             }

package/dist/qualityGate/qualityGate.js

@@ -65,8 +65,9 @@ export class QualityGate {
     async validate(payload) {
         const { state, trs, metrics = [], previousHistory = [], environment } = payload;
         const trsToValidateById = new Map();
+        const resolutionEvaluatedAt = Date.now();
         for (const tr of trs) {
-            if (tr.isRetry || isIgnoredFailure(tr) || state?.isTestResultProcessed(tr.id)) {
+            if (tr.isRetry || isIgnoredFailure(tr, resolutionEvaluatedAt) || state?.isTestResultProcessed(tr.id)) {
                 continue;
             }
             trsToValidateById.set(tr.id, tr);

package/dist/report.js

@@ -18,11 +18,11 @@ import { lstat, mkdtemp, readdir, rename, rm, writeFile } from "node:fs/promises
 import { tmpdir } from "node:os";
 import { basename, dirname, join, resolve } from "node:path";
 import { promisify } from "node:util";
-import { detect } from "@allurereport/ci";
+import { createReportCiContext, detect } from "@allurereport/ci";
 import { createProgressLogger } from "@allurereport/cli-commons";
 import { normalizeCategoriesConfig, parseIntegerConfigValue } from "@allurereport/core-api";
 import { AllureStoreDumpFiles, createTestResultRegistry, } from "@allurereport/plugin-api";
-import { allure1, allure2, attachments, cucumberjson, cucumberMessages, junitXml, readXcResultBundle, } from "@allurereport/reader";
+import { allure1, allure2, attachments, cucumberjson, cucumberMessages, junitXml, openTestReporting, readXcResultBundle, } from "@allurereport/reader";
 import { PathResultFile } from "@allurereport/reader-api";
 import { AllureRemoteHistory, AllureServiceClient, AllureTestOpsClient, KnownError, UnknownError, } from "@allurereport/service";
 import { generateSummary } from "@allurereport/summary";
@@ -898,6 +898,7 @@ export class AllureReport {
                 });
                 __classPrivateFieldGet(this, _AllureReport_finishGeneratePerfSpan, "f").call(this);
                 await __classPrivateFieldGet(this, _AllureReport_ingestSelfPerfMetrics, "f").call(this);
+                const ciContext = createReportCiContext(__classPrivateFieldGet(this, _AllureReport_ci, "f"));
                 await __classPrivateFieldGet(this, _AllureReport_eachPlugin, "f").call(this, false, async (plugin, context) => {
                     const summary = await plugin?.info?.(context, __classPrivateFieldGet(this, _AllureReport_store, "f"));
                     if (!summary) {
@@ -906,6 +907,7 @@ export class AllureReport {
                     summary.pluginId = context.id;
                     summary.pullRequestHref = __classPrivateFieldGet(this, _AllureReport_ci, "f")?.pullRequestUrl;
                     summary.jobHref = __classPrivateFieldGet(this, _AllureReport_ci, "f")?.jobRunUrl;
+                    Object.assign(summary, ciContext);
                     summaries.push({
                         ...summary,
                         href: `${context.id}/`,
@@ -1060,7 +1062,7 @@ export class AllureReport {
                 }
             }
         });
-        const { name, readers = [allure1, allure2, cucumberjson, cucumberMessages, junitXml, attachments], plugins = [], resolutions, reportFiles, realTime, historyPath, historyBaseUrl, historyLimit, flakyDetection, appendHistory, defaultLabels = {}, variables = {}, environment, allowedEnvironments, environments, output, hideLabels, qualityGate, performance, dump, categories, allureService, globalAttachments, cwd, } = opts;
+        const { name, readers = [allure1, allure2, cucumberjson, cucumberMessages, openTestReporting, junitXml, attachments], plugins = [], resolutions, reportFiles, realTime, historyPath, historyBaseUrl, historyLimit, flakyDetection, appendHistory, defaultLabels = {}, variables = {}, environment, allowedEnvironments, environments, output, hideLabels, qualityGate, performance, dump, categories, allureService, globalAttachments, cwd, } = opts;
         const allureServiceAccessToken = allureService?.accessToken;
         if (allureServiceAccessToken) {
             const allureServiceClientConfig = {

package/dist/resolutions.d.ts

@@ -11,7 +11,7 @@ export declare const KNOWN_FROM_RESULT_RESOLUTION: {
     readonly comment: "Accepted from result (known)";
 };
 export declare const getResolutionByRules: (testResult: TestResult, config?: ResolutionsConfig) => ResolutionRule | undefined;
-export declare const isIgnoredFailure: (testResult: TestResult) => boolean;
+export declare const isIgnoredFailure: (testResult: TestResult, now?: number) => boolean;
 export declare const createResolutionIssue: (rule: IssueResolutionRule, config?: ResolutionsConfig) => ResolutionIssue;
 export declare const resolveExactIssuesFilePath: (pathOrDir: string | undefined, label: string) => Promise<string | undefined>;
 export declare const writeKnownIssues: (store: AllureStore, knownIssuesPath?: string) => Promise<void>;

package/dist/resolutions.js

@@ -1,5 +1,6 @@
 import { mkdir, stat, writeFile } from "node:fs/promises";
 import { dirname, extname, resolve } from "node:path";
+import { isIgnoredResolution, parseResolutionExpiresAt } from "@allurereport/core-api";
 import { isFileNotFoundError } from "./utils/misc.js";
 export const DEFAULT_KNOWN_ISSUES_PATH = "known-issues.json";
 const nonEmpty = (value) => typeof value === "string" && value.trim().length > 0;
@@ -82,6 +83,14 @@ const validateIgnoredRule = (rule, path, errors) => {
     if (!nonEmpty(rule.comment)) {
         errors.push(`${path}.comment must be a non-empty string`);
     }
+    if (rule.resolution === "accepted" && rule.expiresAt !== undefined) {
+        errors.push(`${path}.expiresAt is only supported for muted resolutions`);
+    }
+    if (rule.resolution === "muted" &&
+        rule.expiresAt !== undefined &&
+        (!nonEmpty(rule.expiresAt) || parseResolutionExpiresAt(rule.expiresAt) === undefined)) {
+        errors.push(`${path}.expiresAt must be a JavaScript-compatible ISO 8601 timestamp with an explicit timezone`);
+    }
 };
 export const validateResolutionsConfig = (config) => {
     if (!config) {
@@ -154,7 +163,7 @@ export const getResolutionByRules = (testResult, config) => {
     }
     return undefined;
 };
-export const isIgnoredFailure = (testResult) => testResult.resolution === "muted" || testResult.resolution === "accepted";
+export const isIgnoredFailure = (testResult, now = Date.now()) => isIgnoredResolution(testResult, now);
 export const createResolutionIssue = (rule, config) => {
     const template = config?.links?.[rule.issue.type];
     const issue = { ...rule.issue, comment: rule.comment };

package/dist/store/store.js

@@ -723,7 +723,8 @@ export class DefaultAllureStore {
     }
     async blockingFailedTestResults() {
         const failedTestResults = await this.failedTestResults();
-        return failedTestResults.filter((tr) => !isIgnoredFailure(tr));
+        const resolutionEvaluatedAt = Date.now();
+        return failedTestResults.filter((tr) => !isIgnoredFailure(tr, resolutionEvaluatedAt));
     }
     async unknownFailedTestResults() {
         return this.blockingFailedTestResults();
@@ -943,6 +944,7 @@ export class DefaultAllureStore {
         for (const testResult of __classPrivateFieldGet(this, _DefaultAllureStore_testResults, "f").values()) {
             delete testResult.resolution;
             delete testResult.resolutionComment;
+            delete testResult.resolutionExpiresAt;
         }
         const normalizedEnvironments = environments
             .map((environmentValue) => {
@@ -993,6 +995,7 @@ export class DefaultAllureStore {
             __classPrivateFieldGet(this, _DefaultAllureStore_instances, "m", _DefaultAllureStore_removeResolutionIssueAssociation).call(this, testResult.id);
             delete testResult.resolution;
             delete testResult.resolutionComment;
+            delete testResult.resolutionExpiresAt;
             __classPrivateFieldGet(this, _DefaultAllureStore_testResults, "f").set(testResult.id, testResult);
             const envId = __classPrivateFieldGet(this, _DefaultAllureStore_instances, "m", _DefaultAllureStore_environmentIdByTestResult).call(this, testResult);
             __classPrivateFieldGet(this, _DefaultAllureStore_instances, "m", _DefaultAllureStore_assertAllowedEnvironmentId).call(this, envId, `restored testResults[${JSON.stringify(testResult.id)}]`);
@@ -1202,6 +1205,10 @@ _DefaultAllureStore_testResults = new WeakMap(), _DefaultAllureStore_attachments
     __classPrivateFieldGet(this, _DefaultAllureStore_instances, "m", _DefaultAllureStore_removeResolutionIssueAssociation).call(this, testResult.id);
     testResult.resolution = rule.resolution;
     testResult.resolutionComment = rule.comment;
+    delete testResult.resolutionExpiresAt;
+    if (rule.resolution === "muted" && rule.expiresAt !== undefined) {
+        testResult.resolutionExpiresAt = rule.expiresAt;
+    }
     if (rule.resolution === "issue") {
         __classPrivateFieldGet(this, _DefaultAllureStore_instances, "m", _DefaultAllureStore_associateResolutionIssue).call(this, createResolutionIssue(rule, __classPrivateFieldGet(this, _DefaultAllureStore_resolutionsConfig, "f")), testResult.id);
     }
@@ -1302,13 +1309,11 @@ _DefaultAllureStore_testResults = new WeakMap(), _DefaultAllureStore_attachments
 }, _DefaultAllureStore_getHistoryLookup = function _DefaultAllureStore_getHistoryLookup() {
     return (__classPrivateFieldSet(this, _DefaultAllureStore_historyLookup, __classPrivateFieldGet(this, _DefaultAllureStore_historyLookup, "f") ?? createHistoryTestResultLookup(__classPrivateFieldGet(this, _DefaultAllureStore_testResults, "f").values()), "f"));
 }, _DefaultAllureStore_historyFor = function _DefaultAllureStore_historyFor(result, lookup) {
-    return __classPrivateFieldGet(this, _DefaultAllureStore_historyPoints, "f").flatMap((point) => {
-        const historicalResult = lookup(point, result);
-        return historicalResult ? [historicalResult] : [];
-    });
+    return __classPrivateFieldGet(this, _DefaultAllureStore_historyPoints, "f").map((point) => lookup(point, result));
 }, _DefaultAllureStore_applyHistoryFlags = function _DefaultAllureStore_applyHistoryFlags(result, history) {
     result.flaky = result.sourceMetadata?.reportedFlaky === true || __classPrivateFieldGet(this, _DefaultAllureStore_detectFlaky, "f").call(this, result, history);
-    result.transition = getStatusTransition(result, history);
+    const resolvedHistory = history.filter((entry) => entry !== undefined);
+    result.transition = getStatusTransition(result, resolvedHistory);
 }, _DefaultAllureStore_restoreAttachmentContent = function _DefaultAllureStore_restoreAttachmentContent(id, content) {
     const attachment = __classPrivateFieldGet(this, _DefaultAllureStore_attachments, "f").get(id);
     __classPrivateFieldGet(this, _DefaultAllureStore_attachmentContents, "f").set(id, content);

package/dist/utils/flaky.d.ts

@@ -1,2 +1,2 @@
-import { type FlakyDetectionConfig, type HistoryTestResult, type TestResult } from "@allurereport/core-api";
-export declare const createFlakyDetector: ({ historyDepth, includePassedTests, }?: FlakyDetectionConfig) => ((tr: TestResult, history: HistoryTestResult[]) => boolean);
+import { type HistoryTestResult, type FlakyDetectionConfig, type TestResult } from "@allurereport/core-api";
+export declare const createFlakyDetector: ({ includePassedTests, historyDepth, stabilizationPeriod }?: FlakyDetectionConfig) => (tr: TestResult, history: (HistoryTestResult | undefined)[]) => boolean;

package/dist/utils/flaky.js

@@ -1,40 +1,7 @@
-import { DEFAULT_ENVIRONMENT, } from "@allurereport/core-api";
-const DEFAULT_HISTORY_DEPTH = 5;
-const TRANSITION_HALF_LIFE = 2;
-const STABILITY_PRIOR_WEIGHT = 3;
-const FLAKY_SCORE_THRESHOLD = 30;
-const badStatuses = ["failed", "broken"];
-const isFlakyByWeightedTransitions = (tr, history, historyDepth, includePassedTests) => {
-    const currentPassed = tr.status === "passed";
-    const isEligibleStatus = badStatuses.includes(tr.status) || (includePassedTests && currentPassed);
-    if (historyDepth === -1 || !isEligibleStatus) {
+import { getTestFlakiness, } from "@allurereport/core-api";
+export const createFlakyDetector = ({ includePassedTests = false, historyDepth, stabilizationPeriod } = {}) => (tr, history) => {
+    if (tr.status !== "failed" && tr.status !== "broken" && !(includePassedTests && tr.status === "passed")) {
         return false;
     }
-    let previousPassed = currentPassed;
-    let comparisons = 0;
-    let weightedTransitions = 0;
-    let totalWeight = 0;
-    for (const result of history) {
-        if (historyDepth !== 0 && comparisons >= historyDepth) {
-            break;
-        }
-        if (result.id === tr.id ||
-            (result.environment ?? DEFAULT_ENVIRONMENT) !== (tr.environment ?? DEFAULT_ENVIRONMENT) ||
-            (result.status !== "passed" && !badStatuses.includes(result.status))) {
-            continue;
-        }
-        const passed = result.status === "passed";
-        const weight = 2 ** (-comparisons / TRANSITION_HALF_LIFE);
-        if (passed !== previousPassed) {
-            weightedTransitions += weight;
-        }
-        totalWeight += weight;
-        previousPassed = passed;
-        comparisons++;
-    }
-    const score = (100 * weightedTransitions) / (STABILITY_PRIOR_WEIGHT + totalWeight);
-    return score >= FLAKY_SCORE_THRESHOLD;
-};
-export const createFlakyDetector = ({ historyDepth = DEFAULT_HISTORY_DEPTH, includePassedTests = false, } = {}) => {
-    return (tr, history) => isFlakyByWeightedTransitions(tr, history, historyDepth, includePassedTests);
+    return getTestFlakiness(tr, history, { historyDepth, stabilizationPeriod }) === true;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allurereport/core",
-  "version": "3.21.0",
+  "version": "3.22.0",
   "description": "Collection of generic Allure utilities used across the entire project",
   "keywords": [
     "allure"
@@ -20,34 +20,34 @@
   "scripts": {
     "build": "run clean && tsc --project ./tsconfig.json",
     "clean": "rimraf ./dist",
-    "test": "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/ci": "3.21.0",
-    "@allurereport/cli-commons": "3.21.0",
-    "@allurereport/core-api": "3.21.0",
-    "@allurereport/plugin-agent": "3.21.0",
-    "@allurereport/plugin-allure2": "3.21.0",
-    "@allurereport/plugin-api": "3.21.0",
-    "@allurereport/plugin-awesome": "3.21.0",
-    "@allurereport/plugin-classic": "3.21.0",
-    "@allurereport/plugin-csv": "3.21.0",
-    "@allurereport/plugin-dashboard": "3.21.0",
-    "@allurereport/plugin-jira": "3.21.0",
-    "@allurereport/plugin-log": "3.21.0",
-    "@allurereport/plugin-metrics": "3.21.0",
-    "@allurereport/plugin-progress": "3.21.0",
-    "@allurereport/plugin-slack": "3.21.0",
-    "@allurereport/plugin-testops": "3.21.0",
-    "@allurereport/plugin-testplan": "3.21.0",
-    "@allurereport/plugin-xray": "3.21.0",
-    "@allurereport/reader": "3.21.0",
-    "@allurereport/reader-api": "3.21.0",
-    "@allurereport/service": "3.21.0",
-    "@allurereport/summary": "3.21.0",
+    "@allurereport/ci": "3.22.0",
+    "@allurereport/cli-commons": "3.22.0",
+    "@allurereport/core-api": "3.22.0",
+    "@allurereport/plugin-agent": "3.22.0",
+    "@allurereport/plugin-allure2": "3.22.0",
+    "@allurereport/plugin-api": "3.22.0",
+    "@allurereport/plugin-awesome": "3.22.0",
+    "@allurereport/plugin-classic": "3.22.0",
+    "@allurereport/plugin-csv": "3.22.0",
+    "@allurereport/plugin-dashboard": "3.22.0",
+    "@allurereport/plugin-jira": "3.22.0",
+    "@allurereport/plugin-log": "3.22.0",
+    "@allurereport/plugin-metrics": "3.22.0",
+    "@allurereport/plugin-progress": "3.22.0",
+    "@allurereport/plugin-slack": "3.22.0",
+    "@allurereport/plugin-testops": "3.22.0",
+    "@allurereport/plugin-testplan": "3.22.0",
+    "@allurereport/plugin-xray": "3.22.0",
+    "@allurereport/reader": "3.22.0",
+    "@allurereport/reader-api": "3.22.0",
+    "@allurereport/service": "3.22.0",
+    "@allurereport/summary": "3.22.0",
     "glob": "^13.0.6",
     "handlebars": "4.7.10",
     "jiti": "^2.5.1",
@@ -58,17 +58,19 @@
     "zip-stream": "^7.0.5"
   },
   "devDependencies": {
-    "@allurereport/test-config": "3.21.0",
+    "@allurereport/common-config": "3.22.0",
     "@types/node": "^20",
     "@types/zip-stream": "^7.0.0",
-    "@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",
     "tslib": "^2.7.0",
     "typescript": "^5",
-    "vitest": "^4.1.0"
+    "vite": "@voidzero-dev/vite-plus-core@1.2.0",
+    "vite-plus": "1.2.0",
+    "vitest": "5.0.4"
   }
 }