Files
supabase/apps/studio/data/replication/update-pipeline-version-mutation.ts
Ivan Vasilov 8b657165b5 chore: Migrate to use custom type for ReactQuery queries and mutations (#40073)
* Add custom types for queries, mutations and infinite queries.

* Migrate all queries to use the new type.

* Migrate all infinite queries to useCustomInfiniteQueryOptions.

* Migrate all mutations to use useCustomMutationOptions.

* Add type to all imports in `types` folder.
2025-11-03 13:18:13 +01:00

73 lines
2.3 KiB
TypeScript

import { useMutation, useQueryClient } from '@tanstack/react-query'
import { toast } from 'sonner'
import { handleError, post } from 'data/fetchers'
import type { ResponseError, UseCustomMutationOptions } from 'types'
import { replicationKeys } from './keys'
type UpdatePipelineVersionParams = {
projectRef: string
pipelineId: number
versionId: number
}
async function updatePipelineVersion(
{ projectRef, pipelineId, versionId }: UpdatePipelineVersionParams,
signal?: AbortSignal
) {
if (!projectRef) throw new Error('projectRef is required')
if (!pipelineId) throw new Error('pipelineId is required')
if (!versionId) throw new Error('versionId is required')
const { data, error } = await post(
'/platform/replication/{ref}/pipelines/{pipeline_id}/version',
{
params: { path: { ref: projectRef, pipeline_id: pipelineId } },
body: { version_id: versionId },
signal,
}
)
if (error) handleError(error)
return data
}
type UpdatePipelineVersionData = Awaited<ReturnType<typeof updatePipelineVersion>>
export const useUpdatePipelineVersionMutation = ({
onSuccess,
onError,
...options
}: Omit<
UseCustomMutationOptions<UpdatePipelineVersionData, ResponseError, UpdatePipelineVersionParams>,
'mutationFn'
> = {}) => {
const queryClient = useQueryClient()
return useMutation<UpdatePipelineVersionData, ResponseError, UpdatePipelineVersionParams>({
mutationFn: (vars) => updatePipelineVersion(vars),
async onSuccess(data, variables, context) {
const { projectRef, pipelineId } = variables
// Ensure the version dot updates promptly
await queryClient.invalidateQueries({
queryKey: replicationKeys.pipelinesVersion(projectRef, pipelineId),
})
await onSuccess?.(data, variables, context)
},
async onError(error, variables, context) {
const { projectRef, pipelineId } = variables
if (error?.code === 404) {
// Default image changed meanwhile. Refresh version info so UI reflects latest state.
await queryClient.invalidateQueries({
queryKey: replicationKeys.pipelinesVersion(projectRef, pipelineId),
})
} else if (onError === undefined) {
toast.error(`Failed to update pipeline version: ${error.message}`)
} else {
onError(error, variables, context)
}
},
...options,
})
}