mirror of
https://github.com/supabase/supabase.git
synced 2026-09-11 04:21:47 +08:00
29e47821f5
## I have read the [CONTRIBUTING.md](https://github.com/supabase/supabase/blob/master/CONTRIBUTING.md) file. YES ## What kind of change does this PR introduce? Feature — adds a new Realtime setting to configure the Postgres Changes connection pool size. ## What is the current behavior? The Realtime settings page only exposes the connection pool used for Realtime Authorization (`connection_pool`). The pool that Realtime uses for Postgres Changes is not surfaced anywhere in the dashboard, so projects that need to tune it have no self-serve way to do so — the only option is to contact support. ## What is the new behavior? The Realtime settings page now includes a **Postgres Changes connection pool size** field: - Reads `postgres_changes_pool` from the project's Realtime config, falling back to a default of `2` when no override is stored. - Validates input from `1` through `20` (`MAX_POSTGRES_CHANGES_POOL`), and submits the value as a number in the config `PATCH` payload. - Docs (`apps/docs/content/guides/realtime/settings.mdx`) are expanded with sizing guidance for both connection pools, plus limits, resource-usage notes, and the operational error codes to look for. <img width="1160" height="166" alt="Screenshot 2026-08-19 at 13 59 04" src="https://github.com/user-attachments/assets/fd3ee29e-e9bf-438b-970f-8008ec57020f" /> ## Additional context The named `RealtimeConfigResponse` / `UpdateRealtimeConfigBody` schemas in the generated `api-types` package do not carry `postgres_changes_pool` yet, so both the query and mutation types extend the generated schema locally — the same pattern already used elsewhere in `apps/studio/data/`. Once the platform OpenAPI spec ships the field and `api-types` is regenerated, those two local intersections can be dropped. Covered by component tests in `RealtimeSettings.test.tsx` for both the fetch and save paths. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Added a Realtime setting to configure the Postgres Changes connection pool size. * Connection pools support 1–20 connections, with a default of 2. * Saving the setting now applies the configured value correctly. * **Documentation** * Expanded Realtime Settings guidance with configuration limits, resource usage, channel access, payload and presence limits, plan ceilings, spend-cap restrictions, and operational error codes. * Added guidance for sizing authorization and Postgres Changes connection pools. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Ivan Vasilov <vasilov.ivan@gmail.com>
66 lines
2.1 KiB
TypeScript
66 lines
2.1 KiB
TypeScript
import { useQuery } from '@tanstack/react-query'
|
|
import type { components } from 'api-types'
|
|
|
|
import { realtimeKeys } from './keys'
|
|
import { get, handleError } from '@/data/fetchers'
|
|
import { IS_PLATFORM } from '@/lib/constants'
|
|
import type { ResponseError, UseCustomQueryOptions } from '@/types'
|
|
|
|
type RealtimeConfigResponse = components['schemas']['RealtimeConfigResponse']
|
|
|
|
export type RealtimeConfigurationVariables = {
|
|
projectRef?: string
|
|
}
|
|
|
|
export const REALTIME_DEFAULT_CONFIG = {
|
|
private_only: false,
|
|
connection_pool: 2,
|
|
postgres_changes_pool: 2,
|
|
max_concurrent_users: 200,
|
|
max_events_per_second: 100,
|
|
max_bytes_per_second: 100000,
|
|
max_channels_per_client: 100,
|
|
max_joins_per_second: 100,
|
|
max_presence_events_per_second: 100,
|
|
max_payload_size_in_kb: 100,
|
|
suspend: false,
|
|
presence_enabled: true,
|
|
} as const satisfies RealtimeConfigResponse
|
|
|
|
export async function getRealtimeConfiguration(
|
|
{ projectRef }: RealtimeConfigurationVariables,
|
|
signal?: AbortSignal
|
|
) {
|
|
if (!projectRef) throw new Error('Project ref is required')
|
|
|
|
const { data, error } = await get(`/platform/projects/{ref}/config/realtime`, {
|
|
params: { path: { ref: projectRef } },
|
|
signal,
|
|
})
|
|
if (error) {
|
|
if ((error as ResponseError).message === 'Custom realtime config for a project not found') {
|
|
return REALTIME_DEFAULT_CONFIG
|
|
} else {
|
|
handleError(error)
|
|
}
|
|
}
|
|
return data
|
|
}
|
|
|
|
export type RealtimeConfigurationData = Awaited<ReturnType<typeof getRealtimeConfiguration>>
|
|
export type RealtimeConfigurationError = ResponseError
|
|
|
|
export const useRealtimeConfigurationQuery = <TData = RealtimeConfigurationData>(
|
|
{ projectRef }: RealtimeConfigurationVariables,
|
|
{
|
|
enabled = true,
|
|
...options
|
|
}: UseCustomQueryOptions<RealtimeConfigurationData, RealtimeConfigurationError, TData> = {}
|
|
) =>
|
|
useQuery<RealtimeConfigurationData, RealtimeConfigurationError, TData>({
|
|
queryKey: realtimeKeys.configuration(projectRef),
|
|
queryFn: ({ signal }) => getRealtimeConfiguration({ projectRef }, signal),
|
|
enabled: enabled && IS_PLATFORM && typeof projectRef !== 'undefined',
|
|
...options,
|
|
})
|