@allurereport/plugin-api 3.16.1 → 3.18.0

package/dist/config.d.ts

@@ -1,4 +1,4 @@
-import type { AllureServiceConfig, CategoriesConfig, DefaultLabelsConfig, EnvironmentsConfig, ReportVariables, ResolutionsConfig } from "@allurereport/core-api";
+import type { AllureServiceConfig, CategoriesConfig, DefaultLabelsConfig, EnvironmentsConfig, PerformanceConfig, ReportVariables, ResolutionsConfig } from "@allurereport/core-api";
 import type { PluginDescriptor } from "./plugin.js";
 import type { QualityGateConfig } from "./qualityGate.js";
 export interface Config {
@@ -8,6 +8,7 @@ export interface Config {
     port?: string;
     hideLabels?: (string | RegExp)[];
     historyPath?: string;
+    historyBaseUrl?: string;
     historyLimit?: number;
     resolutions?: ResolutionsConfig;
     defaultLabels?: DefaultLabelsConfig;
@@ -19,6 +20,7 @@ export interface Config {
     plugins?: Record<string, PluginDescriptor>;
     appendHistory?: boolean;
     qualityGate?: QualityGateConfig;
+    performance?: PerformanceConfig;
     allureService?: AllureServiceConfig;
     categories?: CategoriesConfig;
     globalAttachments?: string[];

package/dist/plugin.d.ts

@@ -34,7 +34,7 @@ export interface PluginContext {
     categories?: CategoryDefinition[];
     history?: AllureHistory;
 }
-export type TestResultSummary = Pick<TestResult, "id" | "name" | "duration" | "status">;
+export type TestResultSummary = Pick<TestResult, "id" | "name" | "duration" | "environment" | "status">;
 export interface TestResultRegistry {
     byId: Record<string, TestResultSummary>;
 }
@@ -56,6 +56,7 @@ export interface PluginSummary {
     retryTests?: string[];
     checks?: SummaryCheckResult[];
     createdAt?: number;
+    filtered?: boolean;
     meta?: Record<string, any>;
 }
 export interface PluginReportFile {
@@ -103,8 +104,15 @@ export interface RealtimeSubscriber {
         fileName?: string;
         environment?: string;
     }) => RealtimeListenerResult): () => void;
+    onProcessGlobalAttachment(listener: (payload: {
+        attachment: ResultFile;
+        fileName?: string;
+        environment?: string;
+    }) => RealtimeListenerResult): () => void;
     onGlobalExitCode(listener: (payload: ExitCode) => RealtimeListenerResult): () => void;
     onGlobalError(listener: (error: PluginGlobalError) => RealtimeListenerResult): () => void;
+    onProcessGlobalError(listener: (error: PluginGlobalError) => RealtimeListenerResult): () => void;
+    onProcessGlobalsReset(listener: () => RealtimeListenerResult): () => void;
     onQualityGateResults(listener: (payload: QualityGateValidationResult[]) => RealtimeListenerResult): () => void;
     onTestResults(listener: (trIds: string[]) => RealtimeListenerResult, options?: BatchOptions): () => void;
     onTestFixtureResults(listener: (tfrIds: string[]) => RealtimeListenerResult, options?: BatchOptions): () => void;
@@ -112,8 +120,11 @@ export interface RealtimeSubscriber {
 }
 export interface RealtimeEventsDispatcher {
     sendGlobalAttachment(attachment: ResultFile, fileName?: string, environment?: string): void;
+    sendProcessGlobalAttachment(attachment: ResultFile, fileName?: string, environment?: string): void;
     sendGlobalExitCode(payload: ExitCode): void;
     sendGlobalError(error: PluginGlobalError): void;
+    sendProcessGlobalError(error: PluginGlobalError): void;
+    sendProcessGlobalsReset(): void;
     sendQualityGateResults(payload: QualityGateValidationResult[]): void;
     sendTestResult(trId: string): void;
     sendTestFixtureResult(tfrId: string): void;

package/dist/qualityGate.d.ts

@@ -1,4 +1,4 @@
-import type { TestResult } from "@allurereport/core-api";
+import type { MetricSample, TestResult } from "@allurereport/core-api";
 export type QualityGateValidationResult = {
     success: boolean;
     expected: any;
@@ -13,27 +13,38 @@ export type QualityGateRules = Record<string, any> & {
     fastFail?: boolean;
     filter?: (tr: TestResult) => boolean;
 };
-export type QualityGateRuleResult = {
+export type QualityGateRuleResult<T = unknown> = {
     success: boolean;
-    actual: any;
+    actual: T;
     testResults: string[];
 };
-export interface QualityGateRuleState<T> {
-    getResult(): T | undefined;
-    setResult(value: T, testResults: QualityGateRuleResult["testResults"]): void;
+export interface QualityGateRuleState {
+    getResult(): unknown;
+    setResult(value: unknown, testResults: string[]): void;
 }
-export type QualityGateRule<T = any, K = T> = {
+export type QualityGateMetricHistoryPoint = {
+    uuid?: string;
+    timestamp?: number;
+    metrics?: Record<string, number>;
+};
+export type QualityGateRule<T = unknown, K = T> = {
     rule: string;
     message: (payload: {
         expected: T;
-        actual: T;
+        actual: K;
+    }) => string;
+    successMessage?: (payload: {
+        expected: T;
+        actual: K;
     }) => string;
     validate: (payload: {
         expected: T;
         trs: TestResult[];
-        state: QualityGateRuleState<K>;
+        state: QualityGateRuleState;
+        metrics?: MetricSample[];
+        previousHistory?: QualityGateMetricHistoryPoint[];
         environment?: string;
-    }) => Promise<QualityGateRuleResult>;
+    }) => Promise<QualityGateRuleResult<K>>;
 };
 export type QualityGateConfig = {
     rules?: QualityGateRules[];

package/dist/report.d.ts

@@ -1,4 +1,4 @@
-import type { AttachmentTestStepResult, CiDescriptor, DefaultTreeGroup, HistoryTestResult, TestFixtureResult, TestResult, TestStatus, TestStepResult, TreeData, WithChildren } from "@allurereport/core-api";
+import type { AttachmentTestStepResult, CiDescriptor, DefaultTreeGroup, HistoryTestResult, 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";
@@ -34,6 +34,7 @@ export type ReportOptions = {
     ci?: CiDescriptor;
     executor?: ReportExecutorInfo;
     runSummary?: ReportRunSummary;
+    runSummaryByEnv?: Record<string, ReportRunSummary>;
     stepTreeExpansion?: StepTreeExpansion;
     defaultSortBy?: string;
 };
@@ -74,19 +75,21 @@ export type ReportTestResult = Omit<TestResult, "runSelector" | "sourceMetadata"
     retry: boolean;
     categories?: ReportCategory[];
     environment?: string | "default";
+    resolutionIssue?: ResolutionIssue;
     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"> & {
+export type ReportTreeLeaf = Pick<ReportTestResult, "duration" | "name" | "start" | "status" | "groupOrder" | "flaky" | "transition" | "retry" | "retriesCount" | "resolution"> & {
     nodeId: string;
     id?: string;
     transitionTooltip?: string;
     tooltips?: Record<string, string>;
     tags?: string[];
     categories?: string[];
+    severity?: string;
 };
 export type ReportTreeGroup = WithChildren & DefaultTreeGroup & {
     nodeId: string;
@@ -110,6 +113,20 @@ export type ReportSearchDocument = {
     statusMessage?: string;
     links?: string;
 };
+export type ReportResolutionTestResult = Pick<ReportTreeLeaf, "nodeId" | "id" | "name" | "status" | "duration" | "flaky" | "transition" | "retry" | "retriesCount" | "resolution" | "tooltips"> & {
+    groupOrder?: number;
+};
+export type ReportResolutionGroup = {
+    id: string;
+    resolution: ResolutionCategory;
+    name: string;
+    comment?: string;
+    issue?: ResolutionIssue;
+    testResults: ReportResolutionTestResult[];
+};
+export type ReportResolutionCategories = {
+    groups: ReportResolutionGroup[];
+};
 export type ReportRecursiveTree = DefaultTreeGroup & {
     nodeId: string;
     leaves: ReportTreeLeaf[];

package/dist/store.d.ts

@@ -1,4 +1,4 @@
-import type { AllureCheckResult, AttachmentLink, EnvironmentIdentity, GlobalAttachmentLink, HistoryDataPoint, HistoryTestResult, ResolutionIssue, ReportVariables, Statistic, TestCase, TestEnvGroup, TestError, TestFixtureResult, TestResult } from "@allurereport/core-api";
+import type { AllureCheckResult, AttachmentLink, EnvironmentIdentity, GlobalAttachmentLink, HistoryDataPoint, HistoryTestResult, ResolutionIssue, MetricSample, ReportVariables, Statistic, TestCase, TestEnvGroup, TestError, TestFixtureResult, TestResult } from "@allurereport/core-api";
 import type { ExitCode, PluginGlobalError } from "./plugin.js";
 import type { QualityGateValidationResult } from "./qualityGate.js";
 import type { ResultFile } from "./resultFile.js";
@@ -24,6 +24,7 @@ export interface AllureStore {
     allResolutionIssues: () => Promise<ResolutionIssue[]>;
     resolutionIssueByTestResultId: (trId: string) => Promise<ResolutionIssue | undefined>;
     testResultsByResolutionIssueId: (resolutionIssueId: string) => Promise<TestResult[]>;
+    allMetrics: () => Promise<MetricSample[]>;
     allNewTestResults: (filter?: TestResultFilter, history?: HistoryDataPoint[]) => Promise<TestResult[]>;
     addCheckResult: (result: AllureCheckResult) => Promise<void>;
     allCheckResults: () => Promise<AllureCheckResult[]>;
@@ -81,6 +82,7 @@ export interface AllureStoreDump {
     reportVariables: ReportVariables;
     resolutionIssues: Record<string, ResolutionIssue>;
     qualityGateResults: QualityGateValidationResult[];
+    metrics?: MetricSample[];
     indexAttachmentByTestResult: Record<string, string[]>;
     indexTestResultByHistoryId: Record<string, string[]>;
     indexTestResultByTestCase: Record<string, string[]>;
@@ -107,5 +109,6 @@ export declare enum AllureStoreDumpFiles {
     IndexAttachmentsByFixture = "index-attachments-by-fixture.json",
     IndexFixturesByTestResult = "index-fixtures-by-test-result.json",
     QualityGateResults = "quality-gate-results.json",
-    TestResultIngestOrder = "test-result-ingest-order.json"
+    TestResultIngestOrder = "test-result-ingest-order.json",
+    Metrics = "metrics.json"
 }

package/dist/store.js

@@ -18,4 +18,5 @@ export var AllureStoreDumpFiles;
     AllureStoreDumpFiles["IndexFixturesByTestResult"] = "index-fixtures-by-test-result.json";
     AllureStoreDumpFiles["QualityGateResults"] = "quality-gate-results.json";
     AllureStoreDumpFiles["TestResultIngestOrder"] = "test-result-ingest-order.json";
+    AllureStoreDumpFiles["Metrics"] = "metrics.json";
 })(AllureStoreDumpFiles || (AllureStoreDumpFiles = {}));

package/dist/utils/summary.d.ts

@@ -4,6 +4,7 @@ import type { AllureStore } from "../store.js";
 export declare const convertToTestResultSummary: (tr: TestResult) => TestResultSummary;
 export declare const createTestResultRegistry: (testResults: TestResult[]) => TestResultRegistry;
 export declare const convertToSummaryCheckResult: (check: AllureCheckResult) => SummaryCheckResult;
+export declare const calculateRunDuration: (testResults: Pick<TestResult, "start" | "stop" | "duration">[]) => number;
 export declare const createPluginSummary: (params: {
     filter?: (testResult: TestResult) => boolean;
     name: string;

package/dist/utils/summary.js

@@ -4,6 +4,7 @@ export const convertToTestResultSummary = (tr) => ({
     name: tr.name,
     duration: tr.duration,
     status: tr.status,
+    ...(tr.environment ? { environment: tr.environment } : {}),
 });
 export const createTestResultRegistry = (testResults) => ({
     byId: Object.fromEntries(testResults.map((testResult) => [testResult.id, convertToTestResultSummary(testResult)])),
@@ -13,6 +14,23 @@ export const convertToSummaryCheckResult = (check) => ({
     name: check.name,
     status: check.status,
 });
+export const calculateRunDuration = (testResults) => {
+    let start = Infinity;
+    let stop = -Infinity;
+    for (const { start: trStart, stop: trStop } of testResults) {
+        if (typeof trStart === "number" &&
+            Number.isFinite(trStart) &&
+            typeof trStop === "number" &&
+            Number.isFinite(trStop)) {
+            start = Math.min(start, trStart);
+            stop = Math.max(stop, trStop);
+        }
+    }
+    if (Number.isFinite(start) && Number.isFinite(stop)) {
+        return Math.max(0, stop - start);
+    }
+    return testResults.reduce((acc, { duration = 0 }) => acc + duration, 0);
+};
 export const createPluginSummary = async (params) => {
     const { name, filter, plugin, store, history, meta } = params;
     const allChecks = await store.allCheckResults();
@@ -22,7 +40,7 @@ export const createPluginSummary = async (params) => {
     const retryFlags = await Promise.all(allTrs.map(async (tr) => (await store.retriesByTr(tr)).length > 0));
     const retryTrs = allTrs.filter((_, index) => retryFlags[index]);
     const flakyTrs = allTrs.filter((tr) => !!tr?.flaky);
-    const duration = allTrs.reduce((acc, { duration: trDuration = 0 }) => acc + trDuration, 0);
+    const duration = calculateRunDuration(allTrs);
     const worstStatus = getWorstStatus(allTrs.map(({ status }) => status));
     const createdAt = allTrs.reduce((acc, { stop }) => Math.max(acc, stop || 0), 0);
     return {
@@ -35,6 +53,7 @@ export const createPluginSummary = async (params) => {
         name,
         duration,
         createdAt,
+        ...(filter ? { filtered: true } : {}),
         plugin,
         meta,
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allurereport/plugin-api",
-  "version": "3.16.1",
+  "version": "3.18.0",
   "description": "Allure Plugin API",
   "keywords": [
     "allure"
@@ -29,7 +29,7 @@
     "lint:fix": "oxlint --import-plugin --fix src test features stories"
   },
   "dependencies": {
-    "@allurereport/core-api": "3.16.1",
+    "@allurereport/core-api": "3.18.0",
     "tar-stream": "3.1.7"
   },
   "devDependencies": {