Skip to content

📝 Add docstrings to feat/dashboard-home-ui #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
coderabbitai wants to merge 1 commit into from
Closed

📝 Add docstrings to feat/dashboard-home-ui #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions frontend/src/pages/dashboard/DashboardPage.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,12 @@ const appFontFamily =
const donutPassColor = "#a8b9ee";
const donutFailColor = "#4a5a9a";

/**
* Renders a styled status tag or placeholder for a batch result string.
*
* @param result - The batch result text to display; may be null or undefined.
* @returns A React element: a colored Tag indicating "fail" (error color), "pass" (success color), or "processing" for other values, or a bold dash when the input is empty.
*/
function renderBatchResultTag(result: string | null | undefined) {
const label = (result || "").trim();
if (!label) {
Expand All @@ -42,6 +48,12 @@ function renderBatchResultTag(result: string | null | undefined) {
);
}

/**
* Build an ECharts option for visualizing batch trends as two smoothed line series.
*
* @param items - Array of batch trend entries; each element is used in order for x-axis categories and series data points.
* @returns An ECharts option object that renders two line series labeled "失败用例数" (failed cases) and "总用例数" (total cases), with axis, tooltip, legend, grid, and area styling configured for trend visualization.
*/
function buildChartOption(items: BatchTrendItem[]) {
return {
tooltip: {
Expand Down Expand Up @@ -125,6 +137,14 @@ function buildChartOption(items: BatchTrendItem[]) {
};
}

/**
* Builds an ECharts option for a donut chart that visualizes pass vs. fail composition for a batch.
*
* @param passed - Number of passed cases in the batch.
* @param failed - Number of failed cases in the batch.
* @param totalCaseNum - Reported total case count to display at chart center; if not a number or negative, the displayed total falls back to `passed + failed`.
* @returns An ECharts option object for a donut (pie) chart. If `passed + failed` is zero the option contains only centered total text and an empty-data title; otherwise it includes tooltip, legend, colored slices for "通过" and "失败", and a centered total graphic.
*/
function buildDonutOption(passed: number, failed: number, totalCaseNum: number) {
const sum = passed + failed;
const centerTotal =
Expand Down Expand Up @@ -217,6 +237,14 @@ function buildDonutOption(passed: number, failed: number, totalCaseNum: number)
};
}

/**
* Render the dashboard page showing the latest batch donut and branch trend charts.
*
* Fetches latest batch data and recent batch trends for "master" and "bugfix", displays loading and empty states,
* and navigates to the history view when a batch card or a chart point is clicked.
*
* @returns The React element for the dashboard page containing the latest-batch summary and branch trend charts.
*/
export default function DashboardPage() {
const navigate = useNavigate();
const [latestBatch, setLatestBatch] = useState<LatestBatchItem | null | undefined>(undefined);
Expand Down
Loading