@allurereport/plugin-api 3.14.3 → 3.15.0

package/dist/config.d.ts

@@ -1,4 +1,4 @@
-import type { AllureServiceConfig, CategoriesConfig, DefaultLabelsConfig, EnvironmentsConfig, ReportVariables } from "@allurereport/core-api";
+import type { AllureServiceConfig, CategoriesConfig, DefaultLabelsConfig, EnvironmentsConfig, KnownIssuesPathConfig, ReportVariables, KnownIssuesConfig } from "@allurereport/core-api";
 import type { PluginDescriptor } from "./plugin.js";
 import type { QualityGateConfig } from "./qualityGate.js";
 export interface Config {
@@ -9,7 +9,8 @@ export interface Config {
     hideLabels?: (string | RegExp)[];
     historyPath?: string;
     historyLimit?: number;
-    knownIssuesPath?: string;
+    knownIssuesPath?: KnownIssuesPathConfig;
+    knownIssues?: KnownIssuesConfig;
     defaultLabels?: DefaultLabelsConfig;
     dump?: string;
     environment?: string;

package/dist/plugin.d.ts

@@ -34,7 +34,10 @@ export interface PluginContext {
     categories?: CategoryDefinition[];
     history?: AllureHistory;
 }
-export type SummaryTestResult = Pick<TestResult, "name" | "id" | "status" | "duration">;
+export type TestResultSummary = Pick<TestResult, "id" | "name" | "duration" | "status">;
+export interface TestResultRegistry {
+    byId: Record<string, TestResultSummary>;
+}
 export type SummaryCheckResult = Pick<AllureCheckResult, "id" | "name" | "status">;
 export type { GlobalAttachmentLink } from "@allurereport/core-api";
 export interface PluginSummary {
@@ -48,9 +51,9 @@ export interface PluginSummary {
     duration: number;
     plugin?: string;
     pluginId?: string;
-    newTests?: SummaryTestResult[];
-    flakyTests?: SummaryTestResult[];
-    retryTests?: SummaryTestResult[];
+    newTests?: string[];
+    flakyTests?: string[];
+    retryTests?: string[];
     checks?: SummaryCheckResult[];
     createdAt?: number;
     meta?: Record<string, any>;

package/dist/qualityGate.d.ts

@@ -6,6 +6,7 @@ export type QualityGateValidationResult = {
     rule: string;
     message: string;
     environment?: string;
+    testResults: string[];
 };
 export type QualityGateRules = Record<string, any> & {
     id?: string;
@@ -15,10 +16,11 @@ export type QualityGateRules = Record<string, any> & {
 export type QualityGateRuleResult = {
     success: boolean;
     actual: any;
+    testResults: string[];
 };
 export interface QualityGateRuleState<T> {
     getResult(): T | undefined;
-    setResult(value: T): void;
+    setResult(value: T, testResults: QualityGateRuleResult["testResults"]): void;
 }
 export type QualityGateRule<T = any, K = T> = {
     rule: string;

package/dist/store.d.ts

@@ -47,6 +47,7 @@ export interface AllureStore {
     fixturesByTrId: (trId: string) => Promise<TestFixtureResult[]>;
     relatedByTestResultIds: (trIds: readonly string[]) => Promise<TestResultRelatedData>;
     failedTestResults: () => Promise<TestResult[]>;
+    blockingFailedTestResults: () => Promise<TestResult[]>;
     unknownFailedTestResults: () => Promise<TestResult[]>;
     testResultsByLabel: (labelName: string) => Promise<{
         _: TestResult[];
@@ -76,13 +77,13 @@ export interface AllureStoreDump {
     fixtures: Record<string, TestFixtureResult>;
     environments: Array<string | EnvironmentIdentity>;
     reportVariables: ReportVariables;
+    knownIssues: Record<string, KnownTestFailure>;
     qualityGateResults: QualityGateValidationResult[];
     indexAttachmentByTestResult: Record<string, string[]>;
     indexTestResultByHistoryId: Record<string, string[]>;
     indexTestResultByTestCase: Record<string, string[]>;
     indexAttachmentByFixture: Record<string, string[]>;
     indexFixturesByTestResult: Record<string, string[]>;
-    indexKnownByHistoryId: Record<string, KnownTestFailure[]>;
     testResultIdsIngestOrder: string[];
 }
 export declare enum AllureStoreDumpFiles {
@@ -95,12 +96,12 @@ export declare enum AllureStoreDumpFiles {
     CheckResults = "check-results.json",
     Environments = "environments.json",
     ReportVariables = "report-variables.json",
+    KnownIssues = "known-issues.json",
     IndexAttachmentsByTestResults = "index-attachments-by-test-results.json",
     IndexTestResultsByHistoryId = "index-test-results-by-history-id.json",
     IndexTestResultsByTestCase = "index-test-results-by-test-case.json",
     IndexAttachmentsByFixture = "index-attachments-by-fixture.json",
     IndexFixturesByTestResult = "index-fixtures-by-test-result.json",
-    IndexKnownByHistoryId = "index-known-by-history-id.json",
     QualityGateResults = "quality-gate-results.json",
     TestResultIngestOrder = "test-result-ingest-order.json"
 }

package/dist/store.js

@@ -9,12 +9,12 @@ export var AllureStoreDumpFiles;
     AllureStoreDumpFiles["CheckResults"] = "check-results.json";
     AllureStoreDumpFiles["Environments"] = "environments.json";
     AllureStoreDumpFiles["ReportVariables"] = "report-variables.json";
+    AllureStoreDumpFiles["KnownIssues"] = "known-issues.json";
     AllureStoreDumpFiles["IndexAttachmentsByTestResults"] = "index-attachments-by-test-results.json";
     AllureStoreDumpFiles["IndexTestResultsByHistoryId"] = "index-test-results-by-history-id.json";
     AllureStoreDumpFiles["IndexTestResultsByTestCase"] = "index-test-results-by-test-case.json";
     AllureStoreDumpFiles["IndexAttachmentsByFixture"] = "index-attachments-by-fixture.json";
     AllureStoreDumpFiles["IndexFixturesByTestResult"] = "index-fixtures-by-test-result.json";
-    AllureStoreDumpFiles["IndexKnownByHistoryId"] = "index-known-by-history-id.json";
     AllureStoreDumpFiles["QualityGateResults"] = "quality-gate-results.json";
     AllureStoreDumpFiles["TestResultIngestOrder"] = "test-result-ingest-order.json";
 })(AllureStoreDumpFiles || (AllureStoreDumpFiles = {}));

package/dist/utils/summary.d.ts

@@ -1,7 +1,8 @@
 import { AllureCheckResult, type AllureHistory, type CiDescriptor, type TestResult } from "@allurereport/core-api";
-import type { PluginSummary, SummaryCheckResult, SummaryTestResult } from "../plugin.js";
+import type { PluginSummary, SummaryCheckResult, TestResultRegistry, TestResultSummary } from "../plugin.js";
 import type { AllureStore } from "../store.js";
-export declare const convertToSummaryTestResult: (tr: TestResult) => SummaryTestResult;
+export declare const convertToTestResultSummary: (tr: TestResult) => TestResultSummary;
+export declare const createTestResultRegistry: (testResults: TestResult[]) => TestResultRegistry;
 export declare const convertToSummaryCheckResult: (check: AllureCheckResult) => SummaryCheckResult;
 export declare const createPluginSummary: (params: {
     filter?: (testResult: TestResult) => boolean;

package/dist/utils/summary.js

@@ -1,9 +1,12 @@
 import { getWorstStatus, } from "@allurereport/core-api";
-export const convertToSummaryTestResult = (tr) => ({
+export const convertToTestResultSummary = (tr) => ({
     id: tr.id,
     name: tr.name,
-    status: tr.status,
     duration: tr.duration,
+    status: tr.status,
+});
+export const createTestResultRegistry = (testResults) => ({
+    byId: Object.fromEntries(testResults.map((testResult) => [testResult.id, convertToTestResultSummary(testResult)])),
 });
 export const convertToSummaryCheckResult = (check) => ({
     id: check.id,
@@ -16,7 +19,8 @@ export const createPluginSummary = async (params) => {
     const allTrs = await store.allTestResults({ filter });
     const mainBranchHistory = (await history?.readHistory?.({ branch: "" })) ?? [];
     const newTrs = await store.allNewTestResults(filter, mainBranchHistory);
-    const retryTrs = allTrs.filter((tr) => !!tr?.retries?.length);
+    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 worstStatus = getWorstStatus(allTrs.map(({ status }) => status));
@@ -24,9 +28,9 @@ export const createPluginSummary = async (params) => {
     return {
         stats: await store.testsStatistic(filter),
         status: worstStatus ?? "passed",
-        newTests: newTrs.map(convertToSummaryTestResult),
-        flakyTests: flakyTrs.map(convertToSummaryTestResult),
-        retryTests: retryTrs.map(convertToSummaryTestResult),
+        newTests: newTrs.map(({ id }) => id),
+        flakyTests: flakyTrs.map(({ id }) => id),
+        retryTests: retryTrs.map(({ id }) => id),
         checks: allChecks.map(convertToSummaryCheckResult),
         name,
         duration,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allurereport/plugin-api",
-  "version": "3.14.3",
+  "version": "3.15.0",
   "description": "Allure Plugin API",
   "keywords": [
     "allure"
@@ -26,7 +26,7 @@
     "lint:fix": "oxlint --import-plugin --fix src test features stories"
   },
   "dependencies": {
-    "@allurereport/core-api": "3.14.3"
+    "@allurereport/core-api": "3.15.0"
   },
   "devDependencies": {
     "@types/node": "^20",