mirror of
https://github.com/supabase/supabase.git
synced 2026-10-06 09:55:06 +03: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 -->
193 lines
6.6 KiB
TypeScript
193 lines
6.6 KiB
TypeScript
import { useDebounce } from '@uidotdev/usehooks'
|
|
import { useParams } from 'common'
|
|
import { Home, Plus } from 'lucide-react'
|
|
import { useState } from 'react'
|
|
import {
|
|
Command,
|
|
CommandGroup,
|
|
CommandInput,
|
|
CommandItem,
|
|
CommandList,
|
|
DropdownMenuCheckboxItem,
|
|
DropdownMenuPortal,
|
|
DropdownMenuSub,
|
|
DropdownMenuSubContent,
|
|
DropdownMenuSubTrigger,
|
|
SQL_ICON,
|
|
} from 'ui'
|
|
import { ShimmeringLoader } from 'ui-patterns/ShimmeringLoader'
|
|
|
|
import { BURSTABLE_IO_METRIC_KEYS, DEPRECATED_REPORTS } from './Reports.constants'
|
|
import { hasBurstableIO } from '@/components/interfaces/DiskManagement/DiskManagement.utils'
|
|
import { SIDEBAR_KEYS } from '@/components/layouts/ProjectLayout/LayoutSidebar/LayoutSidebarProvider'
|
|
import { useContentQuery } from '@/data/content/content-query'
|
|
import { useIsFeatureEnabled } from '@/hooks/misc/useIsFeatureEnabled'
|
|
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
|
|
import { Metric, METRIC_CATEGORIES, METRICS } from '@/lib/constants/metrics'
|
|
import { useTrack } from '@/lib/telemetry/track'
|
|
import { editorPanelState } from '@/state/editor-panel-state'
|
|
import { useSidebarManagerSnapshot } from '@/state/sidebar-manager-state'
|
|
import type { Dashboards } from '@/types'
|
|
|
|
interface MetricOptionsProps {
|
|
config?: Dashboards.Content
|
|
handleChartSelection: ({
|
|
metric,
|
|
isAddingChart,
|
|
}: {
|
|
metric: Metric
|
|
isAddingChart: boolean
|
|
}) => void
|
|
}
|
|
|
|
export const MetricOptions = ({ config, handleChartSelection }: MetricOptionsProps) => {
|
|
const { ref: projectRef } = useParams()
|
|
const { data: project } = useSelectedProjectQuery()
|
|
const { openSidebar } = useSidebarManagerSnapshot()
|
|
const [search, setSearch] = useState('')
|
|
|
|
const { projectAuthAll: authEnabled, projectStorageAll: storageEnabled } = useIsFeatureEnabled([
|
|
'project_auth:all',
|
|
'project_storage:all',
|
|
])
|
|
|
|
const supportsBurstableIO = hasBurstableIO(project?.infra_compute_size)
|
|
|
|
const metricCategories = Object.values(METRIC_CATEGORIES).filter(({ key }) => {
|
|
if (key === 'api_auth') return authEnabled
|
|
if (key === 'api_storage') return storageEnabled
|
|
return true
|
|
})
|
|
|
|
const track = useTrack()
|
|
|
|
const debouncedSearch = useDebounce(search, 300)
|
|
const {
|
|
data,
|
|
isPending: isLoading,
|
|
refetch,
|
|
} = useContentQuery({
|
|
projectRef,
|
|
type: 'sql',
|
|
name: debouncedSearch.length === 0 ? undefined : debouncedSearch,
|
|
})
|
|
const snippets = data?.content
|
|
|
|
return (
|
|
<>
|
|
{metricCategories.map((cat) => {
|
|
return (
|
|
<DropdownMenuSub key={cat.key}>
|
|
<DropdownMenuSubTrigger className="space-x-2">
|
|
{cat.icon ? cat.icon() : <Home size={14} />}
|
|
<p>{cat.label}</p>
|
|
</DropdownMenuSubTrigger>
|
|
<DropdownMenuPortal>
|
|
<DropdownMenuSubContent>
|
|
{METRICS.filter(
|
|
(metric) =>
|
|
!DEPRECATED_REPORTS.includes(metric.key) &&
|
|
metric?.category?.key === cat.key &&
|
|
(supportsBurstableIO || !BURSTABLE_IO_METRIC_KEYS.includes(metric.key))
|
|
).map((metric) => {
|
|
return (
|
|
<DropdownMenuCheckboxItem
|
|
key={metric.key}
|
|
className="cursor-pointer"
|
|
checked={config?.layout?.some((x: any) => x.attribute === metric.key)}
|
|
onCheckedChange={(e) => handleChartSelection({ metric, isAddingChart: e })}
|
|
>
|
|
<div className="flex flex-col space-y-0">
|
|
<span>{metric.label}</span>
|
|
</div>
|
|
</DropdownMenuCheckboxItem>
|
|
)
|
|
})}
|
|
</DropdownMenuSubContent>
|
|
</DropdownMenuPortal>
|
|
</DropdownMenuSub>
|
|
)
|
|
})}
|
|
<DropdownMenuSub
|
|
onOpenChange={(open) => {
|
|
if (open) refetch()
|
|
}}
|
|
>
|
|
<DropdownMenuSubTrigger className="space-x-2">
|
|
<SQL_ICON
|
|
size={14}
|
|
strokeWidth={1.5}
|
|
className="fill-foreground-light w-5 h-4 shrink-0 grow-0 -ml-0.5"
|
|
/>
|
|
<p>SQL Snippets</p>
|
|
</DropdownMenuSubTrigger>
|
|
<DropdownMenuPortal>
|
|
<DropdownMenuSubContent className="p-0">
|
|
<Command shouldFilter={false}>
|
|
<CommandInput
|
|
autoFocus
|
|
placeholder="Search snippets..."
|
|
value={search}
|
|
onValueChange={setSearch}
|
|
/>
|
|
<CommandList>
|
|
{isLoading ? (
|
|
<div className="flex flex-col p-1 gap-y-1">
|
|
<ShimmeringLoader />
|
|
<ShimmeringLoader className="w-3/4" />
|
|
</div>
|
|
) : !snippets?.length ? (
|
|
<p className="text-xs text-center text-foreground-lighter py-3">
|
|
No snippets found
|
|
</p>
|
|
) : null}
|
|
<CommandGroup>
|
|
{snippets?.map((snippet) => (
|
|
<CommandItem
|
|
key={snippet.id}
|
|
value={snippet.id}
|
|
className="cursor-pointer"
|
|
onSelect={() => {
|
|
if (!config?.layout.find((x) => x.id === snippet.id)) {
|
|
handleChartSelection({
|
|
metric: {
|
|
id: snippet.id,
|
|
key: `snippet_${snippet.id}`,
|
|
label: snippet.name,
|
|
},
|
|
isAddingChart: true,
|
|
})
|
|
track('custom_report_add_sql_block_clicked')
|
|
}
|
|
}}
|
|
>
|
|
{snippet.name}
|
|
</CommandItem>
|
|
))}
|
|
</CommandGroup>
|
|
</CommandList>
|
|
|
|
<div className="h-px bg-border-overlay -mx-1" />
|
|
|
|
<CommandGroup>
|
|
<CommandItem
|
|
className="cursor-pointer w-full"
|
|
onSelect={() => {
|
|
editorPanelState.openAsNew()
|
|
openSidebar(SIDEBAR_KEYS.EDITOR_PANEL)
|
|
}}
|
|
>
|
|
<div className="w-full flex items-center gap-2">
|
|
<Plus size={14} strokeWidth={1.5} />
|
|
<p>Create snippet</p>
|
|
</div>
|
|
</CommandItem>
|
|
</CommandGroup>
|
|
</Command>
|
|
</DropdownMenuSubContent>
|
|
</DropdownMenuPortal>
|
|
</DropdownMenuSub>
|
|
</>
|
|
)
|
|
}
|