Skip to content

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

feat(pipelines): Use new restart endpoint (#48737)

Riccardo Busetti21919ec9b804
diff --git a/apps/studio/.github/eslint-rule-baselines.json b/apps/studio/.github/eslint-rule-baselines.json
index e19a3747373..20ebe971674 100644
--- a/apps/studio/.github/eslint-rule-baselines.json
+++ b/apps/studio/.github/eslint-rule-baselines.json
@@ -595,7 +595,6 @@
"data/profile/profile-identities-query.ts": 1,
"data/profile/profile-unlink-identity-mutation.ts": 2,
"data/projects/project-create-mutation.ts": 1,
- "data/replication/restart-pipeline-helper.ts": 2,
"data/replication/rollback-tables-mutation.ts": 1,
"data/reports/v2/auth.config.ts": 15,
"data/reports/v2/edge-functions.config.ts": 9,
diff --git a/apps/studio/components/interfaces/Database/Replication/ReplicationPipelineStatus/ReplicationPipelineStatus.tsx b/apps/studio/components/interfaces/Database/Replication/ReplicationPipelineStatus/ReplicationPipelineStatus.tsx
index 8da3285a784..a670c455cf2 100644
--- a/apps/studio/components/interfaces/Database/Replication/ReplicationPipelineStatus/ReplicationPipelineStatus.tsx
+++ b/apps/studio/components/interfaces/Database/Replication/ReplicationPipelineStatus/ReplicationPipelineStatus.tsx
@@ -55,7 +55,7 @@ import { useReplicationPipelineByIdQuery } from '@/data/replication/pipeline-by-
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 { useRestartPipelineHelper } from '@/data/replication/restart-pipeline-helper'
+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 {
@@ -137,7 +137,7 @@ export const ReplicationPipelineStatus = () => {
const { mutateAsync: startPipeline, isPending: isStartingPipeline } = useStartPipelineMutation()
const { mutateAsync: stopPipeline, isPending: isStoppingPipeline } = useStopPipelineMutation()
- const { restartPipeline } = useRestartPipelineHelper()
+ const { mutateAsync: restartPipeline } = useRestartPipelineMutation()
const destinationName = pipeline?.destination_name
const statusName = getStatusName(pipelineStatusData?.status)
diff --git a/apps/studio/components/interfaces/Database/Replication/RowMenu.tsx b/apps/studio/components/interfaces/Database/Replication/RowMenu.tsx
index 4db6813bef1..51a5faa3a4e 100644
--- a/apps/studio/components/interfaces/Database/Replication/RowMenu.tsx
+++ b/apps/studio/components/interfaces/Database/Replication/RowMenu.tsx
@@ -24,7 +24,7 @@ import {
import { PipelineStatusName } from './Replication.constants'
import { ReplicationPipelineStatusData } from '@/data/replication/pipeline-status-query'
import { Pipeline } from '@/data/replication/pipelines-query'
-import { useRestartPipelineHelper } from '@/data/replication/restart-pipeline-helper'
+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 {
@@ -66,7 +66,7 @@ export const RowMenu = ({
const { mutateAsync: startPipeline } = useStartPipelineMutation()
const { mutateAsync: stopPipeline } = useStopPipelineMutation()
- const { restartPipeline } = useRestartPipelineHelper()
+ const { mutateAsync: restartPipeline } = useRestartPipelineMutation()
const { getRequestStatus, setRequestStatus: setGlobalRequestStatus } = usePipelineRequestStatus()
const requestStatus = pipeline?.id
? getRequestStatus(pipeline.id)
diff --git a/apps/studio/data/replication/restart-pipeline-helper.ts b/apps/studio/data/replication/restart-pipeline-helper.ts
deleted file mode 100644
index 881f1aa8c47..00000000000
--- a/apps/studio/data/replication/restart-pipeline-helper.ts
+++ /dev/null
@@ -1,40 +0,0 @@
-import { useStartPipelineMutation } from './start-pipeline-mutation'
-import { useStopPipelineMutation } from './stop-pipeline-mutation'
-
-interface RestartPipelineParams {
- projectRef: string
- pipelineId: number
-}
-
-/**
- * Helper hook that provides a restart function which properly stops and then starts a pipeline.
- *
- * ## Why Stop + Start?
- *
- * This explicit two-step restart process is necessary to work around edge cases where Kubernetes
- * doesn't properly recreate pods when using the start endpoint alone on a running pipeline. This happens
- * because crash looping pods are not restarted if the resource is patched. We will try to find a better
- * solution for this in the future.
- */
-export const useRestartPipelineHelper = () => {
- const { mutateAsync: stopPipeline } = useStopPipelineMutation()
- const { mutateAsync: startPipeline } = useStartPipelineMutation()
-
- const restartPipeline = async ({ projectRef, pipelineId }: RestartPipelineParams) => {
- // Step 1: Stop the pipeline to ensure pods are fully terminated
- try {
- await stopPipeline({ projectRef, pipelineId })
- } catch (error: any) {
- throw new Error(`Failed to stop pipeline: ${error.message}`)
- }
-
- // Step 2: Start the pipeline to create fresh pods with clean state
- try {
- await startPipeline({ projectRef, pipelineId })
- } catch (error: any) {
- throw new Error(`Failed to start pipeline: ${error.message}`)
- }
- }
-
- return { restartPipeline }
-}
diff --git a/apps/studio/data/replication/restart-pipeline-mutation.ts b/apps/studio/data/replication/restart-pipeline-mutation.ts
new file mode 100644
index 00000000000..ec6a5d5fa74
--- /dev/null
+++ b/apps/studio/data/replication/restart-pipeline-mutation.ts
@@ -0,0 +1,75 @@
+import { useMutation, useQueryClient } from '@tanstack/react-query'
+
+import { replicationKeys } from './keys'
+import { handleError, post } from '@/data/fetchers'
+import type { ResponseError, UseCustomMutationOptions } from '@/types'
+
+export type RestartPipelineParams = {
+ projectRef: string
+ pipelineId: number
+}
+
+export async function restartPipeline(
+ { projectRef, pipelineId }: RestartPipelineParams,
+ signal?: AbortSignal
+) {
+ if (!projectRef) throw new Error('projectRef is required')
+
+ const { data, error } = await post(
+ '/platform/replication/{ref}/pipelines/{pipeline_id}/restart',
+ {
+ params: { path: { ref: projectRef, pipeline_id: pipelineId } },
+ signal,
+ }
+ )
+ if (error) {
+ handleError(error)
+ }
+
+ return data
+}
+
+type RestartPipelineData = Awaited<ReturnType<typeof restartPipeline>>
+
+export const useRestartPipelineMutation = ({
+ onSuccess,
+ onError,
+ ...options
+}: Omit<
+ UseCustomMutationOptions<RestartPipelineData, ResponseError, RestartPipelineParams>,
+ 'mutationFn'
+> = {}) => {
+ const queryClient = useQueryClient()
+
+ return useMutation<RestartPipelineData, ResponseError, RestartPipelineParams>({
+ mutationFn: (vars) => restartPipeline(vars),
+ async onSuccess(data, variables, context) {
+ const { projectRef, pipelineId } = variables
+
+ await queryClient.invalidateQueries({
+ queryKey: replicationKeys.pipelinesStatus(projectRef, pipelineId),
+ })
+
+ // [Joshen] We're manually updating the query client here as the pipeline status is async
+ // So setting it so starting while letting long poll update the actual status thereafter
+ queryClient.setQueriesData(
+ {
+ queryKey: replicationKeys.pipelinesStatus(projectRef, pipelineId),
+ exact: true,
+ },
+ (prev) => {
+ if (!prev) return prev
+ return { ...prev, status: { name: 'starting' } }
+ }
+ )
+
+ await onSuccess?.(data, variables, context)
+ },
+ // No default error toast here: callers already show one from their try/catch around
+ // mutateAsync, so a default here would double up. onError is only for opt-in callers.
+ async onError(data, variables, context) {
+ await onError?.(data, variables, context)
+ },
+ ...options,
+ })
+}
diff --git a/packages/api-types/types/platform.d.ts b/packages/api-types/types/platform.d.ts
index 836d4c4de6d..622b9dd1b78 100644
--- a/packages/api-types/types/platform.d.ts
+++ b/packages/api-types/types/platform.d.ts
@@ -3879,6 +3879,26 @@ export interface paths {
patch?: never
trace?: never
}
+ '/platform/replication/{ref}/pipelines/{pipeline_id}/restart': {
+ parameters: {
+ query?: never
+ header?: never
+ path?: never
+ cookie?: never
+ }
+ get?: never
+ put?: never
+ /**
+ * Restart pipeline
+ * @description Restart the pipeline. Requires bearer auth and an active, healthy project. Fails with a conflict if the pipeline is not currently running.
+ */
+ post: operations['ReplicationPipelinesController_restartPipeline']
+ delete?: never
+ options?: never
+ head?: never
+ patch?: never
+ trace?: never
+ }
'/platform/replication/{ref}/pipelines/{pipeline_id}/rollback-tables': {
parameters: {
query?: never
@@ -28289,6 +28309,64 @@ export interface operations {
}
}
}
+ ReplicationPipelinesController_restartPipeline: {
+ parameters: {
+ query?: never
+ header?: never
+ path: {
+ /** @description Pipeline id */
+ pipeline_id: number
+ /** @description Project ref */
+ ref: string
+ }
+ cookie?: never
+ }
+ requestBody?: never
+ responses: {
+ /** @description Pipeline restart accepted. */
+ 202: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Unauthorized */
+ 401: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Forbidden action */
+ 403: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Pipeline is not running. */
+ 409: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Rate limit exceeded */
+ 429: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ /** @description Unexpected error while restarting pipeline. */
+ 500: {
+ headers: {
+ [name: string]: unknown
+ }
+ content?: never
+ }
+ }
+ }
ReplicationPipelinesController_getPipelineStatus: {
parameters: {
query?: never