Files
supabase/apps/studio/components/interfaces/Database/Replication/RowMenu.tsx
T
edec85d1ca fix(pipelines): Make pipeline actions and status updates reliable (#50085)
## Summary

Make pipeline actions and status feedback reliable while requests are
running or fail. Let the backend coordinate table resets and restarts,
keep stopped pipelines stopped after resets or settings changes, and
refresh the UI from confirmed backend state.

## Pipeline actions and recovery

- Reset one table, all errored tables, or all tables through the
rollback endpoint without separate frontend stop/start requests. Explain
which destination data is deleted, which rows are copied again, initial
sync charges, and the skip-initial-sync setting.
- Keep pending feedback until the action and a fresh status read finish,
including across navigation and polling errors. Prevent overlapping
actions and disable start/stop controls when status is unavailable or
transitioning.
- Close the creation form once the pipeline is created. If its initial
start fails, users can retry Start on the existing pipeline without
creating a duplicate.
- Wait for confirmed shutdown before deletion; a shutdown error or
timeout leaves deletion retryable. Keep failed version updates open and
avoid reporting success.
- Clarify recovery guidance and pending labels, suppress duplicate error
toasts, and hide stale table errors during transitions.

## Status updates and shared UI

- Poll pipeline status and table metrics one second after each response,
share in-flight reads, pause dashboard polling in background tabs, and
respect rate-limit backoff. The shutdown waiter continues in the
background.
- Refresh metadata after mutations even when an older read is in flight,
while preserving shared polling requests. Refresh affected data after
failures that may follow a committed reset or settings change.
- Move pending request state into the shared, project-keyed
`DatabaseLayout` so the list, detail page, and diagram stay consistent.
The surrounding database-page changes update named imports in both
Next.js and TanStack routes.
- Simplify action, status, and form rendering; announce status changes
to assistive technology; and sort table statuses without mutating cached
data.

---------

Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
Co-authored-by: Danny White <3104761+dnywh@users.noreply.github.com>
2026-09-18 11:32:48 +08:00

241 lines
7.7 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 } 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({ onError: () => {} })
const { mutateAsync: stopPipeline } = useStopPipelineMutation({ onError: () => {} })
const { mutateAsync: restartPipeline } = useRestartPipelineMutation()
const { getRequestStatus, isRequestPending, runWithRequestStatus } = usePipelineRequestStatus()
const requestStatus = pipeline?.id
? getRequestStatus(pipeline.id)
: PipelineStatusRequestStatus.None
const isPipelineRequestPending = !!pipeline && isRequestPending(pipeline.id)
// Show actions when not in a transitional state
const canPerformActions =
!isError &&
!!pipeline &&
!isPipelineRequestPending &&
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 {
await runWithRequestStatus(pipeline.id, PipelineStatusRequestStatus.StartRequested, () =>
startPipeline({ projectRef, pipelineId: pipeline.id })
)
} catch (error) {
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 {
await runWithRequestStatus(pipeline.id, PipelineStatusRequestStatus.StopRequested, () =>
stopPipeline({ projectRef, pipelineId: pipeline.id })
)
} catch (error) {
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 {
await runWithRequestStatus(pipeline.id, PipelineStatusRequestStatus.StopRequested, () =>
restartPipeline({ projectRef, pipelineId: pipeline.id })
)
} catch (error) {
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-44">
<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?.()}
disabled={isPipelineRequestPending}
>
<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)}
disabled={isPipelineRequestPending}
>
<Edit size={14} />
<p>Edit pipeline</p>
</DropdownMenuItem>
<DropdownMenuItem
className="space-x-2"
onClick={onDeleteClick}
disabled={isPipelineRequestPending}
>
<Trash size={14} />
<p>Delete pipeline</p>
</DropdownMenuItem>
</DropdownMenuContent>
</DropdownMenu>
</div>
)
}