refactor(plugin-awesome, plugin-dashboard, web-commons): introduce DEFAULT_CHART_HISTORY_LIMIT and update trend chart options

Author: Viperwow

packages/plugin-awesome/src/charts.ts

@@ -1,6 +1,6 @@
 import type { HistoryDataPoint, SeverityLevel, Statistic, TestResult, TestStatus } from "@allurereport/core-api";
 import type { AllureStore, PluginContext } from "@allurereport/plugin-api";
-import { getPieChartDataDashboard, getSeverityTrendData, getStatusTrendData } from "@allurereport/web-commons";
+import { getPieChartDataDashboard, getSeverityTrendData, getStatusTrendData, DEFAULT_CHART_HISTORY_LIMIT } from "@allurereport/web-commons";
 import { randomUUID } from "crypto";
 import type { PieArcDatum } from "d3-shape";
 import { arc, pie } from "d3-shape";
@@ -416,13 +416,14 @@ export const generateTrendChart = (
   },
   context: PluginContext,
 ): TrendChartData | undefined => {
-  const { dataType } = options;
+  const newOptions = { limit: DEFAULT_CHART_HISTORY_LIMIT, ...options };
+  const { dataType } = newOptions;
   const { statistic, historyDataPoints, testResults } = stores;
 
   if (dataType === ChartData.Status) {
-    return getStatusTrendData(statistic, context.reportName, historyDataPoints, options);
+    return getStatusTrendData(statistic, context.reportName, historyDataPoints, newOptions);
   } else if (dataType === ChartData.Severity) {
-    return getSeverityTrendData(testResults, context.reportName, historyDataPoints, options);
+    return getSeverityTrendData(testResults, context.reportName, historyDataPoints, newOptions);
   }
 };
 

packages/plugin-dashboard/README.md

@@ -66,7 +66,7 @@ Trend charts allow you to track metrics over time. Available configurations:
   type: "trend",
   dataType: "status",
   mode: "percent", // optional, default: "raw"
-  limit: 10, // optional: limit number of builds
+  limit: 10, // optional: limit number of builds, default: 10
   title: "Custom Status Trend", // optional
   metadata: { // optional
     executionIdAccessor: (executionOrder) => `build-${executionOrder}`,

packages/plugin-dashboard/src/generators.ts

@@ -6,6 +6,7 @@ import {
   createReportDataScript,
   createScriptTag,
   createStylesLinkTag,
+  DEFAULT_CHART_HISTORY_LIMIT,
 } from "@allurereport/web-commons";
 import type { DashboardReportOptions } from "@allurereport/web-dashboard";
 import { randomUUID } from "crypto";
@@ -87,13 +88,14 @@ const generateTrendChart = (
   },
   context: PluginContext,
 ): TrendChartData | undefined => {
-  const { dataType } = options;
+  const newOptions = { limit: DEFAULT_CHART_HISTORY_LIMIT, ...options };
+  const { dataType } = newOptions;
   const { statistic, historyDataPoints, testResults } = stores;
 
   if (dataType === ChartData.Status) {
-    return getStatusTrendData(statistic, context.reportName, historyDataPoints, options);
+    return getStatusTrendData(statistic, context.reportName, historyDataPoints, newOptions);
   } else if (dataType === ChartData.Severity) {
-    return getSeverityTrendData(testResults, context.reportName, historyDataPoints, options);
+    return getSeverityTrendData(testResults, context.reportName, historyDataPoints, newOptions);
   }
 };
 

packages/web-commons/src/charts.ts

@@ -4,6 +4,8 @@ import { arc, pie } from "d3-shape";
 
 export type BasePieSlice = Pick<PieSlice, "status" | "count">;
 
+export const DEFAULT_CHART_HISTORY_LIMIT = 10;
+
 export const d3Arc = arc<PieArcDatum<BasePieSlice>>().innerRadius(40).outerRadius(50).cornerRadius(2).padAngle(0.03);
 
 export const d3Pie = pie<BasePieSlice>()