@allurereport/core 3.18.0 → 3.19.0

package/dist/utils/event.js

@@ -9,7 +9,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
     return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
 };
-var _RealtimeEventsDispatcher_emitter, _RealtimeSubscriber_instances, _RealtimeSubscriber_emitter, _RealtimeSubscriber_handlers, _RealtimeSubscriber_onEvent, _RealtimeSubscriber_onBatchedEvent, _RealtimeSubscriber_createBatchHandler, _RealtimeSubscriber_runBatchHandler, _RealtimeSubscriber_disposeBatchHandler;
+var _RealtimeEventsDispatcher_emitter, _RealtimeSubscriber_instances, _RealtimeSubscriber_emitter, _RealtimeSubscriber_beforeTestResults, _RealtimeSubscriber_handlers, _RealtimeSubscriber_onEvent, _RealtimeSubscriber_onBatchedEvent, _RealtimeSubscriber_createBatchHandler, _RealtimeSubscriber_runBatchHandler, _RealtimeSubscriber_disposeBatchHandler;
 import console from "node:console";
 import { setTimeout } from "node:timers/promises";
 export var RealtimeEvents;
@@ -77,11 +77,13 @@ export class RealtimeEventsDispatcher {
 }
 _RealtimeEventsDispatcher_emitter = new WeakMap();
 export class RealtimeSubscriber {
-    constructor(emitter) {
+    constructor(emitter, beforeTestResults) {
         _RealtimeSubscriber_instances.add(this);
         _RealtimeSubscriber_emitter.set(this, void 0);
+        _RealtimeSubscriber_beforeTestResults.set(this, void 0);
         _RealtimeSubscriber_handlers.set(this, []);
         __classPrivateFieldSet(this, _RealtimeSubscriber_emitter, emitter, "f");
+        __classPrivateFieldSet(this, _RealtimeSubscriber_beforeTestResults, beforeTestResults, "f");
     }
     onGlobalAttachment(listener) {
         return __classPrivateFieldGet(this, _RealtimeSubscriber_instances, "m", _RealtimeSubscriber_onEvent).call(this, RealtimeEvents.GlobalAttachment, listener);
@@ -105,7 +107,10 @@ export class RealtimeSubscriber {
         return __classPrivateFieldGet(this, _RealtimeSubscriber_instances, "m", _RealtimeSubscriber_onEvent).call(this, RealtimeEvents.QualityGateResults, listener);
     }
     onTestResults(listener, options = {}) {
-        return __classPrivateFieldGet(this, _RealtimeSubscriber_instances, "m", _RealtimeSubscriber_onBatchedEvent).call(this, RealtimeEvents.TestResult, listener, options);
+        return __classPrivateFieldGet(this, _RealtimeSubscriber_instances, "m", _RealtimeSubscriber_onBatchedEvent).call(this, RealtimeEvents.TestResult, (trIds) => {
+            __classPrivateFieldGet(this, _RealtimeSubscriber_beforeTestResults, "f")?.call(this);
+            return listener(trIds);
+        }, options);
     }
     onTestFixtureResults(listener, options = {}) {
         return __classPrivateFieldGet(this, _RealtimeSubscriber_instances, "m", _RealtimeSubscriber_onBatchedEvent).call(this, RealtimeEvents.TestFixtureResult, listener, options);
@@ -121,7 +126,7 @@ export class RealtimeSubscriber {
         __classPrivateFieldSet(this, _RealtimeSubscriber_handlers, [], "f");
     }
 }
-_RealtimeSubscriber_emitter = new WeakMap(), _RealtimeSubscriber_handlers = new WeakMap(), _RealtimeSubscriber_instances = new WeakSet(), _RealtimeSubscriber_onEvent = function _RealtimeSubscriber_onEvent(event, listener) {
+_RealtimeSubscriber_emitter = new WeakMap(), _RealtimeSubscriber_beforeTestResults = new WeakMap(), _RealtimeSubscriber_handlers = new WeakMap(), _RealtimeSubscriber_instances = new WeakSet(), _RealtimeSubscriber_onEvent = function _RealtimeSubscriber_onEvent(event, listener) {
     const handler = createListenerHandler(listener);
     __classPrivateFieldGet(this, _RealtimeSubscriber_emitter, "f").on(event, handler);
     return () => {

package/dist/utils/flaky.d.ts

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

package/dist/utils/flaky.js

@@ -1,12 +1,40 @@
-const MAX_LAST_HISTORY_SIZE = 5;
+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 isAllureClassicFlaky = (tr, history) => {
-    if (history.length === 0 || !badStatuses.includes(tr.status)) {
+const isFlakyByWeightedTransitions = (tr, history, historyDepth, includePassedTests) => {
+    const currentPassed = tr.status === "passed";
+    const isEligibleStatus = badStatuses.includes(tr.status) || (includePassedTests && currentPassed);
+    if (historyDepth === -1 || !isEligibleStatus) {
         return false;
     }
-    const limitedLastHistory = history.slice(0, MAX_LAST_HISTORY_SIZE);
-    const limitedLastHistoryStatuses = limitedLastHistory.map((h) => h.status);
-    return (limitedLastHistoryStatuses.includes("passed") &&
-        limitedLastHistoryStatuses.indexOf("passed") < limitedLastHistoryStatuses.lastIndexOf("failed"));
+    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);
 };
-export const isFlaky = (tr, history) => tr.flaky || isAllureClassicFlaky(tr, history);

package/dist/utils/realtimeChannel.d.ts

@@ -3,6 +3,7 @@ export declare class RealtimeChannel {
     #private;
     readonly dispatcher: RealtimeEventsDispatcher;
     readonly subscriber: RealtimeSubscriber;
+    constructor(beforeTestResults?: () => void);
     onResultLikeChanged(listener: () => void): () => void;
     close(): void;
 }

package/dist/utils/realtimeChannel.js

@@ -7,10 +7,10 @@ var _RealtimeChannel_emitter;
 import { EventEmitter } from "node:events";
 import { RealtimeEvents, RealtimeEventsDispatcher, RealtimeSubscriber } from "./event.js";
 export class RealtimeChannel {
-    constructor() {
+    constructor(beforeTestResults) {
         _RealtimeChannel_emitter.set(this, new EventEmitter());
         this.dispatcher = new RealtimeEventsDispatcher(__classPrivateFieldGet(this, _RealtimeChannel_emitter, "f"));
-        this.subscriber = new RealtimeSubscriber(__classPrivateFieldGet(this, _RealtimeChannel_emitter, "f"));
+        this.subscriber = new RealtimeSubscriber(__classPrivateFieldGet(this, _RealtimeChannel_emitter, "f"), beforeTestResults);
     }
     onResultLikeChanged(listener) {
         __classPrivateFieldGet(this, _RealtimeChannel_emitter, "f").on(RealtimeEvents.TestResult, listener);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allurereport/core",
-  "version": "3.18.0",
+  "version": "3.19.0",
   "description": "Collection of generic Allure utilities used across the entire project",
   "keywords": [
     "allure"
@@ -25,26 +25,26 @@
     "lint:fix": "oxlint --import-plugin --fix src test features stories"
   },
   "dependencies": {
-    "@allurereport/ci": "3.18.0",
-    "@allurereport/cli-commons": "3.18.0",
-    "@allurereport/core-api": "3.18.0",
-    "@allurereport/plugin-agent": "3.18.0",
-    "@allurereport/plugin-allure2": "3.18.0",
-    "@allurereport/plugin-api": "3.18.0",
-    "@allurereport/plugin-awesome": "3.18.0",
-    "@allurereport/plugin-classic": "3.18.0",
-    "@allurereport/plugin-csv": "3.18.0",
-    "@allurereport/plugin-dashboard": "3.18.0",
-    "@allurereport/plugin-jira": "3.18.0",
-    "@allurereport/plugin-log": "3.18.0",
-    "@allurereport/plugin-progress": "3.18.0",
-    "@allurereport/plugin-slack": "3.18.0",
-    "@allurereport/plugin-testops": "3.18.0",
-    "@allurereport/plugin-testplan": "3.18.0",
-    "@allurereport/reader": "3.18.0",
-    "@allurereport/reader-api": "3.18.0",
-    "@allurereport/service": "3.18.0",
-    "@allurereport/summary": "3.18.0",
+    "@allurereport/ci": "3.19.0",
+    "@allurereport/cli-commons": "3.19.0",
+    "@allurereport/core-api": "3.19.0",
+    "@allurereport/plugin-agent": "3.19.0",
+    "@allurereport/plugin-allure2": "3.19.0",
+    "@allurereport/plugin-api": "3.19.0",
+    "@allurereport/plugin-awesome": "3.19.0",
+    "@allurereport/plugin-classic": "3.19.0",
+    "@allurereport/plugin-csv": "3.19.0",
+    "@allurereport/plugin-dashboard": "3.19.0",
+    "@allurereport/plugin-jira": "3.19.0",
+    "@allurereport/plugin-log": "3.19.0",
+    "@allurereport/plugin-progress": "3.19.0",
+    "@allurereport/plugin-slack": "3.19.0",
+    "@allurereport/plugin-testops": "3.19.0",
+    "@allurereport/plugin-testplan": "3.19.0",
+    "@allurereport/reader": "3.19.0",
+    "@allurereport/reader-api": "3.19.0",
+    "@allurereport/service": "3.19.0",
+    "@allurereport/summary": "3.19.0",
     "glob": "^13.0.6",
     "handlebars": "^4.7.9",
     "jiti": "^2.5.1",