Files
supabase/apps/studio/components/interfaces/Functions/EdgeFunctionSecrets/EdgeFunctionSecrets.tsx
T
Charis 11aa71bc2a fix(edge functions secrets): allow read-only role to read secrets metadata (#40667)
According to our API permissions model, the read-only role can also read
secrets metadata (the actual secret itself is not viewable by anybdoy).
Updating the frontend UI to match.
2025-11-21 10:57:34 -05:00

197 lines
7.6 KiB
TypeScript

import { PermissionAction } from '@supabase/shared-types/out/constants'
import { Search } from 'lucide-react'
import { useRef, useState } from 'react'
import { toast } from 'sonner'
import { useParams } from 'common'
import AlertError from 'components/ui/AlertError'
import NoPermission from 'components/ui/NoPermission'
import { GenericSkeletonLoader } from 'components/ui/ShimmeringLoader'
import { useSecretsDeleteMutation } from 'data/secrets/secrets-delete-mutation'
import { useSecretsQuery } from 'data/secrets/secrets-query'
import { useAsyncCheckPermissions } from 'hooks/misc/useCheckPermissions'
import { handleErrorOnDelete, useQueryStateWithSelect } from 'hooks/misc/useQueryStateWithSelect'
import { Badge, Card, Table, TableBody, TableCell, TableHead, TableHeader, TableRow } from 'ui'
import { Input } from 'ui-patterns/DataInputs/Input'
import ConfirmationModal from 'ui-patterns/Dialogs/ConfirmationModal'
import AddNewSecretForm from './AddNewSecretForm'
import EdgeFunctionSecret from './EdgeFunctionSecret'
import { EditSecretSheet } from './EditSecretSheet'
export const EdgeFunctionSecrets = () => {
const { ref: projectRef } = useParams()
const [searchString, setSearchString] = useState('')
// Track the ID being deleted to exclude it from error checking
const deletingSecretNameRef = useRef<string | null>(null)
const { can: canReadSecrets, isLoading: isLoadingSecretsPermissions } = useAsyncCheckPermissions(
PermissionAction.FUNCTIONS_SECRET_READ,
'*'
)
const { can: canUpdateSecrets } = useAsyncCheckPermissions(PermissionAction.SECRETS_WRITE, '*')
const { data, error, isLoading, isSuccess, isError } = useSecretsQuery(
{
projectRef: projectRef,
},
{ enabled: canReadSecrets }
)
const { setValue: setSelectedSecretToEdit, value: selectedSecretToEdit } =
useQueryStateWithSelect({
urlKey: 'edit',
select: (secretName: string) =>
secretName ? data?.find((secret) => secret.name === secretName) : undefined,
enabled: !!data,
onError: () => toast.error(`Secret not found`),
})
const { setValue: setSelectedSecretToDelete, value: selectedSecretToDelete } =
useQueryStateWithSelect({
urlKey: 'delete',
select: (secretName: string) =>
secretName ? data?.find((secret) => secret.name === secretName) : undefined,
enabled: !!data,
onError: (_error, selectedId) =>
handleErrorOnDelete(deletingSecretNameRef, selectedId, `Secret not found`),
})
const { mutate: deleteSecret, isPending: isDeleting } = useSecretsDeleteMutation({
onSuccess: (_, variables) => {
toast.success(`Successfully deleted ${variables.secrets[0]}`)
setSelectedSecretToDelete(null)
},
onError: () => {
deletingSecretNameRef.current = null
},
})
const secrets =
searchString.length > 0
? data?.filter((secret) => secret.name.toLowerCase().includes(searchString.toLowerCase())) ??
[]
: data ?? []
const headers = [
<TableHead key="secret-name">Name</TableHead>,
<TableHead key="secret-value" className="flex items-center gap-x-2">
Digest{' '}
<Badge color="scale" className="font-mono">
SHA256
</Badge>
</TableHead>,
<TableHead key="secret-updated-at">Updated at</TableHead>,
<TableHead key="actions" />,
]
const showLoadingState = isLoadingSecretsPermissions || (canReadSecrets && isLoading)
return (
<>
{showLoadingState ? (
<GenericSkeletonLoader />
) : !canReadSecrets ? (
<NoPermission resourceText="view this project's edge function secrets" />
) : (
<>
{isError && <AlertError error={error} subject="Failed to retrieve project secrets" />}
{isSuccess && (
<>
<div className="mb-6">
{!canUpdateSecrets ? (
<NoPermission resourceText="manage this project's edge function secrets" />
) : (
<AddNewSecretForm />
)}
</div>
{canUpdateSecrets && !canReadSecrets ? (
<NoPermission resourceText="view this project's edge function secrets" />
) : canReadSecrets ? (
<div className="space-y-4 mt-4">
<div className="flex flex-col md:flex-row md:items-center justify-between gap-2">
<Input
size="small"
className="w-full md:w-80"
placeholder="Search for a secret"
value={searchString}
onChange={(e: any) => setSearchString(e.target.value)}
icon={<Search size={14} />}
/>
</div>
<Card>
<Table>
<TableHeader>
<TableRow>{headers}</TableRow>
</TableHeader>
<TableBody>
{secrets.length > 0 ? (
secrets.map((secret) => (
<EdgeFunctionSecret
key={secret.name}
secret={secret}
onSelectEdit={() => setSelectedSecretToEdit(secret.name)}
onSelectDelete={() => setSelectedSecretToDelete(secret.name)}
/>
))
) : secrets.length === 0 && searchString.length > 0 ? (
<TableRow>
<TableCell colSpan={headers.length}>
<p className="text-sm text-foreground">No results found</p>
<p className="text-sm text-foreground-light">
Your search for "{searchString}" did not return any results
</p>
</TableCell>
</TableRow>
) : (
<TableRow>
<TableCell colSpan={headers.length}>
<p className="text-sm text-foreground">No secrets created</p>
<p className="text-sm text-foreground-light">
There are no secrets associated with your project yet
</p>
</TableCell>
</TableRow>
)}
</TableBody>
</Table>
</Card>
</div>
) : null}
</>
)}
</>
)}
<EditSecretSheet
secret={selectedSecretToEdit}
visible={!!selectedSecretToEdit}
onClose={() => setSelectedSecretToEdit(null)}
/>
<ConfirmationModal
variant="destructive"
loading={isDeleting}
visible={!!selectedSecretToDelete}
confirmLabel="Delete secret"
confirmLabelLoading="Deleting secret"
title={`Confirm to delete secret "${selectedSecretToDelete?.name}"`}
onCancel={() => setSelectedSecretToDelete(null)}
onConfirm={() => {
if (selectedSecretToDelete) {
deletingSecretNameRef.current = selectedSecretToDelete.name
deleteSecret({ projectRef, secrets: [selectedSecretToDelete.name] })
}
}}
>
<p className="text-sm">
Before removing this secret, ensure none of your Edge Functions are actively using it.
This action cannot be undone.
</p>
</ConfirmationModal>
</>
)
}