Files
supabase/apps/studio/data/workflow-runs/workflow-run-query.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

54 lines
1.6 KiB
TypeScript

import { useQuery } from '@tanstack/react-query'
import { get, handleError } from 'data/fetchers'
import type { ResponseError, UseCustomQueryOptions } from 'types'
import { workflowRunKeys } from './keys'
export type WorkflowRunVariables = {
projectRef?: string
workflowRunId?: string
}
export async function getWorkflowRun(
{ workflowRunId }: WorkflowRunVariables,
signal?: AbortSignal
): Promise<{ logs: string; workflowRunId: string }> {
if (!workflowRunId) throw new Error('workflowRunId is required')
// Use the logs endpoint which fetches workflow run status
const { data, error } = await get('/platform/workflow-runs/{workflow_run_id}/logs', {
params: {
path: {
workflow_run_id: workflowRunId,
},
},
parseAs: 'text',
signal,
})
if (error) {
handleError(error)
}
// Return an object with the logs and we'll extract status from headers if needed
return { logs: data as string, workflowRunId }
}
export type WorkflowRunData = { logs: string; workflowRunId: string }
export type WorkflowRunError = ResponseError
export const useWorkflowRunQuery = <TData = WorkflowRunData>(
{ projectRef, workflowRunId }: WorkflowRunVariables,
{
enabled = true,
...options
}: UseCustomQueryOptions<WorkflowRunData, WorkflowRunError, TData> = {}
) =>
useQuery<WorkflowRunData, WorkflowRunError, TData>({
queryKey: workflowRunKeys.detail(projectRef, workflowRunId),
queryFn: ({ signal }) => getWorkflowRun({ workflowRunId }, signal),
enabled: enabled && typeof workflowRunId !== 'undefined',
staleTime: 0,
...options,
})