Files
supabase/apps/studio/data/config/disk-attributes-query.ts
T
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

92 lines
2.5 KiB
TypeScript

import { useQuery } from '@tanstack/react-query'
import dayjs from 'dayjs'
import { useMemo } from 'react'
import type { components } from 'data/api'
import { get, handleError } from 'data/fetchers'
import type { ResponseError, UseCustomQueryOptions } from 'types'
import { COOLDOWN_DURATION } from './disk-attributes-update-mutation'
import { configKeys } from './keys'
export type DiskAttributesVariables = {
projectRef?: string
}
export type DiskAttribute = components['schemas']['DiskResponse']
export async function getDiskAttributes(
{ projectRef }: DiskAttributesVariables,
signal?: AbortSignal
) {
if (!projectRef) throw new Error('Project ref is required')
const { data, error } = await get(`/platform/projects/{ref}/disk`, {
params: { path: { ref: projectRef } },
signal,
})
if (error) handleError(error)
return data
}
export type DiskAttributesData = Awaited<ReturnType<typeof getDiskAttributes>>
export type DiskAttributesError = ResponseError
export const useDiskAttributesQuery = <TData = DiskAttributesData>(
{ projectRef }: DiskAttributesVariables,
{
enabled = true,
...options
}: UseCustomQueryOptions<DiskAttributesData, DiskAttributesError, TData> = {}
) =>
useQuery<DiskAttributesData, DiskAttributesError, TData>({
queryKey: configKeys.diskAttributes(projectRef),
queryFn: ({ signal }) => getDiskAttributes({ projectRef }, signal),
enabled: enabled && typeof projectRef !== 'undefined',
...options,
})
export const useRemainingDurationForDiskAttributeUpdate = ({
projectRef,
enabled = true,
}: {
projectRef?: string
enabled?: boolean
}) => {
const { data, isLoading, isError, isSuccess, error } = useDiskAttributesQuery(
{ projectRef },
{ enabled }
)
const lastModifiedAtString = dayjs(data?.last_modified_at ?? '').utc()
const secondsFromNow = Math.max(
0,
dayjs().utc().diff(dayjs(lastModifiedAtString).utc(), 'second')
)
const remainingDuration = useMemo(() => {
return lastModifiedAtString === undefined || COOLDOWN_DURATION - secondsFromNow < 0
? 0
: COOLDOWN_DURATION - secondsFromNow
}, [lastModifiedAtString, secondsFromNow])
if (data?.last_modified_at === undefined)
return {
remainingDuration: 0,
isWithinCooldownWindow: false,
isLoading,
isError,
error,
isSuccess,
}
return {
remainingDuration,
isWithinCooldownWindow: remainingDuration > 0,
isLoading,
isError,
error,
isSuccess,
}
}