Files
supabase/apps/studio/data/database-policies/database-policies-query.ts
Andrew Valleteau 31aad403de fix(studio): early fail query when x-connection-encrypted is invalid (#35331)
* fix(studio): early fail query when x-connection-encrypted is invalid

* fix(studio): uniformize readDatabase and projectDetails connString handling

* chore: update api types

* chore: add connectionString null option

* fix: only enforce x-connection-encrypted on platform

* chore: refactor connString check in a single point

* chore: fix guard logic

* chore: fix pgMetaGuard

* chore: fix types
2025-05-08 12:11:03 +02:00

64 lines
1.9 KiB
TypeScript

import { UseQueryOptions, useQuery } from '@tanstack/react-query'
import { get, handleError } from 'data/fetchers'
import { useSelectedProject } from 'hooks/misc/useSelectedProject'
import { PROJECT_STATUS } from 'lib/constants'
import type { ResponseError } from 'types'
import { databasePoliciesKeys } from './keys'
export type DatabasePoliciesVariables = {
projectRef?: string
connectionString?: string | null
schema?: string
}
export async function getDatabasePolicies(
{ projectRef, connectionString, schema }: DatabasePoliciesVariables,
signal?: AbortSignal,
headersInit?: HeadersInit
) {
if (!projectRef) throw new Error('projectRef is required')
let headers = new Headers(headersInit)
if (connectionString) headers.set('x-connection-encrypted', connectionString)
const { data, error } = await get('/platform/pg-meta/{ref}/policies', {
params: {
header: { 'x-connection-encrypted': connectionString! },
path: { ref: projectRef },
query: {
included_schemas: schema || '',
excluded_schemas: '',
},
},
headers,
signal,
})
if (error) handleError(error)
return data
}
export type DatabasePoliciesData = Awaited<ReturnType<typeof getDatabasePolicies>>
export type DatabasePoliciesError = ResponseError
export const useDatabasePoliciesQuery = <TData = DatabasePoliciesData>(
{ projectRef, connectionString, schema }: DatabasePoliciesVariables,
{
enabled = true,
...options
}: UseQueryOptions<DatabasePoliciesData, DatabasePoliciesError, TData> = {}
) => {
const project = useSelectedProject()
const isActive = project?.status === PROJECT_STATUS.ACTIVE_HEALTHY
return useQuery<DatabasePoliciesData, DatabasePoliciesError, TData>(
databasePoliciesKeys.list(projectRef, schema),
({ signal }) => getDatabasePolicies({ projectRef, connectionString, schema }, signal),
{
enabled: enabled && typeof projectRef !== 'undefined' && isActive,
...options,
}
)
}