Files
supabase/apps/studio/components/interfaces/Settings/API/DataApiProjectUrlCard.tsx
Joshen Lim 90d3b56db0 Joshen/fe 2621 show custom domain on dashboard and connect modal (#43233)
## Context

Main fix is to adjust the new home page + connect dialog (and connect
sheet) to render the project's custom domain if available

<img width="471" height="255" alt="image"
src="https://github.com/user-attachments/assets/3a208b2e-bdeb-43f5-a2e7-3495881dbaaa"
/>
<img width="1065" height="233" alt="image"
src="https://github.com/user-attachments/assets/2a7b8f81-8c0b-4803-bf0a-fc16a2f1e0e1"
/>

## Changes involved

- Created a `useProjectApiUrl` hook that will return the API URL
depending if custom domains is available, otherwise default to default
project API URL
- Refactored all the other places that were manually deriving the
project's endpoint
  - Storage Explorer -> copy URL
  - Edge Functions
  - Integrations -> Data API + API Docs
  - Auth Providers -> Callback URL
- Also updated the copy CTA for the addons page
  - Instead of just "Change xxx", make it a bit more actionable
  - For add ons with binary states (Custom domains, IPv4)
    - If not enabled yet, "Enable xxx", otherwise "Toggle xxx"
  - For PITR
- If not enabled yet, "Enable PITR", otherwise "Change recovery
duration"
  - Also added "Edit custom domain" CTA if enabled
<img width="1144" height="518" alt="image"
src="https://github.com/user-attachments/assets/4f152ea5-0cc7-412c-95e8-ad5bb37c19c3"
/>


## To test
- [ ] Verify that for a project with custom domain set up, all the
affected UI mentioned in the above section look correct
2026-03-03 11:37:08 +08:00

107 lines
3.8 KiB
TypeScript

import { useParams } from 'common'
import { AlertCircle } from 'lucide-react'
import { parseAsString, useQueryState } from 'nuqs'
import { useEffect } from 'react'
import { Alert_Shadcn_, AlertTitle_Shadcn_ } from 'ui'
import {
PageSection,
PageSectionAside,
PageSectionContent,
PageSectionDescription,
PageSectionMeta,
PageSectionSummary,
PageSectionTitle,
} from 'ui-patterns'
import { Input } from 'ui-patterns/DataInputs/Input'
import { ShimmeringLoader } from 'ui-patterns/ShimmeringLoader'
import { getApiEndpoint } from '@/components/interfaces/Integrations/DataApi/DataApi.utils'
import { DatabaseSelector } from '@/components/ui/DatabaseSelector'
import { useProjectApiUrl } from '@/data/config/project-endpoint-query'
import { useLoadBalancersQuery } from '@/data/read-replicas/load-balancers-query'
import { useReadReplicasQuery } from '@/data/read-replicas/replicas-query'
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
import { useStaticEffectEvent } from '@/hooks/useStaticEffectEvent'
import { useDatabaseSelectorStateSnapshot } from '@/state/database-selector'
export const DataApiProjectUrlCard = () => {
const { isPending: isLoading } = useSelectedProjectQuery()
const { ref: projectRef } = useParams()
const state = useDatabaseSelectorStateSnapshot()
const [querySource, setQuerySource] = useQueryState('source', parseAsString)
const { data: resolvedEndpoint } = useProjectApiUrl({ projectRef })
const {
data: databases,
isError,
isPending: isLoadingDatabases,
} = useReadReplicasQuery({ projectRef })
const { data: loadBalancers } = useLoadBalancersQuery({ projectRef })
const syncSelectedDb = useStaticEffectEvent(() => {
if (querySource && querySource !== state.selectedDatabaseId) {
state.setSelectedDatabaseId(querySource)
}
})
useEffect(() => {
syncSelectedDb()
}, [syncSelectedDb, querySource, projectRef])
const selectedDatabase = databases?.find((db) => db.identifier === state.selectedDatabaseId)
const loadBalancerSelected = state.selectedDatabaseId === 'load-balancer'
const replicaSelected = selectedDatabase?.identifier !== projectRef
const endpoint = getApiEndpoint({
selectedDatabaseId: state.selectedDatabaseId,
projectRef,
resolvedEndpoint,
loadBalancers,
selectedDatabase,
})
return (
<PageSection className="first:pt-0">
<PageSectionMeta>
<PageSectionSummary>
<PageSectionTitle>API URL</PageSectionTitle>
<PageSectionDescription>
{loadBalancerSelected
? 'RESTful endpoint for querying and managing your databases through your load balancer'
: replicaSelected
? 'RESTful endpoint for querying your read replica'
: 'RESTful endpoint for querying and managing your database'}
</PageSectionDescription>
</PageSectionSummary>
<PageSectionAside>
<DatabaseSelector
additionalOptions={
(loadBalancers ?? []).length > 0
? [{ id: 'load-balancer', name: 'API Load Balancer' }]
: []
}
onSelectId={() => {
setQuerySource(null)
}}
/>
</PageSectionAside>
</PageSectionMeta>
<PageSectionContent>
{isLoading || isLoadingDatabases ? (
<div className="space-y-2">
<ShimmeringLoader />
<ShimmeringLoader className="w-3/4" delayIndex={1} />
</div>
) : isError ? (
<Alert_Shadcn_ variant="destructive">
<AlertCircle size={16} />
<AlertTitle_Shadcn_>Failed to retrieve project URL</AlertTitle_Shadcn_>
</Alert_Shadcn_>
) : (
<Input copy readOnly className="font-mono" value={endpoint} />
)}
</PageSectionContent>
</PageSection>
)
}