@allurereport/core-api 3.16.0 → 3.17.0

package/dist/aggregate.d.ts

@@ -13,4 +13,9 @@ export type Statistic = DiffStatistic & {
     total: number;
     retries?: number;
     flaky?: number;
+    resolutions?: {
+        issues?: number;
+        muted?: number;
+        accepted?: number;
+    };
 };

package/dist/config.d.ts

@@ -1,5 +1,4 @@
 export type DefaultLabelsConfig = Record<string, string | string[]>;
-export type KnownIssuesPathConfig = string;
 export type AllureServiceConfig = {
     accessToken?: string;
     private?: boolean;

package/dist/index.d.ts

@@ -4,8 +4,9 @@ export * from "./ci.js";
 export * from "./gitFlow.js";
 export type * from "./environment.js";
 export type * from "./history.js";
-export type * from "./known.js";
+export type * from "./resolutions.js";
 export type * from "./metadata.js";
+export * from "./metrics.js";
 export type * from "./model.js";
 export type * from "./testCase.js";
 export type * from "./testPlan.js";

package/dist/index.js

@@ -1,6 +1,7 @@
 export * from "./constants.js";
 export * from "./ci.js";
 export * from "./gitFlow.js";
+export * from "./metrics.js";
 export * from "./static.js";
 export * from "./categories.js";
 export * from "./utils/step.js";

package/dist/metrics.d.ts

@@ -0,0 +1,32 @@
+export type MetricBetter = "lower" | "higher" | "neutral";
+export interface PerformanceGroupConfig {
+    title: string;
+}
+export interface PerformanceMetricConfig {
+    title: string;
+    unit: string;
+    better: Exclude<MetricBetter, "neutral">;
+    group?: string;
+}
+export interface PerformanceConfig {
+    groups?: Record<string, PerformanceGroupConfig>;
+    metrics?: Record<string, PerformanceMetricConfig>;
+}
+export interface AllurePerformanceResult {
+    id: string;
+    key: string;
+    value: any;
+    start: number;
+    stop: number;
+}
+export interface MetricSample extends AllurePerformanceResult {
+    value: number;
+    source?: string;
+    title?: string;
+    unit?: string;
+    group?: string;
+    groupTitle?: string;
+    better?: MetricBetter;
+}
+export type ResolvableMetric = AllurePerformanceResult & Partial<Pick<MetricSample, "source" | "title" | "unit" | "group" | "groupTitle" | "better">>;
+export declare const resolveMetricSamples: (metrics: readonly ResolvableMetric[], performance?: PerformanceConfig) => MetricSample[];

package/dist/metrics.js

@@ -0,0 +1,29 @@
+const isValidMetricResult = (metric) => typeof metric.id === "string" &&
+    metric.id !== "" &&
+    typeof metric.key === "string" &&
+    metric.key !== "" &&
+    Number.isFinite(metric.start) &&
+    Number.isFinite(metric.stop);
+export const resolveMetricSamples = (metrics, performance = {}) => {
+    const metricsConfig = performance.metrics ?? {};
+    const groupsConfig = performance.groups ?? {};
+    return metrics.reduce((acc, metric) => {
+        const value = Number.isFinite(metric.value) ? Number(metric.value) : undefined;
+        if (value === undefined || !isValidMetricResult(metric)) {
+            return acc;
+        }
+        const metricConfig = metricsConfig[metric.key];
+        const group = metricConfig?.group ?? metric.group;
+        const groupConfig = group ? groupsConfig[group] : undefined;
+        acc.push({
+            ...metric,
+            value,
+            ...(metricConfig?.title ? { title: metricConfig.title } : {}),
+            ...(metricConfig?.unit ? { unit: metricConfig.unit } : {}),
+            ...(group ? { group } : {}),
+            ...(groupConfig?.title ? { groupTitle: groupConfig.title } : {}),
+            ...(metricConfig?.better ? { better: metricConfig.better } : {}),
+        });
+        return acc;
+    }, []);
+};

package/dist/model.d.ts

@@ -1,4 +1,5 @@
 import type { TestLabel, TestLink, TestParameter } from "./metadata.js";
+import type { ResolutionCategory } from "./resolutions.js";
 import type { TestCase } from "./testCase.js";
 export type TestStatus = "failed" | "broken" | "passed" | "skipped" | "unknown";
 export type AllureCheckStatus = "passed" | "failed";
@@ -47,7 +48,8 @@ export interface TestResult {
     duration?: number;
     flaky: boolean;
     muted: boolean;
-    known: boolean;
+    resolution?: ResolutionCategory;
+    resolutionComment?: string;
     transition?: TestStatusTransition;
     retryHash?: string;
     isRetry: boolean;

package/dist/resolutions.d.ts

@@ -0,0 +1,48 @@
+import type { TestError, TestStatus } from "./model.js";
+export type ResolutionCategory = "issue" | "muted" | "accepted";
+export interface ResolutionLinkTemplate {
+    nameTemplate?: string;
+    urlTemplate: string;
+}
+export interface ResolutionMatcher {
+    messageRegexp?: string;
+    testCaseId?: string[];
+    retryHash?: string[];
+    environment?: string[];
+}
+export interface IssueResolutionRule extends ResolutionMatcher {
+    resolution: "issue";
+    issue: {
+        id: string;
+        type: string;
+    };
+    comment?: string;
+}
+export interface IgnoredResolutionRule extends ResolutionMatcher {
+    resolution: "muted" | "accepted";
+    comment: string;
+}
+export type ResolutionRule = IssueResolutionRule | IgnoredResolutionRule;
+export interface ResolutionsConfig {
+    knownIssuesPath?: string;
+    links?: Record<string, ResolutionLinkTemplate>;
+    rules: ResolutionRule[];
+}
+export interface ResolutionIssue {
+    id: string;
+    type: string;
+    comment?: string;
+}
+export interface KnownIssueTestResult {
+    name: string;
+    fullName?: string;
+    environment?: string;
+    status: Extract<TestStatus, "failed" | "broken">;
+    error?: TestError;
+}
+export interface KnownIssueRecord extends ResolutionIssue {
+    testResults: Record<string, KnownIssueTestResult>;
+}
+export interface KnownIssuesFile {
+    resolutionIssues: KnownIssueRecord[];
+}

package/dist/utils/history.d.ts

@@ -4,7 +4,6 @@ import type { TestResult } from "../model.js";
 export declare const stringifyHistoryParams: (parameters?: TestParameter[]) => string;
 export declare const getFallbackHistoryId: (tr: Pick<TestResult, "labels" | "parameters">) => string | undefined;
 export declare const getHistoryIdCandidates: (tr: Pick<TestResult, "historyId" | "labels" | "parameters">) => string[];
-export declare const filterUnknownByKnownIssues: (trs: TestResult[], knownIssueHistoryIds: ReadonlySet<string>) => TestResult[];
 export declare const normalizeHistoryDataPoint: (historyDataPoint: HistoryDataPoint) => HistoryDataPoint;
 export declare const normalizeHistoryDataPointUrls: (historyDataPoint: HistoryDataPoint) => HistoryDataPoint;
 export declare const selectHistoryTestResults: (historyDataPoints: HistoryDataPoint[], historyIdCandidates: readonly string[]) => HistoryTestResult[];

package/dist/utils/history.js

@@ -9,6 +9,12 @@ const normalizeHistoryTestResults = (testResults) => {
     }
     return Object.fromEntries(Object.entries(testResults).filter(([, value]) => isRecord(value)));
 };
+const normalizeHistoryMetrics = (metrics) => {
+    if (!isRecord(metrics)) {
+        return {};
+    }
+    return Object.fromEntries(Object.entries(metrics).filter(([, value]) => Number.isFinite(value)));
+};
 const parametersCompare = (a, b) => {
     return (a.name ?? "").localeCompare(b.name ?? "") || (a.value ?? "").localeCompare(b.value ?? "");
 };
@@ -37,20 +43,11 @@ export const getHistoryIdCandidates = (tr) => {
     }
     return result;
 };
