@allurereport/core 3.17.0 → 3.19.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -7,6 +7,9 @@ export declare enum RealtimeEvents {
7
7
  QualityGateResults = "qualityGateResults",
8
8
  GlobalAttachment = "globalAttachment",
9
9
  GlobalError = "globalError",
10
+ ProcessGlobalAttachment = "processGlobalAttachment",
11
+ ProcessGlobalError = "processGlobalError",
12
+ ProcessGlobalsReset = "processGlobalsReset",
10
13
  GlobalExitCode = "globalExitCode"
11
14
  }
12
15
  export interface AllureStoreEvents {
@@ -19,15 +22,25 @@ export interface AllureStoreEvents {
19
22
  fileName?: string;
20
23
  environment?: string;
21
24
  }];
25
+ [RealtimeEvents.ProcessGlobalAttachment]: [{
26
+ attachment: ResultFile;
27
+ fileName?: string;
28
+ environment?: string;
29
+ }];
22
30
  [RealtimeEvents.GlobalExitCode]: [ExitCode];
23
31
  [RealtimeEvents.GlobalError]: [PluginGlobalError];
32
+ [RealtimeEvents.ProcessGlobalError]: [PluginGlobalError];
33
+ [RealtimeEvents.ProcessGlobalsReset]: [];
24
34
  }
25
35
  export declare class RealtimeEventsDispatcher implements RealtimeEventsDispatcherType {
26
36
  #private;
27
37
  constructor(emitter: EventEmitter<AllureStoreEvents>);
28
38
  sendGlobalAttachment(attachment: ResultFile, fileName?: string, environment?: string): void;
39
+ sendProcessGlobalAttachment(attachment: ResultFile, fileName?: string, environment?: string): void;
29
40
  sendGlobalExitCode(codes: ExitCode): void;
30
41
  sendGlobalError(error: PluginGlobalError): void;
42
+ sendProcessGlobalError(error: PluginGlobalError): void;
43
+ sendProcessGlobalsReset(): void;
31
44
  sendQualityGateResults(payload: QualityGateValidationResult[]): void;
32
45
  sendTestResult(trId: string): void;
33
46
  sendTestFixtureResult(tfrId: string): void;
@@ -35,14 +48,21 @@ export declare class RealtimeEventsDispatcher implements RealtimeEventsDispatche
35
48
  }
36
49
  export declare class RealtimeSubscriber implements RealtimeSubscriberType {
37
50
  #private;
38
- constructor(emitter: EventEmitter<AllureStoreEvents>);
51
+ constructor(emitter: EventEmitter<AllureStoreEvents>, beforeTestResults?: () => void);
39
52
  onGlobalAttachment(listener: (payload: {
40
53
  attachment: ResultFile;
41
54
  fileName?: string;
42
55
  environment?: string;
43
56
  }) => RealtimeListenerResult): () => void;
57
+ onProcessGlobalAttachment(listener: (payload: {
58
+ attachment: ResultFile;
59
+ fileName?: string;
60
+ environment?: string;
61
+ }) => RealtimeListenerResult): () => void;
44
62
  onGlobalExitCode(listener: (payload: ExitCode) => RealtimeListenerResult): () => void;
45
63
  onGlobalError(listener: (error: PluginGlobalError) => RealtimeListenerResult): () => void;
64
+ onProcessGlobalError(listener: (error: PluginGlobalError) => RealtimeListenerResult): () => void;
65
+ onProcessGlobalsReset(listener: () => RealtimeListenerResult): () => void;
46
66
  onQualityGateResults(listener: (payload: QualityGateValidationResult[]) => RealtimeListenerResult): () => void;
47
67
  onTestResults(listener: (trIds: string[]) => RealtimeListenerResult, options?: BatchOptions): () => void;
48
68
  onTestFixtureResults(listener: (tfrIds: string[]) => RealtimeListenerResult, options?: BatchOptions): () => void;
@@ -9,7 +9,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
9
9
  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");
10
10
  return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
11
11
  };
