Files
supabase/apps/studio/components/interfaces/Database/Replication/RowMenu.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

234 lines
7.9 KiB
TypeScript

import { useParams } from 'common'
import {
ArrowUpCircle,
CircleStop,
Edit,
Eye,
MoreVertical,
Play,
RotateCcw,
Trash,
} from 'lucide-react'
import Link from 'next/link'
import { parseAsInteger, useQueryState } from 'nuqs'
import { toast } from 'sonner'
import {
Button,
DropdownMenu,
DropdownMenuContent,
DropdownMenuItem,
DropdownMenuSeparator,
DropdownMenuTrigger,
Tooltip,
TooltipContent,
TooltipTrigger,
WarningIcon,
} from 'ui'
import { ShimmeringLoader } from 'ui-patterns/ShimmeringLoader'
import {
getStatusName,
PIPELINE_DISABLE_ALLOWED_FROM,
PIPELINE_ENABLE_ALLOWED_FROM,
} from './Pipeline.utils'
import { PipelineStatusName } from './Replication.constants'
import { ReplicationPipelineStatusData } from '@/data/replication/pipeline-status-query'
import { Pipeline } from '@/data/replication/pipelines-query'
import { useRestartPipelineMutation } from '@/data/replication/restart-pipeline-mutation'
import { useStartPipelineMutation } from '@/data/replication/start-pipeline-mutation'
import { useStopPipelineMutation } from '@/data/replication/stop-pipeline-mutation'
import {
PipelineStatusRequestStatus,
usePipelineRequestStatus,
} from '@/state/replication-pipeline-request-status'
import type { ResponseError } from '@/types'
interface RowMenuProps {
destinationId: number
pipeline: Pipeline | undefined
pipelineStatus?: ReplicationPipelineStatusData['status']
error: ResponseError | null
isLoading: boolean
isError: boolean
hasUpdate?: boolean
onDeleteClick: () => void
onUpdateClick?: () => void
}
export const RowMenu = ({
destinationId,
pipeline,
pipelineStatus,
error,
isLoading,
isError,
hasUpdate = false,
onDeleteClick,
onUpdateClick,
}: RowMenuProps) => {
const { ref: projectRef } = useParams()
const statusName = getStatusName(pipelineStatus)
const [, setEdit] = useQueryState(
'edit',
parseAsInteger.withOptions({ history: 'push', clearOnDefault: true })
)
const { mutateAsync: startPipeline } = useStartPipelineMutation()
const { mutateAsync: stopPipeline } = useStopPipelineMutation()
const { mutateAsync: restartPipeline } = useRestartPipelineMutation()
const { getRequestStatus, setRequestStatus: setGlobalRequestStatus } = usePipelineRequestStatus()
const requestStatus = pipeline?.id
? getRequestStatus(pipeline.id)
: PipelineStatusRequestStatus.None
// Show actions when not in a transitional state
const canPerformActions =
requestStatus === PipelineStatusRequestStatus.None &&
statusName !== PipelineStatusName.STARTING &&
[PipelineStatusName.STOPPED, PipelineStatusName.STARTED, PipelineStatusName.FAILED].includes(
statusName as PipelineStatusName
)
// Show both stop and restart for started/failed states
const showStopAndRestart =
canPerformActions &&
(statusName === PipelineStatusName.STARTED || statusName === PipelineStatusName.FAILED)
// Show only start for stopped state
const showStart = canPerformActions && statusName === PipelineStatusName.STOPPED
const onEnablePipeline = async () => {
if (!projectRef) return console.error('Project ref is required')
if (!pipeline) return toast.error('No pipeline found')
try {
// Only show 'enabling' when transitioning from allowed states
if (PIPELINE_ENABLE_ALLOWED_FROM.includes(statusName as PipelineStatusName)) {
setGlobalRequestStatus(pipeline.id, PipelineStatusRequestStatus.StartRequested, statusName)
}
await startPipeline({ projectRef, pipelineId: pipeline.id })
} catch (error) {
setGlobalRequestStatus(pipeline.id, PipelineStatusRequestStatus.None)
toast.error(`Failed to start pipeline: ${(error as ResponseError).message}`)
}
}
const onDisablePipeline = async () => {
if (!projectRef) return console.error('Project ref is required')
if (!pipeline) return toast.error('No pipeline found')
try {
// Only show 'disabling' when transitioning from allowed states
if (PIPELINE_DISABLE_ALLOWED_FROM.includes(statusName as PipelineStatusName)) {
setGlobalRequestStatus(pipeline.id, PipelineStatusRequestStatus.StopRequested, statusName)
}
await stopPipeline({ projectRef, pipelineId: pipeline.id })
} catch (error) {
setGlobalRequestStatus(pipeline.id, PipelineStatusRequestStatus.None)
toast.error(`Failed to stop pipeline: ${(error as ResponseError).message}`)
}
}
const onRestartPipeline = async () => {
if (!projectRef) return console.error('Project ref is required')
if (!pipeline) return toast.error('No pipeline found')
try {
setGlobalRequestStatus(pipeline.id, PipelineStatusRequestStatus.RestartRequested, statusName)
await restartPipeline({ projectRef, pipelineId: pipeline.id })
} catch (error) {
setGlobalRequestStatus(pipeline.id, PipelineStatusRequestStatus.None)
toast.error(`Failed to restart pipeline: ${(error as ResponseError).message}`)
}
}
return (
<div className="flex justify-end items-center space-x-2">
{isLoading && <ShimmeringLoader />}
{isError && (
<Tooltip>
<TooltipTrigger asChild>
<span className="flex items-center" tabIndex={0}>
<WarningIcon />
</span>
</TooltipTrigger>
<TooltipContent side="bottom" className="max-w-xs">
Couldn't load status{error?.message ? `: ${error.message}` : '.'}
</TooltipContent>
</Tooltip>
)}
<DropdownMenu>
<DropdownMenuTrigger asChild>
<div className="relative">
<Button
variant="default"
className="px-1.25 hit-area-2"
aria-label={hasUpdate ? 'Pipeline options, update available' : 'Pipeline options'}
icon={<MoreVertical />}
/>
{hasUpdate && (
<span
className="absolute -top-0.5 -right-0.5 h-2 w-2 bg-brand rounded-full"
aria-hidden
/>
)}
</div>
</DropdownMenuTrigger>
<DropdownMenuContent side="bottom" align="end" className="w-52">
<DropdownMenuItem className="space-x-2" asChild disabled={!pipeline}>
<Link href={`/project/${projectRef}/database/replication/${pipeline?.id}`}>
<Eye size={14} />
<p>View details</p>
</Link>
</DropdownMenuItem>
<DropdownMenuSeparator />
{hasUpdate && (
<>
<DropdownMenuItem className="space-x-2" onClick={() => onUpdateClick?.()}>
<ArrowUpCircle size={14} />
<p>Update available</p>
</DropdownMenuItem>
<DropdownMenuSeparator />
</>
)}
{showStart && (
<>
<DropdownMenuItem className="space-x-2" onClick={onEnablePipeline}>
<Play size={14} />
<p>Start pipeline</p>
</DropdownMenuItem>
<DropdownMenuSeparator />
</>
)}
{showStopAndRestart && (
<>
<DropdownMenuItem className="space-x-2" onClick={onRestartPipeline}>
<RotateCcw size={14} />
<p>Restart pipeline</p>
</DropdownMenuItem>
<DropdownMenuItem className="space-x-2" onClick={onDisablePipeline}>
<CircleStop size={14} />
<p>Stop pipeline</p>
</DropdownMenuItem>
<DropdownMenuSeparator />
</>
)}
<DropdownMenuItem className="space-x-2" onClick={() => setEdit(destinationId)}>
<Edit size={14} />
<p>Edit pipeline</p>
</DropdownMenuItem>
<DropdownMenuItem className="space-x-2" onClick={onDeleteClick}>
<Trash size={14} />
<p>Delete pipeline</p>
</DropdownMenuItem>
</DropdownMenuContent>
</DropdownMenu>
</div>
)
}