Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

feat(studio): show Realtime on High Availability projects in staging (#51372)

Ping-Min Lin1ee88e0fee29
diff --git a/apps/studio/components/interfaces/Database/Publications/PublicationsAvailability.test.tsx b/apps/studio/components/interfaces/Database/Publications/PublicationsAvailability.test.tsx
index 2594bf39ed0..382ebb09fea 100644
--- a/apps/studio/components/interfaces/Database/Publications/PublicationsAvailability.test.tsx
+++ b/apps/studio/components/interfaces/Database/Publications/PublicationsAvailability.test.tsx
@@ -3,17 +3,17 @@ import { describe, expect, it, vi } from 'vitest'
import { PublicationsAvailability } from './PublicationsAvailability'
-const { mockUseHighAvailability } = vi.hoisted(() => ({
- mockUseHighAvailability: vi.fn(),
+const { mockUseIsRealtimeUnavailable } = vi.hoisted(() => ({
+ mockUseIsRealtimeUnavailable: vi.fn(),
}))
vi.mock('@/hooks/misc/useHighAvailability', () => ({
- useHighAvailability: mockUseHighAvailability,
+ useIsRealtimeUnavailable: mockUseIsRealtimeUnavailable,
}))
describe('PublicationsAvailability', () => {
- it('shows the disabled empty state instead of page content for High Availability projects', () => {
- mockUseHighAvailability.mockReturnValue({ isHighAvailability: true })
+ it('shows the disabled empty state instead of page content when Realtime is unavailable', () => {
+ mockUseIsRealtimeUnavailable.mockReturnValue({ isRealtimeUnavailable: true })
render(
<PublicationsAvailability>
@@ -32,8 +32,8 @@ describe('PublicationsAvailability', () => {
expect(screen.queryByText('Publications content')).not.toBeInTheDocument()
})
- it('renders page content for non-High Availability projects', () => {
- mockUseHighAvailability.mockReturnValue({ isHighAvailability: false })
+ it('renders page content when Realtime is available', () => {
+ mockUseIsRealtimeUnavailable.mockReturnValue({ isRealtimeUnavailable: false })
render(
<PublicationsAvailability>
diff --git a/apps/studio/components/interfaces/Database/Publications/PublicationsAvailability.tsx b/apps/studio/components/interfaces/Database/Publications/PublicationsAvailability.tsx
index d38156ada71..91eac96b347 100644
--- a/apps/studio/components/interfaces/Database/Publications/PublicationsAvailability.tsx
+++ b/apps/studio/components/interfaces/Database/Publications/PublicationsAvailability.tsx
@@ -2,12 +2,12 @@ import { BookOpen } from 'lucide-react'
import type { PropsWithChildren } from 'react'
import { HighAvailabilityDisabledEmptyState } from '@/components/ui/HighAvailability/HighAvailabilityDisabledEmptyState'
-import { useHighAvailability } from '@/hooks/misc/useHighAvailability'
+import { useIsRealtimeUnavailable } from '@/hooks/misc/useHighAvailability'
export const PublicationsAvailability = ({ children }: PropsWithChildren) => {
- const { isHighAvailability } = useHighAvailability()
+ const { isRealtimeUnavailable } = useIsRealtimeUnavailable()
- if (isHighAvailability) {
+ if (isRealtimeUnavailable) {
return (
<div className="flex h-full w-full items-center justify-center p-6">
<HighAvailabilityDisabledEmptyState
diff --git a/apps/studio/components/interfaces/ProjectHome/ServiceStatus.test.ts b/apps/studio/components/interfaces/ProjectHome/ServiceStatus.test.ts
index a403d34e88e..548ac0b9c08 100644
--- a/apps/studio/components/interfaces/ProjectHome/ServiceStatus.test.ts
+++ b/apps/studio/components/interfaces/ProjectHome/ServiceStatus.test.ts
@@ -3,11 +3,11 @@ import { describe, expect, it } from 'vitest'
import { resolveRealtimeServiceStatus } from './ServiceStatus.utils'
describe('resolveRealtimeServiceStatus', () => {
- it('marks Realtime as disabled on High Availability projects', () => {
+ it('marks Realtime as disabled when it is unavailable', () => {
expect(resolveRealtimeServiceStatus(true, 'UNHEALTHY')).toBe('DISABLED')
})
- it('preserves Realtime health on standard projects', () => {
+ it('preserves Realtime health when it is available', () => {
expect(resolveRealtimeServiceStatus(false, 'ACTIVE_HEALTHY')).toBe('ACTIVE_HEALTHY')
expect(resolveRealtimeServiceStatus(false, 'UNHEALTHY')).toBe('UNHEALTHY')
})
diff --git a/apps/studio/components/interfaces/ProjectHome/ServiceStatus.tsx b/apps/studio/components/interfaces/ProjectHome/ServiceStatus.tsx
index ae4df4aa17a..7bf36414ed6 100644
--- a/apps/studio/components/interfaces/ProjectHome/ServiceStatus.tsx
+++ b/apps/studio/components/interfaces/ProjectHome/ServiceStatus.tsx
@@ -14,7 +14,7 @@ import {
useProjectServiceStatusQuery,
type ServiceHealthResponse,
} from '@/data/service-status/service-status-query'
-import { useHighAvailability } from '@/hooks/misc/useHighAvailability'
+import { useIsRealtimeUnavailable } from '@/hooks/misc/useHighAvailability'
import { useIsFeatureEnabled } from '@/hooks/misc/useIsFeatureEnabled'
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
import { DOCS_URL } from '@/lib/constants'
@@ -104,7 +104,7 @@ const extractDbSchema = (response: ServiceHealthResponse | undefined) => {
export const ServiceStatus = () => {
const { ref } = useParams()
const { data: project } = useSelectedProjectQuery()
- const { isHighAvailability } = useHighAvailability()
+ const { isRealtimeUnavailable } = useIsRealtimeUnavailable()
const { isEnabled: isUnifiedLogsEnabled } = useUnifiedLogsPreview()
const {
@@ -140,7 +140,7 @@ export const ServiceStatus = () => {
refetchInterval: (query) => {
const data = query.state.data
const isServiceUnhealthy = data?.some((service) => {
- if (isHighAvailability && service.name === 'realtime') {
+ if (isRealtimeUnavailable && service.name === 'realtime') {
return false
}
// if the postgrest service has an empty schema, postgrest has been disabled
@@ -220,7 +220,7 @@ export const ServiceStatus = () => {
error: realtimeStatus?.error,
docsUrl: undefined,
isLoading,
- status: resolveRealtimeServiceStatus(isHighAvailability, realtimeStatus?.status),
+ status: resolveRealtimeServiceStatus(isRealtimeUnavailable, realtimeStatus?.status),
logsUrl: isUnifiedLogsEnabled
? '/logs?filter=log_type:eq:realtime'
: '/logs/realtime-logs',
diff --git a/apps/studio/components/interfaces/ProjectHome/ServiceStatus.utils.ts b/apps/studio/components/interfaces/ProjectHome/ServiceStatus.utils.ts
index 9affbfb9f27..78258827ee4 100644
--- a/apps/studio/components/interfaces/ProjectHome/ServiceStatus.utils.ts
+++ b/apps/studio/components/interfaces/ProjectHome/ServiceStatus.utils.ts
@@ -3,8 +3,8 @@ import type { ProjectServiceStatus as APIProjectServiceStatus } from '@/data/ser
export type ProjectServiceStatus = APIProjectServiceStatus | 'DISABLED'
export const resolveRealtimeServiceStatus = (
- isHighAvailability: boolean,
+ isRealtimeUnavailable: boolean,
status?: APIProjectServiceStatus
): ProjectServiceStatus => {
- return isHighAvailability ? 'DISABLED' : (status ?? 'UNHEALTHY')
+ return isRealtimeUnavailable ? 'DISABLED' : (status ?? 'UNHEALTHY')
}
diff --git a/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/TableEditor/TableEditor.test.tsx b/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/TableEditor/TableEditor.test.tsx
index 01f45f3a121..1c55b5a219d 100644
--- a/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/TableEditor/TableEditor.test.tsx
+++ b/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/TableEditor/TableEditor.test.tsx
@@ -5,11 +5,11 @@ import { describe, expect, it, vi } from 'vitest'
import { TableRealtimeToggle } from './TableEditor'
describe('TableRealtimeToggle', () => {
- it('disables Realtime and shows the HA-specific description for HA projects', () => {
+ it('disables Realtime and shows the HA-specific description when Realtime is unavailable', () => {
render(
<TableRealtimeToggle
checked={false}
- isHighAvailability
+ isRealtimeUnavailable
isPending={false}
onCheckedChange={vi.fn()}
/>
@@ -24,11 +24,11 @@ describe('TableRealtimeToggle', () => {
).not.toBeInTheDocument()
})
- it('keeps Realtime available with the standard description for non-HA projects', () => {
+ it('keeps Realtime available with the standard description when Realtime is available', () => {
render(
<TableRealtimeToggle
checked={false}
- isHighAvailability={false}
+ isRealtimeUnavailable={false}
isPending={false}
onCheckedChange={vi.fn()}
/>
@@ -49,7 +49,7 @@ describe('TableRealtimeToggle', () => {
const { rerender } = render(
<TableRealtimeToggle
checked={false}
- isHighAvailability={false}
+ isRealtimeUnavailable={false}
isPending
onCheckedChange={onCheckedChange}
/>
@@ -63,7 +63,7 @@ describe('TableRealtimeToggle', () => {
rerender(
<TableRealtimeToggle
checked={false}
- isHighAvailability={false}
+ isRealtimeUnavailable={false}
isPending={false}
onCheckedChange={onCheckedChange}
/>
diff --git a/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/TableEditor/TableEditor.tsx b/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/TableEditor/TableEditor.tsx
index eca4e4b1281..1ecb23d3564 100644
--- a/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/TableEditor/TableEditor.tsx
+++ b/apps/studio/components/interfaces/TableGridEditor/SidePanelEditor/TableEditor/TableEditor.tsx
@@ -32,7 +32,7 @@ import { useForeignKeyConstraintsQuery } from '@/data/database/foreign-key-const
import { useEnumeratedTypesQuery } from '@/data/enumerated-types/enumerated-types-query'
import { useCustomContent } from '@/hooks/custom-content/useCustomContent'
import { useChanged } from '@/hooks/misc/useChanged'
-import { useHighAvailability } from '@/hooks/misc/useHighAvailability'
+import { useIsRealtimeUnavailable } from '@/hooks/misc/useHighAvailability'
import { useIsFeatureEnabled } from '@/hooks/misc/useIsFeatureEnabled'
import { useQuerySchemaState } from '@/hooks/misc/useSchemaQueryState'
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
@@ -66,14 +66,14 @@ export interface TableEditorProps {
interface TableRealtimeToggleProps {
checked: boolean
- isHighAvailability: boolean
+ isRealtimeUnavailable: boolean
isPending: boolean
onCheckedChange: () => void
}
export const TableRealtimeToggle = ({
checked,
- isHighAvailability,
+ isRealtimeUnavailable,
isPending,
onCheckedChange,
}: TableRealtimeToggleProps) => {
@@ -82,7 +82,7 @@ export const TableRealtimeToggle = ({
<Checkbox
id="enable-realtime"
checked={checked}
- disabled={isHighAvailability || isPending}
+ disabled={isRealtimeUnavailable || isPending}
onCheckedChange={onCheckedChange}
/>
<div className="grid gap-1.5 leading-none">
@@ -93,7 +93,7 @@ export const TableRealtimeToggle = ({
Enable Realtime
</label>
<p className="text-sm text-foreground-muted">
- {isHighAvailability
+ {isRealtimeUnavailable
? 'Realtime is unavailable on High Availability projects.'
: 'Broadcast changes on this table to authorized subscribers.'}
</p>
@@ -116,7 +116,8 @@ export const TableEditor = ({
const snap = useTableEditorStateSnapshot()
const tableEditorApi = useContext(TableEditorStateContext)
const { realtimeAll: realtimeEnabled } = useIsFeatureEnabled(['realtime:all'])
- const { isHighAvailability, isPending: isHighAvailabilityPending } = useHighAvailability()
+ const { isRealtimeUnavailable, isPending: isRealtimeUnavailablePending } =
+ useIsRealtimeUnavailable()
const { docsRowLevelSecurityGuidePath } = useCustomContent(['docs:row_level_security_guide_path'])
const [params, setParams] = useUrlState()
@@ -260,7 +261,7 @@ export const TableEditor = ({
tableId: table?.id,
importContent,
isRLSEnabled: tableFields.isRLSEnabled,
- isRealtimeEnabled: !isHighAvailability && tableFields.isRealtimeEnabled,
+ isRealtimeEnabled: !isRealtimeUnavailable && tableFields.isRealtimeEnabled,
isDuplicateRows: isDuplicateRows,
existingForeignKeyRelations: foreignKeys,
primaryKey,
@@ -542,8 +543,8 @@ export const TableEditor = ({
{realtimeEnabled && (
<TableRealtimeToggle
checked={tableFields.isRealtimeEnabled}
- isHighAvailability={isHighAvailability}
- isPending={isHighAvailabilityPending}
+ isRealtimeUnavailable={isRealtimeUnavailable}
+ isPending={isRealtimeUnavailablePending}
onCheckedChange={() => {
track('realtime_toggle_table_clicked', {
newState: tableFields.isRealtimeEnabled ? 'disabled' : 'enabled',
diff --git a/apps/studio/components/layouts/RealtimeLayout/RealtimeLayout.tsx b/apps/studio/components/layouts/RealtimeLayout/RealtimeLayout.tsx
index e2be2602639..275ae6c7d8c 100644
--- a/apps/studio/components/layouts/RealtimeLayout/RealtimeLayout.tsx
+++ b/apps/studio/components/layouts/RealtimeLayout/RealtimeLayout.tsx
@@ -8,7 +8,7 @@ import { generateRealtimeMenu } from './RealtimeMenu.utils'
import { HighAvailabilityDisabledEmptyState } from '@/components/ui/HighAvailability/HighAvailabilityDisabledEmptyState'
import { ProductMenu } from '@/components/ui/ProductMenu'
import { ProductMenuShortcuts } from '@/components/ui/ProductMenu/ProductMenuShortcuts'
-import { useHighAvailability } from '@/hooks/misc/useHighAvailability'
+import { useIsRealtimeUnavailable } from '@/hooks/misc/useHighAvailability'
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
import { withAuth } from '@/hooks/misc/withAuth'
@@ -31,12 +31,12 @@ export interface RealtimeLayoutProps {
export const RealtimeLayout = ({ title, children }: PropsWithChildren<RealtimeLayoutProps>) => {
const { data: project } = useSelectedProjectQuery()
- const { isHighAvailability } = useHighAvailability()
+ const { isRealtimeUnavailable } = useIsRealtimeUnavailable()
const router = useRouter()
const page = router.pathname.split('/')[4]
const menu = generateRealtimeMenu(project)
- if (isHighAvailability) {
+ if (isRealtimeUnavailable) {
return (
<>
<Head>
diff --git a/apps/studio/hooks/misc/__tests__/resolveRealtimeUnavailable.test.ts b/apps/studio/hooks/misc/__tests__/resolveRealtimeUnavailable.test.ts
new file mode 100644
index 00000000000..35c2208df24
--- /dev/null
+++ b/apps/studio/hooks/misc/__tests__/resolveRealtimeUnavailable.test.ts
@@ -0,0 +1,18 @@
+import { describe, expect, it } from 'vitest'
+
+import { resolveRealtimeUnavailable } from '../useHighAvailability'
+
+describe('resolveRealtimeUnavailable', () => {
+ it('is unavailable on High Availability projects outside staging and local', () => {
+ expect(resolveRealtimeUnavailable(true, false)).toBe(true)
+ })
+
+ it('is available on High Availability projects in staging and local', () => {
+ expect(resolveRealtimeUnavailable(true, true)).toBe(false)
+ })
+
+ it('is available on standard projects in every environment', () => {
+ expect(resolveRealtimeUnavailable(false, false)).toBe(false)
+ expect(resolveRealtimeUnavailable(false, true)).toBe(false)
+ })
+})
diff --git a/apps/studio/hooks/misc/useHighAvailability.ts b/apps/studio/hooks/misc/useHighAvailability.ts
index 626a484e623..6ba681c9b6e 100644
--- a/apps/studio/hooks/misc/useHighAvailability.ts
+++ b/apps/studio/hooks/misc/useHighAvailability.ts
@@ -2,6 +2,7 @@ import { useMemo } from 'react'
import { MULTIGRES_SCHEMA_NAME, resolveHighAvailability } from './useHighAvailability.constants'
import { useIsHighAvailability, useSelectedProjectQuery } from './useSelectedProject'
+import { IS_STAGING_OR_LOCAL } from '@/lib/constants'
export { MULTIGRES_SCHEMA_NAME, resolveHighAvailability }
@@ -16,6 +17,28 @@ export function useHighAvailability() {
}
}
+/**
+ * Realtime (and the publications it relies on) is only available on High
+ * Availability projects in staging and local environments while it is being
+ * validated there. Whether a project is actually registered as a Realtime
+ * tenant is decided by the platform.
+ */
+export function resolveRealtimeUnavailable(
+ isHighAvailability: boolean,
+ isHighAvailabilityRealtimeAvailable = IS_STAGING_OR_LOCAL
+) {
+ return isHighAvailability && !isHighAvailabilityRealtimeAvailable
+}
+
+export function useIsRealtimeUnavailable() {
+ const { isHighAvailability, isPending } = useHighAvailability()
+
+ return {
+ isRealtimeUnavailable: resolveRealtimeUnavailable(isHighAvailability),
+ isPending,
+ }
+}
+
export function filterSchemasForHighAvailability<T extends { name: string }>(
schemas: T[],
isHighAvailability: boolean