12
- var _RealtimeEventsDispatcher_emitter, _RealtimeSubscriber_instances, _RealtimeSubscriber_emitter, _RealtimeSubscriber_handlers, _RealtimeSubscriber_onEvent, _RealtimeSubscriber_onBatchedEvent, _RealtimeSubscriber_createBatchHandler, _RealtimeSubscriber_runBatchHandler, _RealtimeSubscriber_disposeBatchHandler;
12
+ var _RealtimeEventsDispatcher_emitter, _RealtimeSubscriber_instances, _RealtimeSubscriber_emitter, _RealtimeSubscriber_beforeTestResults, _RealtimeSubscriber_handlers, _RealtimeSubscriber_onEvent, _RealtimeSubscriber_onBatchedEvent, _RealtimeSubscriber_createBatchHandler, _RealtimeSubscriber_runBatchHandler, _RealtimeSubscriber_disposeBatchHandler;
13
13
  import console from "node:console";
14
14
  import { setTimeout } from "node:timers/promises";
15
15
  export var RealtimeEvents;
@@ -20,6 +20,9 @@ export var RealtimeEvents;
20
20
  RealtimeEvents["QualityGateResults"] = "qualityGateResults";
21
21
  RealtimeEvents["GlobalAttachment"] = "globalAttachment";
22
22
  RealtimeEvents["GlobalError"] = "globalError";
23
+ RealtimeEvents["ProcessGlobalAttachment"] = "processGlobalAttachment";
24
+ RealtimeEvents["ProcessGlobalError"] = "processGlobalError";
25
+ RealtimeEvents["ProcessGlobalsReset"] = "processGlobalsReset";
23
26
  RealtimeEvents["GlobalExitCode"] = "globalExitCode";
24
27
  })(RealtimeEvents || (RealtimeEvents = {}));
