Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

feat(studio): give pipeline pages a standard detail header (#50253)

Danny White229d04d65c8b
diff --git a/apps/studio/components/interfaces/Database/Replication/PipelineStatus.tsx b/apps/studio/components/interfaces/Database/Replication/PipelineStatus.tsx
deleted file mode 100644
index dcf28a2106b..00000000000
--- a/apps/studio/components/interfaces/Database/Replication/PipelineStatus.tsx
+++ /dev/null
@@ -1,89 +0,0 @@
-import { useParams } from 'common'
-import { Loader2 } from 'lucide-react'
-import { Badge, Tooltip, TooltipContent, TooltipTrigger } from 'ui'
-import { ShimmeringLoader } from 'ui-patterns/ShimmeringLoader'
-
-import { getPipelineDisplayState, getStatusName } from './Pipeline.utils'
-import { PipelineStatusName } from './Replication.constants'
-import { InlineLink } from '@/components/ui/InlineLink'
-import { ReplicationPipelineStatusData } from '@/data/replication/pipeline-status-query'
-import { PipelineStatusRequestStatus } from '@/state/replication-pipeline-request-status'
-import type { ResponseError } from '@/types'
-
-interface PipelineStatusProps {
- pipelineStatus: ReplicationPipelineStatusData['status'] | undefined
- error: ResponseError | null
- isLoading: boolean
- isError: boolean
- isSuccess: boolean
- requestStatus?: PipelineStatusRequestStatus
- pipelineId?: number
-}
-
-export const PipelineStatus = ({
- pipelineStatus,
- error,
- isLoading,
- isError,
- isSuccess,
- requestStatus,
- pipelineId,
-}: PipelineStatusProps) => {
- const { ref } = useParams()
-
- const statusName = getStatusName(pipelineStatus)
- const displayState = getPipelineDisplayState(requestStatus, statusName)
- const { type, message, label } = displayState
-
- const pipelineLogsUrl = pipelineId
- ? `/project/${ref}/logs/replication-logs?f=${encodeURIComponent(
- JSON.stringify({ pipeline_id: pipelineId })
- )}`
- : `/project/${ref}/logs/replication-logs`
-
- const showLogsCTA = [PipelineStatusName.UNKNOWN, PipelineStatusName.FAILED].includes(
- statusName as PipelineStatusName
- )
-
- return (
- <>
- {isLoading && <ShimmeringLoader />}
-
- {isError && (
- <Tooltip>
- <TooltipTrigger>
- <Badge variant="default">Unknown</Badge>
- </TooltipTrigger>
- <TooltipContent side="bottom" className="w-64 text-center">
- Unable to retrieve status: {error?.message}
- </TooltipContent>
- </Tooltip>
- )}
-
- {isSuccess && (
- <Tooltip>
- <TooltipTrigger asChild>
- <div className="flex items-center gap-x-2">
- <Badge
- variant={
- type === 'failure' ? 'destructive' : type === 'success' ? 'success' : 'default'
- }
- >
- {label}
- </Badge>
- {type === 'loading' && <Loader2 className="animate-spin w-3 h-3" />}
- </div>
- </TooltipTrigger>
- <TooltipContent side="bottom">
- {message}{' '}
- {showLogsCTA && (
- <>
- Check the <InlineLink href={pipelineLogsUrl}>logs</InlineLink> for more information.
- </>
- )}
- </TooltipContent>
- </Tooltip>
- )}
- </>
- )
-}
diff --git a/apps/studio/components/interfaces/Database/Replication/ReplicationPipelineLayout.test.tsx b/apps/studio/components/interfaces/Database/Replication/ReplicationPipelineLayout.test.tsx
new file mode 100644
index 00000000000..5b5722d2f40
--- /dev/null
+++ b/apps/studio/components/interfaces/Database/Replication/ReplicationPipelineLayout.test.tsx
@@ -0,0 +1,308 @@
+import { screen, waitFor } from '@testing-library/react'
+import userEvent from '@testing-library/user-event'
+import type { components } from 'api-types'
+import { mockAnimationsApi } from 'jsdom-testing-mocks'
+import { HttpResponse } from 'msw'
+import { ReactNode, type AnchorHTMLAttributes } from 'react'
+import { beforeEach, describe, expect, test, vi } from 'vitest'
+
+import { ReplicationPipelineLayout } from './ReplicationPipelineLayout'
+import { ReplicationPipelineStatus } from './ReplicationPipelineStatus/ReplicationPipelineStatus'
+import {
+ PipelineRequestStatusProvider,
+ usePipelineRequestStatus,
+} from '@/state/replication-pipeline-request-status'
+import { customRender } from '@/tests/lib/custom-render'
+import { addAPIMock } from '@/tests/lib/msw'
+
+mockAnimationsApi()
+
+// The global setup pins useParams to { ref: 'default' }; this layout also needs a pipeline id
+vi.mock('common', async (importOriginal) => ({
+ ...(await importOriginal<typeof import('common')>()),
+ useParams: () => ({ ref: 'default', pipelineId: '42' }),
+}))
+
+vi.mock('next/router', () => ({
+ useRouter: () => ({ push: vi.fn() }),
+}))
+
+vi.mock('next/link', () => ({
+ default: ({
+ href,
+ children,
+ ...props
+ }: AnchorHTMLAttributes<HTMLAnchorElement> & { href: string }) => (
+ <a href={href} {...props}>
+ {children}
+ </a>
+ ),
+}))
+
+const renderLayout = (children?: ReactNode) =>
+ customRender(
+ <PipelineRequestStatusProvider>
+ <ReplicationPipelineLayout>{children}</ReplicationPipelineLayout>
+ </PipelineRequestStatusProvider>
+ )
+
+const TableResetFixture = () => {
+ const { setTableResetting } = usePipelineRequestStatus()
+
+ return (
+ <>
+ <button tabIndex={0} onClick={() => setTableResetting(42, true)}>
+ Begin table reset
+ </button>
+ <button tabIndex={0} onClick={() => setTableResetting(42, false)}>
+ Finish table reset
+ </button>
+ </>
+ )
+}
+
+type PipelineResponse = components['schemas']['PipelineResponse_Output']
+type PipelineStatusResponse = components['schemas']['PipelineStatusResponse_Output']
+type PipelineReplicationStatusResponse =
+ components['schemas']['PipelineReplicationStatusResponse_Output']
+type PipelineVersionResponse = components['schemas']['PipelineVersionResponse_Output']
+type DestinationResponse = components['schemas']['DestinationResponse_Output']
+type DestinationsResponse = components['schemas']['DestinationsResponse_Output']
+type PipelinesResponse = components['schemas']['PipelinesResponse_Output']
+type SourcesResponse = components['schemas']['SourcesResponse_Output']
+
+const PIPELINE: PipelineResponse = {
+ id: 42,
+ config: { publication_name: 'analytics_publication' },
+ destination_id: 7,
+ destination_name: 'Analytics warehouse',
+ replicator_id: 1,
+ source_id: 2,
+ source_name: 'main-db',
+ tenant_id: 'default',
+}
+
+const DESTINATION: DestinationResponse = {
+ id: 7,
+ name: 'Analytics warehouse',
+ tenant_id: 'default',
+ config: {
+ big_query: {
+ connection_pool_size: 8,
+ dataset_id: 'analytics',
+ project_id: 'acme-analytics',
+ },
+ },
+}
+
+const mockPipeline = () => {
+ addAPIMock({
+ method: 'get',
+ path: '/platform/replication/:ref/pipelines/:pipeline_id',
+ response: () => HttpResponse.json<PipelineResponse>(PIPELINE),
+ })
+ addAPIMock({
+ method: 'get',
+ path: '/platform/replication/:ref/destinations/:destination_id',
+ response: () => HttpResponse.json<DestinationResponse>(DESTINATION),
+ })
+
+ // The header renders DestinationPanel so Edit destination can open in place
+ addAPIMock({
+ method: 'get',
+ path: '/platform/replication/:ref/destinations',
+ response: () => HttpResponse.json<DestinationsResponse>({ destinations: [DESTINATION] }),
+ })
+ addAPIMock({
+ method: 'get',
+ path: '/platform/replication/:ref/pipelines',
+ response: () => HttpResponse.json<PipelinesResponse>({ pipelines: [PIPELINE] }),
+ })
+ addAPIMock({
+ method: 'get',
+ path: '/platform/replication/:ref/sources',
+ response: () =>
+ HttpResponse.json<SourcesResponse>({
+ sources: [
+ {
+ tenant_id: 'default',
+ id: 2,
+ name: 'default',
+ config: { host: 'db.internal', port: 5432, name: 'main-db', username: 'etl_user' },
+ },
+ ],
+ }),
+ })
+}
+
+const mockStatus = (name: PipelineStatusResponse['status']['name']) =>
+ addAPIMock({
+ method: 'get',
+ path: '/platform/replication/:ref/pipelines/:pipeline_id/status',
+ response: () =>
+ HttpResponse.json<PipelineStatusResponse>({ pipeline_id: 42, status: { name } }),
+ })
+
+const mockVersion = (hasUpdate: boolean) =>
+ addAPIMock({
+ method: 'get',
+ path: '/platform/replication/:ref/pipelines/:pipeline_id/version',
+ response: () =>
+ HttpResponse.json<PipelineVersionResponse>({
+ pipeline_id: 42,
+ version: { id: 1, name: 'v0.2.0' },
+ ...(hasUpdate ? { new_version: { id: 2, name: 'v0.3.0' } } : {}),
+ }),
+ })
+
+const mockReplicationStatus = () =>
+ addAPIMock({
+ method: 'get',
+ path: '/platform/replication/:ref/pipelines/:pipeline_id/replication-status',
+ response: () =>
+ HttpResponse.json<PipelineReplicationStatusResponse>({
+ pipeline_id: 42,
+ table_statuses: [],
+ }),
+ })
+
+describe('ReplicationPipelineLayout', () => {
+ beforeEach(() => {
+ mockPipeline()
+ mockVersion(false)
+ })
+
+ test('renders pipeline identity, chrome actions and the lifecycle action', async () => {
+ mockStatus('started')
+
+ renderLayout(<div>Overview content</div>)
+
+ expect(await screen.findByRole('heading', { name: 'Analytics warehouse' })).toBeVisible()
+ expect(screen.getByRole('link', { name: 'Replication' })).toHaveAttribute(
+ 'href',
+ '/project/default/database/replication'
+ )
+ expect(screen.getByRole('link', { name: 'View logs' }).getAttribute('href')).toContain(
+ 'pipeline_id'
+ )
+ expect(screen.getByText('Running')).toBeVisible()
+ expect(screen.getByText('Primary database')).toBeVisible()
+ expect(await screen.findByText('BigQuery')).toBeVisible()
+ expect(await screen.findByRole('button', { name: 'Stop' })).toBeVisible()
+ expect(screen.getByText('Overview content')).toBeVisible()
+ })
+
+ test('keeps the pipeline identity structure in place while it loads', async () => {
+ let resolvePipeline: (pipeline: PipelineResponse) => void = () => {}
+ const pipelineResponse = new Promise<PipelineResponse>((resolve) => {
+ resolvePipeline = resolve
+ })
+
+ addAPIMock({
+ method: 'get',
+ path: '/platform/replication/:ref/pipelines/:pipeline_id',
+ response: async () => HttpResponse.json<PipelineResponse>(await pipelineResponse),
+ })
+ mockStatus('started')
+
+ renderLayout()
+
+ expect(screen.getByText('Primary database')).toBeVisible()
+ expect(screen.getByText('Loading destination')).toBeInTheDocument()
+ expect(screen.getAllByText('Loading pipeline')).toHaveLength(2)
+ expect(screen.queryByText('Running')).not.toBeInTheDocument()
+
+ resolvePipeline(PIPELINE)
+
+ expect(await screen.findByRole('heading', { name: 'Analytics warehouse' })).toBeVisible()
+ expect(await screen.findByText('BigQuery')).toBeVisible()
+ expect(await screen.findByText('Running')).toBeVisible()
+ })
+
+ test('composes the legacy overview without duplicating the detail header', async () => {
+ mockStatus('stopped')
+ mockReplicationStatus()
+
+ renderLayout(<ReplicationPipelineStatus />)
+
+ expect(await screen.findByRole('heading', { name: 'Analytics warehouse' })).toBeVisible()
+ expect(screen.getAllByRole('link', { name: 'View logs' })).toHaveLength(1)
+ expect(screen.getAllByRole('button', { name: 'Start' })).toHaveLength(1)
+ expect(await screen.findByRole('heading', { name: 'Pipeline stopped' })).toBeVisible()
+ })
+
+ test('explains the state in a tooltip when the dot is hovered', async () => {
+ // The dotted underline promises a tooltip; this guards the asChild ref binding that makes it work
+ mockStatus('failed')
+ renderLayout()
+
+ await userEvent.hover(await screen.findByText('Failed'))
+
+ expect(await screen.findByRole('tooltip')).toHaveTextContent(
+ 'Replication has encountered an error. Check the logs for more information.'
+ )
+ expect(screen.queryByRole('link', { name: 'logs' })).not.toBeInTheDocument()
+ })
+
+ test('offers the pipeline actions the primary button does not', async () => {
+ mockStatus('started')
+ renderLayout()
+
+ await screen.findByRole('heading', { name: 'Analytics warehouse' })
+ await userEvent.click(screen.getByRole('button', { name: 'Pipeline options' }))
+
+ // Primary button is Stop while running, so the menu carries Restart instead
+ expect(await screen.findByRole('menuitem', { name: 'Restart pipeline' })).toBeVisible()
+ expect(screen.queryByRole('menuitem', { name: 'Stop pipeline' })).not.toBeInTheDocument()
+ expect(screen.getByRole('menuitem', { name: 'Edit pipeline' })).toBeVisible()
+ expect(screen.getByRole('menuitem', { name: 'Delete pipeline' })).toBeVisible()
+ })
+
+ test('blocks pipeline actions while a table reset is running', async () => {
+ mockStatus('started')
+ mockVersion(true)
+ renderLayout(<TableResetFixture />)
+
+ const lifecycleAction = await screen.findByRole('button', { name: 'Stop' })
+ const options = screen.getByRole('button', { name: 'Pipeline options' })
+ const update = await screen.findByRole('button', { name: 'Update available' })
+ expect(lifecycleAction).toBeEnabled()
+ expect(options).toBeEnabled()
+ expect(update).toBeEnabled()
+
+ await userEvent.click(screen.getByRole('button', { name: 'Begin table reset' }))
+ expect(lifecycleAction).toBeDisabled()
+ expect(options).toBeDisabled()
+ expect(update).toBeDisabled()
+
+ await userEvent.click(screen.getByRole('button', { name: 'Finish table reset' }))
+ expect(lifecycleAction).toBeEnabled()
+ expect(options).toBeEnabled()
+ expect(update).toBeEnabled()
+ })
+
+ test('offers Stop from the menu when the primary button is Restart', async () => {
+ mockStatus('failed')
+ renderLayout()
+
+ await screen.findByRole('heading', { name: 'Analytics warehouse' })
+ await waitFor(() => expect(screen.getByRole('button', { name: 'Restart' })).toBeEnabled())
+ await userEvent.click(screen.getByRole('button', { name: 'Pipeline options' }))
+
+ expect(await screen.findByRole('menuitem', { name: 'Stop pipeline' })).toBeVisible()
+ expect(screen.queryByRole('menuitem', { name: 'Restart pipeline' })).not.toBeInTheDocument()
+ })
+
+ test('keeps an available update visible and opens its modal', async () => {
+ mockStatus('started')
+ mockVersion(true)
+
+ renderLayout()
+
+ const updateButton = await screen.findByRole('button', { name: 'Update available' })
+ expect(updateButton).toHaveClass('bg-brand-400')
+ await userEvent.click(updateButton)
+ // The trigger button shares this name, so match the dialog's heading specifically
+ expect(await screen.findByRole('heading', { name: 'Update available' })).toBeVisible()
+ })
+})
diff --git a/apps/studio/components/interfaces/Database/Replication/ReplicationPipelineLayout.tsx b/apps/studio/components/interfaces/Database/Replication/ReplicationPipelineLayout.tsx
new file mode 100644
index 00000000000..77c453d2996
--- /dev/null
+++ b/apps/studio/components/interfaces/Database/Replication/ReplicationPipelineLayout.tsx
@@ -0,0 +1,424 @@
+import { useParams } from 'common'
+import {
+ ArrowRight,
+ ArrowUpCircle,
+ CircleStop,
+ Edit,
+ MoreVertical,
+ Play,
+ RotateCcw,
+ Trash,
+} from 'lucide-react'
+import Link from 'next/link'
+import { useRouter } from 'next/router'
+import { parseAsInteger, useQueryState } from 'nuqs'
+import { PropsWithChildren, useEffect, useState, type ReactNode } from 'react'
+import { toast } from 'sonner'
+import {
+ BreadcrumbItem,
+ BreadcrumbLink,
+ BreadcrumbList,
+ BreadcrumbPage,
+ BreadcrumbSeparator,
+ Button,
+ DropdownMenu,
+ DropdownMenuContent,
+ DropdownMenuItem,
+ DropdownMenuSeparator,
+ DropdownMenuTrigger,
+} from 'ui'
+import { PageBreadcrumbs, PageBreadcrumbsActions } from 'ui-patterns/PageBreadcrumbs'
+import {
+ PageHeader,
+ PageHeaderAside,
+ PageHeaderDescription,
+ PageHeaderIcon,
+ PageHeaderMeta,
+ PageHeaderSummary,
+ PageHeaderTitle,
+} from 'ui-patterns/PageHeader'
+import { ShimmeringLoader } from 'ui-patterns/ShimmeringLoader'
+
+import { DeleteDestination } from './DeleteDestination'
+import { DestinationLogo } from './DestinationLogo'
+import { DestinationPanel } from './DestinationPanel/DestinationPanel'
+import {
+ getPipelineDisplayState,
+ getStatusName,
+ PIPELINE_ACTIONABLE_STATES,
+} from './Pipeline.utils'
+import { PipelineStatePill } from './PipelineStatePill'
+import { PipelineStatusName, STATUS_REFRESH_FREQUENCY_MS } from './Replication.constants'
+import { getReplicationDestinationType } from './ReplicationDiagram/Nodes.utils'
+import { UpdateVersionModal } from './UpdateVersionModal'
+import { DocsButton } from '@/components/ui/DocsButton'
+import { useDeleteDestinationPipelineMutation } from '@/data/replication/delete-destination-pipeline-mutation'
+import { useReplicationDestinationByIdQuery } from '@/data/replication/destination-by-id-query'
+import { useReplicationPipelineByIdQuery } from '@/data/replication/pipeline-by-id-query'
+import { useReplicationPipelineStatusQuery } from '@/data/replication/pipeline-status-query'
+import { useReplicationPipelineVersionQuery } from '@/data/replication/pipeline-version-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 { DOCS_URL } from '@/lib/constants'
+import {
+ PipelineStatusRequestStatus,
+ usePipelineRequestStatus,
+} from '@/state/replication-pipeline-request-status'
+import { type ResponseError } from '@/types'
+
+type LifecycleAction = 'start' | 'stop' | 'restart'
+
+const LIFECYCLE_BY_STATUS: Partial<
+ Record<PipelineStatusName, { label: string; action: LifecycleAction; icon: ReactNode }>
+> = {
+ [PipelineStatusName.STOPPED]: { label: 'Start', action: 'start', icon: <Play /> },
+ [PipelineStatusName.STARTED]: { label: 'Stop', action: 'stop', icon: <CircleStop /> },
+ [PipelineStatusName.FAILED]: { label: 'Restart', action: 'restart', icon: <RotateCcw /> },
+}
+
+export const ReplicationPipelineLayout = ({ children }: PropsWithChildren) => {
+ const { ref: projectRef, pipelineId: pipelineIdParam } = useParams()
+ const pipelineId = Number(pipelineIdParam)
+ const router = useRouter()
+ const [showUpdateVersionModal, setShowUpdateVersionModal] = useState(false)
+ const [showDeleteDestination, setShowDeleteDestination] = useState(false)
+ const [isDeleting, setIsDeleting] = useState(false)
+ const [, setEdit] = useQueryState(
+ 'edit',
+ parseAsInteger.withOptions({ history: 'push', clearOnDefault: true })
+ )
+ const { getRequestStatus, getIsTableResetting, setRequestStatus, updatePipelineStatus } =
+ usePipelineRequestStatus()
+ const requestStatus = getRequestStatus(pipelineId)
+ const isTableResetting = getIsTableResetting(pipelineId)
+
+ const {
+ data: pipeline,
+ error: pipelineError,
+ isPending: isPipelineLoading,
+ } = useReplicationPipelineByIdQuery(
+ { projectRef, pipelineId },
+ { enabled: Number.isSafeInteger(pipelineId) }
+ )
+ const {
+ data: pipelineStatusData,
+ error: pipelineStatusError,
+ isLoading: isPipelineStatusLoading,
+ isError: isPipelineStatusError,
+ isSuccess: isPipelineStatusSuccess,
+ } = useReplicationPipelineStatusQuery(
+ { projectRef, pipelineId },
+ { enabled: !!pipelineId, refetchInterval: STATUS_REFRESH_FREQUENCY_MS }
+ )
+ const { data: versionData } = useReplicationPipelineVersionQuery({
+ projectRef,
+ pipelineId: pipeline?.id,
+ })
+ const { data: destination, isPending: isDestinationLoading } = useReplicationDestinationByIdQuery(
+ {
+ projectRef,
+ destinationId: pipeline?.destination_id,
+ }
+ )
+
+ const { mutateAsync: startPipeline, isPending: isStartingPipeline } = useStartPipelineMutation({
+ onError: () => {},
+ })
+ const { mutateAsync: stopPipeline, isPending: isStoppingPipeline } = useStopPipelineMutation({
+ onError: () => {},
+ })
+ const { mutateAsync: restartPipeline, isPending: isRestartingPipeline } =
+ useRestartPipelineMutation()
+ const { mutateAsync: deleteDestinationPipeline } = useDeleteDestinationPipelineMutation({
+ onError: () => {},
+ })
+
+ const statusName = getStatusName(pipelineStatusData?.status)
+ const displayState = getPipelineDisplayState(requestStatus, statusName)
+ const destinationType = getReplicationDestinationType(
+ destination?.config as Record<string, unknown> | undefined
+ )
+ const isPipelineIdentityLoading =
+ isPipelineLoading || (pipeline !== undefined && isDestinationLoading)
+ const hasUpdate = Boolean(versionData?.new_version)
+ const isTransitioning = requestStatus !== PipelineStatusRequestStatus.None
+ const isActionable = PIPELINE_ACTIONABLE_STATES.includes(statusName as PipelineStatusName)
+
+ // What the primary button offers for each state it can act on. Anything not listed here (a
+ // pipeline mid-transition, or one in an unknown state) has no action, so the button falls back
+ // to the display state's own label and renders no icon.
+ const lifecycle = LIFECYCLE_BY_STATUS[statusName as PipelineStatusName]
+ const primaryAction: LifecycleAction | undefined = lifecycle?.action
+ const lifecycleLabel = isTransitioning
+ ? displayState.label
+ : (lifecycle?.label ?? displayState.label)
+ // No icon while Starting/Stopping/Restarting: those states have no entry above, and the
+ // button's loading state carries the transition anyway.
+ const lifecycleIcon = lifecycle?.icon
+
+ // The overflow menu carries the lifecycle actions the primary button isn't already offering,
+ // so the detail page has the same reach as the row menu on the list without repeating itself.
+ const isRunningOrFailed =
+ statusName === PipelineStatusName.STARTED || statusName === PipelineStatusName.FAILED
+ const canUseMenuActions =
+ isRunningOrFailed && !isTransitioning && !isPipelineStatusError && !!pipeline
+ const canRestart = canUseMenuActions && !isTableResetting && primaryAction !== 'restart'
+ const canStop = canUseMenuActions && !isTableResetting && primaryAction !== 'stop'
+
+ const onLifecycleAction = async (action?: LifecycleAction) => {
+ const resolvedAction = action ?? primaryAction
+ if (!projectRef || !pipeline || resolvedAction === undefined) return
+
+ try {
+ if (resolvedAction === 'start') {
+ setRequestStatus(pipeline.id, PipelineStatusRequestStatus.StartRequested, statusName)
+ await startPipeline({ projectRef, pipelineId: pipeline.id })
+ } else if (resolvedAction === 'stop') {
+ setRequestStatus(pipeline.id, PipelineStatusRequestStatus.StopRequested, statusName)
+ await stopPipeline({ projectRef, pipelineId: pipeline.id })
+ } else {
+ setRequestStatus(pipeline.id, PipelineStatusRequestStatus.RestartRequested, statusName)
+ await restartPipeline({ projectRef, pipelineId: pipeline.id })
+ }
+ } catch (error) {
+ setRequestStatus(pipeline.id, PipelineStatusRequestStatus.None)
+ toast.error(`Failed to ${resolvedAction} pipeline: ${(error as ResponseError).message}`)
+ }
+ }
+
+ const onDeleteDestination = async () => {
+ if (!projectRef || !pipeline) return
+
+ try {
+ setIsDeleting(true)
+ if (statusName !== PipelineStatusName.STOPPED) {
+ await stopPipeline({ projectRef, pipelineId: pipeline.id })
+ }
+ await deleteDestinationPipeline({
+ projectRef,
+ destinationId: pipeline.destination_id,
+ pipelineId: pipeline.id,
+ })
+ setShowDeleteDestination(false)
+ toast.success(`Deleted pipeline "${pipeline.destination_name}"`)
+ router.push(`/project/${projectRef}/database/replication`)
+ } catch (error) {
+ toast.error(`Failed to delete pipeline: ${(error as ResponseError).message}`)
+ } finally {
+ setIsDeleting(false)
+ }
+ }
+
+ useEffect(() => {
+ updatePipelineStatus(pipelineId, statusName)
+ }, [pipelineId, statusName, updatePipelineStatus])
+
+ const logsUrl = `/project/${projectRef}/logs/replication-logs?f=${encodeURIComponent(
+ JSON.stringify({ pipeline_id: pipelineId })
+ )}`
+
+ return (
+ <div className="flex min-h-full w-full flex-col items-stretch">
+ <div className="bg-surface-75">
+ <PageBreadcrumbs
+ slotClassName="sticky top-0 z-20 bg-sidebar"
+ actions={
+ <PageBreadcrumbsActions>
+ <DocsButton href={`${DOCS_URL}/guides/database/replication`} />
+ <Button asChild variant="default">
+ <Link href={logsUrl}>View logs</Link>
+ </Button>
+ </PageBreadcrumbsActions>
+ }
+ >
+ <BreadcrumbList>
+ <BreadcrumbItem>
+ <BreadcrumbLink asChild>
+ <Link href={`/project/${projectRef}/database/replication`}>Replication</Link>
+ </BreadcrumbLink>
+ </BreadcrumbItem>
+ <BreadcrumbSeparator />
+ <BreadcrumbItem>
+ <BreadcrumbPage>
+ {isPipelineLoading ? (
+ <span className="inline-flex items-center">
+ <span className="sr-only">Loading pipeline</span>
+ <ShimmeringLoader className="h-3 w-24 py-0" />
+ </span>
+ ) : (
+ (pipeline?.destination_name ?? 'Pipeline')
+ )}
+ </BreadcrumbPage>
+ </BreadcrumbItem>
+ </BreadcrumbList>
+ </PageBreadcrumbs>
+
+ <PageHeader size="large" className="border-b py-4">
+ <PageHeaderMeta>
+ <PageHeaderIcon>
+ {isPipelineIdentityLoading ? (
+ <ShimmeringLoader className="h-14 w-14 rounded-lg py-0" />
+ ) : destinationType !== undefined ? (
+ <DestinationLogo type={destinationType} size="large" />
+ ) : (
+ <span className="block h-14 w-14 rounded-lg border bg-surface-100" />
+ )}
+ </PageHeaderIcon>
+ <PageHeaderSummary>
+ <PageHeaderTitle>
+ {isPipelineLoading ? (
+ <span className="inline-flex items-center">
+ <span className="sr-only">Loading pipeline</span>
+ <ShimmeringLoader className="h-6 w-40 py-0" />
+ </span>
+ ) : (
+ (pipeline?.destination_name ?? 'Pipeline')
+ )}
+ </PageHeaderTitle>
+ <PageHeaderDescription className="flex flex-row flex-wrap items-center gap-x-1.5 gap-y-1 text-sm!">
+ <PipelineStatePill
+ pipelineStatus={pipelineStatusData?.status}
+ error={pipelineStatusError}
+ isLoading={isPipelineLoading || isPipelineStatusLoading}
+ isError={isPipelineStatusError}
+ isSuccess={isPipelineStatusSuccess}
+ requestStatus={requestStatus}
+ projectRef={projectRef}
+ pipelineId={pipelineId}
+ />
+ <span aria-hidden className="text-foreground-lighter">
+ &middot;
+ </span>
+ <span className="flex items-center gap-x-1.5 text-foreground-light">
+ <span>Primary database</span>
+ <ArrowRight size={14} strokeWidth={1.5} className="text-foreground-lighter" />
+ {isPipelineIdentityLoading ? (
+ <span className="inline-flex items-center">
+ <span className="sr-only">Loading destination</span>
+ <ShimmeringLoader className="h-3 w-20 py-0" />
+ </span>
+ ) : (
+ <span>{destinationType ?? pipeline?.destination_name ?? 'Unknown'}</span>
+ )}
+ </span>
+ </PageHeaderDescription>
+ </PageHeaderSummary>
+
+ <PageHeaderAside>
+ <div className="flex flex-wrap items-center justify-end gap-2">
+ {hasUpdate && (
+ <Button
+ variant="primary"
+ icon={<ArrowUpCircle />}
+ onClick={() => setShowUpdateVersionModal(true)}
+ disabled={isTableResetting}
+ >
+ Update available
+ </Button>
+ )}
+ <Button
+ variant={
+ !hasUpdate && statusName === PipelineStatusName.STOPPED ? 'primary' : 'default'
+ }
+ icon={lifecycleIcon}
+ onClick={() => onLifecycleAction()}
+ loading={
+ displayState.type === 'loading' ||
+ isTransitioning ||
+ isStartingPipeline ||
+ isStoppingPipeline ||
+ isRestartingPipeline
+ }
+ disabled={
+ Boolean(pipelineError) ||
+ isPipelineStatusError ||
+ !pipeline ||
+ isTransitioning ||
+ isTableResetting ||
+ !isActionable
+ }
+ >
+ {lifecycleLabel}
+ </Button>
+ <DropdownMenu>
+ <DropdownMenuTrigger asChild>
+ <Button
+ variant="default"
+ className="px-1.25 hit-area-2"
+ aria-label="Pipeline options"
+ icon={<MoreVertical />}
+ disabled={isTableResetting}
+ />
+ </DropdownMenuTrigger>
+ <DropdownMenuContent side="bottom" align="end" className="w-52">
+ {canRestart && (
+ <DropdownMenuItem
+ className="gap-x-2"
+ onClick={() => onLifecycleAction('restart')}
+ >
+ <RotateCcw size={14} />
+ <span>Restart pipeline</span>
+ </DropdownMenuItem>
+ )}
+ {canStop && (
+ <DropdownMenuItem
+ className="gap-x-2"
+ onClick={() => onLifecycleAction('stop')}
+ >
+ <CircleStop size={14} />
+ <span>Stop pipeline</span>
+ </DropdownMenuItem>
+ )}
+ {(canRestart || canStop) && <DropdownMenuSeparator />}
+ <DropdownMenuItem
+ className="gap-x-2"
+ disabled={pipeline === undefined}
+ onClick={() => {
+ if (pipeline !== undefined) setEdit(pipeline.destination_id)
+ }}
+ >
+ <Edit size={14} />
+ <span>Edit pipeline</span>
+ </DropdownMenuItem>
+ <DropdownMenuItem
+ className="gap-x-2"
+ disabled={pipeline === undefined}
+ onClick={() => setShowDeleteDestination(true)}
+ >
+ <Trash size={14} />
+ <span>Delete pipeline</span>
+ </DropdownMenuItem>
+ </DropdownMenuContent>
+ </DropdownMenu>
+ </div>
+ </PageHeaderAside>
+ </PageHeaderMeta>
+ </PageHeader>
+ </div>
+
+ {children}
+
+ <DestinationPanel />
+
+ <DeleteDestination
+ visible={showDeleteDestination}
+ setVisible={setShowDeleteDestination}
+ onDelete={onDeleteDestination}
+ isLoading={isDeleting}
+ name={pipeline?.destination_name ?? ''}
+ />
+
+ <UpdateVersionModal
+ visible={showUpdateVersionModal}
+ pipeline={pipeline}
+ onClose={() => setShowUpdateVersionModal(false)}
+ confirmLabel={
+ statusName === PipelineStatusName.STARTED || statusName === PipelineStatusName.FAILED
+ ? 'Update and restart'
+ : 'Update version'
+ }
+ />
+ </div>
+ )
+}
diff --git a/apps/studio/components/interfaces/Database/Replication/ReplicationPipelineStatus/ReplicationPipelineStatus.tsx b/apps/studio/components/interfaces/Database/Replication/ReplicationPipelineStatus/ReplicationPipelineStatus.tsx
index 623e4abb98f..6efa5ed4cb1 100644
--- a/apps/studio/components/interfaces/Database/Replication/ReplicationPipelineStatus/ReplicationPipelineStatus.tsx
+++ b/apps/studio/components/interfaces/Database/Replication/ReplicationPipelineStatus/ReplicationPipelineStatus.tsx
@@ -1,22 +1,7 @@
import { useParams } from 'common'
-import {
- Activity,
- ArrowUpCircle,
- Ban,
- ChevronDown,
- ChevronLeft,
- Info,
- Pause,
- Play,
- RotateCcw,
- Search,
- WifiOff,
- X,
-} from 'lucide-react'
-import Link from 'next/link'
+import { Activity, ChevronDown, Info, RotateCcw, Search, WifiOff, X } from 'lucide-react'
import { parseAsString, useQueryState } from 'nuqs'
-import { useEffect, useMemo, useState } from 'react'
-import { toast } from 'sonner'
+import { useMemo, useState } from 'react'
import {
Button,
Card,
@@ -31,19 +16,14 @@ import {
TableRow,
} from 'ui'
import { Input } from 'ui-patterns/DataInputs/Input'
+import { PageContainer } from 'ui-patterns/PageContainer'
import { GenericSkeletonLoader } from 'ui-patterns/ShimmeringLoader'
import { BatchRestartDialog } from '../BatchRestartDialog'
import { ErrorDetailsDialog } from '../ErrorDetailsDialog'
-import {
- getPipelineDisplayState,
- getStatusName,
- PIPELINE_ACTIONABLE_STATES,
-} from '../Pipeline.utils'
-import { PipelineStatus } from '../PipelineStatus'
+import { getStatusName } from '../Pipeline.utils'
import { PipelineStatusName, STATUS_REFRESH_FREQUENCY_MS } from '../Replication.constants'
import { RestartTableDialog } from '../RestartTableDialog'
-import { UpdateVersionModal } from '../UpdateVersionModal'
import { SlotLagMetrics } from './ReplicationPipelineStatus.types'
import { getDisabledStateConfig } from './ReplicationPipelineStatus.utils'
import { SlotLagMetricsInline, SlotLagMetricsList } from './SlotLagMetrics'
@@ -54,15 +34,10 @@ import { DropdownMenuItemTooltip } from '@/components/ui/DropdownMenuItemTooltip
import { useReplicationPipelineByIdQuery } from '@/data/replication/pipeline-by-id-query'
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 { 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'
/**
* Component for displaying replication pipeline status and table replication details.
@@ -72,7 +47,6 @@ export const ReplicationPipelineStatus = () => {
const { ref: projectRef, pipelineId: _pipelineId } = useParams()
const [searchString, setSearchString] = useQueryState('search', parseAsString.withDefault(''))
- const [showUpdateVersionModal, setShowUpdateVersionModal] = useState(false)
const [showErrorDialog, setShowErrorDialog] = useState(false)
const [selectedTableError, setSelectedTableError] = useState<{
tableName: string
@@ -90,7 +64,7 @@ export const ReplicationPipelineStatus = () => {
const [restartingTableIds, setRestartingTableIds] = useState<Set<number>>(new Set())
const pipelineId = Number(_pipelineId)
- const { getRequestStatus, updatePipelineStatus, setRequestStatus } = usePipelineRequestStatus()
+ const { getRequestStatus, setTableResetting } = usePipelineRequestStatus()
const requestStatus = getRequestStatus(pipelineId)
const {
@@ -103,13 +77,7 @@ export const ReplicationPipelineStatus = () => {
pipelineId,
})
- const {
- data: pipelineStatusData,
- error: pipelineStatusError,
- isLoading: isPipelineStatusLoading,
- isError: isPipelineStatusError,
- isSuccess: isPipelineStatusSuccess,
- } = useReplicationPipelineStatusQuery(
+ const { data: pipelineStatusData } = useReplicationPipelineStatusQuery(
{ projectRef, pipelineId },
{
enabled: !!pipelineId,
@@ -129,19 +97,7 @@ export const ReplicationPipelineStatus = () => {
}
)
- const { data: versionData } = useReplicationPipelineVersionQuery({
- projectRef,
- pipelineId: pipeline?.id,
- })
- const hasUpdate = Boolean(versionData?.new_version)
-
- const { mutateAsync: startPipeline, isPending: isStartingPipeline } = useStartPipelineMutation()
- const { mutateAsync: stopPipeline, isPending: isStoppingPipeline } = useStopPipelineMutation()
- const { mutateAsync: restartPipeline } = useRestartPipelineMutation()
-
- const destinationName = pipeline?.destination_name
const statusName = getStatusName(pipelineStatusData?.status)
- const displayState = getPipelineDisplayState(requestStatus, statusName)
const config = getDisabledStateConfig({ requestStatus, statusName })
// Sort tables by schema and name for consistent ordering (memoized)
@@ -201,121 +157,9 @@ export const ReplicationPipelineStatus = () => {
? `${Math.round(STATUS_REFRESH_FREQUENCY_MS / 1000)}s`
: `${STATUS_REFRESH_FREQUENCY_MS}ms`
- const logsUrl = `/project/${projectRef}/logs/replication-logs${
- pipelineId ? `?f=${encodeURIComponent(JSON.stringify({ pipeline_id: pipelineId }))}` : ''
- }`
-
- const label = isEnablingDisabling
- ? displayState.label
- : statusName === PipelineStatusName.STOPPED
- ? 'Start'
- : statusName === PipelineStatusName.STARTED
- ? 'Stop'
- : statusName === PipelineStatusName.FAILED
- ? 'Restart'
- : displayState.label
-
- const icon =
- statusName === PipelineStatusName.STOPPED ? (
- <Play />
- ) : statusName === PipelineStatusName.STARTED ? (
- <Pause />
- ) : statusName === PipelineStatusName.FAILED ? (
- <RotateCcw />
- ) : (
- <Ban />
- )
-
- const onPrimaryAction = async () => {
- if (!projectRef) return console.error('Project ref is required')
- if (!pipeline) return toast.error('No pipeline found')
-
- const action =
- statusName === PipelineStatusName.STOPPED
- ? 'start'
- : statusName === PipelineStatusName.STARTED
- ? 'stop'
- : 'restart'
- try {
- if (statusName === PipelineStatusName.STOPPED) {
- setRequestStatus(pipeline.id, PipelineStatusRequestStatus.StartRequested, statusName)
- await startPipeline({ projectRef, pipelineId: pipeline.id })
- } else if (statusName === PipelineStatusName.STARTED) {
- setRequestStatus(pipeline.id, PipelineStatusRequestStatus.StopRequested, statusName)
- await stopPipeline({ projectRef, pipelineId: pipeline.id })
- } else if (statusName === PipelineStatusName.FAILED) {
- setRequestStatus(pipeline.id, PipelineStatusRequestStatus.RestartRequested, statusName)
- await restartPipeline({ projectRef, pipelineId: pipeline.id })
- }
- } catch (error) {
- setRequestStatus(pipeline.id, PipelineStatusRequestStatus.None)
- toast.error(`Failed to ${action} pipeline: ${(error as ResponseError).message}`)
- }
- }
-
- useEffect(() => {
- updatePipelineStatus(pipelineId, statusName)
- }, [pipelineId, statusName, updatePipelineStatus])
-
return (
<>
- <div className="flex flex-col gap-y-4">
- <div className="flex items-center justify-between">
- <div className="flex items-center gap-x-3">
- <Button asChild variant="outline" icon={<ChevronLeft />} style={{ padding: '5px' }}>
- <Link href={`/project/${projectRef}/database/replication`} />
- </Button>
- <div className="flex items-center gap-x-3">
- <h3 className="text-xl font-semibold">{destinationName || 'Pipeline'}</h3>
- <PipelineStatus
- pipelineStatus={pipelineStatusData?.status}
- error={pipelineStatusError}
- isLoading={isPipelineStatusLoading}
- isError={isPipelineStatusError}
- isSuccess={isPipelineStatusSuccess}
- requestStatus={requestStatus}
- pipelineId={pipelineId}
- />
- </div>
- </div>
-
- <div className="flex items-center gap-x-2">
- {hasUpdate && (
- <Button
- variant="primary"
- icon={<ArrowUpCircle />}
- onClick={() => setShowUpdateVersionModal(true)}
- >
- Update available
- </Button>
- )}
-
- <Button asChild>
- <Link href={logsUrl}>View logs</Link>
- </Button>
-
- <Button
- variant={statusName === PipelineStatusName.STOPPED ? 'primary' : 'default'}
- onClick={onPrimaryAction}
- loading={
- isPipelineError ||
- displayState.type === 'loading' ||
- isEnablingDisabling ||
- isStartingPipeline ||
- isStoppingPipeline ||
- isAnyRestartInProgress
- }
- disabled={
- isPipelineBusy ||
- !PIPELINE_ACTIONABLE_STATES.includes(statusName as PipelineStatusName)
- }
- icon={icon}
- className="capitalize"
- >
- {label}
- </Button>
- </div>
- </div>
+ <PageContainer size="large" className="flex flex-col gap-y-4 py-6">
{isPipelineError && (
<AlertError error={pipelineError} subject="Failed to retrieve pipeline information" />
)}
@@ -560,18 +404,7 @@ export const ReplicationPipelineStatus = () => {
</div>
</div>
)}
- </div>
-
- <UpdateVersionModal
- visible={showUpdateVersionModal}
- pipeline={pipeline}
- onClose={() => setShowUpdateVersionModal(false)}
- confirmLabel={
- statusName === PipelineStatusName.STARTED || statusName === PipelineStatusName.FAILED
- ? 'Update and restart'
- : 'Update version'
- }
- />
+ </PageContainer>
{/* Restart Table Confirmation Dialog */}
{selectedTableForRestart && (
@@ -584,9 +417,11 @@ export const ReplicationPipelineStatus = () => {
publicationName={pipeline?.config.publication_name}
pipelineStatusName={statusName}
onRestartStart={() => {
+ setTableResetting(pipelineId, true)
setRestartingTableIds((prev) => new Set(prev).add(selectedTableForRestart.id))
}}
onRestartComplete={() => {
+ setTableResetting(pipelineId, false)
setRestartingTableIds((prev) => {
const next = new Set(prev)
next.delete(selectedTableForRestart.id)
@@ -619,9 +454,11 @@ export const ReplicationPipelineStatus = () => {
tableSyncCopy={pipeline?.config.table_sync_copy}
pipelineStatusName={statusName}
onRestartStart={(tableIds) => {
+ setTableResetting(pipelineId, true)
setRestartingTableIds((prev) => new Set([...prev, ...tableIds]))
}}
onRestartComplete={(tableIds) => {
+ setTableResetting(pipelineId, false)
setRestartingTableIds((prev) => {
const next = new Set(prev)
tableIds.forEach((id) => next.delete(id))
diff --git a/apps/studio/pages/project/[ref]/database/replication/[pipelineId].tsx b/apps/studio/pages/project/[ref]/database/replication/[pipelineId].tsx
index e1caff23d17..6da8e106e10 100644
--- a/apps/studio/pages/project/[ref]/database/replication/[pipelineId].tsx
+++ b/apps/studio/pages/project/[ref]/database/replication/[pipelineId].tsx
@@ -2,12 +2,11 @@ import { FeatureFlagContext, useParams } from 'common'
import { useRouter } from 'next/router'
import { useContext, useEffect } from 'react'
+import { ReplicationPipelineLayout } from '@/components/interfaces/Database/Replication/ReplicationPipelineLayout'
import { ReplicationPipelineStatus } from '@/components/interfaces/Database/Replication/ReplicationPipelineStatus/ReplicationPipelineStatus'
import { useIsETLPrivateAlpha } from '@/components/interfaces/Database/Replication/useIsETLPrivateAlpha'
import DatabaseLayout from '@/components/layouts/DatabaseLayout/DatabaseLayout'
import { DefaultLayout } from '@/components/layouts/DefaultLayout'
-import { ScaffoldContainer, ScaffoldSection } from '@/components/layouts/Scaffold'
-import { FormHeader } from '@/components/ui/Forms/FormHeader'
import { PipelineRequestStatusProvider } from '@/state/replication-pipeline-request-status'
import type { NextPageWithLayout } from '@/types'
@@ -27,14 +26,9 @@ const DatabaseReplicationPage: NextPageWithLayout = () => {
<>
{enablePgReplicate && (
<PipelineRequestStatusProvider>
- <ScaffoldContainer>
- <ScaffoldSection>
- <div className="col-span-12">
- <FormHeader title="Replication" />
- <ReplicationPipelineStatus />
- </div>
- </ScaffoldSection>
- </ScaffoldContainer>
+ <ReplicationPipelineLayout>
+ <ReplicationPipelineStatus />
+ </ReplicationPipelineLayout>
</PipelineRequestStatusProvider>
)}
</>
diff --git a/apps/studio/state/replication-pipeline-request-status.tsx b/apps/studio/state/replication-pipeline-request-status.tsx
index b14c7864ebd..2284fece4d8 100644
--- a/apps/studio/state/replication-pipeline-request-status.tsx
+++ b/apps/studio/state/replication-pipeline-request-status.tsx
@@ -24,6 +24,8 @@ interface PipelineRequestStatusContextType {
snapshotStatus?: string
) => void
getRequestStatus: (pipelineId: number) => PipelineStatusRequestStatus
+ setTableResetting: (pipelineId: number, isResetting: boolean) => void
+ getIsTableResetting: (pipelineId: number) => boolean
updatePipelineStatus: (pipelineId: number, backendStatus: string | undefined) => void
}
@@ -45,6 +47,7 @@ export const PipelineRequestStatusProvider = ({ children }: PipelineRequestStatu
const [pipelineStatusSnapshot, setPipelineStatusSnapshot] = useState<
Record<number, string | undefined>
>({})
+ const [tableResetStatus, setTableResetStatus] = useState<Record<number, boolean>>({})
const timeoutsRef = useRef<Record<number, number>>({})
const REQUEST_TIMEOUT_MS = 10_000
@@ -100,6 +103,16 @@ export const PipelineRequestStatusProvider = ({ children }: PipelineRequestStatu
return requestStatus[pipelineId] || PipelineStatusRequestStatus.None
}
+ const setTableResetting = (pipelineId: number, isResetting: boolean) => {
+ setTableResetStatus((prev) => {
+ if (isResetting) return { ...prev, [pipelineId]: true }
+ const { [pipelineId]: _omit, ...rest } = prev
+ return rest
+ })
+ }
+
+ const getIsTableResetting = (pipelineId: number) => tableResetStatus[pipelineId] === true
+
const updatePipelineStatus = useCallback(
(pipelineId: number, newStatus: string | undefined) => {
const currentRequestStatus = requestStatus[pipelineId] || PipelineStatusRequestStatus.None
@@ -129,6 +142,8 @@ export const PipelineRequestStatusProvider = ({ children }: PipelineRequestStatu
pipelineStatusSnapshot,
setRequestStatus,
getRequestStatus,
+ setTableResetting,
+ getIsTableResetting,
updatePipelineStatus,
}}
>