Files
supabase/apps/studio/data/projects/projects-query.ts
Joshen Lim bb6349f34f Second round of wrapping RQ errors with handleError (#26428)
* First round of wrapping RQ errors with handleError

* Remove the throw before the handleError usage.

* Make the handling of an API error more versatile. Add logging in Sentry if the error is of unknown type.

* Remove throwing of the handleError function.

* Add return type to the handleError function to be never so that we're sure it always throws.

* Second round of wrapping RQ errors with handleError

* Temp fix in delete credential mutation, and fix loading state

---------

Co-authored-by: Ivan Vasilov <vasilov.ivan@gmail.com>
2024-05-21 15:51:11 +08:00

109 lines
2.6 KiB
TypeScript

import { QueryClient, useQuery, useQueryClient, UseQueryOptions } from '@tanstack/react-query'
import { useCallback, useRef } from 'react'
import type { components } from 'data/api'
import { get, handleError } from 'data/fetchers'
import type { ResponseError } from 'types'
import { projectKeys } from './keys'
import type { Project } from './project-detail-query'
export type ProjectsVariables = {
ref?: string
}
export type ProjectInfo = components['schemas']['ProjectInfo']
export async function getProjects(signal?: AbortSignal) {
const { data, error } = await get('/platform/projects', { signal })
if (error) handleError(error)
return data
}
export type ProjectsData = Awaited<ReturnType<typeof getProjects>>
export type ProjectsError = ResponseError
export const useProjectsQuery = <TData = ProjectsData>({
enabled = true,
...options
}: UseQueryOptions<ProjectsData, ProjectsError, TData> = {}) => {
return useQuery<ProjectsData, ProjectsError, TData>(
projectKeys.list(),
({ signal }) => getProjects(signal),
{ enabled, ...options }
)
}
export function prefetchProjects(client: QueryClient) {
return client.prefetchQuery(projectKeys.list(), ({ signal }) => getProjects(signal))
}
export function useProjectsPrefetch() {
const client = useQueryClient()
return useCallback(() => {
prefetchProjects(client)
}, [client])
}
export function useAutoProjectsPrefetch() {
const prefetch = useProjectsPrefetch()
const called = useRef<boolean>(false)
if (called.current === false) {
called.current = true
prefetch()
}
}
export function invalidateProjectsQuery(client: QueryClient) {
return client.invalidateQueries(projectKeys.list())
}
export function setProjectStatus(
client: QueryClient,
projectRef: Project['ref'],
status: Project['status']
) {
client.setQueriesData<Project[] | undefined>(
projectKeys.list(),
(old) => {
if (!old) return old
return old.map((project) => {
if (project.ref === projectRef) {
return { ...project, status }
}
return project
})
},
{ updatedAt: Date.now() }
)
client.setQueriesData<Project>(
projectKeys.detail(projectRef),
(old) => {
if (!old) return old
return { ...old, status }
},
{ updatedAt: Date.now() }
)
}
export function setProjectPostgrestStatus(
client: QueryClient,
projectRef: Project['ref'],
status: Project['postgrestStatus']
) {
client.setQueriesData<Project>(
projectKeys.detail(projectRef),
(old) => {
if (!old) return old
return { ...old, postgrestStatus: status }
},
{ updatedAt: Date.now() }
)
}