25
28
  const runListener = (listener, ...args) => {
@@ -44,12 +47,21 @@ export class RealtimeEventsDispatcher {
44
47
  sendGlobalAttachment(attachment, fileName, environment) {
45
48
  __classPrivateFieldGet(this, _RealtimeEventsDispatcher_emitter, "f").emit(RealtimeEvents.GlobalAttachment, { attachment, fileName, environment });
46
49
  }
50
+ sendProcessGlobalAttachment(attachment, fileName, environment) {
51
+ __classPrivateFieldGet(this, _RealtimeEventsDispatcher_emitter, "f").emit(RealtimeEvents.ProcessGlobalAttachment, { attachment, fileName, environment });
52
+ }
47
53
  sendGlobalExitCode(codes) {
48
54
  __classPrivateFieldGet(this, _RealtimeEventsDispatcher_emitter, "f").emit(RealtimeEvents.GlobalExitCode, codes);
49
55
  }
50
56
  sendGlobalError(error) {
51
57
  __classPrivateFieldGet(this, _RealtimeEventsDispatcher_emitter, "f").emit(RealtimeEvents.GlobalError, error);
52
58
  }
59
+ sendProcessGlobalError(error) {
60
+ __classPrivateFieldGet(this, _RealtimeEventsDispatcher_emitter, "f").emit(RealtimeEvents.ProcessGlobalError, error);
61
+ }
62
+ sendProcessGlobalsReset() {
63
+ __classPrivateFieldGet(this, _RealtimeEventsDispatcher_emitter, "f").emit(RealtimeEvents.ProcessGlobalsReset);
64
+ }
53
65
  sendQualityGateResults(payload) {
54
66
  __classPrivateFieldGet(this, _RealtimeEventsDispatcher_emitter, "f").emit(RealtimeEvents.QualityGateResults, payload ?? []);
55
67
  }
@@ -65,26 +77,40 @@ export class RealtimeEventsDispatcher {
65
77
  }
66
78
  _RealtimeEventsDispatcher_emitter = new WeakMap();
67
79
  export class RealtimeSubscriber {
68
- constructor(emitter) {
80
+ constructor(emitter, beforeTestResults) {
69
81
  _RealtimeSubscriber_instances.add(this);
70
82
  _RealtimeSubscriber_emitter.set(this, void 0);
83
+ _RealtimeSubscriber_beforeTestResults.set(this, void 0);
71
84
  _RealtimeSubscriber_handlers.set(this, []);
72
85
  __classPrivateFieldSet(this, _RealtimeSubscriber_emitter, emitter, "f");
86
+ __classPrivateFieldSet(this, _RealtimeSubscriber_beforeTestResults, beforeTestResults, "f");
73
87
  }
74
88
  onGlobalAttachment(listener) {
75
89
  return __classPrivateFieldGet(this, _RealtimeSubscriber_instances, "m", _RealtimeSubscriber_onEvent).call(this, RealtimeEvents.GlobalAttachment, listener);
76
90
  }
91
+ onProcessGlobalAttachment(listener) {
92
+ return __classPrivateFieldGet(this, _RealtimeSubscriber_instances, "m", _RealtimeSubscriber_onEvent).call(this, RealtimeEvents.ProcessGlobalAttachment, listener);
93
+ }
77
94
  onGlobalExitCode(listener) {
78
95
  return __classPrivateFieldGet(this, _RealtimeSubscriber_instances, "m", _RealtimeSubscriber_onEvent).call(this, RealtimeEvents.GlobalExitCode, listener);
79
96
  }
80
97
  onGlobalError(listener) {
81
98
  return __classPrivateFieldGet(this, _RealtimeSubscriber_instances, "m", _RealtimeSubscriber_onEvent).call(this, RealtimeEvents.GlobalError, listener);
82
99
  }
100
+ onProcessGlobalError(listener) {
101
+ return __classPrivateFieldGet(this, _RealtimeSubscriber_instances, "m", _RealtimeSubscriber_onEvent).call(this, RealtimeEvents.ProcessGlobalError, listener);
102
+ }
103
+ onProcessGlobalsReset(listener) {
104
+ return __classPrivateFieldGet(this, _RealtimeSubscriber_instances, "m", _RealtimeSubscriber_onEvent).call(this, RealtimeEvents.ProcessGlobalsReset, listener);
105
+ }
83
106
  onQualityGateResults(listener) {
84
107
  return __classPrivateFieldGet(this, _RealtimeSubscriber_instances, "m", _RealtimeSubscriber_onEvent).call(this, RealtimeEvents.QualityGateResults, listener);
85
108
  }
86
109
  onTestResults(listener, options = {}) {
87
- return __classPrivateFieldGet(this, _RealtimeSubscriber_instances, "m", _RealtimeSubscriber_onBatchedEvent).call(this, RealtimeEvents.TestResult, listener, options);
110
+ return __classPrivateFieldGet(this, _RealtimeSubscriber_instances, "m", _RealtimeSubscriber_onBatchedEvent).call(this, RealtimeEvents.TestResult, (trIds) => {
111
+ __classPrivateFieldGet(this, _RealtimeSubscriber_beforeTestResults, "f")?.call(this);
112
+ return listener(trIds);
113
+ }, options);
88
114
  }
89
115
  onTestFixtureResults(listener, options = {}) {
90
116
  return __classPrivateFieldGet(this, _RealtimeSubscriber_instances, "m", _RealtimeSubscriber_onBatchedEvent).call(this, RealtimeEvents.TestFixtureResult, listener, options);
@@ -100,7 +126,7 @@ export class RealtimeSubscriber {
100
126
  __classPrivateFieldSet(this, _RealtimeSubscriber_handlers, [], "f");
101
127
  }
102
128
  }
103
- _RealtimeSubscriber_emitter = new WeakMap(), _RealtimeSubscriber_handlers = new WeakMap(), _RealtimeSubscriber_instances = new WeakSet(), _RealtimeSubscriber_onEvent = function _RealtimeSubscriber_onEvent(event, listener) {
129
+ _RealtimeSubscriber_emitter = new WeakMap(), _RealtimeSubscriber_beforeTestResults = new WeakMap(), _RealtimeSubscriber_handlers = new WeakMap(), _RealtimeSubscriber_instances = new WeakSet(), _RealtimeSubscriber_onEvent = function _RealtimeSubscriber_onEvent(event, listener) {
104
130
  const handler = createListenerHandler(listener);
105
131
  __classPrivateFieldGet(this, _RealtimeSubscriber_emitter, "f").on(event, handler);
106
132
  return () => {
@@ -1,2 +1,2 @@
1
- import type { HistoryTestResult, TestResult } from "@allurereport/core-api";
2
- export declare const isFlaky: (tr: TestResult, history: HistoryTestResult[]) => boolean;
1
+ import { type FlakyDetectionConfig, type HistoryTestResult, type TestResult } from "@allurereport/core-api";
2
+ export declare const createFlakyDetector: ({ historyDepth, includePassedTests, }?: FlakyDetectionConfig) => ((tr: TestResult, history: HistoryTestResult[]) => boolean);
@@ -1,12 +1,40 @@
1
- const MAX_LAST_HISTORY_SIZE = 5;
1
+ import { DEFAULT_ENVIRONMENT, } from "@allurereport/core-api";
2
+ const DEFAULT_HISTORY_DEPTH = 5;
3
+ const TRANSITION_HALF_LIFE = 2;
4
+ const STABILITY_PRIOR_WEIGHT = 3;
5
+ const FLAKY_SCORE_THRESHOLD = 30;
2
6
  const badStatuses = ["failed", "broken"];
3
- const isAllureClassicFlaky = (tr, history) => {
4
- if (history.length === 0 || !badStatuses.includes(tr.status)) {
7
+ const isFlakyByWeightedTransitions = (tr, history, historyDepth, includePassedTests) => {
8
+ const currentPassed = tr.status === "passed";
9
+ const isEligibleStatus = badStatuses.includes(tr.status) || (includePassedTests && currentPassed);
10
+ if (historyDepth === -1 || !isEligibleStatus) {
5
11
  return false;
6
12
  }
7
- const limitedLastHistory = history.slice(0, MAX_LAST_HISTORY_SIZE);
8
- const limitedLastHistoryStatuses = limitedLastHistory.map((h) => h.status);
9
- return (limitedLastHistoryStatuses.includes("passed") &&
10
- limitedLastHistoryStatuses.indexOf("passed") < limitedLastHistoryStatuses.lastIndexOf("failed"));
13
+ let previousPassed = currentPassed;
14
+ let comparisons = 0;
15
+ let weightedTransitions = 0;
16
+ let totalWeight = 0;
17
+ for (const result of history) {
18
+ if (historyDepth !== 0 && comparisons >= historyDepth) {
19
+ break;
20
+ }
21
+ if (result.id === tr.id ||
22
+ (result.environment ?? DEFAULT_ENVIRONMENT) !== (tr.environment ?? DEFAULT_ENVIRONMENT) ||
23
+ (result.status !== "passed" && !badStatuses.includes(result.status))) {
24
+ continue;
25
+ }
26
+ const passed = result.status === "passed";
27
+ const weight = 2 ** (-comparisons / TRANSITION_HALF_LIFE);
28
+ if (passed !== previousPassed) {
29
+ weightedTransitions += weight;
30
+ }
31
+ totalWeight += weight;
32
+ previousPassed = passed;
33
+ comparisons++;
34
+ }
35
+ const score = (100 * weightedTransitions) / (STABILITY_PRIOR_WEIGHT + totalWeight);
36
+ return score >= FLAKY_SCORE_THRESHOLD;
37
+ };
38
+ export const createFlakyDetector = ({ historyDepth = DEFAULT_HISTORY_DEPTH, includePassedTests = false, } = {}) => {
39
+ return (tr, history) => isFlakyByWeightedTransitions(tr, history, historyDepth, includePassedTests);
11
40
  };
12
- export const isFlaky = (tr, history) => tr.flaky || isAllureClassicFlaky(tr, history);
@@ -3,6 +3,7 @@ export declare class RealtimeChannel {
3
3
  #private;
4
4
  readonly dispatcher: RealtimeEventsDispatcher;
5
5
  readonly subscriber: RealtimeSubscriber;
6
+ constructor(beforeTestResults?: () => void);
6
7
  onResultLikeChanged(listener: () => void): () => void;
7
8
  close(): void;
8
9
  }
@@ -7,10 +7,10 @@ var _RealtimeChannel_emitter;
7
7
  import { EventEmitter } from "node:events";
8
8
  import { RealtimeEvents, RealtimeEventsDispatcher, RealtimeSubscriber } from "./event.js";
9
9
  export class RealtimeChannel {
10
- constructor() {
10
+ constructor(beforeTestResults) {
11
11
  _RealtimeChannel_emitter.set(this, new EventEmitter());
12
12
  this.dispatcher = new RealtimeEventsDispatcher(__classPrivateFieldGet(this, _RealtimeChannel_emitter, "f"));
13
- this.subscriber = new RealtimeSubscriber(__classPrivateFieldGet(this, _RealtimeChannel_emitter, "f"));
13
+ this.subscriber = new RealtimeSubscriber(__classPrivateFieldGet(this, _RealtimeChannel_emitter, "f"), beforeTestResults);
14
14
  }
15
15
  onResultLikeChanged(listener) {
16
16
  __classPrivateFieldGet(this, _RealtimeChannel_emitter, "f").on(RealtimeEvents.TestResult, listener);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@allurereport/core",
3
- "version": "3.17.0",
3
+ "version": "3.19.0",
4
4
  "description": "Collection of generic Allure utilities used across the entire project",
5
5
  "keywords": [
6
6
  "allure"
@@ -25,33 +25,33 @@
25
25
  "lint:fix": "oxlint --import-plugin --fix src test features stories"
26
26
  },
27
27
  "dependencies": {
28
- "@allurereport/ci": "3.17.0",
29
- "@allurereport/cli-commons": "3.17.0",
30
- "@allurereport/core-api": "3.17.0",
31
- "@allurereport/plugin-agent": "3.17.0",
32
- "@allurereport/plugin-allure2": "3.17.0",
33
- "@allurereport/plugin-api": "3.17.0",
34
- "@allurereport/plugin-awesome": "3.17.0",
35
- "@allurereport/plugin-classic": "3.17.0",
36
- "@allurereport/plugin-csv": "3.17.0",
37
- "@allurereport/plugin-dashboard": "3.17.0",
38
- "@allurereport/plugin-jira": "3.17.0",
39
- "@allurereport/plugin-log": "3.17.0",
40
- "@allurereport/plugin-progress": "3.17.0",
41
- "@allurereport/plugin-slack": "3.17.0",
42
- "@allurereport/plugin-testops": "3.17.0",
43
- "@allurereport/plugin-testplan": "3.17.0",
44
- "@allurereport/reader": "3.17.0",
45
- "@allurereport/reader-api": "3.17.0",
46
- "@allurereport/service": "3.17.0",
47
- "@allurereport/summary": "3.17.0",
28
+ "@allurereport/ci": "3.19.0",
29
+ "@allurereport/cli-commons": "3.19.0",
30
+ "@allurereport/core-api": "3.19.0",
31
+ "@allurereport/plugin-agent": "3.19.0",
32
+ "@allurereport/plugin-allure2": "3.19.0",
33
+ "@allurereport/plugin-api": "3.19.0",
34
+ "@allurereport/plugin-awesome": "3.19.0",
35
+ "@allurereport/plugin-classic": "3.19.0",
36
+ "@allurereport/plugin-csv": "3.19.0",
37
+ "@allurereport/plugin-dashboard": "3.19.0",
38
+ "@allurereport/plugin-jira": "3.19.0",
39
+ "@allurereport/plugin-log": "3.19.0",
40
+ "@allurereport/plugin-progress": "3.19.0",
41
+ "@allurereport/plugin-slack": "3.19.0",
42
+ "@allurereport/plugin-testops": "3.19.0",
43
+ "@allurereport/plugin-testplan": "3.19.0",
44
+ "@allurereport/reader": "3.19.0",
45
+ "@allurereport/reader-api": "3.19.0",
46
+ "@allurereport/service": "3.19.0",
47
+ "@allurereport/summary": "3.19.0",
48
48
  "glob": "^13.0.6",
49
49
  "handlebars": "^4.7.9",
50
50
  "jiti": "^2.5.1",
51
51
  "node-stream-zip": "^1.15.0",
52
52
  "p-limit": "^7.3.0",
53
53
  "yaml": "^2.8.3",
54
- "yoctocolors": "^2.1.2",
54
+ "yoctocolors": "^2.2.0",
55
55
  "zip-stream": "^7.0.5"
56
56
  },
57
57
  "devDependencies": {