Skip to content

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

14.1 KB
Raw Blame
import { keepPreviousData } from '@tanstack/react-query'
import {
  getCoreRowModel,
  getSortedRowModel,
  useReactTable,
  type RowSelectionState,
  type SortingState,
} from '@tanstack/react-table'
import { useParams } from 'common'
import dayjs from 'dayjs'
import { RefreshCwIcon } from 'lucide-react'
import { useEffect, useMemo, useRef, useState } from 'react'
import {
  Alert,
  AlertDescription,
  AlertTitle,
  cn,
  ResizablePanel,
  ResizablePanelGroup,
  WarningIcon,
} from 'ui'
import { FilterBar, type FilterGroup, type FilterProperty } from 'ui-patterns/FilterBar'
import { ShimmeringLoader } from 'ui-patterns/ShimmeringLoader'

import { AuditLogDetailsPanel } from '@/components/interfaces/AuditLogs/AuditLogDetailsPanel'
import { getAuditLogColumns } from '@/components/interfaces/AuditLogs/AuditLogs.columns'
import {
  DATE_FILTER_PROPERTY,
  filterByFilterGroup,
  findDateCondition,
  getDefaultAuditLogRange,
  PROJECT_FILTER_PROPERTY,
  USER_FILTER_PROPERTY,
} from '@/components/interfaces/AuditLogs/AuditLogs.utils'
import {
  DateRangeOption,
  formatDateRangeValue,
} from '@/components/interfaces/AuditLogs/AuditLogsDateRangeOption'
import { createAuditLogsProjectOption } from '@/components/interfaces/AuditLogs/AuditLogsProjectOption'
import { AuditLogsSelectionHeader } from '@/components/interfaces/AuditLogs/AuditLogsSelectionHeader'
import { AuditLogsTable } from '@/components/interfaces/AuditLogs/AuditLogsTable'
import { createAuditLogsUserOption } from '@/components/interfaces/AuditLogs/AuditLogsUserOption'
import {
  parseTimeRange,
  serializeTimeRange,
} from '@/components/interfaces/Settings/Logs/Logs.timeRange'
import { ScaffoldContainer, ScaffoldSection } from '@/components/layouts/Scaffold'
import { AlertError } from '@/components/ui/AlertError'
import { ButtonTooltip } from '@/components/ui/ButtonTooltip'
import { NoPermission } from '@/components/ui/NoPermission'
import { UpgradeToPro } from '@/components/ui/UpgradeToPro'
import {
  AuditLog,
  useOrganizationAuditLogsQuery,
} from '@/data/organizations/organization-audit-logs-query'
import { useOrganizationMembersQuery } from '@/data/organizations/organization-members-query'
import { useOrgProjectsInfiniteQuery } from '@/data/projects/org-projects-infinite-query'
import { useCheckEntitlements } from '@/hooks/misc/useCheckEntitlements'
import { FGA_PERMISSIONS, useAsyncCheckPermissionsV2 } from '@/hooks/misc/useCheckPermissionsV2'
import { useSelectedOrganizationQuery } from '@/hooks/misc/useSelectedOrganization'
import { SHORTCUT_IDS } from '@/state/shortcuts/registry'
import { useShortcut } from '@/state/shortcuts/useShortcut'

const CONTENT_PADDING = 'w-full px-6 xl:px-9'
const logsUpgradeError = 'upgrade to Team or Enterprise Plan to access audit logs.'

