Files
Saxon Fletcher f9a1d2e983 Disable unsupported Studio features for HA projects (#48376)
## Summary

More gating to support upcoming High Availability projects. 

- Keep the Recent Branch stat visible on the project home page for HA
projects, but disable its interaction, reduce its opacity, and skip the
branches query.
- Treat Realtime as disabled for HA projects in the service-status
dropdown so it does not make the project appear unhealthy or trigger
unhealthy polling.
- Show the shared unsupported-feature empty state for Custom Domains and
skip its query on HA projects.
- Disable the Enable Realtime checkbox in the table creation sheet for
HA projects.


<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

- **New Features**
- Added High Availability–aware behavior across activity stats, service
status, custom domains, and table realtime controls.
- Introduced reusable Branch value UI that shows an “Unavailable” state
in High Availability mode.
- Added a dedicated realtime toggle UI that disables interaction and
updates helper text when unavailable.

- **Bug Fixes**
- Ensured realtime is treated as disabled (not unhealthy) in High
Availability and prevented realtime enabling/saving.
- Reduced unnecessary data fetching by gating addon/custom-domain
requests and disabling branch queries.

- **Tests**
- Added coverage for realtime status resolution, BranchStatValue
“Unavailable” rendering, and TableRealtimeToggle behavior.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-07-30 16:37:13 +08:00

208 lines
7.7 KiB
TypeScript

import { SupportCategories } from '@supabase/shared-types/out/constants'
import { useFlag, useParams } from 'common'
import { AlertCircle } from 'lucide-react'
import { Card, CardContent } from 'ui'
import {
PageSection,
PageSectionContent,
PageSectionDescription,
PageSectionMeta,
PageSectionSummary,
PageSectionTitle,
} from 'ui-patterns/PageSection'
import { CustomDomainActivate } from './CustomDomainActivate'
import { CustomDomainDelete } from './CustomDomainDelete'
import { CustomDomainsConfigureHostname } from './CustomDomainsConfigureHostname'
import { CustomDomainsShimmerLoader } from './CustomDomainsShimmerLoader'
import { CustomDomainVerify } from './CustomDomainVerify'
import { SupportLink } from '@/components/interfaces/Support/SupportLink'
import { HighAvailabilityDisabledEmptyState } from '@/components/ui/HighAvailability/HighAvailabilityDisabledEmptyState'
import { InlineLinkClassName } from '@/components/ui/InlineLink'
import { UpgradeToPro } from '@/components/ui/UpgradeToPro'
import {
useCustomDomainsQuery,
type CustomDomainsData,
} from '@/data/custom-domains/custom-domains-query'
import { useProjectAddonsQuery } from '@/data/subscriptions/project-addons-query'
import { useHighAvailability } from '@/hooks/misc/useHighAvailability'
import { useSelectedOrganizationQuery } from '@/hooks/misc/useSelectedOrganization'
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
export const CustomDomainConfig = () => {
const { ref } = useParams()
const { data: project } = useSelectedProjectQuery()
const { isHighAvailability, isPending: isHighAvailabilityPending } = useHighAvailability()
const { data: organization } = useSelectedOrganizationQuery()
const isBranch = Boolean(project?.parent_project_ref)
const entityLabel = isBranch ? 'branch' : 'project'
const customDomainsDisabledDueToQuota = useFlag('customDomainsDisabledDueToQuota')
const plan = organization?.plan?.id
const canLoadCustomDomains = !isHighAvailability && !isHighAvailabilityPending
const { data: addons, isPending: isLoadingAddons } = useProjectAddonsQuery(
{ projectRef: ref },
{ enabled: canLoadCustomDomains }
)
const hasCustomDomainAddon = !!addons?.selected_addons.find((x) => x.type === 'custom_domain')
const {
data: customDomainData,
isPending: isCustomDomainsLoading,
isError,
isSuccess,
status: customDomainStatus,
} = useCustomDomainsQuery(
{ projectRef: ref },
{
enabled: canLoadCustomDomains,
refetchInterval: (query) => {
const data = query.state.data
// while setting up the ssl certificate, we want to poll every 5 seconds
if (data?.customDomain?.ssl.status) {
return 10000 // 10 seconds
}
return false
},
}
)
const { status } = customDomainData || {}
if (isHighAvailability) {
return (
<PageSection id="custom-domains">
<PageSectionMeta>
<PageSectionSummary>
<PageSectionTitle>Custom domains</PageSectionTitle>
<PageSectionDescription>
Present a branded experience to your users
</PageSectionDescription>
</PageSectionSummary>
</PageSectionMeta>
<PageSectionContent>
<HighAvailabilityDisabledEmptyState
title="Custom domains unavailable on High Availability projects"
description="We're working to bring custom domains to High Availability projects. Contact support if this is blocking your work."
className="max-w-none mx-0 py-6"
/>
</PageSectionContent>
</PageSection>
)
}
return (
<PageSection id="custom-domains">
<PageSectionMeta>
<PageSectionSummary>
<PageSectionTitle>Custom domains</PageSectionTitle>
<PageSectionDescription>
Present a branded experience to your users
</PageSectionDescription>
</PageSectionSummary>
</PageSectionMeta>
<PageSectionContent>
{isHighAvailabilityPending || isLoadingAddons ? (
<Card>
<CardContent className="space-y-6">
<CustomDomainsShimmerLoader />
</CardContent>
</Card>
) : !hasCustomDomainAddon ? (
<UpgradeToPro
primaryText={
customDomainsDisabledDueToQuota
? 'New custom domains are temporarily disabled'
: 'Custom domains are a Pro Plan add-on'
}
secondaryText={
customDomainsDisabledDueToQuota
? 'We are working with our upstream DNS provider before we are able to sign up new custom domains. Please check back in a few hours.'
: plan === 'free'
? 'Paid Plans come with free vanity subdomains or Custom Domains for an additional $10/month per domain.'
: `To configure a custom domain for your ${entityLabel}, please enable the add-on. Each Custom Domain costs $10 per month.`
}
addon="customDomain"
source="customDomain"
featureProposition="enable custom domains"
disabled={customDomainsDisabledDueToQuota}
/>
) : isCustomDomainsLoading ? (
<Card>
<CardContent className="space-y-6">
<CustomDomainsShimmerLoader />
</CardContent>
</Card>
) : isError ? (
<Card>
<CardContent className="space-y-6">
<div className="flex items-center justify-center space-x-2 py-8">
<AlertCircle size={16} strokeWidth={1.5} />
<p className="text-sm text-foreground-light">
Failed to retrieve custom domain configuration. Please try again later or{' '}
<SupportLink
queryParams={{ projectRef: ref, category: SupportCategories.SALES_ENQUIRY }}
className={InlineLinkClassName}
>
contact support
</SupportLink>
.
</p>
</div>
</CardContent>
</Card>
) : status === '0_no_hostname_configured' ? (
<CustomDomainsConfigureHostname />
) : (
<Card>
<CardContent className="p-0">
{isSuccess ? (
<div className="flex flex-col">
{(status === '1_not_started' ||
status === '2_initiated' ||
status === '3_challenge_verified') && <CustomDomainVerify />}
{customDomainData.status === '4_origin_setup_completed' && (
<CustomDomainActivate
projectRef={ref}
customDomain={customDomainData.customDomain}
/>
)}
{customDomainData.status === '5_services_reconfigured' && (
<CustomDomainDelete
projectRef={ref}
customDomain={customDomainData.customDomain}
/>
)}
</div>
) : (
<CustomDomainConfigFallthrough
fetchStatus={customDomainStatus}
data={customDomainData}
/>
)}
</CardContent>
</Card>
)}
</PageSectionContent>
</PageSection>
)
}
interface CustomDomainConfigFallthroughProps {
fetchStatus: 'error' | 'success' | 'pending'
data: CustomDomainsData | undefined
}
function CustomDomainConfigFallthrough({ fetchStatus, data }: CustomDomainConfigFallthroughProps) {
console.error(`Failing to display UI for custom domains:
Fetch status: ${fetchStatus}
Custom domain status: ${data?.status}`)
return null
}