EdgeFunctionSecrets.tsx 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241
  1. import { PermissionAction } from '@supabase/shared-types/out/constants'
  2. import { useParams } from 'common'
  3. import { Search } from 'lucide-react'
  4. import { parseAsString, useQueryState } from 'nuqs'
  5. import { useEffect, useMemo, useState } from 'react'
  6. import { toast } from 'sonner'
  7. import { Badge, Card, Table, TableBody, TableCell, TableHead, TableHeader, TableRow } from 'ui'
  8. import { Input } from 'ui-patterns/DataInputs/Input'
  9. import { ConfirmationModal } from 'ui-patterns/Dialogs/ConfirmationModal'
  10. import { GenericSkeletonLoader } from 'ui-patterns/ShimmeringLoader'
  11. import { AddNewSecretForm } from './AddNewSecretForm'
  12. import { DefaultEdgeFunctionSecrets } from './DefaultEdgeFunctionSecrets'
  13. import {
  14. getVisibleDefaultEdgeFunctionSecrets,
  15. isInternalEdgeFunctionSecret,
  16. } from './DefaultEdgeFunctionSecrets.utils'
  17. import EdgeFunctionSecret from './EdgeFunctionSecret'
  18. import { EditSecretSheet } from './EditSecretSheet'
  19. import { AlertError } from '@/components/ui/AlertError'
  20. import { DocsButton } from '@/components/ui/DocsButton'
  21. import { NoPermission } from '@/components/ui/NoPermission'
  22. import { useSecretsDeleteMutation } from '@/data/secrets/secrets-delete-mutation'
  23. import { useSecretsQuery } from '@/data/secrets/secrets-query'
  24. import { useAsyncCheckPermissions } from '@/hooks/misc/useCheckPermissions'
  25. import { DOCS_URL } from '@/lib/constants'
  26. export const EdgeFunctionSecrets = () => {
  27. const { ref: projectRef } = useParams()
  28. const [searchString, setSearchString] = useState('')
  29. const { can: canReadSecrets, isLoading: isLoadingSecretsPermissions } = useAsyncCheckPermissions(
  30. PermissionAction.FUNCTIONS_SECRET_READ,
  31. '*'
  32. )
  33. const { can: canUpdateSecrets } = useAsyncCheckPermissions(PermissionAction.SECRETS_WRITE, '*')
  34. const {
  35. data = [],
  36. error,
  37. isPending: isLoading,
  38. isSuccess,
  39. isError,
  40. } = useSecretsQuery({ projectRef: projectRef }, { enabled: canReadSecrets })
  41. const customSecrets = useMemo(
  42. () => data.filter((secret) => !isInternalEdgeFunctionSecret(secret.name)),
  43. [data]
  44. )
  45. const visibleDefaultSecrets = useMemo(
  46. () => getVisibleDefaultEdgeFunctionSecrets(new Set(data.map((secret) => secret.name))),
  47. [data]
  48. )
  49. const [selectedIdToEdit, setSelectedIdToEdit] = useQueryState(
  50. 'edit',
  51. parseAsString.withOptions({ history: 'push', clearOnDefault: true })
  52. )
  53. const selectedSecretToEdit = useMemo(
  54. () => customSecrets.find((secret) => secret.name === selectedIdToEdit),
  55. [customSecrets, selectedIdToEdit]
  56. )
  57. const [selectedIdToDelete, setSelectedIdToDelete] = useQueryState(
  58. 'delete',
  59. parseAsString.withOptions({ history: 'push', clearOnDefault: true })
  60. )
  61. const selectedSecretToDelete = useMemo(
  62. () => customSecrets.find((secret) => secret.name === selectedIdToDelete),
  63. [customSecrets, selectedIdToDelete]
  64. )
  65. const {
  66. mutate: deleteSecret,
  67. isPending: isDeleting,
  68. isSuccess: isSuccessDelete,
  69. } = useSecretsDeleteMutation({
  70. onSuccess: (_, variables) => {
  71. toast.success(`Successfully deleted secret “${variables.secrets[0]}”`)
  72. setSelectedIdToDelete(null)
  73. },
  74. })
  75. const filteredCustomSecrets = useMemo(() => {
  76. if (searchString.length === 0) return customSecrets
  77. const search = searchString.toLowerCase()
  78. return customSecrets.filter((secret) => secret.name.toLowerCase().includes(search))
  79. }, [customSecrets, searchString])
  80. const headers = [
  81. <TableHead key="secret-name">Name</TableHead>,
  82. <TableHead key="secret-value" className="flex items-center gap-x-2">
  83. Digest <Badge variant="default">SHA256</Badge>
  84. </TableHead>,
  85. <TableHead key="secret-updated-at">Updated</TableHead>,
  86. <TableHead key="actions" />,
  87. ]
  88. const showLoadingState = isLoadingSecretsPermissions || (canReadSecrets && isLoading)
  89. useEffect(() => {
  90. if (!!selectedIdToEdit && isSuccess && !selectedSecretToEdit) {
  91. toast(`Secret ${selectedIdToEdit} cannot be found`)
  92. setSelectedIdToEdit(null)
  93. }
  94. }, [isSuccess, selectedIdToEdit, selectedSecretToEdit, setSelectedIdToEdit])
  95. useEffect(() => {
  96. if (!!selectedIdToDelete && isSuccess && !selectedSecretToDelete && !isSuccessDelete) {
  97. toast(`Secret ${selectedIdToDelete} cannot be found`)
  98. setSelectedIdToDelete(null)
  99. }
  100. }, [
  101. isSuccess,
  102. isSuccessDelete,
  103. selectedIdToDelete,
  104. selectedSecretToDelete,
  105. setSelectedIdToDelete,
  106. ])
  107. return (
  108. <>
  109. {showLoadingState ? (
  110. <GenericSkeletonLoader />
  111. ) : !canReadSecrets ? (
  112. <NoPermission resourceText="view this project's edge function secrets" />
  113. ) : (
  114. <>
  115. {isError && <AlertError error={error} subject="Failed to retrieve project secrets" />}
  116. {isSuccess && (
  117. <div className="space-y-10">
  118. {canUpdateSecrets ? (
  119. <AddNewSecretForm />
  120. ) : (
  121. <NoPermission resourceText="manage this project's edge function secrets" />
  122. )}
  123. <section className="space-y-4">
  124. <div className="flex flex-col md:flex-row md:items-center justify-between gap-2">
  125. <div className="space-y-1">
  126. <h3 className="text-foreground text-base">Custom secrets</h3>
  127. <p className="text-sm text-foreground-light">
  128. Secrets you have defined for this project
  129. </p>
  130. </div>
  131. <Input
  132. size="small"
  133. className="w-full md:w-80"
  134. placeholder="Search for a secret"
  135. value={searchString}
  136. onChange={(e) => setSearchString(e.target.value)}
  137. icon={<Search />}
  138. />
  139. </div>
  140. <Card>
  141. <Table>
  142. <TableHeader>
  143. <TableRow>{headers}</TableRow>
  144. </TableHeader>
  145. <TableBody>
  146. {filteredCustomSecrets.length > 0 ? (
  147. filteredCustomSecrets.map((secret) => (
  148. <EdgeFunctionSecret
  149. key={secret.name}
  150. secret={secret}
  151. onSelectEdit={() => setSelectedIdToEdit(secret.name)}
  152. onSelectDelete={() => setSelectedIdToDelete(secret.name)}
  153. />
  154. ))
  155. ) : customSecrets.length === 0 ? (
  156. <TableRow className="[&>td]:hover:bg-inherit">
  157. <TableCell colSpan={headers.length}>
  158. <p className="text-sm text-foreground">No custom secrets created</p>
  159. <p className="text-sm text-foreground-lighter">
  160. This project has no custom secrets yet.
  161. </p>
  162. </TableCell>
  163. </TableRow>
  164. ) : (
  165. <TableRow className="[&>td]:hover:bg-inherit">
  166. <TableCell colSpan={headers.length}>
  167. <p className="text-sm text-foreground">No results found</p>
  168. <p className="text-sm text-foreground-light">
  169. Your search for "{searchString}" did not return any results
  170. </p>
  171. </TableCell>
  172. </TableRow>
  173. )}
  174. </TableBody>
  175. </Table>
  176. </Card>
  177. </section>
  178. <section className="space-y-4">
  179. <div className="flex flex-col md:flex-row md:items-center justify-between gap-2">
  180. <div className="space-y-1">
  181. <h3 className="text-foreground text-base">Default secrets</h3>
  182. <p className="text-sm text-foreground-light">
  183. Reserved secrets available in every project
  184. </p>
  185. </div>
  186. <DocsButton href={`${DOCS_URL}/guides/functions/secrets#default-secrets`} />
  187. </div>
  188. <DefaultEdgeFunctionSecrets secrets={visibleDefaultSecrets} />
  189. </section>
  190. </div>
  191. )}
  192. </>
  193. )}
  194. <EditSecretSheet
  195. secret={selectedSecretToEdit}
  196. visible={!!selectedSecretToEdit}
  197. onClose={() => setSelectedIdToEdit(null)}
  198. />
  199. <ConfirmationModal
  200. variant="destructive"
  201. loading={isDeleting}
  202. visible={!!selectedSecretToDelete}
  203. confirmLabel="Delete secret"
  204. confirmLabelLoading="Deleting secret"
  205. title={`Delete secret “${selectedSecretToDelete?.name}”`}
  206. onCancel={() => setSelectedIdToDelete(null)}
  207. onConfirm={() => {
  208. if (selectedSecretToDelete) {
  209. deleteSecret({ projectRef, secrets: [selectedSecretToDelete.name] })
  210. }
  211. }}
  212. >
  213. <p className="text-sm">
  214. Ensure none of your edge functions are actively using this secret before deleting it. This
  215. action cannot be undone.
  216. </p>
  217. </ConfirmationModal>
  218. </>
  219. )
  220. }