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>
133 lines
4.6 KiB
TypeScript
133 lines
4.6 KiB
TypeScript
import {
|
|
Background,
|
|
ColorMode,
|
|
Edge,
|
|
EdgeTypes,
|
|
Node,
|
|
NodeTypes,
|
|
ReactFlow,
|
|
useNodesInitialized,
|
|
useReactFlow,
|
|
} from '@xyflow/react'
|
|
import { useTheme } from 'next-themes'
|
|
import { useEffect, useEffectEvent, useState } from 'react'
|
|
|
|
import '@xyflow/react/dist/style.css'
|
|
|
|
import { cn } from 'ui'
|
|
|
|
import { getDagreGraphLayout } from './InstanceConfiguration.utils'
|
|
import { timeout } from '@/lib/helpers'
|
|
|
|
interface DiagramFlowProps {
|
|
nodes: Node[]
|
|
edges: Edge[]
|
|
nodeTypes: NodeTypes
|
|
edgeTypes: EdgeTypes
|
|
/** Prepends background group nodes (regions, shards) after the dagre layout runs */
|
|
addGroupNodes: (nodes: Node[], edges: Edge[]) => { nodes: Node[]; edges: Edge[] }
|
|
ranksep?: number
|
|
}
|
|
|
|
/**
|
|
* Shared React Flow canvas for the infrastructure diagrams, laid out with a
|
|
* two-pass measured dagre layout: the first pass uses fallback heights while
|
|
* the diagram is held invisible, then `useNodesInitialized` triggers a second
|
|
* pass that re-runs dagre with the real measured node heights before fading
|
|
* the diagram in. Must be rendered inside a `ReactFlowProvider`.
|
|
*/
|
|
export const DiagramFlow = ({
|
|
nodes,
|
|
edges,
|
|
nodeTypes,
|
|
edgeTypes,
|
|
addGroupNodes,
|
|
ranksep,
|
|
}: DiagramFlowProps) => {
|
|
const reactFlow = useReactFlow()
|
|
const { resolvedTheme } = useTheme()
|
|
const nodesInitialized = useNodesInitialized()
|
|
const [hasMeasuredLayout, setHasMeasuredLayout] = useState(false)
|
|
|
|
const backgroundPatternColor =
|
|
resolvedTheme === 'dark' ? 'rgba(255, 255, 255, 0.3)' : 'rgba(0, 0, 0, 0.4)'
|
|
|
|
const setReactFlow = useEffectEvent(async ({ isMeasuredPass }: { isMeasuredPass: boolean }) => {
|
|
// Merge in React Flow's measured dimensions (if any) so dagre can use real
|
|
// heights instead of the first-paint fallbacks.
|
|
const measuredNodes = nodes.map((node) => {
|
|
const existing = reactFlow.getNode(node.id)
|
|
return existing?.measured ? { ...node, measured: existing.measured } : node
|
|
})
|
|
const graph = getDagreGraphLayout(measuredNodes, edges, { ranksep })
|
|
const { nodes: groupedNodes } = addGroupNodes(graph.nodes, graph.edges)
|
|
// Re-attach known measurements to the freshly created group nodes too —
|
|
// handing setNodes an unmeasured node resets the store's nodesInitialized
|
|
// flag, which would re-trigger the measured pass below on every re-measure
|
|
// and loop forever (each iteration re-running fitView, so the diagram
|
|
// snaps back to center and can't be panned).
|
|
const updatedNodes = groupedNodes.map((node) => {
|
|
if (node.measured !== undefined) return node
|
|
const existing = reactFlow.getNode(node.id)
|
|
return existing?.measured ? { ...node, measured: existing.measured } : node
|
|
})
|
|
reactFlow.setNodes(updatedNodes)
|
|
reactFlow.setEdges(graph.edges)
|
|
|
|
// [Joshen] Odd fix to ensure that react flow snaps back to center when adding nodes
|
|
await timeout(1)
|
|
reactFlow.fitView({ maxZoom: 0.9, minZoom: 0.9 })
|
|
if (isMeasuredPass) setHasMeasuredLayout(true)
|
|
})
|
|
|
|
// First pass: lay out using fallback heights for any not-yet-measured nodes.
|
|
// The diagram is kept invisible until the measured pass below has run, so the
|
|
// user never sees the fallback positions.
|
|
useEffect(() => {
|
|
if (nodes.length > 0) {
|
|
setReactFlow({ isMeasuredPass: false })
|
|
}
|
|
}, [nodes, edges])
|
|
|
|
// Second pass: once React Flow has measured the nodes, re-run the layout so
|
|
// dagre uses real heights. Only `nodesInitialized` going true should trigger
|
|
// this — the first-pass effect above handles node changes.
|
|
const runMeasuredLayout = useEffectEvent(() => {
|
|
if (nodesInitialized && nodes.length > 0) {
|
|
setReactFlow({ isMeasuredPass: true })
|
|
}
|
|
})
|
|
useEffect(() => {
|
|
runMeasuredLayout()
|
|
}, [nodesInitialized])
|
|
|
|
return (
|
|
<ReactFlow
|
|
// FIXME: https://github.com/xyflow/xyflow/issues/4876
|
|
colorMode={'' as unknown as ColorMode}
|
|
fitView
|
|
fitViewOptions={{ minZoom: 0.9, maxZoom: 0.9 }}
|
|
// Keep the diagram invisible (but laid out, so nodes can be measured)
|
|
// until the measured-height layout pass has run.
|
|
className={cn(
|
|
'instance-configuration transition-opacity duration-150',
|
|
hasMeasuredLayout ? 'opacity-100' : 'opacity-0'
|
|
)}
|
|
zoomOnPinch={false}
|
|
zoomOnScroll={false}
|
|
nodesDraggable={false}
|
|
nodesConnectable={false}
|
|
zoomOnDoubleClick={false}
|
|
edgesFocusable={false}
|
|
edgesReconnectable={false}
|
|
defaultNodes={[]}
|
|
defaultEdges={[]}
|
|
nodeTypes={nodeTypes}
|
|
edgeTypes={edgeTypes}
|
|
proOptions={{ hideAttribution: true }}
|
|
>
|
|
<Background color={backgroundPatternColor} />
|
|
</ReactFlow>
|
|
)
|
|
}
|