mirror of
https://github.com/supabase/supabase.git
synced 2026-09-06 09:59:03 +08:00
Adds an infrastructure/topology diagram for High Availability (Multigres) projects showing the real cluster topology — gateway tier, shard group, and the primary + read replicas inside it — on both the project homepage and the database/replication page, replacing the primary-only view and the "Replication unavailable" empty state. <img width="790" height="541" alt="Screenshot 2026-08-20 at 8 23 42 PM" src="https://github.com/user-attachments/assets/0bce21e3-2091-4285-84ca-60fdecb10d39" /> Addresses [FE-3717](https://linear.app/supabase/issue/FE-3717/show-replicas-in-replication-diagram). **Added:** - `data/ha-admin/` — read-only queries for the mgmt-api `/ha-admin/v1/{gateways,poolers,cells,databases}` multiadmin passthrough (ported from `bobbie/ha-stub`, re-authored to `queryOptions`). Responses are validated with zod at the fetch boundary (all fields optional per proto3 zero-value omission; enum-shaped fields stay plain strings so new proto values degrade gracefully); malformed payloads surface through the diagram's error fallback. - `HaTopology.utils.ts` — pure topology mapper (+ 26 unit tests): shard grouping, primary identified via `routingState.role` (deprecated `type` as fallback) with **failover-safe election** — when the outgoing and incoming primary briefly both claim `ROUTING_ROLE_PRIMARY`, the highest routing rule (coordinator term, leader subterm) wins, matching the multigateway's own election — plus status mapping onto the existing Healthy / Coming up / Going down / Unhealthy vocabulary, and an AZ formatter for `id.cell` that degrades to the raw cell name. - HA diagram nodes/edges: `Multigateway` card, shard group box with header pill (`Shard 1`, `Automatic failover` + tooltip), `Primary Database` card styled like the standard diagram's — neutral border, green icon chip (with the standard CPU / Disk / RAM footer — connections omitted until their meaning through the multigateway is confirmed), `Read Replica` cards, and the standard animated replication edges (status lives on the card badges). Poolers and gateways poll every 30s without re-running layout (topology projection + structural sharing). Drag-to-pan works through the shard group box, and the metrics footer's skeleton matches the loaded row height so the card doesn't shift. - Accessibility: the failover tooltip trigger is a keyboard-focusable button, status badges sit in stable `role="status"` live regions, the region flag is decorative (`alt=""`), and the edge dash/spinner animations respect `prefers-reduced-motion` (applied to the pipelines diagram's edges too). - Fallbacks: `AlertError` ("Failed to retrieve cluster topology") when either ha-admin query errors, and a "Cluster topology unavailable" empty state when the topology comes back empty — never a half-rendered diagram. **Changed:** - `InstanceConfiguration` is now topology-source-aware: it branches internally on `useHighAvailability()`, so both surfaces (homepage `TopSection` and the replication page) get the right diagram with no new wiring. The two-pass measured dagre layout moved into a shared `DiagramFlow`; `nodeTypes`/`edgeTypes` are module-level consts. - `getEdgeVisual` + the mid-edge icon chip lifted out of `ReplicationDiagram/Edges.tsx` into `components/ui/ReactFlow/EdgeVisual.tsx` so both diagrams derive edge icon + line style from one state object (no behavior change for the pipelines diagram). The primary card's CPU/Disk/RAM footer is likewise extracted into a shared `ComputeMetricsFooter`. - Fixes a latent relayout loop inherited from the region-box pattern: handing React Flow a freshly created (unmeasured) group node on every layout pass reset `nodesInitialized`, re-triggering the measured pass and `fitView` forever — which made the diagram snap back to center and effectively unpannable. The shared `DiagramFlow` now re-attaches known measurements to group nodes, which also covers the standard diagram's region boxes. - Standard diagram: the API Load Balancer → primary edge is now static — no data flows over it, the line only indicates a relation. - `database/replication` page: the HA early-return empty state is replaced by the diagram under a "High Availability cluster topology" header. Non-HA projects are untouched. **Intentional deviations from the mock** (for design review): 1. **No per-replica regions** — alpha replicas are one-per-cell inside a single region, so the mock's `eu-west-1` / `ap-southeast-1` on sibling replicas would be false. Availability zone per node, region shown once on the primary. 2. **"Primary Database", not "Main Database"** — matches the string both existing diagrams already ship, and the same component now renders both project types. 3. **No collapse chevron on the shard header** — alpha has exactly one shard; collapsing it would hide the whole diagram. The group box still ships; add collapse when `shards.length > 1`. 4. **Failover shown on the shard group, not replica cards** — failover is a cohort property; per-card badging would assert readiness we can't verify without a per-pooler `/status` fanout. 5. **Standard node/edge styling reused** (per review) — neutral primary border + green chip and the default animated edges instead of the mock's green ring and dashed green arrowed edges, keeping the HA and non-HA diagrams visually consistent. **Confirmed against a real local Multigres cluster:** cells are named `cell-1`/`cell-2`/… (not AZ-shaped — the AZ formatter falls back to the raw cell name as designed); `GET /platform/projects/{ref}/databases` returns only the primary row for HA projects; and the `/ha-admin` passthrough returns **each gateway/pooler record once per cell it fans out to** — the topology mapper dedupes by id, but worth confirming with @sbc-bobbie whether the backend should dedupe. **Known alpha limitation:** node health and the "replicating" edge state derive from the pooler's *topology record* (`lifecycleStatus`/`servingStatus`), not a live probe — a pooler that crashes without publishing a terminal state can read as healthy until the topology evicts its record, and a serving replica with paused replay still shows a green edge. This matches the existing replication diagram's semantics (`ACTIVE_HEALTHY` ⇒ animated edge). Live per-pooler signals (WAL receiver state, replay position) exist on `GET /poolers/{cell}/{name}/status` but need a per-pooler fanout — deliberately deferred, noted on `getPoolerStatus`. **Still to confirm** (doesn't block review): whether the `/ha-admin` passthrough is deployed to production or staging-only (if staging-only, this should get a flag before GA). ## To test Tested end-to-end locally against a real Multigres project (standard-project regression pass, HA creation flow, error fallback against real 500s, and full topology + polling + console checks against live multiadmin data): - **HA project homepage**: diagram card shows Multigateway → shard box (`Shard 1`, count badge, `Automatic failover` tooltip) → green-bordered Primary Database (region, AZ, size) + Read Replica cards (AZ), dashed green animated edges to healthy replicas. No flow/map toggle for HA. - **HA project → Database → Replication**: same diagram under a "High Availability cluster topology" header; no Destinations section; the old "Replication unavailable…" state is gone. - **Error path**: if `/ha-admin/v1/*` fails, both surfaces show "Failed to retrieve cluster topology" with Contact support — no partial diagram. - **Standard project regression**: homepage diagram (primary card, flow ⇄ map toggle round-trips), replication page (pipelines diagram + Destinations) all unchanged; zero requests to `/ha-admin/*`. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **New Features** - Added High Availability topology diagrams to the Replication page. - Display gateways, primary databases, replicas, shards, statuses, regions, infrastructure details, and compute metrics. - Added observability links and live topology updates with loading, error, and unavailable states. - **Bug Fixes** - Improved handling of incomplete infrastructure identities and unexpected data. - Corrected topology layout, node spacing, and visual edge behavior. - **Accessibility** - Reduced-motion preferences now disable diagram animations and loading effects. - Improved status announcements for assistive technologies. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Alaister Young <10985857+alaister@users.noreply.github.com>
191 lines
7.4 KiB
TypeScript
191 lines
7.4 KiB
TypeScript
import { Handle, Node, NodeProps, Position } from '@xyflow/react'
|
|
import { Database, DatabaseBackup, HelpCircle, Layers, Loader2, Network } from 'lucide-react'
|
|
import { Badge, cn, Tooltip, TooltipContent, TooltipTrigger } from 'ui'
|
|
|
|
import { ComputeMetricsFooter } from './ComputeMetricsFooter'
|
|
import {
|
|
HaPoolerNodeData,
|
|
HaShardNodeData,
|
|
MultigatewayNodeData,
|
|
} from './HaInstanceConfiguration.utils'
|
|
import { HA_POOLER_STATUS_LABELS, HaPoolerStatus } from './HaTopology.utils'
|
|
import { NODE_CARD_WIDTH } from './InstanceConfiguration.constants'
|
|
import { useHaPoolerCard } from './useHaPooler'
|
|
import { BASE_PATH } from '@/lib/constants'
|
|
|
|
const STATUS_BADGE_VARIANTS: Record<HaPoolerStatus, 'success' | 'warning' | 'default'> = {
|
|
healthy: 'success',
|
|
coming_up: 'default',
|
|
going_down: 'default',
|
|
unhealthy: 'warning',
|
|
}
|
|
|
|
const PoolerStatusBadge = ({ status }: { status: HaPoolerStatus }) => (
|
|
<Badge variant={STATUS_BADGE_VARIANTS[status]}>{HA_POOLER_STATUS_LABELS[status]}</Badge>
|
|
)
|
|
|
|
const PoolerCardSubtitle = ({
|
|
availabilityZone,
|
|
computeSize,
|
|
}: {
|
|
availabilityZone?: string
|
|
computeSize?: string
|
|
}) => (
|
|
<p className="flex items-center gap-x-1 text-sm text-foreground-light">
|
|
{availabilityZone !== undefined && <span>{availabilityZone}</span>}
|
|
{availabilityZone !== undefined && !!computeSize && (
|
|
<span className="text-foreground-lighter">·</span>
|
|
)}
|
|
{!!computeSize && <span>{computeSize}</span>}
|
|
</p>
|
|
)
|
|
|
|
export const MultigatewayNode = ({ data }: NodeProps<Node<MultigatewayNodeData>>) => {
|
|
const { numGateways } = data
|
|
|
|
return (
|
|
<>
|
|
<div className="flex flex-col rounded-sm bg-surface-100 border border-default">
|
|
<div className="flex items-start p-3 gap-x-4" style={{ width: NODE_CARD_WIDTH }}>
|
|
<div className="flex gap-x-3">
|
|
<div className="min-w-8 h-8 bg-blue-600 border border-blue-800 rounded-md flex items-center justify-center">
|
|
<Network aria-hidden="true" size={16} />
|
|
</div>
|
|
<div className="flex flex-col gap-y-0.5">
|
|
<p className="text-sm">Multigateway</p>
|
|
<p className="flex items-center gap-x-1 text-sm text-foreground-light">
|
|
<span>Load balancer</span>
|
|
{numGateways > 1 && (
|
|
<>
|
|
<span className="text-foreground-lighter">·</span>
|
|
<span>{numGateways} instances</span>
|
|
</>
|
|
)}
|
|
</p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<Handle type="source" position={Position.Bottom} style={{ background: 'transparent' }} />
|
|
</>
|
|
)
|
|
}
|
|
|
|
export const HaPrimaryNode = ({ data }: NodeProps<Node<HaPoolerNodeData>>) => {
|
|
// [Joshen] Just FYI Handles cannot be conditionally rendered
|
|
const { cell, name, hasGateway } = data
|
|
const { status, availabilityZone, computeSize, primaryRegion } = useHaPoolerCard({ cell, name })
|
|
|
|
return (
|
|
<>
|
|
<Handle
|
|
type="target"
|
|
position={Position.Top}
|
|
className={!hasGateway ? 'opacity-0' : ''}
|
|
style={{ background: 'transparent' }}
|
|
/>
|
|
<div className="flex flex-col rounded-sm bg-surface-100 border border-default">
|
|
<div className="flex items-start justify-between p-3" style={{ width: NODE_CARD_WIDTH }}>
|
|
<div className="flex gap-x-3">
|
|
<div className="w-8 h-8 bg-brand-500 border border-brand-600 rounded-md flex items-center justify-center">
|
|
<Database aria-hidden="true" size={16} />
|
|
</div>
|
|
<div className="flex flex-col gap-y-0.5">
|
|
<div className="flex items-center gap-x-2">
|
|
<p className="text-sm">Primary Database</p>
|
|
{/* Stable live region so polled status changes are announced */}
|
|
<span role="status">
|
|
{status !== undefined && <PoolerStatusBadge status={status} />}
|
|
</span>
|
|
</div>
|
|
{primaryRegion !== undefined && (
|
|
<p className="text-sm text-foreground-light">{primaryRegion.name}</p>
|
|
)}
|
|
<PoolerCardSubtitle availabilityZone={availabilityZone} computeSize={computeSize} />
|
|
</div>
|
|
</div>
|
|
{primaryRegion !== undefined && (
|
|
// Decorative — the visible text next to it already names the region
|
|
<img
|
|
alt=""
|
|
aria-hidden="true"
|
|
className="w-8 rounded-xs mt-0.5"
|
|
src={`${BASE_PATH}/img/regions/${primaryRegion.region}.svg`}
|
|
/>
|
|
)}
|
|
</div>
|
|
{/* Whether connection metrics are meaningful through the multigateway
|
|
is unconfirmed, so they're left off for HA projects. */}
|
|
<ComputeMetricsFooter showConnections={false} />
|
|
</div>
|
|
<Handle type="source" position={Position.Bottom} style={{ background: 'transparent' }} />
|
|
</>
|
|
)
|
|
}
|
|
|
|
export const HaReplicaNode = ({ data }: NodeProps<Node<HaPoolerNodeData>>) => {
|
|
const { cell, name } = data
|
|
const { status, availabilityZone, computeSize } = useHaPoolerCard({ cell, name })
|
|
|
|
return (
|
|
<>
|
|
<Handle type="target" position={Position.Top} style={{ background: 'transparent' }} />
|
|
<div
|
|
className="flex items-start rounded-sm bg-surface-100 border border-default p-3"
|
|
style={{ width: NODE_CARD_WIDTH }}
|
|
>
|
|
<div className="flex gap-x-3">
|
|
<div
|
|
className={cn(
|
|
'w-8 h-8 border rounded-md flex items-center justify-center',
|
|
status === 'healthy'
|
|
? 'bg-brand-400 border-brand-500'
|
|
: 'bg-surface-100 border-foreground/20'
|
|
)}
|
|
>
|
|
{status === 'coming_up' ? (
|
|
<Loader2 aria-hidden="true" className="motion-safe:animate-spin" size={16} />
|
|
) : (
|
|
<DatabaseBackup aria-hidden="true" size={16} />
|
|
)}
|
|
</div>
|
|
<div className="flex flex-col gap-y-0.5">
|
|
<div className="flex items-center gap-x-2">
|
|
<p className="text-sm">Read Replica</p>
|
|
{/* Stable live region so polled status changes are announced */}
|
|
<span role="status">
|
|
{status !== undefined && <PoolerStatusBadge status={status} />}
|
|
</span>
|
|
</div>
|
|
<PoolerCardSubtitle availabilityZone={availabilityZone} computeSize={computeSize} />
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</>
|
|
)
|
|
}
|
|
|
|
export const HaShardNode = ({ data }: NodeProps<Node<HaShardNodeData>>) => {
|
|
const { name } = data
|
|
|
|
return (
|
|
<div className="relative h-full w-full rounded-md border border-default bg-surface-100/25">
|
|
<div className="pointer-events-auto absolute top-3 left-3 flex items-center gap-x-2 rounded-full border border-default bg-surface-100 pl-3 pr-2 py-1">
|
|
<Layers aria-hidden="true" size={14} className="text-foreground-light" />
|
|
<p className="text-sm">{name}</p>
|
|
<Tooltip>
|
|
{/* Renders a button so the explanation is keyboard reachable */}
|
|
<TooltipTrigger className="flex items-center gap-x-1 text-sm text-foreground-light">
|
|
Automatic failover
|
|
<HelpCircle aria-hidden="true" size={14} />
|
|
</TooltipTrigger>
|
|
<TooltipContent side="bottom" className="max-w-72 text-center">
|
|
If the primary database fails, a replica in this shard is automatically promoted to take
|
|
its place.
|
|
</TooltipContent>
|
|
</Tooltip>
|
|
</div>
|
|
</div>
|
|
)
|
|
}
|