@openshift-migration-advisor/shared-components 0.25.0-fce5293f01c1 → 0.27.0-6438cd962b5f

package/src/report/ChartExportProvider.tsx

@@ -11,6 +11,7 @@ import {
   type ChartExportFile,
   canvasToBlob,
   downloadBlob,
+  type PdfTextPage,
   type RegisteredChart,
   releaseCanvas,
   restoreChartExportViews,
@@ -36,6 +37,12 @@ export type BuildChartDocument = (
   documentTitle: string,
 ) => Promise<Blob>;
 
+export type BuildPdfDocument = (
+  charts: ChartCaptureSource[],
+  documentTitle: string,
+  extraPages?: PdfTextPage[],
+) => Promise<Blob>;
+
 export type {
   ChartExportApi,
   ChartExportFormat,
@@ -47,7 +54,7 @@ export interface ChartExportProviderProps {
   capture?: CaptureChartElement;
   zipFiles?: ZipChartFiles;
   encodePng?: EncodeChartPng;
-  buildPdf?: BuildChartDocument;
+  buildPdf?: BuildPdfDocument;
   buildHtml?: BuildChartDocument;
   downloadFile?: (blob: Blob, filename: string) => void;
   getZipFilename?: () => string;
@@ -96,8 +103,8 @@ async function resolveZip(override?: ZipChartFiles): Promise<ZipChartFiles> {
 }
 
 async function resolvePdf(
-  override?: BuildChartDocument,
-): Promise<BuildChartDocument> {
+  override?: BuildPdfDocument,
+): Promise<BuildPdfDocument> {
   if (override) {
     return override;
   }
@@ -281,11 +288,11 @@ export const ChartExportProvider: FC<ChartExportProviderProps> = ({
   ]);
 
   const downloadPdf = useCallback(
-    async (documentTitle: string) => {
+    async (documentTitle: string, extraPages?: PdfTextPage[]) => {
       await runCapture(
         async () => {
           const charts = listCharts();
-          if (charts.length === 0) {
+          if (charts.length === 0 && (extraPages?.length ?? 0) === 0) {
             throw new Error("The report is not ready to export yet.");
           }
           const captureFn = await resolveCapture(capture);
@@ -296,6 +303,7 @@ export const ChartExportProvider: FC<ChartExportProviderProps> = ({
               await build(
                 toCaptureSources(charts, captureFn, prepareElement),
                 documentTitle,
+                extraPages,
               ),
               getPdfFilename(),
             );

package/src/report/ErrorTable.tsx

@@ -0,0 +1,85 @@
+import {
+  Card,
+  CardBody,
+  CardTitle,
+  Flex,
+  FlexItem,
+  Icon,
+} from "@patternfly/react-core";
+import { ExclamationCircleIcon } from "@patternfly/react-icons";
+import type React from "react";
+import { CardEmptyState } from "./CardEmptyState.js";
+import { ChartHeaderActions } from "./ChartDownloadButton.js";
+import { ChartExportSurface } from "./ChartExportSurface.js";
+import { REPORT_CARD_EMPTY_STATE_TITLES } from "./constants.js";
+import { dashboardStyles } from "./dashboardStyles.js";
+import { ReportTable } from "./ReportTable.js";
+
+/**
+ * Minimal shape of a migration issue consumed by {@link ErrorTable}. Declared
+ * locally so this package does not depend on a specific SDK (`agent-sdk` or
+ * `planner-sdk`); callers pass the subset of `MigrationIssue` fields read here.
+ */
+export interface MigrationIssueLike {
+  label: string;
+  assessment: string;
+  count: number;
+}
+
+export interface ErrorTableProps {
+  errors: MigrationIssueLike[];
+  /** Optional drill-down callback invoked with an issue's `label`. */
+  onConcernClick?: (concernLabel: string) => void;
+}
+
+export const ErrorTable: React.FC<ErrorTableProps> = ({
+  errors,
+  onConcernClick,
+}) => {
+  const handleRowClick = (issue: MigrationIssueLike) => {
+    if (issue.label && onConcernClick) {
+      onConcernClick(issue.label);
+    }
+  };
+
+  const chartId = "errors-table";
+  const chartTitle = "Errors";
+
+  return (
+    <ChartExportSurface id={chartId} title={chartTitle}>
+      <Card className={dashboardStyles.card}>
+        <CardTitle>
+          <Flex
+            justifyContent={{ default: "justifyContentSpaceBetween" }}
+            alignItems={{ default: "alignItemsCenter" }}
+          >
+            <FlexItem>
+              <Icon status="danger">
+                <ExclamationCircleIcon />
+              </Icon>{" "}
+              Errors
+            </FlexItem>
+            <ChartHeaderActions chartId={chartId} title={chartTitle} />
+          </Flex>
+        </CardTitle>
+        <CardBody className={dashboardStyles.cardBodyScrollable}>
+          {errors.length === 0 ? (
+            <CardEmptyState title={REPORT_CARD_EMPTY_STATE_TITLES.errors} />
+          ) : (
+            <div>
+              <ReportTable<MigrationIssueLike>
+                data={errors}
+                columns={["Description", "Total VMs"]}
+                fields={["assessment", "count"]}
+                onRowClick={onConcernClick ? handleRowClick : undefined}
+                clickableFields={onConcernClick ? ["assessment"] : []}
+              />
+            </div>
+          )}
+        </CardBody>
+      </Card>
+    </ChartExportSurface>
+  );
+};
+
+ErrorTable.displayName = "ErrorTable";

package/src/report/HostsOverview.tsx

@@ -0,0 +1,185 @@
+import { css } from "@emotion/css";
+import {
+  Card,
+  CardBody,
+  CardTitle,
+  Flex,
+  FlexItem,
+} from "@patternfly/react-core";
+import { ServerIcon } from "@patternfly/react-icons";
+import {
+  chart_color_blue_300,
+  chart_color_green_300,
+  chart_color_purple_100,
+  chart_color_purple_300,
+  chart_color_teal_200,
+  chart_color_yellow_400,
+} from "@patternfly/react-tokens";
+import type { FC } from "react";
+import { useMemo } from "react";
+import {
+  MigrationDonutChart,
+  type MigrationDonutChartDatum,
+  type MigrationDonutChartLegendVariant,
+} from "../charts/MigrationDonutChart.js";
+import { CardEmptyState } from "./CardEmptyState.js";
+import { ChartHeaderActions } from "./ChartDownloadButton.js";
+import { ChartExportSurface } from "./ChartExportSurface.js";
+import { REPORT_CARD_EMPTY_STATE_TITLES } from "./constants.js";
+import { dashboardStyles } from "./dashboardStyles.js";
+
+/** Smallest host shape this card reads. Apps pass SDK hosts structurally. */
+export interface HostLike {
+  model?: string | number;
+}
+
+export interface HostsOverviewProps {
+  hosts?: HostLike[];
+  /** `"html"` in agent-ui; ui-app passes `"chart"`. */
+  legendVariant?: MigrationDonutChartLegendVariant;
+}
+
+const TOP_HOST_MODELS = 5;
+const OTHER_MODELS_LABEL = "Other models";
+const UNKNOWN_MODEL_LABEL = "Unknown model";
+const CHART_ID = "hosts-overview";
+const CHART_TITLE = "Host distribution by model";
+
+/**
+ * Same categorical order as the ui-app host-model donut, mapped onto
+ * PatternFly `chart_color_*` tokens (nearest token where the old hex
+ * was not itself a token).
+ */
+const HOST_MODEL_COLORS = [
+  chart_color_blue_300.value,
+  chart_color_purple_300.value,
+  chart_color_purple_100.value,
+  chart_color_teal_200.value,
+  chart_color_yellow_400.value,
+  chart_color_green_300.value,
+];
+
+const cardSubtitle = css`
+  color: var(--pf-t--global--text--color--subtle);
+  font-size: 0.85rem;
+`;
+
+const hostModelLabel = (model: HostLike["model"]): string => {
+  const raw =
+    typeof model === "string"
+      ? model
+      : typeof model === "number"
+        ? String(model)
+        : "";
+  const trimmed = raw.trim();
+  return trimmed !== "" ? trimmed : UNKNOWN_MODEL_LABEL;
+};
+
+const buildHostModelDonut = (
+  hosts: HostLike[],
+): {
+  slices: MigrationDonutChartDatum[];
+  legend: Record<string, string>;
+  totalHosts: number;
+} => {
+  const counts = new Map<string, number>();
+  for (const host of hosts) {
+    const label = hostModelLabel(host?.model);
+    counts.set(label, (counts.get(label) ?? 0) + 1);
+  }
+
+  const entries = [...counts.entries()]
+    .map(([model, count]) => ({ model, count }))
+    .sort((a, b) => b.count - a.count);
+
+  const top = entries.slice(0, TOP_HOST_MODELS);
+  const restSum = entries
+    .slice(TOP_HOST_MODELS)
+    .reduce((sum, entry) => sum + entry.count, 0);
+
+  const slices: MigrationDonutChartDatum[] = top.map((entry) => ({
+    name: entry.model,
+    count: entry.count,
+    countDisplay: `${entry.count} hosts`,
+    legendCategory: entry.model,
+  }));
+
+  if (restSum > 0) {
+    slices.push({
+      name: OTHER_MODELS_LABEL,
+      count: restSum,
+      countDisplay: `${restSum} hosts`,
+      legendCategory: OTHER_MODELS_LABEL,
+    });
+  }
+
+  const legend: Record<string, string> = {};
+  slices.forEach((slice, index) => {
+    const color = HOST_MODEL_COLORS[index % HOST_MODEL_COLORS.length];
+    if (color) {
+      legend[slice.legendCategory] = color;
+    }
+  });
+
+  return { slices, legend, totalHosts: hosts.length };
+};
+
+export const HostsOverview: FC<HostsOverviewProps> = ({
+  hosts,
+  legendVariant = "html",
+}) => {
+  const { slices, legend, totalHosts } = useMemo(
+    () => buildHostModelDonut(Array.isArray(hosts) ? hosts : []),
+    [hosts],
+  );
+
+  return (
+    <ChartExportSurface id={CHART_ID} title={CHART_TITLE}>
+      <Card className={dashboardStyles.card}>
+        <CardTitle>
+          <Flex
+            justifyContent={{ default: "justifyContentSpaceBetween" }}
+            alignItems={{ default: "alignItemsCenter" }}
+          >
+            <FlexItem>
+              <div>
+                <div>
+                  <ServerIcon /> {CHART_TITLE}
+                </div>
+                <div className={cardSubtitle}>Top 5 models</div>
+              </div>
+            </FlexItem>
+            <ChartHeaderActions chartId={CHART_ID} title={CHART_TITLE} />
+          </Flex>
+        </CardTitle>
+        <CardBody className={dashboardStyles.cardBodyScrollable}>
+          {slices.length === 0 ? (
+            <CardEmptyState title={REPORT_CARD_EMPTY_STATE_TITLES.hosts} />
+          ) : (
+            <MigrationDonutChart
+              legendVariant={legendVariant}
+              data={slices}
+              height={300}
+              width={420}
+              donutThickness={18}
+              titleFontSize={34}
+              legend={legend}
+              legendWidth={680}
+              title={`${totalHosts}`}
+              subTitle="Hosts"
+              subTitleColor="var(--pf-t--global--text--color--subtle)"
+              itemsPerRow={2}
+              labelFontSize={16}
+              marginLeft="0%"
+              tooltipLabelFormatter={({ datum, percent }) =>
+                `${datum.countDisplay}\n${percent.toFixed(1)}%`
+              }
+            />
+          )}
+        </CardBody>
+      </Card>
+    </ChartExportSurface>
+  );
+};
+
+HostsOverview.displayName = "HostsOverview";

package/src/report/ReportTable.tsx

@@ -0,0 +1,81 @@
+import { Button } from "@patternfly/react-core";
+import { Table, Tbody, Td, Th, Thead, Tr } from "@patternfly/react-table";
+import type React from "react";
+import { tableFullWidthStyle } from "./dashboardStyles.js";
+
+export interface ReportTableProps<DataItem> {
+  columns: string[];
+  data: DataItem[];
+  fields: Array<keyof DataItem>;
+  caption?: string;
+  onRowClick?: (item: DataItem) => void;
+  clickableFields?: Array<keyof DataItem>;
+}
+
+export function ReportTable<DataItem>(
+  props: ReportTableProps<DataItem>,
+): React.ReactNode {
+  const {
+    columns,
+    data,
+    fields,
+    caption,
+    onRowClick,
+    clickableFields = [],
+  } = props;
+
+  const renderCell = (
+    item: DataItem,
+    field: keyof DataItem,
+  ): React.ReactNode => {
+    const value = item[field];
+
+    if (value === "" || value == null) {
+      return "-";
+    }
+
+    if (typeof value === "boolean") {
+      return value ? "True" : "False";
+    }
+
+    // Make field clickable if specified
+    if (clickableFields.includes(field) && onRowClick) {
+      return (
+        <Button
+          variant="link"
+          isInline
+          onClick={() => onRowClick(item)}
+          style={{ padding: 0, fontSize: "inherit" }}
+        >
+          {value as React.ReactNode}
+        </Button>
+      );
+    }
+
+    return value as React.ReactNode;
+  };
+
+  return (
+    <Table variant="compact" borders={false} className={tableFullWidthStyle}>
+      {caption && <caption>{caption}</caption>}
+      <Thead>
+        <Tr>
+          {columns.map((name) => (
+            <Th key={name}>{name}</Th>
+          ))}
+        </Tr>
+      </Thead>
+      <Tbody>
+        {data.map((item) => (
+          <Tr key={`row-${String(item[fields[0]])}`}>
+            {fields.map((f) => (
+              <Td key={String(f)}>{renderCell(item, f)}</Td>
+            ))}
+          </Tr>
+        ))}
+      </Tbody>
+    </Table>
+  );
+}
+
+ReportTable.displayName = "ReportTable";

package/src/report/WarningsTable.tsx

@@ -0,0 +1,75 @@
+import {
+  Card,
+  CardBody,
+  CardTitle,
+  Flex,
+  FlexItem,
+  Icon,
+} from "@patternfly/react-core";
+import { ExclamationTriangleIcon } from "@patternfly/react-icons";
+import type React from "react";
+import { CardEmptyState } from "./CardEmptyState.js";
+import { ChartHeaderActions } from "./ChartDownloadButton.js";
+import { ChartExportSurface } from "./ChartExportSurface.js";
+import { REPORT_CARD_EMPTY_STATE_TITLES } from "./constants.js";
+import { dashboardStyles } from "./dashboardStyles.js";
+import type { MigrationIssueLike } from "./ErrorTable.js";
+import { ReportTable } from "./ReportTable.js";
+
+export interface WarningsTableProps {
+  warnings: MigrationIssueLike[];
+  /** Optional drill-down callback invoked with an issue's `label`. */
+  onConcernClick?: (concernLabel: string) => void;
+}
+
+export const WarningsTable: React.FC<WarningsTableProps> = ({
+  warnings,
+  onConcernClick,
+}) => {
+  const handleRowClick = (issue: MigrationIssueLike) => {
+    if (issue.label && onConcernClick) {
+      onConcernClick(issue.label);
+    }
+  };
+
+  const chartId = "warnings-table";
+  const chartTitle = "Warnings";
+
+  return (
+    <ChartExportSurface id={chartId} title={chartTitle}>
+      <Card className={dashboardStyles.card}>
+        <CardTitle>
+          <Flex
+            justifyContent={{ default: "justifyContentSpaceBetween" }}
+            alignItems={{ default: "alignItemsCenter" }}
+          >
+            <FlexItem>
+              <Icon status="warning">
+                <ExclamationTriangleIcon />
+              </Icon>{" "}
+              Warnings
+            </FlexItem>
+            <ChartHeaderActions chartId={chartId} title={chartTitle} />
+          </Flex>
+        </CardTitle>
+        <CardBody className={dashboardStyles.cardBodyScrollable}>
+          {warnings.length === 0 ? (
+            <CardEmptyState title={REPORT_CARD_EMPTY_STATE_TITLES.warnings} />
+          ) : (
+            <div>
+              <ReportTable<MigrationIssueLike>
+                data={warnings}
+                columns={["Description", "Total VMs"]}
+                fields={["assessment", "count"]}
+                onRowClick={onConcernClick ? handleRowClick : undefined}
+                clickableFields={onConcernClick ? ["assessment"] : []}
+              />
+            </div>
+          )}
+        </CardBody>
+      </Card>
+    </ChartExportSurface>
+  );
+};
+
+WarningsTable.displayName = "WarningsTable";

package/src/report/__tests__/ChartExportProvider.test.tsx

@@ -101,12 +101,18 @@ function DownloadChartButton({ id }: { id: string }): JSX.Element {
   );
 }
 
-function DownloadPdfButton(): JSX.Element {
+function DownloadPdfButton({
+  extraPages,
+}: {
+  extraPages?: Parameters<
+    NonNullable<ReturnType<typeof useChartExport>>["downloadPdf"]
+  >[1];
+}): JSX.Element {
   const exportApi = useChartExport();
   return (
     <button
       type="button"
-      onClick={() => void exportApi?.downloadPdf("Overview")}
+      onClick={() => void exportApi?.downloadPdf("Overview", extraPages)}
     >
       Download pdf
     </button>
@@ -236,6 +242,68 @@ describe("ChartExportProvider", () => {
     expect(downloadFile).toHaveBeenCalledWith(expect.any(Blob), "report.pdf");
   });
 
+  it("forwards extra text pages (e.g. cluster sizing recommendations) to the pdf builder", async () => {
+    const user = userEvent.setup();
+    const capture = vi.fn(async () => fakeCanvas());
+    const buildPdf = vi.fn(async () => new Blob(["pdf"]));
+    const downloadFile = vi.fn();
+    const extraPages = [
+      {
+        title: "Cluster sizing recommendations",
+        items: [
+          { label: "Cluster name", value: "cluster-1" },
+          { label: "Target platform", value: "Bare metal" },
+        ],
+        footer: "Note: estimates only.",
+      },
+    ];
+
+    render(
+      <ChartExportProvider
+        capture={capture}
+        zipFiles={vi.fn()}
+        buildPdf={buildPdf}
+        downloadFile={downloadFile}
+        getPdfFilename={() => "report.pdf"}
+      >
+        <RegisteredChart id="storage" title="Disks" />
+        <DownloadPdfButton extraPages={extraPages} />
+      </ChartExportProvider>,
+    );
+
+    await user.click(screen.getByRole("button", { name: "Download pdf" }));
+
+    expect(buildPdf).toHaveBeenCalledTimes(1);
+    expect(buildPdf.mock.calls[0]?.[2]).toEqual(extraPages);
+    expect(downloadFile).toHaveBeenCalledWith(expect.any(Blob), "report.pdf");
+  });
+
+  it("builds a PDF from extra text pages alone when no charts are registered", async () => {
+    const user = userEvent.setup();
+    const buildPdf = vi.fn(async () => new Blob(["pdf"]));
+    const downloadFile = vi.fn();
+    const extraPages = [{ title: "Cluster sizing recommendations", items: [] }];
+
+    render(
+      <ChartExportProvider
+        capture={vi.fn()}
+        zipFiles={vi.fn()}
+        buildPdf={buildPdf}
+        downloadFile={downloadFile}
+        getPdfFilename={() => "report.pdf"}
+      >
+        <DownloadPdfButton extraPages={extraPages} />
+      </ChartExportProvider>,
+    );
+
+    await user.click(screen.getByRole("button", { name: "Download pdf" }));
+
+    expect(buildPdf).toHaveBeenCalledTimes(1);
+    expect(buildPdf.mock.calls[0]?.[0]).toEqual([]);
+    expect(buildPdf.mock.calls[0]?.[2]).toEqual(extraPages);
+    expect(downloadFile).toHaveBeenCalledWith(expect.any(Blob), "report.pdf");
+  });
+
   it("builds HTML from the same captured canvases", async () => {
     const user = userEvent.setup();
     const capture = vi.fn(async () => fakeCanvas());