Files
supabase/apps/studio/data/database-queues/database-queues-create-mutation.ts
Charis 116faefcda studio: convert more executeSql callers to SafeSqlFragment (#45645)
## Summary

- Converts ~27 `executeSql` call sites in `apps/studio/data/**` to build
SQL through `safeSql` / `ident` / `literal` / `keyword` /
`joinSqlFragments` instead of raw template-string interpolation.
- Tightens the `useDatabaseCronJobCreateMutation` and
`useDatabaseEventTriggerCreateMutation` `sql`/`query` parameter types
from `string` to `SafeSqlFragment` (callers already produce one).
- Updates `getDeleteEnumeratedTypeSQL` in `packages/pg-meta` to return
`SafeSqlFragment`.
- Fixes a bug noticed while testing where Queues integration does not
correctly handle queues with uppercase names.

## Pages to manually test

- Integrations > Cron Jobs
- Integrations > Queues
- Database > Triggers > Event Triggers
- Database > Indexes
- Reports > Query Performance
- Storage

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->

## Summary by CodeRabbit

## Release Notes

* **Bug Fixes**
  * Queue lookups now correctly handle case-insensitive queue names.
* Queue table references are now properly managed and consistently
applied throughout the queue management interface.
  * Improved queue name display normalization in the user interface.

* **Chores**
* Enhanced SQL query safety across the database layer through
parameterized query construction and safer templating approaches.

<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-05-06 12:21:48 -04:00

93 lines
2.8 KiB
TypeScript

import { ident, literal, safeSql } from '@supabase/pg-meta/src/pg-format'
import { useMutation, useQueryClient } from '@tanstack/react-query'
import { toast } from 'sonner'
import { databaseQueuesKeys } from './keys'
import {
isQueueNameValid,
pgmqQueueTable,
} from '@/components/interfaces/Integrations/Queues/Queues.utils'
import { executeSql } from '@/data/sql/execute-sql-query'
import { tableKeys } from '@/data/tables/keys'
import type { ResponseError, UseCustomMutationOptions } from '@/types'
export type DatabaseQueueCreateVariables = {
projectRef: string
connectionString?: string | null
name: string
type: 'basic' | 'partitioned' | 'unlogged'
enableRls: boolean
configuration?: {
partitionInterval?: number
retentionInterval?: number
}
}
export async function createDatabaseQueue({
projectRef,
connectionString,
name,
type,
enableRls,
configuration,
}: DatabaseQueueCreateVariables) {
if (!isQueueNameValid(name)) {
throw new Error(
'Invalid queue name: must contain only alphanumeric characters, underscores, and hyphens'
)
}
const { partitionInterval, retentionInterval } = configuration ?? {}
const createFragment =
type === 'partitioned'
? safeSql`select from pgmq.create_partitioned(${literal(name)}, ${literal(partitionInterval)}, ${literal(retentionInterval)});`
: type === 'unlogged'
? safeSql`SELECT pgmq.create_unlogged(${literal(name)});`
: safeSql`SELECT pgmq.create(${literal(name)});`
const rlsFragment = enableRls
? safeSql` alter table ${ident('pgmq')}.${ident(pgmqQueueTable(name))} enable row level security;`
: safeSql``
const { result } = await executeSql({
projectRef,
connectionString,
sql: safeSql`${createFragment}${rlsFragment}`,
queryKey: databaseQueuesKeys.create(),
})
return result
}
type DatabaseQueueCreateData = Awaited<ReturnType<typeof createDatabaseQueue>>
export const useDatabaseQueueCreateMutation = ({
onSuccess,
onError,
...options
}: Omit<
UseCustomMutationOptions<DatabaseQueueCreateData, ResponseError, DatabaseQueueCreateVariables>,
'mutationFn'
> = {}) => {
const queryClient = useQueryClient()
return useMutation<DatabaseQueueCreateData, ResponseError, DatabaseQueueCreateVariables>({
mutationFn: (vars) => createDatabaseQueue(vars),
async onSuccess(data, variables, context) {
const { projectRef } = variables
await queryClient.invalidateQueries({ queryKey: databaseQueuesKeys.list(projectRef) })
queryClient.invalidateQueries({ queryKey: tableKeys.list(projectRef, 'pgmq') })
await onSuccess?.(data, variables, context)
},
async onError(data, variables, context) {
if (onError === undefined) {
toast.error(`Failed to create database queue: ${data.message}`)
} else {
onError(data, variables, context)
}
},
...options,
})
}