Skip to content

The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.

5.8 KB
Raw Blame
import { zodResolver } from '@hookform/resolvers/zod'
import { useQuery } from '@tanstack/react-query'
import { useParams } from 'common'
import { useEffect, useMemo } from 'react'
import { SubmitHandler, useForm } from 'react-hook-form'
import { toast } from 'sonner'
import { Button, Card, CardContent, CardFooter, Form, FormControl, FormField, Switch } from 'ui'
import { FormItemLayout } from 'ui-patterns/form/FormItemLayout/FormItemLayout'
import {
  PageSection,
  PageSectionAside,
  PageSectionContent,
  PageSectionMeta,
  PageSectionSummary,
  PageSectionTitle,
} from 'ui-patterns/PageSection'
import z from 'zod'

import { AlertError } from '@/components/ui/AlertError'
import { ButtonTooltip } from '@/components/ui/ButtonTooltip'
import { DocsButton } from '@/components/ui/DocsButton'
import { usePostgresConfigurationUpdateMutation } from '@/data/config/postgres-config-mutation'
import { postgresConfigurationQueryOptions } from '@/data/config/postgres-config-query'
import { FGA_PERMISSIONS, useAsyncCheckPermissionsV2 } from '@/hooks/misc/useCheckPermissionsV2'
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
import { DOCS_URL } from '@/lib/constants'

const FormSchema = z.object({
  log_connections: z.boolean(),
  log_disconnections: z.boolean(),
})

export const ConnectionLogging = () => {
  const { ref: projectRef } = useParams()
  const { data: project } = useSelectedProjectQuery()
  const { can: canUpdatePostgresConfiguration } = useAsyncCheckPermissionsV2(
    FGA_PERMISSIONS.PROJECT.DATABASE_CONFIG_WRITE,
    { projectRef: project?.parentRef }
  )

  const {
    data: postgresConfig,
    error,
    isSuccess,
    isError,
  } = useQuery(postgresConfigurationQueryOptions({ projectRef }))

  const { mutate: updatePostgresConfig, isPending: isSaving } =
    usePostgresConfigurationUpdateMutation({
      onSuccess: () => toast('Successfully updated logging settings'),
    })

  const defaultValues = useMemo(
    () => ({
      log_connections: postgresConfig?.log_connections ?? false,
      log_disconnections: postgresConfig?.log_disconnections ?? false,
    }),
    [postgresConfig]
  )

  const form = useForm<z.infer<typeof FormSchema>>({
    resolver: zodResolver(FormSchema),
    values: defaultValues,
  })
  const hasChanges = form.formState.isDirty

  const onSubmit: SubmitHandler<z.infer<typeof FormSchema>> = (payload) => {
    if (!projectRef) return
    updatePostgresConfig({ projectRef, payload })
  }

  useEffect(() => {
    if (isSuccess) form.reset(defaultValues)
  }, [isSuccess, defaultValues, form])

  return (
    <PageSection id="log-connections">
      <PageSectionMeta>
        <PageSectionSummary>
          <PageSectionTitle>Connection logging</PageSectionTitle>
        </PageSectionSummary>
        <PageSectionAside className="flex items-center gap-x-2">
          <DocsButton href={`${DOCS_URL}/guides/platform/postgres-connection-logging`} />
        </PageSectionAside>
      </PageSectionMeta>
      <PageSectionContent>
        {isError ? (
          <AlertError error={error} subject="Failed to retrieve Postgres configuration" />
        ) : (
          <Form {...form}>
            <form onSubmit={form.handleSubmit(onSubmit)}>
              <Card>
                <CardContent>
                  <FormField
                    control={form.control}
                    name="log_connections"
                    render={({ field }) => (
                      <FormItemLayout
                        layout="flex-row-reverse"
                        label="Log connections"
                        description="Enables logging for each successful connection to the database"
                        className="[&>div:first-child]:xl:w-1/5"
                      >
                        <FormControl>
                          <Switch checked={field.value} onCheckedChange={field.onChange} />
                        </FormControl>
                      </FormItemLayout>
                    )}
                  />
                </CardContent>
                <CardContent>
                  <FormField
                    control={form.control}
                    name="log_disconnections"
                    render={({ field }) => (
                      <FormItemLayout
                        layout="flex-row-reverse"
                        label="Log disconnections"
                        description="Enables logging for the end of each session, including its duration"
                        className="[&>div:first-child]:xl:w-1/5"
                      >
                        <FormControl>
                          <Switch checked={field.value} onCheckedChange={field.onChange} />
                        </FormControl>
                      </FormItemLayout>
                    )}
                  />
                </CardContent>
                <CardFooter className="gap-x-2 justify-end">
                  <Button
                    type="button"
                    disabled={!hasChanges || isSaving}
                    onClick={() => form.reset(defaultValues)}
                  >
                    Cancel
                  </Button>
                  <ButtonTooltip
                    type="submit"
                    variant="primary"
                    loading={isSaving}
                    disabled={!hasChanges || !canUpdatePostgresConfiguration}
                    tooltip={{
                      content: {
                        side: 'bottom',
                        text: !canUpdatePostgresConfiguration
                          ? 'You need additional permissions to update this setting'
                          : undefined,
                      },
                    }}
                  >
                    Save
                  </ButtonTooltip>
                </CardFooter>
              </Card>
            </form>
          </Form>
        )}
      </PageSectionContent>
    </PageSection>
  )
}