Files
supabase/apps/studio/hooks/analytics/useProjectUsageStats.tsx
T
Saxon FletcherandJoshen Lim 3bea8f5bf0 Home New: Project Usage (#38339)
* new home top

* advisors

* add project usage section

* fix ts

* postgres

* add advisor section

* Nit

* Nit

* Attempt to fix ui library build issue

* Revert changes to Row/index.tsx

* Fix icon positioning

---------

Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
2025-09-12 09:34:28 +10:00

121 lines
3.0 KiB
TypeScript

import { useQuery } from '@tanstack/react-query'
import { useMemo } from 'react'
import { LogsTableName } from 'components/interfaces/Settings/Logs/Logs.constants'
import type {
EventChart,
EventChartData,
Filters,
LogsEndpointParams,
} from 'components/interfaces/Settings/Logs/Logs.types'
import { genChartQuery } from 'components/interfaces/Settings/Logs/Logs.utils'
import { get } from 'data/fetchers'
import { useFillTimeseriesSorted } from './useFillTimeseriesSorted'
import useTimeseriesUnixToIso from './useTimeseriesUnixToIso'
interface ProjectUsageStatsHookResult {
error: string | Object | null
isLoading: boolean
filters: Filters
params: LogsEndpointParams
eventChartData: EventChartData[]
refresh: () => void
}
function useProjectUsageStats({
projectRef,
table,
timestampStart,
timestampEnd,
filterOverride,
}: {
projectRef: string
table: LogsTableName
timestampStart: string
timestampEnd: string
filterOverride?: Filters
}): ProjectUsageStatsHookResult {
const filterOverrideString = JSON.stringify(filterOverride)
const mergedFilters = useMemo(
() => ({
...filterOverride,
}),
[filterOverrideString]
)
const params: LogsEndpointParams = useMemo(() => {
return { iso_timestamp_start: timestampStart, iso_timestamp_end: timestampEnd }
}, [timestampStart, timestampEnd])
const chartQuery = useMemo(
() => genChartQuery(table, params, mergedFilters),
[table, params, mergedFilters]
)
const chartQueryKey = useMemo(
() => [
'projects',
projectRef,
'logs-chart',
table,
{
projectRef,
sql: chartQuery,
iso_timestamp_start: timestampStart,
iso_timestamp_end: timestampEnd,
},
],
[projectRef, chartQuery, timestampStart, timestampEnd, table]
)
const { data: eventChartResponse, refetch: refreshEventChart } = useQuery(
chartQueryKey,
async ({ signal }) => {
const { data, error } = await get(`/platform/projects/{ref}/analytics/endpoints/logs.all`, {
params: {
path: { ref: projectRef },
query: {
iso_timestamp_start: timestampStart,
iso_timestamp_end: timestampEnd,
sql: chartQuery,
},
},
signal,
})
if (error) {
throw error
}
return data as unknown as EventChart
},
{
refetchOnWindowFocus: false,
enabled: typeof projectRef !== 'undefined',
}
)
const normalizedEventChartData = useTimeseriesUnixToIso(
eventChartResponse?.result ?? [],
'timestamp'
)
const { data: eventChartData, error: eventChartError } = useFillTimeseriesSorted(
normalizedEventChartData,
'timestamp',
'count',
0,
timestampStart,
timestampEnd || new Date().toISOString()
)
return {
isLoading: !eventChartResponse,
error: eventChartError,
filters: mergedFilters,
params,
eventChartData,
refresh: refreshEventChart,
}
}
export default useProjectUsageStats