Files
supabase/apps/studio/components/interfaces/Database/Replication/DestinationRow.tsx
T
Danny White 2e435986c9 feat(studio): polish the Replication pipelines list (#50252)
## What kind of change does this PR introduce?

Studio UI and interaction polish. This is the second PR in the Pipelines
review stack and depends on #50251.

## What is the current behaviour?

Pipeline rows require a separate view action, cannot be sorted, and
present lifecycle, lag, and destination terminology inconsistently.

## What is the new behaviour?

Makes rows navigable with link-like mouse and keyboard behaviour, adds
Name and Status sorting, reuses cached status queries, and moves row
actions into the overflow menu. It also clarifies pipeline terminology,
adds Docs and feedback actions, and standardises state, error, lag, and
loading presentation with accessible announcements.

| Before | After |
| --- | --- |
| <img width="1280" height="1323" alt="Replication Database ETL BigTable
ETL Team Supabase"
src="https://github.com/user-attachments/assets/53a62283-0e58-4408-8409-2b87a38af159"
/> | <img width="1280" height="1323" alt="Replication Database Agua
Basket Supabase"
src="https://github.com/user-attachments/assets/ba4de1e0-4a84-43b4-8975-ca05a3056bcf"
/> |

## To test

1. Open `/project/<ref>/database/replication`.
2. Sort by Name and Status, then confirm failed and stopped pipelines
surface first when Status is ascending.
3. Click a row, use Enter or Space, and modifier-click or middle-click
to verify link behaviour.
4. Open the row overflow menu and confirm it does not navigate.
5. Check loading, initial sync, caught up, numeric lag, unavailable lag,
and table-error states where available.


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

- **New Features**
- Added sortable pipeline lists with clearer loading, empty, and error
states.
- Pipeline rows now support direct navigation, detail viewing, status
indicators, lag progress, and table error summaries.
- Added initial-sync progress indicators and accessible status
announcements.
  - Added documentation and feedback links.
  - Improved pipeline version update and enable/disable dialogs.

- **Bug Fixes**
  - Prevented right-clicks from triggering navigation.
  - Improved unavailable lag and initial-sync handling.

- **Style**
- Standardized replication terminology and confirmation messaging around
pipelines.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-09-15 10:07:49 +10:00

297 lines
11 KiB
TypeScript

import { useParams } from 'common'
import { ChevronRight, Minus } from 'lucide-react'
import { useRouter } from 'next/router'
import { useEffect, useState } from 'react'
import { toast } from 'sonner'
import { TableCell, TableRow } from 'ui'
import { ShimmeringLoader } from 'ui-patterns/ShimmeringLoader'
import { DeleteDestination } from './DeleteDestination'
import { DestinationLogo } from './DestinationLogo'
import { DetailSubtext } from './DetailSubtext'
import { PipelineStatePill } from './PipelineStatePill'
import { PipelineStatusName, STATUS_REFRESH_FREQUENCY_MS } from './Replication.constants'
import {
getFormattedLagValue,
getInitialSyncProgress,
} from './ReplicationPipelineStatus/ReplicationPipelineStatus.utils'
import { RowMenu } from './RowMenu'
import { UpdateVersionModal } from './UpdateVersionModal'
import { useDestinationInformation } from './useDestinationInformation'
import { AlertError } from '@/components/ui/AlertError'
import { useDeleteDestinationPipelineMutation } from '@/data/replication/delete-destination-pipeline-mutation'
import { useReplicationPipelineReplicationStatusQuery } from '@/data/replication/pipeline-replication-status-query'
import { useReplicationPipelineStatusQuery } from '@/data/replication/pipeline-status-query'
import { useReplicationPipelineVersionQuery } from '@/data/replication/pipeline-version-query'
import { useStopPipelineMutation } from '@/data/replication/stop-pipeline-mutation'
import { createNavigationHandler } from '@/lib/navigation'
import {
PipelineStatusRequestStatus,
usePipelineRequestStatus,
} from '@/state/replication-pipeline-request-status'
import { type ResponseError } from '@/types'
interface DestinationRowProps {
destinationId: number
}
export const DestinationRow = ({ destinationId }: DestinationRowProps) => {
const router = useRouter()
const { ref: projectRef } = useParams()
const [showDeleteDestinationForm, setShowDeleteDestinationForm] = useState(false)
const [isDeleting, setIsDeleting] = useState(false)
const [showUpdateVersionModal, setShowUpdateVersionModal] = useState(false)
const { type, statusName, destination, pipeline, pipelineStatus, pipelineFetcher } =
useDestinationInformation({
id: destinationId,
})
const {
error: pipelineError,
isPending: isPipelineLoading,
isError: isPipelineError,
isSuccess: isPipelineSuccess,
} = pipelineFetcher
const destinationName = destination?.name ?? ''
const {
error: pipelineStatusError,
isPending: isPipelineStatusLoading,
isError: isPipelineStatusError,
isSuccess: isPipelineStatusSuccess,
} = useReplicationPipelineStatusQuery(
{
projectRef,
pipelineId: pipeline?.id,
},
{ refetchInterval: STATUS_REFRESH_FREQUENCY_MS }
)
const { getRequestStatus, updatePipelineStatus } = usePipelineRequestStatus()
const requestStatus = pipeline?.id
? getRequestStatus(pipeline.id)
: PipelineStatusRequestStatus.None
const { mutateAsync: stopPipeline } = useStopPipelineMutation()
const { mutateAsync: deleteDestinationPipeline } = useDeleteDestinationPipelineMutation({})
// Fetch table-level replication status to surface errors in list view
const {
data: replicationStatusData,
isPending: isReplicationStatusLoading,
isError: isReplicationStatusError,
} = useReplicationPipelineReplicationStatusQuery(
{ projectRef, pipelineId: pipeline?.id },
{ refetchInterval: STATUS_REFRESH_FREQUENCY_MS }
)
const tableStatuses = replicationStatusData?.table_statuses ?? []
const errorCount = tableStatuses.filter((t) => t.state?.name === 'error').length
const applyLag = replicationStatusData?.apply_lag
// Show the byte-based slot lag (WAL the destination hasn't confirmed flushing yet). The
// time-based flush_lag from pg_stat_replication is routinely NULL for logical slots that are
// idle or don't report timed feedback, whereas confirmed_flush_lsn_bytes is always populated.
const lagBytes = applyLag?.confirmed_flush_lsn_bytes
const lag = getFormattedLagValue('bytes', lagBytes)
// The lag figure only covers ongoing changes, so it reads as "Caught up" while an initial copy
// is still running. Say what's actually happening instead.
const { syncingCount } = getInitialSyncProgress(tableStatuses)
const isInitialSyncRunning = syncingCount > 0
const isCaughtUp = lagBytes === 0
// Only show errors when pipeline is running (not when stopped or restarting)
const isPipelineStopped = statusName === PipelineStatusName.STOPPED
const isRestarting = requestStatus === PipelineStatusRequestStatus.RestartRequested
const hasTableErrors = errorCount > 0 && !isPipelineStopped && !isRestarting
// Check if a newer pipeline version is available (one-time check cached for session)
const { data: versionData } = useReplicationPipelineVersionQuery({
projectRef,
pipelineId: pipeline?.id,
})
const hasUpdate = Boolean(versionData?.new_version)
const handleNavigation = pipeline
? createNavigationHandler(`/project/${projectRef}/database/replication/${pipeline.id}`, router)
: undefined
const onDeleteClick = async () => {
if (!projectRef) {
return console.error('Project ref is required')
}
if (!pipeline) {
return toast.error('No pipeline found')
}
try {
setIsDeleting(true)
await stopPipeline({ projectRef, pipelineId: pipeline.id })
await deleteDestinationPipeline({
projectRef,
destinationId: destinationId,
pipelineId: pipeline.id,
})
// Close dialog after successful deletion
setShowDeleteDestinationForm(false)
toast.success(`Deleted pipeline "${destinationName}"`)
} catch (error) {
toast.error(`Failed to delete pipeline: ${(error as ResponseError).message}`)
} finally {
setIsDeleting(false)
}
}
useEffect(() => {
if (pipeline?.id) {
updatePipelineStatus(pipeline.id, statusName)
}
}, [pipeline?.id, statusName, updatePipelineStatus])
// Five distinct states, so early returns rather than a ternary chain. The row only renders once
// a pipeline exists, so there is no "no pipeline" case to handle here.
const renderLag = () => {
if (isReplicationStatusLoading) return <ShimmeringLoader />
if (isInitialSyncRunning)
return <span className="text-foreground-light whitespace-nowrap">Initial sync</span>
if (isReplicationStatusError || !applyLag)
return (
<>
<Minus size={18} className="text-foreground-lighter" aria-hidden />
<span className="sr-only">Lag unavailable</span>
</>
)
if (isCaughtUp)
return <span className="text-foreground-light whitespace-nowrap">Caught up</span>
return <span className="text-foreground-light whitespace-nowrap">{lag.display}</span>
}
return (
<>
{isPipelineError && (
<TableRow>
<TableCell colSpan={6}>
<AlertError error={pipelineError} subject="Failed to retrieve pipeline information" />
</TableCell>
</TableRow>
)}
{isPipelineSuccess && pipeline && (
<TableRow
className="relative cursor-pointer focus-inset"
onClick={handleNavigation}
onAuxClick={handleNavigation}
onKeyDown={handleNavigation}
tabIndex={0}
>
<TableCell className="!pr-1">
{type ? <DestinationLogo type={type} hasErrors={hasTableErrors} /> : null}
</TableCell>
<TableCell className="max-w-[180px]">
{isPipelineLoading ? (
<ShimmeringLoader />
) : (
<div className="flex flex-col gap-y-0.5">
<p className="text-sm font-medium text-foreground truncate">
{destinationName || type}
</p>
<DetailSubtext className="flex items-center gap-x-1.5">
<span>#{pipeline?.id}</span>
<span aria-hidden>&middot;</span>
<span>{type}</span>
{hasTableErrors && (
<>
<span aria-hidden>&middot;</span>
<span className="text-destructive">
{errorCount} table error{errorCount === 1 ? '' : 's'}
</span>
</>
)}
</DetailSubtext>
</div>
)}
</TableCell>
<TableCell>
{isPipelineLoading || !pipeline ? (
<ShimmeringLoader />
) : (
<PipelineStatePill
pipelineStatus={pipelineStatus?.status}
error={pipelineStatusError}
isLoading={isPipelineStatusLoading}
isError={isPipelineStatusError}
isSuccess={isPipelineStatusSuccess}
requestStatus={requestStatus}
projectRef={projectRef}
pipelineId={pipeline?.id}
/>
)}
</TableCell>
<TableCell>
<div aria-live="polite" aria-atomic="true">
{isReplicationStatusLoading && <span className="sr-only">Loading lag</span>}
{renderLag()}
</div>
</TableCell>
<TableCell>
{isPipelineLoading || !pipeline ? (
<ShimmeringLoader />
) : (
pipeline.config.publication_name
)}
</TableCell>
<TableCell>
<div className="flex items-center justify-end gap-x-2">
<div
onClick={(event) => event.stopPropagation()}
onAuxClick={(event) => event.stopPropagation()}
onKeyDown={(event) => event.stopPropagation()}
>
<RowMenu
destinationId={destinationId}
pipeline={pipeline}
pipelineStatus={pipelineStatus?.status}
error={pipelineStatusError}
isLoading={isPipelineStatusLoading}
isError={isPipelineStatusError}
onDeleteClick={() => setShowDeleteDestinationForm(true)}
hasUpdate={hasUpdate}
onUpdateClick={() => setShowUpdateVersionModal(true)}
/>
</div>
<ChevronRight
size={16}
strokeWidth={1.5}
className="text-foreground-lighter"
aria-hidden
/>
<button tabIndex={-1} className="sr-only">
Go to pipeline details
</button>
</div>
</TableCell>
</TableRow>
)}
<DeleteDestination
visible={showDeleteDestinationForm}
setVisible={setShowDeleteDestinationForm}
onDelete={onDeleteClick}
isLoading={isDeleting}
name={destinationName}
/>
<UpdateVersionModal
visible={showUpdateVersionModal}
pipeline={pipeline}
onClose={() => setShowUpdateVersionModal(false)}
confirmLabel={
statusName === PipelineStatusName.STARTED || statusName === PipelineStatusName.FAILED
? 'Update and restart'
: 'Update version'
}
/>
</>
)
}