Files
supabase/apps/studio/data/database-extensions/database-extension-enable-mutation.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

87 lines
2.3 KiB
TypeScript

import { useMutation, UseMutationOptions, useQueryClient } from '@tanstack/react-query'
import { toast } from 'sonner'
import { handleError, post } from 'data/fetchers'
import { executeSql } from 'data/sql/execute-sql-query'
import type { ResponseError } from 'types'
import { databaseExtensionsKeys } from './keys'
export type DatabaseExtensionEnableVariables = {
projectRef: string
connectionString?: string | null
schema: string
name: string
version: string
cascade?: boolean
createSchema?: boolean
}
export async function enableDatabaseExtension({
projectRef,
connectionString,
schema,
name,
version,
cascade = false,
createSchema = false,
}: DatabaseExtensionEnableVariables) {
let headers = new Headers()
if (connectionString) headers.set('x-connection-encrypted', connectionString)
if (createSchema) {
try {
await executeSql({
projectRef,
connectionString,
sql: `create schema if not exists ${schema}`,
})
} catch (error) {
throw error
}
}
const { data, error } = await post('/platform/pg-meta/{ref}/extensions', {
params: {
header: { 'x-connection-encrypted': connectionString! },
path: { ref: projectRef },
},
body: { schema, name, version, cascade },
headers,
})
if (error) handleError(error)
return data
}
type DatabaseExtensionEnableData = Awaited<ReturnType<typeof enableDatabaseExtension>>
export const useDatabaseExtensionEnableMutation = ({
onSuccess,
onError,
...options
}: Omit<
UseMutationOptions<DatabaseExtensionEnableData, ResponseError, DatabaseExtensionEnableVariables>,
'mutationFn'
> = {}) => {
const queryClient = useQueryClient()
return useMutation<DatabaseExtensionEnableData, ResponseError, DatabaseExtensionEnableVariables>(
(vars) => enableDatabaseExtension(vars),
{
async onSuccess(data, variables, context) {
const { projectRef } = variables
await queryClient.invalidateQueries(databaseExtensionsKeys.list(projectRef))
await onSuccess?.(data, variables, context)
},
async onError(data, variables, context) {
if (onError === undefined) {
toast.error(`Failed to enable database extension: ${data.message}`)
} else {
onError(data, variables, context)
}
},
...options,
}
)
}