Files
supabase/apps/studio/components/interfaces/Settings/API/ServiceList.tsx
Joshen Lim b78eea5176 Support hardening api via custom schema in api settings (#27894)
* Support hardening api via custom schema in api settings

* Update UI based on discussion

* Changes to language

* Update changes

* Remove unnecessary check on pg_graphql extension

* Fix

* Fix
2024-07-11 15:48:06 +08:00

168 lines
6.4 KiB
TypeScript

import { JwtSecretUpdateError, JwtSecretUpdateStatus } from '@supabase/shared-types/out/events'
import { useQueryClient } from '@tanstack/react-query'
import { AlertCircle } from 'lucide-react'
import { useEffect, useRef } from 'react'
import toast from 'react-hot-toast'
import { useParams } from 'common'
import { useProjectContext } from 'components/layouts/ProjectLayout/ProjectContext'
import DatabaseSelector from 'components/ui/DatabaseSelector'
import Panel from 'components/ui/Panel'
import { DisplayApiSettings } from 'components/ui/ProjectSettings'
import { GenericSkeletonLoader } from 'components/ui/ShimmeringLoader'
import { useJwtSecretUpdatingStatusQuery } from 'data/config/jwt-secret-updating-status-query'
import { configKeys } from 'data/config/keys'
import { useProjectApiQuery } from 'data/config/project-api-query'
import { useCustomDomainsQuery } from 'data/custom-domains/custom-domains-query'
import { useLoadBalancersQuery } from 'data/read-replicas/load-balancers-query'
import { useReadReplicasQuery } from 'data/read-replicas/replicas-query'
import { PROJECT_STATUS } from 'lib/constants'
import { useDatabaseSelectorStateSnapshot } from 'state/database-selector'
import { Badge, Input } from 'ui'
import { JWT_SECRET_UPDATE_ERROR_MESSAGES } from './API.constants'
import JWTSettings from './JWTSettings'
import { PostgrestConfig } from './PostgrestConfig'
const ServiceList = () => {
const client = useQueryClient()
const { project, isLoading } = useProjectContext()
const { ref: projectRef, source } = useParams()
const state = useDatabaseSelectorStateSnapshot()
const { data: settings, isError } = useProjectApiQuery({
projectRef,
})
const { data: customDomainData } = useCustomDomainsQuery({ projectRef })
const { data: databases } = useReadReplicasQuery({ projectRef })
const { data: loadBalancers } = useLoadBalancersQuery({ projectRef })
const { data } = useJwtSecretUpdatingStatusQuery({ projectRef })
const jwtSecretUpdateStatus = data?.jwtSecretUpdateStatus
const jwtSecretUpdateError = data?.jwtSecretUpdateError
const previousJwtSecretUpdateStatus = useRef<JwtSecretUpdateStatus>()
const { Failed, Updated, Updating } = JwtSecretUpdateStatus
const jwtSecretUpdateErrorMessage =
JWT_SECRET_UPDATE_ERROR_MESSAGES[jwtSecretUpdateError as JwtSecretUpdateError]
// Get the API service
const isCustomDomainActive = customDomainData?.customDomain?.status === 'active'
const selectedDatabase = databases?.find((db) => db.identifier === state.selectedDatabaseId)
const loadBalancerSelected = state.selectedDatabaseId === 'load-balancer'
const replicaSelected = selectedDatabase?.identifier !== projectRef
const endpoint =
isCustomDomainActive && state.selectedDatabaseId === projectRef
? `https://${customDomainData.customDomain.hostname}`
: loadBalancerSelected
? loadBalancers?.[0].endpoint ?? ''
: selectedDatabase?.restUrl
useEffect(() => {
if (previousJwtSecretUpdateStatus.current === Updating) {
switch (jwtSecretUpdateStatus) {
case Updated:
client.invalidateQueries(configKeys.api(projectRef))
client.invalidateQueries(configKeys.settings(projectRef))
client.invalidateQueries(configKeys.postgrest(projectRef))
toast.success('Successfully updated JWT secret')
break
case Failed:
toast.error(`JWT secret update failed: ${jwtSecretUpdateErrorMessage}`)
break
}
}
previousJwtSecretUpdateStatus.current = jwtSecretUpdateStatus
}, [jwtSecretUpdateStatus])
useEffect(() => {
if (source !== undefined) {
state.setSelectedDatabaseId('load-balancer')
}
}, [source])
return (
<div>
{isLoading ? (
<GenericSkeletonLoader />
) : project?.status !== PROJECT_STATUS.ACTIVE_HEALTHY ? (
<div className="flex items-center justify-center rounded border border-overlay bg-surface-100 p-8">
<AlertCircle size={16} />
<p className="text-sm text-foreground-light ml-2">
API settings are unavailable as the project is not active
</p>
</div>
) : (
<>
<section>
<Panel
title={
<div className="w-full flex items-center justify-between">
<h5 className="mb-0">Project URL</h5>
<DatabaseSelector
additionalOptions={
(loadBalancers ?? []).length > 0
? [{ id: 'load-balancer', name: 'API Load Balancer' }]
: []
}
/>
</div>
}
>
<Panel.Content>
{isError ? (
<div className="flex items-center justify-center py-4 space-x-2">
<AlertCircle size={16} />
<p className="text-sm text-foreground-light">Failed to retrieve project URL</p>
</div>
) : (
<Input
copy
label={
isCustomDomainActive ? (
<div className="flex items-center space-x-2">
<p>URL</p>
<Badge>Custom domain active</Badge>
</div>
) : (
'URL'
)
}
readOnly
disabled
className="input-mono"
value={endpoint}
descriptionText={
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'
}
layout="horizontal"
/>
)}
</Panel.Content>
</Panel>
</section>
<section>
<DisplayApiSettings key="DisplayAPISettings" />
</section>
<section>
<JWTSettings />
</section>
<section id="postgrest-config">
<PostgrestConfig />
</section>
</>
)}
</div>
)
}
export default ServiceList