Files
supabase/apps/studio/components/interfaces/Database/Replication/ReadReplicas/ReadReplicaDetails.tsx
Riccardo Busetti 324c724117 ref(replication): Improve replication copy and UI (#46793)
This PR improves the replication UI in the following ways:
- Adds a new selecion picker for destinations which is split by the
destination location and it's clearer and can scale more when we add
more destinations.
- Adds a much improved section on lag, highlighting new metrics that
could help debug issues more easily.
- Improves the copy across the whole code.
- Fixes the 2d topological view of replication with better status
handling.

### Screenshots

<img width="1270" height="777" alt="image"
src="https://github.com/user-attachments/assets/0ffc890e-2f80-47e5-bdb1-75071adda024"
/>

<img width="1665" height="656" alt="image"
src="https://github.com/user-attachments/assets/23a27a02-acb2-4891-af95-5bc1d6ec7bfe"
/>

<img width="1454" height="247" alt="image"
src="https://github.com/user-attachments/assets/c8799983-aa63-42b2-9370-ae4e009c1573"
/>

<img width="1120" height="340" alt="image"
src="https://github.com/user-attachments/assets/20a18ad6-e5a9-40ec-80d4-42d6f783d868"
/>

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **New Features**
  * Live slot health indicators, legend, and connection badges.
  * Grouped destination type dropdown with alpha badges.

* **Improvements**
* Clearer UI copy for external destinations, alpha disclaimers, and
onboarding flows.
* Consolidated "n/a" handling for lag displays and richer metric
tooltips.
* Simplified replication diagram visuals and clearer table/row
status/lag presentation.
* Replication status responses now include expanded slot health and lag
metrics.

* **Tests**
* New test suites covering destination selection and destination row
states.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-06-11 10:58:36 +00:00

180 lines
6.8 KiB
TypeScript

import { useParams } from 'common'
import { BarChart2 } from 'lucide-react'
import { useMemo } from 'react'
import { AWS_REGIONS } from 'shared-data'
import { Card, CardContent, CardHeader, CardTitle } from 'ui'
import {
Chart,
ChartCard,
ChartContent,
ChartEmptyState,
ChartHeader,
ChartLine,
ChartLoadingState,
ChartMetric,
GenericSkeletonLoader,
} from 'ui-patterns'
import { Input } from 'ui-patterns/DataInputs/Input'
import { FormItemLayout } from 'ui-patterns/form/FormItemLayout/FormItemLayout'
import { REPORT_DATERANGE_HELPER_LABELS } from '@/components/interfaces/Reports/Reports.constants'
import { REPLICA_STATUS } from '@/components/interfaces/Settings/Infrastructure/InfrastructureConfiguration/InstanceConfiguration.constants'
import { ScaffoldContainer, ScaffoldSection } from '@/components/layouts/Scaffold'
import { useInfraMonitoringAttributesQuery } from '@/data/analytics/infra-monitoring-query'
import { useLoadBalancersQuery } from '@/data/read-replicas/load-balancers-query'
import { useReplicationLagQuery } from '@/data/read-replicas/replica-lag-query'
import { useReadReplicasQuery } from '@/data/read-replicas/replicas-query'
import { useReadReplicasStatusesQuery } from '@/data/read-replicas/replicas-status-query'
import { useReportDateRange } from '@/hooks/misc/useReportDateRange'
import { BASE_PATH } from '@/lib/constants'
const attribute = 'physical_replication_lag_physical_replication_lag_seconds'
export const ReadReplicaDetails = () => {
const { ref: projectRef, replicaId } = useParams()
const { data = [], isPending: isLoadingDatabases } = useReadReplicasQuery({ projectRef })
const replica = data.find((x) => x.identifier === replicaId)
const { identifier, connectionString, status: baseStatus, restUrl, region, size } = replica ?? {}
const regionLabel = Object.values(AWS_REGIONS).find((x) => x.code === region)?.displayName
const { data: statuses = [] } = useReadReplicasStatusesQuery({ projectRef })
const replicaStatus = statuses.find((x) => x.identifier === identifier)
const status = replicaStatus?.status ?? baseStatus
const { data: loadBalancers = [] } = useLoadBalancersQuery({ projectRef })
const loadBalancer = loadBalancers.find((x) =>
x.databases.some((x) => x.identifier === identifier)
)
const { data: lagDuration, isPending: isLoadingLag } = useReplicationLagQuery(
{
id: identifier ?? '',
projectRef,
connectionString,
},
{ enabled: status === REPLICA_STATUS.ACTIVE_HEALTHY }
)
const { selectedDateRange } = useReportDateRange(REPORT_DATERANGE_HELPER_LABELS.LAST_60_MINUTES)
// [Joshen] This is unused but intentional to scaffold the usage for now, refer to comment below
const { data: infraMonitoringData, isPending: isFetchingInfraMonitoring } =
useInfraMonitoringAttributesQuery(
{
projectRef,
attributes: [attribute],
databaseIdentifier: identifier,
startDate: selectedDateRange.period_start.date,
endDate: selectedDateRange.period_end.date,
interval: selectedDateRange.interval,
},
{ enabled: !!replica }
)
const chartData = useMemo(
() =>
infraMonitoringData?.data.map((x) => ({
timestamp: x.period_start,
[attribute]: (x as Record<string, string | number>)[attribute],
})) ?? [],
[infraMonitoringData?.data]
)
return (
<>
<Chart className="mt-6" isLoading={isLoadingLag || isFetchingInfraMonitoring}>
<ChartCard className="rounded-none border-x-0">
<ChartHeader className="px-10">
<ChartMetric
label="Replication lag"
value={lagDuration !== undefined ? `${lagDuration}s` : '-'}
/>
</ChartHeader>
<ChartContent
isEmpty={chartData.length === 0}
emptyState={
<ChartEmptyState
icon={<BarChart2 size={16} />}
title="No data to show"
description="It may take up to 24 hours for data to refresh"
/>
}
loadingState={<ChartLoadingState className="h-[228px]" />}
>
<div className="h-56 px-5">
<ChartLine
showGrid
showYAxis
isFullHeight
data={chartData}
dataKey={attribute}
YAxisProps={{
tickFormatter: (value) => `${value}s`,
width: 80,
}}
config={{
[attribute]: { label: 'Replication lag' },
}}
/>
</div>
</ChartContent>
</ChartCard>
</Chart>
<ScaffoldContainer>
<ScaffoldSection isFullWidth>
<Card>
<CardHeader>
<CardTitle>Replica Information</CardTitle>
</CardHeader>
{isLoadingDatabases ? (
<CardContent>
<GenericSkeletonLoader />
</CardContent>
) : (
<>
<CardContent>
<FormItemLayout
isReactForm={false}
layout="horizontal"
label="Load Balancer URL"
description="RESTful endpoint for querying and managing your databases through your load balancer."
>
<Input readOnly copy className="input-mono" value={loadBalancer?.endpoint} />
</FormItemLayout>
</CardContent>
<CardContent className="flex flex-col gap-y-4">
<FormItemLayout isReactForm={false} layout="horizontal" label="Replica URL">
<Input readOnly copy className="input-mono" value={restUrl} />
</FormItemLayout>
<FormItemLayout isReactForm={false} layout="horizontal" label="Region">
<Input
readOnly
className="input-mono"
value={regionLabel}
icon={
<img
alt="region icon"
className="w-5 rounded-xs"
src={`${BASE_PATH}/img/regions/${region ?? ''}.svg`}
/>
}
/>
</FormItemLayout>
<FormItemLayout
isReactForm={false}
layout="horizontal"
label="Compute Size"
description="Size of replica will be identical to the primary database."
>
<Input readOnly className="input-mono" value={size} />
</FormItemLayout>
</CardContent>
</>
)}
</Card>
</ScaffoldSection>
</ScaffoldContainer>
</>
)
}