Files
supabase/apps/studio/components/interfaces/HomeNew/ProjectUsageSection.tsx
T
Pamela ChiaandJoshen Lim b3b5652555 Feat/add tracking and phflag for new home (#38853)
* add phflag

* track homev2 clicks

* track v2 drags

* remove old home tracking and extra visibility tracking

* add advisor, usage, and report clicks

* fix import type

* track remove charts from home

* rename actions to follow conventions

* fix lints

* simplify activity stats and add issue count property

* reduce useSelectedProjectQuery

* revert onClick and improve event properties

* Fix broken images

---------

Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
2025-09-23 21:22:27 +08:00

439 lines
16 KiB
TypeScript

import dayjs from 'dayjs'
import { Archive, ChevronDown, Code, Database, Key, Zap } from 'lucide-react'
import Link from 'next/link'
import { useRouter } from 'next/router'
import { useMemo, useState } from 'react'
import { useParams } from 'common'
import NoDataPlaceholder from 'components/ui/Charts/NoDataPlaceholder'
import { InlineLink } from 'components/ui/InlineLink'
import { useSendEventMutation } from 'data/telemetry/send-event-mutation'
import useProjectUsageStats from 'hooks/analytics/useProjectUsageStats'
import { useCurrentOrgPlan } from 'hooks/misc/useCurrentOrgPlan'
import { useIsFeatureEnabled } from 'hooks/misc/useIsFeatureEnabled'
import { useSelectedOrganizationQuery } from 'hooks/misc/useSelectedOrganization'
import type { ChartIntervals } from 'types'
import {
Button,
Card,
CardContent,
CardHeader,
CardTitle,
DropdownMenu,
DropdownMenuContent,
DropdownMenuRadioGroup,
DropdownMenuRadioItem,
DropdownMenuTrigger,
Loading,
Tooltip,
TooltipContent,
TooltipTrigger,
cn,
} from 'ui'
import { Row } from 'ui-patterns'
import { LogsBarChart } from 'ui-patterns/LogsBarChart'
import { useServiceStats } from './ProjectUsageSection.utils'
const LOG_RETENTION = { free: 1, pro: 7, team: 28, enterprise: 90 }
const CHART_INTERVALS: ChartIntervals[] = [
{
key: '1hr',
label: 'Last 60 minutes',
startValue: 1,
startUnit: 'hour',
format: 'MMM D, h:mma',
availableIn: ['free', 'pro', 'team', 'enterprise'],
},
{
key: '1day',
label: 'Last 24 hours',
startValue: 24,
startUnit: 'hour',
format: 'MMM D, ha',
availableIn: ['free', 'pro', 'team', 'enterprise'],
},
{
key: '7day',
label: 'Last 7 days',
startValue: 7,
startUnit: 'day',
format: 'MMM D',
availableIn: ['pro', 'team', 'enterprise'],
},
]
type ChartIntervalKey = '1hr' | '1day' | '7day'
type LogsBarChartDatum = {
timestamp: string
error_count: number
ok_count: number
warning_count: number
}
type ServiceKey = 'db' | 'functions' | 'auth' | 'storage' | 'realtime'
type ServiceEntry = {
key: ServiceKey
title: string
icon: React.ReactNode
href?: string
route: string
enabled: boolean
}
type ServiceComputed = ServiceEntry & {
data: LogsBarChartDatum[]
total: number
warn: number
err: number
stats: ReturnType<typeof useProjectUsageStats>
}
export const ProjectUsageSection = () => {
const router = useRouter()
const { ref: projectRef } = useParams()
const { data: organization } = useSelectedOrganizationQuery()
const { mutate: sendEvent } = useSendEventMutation()
const { projectAuthAll: authEnabled, projectStorageAll: storageEnabled } = useIsFeatureEnabled([
'project_auth:all',
'project_storage:all',
])
const { plan } = useCurrentOrgPlan()
const DEFAULT_INTERVAL: ChartIntervalKey = plan?.id === 'free' ? '1hr' : '1day'
const [interval, setInterval] = useState<ChartIntervalKey>(DEFAULT_INTERVAL)
const selectedInterval = CHART_INTERVALS.find((i) => i.key === interval) || CHART_INTERVALS[1]
const { timestampStart, timestampEnd, datetimeFormat } = useMemo(() => {
const startDateLocal = dayjs().subtract(
selectedInterval.startValue,
selectedInterval.startUnit as dayjs.ManipulateType
)
const endDateLocal = dayjs()
const format = selectedInterval.format || 'MMM D, ha'
return {
timestampStart: startDateLocal.toISOString(),
timestampEnd: endDateLocal.toISOString(),
datetimeFormat: format,
}
}, [selectedInterval]) // Only recalculate when interval changes
const { previousStart, previousEnd } = useMemo(() => {
const currentStart = dayjs(timestampStart)
const currentEnd = dayjs(timestampEnd)
const durationMs = currentEnd.diff(currentStart)
const prevEnd = currentStart
const prevStart = currentStart.subtract(durationMs, 'millisecond')
return { previousStart: prevStart.toISOString(), previousEnd: prevEnd.toISOString() }
}, [timestampStart, timestampEnd])
const statsByService = useServiceStats(
projectRef as string,
timestampStart,
timestampEnd,
previousStart,
previousEnd
)
const toLogsBarChartData = (rows: any[] = []): LogsBarChartDatum[] => {
return rows.map((r) => ({
timestamp: String(r.timestamp),
ok_count: Number(r.ok_count || 0),
warning_count: Number(r.warning_count || 0),
error_count: Number(r.error_count || 0),
}))
}
const sumTotal = (data: LogsBarChartDatum[]) =>
data.reduce((acc, r) => acc + r.ok_count + r.warning_count + r.error_count, 0)
const sumWarnings = (data: LogsBarChartDatum[]) =>
data.reduce((acc, r) => acc + r.warning_count, 0)
const sumErrors = (data: LogsBarChartDatum[]) => data.reduce((acc, r) => acc + r.error_count, 0)
const serviceBase: ServiceEntry[] = useMemo(
() => [
{
key: 'db',
title: 'Database requests',
icon: <Database strokeWidth={1.5} size={16} className="text-foreground-lighter" />,
href: `/project/${projectRef}/editor`,
route: '/logs/postgres-logs',
enabled: true,
},
{
key: 'functions',
title: 'Functions requests',
icon: <Code strokeWidth={1.5} size={16} className="text-foreground-lighter" />,
route: '/logs/edge-functions-logs',
enabled: true,
},
{
key: 'auth',
title: 'Auth requests',
icon: <Key strokeWidth={1.5} size={16} className="text-foreground-lighter" />,
href: `/project/${projectRef}/auth/users`,
route: '/logs/auth-logs',
enabled: authEnabled,
},
{
key: 'storage',
title: 'Storage requests',
icon: <Archive strokeWidth={1.5} size={16} className="text-foreground-lighter" />,
href: `/project/${projectRef}/storage/buckets`,
route: '/logs/storage-logs',
enabled: storageEnabled,
},
{
key: 'realtime',
title: 'Realtime requests',
icon: <Zap strokeWidth={1.5} size={16} className="text-foreground-lighter" />,
route: '/logs/realtime-logs',
enabled: true,
},
],
[projectRef, authEnabled, storageEnabled]
)
const services: ServiceComputed[] = useMemo(
() =>
serviceBase.map((s) => {
const currentStats = statsByService[s.key].current
const data = toLogsBarChartData(currentStats.eventChartData)
const total = sumTotal(data)
const warn = sumWarnings(data)
const err = sumErrors(data)
return { ...s, stats: currentStats, data, total, warn, err }
}),
[serviceBase, statsByService]
)
const isLoading = services.some((s) => s.stats.isLoading)
const handleBarClick = (logRoute: string, serviceKey: ServiceKey) => (datum: any) => {
if (!datum?.timestamp) return
const datumTimestamp = dayjs(datum.timestamp).toISOString()
const start = dayjs(datumTimestamp).subtract(1, 'minute').toISOString()
const end = dayjs(datumTimestamp).add(1, 'minute').toISOString()
const queryParams = new URLSearchParams({
iso_timestamp_start: start,
iso_timestamp_end: end,
})
router.push(`/project/${projectRef}${logRoute}?${queryParams.toString()}`)
if (projectRef && organization?.slug) {
sendEvent({
action: 'home_project_usage_chart_clicked',
properties: {
service_type: serviceKey,
bar_timestamp: datum.timestamp,
},
groups: {
project: projectRef,
organization: organization.slug,
},
})
}
}
const enabledServices = services.filter((s) => s.enabled)
const totalRequests = enabledServices.reduce((sum, s) => sum + (s.total || 0), 0)
const totalErrors = enabledServices.reduce((sum, s) => sum + (s.err || 0), 0)
const errorRate = totalRequests > 0 ? (totalErrors / totalRequests) * 100 : 0
const prevServiceTotals = useMemo(
() =>
serviceBase.map((s) => {
const previousStats = statsByService[s.key].previous
const data = toLogsBarChartData(previousStats.eventChartData)
return {
enabled: s.enabled,
total: sumTotal(data),
err: sumErrors(data),
}
}),
[serviceBase, statsByService]
)
const enabledPrev = prevServiceTotals.filter((s) => s.enabled)
const prevTotalRequests = enabledPrev.reduce((sum, s) => sum + (s.total || 0), 0)
const prevTotalErrors = enabledPrev.reduce((sum, s) => sum + (s.err || 0), 0)
const prevErrorRate = prevTotalRequests > 0 ? (prevTotalErrors / prevTotalRequests) * 100 : 0
const totalRequestsChangePct =
prevTotalRequests === 0
? totalRequests > 0
? 100
: 0
: ((totalRequests - prevTotalRequests) / prevTotalRequests) * 100
const errorRateChangePct =
prevErrorRate === 0
? errorRate > 0
? 100
: 0
: ((errorRate - prevErrorRate) / prevErrorRate) * 100
const formatDelta = (v: number) => `${v >= 0 ? '+' : ''}${v.toFixed(1)}%`
const totalDeltaClass = totalRequestsChangePct >= 0 ? 'text-brand' : 'text-destructive'
const errorDeltaClass = errorRateChangePct <= 0 ? 'text-brand' : 'text-destructive'
return (
<div className="space-y-6">
<div className="flex flex-row justify-between items-center gap-x-2">
<div className="flex flex-col md:flex-row md:items-center md:gap-6">
<div className="flex items-start gap-2 heading-section text-foreground-light">
<span className="text-foreground">{totalRequests.toLocaleString()}</span>
<span>Total Requests</span>
<span className={cn('text-sm', totalDeltaClass)}>
{formatDelta(totalRequestsChangePct)}
</span>
</div>
<div className="flex items-start gap-2 heading-section text-foreground-light">
<span className="text-foreground">{errorRate.toFixed(1)}%</span>
<span>Error Rate</span>
<span className={cn('text-sm', errorDeltaClass)}>
{formatDelta(errorRateChangePct)}
</span>
</div>
</div>
<DropdownMenu>
<DropdownMenuTrigger asChild>
<Button type="default" iconRight={<ChevronDown size={14} />}>
<span>{selectedInterval.label}</span>
</Button>
</DropdownMenuTrigger>
<DropdownMenuContent side="bottom" align="end" className="w-40">
<DropdownMenuRadioGroup
value={interval}
onValueChange={(interval) => setInterval(interval as ChartIntervalKey)}
>
{CHART_INTERVALS.map((i) => {
const disabled = !i.availableIn?.includes(plan?.id || 'free')
if (disabled) {
const retentionDuration = LOG_RETENTION[plan?.id ?? 'free']
return (
<Tooltip key={i.key}>
<TooltipTrigger asChild>
<DropdownMenuRadioItem
disabled
value={i.key}
className="!pointer-events-auto"
>
{i.label}
</DropdownMenuRadioItem>
</TooltipTrigger>
<TooltipContent side="left">
<p>
{plan?.name} plan only includes up to {retentionDuration} day
{retentionDuration > 1 ? 's' : ''} of log retention
</p>
<p className="text-foreground-light">
<InlineLink
className="text-foreground-light hover:text-foreground"
href={`/org/${organization?.slug}/billing?panel=subscriptionPlan`}
>
Upgrade your plan
</InlineLink>{' '}
to increase log retention and view statistics for the{' '}
{i.label.toLowerCase()}
</p>
</TooltipContent>
</Tooltip>
)
} else {
return (
<DropdownMenuRadioItem key={i.key} value={i.key}>
{i.label}
</DropdownMenuRadioItem>
)
}
})}
</DropdownMenuRadioGroup>
</DropdownMenuContent>
</DropdownMenu>
</div>
<Row columns={[3, 2, 1]}>
{enabledServices.map((s) => (
<Card key={s.key} className="mb-0 md:mb-0 h-full flex flex-col h-64">
<CardHeader className="flex flex-row items-end justify-between gap-2 space-y-0 pb-0 border-b-0">
<div className="flex items-center gap-2">
<div className="flex flex-col">
<div className="flex items-center gap-2">
<CardTitle className="text-foreground-light">
{s.href ? (
<Link
href={s.href}
onClick={() => {
if (projectRef && organization?.slug) {
sendEvent({
action: 'home_project_usage_service_clicked',
properties: {
service_type: s.key,
total_requests: s.total || 0,
error_count: s.err || 0,
},
groups: {
project: projectRef,
organization: organization.slug,
},
})
}
}}
>
{s.title}
</Link>
) : (
s.title
)}
</CardTitle>
</div>
<span className="text-foreground text-xl">{(s.total || 0).toLocaleString()}</span>
</div>
</div>
<div className="flex items-end gap-4 text-foreground-light">
<div className="flex flex-col items-end">
<div className="flex items-center gap-2">
<div className="w-1.5 h-1.5 bg-warning rounded-full" />
<span className="heading-meta">Warn</span>
</div>
<span className="text-foreground text-xl">{(s.warn || 0).toLocaleString()}</span>
</div>
<div className="flex flex-col items-end">
<div className="flex items-center gap-2">
<div className="w-1.5 h-1.5 bg-destructive rounded-full" />
<span className="heading-meta">Err</span>
</div>
<span className="text-foreground text-xl">{(s.err || 0).toLocaleString()}</span>
</div>
</div>
</CardHeader>
<CardContent className="p-6 pt-4 flex-1 h-full overflow-hidden">
<Loading isFullHeight active={isLoading}>
<LogsBarChart
isFullHeight
data={s.data}
DateTimeFormat={datetimeFormat}
onBarClick={handleBarClick(s.route, s.key)}
EmptyState={
<NoDataPlaceholder
size="small"
message="No data for selected period"
isFullHeight
/>
}
/>
</Loading>
</CardContent>
</Card>
))}
</Row>
</div>
)
}