Files
supabase/apps/studio/data/config/project-settings-v2-query.ts
T
Ivan VasilovandJoshen Lim f29003e0e7 fix: Use protocol property when building API url (#30332)
* Fix the types for API settings to include protocol.

* Use the protocol property in all usages of endpoints.

* Update

* Lint

* Revert changes to retrieving protocol

* Remove console.logs

---------

Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
2024-11-06 22:22:24 +01:00

68 lines
2.5 KiB
TypeScript

import { PermissionAction } from '@supabase/shared-types/out/constants'
import { useQuery, UseQueryOptions } from '@tanstack/react-query'
import type { components } from 'data/api'
import { get, handleError } from 'data/fetchers'
import { useCheckPermissions } from 'hooks/misc/useCheckPermissions'
import type { ResponseError } from 'types'
import { configKeys } from './keys'
export type ProjectSettingsVariables = { projectRef?: string }
// Manually add the protocol property to the response - specifically just for the local/CLI environment
type ProjectAppConfig = components['schemas']['ProjectAppConfigResponse'] & { protocol?: string }
export type ProjectSettings = components['schemas']['ProjectSettingsResponse'] & {
app_config?: ProjectAppConfig
}
export async function getProjectSettings(
{ projectRef }: ProjectSettingsVariables,
signal?: AbortSignal
) {
if (!projectRef) throw new Error('projectRef is required')
const { data, error } = await get('/platform/projects/{ref}/settings', {
params: { path: { ref: projectRef } },
signal,
})
if (error) handleError(error)
return data as unknown as ProjectSettings
}
type ProjectSettingsData = Awaited<ReturnType<typeof getProjectSettings>>
type ProjectSettingsError = ResponseError
export const useProjectSettingsV2Query = <TData = ProjectSettingsData>(
{ projectRef }: ProjectSettingsVariables,
{
enabled = true,
...options
}: UseQueryOptions<ProjectSettingsData, ProjectSettingsError, TData> = {}
) => {
// [Joshen] Sync with API perms checking here - shouldReturnApiKeys
// https://github.com/supabase/infrastructure/blob/develop/api/src/routes/platform/projects/ref/settings.controller.ts#L92
const canReadAPIKeys = useCheckPermissions(PermissionAction.TENANT_SQL_ADMIN_WRITE, '*')
return useQuery<ProjectSettingsData, ProjectSettingsError, TData>(
configKeys.settingsV2(projectRef),
({ signal }) => getProjectSettings({ projectRef }, signal),
{
enabled: enabled && typeof projectRef !== 'undefined',
refetchInterval(data) {
const apiKeys = (data as ProjectSettings)?.service_api_keys ?? []
const interval = canReadAPIKeys && apiKeys.length === 0 ? 2000 : 0
return interval
},
...options,
}
)
}
export const getAPIKeys = (settings?: ProjectSettings) => {
const anonKey = (settings?.service_api_keys ?? []).find((x) => x.tags === 'anon')
const serviceKey = (settings?.service_api_keys ?? []).find((x) => x.tags === 'service_role')
return { anonKey, serviceKey }
}