export const AuditLogs = () => {
  const { slug } = useParams()

  const [dateRange, setDateRange] = useState(getDefaultAuditLogRange)
  const [selectedLog, setSelectedLog] = useState<AuditLog>()
  const [filterGroup, setFilterGroup] = useState<FilterGroup>(() => ({
    logicalOperator: 'AND',
    conditions: [
      {
        propertyName: DATE_FILTER_PROPERTY,
        operator: '=',
        value: serializeTimeRange([new Date(dateRange.from), new Date(dateRange.to)]),
      },
    ],
  }))
  const [freeformText, setFreeformText] = useState('')
  const [projectNames, setProjectNames] = useState<Record<string, string>>({})

  const handleSelectProject = (project: { ref: string; name: string }) =>
    setProjectNames((prev) => ({ ...prev, [project.ref]: project.name }))

  const handleFilterChange = (next: FilterGroup) => {
    setFilterGroup(next)
    // The API call is driven by `dateRange`, so keep it in sync with the date chip
    const dateCondition = findDateCondition(next)
    if (!dateCondition) {
      setDateRange(getDefaultAuditLogRange())
      return
    }
    const range = parseTimeRange(dateCondition.value)
    if (range) setDateRange({ from: range[0].toISOString(), to: range[1].toISOString() })
  }

  const { can: canReadAuditLogs, isLoading: isLoadingPermissions } = useAsyncCheckPermissionsV2(
    FGA_PERMISSIONS.ORGANIZATION.AUDIT_LOGS_READ
  )

  const { hasAccess: hasAccessToAuditLogs, isLoading: isLoadingEntitlements } =
    useCheckEntitlements('security.audit_logs_days')

  const {
    data,
    error,
    isPending: isLoading,
    isSuccess,
    isError,
    isRefetching,
    fetchStatus,
    refetch,
  } = useOrganizationAuditLogsQuery(
    {
      slug,
      iso_timestamp_start: dateRange.from,
      iso_timestamp_end: dateRange.to,
    },
    {
      enabled: canReadAuditLogs,
      retry: false,
      placeholderData: (previousData, previousQuery) =>
        previousQuery?.queryKey[1] === slug ? previousData : undefined,
      refetchOnWindowFocus: (query) => {
        return !query.state.error?.message.endsWith(logsUpgradeError)
      },
    }
  )

  const isLogsNotAvailableBasedOnPlan = isError && !hasAccessToAuditLogs
  const isRangeExceededError = isError && error.message.includes('range exceeded')
  const showFilters = !isLoading && !isLogsNotAvailableBasedOnPlan

  const { data: projectsData, isPending: isLoadingProjects } = useOrgProjectsInfiniteQuery(
    { slug },
    { placeholderData: keepPreviousData, enabled: showFilters }
  )
  const projects = useMemo(
    () => projectsData?.pages.flatMap((page) => page.projects) ?? [],
    [projectsData?.pages]
  )

  const { data: selectedOrganization, isLoading: isLoadingOrganizations } =
    useSelectedOrganizationQuery({ enabled: showFilters })
  const organizations = useMemo(
    () => (selectedOrganization ? [selectedOrganization] : []),
    [selectedOrganization]
  )

  const { data: members } = useOrganizationMembersQuery({ slug }, { enabled: showFilters })

  const logs = useMemo(() => data?.result ?? [], [data?.result])
  const filteredLogs = useMemo(() => filterByFilterGroup(logs, filterGroup), [logs, filterGroup])

  const hasDateFilter = !!findDateCondition(filterGroup)
  const filterProperties: FilterProperty[] = [
    {
      label: 'User',
      name: USER_FILTER_PROPERTY,
      type: 'string',
      operators: ['='],
      options: { component: createAuditLogsUserOption(slug) },
      formatValue: (value) => {
        const id = String(value ?? '')
        return members?.find((member) => member.gotrue_id === id)?.username ?? id
      },
    },
    {
      label: 'Project',
      name: PROJECT_FILTER_PROPERTY,
      type: 'string',
      operators: ['='],
      options: { component: createAuditLogsProjectOption(handleSelectProject, slug) },
      formatValue: (value) => {
        const ref = String(value ?? '')
        return projectNames[ref] ?? projects.find((p) => p.ref === ref)?.name ?? ref
      },
    },
    {
      label: 'Date range',
      name: DATE_FILTER_PROPERTY,
      type: 'date',
      operators: [{ label: 'Equals', value: '=', group: 'comparison' }],
      options: { component: DateRangeOption },
      formatValue: formatDateRangeValue,
      isAvailable: !hasDateFilter,
      topLevelOnly: true,
    },
  ]

  const lastSelectedRowId = useRef<string | null>(null)
  const columns = useMemo(
    () =>
      getAuditLogColumns({
        projects,
        organizations,
        members,
        lastSelectedRowId,
        isLoadingProjects,
        isLoadingOrganizations,
      }),
    [projects, organizations, members, isLoadingProjects, isLoadingOrganizations]
  )
  const [sorting, setSorting] = useState<SortingState>([{ id: 'date', desc: true }])
  const [rowSelection, setRowSelection] = useState<RowSelectionState>({})

  const table = useReactTable({
    data: filteredLogs,
    columns,
    state: { sorting, rowSelection },
    enableMultiRowSelection: true,
    getRowId: (row) => row.request_id,
    onSortingChange: setSorting,
    onRowSelectionChange: setRowSelection,
    getCoreRowModel: getCoreRowModel(),
    getSortedRowModel: getSortedRowModel(),
  })

  const shouldShowLoadingState =
    (isLoading && fetchStatus !== 'idle') || isLoadingPermissions || isLoadingEntitlements

  useShortcut(SHORTCUT_IDS.ORG_AUDIT_LOGS_REFRESH, () => refetch(), {
    enabled: !isLoading && !isRefetching && canReadAuditLogs,
  })

  useEffect(() => {
    setRowSelection({})
    lastSelectedRowId.current = null
  }, [filterGroup])

  // This feature depends on the subscription tier of the user.
  // The API limits the logs to maximum of 62 days and 5 minutes so when the page is
  // viewed for more than 5 minutes, the call parameters needs to be updated. This also works with
  // higher tiers. The user will see a loading shimmer.
  useEffect(() => {
    const duration = dayjs(dateRange.from).diff(dayjs(dateRange.to))
    const interval = setInterval(() => {
      const currentTime = dayjs().utc().set('millisecond', 0)
      setDateRange({
        from: currentTime.add(duration).toISOString(),
        to: currentTime.toISOString(),
      })
    }, 5 * 60000)

    return () => clearInterval(interval)
  }, [dateRange.from, dateRange.to])

  if (isLogsNotAvailableBasedOnPlan) {
    return (
      <ScaffoldContainer className="px-6 xl:px-10">
        <ScaffoldSection isFullWidth>
          <UpgradeToPro
            plan="Team"
            source="organizationAuditLogs"
            primaryText="Organization Audit Logs are not available on Free or Pro plans"
            secondaryText="Upgrade to Team or Enterprise to view up to 62 days of Audit Logs for your organization."
            featureProposition="enable audit logs"
          />
        </ScaffoldSection>
      </ScaffoldContainer>
    )
  }

  return (
    <ScaffoldContainer size="full" className="px-0 h-full flex flex-col">
      <ScaffoldSection isFullWidth className="pt-6! pb-0! flex-1 min-h-0">
        <div className="flex flex-col h-full min-h-0">
          {shouldShowLoadingState && (
            <div className={cn(CONTENT_PADDING, 'space-y-2')}>
              <ShimmeringLoader />
              <ShimmeringLoader className="w-3/4" />
              <ShimmeringLoader className="w-1/2" />
            </div>
          )}

          {!shouldShowLoadingState && !canReadAuditLogs && (
            <div className={CONTENT_PADDING}>
              <NoPermission resourceText="view organization audit logs" />
            </div>
          )}

          {isError && (
            <div className={CONTENT_PADDING}>
              {isRangeExceededError ? (
                <Alert variant="destructive" title="Date range too large">
                  <WarningIcon />
                  <AlertTitle>Date range too large</AlertTitle>
                  <AlertDescription>
                    The selected date range exceeds the maximum allowed period. Please select a
                    smaller time range.
                  </AlertDescription>
                </Alert>
              ) : (
                <AlertError error={error} subject="Failed to retrieve audit logs" />
              )}
            </div>
          )}

          {isSuccess && (
            <>
              {showFilters && (
                <div className="border-t py-2 pl-1 pr-4 flex flex-col md:flex-row justify-between">
                  <FilterBar
                    supportsOperators
                    variant="pill"
                    defaultGroupOperator="OR"
                    className="bg-transparent border-0 [&>div>div>div>input]:!text-xs [&_[data-testid=filter-bar-freeform-input]]:min-w-64"
                    filterProperties={filterProperties}
                    freeformText={freeformText}
                    filters={filterGroup}
                    onFilterChange={handleFilterChange}
                    onFreeformTextChange={setFreeformText}
                  />
                  <ButtonTooltip
                    disabled={isLoading}
                    loading={isLoading || isRefetching}
                    className="w-7"
                    icon={<RefreshCwIcon />}
                    onClick={() => refetch()}
                    tooltip={{ content: { side: 'bottom', text: 'Refresh logs' } }}
                  />
                </div>
              )}

              {logs.length === 0 ? (
                <div className={cn(CONTENT_PADDING, 'border-t pt-4')}>
                  <div className="bg-surface-100 border rounded-sm p-4 flex items-center justify-between">
                    <p className="prose text-sm">
                      Your organization does not have any audit logs available yet
                    </p>
                  </div>
                </div>
              ) : logs.length > 0 && filteredLogs.length === 0 ? (
                <div className={cn(CONTENT_PADDING, 'border-t pt-4')}>
                  <div className="bg-surface-100 border rounded-sm p-4 flex items-center justify-between">
                    <p className="prose text-sm">
                      No audit logs found based on the filters applied
                    </p>
                  </div>
                </div>
              ) : (
                <div className="border-y overflow-hidden flex-1 min-h-0">
                  <ResizablePanelGroup orientation="horizontal" className="h-full">
                    <ResizablePanel
                      defaultSize={100}
                      minSize={30}
                      className="flex flex-col overflow-hidden"
                    >
                      <div className="grow relative overflow-hidden">
                        <AuditLogsSelectionHeader table={table} />
                        <AuditLogsTable
                          table={table}
                          selectedLog={selectedLog}
                          onSelectLog={(log) =>
                            setSelectedLog((prev) =>
                              prev?.request_id === log.request_id ? undefined : log
                            )
                          }
                        />
                      </div>
                    </ResizablePanel>
                    {selectedLog && (
                      <AuditLogDetailsPanel
                        selectedLog={selectedLog}
                        onClose={() => setSelectedLog(undefined)}
                      />
                    )}
                  </ResizablePanelGroup>
                </div>
              )}
            </>
          )}
        </div>
      </ScaffoldSection>
    </ScaffoldContainer>
  )
}