-export const filterUnknownByKnownIssues = (trs, knownIssueHistoryIds) => {
-    return trs.filter((tr) => {
-        const historyIdCandidates = getHistoryIdCandidates(tr);
-        if (historyIdCandidates.length === 0) {
-            return true;
-        }
-        return historyIdCandidates.every((historyId) => !knownIssueHistoryIds.has(historyId));
-    });
-};
 export const normalizeHistoryDataPoint = (historyDataPoint) => ({
     ...historyDataPoint,
     knownTestCaseIds: Array.isArray(historyDataPoint.knownTestCaseIds) ? historyDataPoint.knownTestCaseIds : [],
     testResults: normalizeHistoryTestResults(historyDataPoint.testResults),
-    metrics: isRecord(historyDataPoint.metrics) ? historyDataPoint.metrics : {},
+    metrics: normalizeHistoryMetrics(historyDataPoint.metrics),
     url: historyDataPoint.url ?? "",
 });
 export const normalizeHistoryDataPointUrls = (historyDataPoint) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@allurereport/core-api",
-  "version": "3.16.0",
+  "version": "3.17.0",
   "description": "Allure Core API",
   "keywords": [
     "allure"

package/dist/known.d.ts

@@ -1,20 +0,0 @@
-import type { TestLink } from "./metadata.js";
-import type { TestError } from "./model.js";
-export interface KnownIssueDecision {
-    reason: string;
-    links?: TestLink[];
-}
-export interface KnownTestFailure extends KnownIssueDecision {
-    historyId: string;
-    error?: TestError;
-}
-export interface KnownIssueDescriptor {
-    messageRegexp?: string;
-    testCaseId?: string;
-    retryHash?: string;
-    environmentId?: string;
-    decision: KnownIssueDecision;
-}
-export interface KnownIssuesConfig {
-    rules: KnownIssueDescriptor[];
-}