supabase/apps/studio/data/realtime/realtime-config-mutation.ts

import { useMutation, useQueryClient } from '@tanstack/react-query'
import { toast } from 'sonner'

import { realtimeKeys } from './keys'
import type { components } from '@/data/api'
import { configKeys } from '@/data/config/keys'
import { handleError, patch } from '@/data/fetchers'
import type { ResponseError, UseCustomMutationOptions } from '@/types'

export type RealtimeConfigurationUpdateBody = components['schemas']['UpdateRealtimeConfigBody'] & {
  postgres_changes_pool?: number
}

export type RealtimeConfigurationUpdateVariables = {
  ref: string
} & RealtimeConfigurationUpdateBody

export async function updateRealtimeConfiguration({
  ref,
  private_only,
  connection_pool,
  postgres_changes_pool,
  max_concurrent_users,
  max_events_per_second,
  max_bytes_per_second,
  max_channels_per_client,
  max_joins_per_second,
  max_presence_events_per_second,
  max_payload_size_in_kb,
  suspend,
}: RealtimeConfigurationUpdateVariables) {
  if (!ref) return console.error('Project ref is required')

  const { data, error } = await patch('/platform/projects/{ref}/config/realtime', {
    params: { path: { ref } },
    body: {
      private_only,
      connection_pool,
      postgres_changes_pool,
      max_concurrent_users,
      max_events_per_second,
      max_bytes_per_second,
      max_channels_per_client,
      max_joins_per_second,
      max_presence_events_per_second,
      max_payload_size_in_kb,
      suspend,
    },
  })

  if (error) handleError(error)
  return data
}

type RealtimeConfigurationUpdateData = Awaited<ReturnType<typeof updateRealtimeConfiguration>>

export const useRealtimeConfigurationUpdateMutation = ({
  onSuccess,
  onError,
  ...options
}: Omit<
  UseCustomMutationOptions<
    RealtimeConfigurationUpdateData,
    ResponseError,
    RealtimeConfigurationUpdateVariables
  >,
  'mutationFn'
> = {}) => {
  const queryClient = useQueryClient()

  return useMutation<
    RealtimeConfigurationUpdateData,
    ResponseError,
    RealtimeConfigurationUpdateVariables
  >({
    mutationFn: (vars) => updateRealtimeConfiguration(vars),
    async onSuccess(data, variables, context) {
      const { ref } = variables
      await Promise.all([
        queryClient.invalidateQueries({ queryKey: realtimeKeys.configuration(ref) }),
        queryClient.invalidateQueries({ queryKey: configKeys.projectConfig(ref) }),
      ])
      await onSuccess?.(data, variables, context)
    },
    async onError(data, variables, context) {
      if (onError === undefined) {
        toast.error(`Failed to update realtime configuration: ${data.message}`)
      } else {
        onError(data, variables, context)
      }
    },
    ...options,
  })
}