SPB Git

Repository Public

widgets.tsx 20.7 KB 430 lines tsx

1"use client";2import Link from "next/link";3import { createContext, useContext, useId, useMemo, useState, type ReactNode } from "react";4import type { Schemas } from "@/api/client";5import { useApiQuery } from "@/api/query";6import { metricLabel } from "@/features/shared/metrics";7import { useI18n, type I18n, type TKey } from "@/i18n";8import { usePeriod } from "@/shell/period";9import { useSession } from "@/shell/session";10import { Badge, DataStamp, EmptyState, Icon, Meter, QueryBoundary, Segmented, SelectField, StateDot, Unmeasured, actionIcon, actionTone, maintenanceTone, severityTone, type IconName, type Tone } from "@/ui";11import { TimeSeriesChart } from "@/ui/TimeSeriesChart";12import { TREND_GROUPS, TREND_METRICS, isWidgetType, trendConfig, trendRange, type TrendGroup, type Widget, type WidgetType } from "./layout";1314export const WIDGET_ICON: Record<WidgetType, IconName> = { nodes: "nodes", capacity: "chart", trends: "activity", alerts: "alerts", incidents: "critical", jobs: "jobs", services: "services", models: "models", storage: "storage", maintenance: "maintenance", actions: "bolt" };15const TITLE: Record<WidgetType, TKey> = {16  nodes: "overview.widget.nodes", capacity: "overview.widget.capacity", trends: "overview.widget.trends", alerts: "overview.widget.alerts", incidents: "overview.widget.incidents", jobs: "overview.widget.jobs",17  services: "overview.widget.services", models: "overview.widget.models", storage: "overview.widget.storage", maintenance: "overview.widget.maintenance", actions: "overview.widget.actions",18};1920/** Display title of a widget (used by the frame and by the accessible names of the edit controls). */21export function widgetTitle(t: I18n["t"], w: Pick<Widget, "type" | "config">): string {22  if (!isWidgetType(w.type)) return t("overview.widget.unknown");23  if (w.type === "trends") return t("overview.trends.title", { metric: metricLabel(t, trendConfig(w.config).metric) });24  return t(TITLE[w.type]);25}26export const widgetTypeLabel = (t: I18n["t"], type: WidgetType): string => t(TITLE[type]);2728/** Edit controls injected by the grid into the header of the widget it wraps (absent outside edit mode). */29export const FrameControls = createContext<ReactNode>(null);3031interface FrameProps {32  type: WidgetType | "unknown";33  title: string;34  stamp?: ReactNode;35  children: ReactNode;36}37export function Frame({ type, title, stamp, children }: FrameProps) {38  const id = useId();39  const controls = useContext(FrameControls);40  return (41    <section className="ov-widget" aria-labelledby={id} data-testid={`ov-widget-${type}`}>42      <header className="ov-widget-head">43        <Icon name={type === "unknown" ? "unknown" : WIDGET_ICON[type]} size={15} />44        <h2 id={id} className="truncate">{title}</h2>45        <span className="grow" />46        <span className="ov-secondary">{stamp}</span>47        {controls}48      </header>49      <div className="ov-widget-body" ref={focusableWhenScrollable}>{children}</div>50    </section>51  );52}5354export function useOverview() {55  return useApiQuery("/cluster/overview", undefined, { refetchInterval: 30_000 });56}57type Overview = Schemas["ClusterOverview"];5859/** The server omitted an optional block of the overview (no permission, or nothing reports it): say so. */60function NotReported() {61  const { t } = useI18n();62  return <Unmeasured availability="not_observed" reason={t("overview.notReported")} />;63}6465function Figure({ value, label, tone, icon, href }: { value: ReactNode; label: string; tone?: Tone; icon?: IconName; href?: string }) {66  const body = (67    <>68      <span className="ov-figure-value num">{value}</span>69      {tone ? <StateDot tone={tone} label={label} subtle {...(icon ? { icon } : {})} /> : <span className="ov-figure-label">{label}</span>}70    </>71  );72  return href ? <Link href={href} className="ov-figure">{body}</Link> : <div className="ov-figure">{body}</div>;73}7475function OverviewFrame({ type, children }: { type: WidgetType; children: (o: Overview) => ReactNode }) {76  const { t } = useI18n();77  const q = useOverview();78  return (79    <Frame type={type} title={t(TITLE[type])} stamp={q.data ? <DataStamp at={q.data.generated_at} /> : null}>80      <QueryBoundary query={q} compact>{children}</QueryBoundary>81    </Frame>82  );83}8485// ── node availability ──86function NodesWidget() {87  const { t, fmt } = useI18n();88  return (89    <OverviewFrame type="nodes">90      {(o) => (91        <div className="ov-stack">92          <div className="ov-figures" data-testid="ov-nodes-counts">93            <Figure value={fmt.integer(o.nodes.fresh)} label={t("states.freshness.fresh")} tone="ok" href="/nodes?freshness=fresh" />94            <Figure value={fmt.integer(o.nodes.stale)} label={t("states.freshness.stale")} tone="stale" href="/nodes?freshness=stale" />95            <Figure value={fmt.integer(o.nodes.offline)} label={t("states.freshness.offline")} tone="offline" href="/nodes?freshness=offline" />96            <Figure value={fmt.integer(o.nodes.maintenance)} label={t("overview.nodes.maintenance")} tone="maintenance" href="/nodes?maintenance=true" />97          </div>98          <p className="ov-note ov-secondary">{t("overview.nodes.total", { total: fmt.integer(o.nodes.total) })}</p>99        </div>100      )}101    </OverviewFrame>102  );103}104105/**106 * A widget body scrolls when its content is taller than its grid cell. A scrollable region must be reachable by107 * keyboard, so it becomes a tab stop exactly while it overflows.108 */109function focusableWhenScrollable(el: HTMLDivElement | null): (() => void) | undefined {110  if (!el) return undefined;111  const sync = () => {112    if (el.scrollHeight > el.clientHeight + 1) el.tabIndex = 0;113    else el.removeAttribute("tabindex");114  };115  const ro = new ResizeObserver(sync);116  ro.observe(el);117  const mo = new MutationObserver(sync);118  mo.observe(el, { childList: true, subtree: true });119  sync();120  return () => {121    ro.disconnect();122    mo.disconnect();123  };124}125126// ── capacity with coverage ──127function CapacityRow({ id, label, total, nodesTotal, kind }: { id: "cpu" | "memory" | "storage"; label: string; total: Schemas["CapacityTotal"]; nodesTotal: number; kind: "cores" | "bytes" }) {128  const { t, tn, fmt } = useI18n();129  const value = kind === "cores" ? fmt.integer(total.total) : fmt.bytes(total.total);130  const partial = total.coverage < nodesTotal;131  return (132    <div className="ov-cap" data-testid={`ov-capacity-${id}`}>133      <div className="row-between">134        <span className="ov-cap-label">{label}</span>135        <span className="ov-cap-value num">{total.coverage === 0 ? <Unmeasured availability="not_observed" /> : <>{value}{kind === "cores" ? <small> {t("overview.capacity.cores")}</small> : null}</>}</span>136      </div>137      {kind === "bytes" ? (138        total.used !== undefined && total.total > 0 ? (139          <Meter value={(total.used / total.total) * 100} label={t("overview.capacity.usedOf", { label })} text={`${fmt.bytes(total.used)} · ${fmt.percent((total.used / total.total) * 100)}`} />140        ) : (141          <span className="mcc-unmeasured"><Icon name="unknown" size={13} />{t("overview.capacity.noUsage")}</span>142        )143      ) : null}144      <span className={partial ? "ov-coverage partial" : "ov-coverage"} data-testid="ov-coverage">145        {partial ? <Icon name="warning" size={12} /> : null}146        {tn("overview.capacity.coverage", total.coverage, { total: fmt.integer(nodesTotal) })}147      </span>148    </div>149  );150}151function CapacityWidget() {152  const { t } = useI18n();153  return (154    <OverviewFrame type="capacity">155      {(o) => (156        <div className="ov-stack">157          <CapacityRow id="cpu" label={t("overview.capacity.cpu")} total={o.capacity.cpu_cores} nodesTotal={o.nodes.total} kind="cores" />158          <CapacityRow id="memory" label={t("overview.capacity.memory")} total={o.capacity.memory} nodesTotal={o.nodes.total} kind="bytes" />159          <CapacityRow id="storage" label={t("overview.capacity.storage")} total={o.capacity.storage} nodesTotal={o.nodes.total} kind="bytes" />160        </div>161      )}162    </OverviewFrame>163  );164}165166// ── cluster trends ──167function TrendsWidget({ widget, onConfig }: WidgetProps) {168  const { t, tn } = useI18n();169  const period = usePeriod(60_000);170  const cfg = trendConfig(widget.config);171  const range = trendRange(period.preset, period.toMs - period.fromMs);172  const q = useApiQuery("/cluster/trends", { query: { metric: cfg.metric, range, group_by: cfg.groupBy } }, { refetchInterval: 60_000 });173  const series = useMemo(174    () => (q.data?.series ?? []).map((s) => ({ id: s.group, label: cfg.groupBy === "cluster" ? t("overview.trends.cluster") : s.group, points: s.points })),175    [q.data, cfg.groupBy, t],176  );177  const metrics = (TREND_METRICS as readonly string[]).includes(cfg.metric) ? [...TREND_METRICS] : [cfg.metric, ...TREND_METRICS];178  const title = widgetTitle(t, widget);179  return (180    <Frame type="trends" title={title} stamp={q.data ? <DataStamp at={q.data.generated_at} /> : null}>181      <div className="ov-trend-controls">182        <SelectField label={t("overview.trends.metric")} hideLabel value={cfg.metric} onChange={(metric) => onConfig?.({ metric })} options={metrics.map((m) => ({ value: m, label: metricLabel(t, m) }))} />183        <Segmented<TrendGroup> label={t("overview.trends.groupBy")} value={cfg.groupBy} onChange={(group_by) => onConfig?.({ group_by })} options={TREND_GROUPS.map((g) => ({ value: g, label: t(`overview.trends.group.${g}`) }))} />184      </div>185      {period.preset === null ? <p className="mcc-hint">{t("overview.trends.presetOnly", { range: t(`ui.range.long.${range}`) })}</p> : null}186      <QueryBoundary query={q} compact>187        {(d) => (188          <>189            <TimeSeriesChart190              title={`${title} — ${t(`ui.range.long.${d.range}`)}`}191              unit={d.unit}192              series={series}193              {...(d.unit === "percent" ? { yMax: 100 } : {})}194              placeholder={<span className="mcc-unmeasured"><Icon name="unknown" size={13} />{t("overview.trends.empty")}</span>}195            />196            <p className="ov-note ov-secondary" data-testid="ov-trends-coverage">197              {t(`overview.trends.aggregation.${d.aggregation}`)}198              {d.series.map((s) => <span key={s.group}> · {cfg.groupBy === "cluster" ? "" : `${s.group} : `}{tn("overview.trends.coverage", s.coverage)}</span>)}199            </p>200          </>201        )}202      </QueryBoundary>203    </Frame>204  );205}206207// ── alerts / incidents ──208function AlertsWidget() {209  const { t, fmt } = useI18n();210  return (211    <OverviewFrame type="alerts">212      {(o) =>213        o.alerts ? (214          <div className="ov-stack">215            <ul className="ov-rows" data-testid="ov-alerts-counts">216              {(["critical", "warning", "info"] as const).map((s) => (217                <li key={s}>218                  <Badge tone={severityTone(s)}>{t(`states.severity.${s}`)}</Badge>219                  <span className="ov-row-value num">{fmt.integer(o.alerts?.[s] ?? 0)}</span>220                </li>221              ))}222            </ul>223            <Link href="/alerts" className="ov-more">{t("overview.alerts.viewAll")}</Link>224          </div>225        ) : <NotReported />226      }227    </OverviewFrame>228  );229}230231function IncidentsWidget() {232  const { t, fmt } = useI18n();233  const { can } = useSession();234  const list = useApiQuery("/incidents", { query: { state: "open", limit: 4 } }, { enabled: can("alerts.read"), refetchInterval: 60_000 });235  return (236    <OverviewFrame type="incidents">237      {(o) =>238        o.open_incidents === undefined ? <NotReported /> : (239          <div className="ov-stack">240            <Figure value={fmt.integer(o.open_incidents)} label={t("overview.incidents.open")} {...(o.open_incidents > 0 ? { tone: "critical" as const } : { tone: "ok" as const })} href="/alerts?tab=incidents" />241            {list.data && list.data.items.length > 0 ? (242              <ul className="ov-list ov-secondary">243                {list.data.items.map((i) => (244                  <li key={i.id}><Link href={`/incidents/${i.id}`} className="truncate">{i.title}</Link><span className="faint num nowrap">{fmt.relative(i.opened_at)}</span></li>245                ))}246              </ul>247            ) : null}248          </div>249        )250      }251    </OverviewFrame>252  );253}254255// ── jobs / services / models ──256function JobsWidget() {257  const { t, fmt } = useI18n();258  return (259    <OverviewFrame type="jobs">260      {(o) => o.jobs ? (261        <div className="ov-figures">262          <Figure value={fmt.integer(o.jobs.running)} label={t("states.job.running")} tone="info" icon="running" href="/jobs?state=running" />263          <Figure value={fmt.integer(o.jobs.queued)} label={t("states.job.queued")} tone="neutral" icon="clock" href="/jobs?state=queued" />264        </div>265      ) : <NotReported />}266    </OverviewFrame>267  );268}269function ServicesWidget() {270  const { t, fmt } = useI18n();271  return (272    <OverviewFrame type="services">273      {(o) => o.services ? (274        <div className="ov-figures">275          <Figure value={fmt.integer(o.services.online)} label={t("states.service.online")} tone="ok" href="/services?state=online" />276          <Figure value={fmt.integer(o.services.errored)} label={t("states.service.errored")} tone="critical" href="/services?state=errored" />277          <Figure value={fmt.integer(o.services.stopped)} label={t("states.service.stopped")} tone="offline" href="/services?state=stopped" />278          <Figure value={fmt.integer(o.services.unknown)} label={t("states.service.unknown")} tone="stale" icon="unknown" href="/services?state=unknown" />279        </div>280      ) : <NotReported />}281    </OverviewFrame>282  );283}284function ModelsWidget() {285  const { t, fmt } = useI18n();286  return (287    <OverviewFrame type="models">288      {(o) => o.models ? (289        <div className="ov-stack">290          <Figure value={<>{fmt.integer(o.models.online)}<small> / {fmt.integer(o.models.total)}</small></>} label={t("overview.models.online")} tone={o.models.total > 0 && o.models.online === o.models.total ? "ok" : o.models.online === 0 && o.models.total > 0 ? "critical" : o.models.total === 0 ? "neutral" : "warning"} href="/models" />291          <p className="ov-note ov-secondary">{t("overview.models.note")}</p>292        </div>293      ) : <NotReported />}294    </OverviewFrame>295  );296}297298// ── NAS and backups ──299function StorageWidget() {300  const { t, fmt } = useI18n();301  return (302    <OverviewFrame type="storage">303      {(o) => (304        <div className="ov-stack">305          <div>306            <h3 className="caps">{t("overview.storage.nas")}</h3>307            {o.nas ? (308              o.nas.total === 0 ? <p className="ov-note">{t("overview.storage.noNas")}</p> : (309                <ul className="ov-inline" data-testid="ov-nas">310                  <li><StateDot tone="ok" label={t("overview.storage.nasOnline", { count: o.nas.online })} subtle /></li>311                  <li><StateDot tone="offline" label={t("overview.storage.nasOffline", { count: o.nas.offline })} subtle /></li>312                  <li><StateDot tone="stale" icon="unknown" label={t("overview.storage.nasUnknown", { count: o.nas.unknown })} subtle /></li>313                </ul>314              )315            ) : <NotReported />}316          </div>317          <div>318            <h3 className="caps">{t("overview.storage.backups")}</h3>319            {o.backups ? (320              o.backups.total === 0 ? <p className="ov-note">{t("overview.storage.noBackups")}</p> : (321                <>322                  <ul className="ov-inline" data-testid="ov-backups">323                    <li><StateDot tone="ok" label={t("overview.storage.backupsOk", { count: o.backups.ok })} subtle /></li>324                    <li><StateDot tone="critical" label={t("overview.storage.backupsFailed", { count: o.backups.failed })} subtle /></li>325                    <li><StateDot tone="stale" icon="unknown" label={t("overview.storage.backupsUnknown", { count: o.backups.unknown })} subtle /></li>326                  </ul>327                  <p className="ov-note ov-secondary">328                    {o.backups.last_success_at ? t("overview.storage.lastSuccess", { when: fmt.dateTime(o.backups.last_success_at) }) : t("overview.storage.noSuccess")}329                  </p>330                </>331              )332            ) : <NotReported />}333          </div>334          <Link href="/storage" className="ov-more">{t("overview.storage.view")}</Link>335        </div>336      )}337    </OverviewFrame>338  );339}340341// ── recent operator actions ──342function ActionsWidget() {343  const { t, fmt } = useI18n();344  return (345    <OverviewFrame type="actions">346      {(o) =>347        o.recent_actions === undefined ? <NotReported /> : o.recent_actions.length === 0 ? <p className="ov-note">{t("overview.actions.none")}</p> : (348          <ul className="ov-list" data-testid="ov-actions">349            {o.recent_actions.slice(0, 8).map((a) => (350              <li key={a.id}>351                <StateDot tone={actionTone(a.state)} icon={actionIcon(a.state)} label={t(`states.action.${a.state}`)} hideLabel />352                <Link href={`/actions/${a.id}`} className="truncate"><span className="mono">{a.type}</span>{a.target_label ? <span className="muted"> · {a.target_label}</span> : null}</Link>353                <span className="faint num nowrap ov-secondary">{a.requested_by_display_name ? `${a.requested_by_display_name} · ` : ""}{fmt.relative(a.created_at)}</span>354              </li>355            ))}356          </ul>357        )358      }359    </OverviewFrame>360  );361}362363// ── upcoming maintenance (next 7 days) ──364function MaintenanceWidget() {365  const { t, tn, fmt } = useI18n();366  const { can } = useSession();367  // window fixed at mount (rounded to the minute) so the query key is stable; the list refreshes on its own368  const [range] = useState(() => {369    const from = Math.floor(Date.now() / 60_000) * 60_000;370    return { from: new Date(from).toISOString(), to: new Date(from + 7 * 86400_000).toISOString() };371  });372  const allowed = can("maintenance.read");373  const q = useApiQuery("/maintenance/windows", { query: range }, { enabled: allowed, refetchInterval: 120_000 });374  return (375    <Frame type="maintenance" title={t("overview.widget.maintenance")} stamp={q.data ? <DataStamp at={q.dataUpdatedAt} /> : null}>376      {!allowed ? <Unmeasured availability="permission_denied" reason={t("errors.forbidden.bodyPermission", { permission: "maintenance.read" })} /> : (377        <QueryBoundary query={q} compact>378          {(d) => {379            const items = d.items.filter((i) => i.window.status !== "cancelled" && i.window.status !== "completed").sort((a, b) => a.occurrence_start.localeCompare(b.occurrence_start)).slice(0, 6);380            if (items.length === 0) return <EmptyState compact icon="calendar" title={t("overview.maintenance.none")} />;381            return (382              <ul className="ov-list" data-testid="ov-maintenance">383                {items.map((i) => (384                  <li key={`${i.window.id}:${i.occurrence_start}`} className="ov-list-tall">385                    <StateDot tone={i.active ? "maintenance" : maintenanceTone(i.window.status)} icon={i.active ? "wrench" : "calendar"} label={i.active ? t("states.maintenance.in_progress") : t(`states.maintenance.${i.window.status}`)} hideLabel />386                    <span className="grow">387                      <Link href={`/maintenance/${i.window.id}`} className="truncate">{i.window.title}</Link>388                      <span className="ov-sub ov-secondary num">389                        {fmt.dateTime(i.occurrence_start)} · {t(`states.category.${i.window.category}`)} · {tn("overview.maintenance.nodes", i.window.scope.node_ids.length)}390                      </span>391                    </span>392                    {i.active ? <Badge tone="maintenance">{t("states.maintenance.in_progress")}</Badge> : null}393                  </li>394                ))}395              </ul>396            );397          }}398        </QueryBoundary>399      )}400    </Frame>401  );402}403404export interface WidgetProps {405  widget: Widget;406  /** Merge a config change into the widget (persisted with the layout). */407  onConfig?: ((config: Record<string, unknown>) => void) | undefined;408}409410/** Renders a dashboard widget by type. A type this client does not know is kept and shown as a placeholder. */411export function WidgetView({ widget, onConfig }: WidgetProps) {412  const { t } = useI18n();413  if (!isWidgetType(widget.type)) {414    return <Frame type="unknown" title={t("overview.widget.unknown")}><p className="ov-note">{t("overview.unknownBody", { type: widget.type })}</p></Frame>;415  }416  switch (widget.type) {417    case "nodes": return <NodesWidget />;418    case "capacity": return <CapacityWidget />;419    case "trends": return <TrendsWidget widget={widget} onConfig={onConfig} />;420    case "alerts": return <AlertsWidget />;421    case "incidents": return <IncidentsWidget />;422    case "jobs": return <JobsWidget />;423    case "services": return <ServicesWidget />;424    case "models": return <ModelsWidget />;425    case "storage": return <StorageWidget />;426    case "maintenance": return <MaintenanceWidget />;427    case "actions": return <ActionsWidget />;428  }429}430
Files main
Menu

Theme