@openshift-migration-advisor/shared-components 0.25.0-0ad1e70d1fa5 → 0.25.0-1701f64050d7

package/src/report/NetworkOverview.tsx

@@ -0,0 +1,405 @@
+import { css } from "@emotion/css";
+import {
+  Card,
+  CardBody,
+  CardTitle,
+  Dropdown,
+  DropdownItem,
+  DropdownList,
+  Flex,
+  FlexItem,
+  MenuToggle,
+  type MenuToggleElement,
+} from "@patternfly/react-core";
+import { TopologyIcon } from "@patternfly/react-icons";
+import {
+  chart_color_black_500,
+  chart_color_blue_300,
+  chart_color_green_300,
+  chart_color_orange_100,
+  chart_color_purple_100,
+  chart_color_purple_300,
+  chart_color_red_orange_200,
+  chart_color_teal_200,
+  chart_color_teal_400,
+  chart_color_yellow_400,
+} from "@patternfly/react-tokens";
+import type { FC, Ref } from "react";
+import { useMemo, useState } 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 { chartExportViewsFromLabels } from "./chartExport.js";
+import { REPORT_CARD_EMPTY_STATE_TITLES } from "./constants.js";
+import { dashboardStyles } from "./dashboardStyles.js";
+
+/** Network fields this card reads. Apps pass SDK networks structurally. */
+export interface NetworkLike {
+  vmsCount?: number;
+  vlanId?: string | number;
+}
+
+/** Infra fields this card reads. */
+export interface NetworkInfraLike {
+  networks?: NetworkLike[];
+}
+
+/** Deprecated NIC histogram used when `distributionByNicCount` is absent. */
+export interface NicCountHistogram {
+  data?: number[];
+  minValue?: number;
+  step?: number;
+}
+
+/** NIC summary fields this card reads from the VM resource breakdown. */
+export interface NicCountSummary {
+  total?: number;
+  histogram?: NicCountHistogram;
+}
+
+export interface NetworkOverviewProps {
+  infra?: NetworkInfraLike;
+  nicCount?: NicCountSummary;
+  distributionByNicCount?: Record<string, number>;
+  /** `"html"` in agent-ui; ui-app passes `"chart"`. */
+  legendVariant?: MigrationDonutChartLegendVariant;
+}
+
+type ViewMode = "networkDistribution" | "nicCount";
+
+const VIEW_MODE_LABELS: Record<ViewMode, string> = {
+  networkDistribution: "VM distribution by network",
+  nicCount: "VM distribution by NIC count",
+};
+
+const TOP_NETWORKS = 4;
+const REST_OF_NETWORKS_LABEL = "Rest of networks";
+const CHART_ID = "network-overview";
+const CHART_TITLE = "Networks";
+
+/**
+ * Categorical order from the ui-app network donut, mapped onto PatternFly
+ * `chart_color_*` tokens (nearest token where the old hex was not a token).
+ */
+const NETWORK_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,
+  chart_color_orange_100.value,
+  chart_color_red_orange_200.value,
+  chart_color_teal_400.value,
+  chart_color_black_500.value,
+];
+
+const cardSubtitle = css`
+  color: var(--pf-t--global--text--color--subtle);
+  font-size: 0.85rem;
+`;
+
+const menuToggleMinWidth = css`
+  min-width: 250px;
+`;
+
+const titleRow = css`
+  width: 100%;
+`;
+
+const isViewMode = (value: string | number | undefined): value is ViewMode =>
+  value === "networkDistribution" || value === "nicCount";
+
+const legendFor = (categories: string[]): Record<string, string> => {
+  const legend: Record<string, string> = {};
+  categories.forEach((category, index) => {
+    const color = NETWORK_COLORS[index % NETWORK_COLORS.length];
+    if (color) {
+      legend[category] = color;
+    }
+  });
+  return legend;
+};
+
+const vlanLabel = (vlanId: NetworkLike["vlanId"]): string => {
+  if (typeof vlanId !== "string" && typeof vlanId !== "number") {
+    return "-";
+  }
+  const value = String(vlanId).trim();
+  return value !== "" ? value : "-";
+};
+
+const buildNetworkDonut = (
+  networks: NetworkLike[] | undefined,
+): {
+  slices: MigrationDonutChartDatum[];
+  legend: Record<string, string>;
+  title: string;
+  vlanBySlice: Record<string, string>;
+} => {
+  const items = (Array.isArray(networks) ? networks : [])
+    .map((network) => ({
+      vmsCount:
+        typeof network?.vmsCount === "number" ? network.vmsCount : Number.NaN,
+      vlanId: vlanLabel(network?.vlanId),
+    }))
+    .filter(
+      (network) => Number.isFinite(network.vmsCount) && network.vmsCount >= 0,
+    )
+    .sort((a, b) => b.vmsCount - a.vmsCount);
+
+  const totalVMs = items.reduce((sum, network) => sum + network.vmsCount, 0);
+  const top = items.slice(0, TOP_NETWORKS);
+  const restSum = items
+    .slice(TOP_NETWORKS)
+    .reduce((sum, network) => sum + network.vmsCount, 0);
+
+  const vlanBySlice: Record<string, string> = {};
+  const slices: MigrationDonutChartDatum[] = top.map((network, index) => {
+    const name = `Network ${index + 1}`;
+    vlanBySlice[name] = network.vlanId;
+    return {
+      name,
+      count: network.vmsCount,
+      countDisplay: `${network.vmsCount} VMs`,
+      legendCategory: name,
+    };
+  });
+
+  if (restSum > 0) {
+    slices.push({
+      name: REST_OF_NETWORKS_LABEL,
+      count: restSum,
+      countDisplay: `${restSum} VMs`,
+      legendCategory: REST_OF_NETWORKS_LABEL,
+    });
+    vlanBySlice[REST_OF_NETWORKS_LABEL] = "-";
+  }
+
+  return {
+    slices,
+    legend: legendFor(slices.map((slice) => slice.legendCategory)),
+    title: `${totalVMs}`,
+    vlanBySlice,
+  };
+};
+
+const nicBucketLabel = (bucket: string): string => {
+  const count = Number.parseInt(bucket, 10);
+  if (bucket.endsWith("+")) {
+    return `${count}+ NIC`;
+  }
+  return count === 1 ? "1 NIC" : `${count} NIC`;
+};
+
+const compareNicBuckets = (
+  a: { bucket: string },
+  b: { bucket: string },
+): number => {
+  const aPlus = a.bucket.endsWith("+");
+  const bPlus = b.bucket.endsWith("+");
+  if (aPlus !== bPlus) {
+    return aPlus ? 1 : -1;
+  }
+  const aNum = Number.parseInt(a.bucket, 10);
+  const bNum = Number.parseInt(b.bucket, 10);
+  if (Number.isFinite(aNum) && Number.isFinite(bNum)) {
+    return aNum - bNum;
+  }
+  return a.bucket.localeCompare(b.bucket);
+};
+
+const slicesFromBuckets = (
+  entries: { bucket: string; count: number }[],
+): MigrationDonutChartDatum[] =>
+  entries.map((entry) => {
+    const label = nicBucketLabel(entry.bucket);
+    return {
+      name: label,
+      count: entry.count,
+      countDisplay: `${entry.count} VMs`,
+      legendCategory: label,
+    };
+  });
+
+const buildNicDonut = (
+  distributionByNicCount: Record<string, number> | undefined,
+  nicCount: NicCountSummary | undefined,
+): {
+  slices: MigrationDonutChartDatum[];
+  legend: Record<string, string>;
+  title: string;
+} => {
+  if (distributionByNicCount != null) {
+    const entries = Object.entries(distributionByNicCount)
+      .map(([bucket, value]) => ({
+        bucket,
+        count: Number.isFinite(Number(value)) ? Number(value) : 0,
+      }))
+      .filter((entry) => entry.count > 0)
+      .sort(compareNicBuckets);
+    const slices = slicesFromBuckets(entries);
+    const total = entries.reduce((sum, entry) => sum + entry.count, 0);
+    return {
+      slices,
+      legend: legendFor(slices.map((slice) => slice.legendCategory)),
+      title: `${total}`,
+    };
+  }
+
+  const histogram = nicCount?.histogram;
+  const data = Array.isArray(histogram?.data) ? histogram.data : [];
+  const minValue =
+    typeof histogram?.minValue === "number" ? histogram.minValue : 0;
+  const step = typeof histogram?.step === "number" ? histogram.step : 1;
+  const buckets = data
+    .map((count, index) => ({
+      bucket: String(minValue + index * step),
+      count: Number(count) || 0,
+    }))
+    .filter((entry) => entry.count > 0)
+    .sort((a, b) => Number(a.bucket) - Number(b.bucket));
+  const slices = slicesFromBuckets(buckets);
+  const total =
+    typeof nicCount?.total === "number"
+      ? nicCount.total
+      : buckets.reduce((sum, entry) => sum + entry.count, 0);
+
+  return {
+    slices,
+    legend: legendFor(slices.map((slice) => slice.legendCategory)),
+    title: `${total}`,
+  };
+};
+
+export const NetworkOverview: FC<NetworkOverviewProps> = ({
+  infra,
+  nicCount,
+  distributionByNicCount,
+  legendVariant = "html",
+}) => {
+  const [viewMode, setViewMode] = useState<ViewMode>("networkDistribution");
+  const [isDropdownOpen, setIsDropdownOpen] = useState(false);
+
+  const networkChart = useMemo(
+    () => buildNetworkDonut(infra?.networks),
+    [infra?.networks],
+  );
+  const nicChart = useMemo(
+    () => buildNicDonut(distributionByNicCount, nicCount),
+    [distributionByNicCount, nicCount],
+  );
+
+  const chartTitle = `${CHART_TITLE} — ${VIEW_MODE_LABELS[viewMode]}`;
+  const activeChart =
+    viewMode === "networkDistribution" ? networkChart : nicChart;
+  const emptyTitle =
+    viewMode === "networkDistribution"
+      ? REPORT_CARD_EMPTY_STATE_TITLES.networks
+      : REPORT_CARD_EMPTY_STATE_TITLES.nicCount;
+
+  return (
+    <ChartExportSurface
+      id={CHART_ID}
+      title={chartTitle}
+      exportViews={chartExportViewsFromLabels(CHART_TITLE, VIEW_MODE_LABELS)}
+      activeExportViewId={viewMode}
+      onExportViewChange={(viewId) => {
+        if (isViewMode(viewId)) {
+          setViewMode(viewId);
+        }
+      }}
+    >
+      <Card className={dashboardStyles.card}>
+        <CardTitle>
+          <Flex
+            className={titleRow}
+            justifyContent={{ default: "justifyContentSpaceBetween" }}
+            alignItems={{ default: "alignItemsCenter" }}
+          >
+            <FlexItem>
+              <div>
+                <div>
+                  <TopologyIcon /> {CHART_TITLE}
+                </div>
+                {viewMode === "networkDistribution" && (
+                  <div className={cardSubtitle}>Top 5 networks</div>
+                )}
+              </div>
+            </FlexItem>
+            <ChartHeaderActions chartId={CHART_ID} title={chartTitle}>
+              <Dropdown
+                isOpen={isDropdownOpen}
+                onSelect={(_event, value) => {
+                  if (isViewMode(value)) {
+                    setViewMode(value);
+                  }
+                  setIsDropdownOpen(false);
+                }}
+                onOpenChange={setIsDropdownOpen}
+                toggle={(toggleRef: Ref<MenuToggleElement>) => (
+                  <MenuToggle
+                    ref={toggleRef}
+                    onClick={() => setIsDropdownOpen((open) => !open)}
+                    isExpanded={isDropdownOpen}
+                    className={menuToggleMinWidth}
+                  >
+                    {VIEW_MODE_LABELS[viewMode]}
+                  </MenuToggle>
+                )}
+              >
+                <DropdownList>
+                  <DropdownItem
+                    value="networkDistribution"
+                    key="networkDistribution"
+                  >
+                    {VIEW_MODE_LABELS.networkDistribution}
+                  </DropdownItem>
+                  <DropdownItem value="nicCount" key="nicCount">
+                    {VIEW_MODE_LABELS.nicCount}
+                  </DropdownItem>
+                </DropdownList>
+              </Dropdown>
+            </ChartHeaderActions>
+          </Flex>
+        </CardTitle>
+        <CardBody className={dashboardStyles.cardBodyScrollable}>
+          {activeChart.slices.length === 0 ? (
+            <CardEmptyState title={emptyTitle} />
+          ) : (
+            <MigrationDonutChart
+              legendVariant={legendVariant}
+              data={activeChart.slices}
+              legend={activeChart.legend}
+              height={300}
+              width={420}
+              donutThickness={18}
+              titleFontSize={34}
+              title={activeChart.title}
+              subTitle="VMs"
+              subTitleColor="var(--pf-t--global--text--color--subtle)"
+              itemsPerRow={Math.ceil(activeChart.slices.length / 2)}
+              labelFontSize={18}
+              marginLeft="0%"
+              tooltipLabelFormatter={({ datum, percent }) => {
+                const summary = `${datum.countDisplay}\n${percent.toFixed(1)}%`;
+                if (viewMode !== "networkDistribution") {
+                  return summary;
+                }
+                const vlan = networkChart.vlanBySlice[datum.legendCategory];
+                return `${summary}\nVLAN: ${vlan ?? "-"}`;
+              }}
+            />
+          )}
+        </CardBody>
+      </Card>
+    </ChartExportSurface>
+  );
+};
+
+NetworkOverview.displayName = "NetworkOverview";

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());