The Postgres development platform. Supabase gives you a dedicated Postgres database to build your web, mobile, and AI applications.
TypeScript aialternativeauthdatabasedenoembeddingsexamplefirebasenextjsoauth2pgvectorpostgispostgrespostgresqlpostgrestrealtimesupabasevectorswebsockets
import { acceptUntrustedSql, safeSql } from '@supabase/pg-meta'
import { useQuery } from '@tanstack/react-query'
import { useParams } from 'common'
import { XIcon } from 'lucide-react'
import { useEffect, useState } from 'react'
import { toast } from 'sonner'
import { BURSTABLE_IO_METRIC_KEYS, DEPRECATED_REPORTS } from '../Reports.constants'
import { ChartBlock } from './ChartBlock'
import { DeprecatedChartBlock } from './DeprecatedChartBlock'
import { LogsSnippetReportBlock } from './LogsSnippetReportBlock'
import { UnavailableChartBlock } from './UnavailableChartBlock'
import { hasBurstableIO } from '@/components/interfaces/DiskManagement/DiskManagement.utils'
import { ChartConfig } from '@/components/interfaces/SQLEditor/UtilityPanel/ChartConfig'
import { ButtonTooltip } from '@/components/ui/ButtonTooltip'
import { DEFAULT_CHART_CONFIG, QueryBlock } from '@/components/ui/QueryBlock/QueryBlock'
import { AnalyticsInterval } from '@/data/analytics/constants'
import { useContentIdQuery } from '@/data/content/content-id-query'
import { usePrimaryDatabase } from '@/data/read-replicas/replicas-query'
import { executeSql } from '@/data/sql/execute-sql-mutation'
import { sqlKeys } from '@/data/sql/keys'
import { applyAutoLimit } from '@/data/sql/utils'
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
import { useDatabaseSelectorStateSnapshot } from '@/state/database-selector'
import type { Dashboards, SqlSnippets } from '@/types'
interface ReportBlockProps {
item: Dashboards.Chart
startDate: string
endDate: string
interval: AnalyticsInterval
disableUpdate: boolean
isRefreshing: boolean
onRemoveChart: ({ metric }: { metric: { key: string } }) => void
onUpdateChart: ({
chart,
chartConfig,
}: {
chart?: Partial<Dashboards.Chart>
chartConfig?: Partial<ChartConfig>
}) => void
}
export const ReportBlock = ({
item,
startDate,
endDate,
interval,
disableUpdate,
isRefreshing,
onRemoveChart,
onUpdateChart,
}: ReportBlockProps) => {
const { ref: projectRef } = useParams()
const state = useDatabaseSelectorStateSnapshot()
const { data: project } = useSelectedProjectQuery()
const [isWriteQuery, setIsWriteQuery] = useState(false)
const isSnippet = item.attribute.startsWith('snippet_')
const isUnavailableBurstChart =
BURSTABLE_IO_METRIC_KEYS.includes(item.attribute) &&
!hasBurstableIO(project?.infra_compute_size)
const {
data,
error: contentError,
isPending: isLoadingContent,
} = useContentIdQuery(
{ projectRef, id: item.id },
{
enabled: isSnippet && !!item.id,
refetchOnWindowFocus: false,
refetchOnMount: false,
refetchIntervalInBackground: false,
retry: (failureCount: number, error) => {
if (error.code === 404 || failureCount >= 2) return false
return true
},
}
)
const isLogsSnippet = data?.type === 'log_sql'
const autoLimit = 100
const sql =
isSnippet && !isLogsSnippet ? (data?.content as SqlSnippets.Content)?.unchecked_sql : undefined
// acceptUntrustedSql is usually not allowed outside a user-action event
// handler, but it's explicitly fine here: adding this block to a report is
// itself the user action that approves running its SQL.
const acceptedSql = sql !== undefined ? acceptUntrustedSql(sql) : safeSql``
const { sql: formattedSql, appendAutoLimit } = applyAutoLimit(acceptedSql, autoLimit)
const chartConfig = { ...DEFAULT_CHART_CONFIG, ...(item.chartConfig ?? {}) }
const isDeprecatedChart = DEPRECATED_REPORTS.includes(item.attribute)
const snippetMissing = contentError?.message.includes('Content not found')
const { database: primaryDatabase } = usePrimaryDatabase({ projectRef })
const readOnlyConnectionString = primaryDatabase?.connection_string_read_only
const postgresConnectionString = primaryDatabase?.connectionString
const {
data: queryResult,
error: executeSqlError,
isPending: executeSqlLoading,
refetch,
} = useQuery({
// eslint-disable-next-line @tanstack/query/exhaustive-deps -- formattedSql/appendAutoLimit are fully derived from sql/autoLimit, both already in the key
queryKey: sqlKeys.query(projectRef, [
item.id,
sql,
readOnlyConnectionString,
postgresConnectionString,
autoLimit,
]),
queryFn: async () => {
if (!projectRef || !sql) return null
const connectionString = readOnlyConnectionString ?? postgresConnectionString
if (!connectionString) {
toast.error('Unable to establish a database connection for this project.')
return null
}
return executeSql({
projectRef,
connectionString,
sql: formattedSql,
})
},
enabled: !isLoadingContent && contentError == null && !isLogsSnippet,
refetchOnWindowFocus: false,
})
const rows = queryResult?.result
useEffect(() => {
if (executeSqlError) {
const errorMessage = String(executeSqlError).toLowerCase()
const isReadOnlyError =
errorMessage.includes('read-only transaction') ||
errorMessage.includes('permission denied') ||
errorMessage.includes('must be owner')
if (isReadOnlyError) {
setIsWriteQuery(true)
}
}
}, [executeSqlError])
useEffect(() => {
if (isRefreshing) {
refetch()
}
}, [isRefreshing, refetch])
if (isLogsSnippet) {
return (
<LogsSnippetReportBlock
label={item.label}
actions={
!disableUpdate ? (
<ButtonTooltip
variant="text"
icon={<XIcon />}
className="w-7 h-7"
onClick={() => onRemoveChart({ metric: { key: item.attribute } })}
tooltip={{ content: { side: 'bottom', text: 'Remove chart' } }}
/>
) : null
}
/>
)
}
return (
<>
{isSnippet ? (
<QueryBlock
blockWriteQueries
portalTooltip
id={item.id}
label={item.label}
chartConfig={chartConfig}
sql={sql}
results={rows}
initialHideSql={true}
errorText={
snippetMissing
? 'SQL snippet not found'
: executeSqlError
? String(executeSqlError)
: undefined
}
isExecuting={!contentError && executeSqlLoading}
isWriteQuery={isWriteQuery}
actions={
<ButtonTooltip
variant="text"
icon={<XIcon />}
className="w-7 h-7"
onClick={() => onRemoveChart({ metric: { key: item.attribute } })}
tooltip={{ content: { side: 'bottom', text: 'Remove chart' } }}
/>
}
onExecute={(_queryType) => {
refetch()
}}
onUpdateChartConfig={onUpdateChart}
onRemoveChart={() => onRemoveChart({ metric: { key: item.attribute } })}
disabled={isLoadingContent || snippetMissing || !sql}
autoLimit={appendAutoLimit}
/>
) : isUnavailableBurstChart ? (
<UnavailableChartBlock
label={item.label}
actions={
!disableUpdate ? (
<ButtonTooltip
variant="text"
icon={<XIcon />}
className="h-7 w-7"
onClick={() => onRemoveChart({ metric: { key: item.attribute } })}
tooltip={{ content: { side: 'bottom', text: 'Remove chart' } }}
/>
) : null
}
/>
) : isDeprecatedChart ? (
<DeprecatedChartBlock
attribute={item.attribute}
label={`${item.label}${projectRef !== state.selectedDatabaseId ? (item.provider === 'infra-monitoring' ? ' of replica' : ' on project') : ''}`}
actions={
!disableUpdate ? (
<ButtonTooltip
variant="text"
icon={<XIcon />}
className="w-7 h-7"
onClick={() => onRemoveChart({ metric: { key: item.attribute } })}
tooltip={{ content: { side: 'bottom', text: 'Remove chart' } }}
/>
) : null
}
/>
) : (
<ChartBlock
startDate={startDate}
endDate={endDate}
interval={interval}
attribute={item.attribute}
provider={item.provider}
defaultChartStyle={item.chart_type}
defaultLogScale={chartConfig?.logScale ?? false}
maxHeight={176}
label={`${item.label}${projectRef !== state.selectedDatabaseId ? (item.provider === 'infra-monitoring' ? ' of replica' : ' on project') : ''}`}
actions={
!disableUpdate ? (
<ButtonTooltip
variant="text"
icon={<XIcon />}
className="w-7 h-7"
onClick={() => onRemoveChart({ metric: { key: item.attribute } })}
tooltip={{ content: { side: 'bottom', text: 'Remove chart' } }}
/>
) : null
}
onUpdateChartConfig={onUpdateChart}
/>
)}
</>
)
}