mirror of
https://github.com/supabase/supabase.git
synced 2026-06-10 04:26:19 +08:00
## Summary
I migrated every `useSendEventMutation` call site in `apps/studio` to
`useTrack`, deleted the legacy hook, and added a lint guardrail so it
can't return. `useTrack` is the type-safe replacement: it auto-injects
`groups: { project, organization }` from the selected project/org and
types `action` + `properties` against `TelemetryEvent`. Existing call
sites built groups manually and were not type-checked at the action
level. The migration covers 81 files (60 trivial swaps, 9 org-only, 3
pre-auth, 5 bespoke, 4 test mocks).
## Changes
- Migrated trivial call sites across `pages/project/[ref]`,
`components/interfaces/*` (Reports, Storage, Realtime/Inspector,
SQLEditor, Functions, EdgeFunctions, Integrations, ProjectAPIDocs,
Branching/BranchManagement, TableGridEditor, Connect, Docs, Auth,
Support, Home, ProjectHome, App), `components/layouts/*`, and
`components/ui/*`.
- Migrated org-only sites (`Organization/Documents/*`,
`Organization/BillingSettings/Subscription/*`,
`Organization/SecuritySettings.tsx`,
`Account/Preferences/DashboardSettingsToggles.tsx`) by dropping the
manual `groups: { organization: ... }` and letting `useTrack`
auto-inject. Verified `useSelectedProjectQuery` is disabled on org
routes (gates on URL `[ref]`).
- Migrated pre-auth sites (`SignInForm.tsx`, `sign-in-mfa.tsx`,
`profile.tsx`) where neither project nor org is resolved.
- Bespoke handling:
- `execute-sql-mutation.ts` and `table-row-create-mutation.ts`: pass `{
project: projectRef }` via `groupOverrides` since the mutation can
target a non-selected project ref.
- `useStudioCommandMenuTelemetry.ts`: kept a direct `sendTelemetryEvent`
call because studio groups must override pre-built event groups
(opposite of `useTrack`'s override direction).
- `AIAssistantOption.tsx`: passes sentinel-aware `groupOverrides` so
`NO_PROJECT_MARKER`/`NO_ORG_MARKER` continue to suppress group emission.
- `SidePanelEditor.utils.tsx`: utility functions `createTable` and
`updateTable` now take a `track: Track` parameter (threaded from
`SidePanelEditor.tsx`); dropped the `organizationSlug` arg since groups
are no longer assembled manually.
- Branch-event attribution: preserved `parentProjectRef` overrides on
`branch_updated`, `branch_merge_completed`, `branch_merge_failed`,
`branch_merge_submitted`, `branch_delete_button_clicked`,
`branch_review_with_assistant_clicked`, and
`branch_*_merge_request_button_clicked`. Original code grouped these
under the parent (production) project, not the branch ref;
auto-injection would have shifted them onto the branch.
- Switched 4 test mocks from `@/data/telemetry/send-event-mutation` to
`@/lib/telemetry/track`. Removed obsolete tests around manual groups and
`try/catch` on telemetry rejection.
- Deleted `apps/studio/data/telemetry/send-event-mutation.ts`. The
deleted module is its own guardrail: any reintroduction of the import
fails at TypeScript module resolution before lint runs.
## Testing
Tested on preview deploy:
- [x] SQL editor `CREATE TABLE` fires `table_created` with method
`sql_editor` and `groups.project` set to the mutation's `projectRef`.
- [x] Table editor creates a table from the side panel; `table_created`
fires from `SidePanelEditor.utils` via threaded `track`.
- [x] Help button (`/project/[ref]/...`) fires `help_button_clicked`
with auto-injected project + org groups.
- [x] Sign-in form fires `sign_in` with empty groups (pre-auth,
expected).
- [x] Org documents page (`/org/[slug]/documents`) fires
`document_view_button_clicked` with org group only, no stale project
ref.
- [x] Command menu (`Cmd+K`) inside a project still fires
`command_menu_opened` with studio's project/org overriding any
event-supplied groups.
- [x] Support form "Ask the Assistant" without selected org fires
`ai_assistant_in_support_form_clicked` with no project/org groups
(sentinels suppress).
- [x] On a branch, "Update branch" / "Merge branch" / "Close merge
request" events fire with `groups.project` set to the parent project
ref, not the branch ref.
Local checks:
- [x] 22/22 tests pass across the 4 updated test files
(`SidePanelEditor.utils.createTable`, `EdgeFunctionRenderer`,
`LayoutSidebar`, `PlanUpdateSidePanel`).
- [x] `rg useSendEventMutation apps/studio` returns 0 hits.
## Linear
- fixes GROWTH-860
<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit
* **Chores**
* Standardized telemetry across the Studio to a unified tracking system;
events now send simplified payloads with less contextual/grouping data.
* No user-facing flows changed; UI behavior, permissions, and
interactions remain the same.
* **Tests**
* Updated telemetry mocks and tests to align with the new tracking
approach.
<!-- review_stack_entry_start -->
[](https://app.coderabbit.ai/change-stack/supabase/supabase/pull/46140?utm_source=github_walkthrough&utm_medium=github&utm_campaign=change_stack)
<!-- review_stack_entry_end -->
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
272 lines
8.9 KiB
TypeScript
272 lines
8.9 KiB
TypeScript
import { useParams } from 'common'
|
|
import dayjs from 'dayjs'
|
|
import Link from 'next/link'
|
|
import { useRouter } from 'next/router'
|
|
import { useEffect, useMemo, useState } from 'react'
|
|
import { Card, CardContent, CardHeader, CardTitle, Loading } from 'ui'
|
|
import { Row } from 'ui-patterns'
|
|
import { LogsBarChart } from 'ui-patterns/LogsBarChart'
|
|
|
|
import NoDataPlaceholder from '@/components/ui/Charts/NoDataPlaceholder'
|
|
import { ChartIntervalDropdown } from '@/components/ui/Logs/ChartIntervalDropdown'
|
|
import { CHART_INTERVALS } from '@/components/ui/Logs/logs.utils'
|
|
import { UsageApiCounts, useProjectLogStatsQuery } from '@/data/analytics/project-log-stats-query'
|
|
import { useFillTimeseriesSorted } from '@/hooks/analytics/useFillTimeseriesSorted'
|
|
import { useCheckEntitlements } from '@/hooks/misc/useCheckEntitlements'
|
|
import { useIsFeatureEnabled } from '@/hooks/misc/useIsFeatureEnabled'
|
|
import { useSelectedOrganizationQuery } from '@/hooks/misc/useSelectedOrganization'
|
|
import { useTrack } from '@/lib/telemetry/track'
|
|
|
|
type LogsBarChartDatum = {
|
|
timestamp: string
|
|
error_count: number
|
|
ok_count: number
|
|
warning_count: number
|
|
}
|
|
|
|
type ChartIntervalKey = '1hr' | '1day' | '7day'
|
|
|
|
type ServiceKey = 'db' | 'auth' | 'storage' | 'realtime'
|
|
|
|
type ServiceEntry = {
|
|
key: ServiceKey
|
|
title: string
|
|
href?: string
|
|
route: string
|
|
enabled: boolean
|
|
}
|
|
|
|
type ServiceComputed = ServiceEntry & {
|
|
data: LogsBarChartDatum[]
|
|
total: number
|
|
isLoading: boolean
|
|
error: unknown | null
|
|
}
|
|
|
|
export const ProjectUsageSection = () => {
|
|
const router = useRouter()
|
|
const { ref: projectRef } = useParams()
|
|
const { data: organization } = useSelectedOrganizationQuery()
|
|
const track = useTrack()
|
|
const { projectAuthAll: authEnabled, projectStorageAll: storageEnabled } = useIsFeatureEnabled([
|
|
'project_auth:all',
|
|
'project_storage:all',
|
|
])
|
|
const { getEntitlementMax } = useCheckEntitlements('log.retention_days')
|
|
const retentionDays = getEntitlementMax()
|
|
|
|
const DEFAULT_INTERVAL: ChartIntervalKey =
|
|
retentionDays !== undefined && retentionDays < 7 ? '1hr' : '1day'
|
|
const [interval, setInterval] = useState<ChartIntervalKey>(DEFAULT_INTERVAL)
|
|
|
|
useEffect(() => {
|
|
setInterval(retentionDays !== undefined && retentionDays < 7 ? '1hr' : '1day')
|
|
}, [retentionDays])
|
|
|
|
const selectedInterval = CHART_INTERVALS.find((i) => i.key === interval) || CHART_INTERVALS[1]
|
|
|
|
const { datetimeFormat } = useMemo(() => {
|
|
const format = selectedInterval.format || 'MMM D, ha'
|
|
return { datetimeFormat: format }
|
|
}, [selectedInterval])
|
|
|
|
// Use V1 data fetching
|
|
const { data: logStatsData, isPending: isLoading } = useProjectLogStatsQuery({
|
|
projectRef,
|
|
interval,
|
|
})
|
|
|
|
// Calculate date range for gap filling
|
|
const startDateLocal = dayjs().subtract(
|
|
selectedInterval.startValue,
|
|
selectedInterval.startUnit as dayjs.ManipulateType
|
|
)
|
|
const endDateLocal = dayjs()
|
|
|
|
// Fill gaps in timeseries data
|
|
const { data: filledCharts } = useFillTimeseriesSorted({
|
|
data: logStatsData?.result ?? [],
|
|
timestampKey: 'timestamp',
|
|
valueKey: [
|
|
'total_auth_requests',
|
|
'total_rest_requests',
|
|
'total_storage_requests',
|
|
'total_realtime_requests',
|
|
],
|
|
defaultValue: 0,
|
|
startDate: startDateLocal.toISOString(),
|
|
endDate: endDateLocal.toISOString(),
|
|
minPointsToFill: 5,
|
|
})
|
|
|
|
const serviceBase: ServiceEntry[] = useMemo(
|
|
() => [
|
|
{
|
|
key: 'db',
|
|
title: 'Database requests',
|
|
href: `/project/${projectRef}/editor`,
|
|
route: '/logs/postgres-logs',
|
|
enabled: true,
|
|
},
|
|
{
|
|
key: 'auth',
|
|
title: 'Auth requests',
|
|
href: `/project/${projectRef}/auth/users`,
|
|
route: '/logs/auth-logs',
|
|
enabled: authEnabled,
|
|
},
|
|
{
|
|
key: 'storage',
|
|
title: 'Storage requests',
|
|
href: `/project/${projectRef}/storage/buckets`,
|
|
route: '/logs/storage-logs',
|
|
enabled: storageEnabled,
|
|
},
|
|
{
|
|
key: 'realtime',
|
|
title: 'Realtime requests',
|
|
route: '/logs/realtime-logs',
|
|
enabled: true,
|
|
},
|
|
],
|
|
[projectRef, authEnabled, storageEnabled]
|
|
)
|
|
|
|
const services: ServiceComputed[] = useMemo(
|
|
() =>
|
|
serviceBase.map((s) => {
|
|
// Map service keys to V1 data field names
|
|
const dataKeyMap: Record<ServiceKey, keyof UsageApiCounts> = {
|
|
db: 'total_rest_requests',
|
|
auth: 'total_auth_requests',
|
|
storage: 'total_storage_requests',
|
|
realtime: 'total_realtime_requests',
|
|
}
|
|
|
|
const dataKey = dataKeyMap[s.key]
|
|
|
|
// Transform V1 data to LogsBarChart format
|
|
// Since V1 doesn't have error/warning breakdown, we show everything as "ok"
|
|
const transformedData: LogsBarChartDatum[] = (filledCharts || []).map((item) => ({
|
|
timestamp: item.timestamp,
|
|
error_count: 0,
|
|
warning_count: 0,
|
|
ok_count: Number(item[dataKey]) || 0,
|
|
}))
|
|
|
|
// Calculate total from filled data
|
|
const total = transformedData.reduce((sum, item) => sum + item.ok_count, 0)
|
|
|
|
return {
|
|
...s,
|
|
data: transformedData,
|
|
total,
|
|
isLoading,
|
|
error: null,
|
|
}
|
|
}),
|
|
[serviceBase, filledCharts, isLoading]
|
|
)
|
|
|
|
const handleBarClick =
|
|
(logRoute: string, serviceKey: ServiceKey) => (datum: LogsBarChartDatum) => {
|
|
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()}`)
|
|
|
|
track('home_project_usage_chart_clicked', {
|
|
service_type: serviceKey,
|
|
bar_timestamp: datum.timestamp,
|
|
})
|
|
}
|
|
|
|
const enabledServices = services.filter((s) => s.enabled)
|
|
const totalRequests = enabledServices.reduce((sum, s) => sum + (s.total || 0), 0)
|
|
|
|
return (
|
|
<div className="space-y-6">
|
|
<div className="flex flex-row justify-between items-center gap-x-2">
|
|
<div className="flex items-start gap-2 heading-section text-foreground-light">
|
|
<span className="text-foreground">{totalRequests.toLocaleString()}</span>
|
|
<span>Total Requests</span>
|
|
</div>
|
|
<ChartIntervalDropdown
|
|
value={interval}
|
|
onChange={(interval) => setInterval(interval as ChartIntervalKey)}
|
|
organizationSlug={organization?.slug}
|
|
dropdownAlign="end"
|
|
tooltipSide="left"
|
|
/>
|
|
</div>
|
|
<Row maxColumns={4} minWidth={280}>
|
|
{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">
|
|
<CardTitle className="text-xs font-mono uppercase text-foreground-light">
|
|
{s.href ? (
|
|
<Link
|
|
href={s.href}
|
|
onClick={() => {
|
|
track('home_project_usage_service_clicked', {
|
|
service_type: s.key,
|
|
total_requests: s.total || 0,
|
|
})
|
|
}}
|
|
>
|
|
{s.title}
|
|
</Link>
|
|
) : (
|
|
s.title
|
|
)}
|
|
</CardTitle>
|
|
<span className="text-foreground text-xl">{(s.total || 0).toLocaleString()}</span>
|
|
</div>
|
|
</div>
|
|
</CardHeader>
|
|
<CardContent className="p-card flex-1 h-full overflow-hidden">
|
|
<Loading isFullHeight active={isLoading}>
|
|
<LogsBarChart
|
|
isFullHeight
|
|
data={s.data}
|
|
DateTimeFormat={datetimeFormat}
|
|
onBarClick={handleBarClick(s.route, s.key)}
|
|
hideZeroValues={true}
|
|
chartConfig={{
|
|
error_count: {
|
|
label: 'Errors',
|
|
},
|
|
warning_count: {
|
|
label: 'Warnings',
|
|
},
|
|
ok_count: {
|
|
label: 'Requests',
|
|
},
|
|
}}
|
|
EmptyState={
|
|
<NoDataPlaceholder
|
|
size="small"
|
|
message="No data for selected period"
|
|
isFullHeight
|
|
/>
|
|
}
|
|
/>
|
|
</Loading>
|
|
</CardContent>
|
|
</Card>
|
|
))}
|
|
</Row>
|
|
</div>
|
|
)
|
|
}
|