The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.
TypeScript aialternativeauthdatabasedenoembeddingsexamplefirebasenextjsoauth2pgvectorpostgispostgrespostgresqlpostgrestrealtimesupabasevectorswebsockets
fix(studio): use realtime entitlements for max settings (#49228)
Eduardo Gurgel7bac134fa5d5
diff --git a/apps/studio/components/interfaces/Realtime/RealtimeSettings.tsx b/apps/studio/components/interfaces/Realtime/RealtimeSettings.tsxindex 52e2a3adb13..13963a9f4a1 100644--- a/apps/studio/components/interfaces/Realtime/RealtimeSettings.tsx+++ b/apps/studio/components/interfaces/Realtime/RealtimeSettings.tsx@@ -23,6 +23,7 @@ import {import { Admonition } from 'ui-patterns/Admonition'import ConfirmationModal from 'ui-patterns/Dialogs/ConfirmationModal'import { FormItemLayout } from 'ui-patterns/form/FormItemLayout/FormItemLayout'+import { GenericSkeletonLoader } from 'ui-patterns/ShimmeringLoader'import * as z from 'zod'import { AlertError } from '@/components/ui/AlertError'@@ -35,12 +36,20 @@ import {REALTIME_DEFAULT_CONFIG,useRealtimeConfigurationQuery,} from '@/data/realtime/realtime-config-query'+import { useCheckEntitlements } from '@/hooks/misc/useCheckEntitlements'import { useAsyncCheckPermissions } from '@/hooks/misc/useCheckPermissions'import { useSelectedOrganizationQuery } from '@/hooks/misc/useSelectedOrganization'import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'const formId = 'realtime-configuration-form'+const REALTIME_SOFT_LIMITS = {+ max_concurrent_users: 50_000,+ max_events_per_second: 50_000,+ max_presence_events_per_second: 5_000,+ max_payload_size_in_kb: 3_000,+}+export const RealtimeSettings = () => {const { ref: projectRef } = useParams()const { data: project } = useSelectedProjectQuery()@@ -56,7 +65,7 @@ export const RealtimeSettings = () => {projectRef: project?.ref,connectionString: project?.connectionString,})- const { data, error, isError } = useRealtimeConfigurationQuery({+ const { data, error, isError, isPending } = useRealtimeConfigurationQuery({projectRef,})@@ -66,6 +75,45 @@ export const RealtimeSettings = () => {schemas: ['realtime'],})+ // Per-plan realtime ceilings come from the org's entitlements (plan + any overrides).+ // The effective limit is the lower of the entitlement and the soft cap, so an unlimited+ // plan is still bounded and self-hosted / loading falls back to the soft cap.+ const { getEntitlementMax: getMaxConcurrentUsers, isSuccess: isSuccessMaxConcurrentUsers } =+ useCheckEntitlements('realtime.max_concurrent_users')+ const { getEntitlementMax: getMaxEventsPerSecond, isSuccess: isSuccessMaxEventsPerSecond } =+ useCheckEntitlements('realtime.max_events_per_second')+ const {+ getEntitlementMax: getMaxPresenceEventsPerSecond,+ isSuccess: isSuccessMaxPresenceEventsPerSecond,+ } = useCheckEntitlements('realtime.max_presence_events_per_second')+ const { getEntitlementMax: getMaxPayloadSizeInKb, isSuccess: isSuccessMaxPayloadSizeInKb } =+ useCheckEntitlements('realtime.max_payload_size_in_kb')++ const isRealtimeEntitlementsLoaded =+ isSuccessMaxConcurrentUsers &&+ isSuccessMaxEventsPerSecond &&+ isSuccessMaxPresenceEventsPerSecond &&+ isSuccessMaxPayloadSizeInKb++ const isLoading = isPending || !isRealtimeEntitlementsLoaded++ const maxConcurrentUsersLimit = Math.min(+ getMaxConcurrentUsers() ?? Infinity,+ REALTIME_SOFT_LIMITS.max_concurrent_users+ )+ const maxEventsPerSecondLimit = Math.min(+ getMaxEventsPerSecond() ?? Infinity,+ REALTIME_SOFT_LIMITS.max_events_per_second+ )+ const maxPresenceEventsPerSecondLimit = Math.min(+ getMaxPresenceEventsPerSecond() ?? Infinity,+ REALTIME_SOFT_LIMITS.max_presence_events_per_second+ )+ const maxPayloadSizeInKbLimit = Math.min(+ getMaxPayloadSizeInKb() ?? Infinity,+ REALTIME_SOFT_LIMITS.max_payload_size_in_kb+ )+const isFreePlan = organization?.plan.id === 'free'const isUsageBillingEnabled = organization?.usage_billing_enabledconst isRealtimeDisabled = data?.suspend ?? REALTIME_DEFAULT_CONFIG.suspend@@ -93,10 +141,38 @@ export const RealtimeSettings = () => {.min(1).max(maxConn?.maxConnections ?? 100).optional(),- max_concurrent_users: z.coerce.number().min(1).max(50000).optional(),- max_events_per_second: z.coerce.number().min(1).max(50000).optional(),- max_presence_events_per_second: z.coerce.number().min(1).max(5000).optional(),- max_payload_size_in_kb: z.coerce.number().min(1).max(10000).optional(),+ max_concurrent_users: z.coerce+ .number()+ .min(1)+ .max(+ maxConcurrentUsersLimit,+ `Cannot exceed ${maxConcurrentUsersLimit.toLocaleString()} concurrent clients`+ )+ .optional(),+ max_events_per_second: z.coerce+ .number()+ .min(1)+ .max(+ maxEventsPerSecondLimit,+ `Cannot exceed ${maxEventsPerSecondLimit.toLocaleString()} events per second`+ )+ .optional(),+ max_presence_events_per_second: z.coerce+ .number()+ .min(1)+ .max(+ maxPresenceEventsPerSecondLimit,+ `Cannot exceed ${maxPresenceEventsPerSecondLimit.toLocaleString()} presence events per second`+ )+ .optional(),+ max_payload_size_in_kb: z.coerce+ .number()+ .min(1)+ .max(+ maxPayloadSizeInKbLimit,+ `Cannot exceed ${maxPayloadSizeInKbLimit.toLocaleString()} KB`+ )+ .optional(),// [Joshen] These fields are temporarily hidden from the UI// max_bytes_per_second: z.coerce.number().min(1).max(10000000).optional(),// max_channels_per_client: z.coerce.number().min(1).max(10000).optional(),@@ -110,10 +186,34 @@ export const RealtimeSettings = () => {.number().min(1).max(maxConn?.maxConnections ?? 100),- max_concurrent_users: z.coerce.number().min(1).max(50000),- max_events_per_second: z.coerce.number().min(1).max(50000),- max_presence_events_per_second: z.coerce.number().min(1).max(5000),- max_payload_size_in_kb: z.coerce.number().min(1).max(10000),+ max_concurrent_users: z.coerce+ .number()+ .min(1)+ .max(+ maxConcurrentUsersLimit,+ `Cannot exceed ${maxConcurrentUsersLimit.toLocaleString()} concurrent clients`+ ),+ max_events_per_second: z.coerce+ .number()+ .min(1)+ .max(+ maxEventsPerSecondLimit,+ `Cannot exceed ${maxEventsPerSecondLimit.toLocaleString()} events per second`+ ),+ max_presence_events_per_second: z.coerce+ .number()+ .min(1)+ .max(+ maxPresenceEventsPerSecondLimit,+ `Cannot exceed ${maxPresenceEventsPerSecondLimit.toLocaleString()} presence events per second`+ ),+ max_payload_size_in_kb: z.coerce+ .number()+ .min(1)+ .max(+ maxPayloadSizeInKbLimit,+ `Cannot exceed ${maxPayloadSizeInKbLimit.toLocaleString()} KB`+ ),// [Joshen] These fields are temporarily hidden from the UI// max_bytes_per_second: z.coerce.number().min(1).max(10000000),// max_channels_per_client: z.coerce.number().min(1).max(10000),@@ -123,16 +223,32 @@ export const RealtimeSettings = () => {}),])+ const configValues = data ?? REALTIME_DEFAULT_CONFIG+ const sharedFormValues = {+ connection_pool: configValues.connection_pool ?? REALTIME_DEFAULT_CONFIG.connection_pool,+ max_concurrent_users:+ configValues.max_concurrent_users ?? REALTIME_DEFAULT_CONFIG.max_concurrent_users,+ max_events_per_second:+ configValues.max_events_per_second ?? REALTIME_DEFAULT_CONFIG.max_events_per_second,+ max_presence_events_per_second:+ configValues.max_presence_events_per_second ??+ REALTIME_DEFAULT_CONFIG.max_presence_events_per_second,+ max_payload_size_in_kb:+ configValues.max_payload_size_in_kb ?? REALTIME_DEFAULT_CONFIG.max_payload_size_in_kb,+ allow_public: !(configValues.private_only ?? REALTIME_DEFAULT_CONFIG.private_only),+ }+ const formValues: z.infer<typeof FormSchema> = {+ suspend: configValues.suspend ?? REALTIME_DEFAULT_CONFIG.suspend,+ ...sharedFormValues,+ }+const form = useForm<z.infer<typeof FormSchema>>({resolver: zodResolver(FormSchema),defaultValues: {...REALTIME_DEFAULT_CONFIG,allow_public: !REALTIME_DEFAULT_CONFIG.private_only,},- values: {- ...(data ?? REALTIME_DEFAULT_CONFIG),- allow_public: !(data?.private_only ?? REALTIME_DEFAULT_CONFIG.private_only),- } as any,+ values: formValues,})const [allow_public, suspend] = useWatch({@@ -145,11 +261,13 @@ export const RealtimeSettings = () => {const onSubmit: SubmitHandler<z.infer<typeof FormSchema>> = (_data) => {if (!projectRef) return console.error('Project ref is required')+ if (!isRealtimeEntitlementsLoaded) returnsetIsConfirmNextModalOpen(true)}const onConfirmSave = () => {if (!projectRef) return console.error('Project ref is required')+ if (!isRealtimeEntitlementsLoaded) returnconst values = form.getValues()// [Joshen] Casting to `Number` here as the values are being set as string when edited in the form@@ -184,6 +302,16 @@ export const RealtimeSettings = () => {})}+ if (isLoading) {+ return (+ <Card>+ <CardContent>+ <GenericSkeletonLoader />+ </CardContent>+ </Card>+ )+ }+return (<><Form {...form}>@@ -207,6 +335,7 @@ export const RealtimeSettings = () => {<FormControl><Switchid="suspend"+ aria-label="Toggle enabling of realtime service"checked={!field.value}onCheckedChange={(checked) => field.onChange(!checked)}disabled={!canUpdateConfig}@@ -221,30 +350,25 @@ export const RealtimeSettings = () => {<AdmonitionshowIcon={false}type={isDisablingRealtime || isEnablingRealtime ? 'warning' : 'default'}- >- <div className="flex items-center gap-x-2">- <div>- <h5 className="text-foreground mb-1">- {isDisablingRealtime- ? 'Realtime service will be disabled'- : isEnablingRealtime- ? 'Realtime service will be re-enabled'- : isRealtimeDisabled- ? 'Realtime service is disabled'- : null}- </h5>- <p className="text-foreground-light">- {isDisablingRealtime- ? 'Clients will no longer be able to connect to your project’s realtime service once saved'- : isEnablingRealtime- ? "Clients will be able to connect to your project's realtime service again once saved"- : isRealtimeDisabled- ? 'You will need to enable it to continue using Realtime'- : null}- </p>- </div>- </div>- </Admonition>+ title={+ isDisablingRealtime+ ? 'Realtime service will be disabled'+ : isEnablingRealtime+ ? 'Realtime service will be re-enabled'+ : isRealtimeDisabled+ ? 'Realtime service is disabled'+ : ''+ }+ description={+ isDisablingRealtime+ ? 'Clients will no longer be able to connect to your project’s realtime service once saved'+ : isEnablingRealtime+ ? "Clients will be able to connect to your project's realtime service again once saved"+ : isRealtimeDisabled+ ? 'You will need to enable it to continue using Realtime'+ : null+ }+ />)}</CardContent>@@ -265,6 +389,7 @@ export const RealtimeSettings = () => {<FormControl><Switchid="allow_public"+ aria-label="Toggle allow public access"checked={field.value}onCheckedChange={field.onChange}disabled={!canUpdateConfig}@@ -278,25 +403,23 @@ export const RealtimeSettings = () => {!isRealtimeDisabled && (<AdmonitionshowIcon={false}+ className="mt-2"type="warning"title="No Realtime RLS policies found"description={- <>- <p className="prose max-w-full text-sm">- Private mode is {isSettingToPrivate ? 'being ' : ''}- enabled, but no RLS policies exists on the{' '}- <code className="text-code-inline">- realtime.messages- </code>{' '}- table. No messages will be received by users.- </p>-- <Button asChild variant="default" className="mt-2">- <Link href={`/project/${projectRef}/realtime/policies`}>- Create policy- </Link>- </Button>- </>+ <p className="prose max-w-full text-sm">+ Private mode is {isSettingToPrivate ? 'being ' : ''}+ enabled, but no RLS policies exist on the{' '}+ <code className="text-code-inline">realtime.messages</code>{' '}+ table. No messages will be received by users.+ </p>+ }+ actions={+ <Button asChild variant="default">+ <Link href={`/project/${projectRef}/realtime/policies`}>+ Create policy+ </Link>+ </Button>}/>)}@@ -555,7 +678,7 @@ export const RealtimeSettings = () => {</div><div className="flex items-center gap-x-2">{form.formState.isDirty && (- <Button variant="default" onClick={() => form.reset(data as any)}>+ <Button variant="default" onClick={() => form.reset(formValues)}>Cancel</Button>)}@@ -563,7 +686,12 @@ export const RealtimeSettings = () => {variant="primary"type="submit"form={formId}- disabled={!canUpdateConfig || isUpdatingConfig || !form.formState.isDirty}+ disabled={+ !canUpdateConfig ||+ isUpdatingConfig ||+ !form.formState.isDirty ||+ !isRealtimeEntitlementsLoaded+ }loading={isUpdatingConfig}>Save changes