mirror of
https://github.com/supabase/supabase.git
synced 2026-10-09 19:35:06 +03:00
## What kind of change does this PR introduce? UI polish for Database → Replication: empty state, page layout, diagram containment, filter actions, and destination sheet copy. ## What is the current behavior? - Empty destinations use a custom dashed box with generic copy. - The diagram is full-bleed with `border-y`. - Page chrome still uses legacy Scaffold wrappers and a long header description that duplicates the empty state. - Filter-row “Add destination” is a default button ahead of secondary actions; Usage always shows. - Local ETL warning sits on the page list. - Destination sheet title/helper/access copy is more verbose; Type helper sits beside the label. ## What is the new behavior? - Empty state uses `EmptyStatePresentational` with clearer CTA copy; toolbar “Add destination” is primary at the end of the filter row; empty-state CTA stays default. - Usage only appears when there is at least one Pipelines destination. - Page uses `PageHeader` / `PageContainer` / `PageSection`, with a short header: “Read replicas and analytics pipelines”. - Diagram sits in a rounded bordered frame inside the page container (same treatment as project overview). - Local ETL warning shows in the add-destination sheet for Pipelines types only, without blocking the form; Type + warning scroll with the sheet body. - Type helper sits under the dropdown as one flowing paragraph (“Cannot be changed after creation…” plus shortened stage notice). - Sheet title is “Add destination”; close only fires on dismiss; Lucide icons (e.g. Snowflake) use consistent stroke width. | Before | After | | --- | --- | | <img width="1479" height="930" alt="Replication Database Chisel Toolshed Supabase" src="https://github.com/user-attachments/assets/a3caf0ba-ed1a-4659-bdef-f66b67e85be4" /> | <img width="1479" height="930" alt="Replication Database Chisel Toolshed Supabase" src="https://github.com/user-attachments/assets/d5a82641-a316-4577-9480-959346994c40" /> | | <img width="1479" height="930" alt="Replication Database Chisel Toolshed Supabase" src="https://github.com/user-attachments/assets/4f956e26-b8d4-4653-a60e-ceca7ec1e070" /> | <img width="1479" height="930" alt="Replication Database Chisel Toolshed Supabase" src="https://github.com/user-attachments/assets/a72461ab-dea9-48a6-ab88-852a12ac80a5" /> | ### Test plan - [x] Open **Database → Replication** with no replicas/destinations: empty state, primary filter-row Add destination, default empty-state Add destination, no Usage button. - [x] Confirm header→diagram and diagram→filter spacing feel even; filter→empty state/table stays tight (`space-y-4`). - [x] Confirm diagram is contained (rounded border), not full-bleed. - [x] Add a Pipelines destination (or use a project that has one): Usage appears; table still works; search “no results” still works. - [ ] Open **Add destination**: title “Add destination”; Type helper under the dropdown; Read Replica has no local warning; Pipelines type shows local warning without hiding fields (when ETL isn’t set up locally). - [ ] Without Pipelines access: request-access panel shows “alpha” copy and “Request alpha access”. - [ ] Spot-check dark/light themes. --------- Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
149 lines
4.6 KiB
TypeScript
149 lines
4.6 KiB
TypeScript
import { Background, ColorMode, ReactFlow, ReactFlowProvider, useReactFlow } from '@xyflow/react'
|
|
import { useParams } from 'common'
|
|
import { useTheme } from 'next-themes'
|
|
import { useEffect, useMemo } from 'react'
|
|
|
|
import { PrimaryDatabaseNode, ReadReplicaNode, ReplicationNode } from './Nodes'
|
|
import { getDagreGraphLayout } from './ReplicationDiagram.utils'
|
|
import { useReadReplicasQuery } from '@/data/read-replicas/replicas-query'
|
|
import { useReplicationDestinationsQuery } from '@/data/replication/destinations-query'
|
|
import { timeout } from '@/lib/helpers'
|
|
|
|
import '@xyflow/react/dist/style.css'
|
|
|
|
import { SmoothstepEdge } from './Edges'
|
|
import { checkLocalETLNotSetUp } from '@/data/replication/utils'
|
|
|
|
export const ReplicationDiagram = () => {
|
|
return (
|
|
<ReactFlowProvider>
|
|
<ReplicationDiagramContent />
|
|
</ReactFlowProvider>
|
|
)
|
|
}
|
|
|
|
const nodeTypes = {
|
|
primary: PrimaryDatabaseNode,
|
|
replication: ReplicationNode,
|
|
readReplica: ReadReplicaNode,
|
|
}
|
|
|
|
const edgeTypes = { smoothstep: SmoothstepEdge }
|
|
|
|
const ReplicationDiagramContent = () => {
|
|
const reactFlow = useReactFlow()
|
|
const { resolvedTheme } = useTheme()
|
|
const { ref: projectRef = 'default' } = useParams()
|
|
|
|
const { data: databases = [], isSuccess: isSuccessReplicas } = useReadReplicasQuery({
|
|
projectRef,
|
|
})
|
|
const readReplicas = useMemo(
|
|
() => databases.filter((x) => x.identifier !== projectRef),
|
|
[databases, projectRef]
|
|
)
|
|
|
|
const {
|
|
data,
|
|
error: destinationsError,
|
|
isSuccess: isSuccessDestinations,
|
|
isError: isErrorDestinations,
|
|
} = useReplicationDestinationsQuery({
|
|
projectRef,
|
|
})
|
|
const destinations = useMemo(() => data?.destinations ?? [], [data])
|
|
const isLocalETLNotSetUp = checkLocalETLNotSetUp(destinationsError)
|
|
const skipRenderingDestinations = isErrorDestinations && isLocalETLNotSetUp
|
|
|
|
const nodes = useMemo(() => {
|
|
return [
|
|
{ id: projectRef, type: 'primary', data: {}, position: { x: 0, y: 5 } },
|
|
...readReplicas.map((x) => ({
|
|
id: x.identifier,
|
|
type: 'readReplica',
|
|
data: {},
|
|
position: { x: 0, y: 0 },
|
|
})),
|
|
...destinations.map((x) => ({
|
|
id: x.id.toString(),
|
|
type: 'replication',
|
|
data: {},
|
|
position: { x: 0, y: 0 },
|
|
})),
|
|
]
|
|
}, [destinations, projectRef, readReplicas])
|
|
|
|
const edges = useMemo(() => {
|
|
const shiftEdgeEnd = readReplicas.length + destinations.length > 1
|
|
|
|
return [
|
|
...readReplicas.map((x) => ({
|
|
id: `${projectRef}-${x.identifier}`,
|
|
source: projectRef,
|
|
target: x.identifier,
|
|
type: 'smoothstep',
|
|
className: 'cursor-default!',
|
|
// The edge subscribes to live status itself (see Edges.tsx) so it stays in sync with nodes.
|
|
data: { type: 'replica', identifier: x.identifier, shiftEdgeEnd },
|
|
})),
|
|
...destinations.map((x) => ({
|
|
id: `${projectRef}-${x.id}`,
|
|
source: projectRef,
|
|
target: x.id.toString(),
|
|
type: 'smoothstep',
|
|
className: 'cursor-default!',
|
|
data: { type: 'etl', identifier: x.id.toString(), shiftEdgeEnd },
|
|
})),
|
|
]
|
|
}, [destinations, projectRef, readReplicas])
|
|
|
|
const backgroundPatternColor =
|
|
resolvedTheme === 'dark' ? 'rgba(255, 255, 255, 0.3)' : 'rgba(0, 0, 0, 0.4)'
|
|
|
|
const setReactFlow = async () => {
|
|
const graph = getDagreGraphLayout(nodes, edges)
|
|
reactFlow.setNodes(graph.nodes)
|
|
reactFlow.setEdges(graph.edges)
|
|
|
|
// [Joshen] Odd fix to ensure that react flow snaps back to center when adding nodes
|
|
await timeout(1)
|
|
reactFlow.fitView({ minZoom: 0.8, maxZoom: 0.9 })
|
|
}
|
|
|
|
useEffect(() => {
|
|
if (
|
|
nodes.length > 0 &&
|
|
(isSuccessDestinations || skipRenderingDestinations) &&
|
|
isSuccessReplicas
|
|
) {
|
|
setReactFlow()
|
|
}
|
|
}, [nodes, isSuccessDestinations, skipRenderingDestinations, isSuccessReplicas])
|
|
|
|
return (
|
|
<div className="nowheel relative h-[350px] w-full border border-muted rounded-md overflow-hidden">
|
|
<ReactFlow
|
|
// FIXME: https://github.com/xyflow/xyflow/issues/4876
|
|
colorMode={'' as unknown as ColorMode}
|
|
fitView
|
|
fitViewOptions={{ minZoom: 0.8, maxZoom: 0.9 }}
|
|
className="bg"
|
|
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>
|
|
</div>
|
|
)
|
|
}
|