supabase/apps/studio/data/database-queues/database-queues-create-mutation.ts

import { ident, literal } from '@supabase/pg-meta/src/pg-format'
import { useMutation, useQueryClient } from '@tanstack/react-query'
import { toast } from 'sonner'

import { databaseQueuesKeys } from './keys'
import { isQueueNameValid } 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 query =
    type === 'partitioned'
      ? `select from pgmq.create_partitioned(${literal(name)}, ${literal(partitionInterval)}, ${literal(retentionInterval)});`
      : type === 'unlogged'
        ? `SELECT pgmq.create_unlogged(${literal(name)});`
        : `SELECT pgmq.create(${literal(name)});`

  const { result } = await executeSql({
    projectRef,
    connectionString,
    sql: `${query} ${enableRls ? `alter table pgmq.${ident('q_' + name)} enable row level security;` : ''}`.trim(),
    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,
  })
}