mirror of
https://github.com/supabase/supabase.git
synced 2026-10-08 19:05: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 -->
180 lines
5.3 KiB
TypeScript
180 lines
5.3 KiB
TypeScript
import RGL, { WidthProvider } from 'react-grid-layout'
|
|
|
|
import 'react-grid-layout/css/styles.css'
|
|
import 'react-resizable/css/styles.css'
|
|
|
|
import { useParams } from 'common'
|
|
import { toast } from 'sonner'
|
|
|
|
import { createSqlSnippetSkeletonV2 } from '../SQLEditor/SQLEditor.utils'
|
|
import { ChartConfig } from '../SQLEditor/UtilityPanel/ChartConfig'
|
|
import { ReportBlock } from './ReportBlock/ReportBlock'
|
|
import { LAYOUT_COLUMN_COUNT } from './Reports.constants'
|
|
import { DEFAULT_CHART_CONFIG } from '@/components/ui/QueryBlock/QueryBlock'
|
|
import { AnalyticsInterval } from '@/data/analytics/constants'
|
|
import {
|
|
UpsertContentPayload,
|
|
useContentUpsertMutation,
|
|
} from '@/data/content/content-upsert-mutation'
|
|
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
|
|
import { useProfile } from '@/lib/profile'
|
|
import { useTrack } from '@/lib/telemetry/track'
|
|
import type { Dashboards } from '@/types'
|
|
|
|
const ReactGridLayout = WidthProvider(RGL)
|
|
|
|
interface GridResizeProps {
|
|
startDate: string
|
|
endDate: string
|
|
interval: AnalyticsInterval
|
|
editableReport: Dashboards.Content
|
|
disableUpdate: boolean
|
|
isRefreshing: boolean
|
|
onRemoveChart: ({ metric }: { metric: { key: string } }) => void
|
|
onUpdateChart: (
|
|
id: string,
|
|
{
|
|
chart,
|
|
chartConfig,
|
|
}: { chart?: Partial<Dashboards.Chart>; chartConfig?: Partial<ChartConfig> }
|
|
) => void
|
|
setEditableReport: (payload: any) => void
|
|
}
|
|
|
|
export const GridResize = ({
|
|
startDate,
|
|
endDate,
|
|
interval,
|
|
editableReport,
|
|
disableUpdate,
|
|
isRefreshing,
|
|
onRemoveChart,
|
|
onUpdateChart,
|
|
setEditableReport,
|
|
}: GridResizeProps) => {
|
|
const { ref } = useParams()
|
|
const { profile } = useProfile()
|
|
const { data: project } = useSelectedProjectQuery()
|
|
|
|
const track = useTrack()
|
|
const { mutate: upsertContent } = useContentUpsertMutation()
|
|
|
|
const onUpdateLayout = (layout: RGL.Layout[]) => {
|
|
const updatedLayout = [...editableReport.layout]
|
|
|
|
layout.forEach((chart) => {
|
|
const chartIdx = updatedLayout.findIndex((y) => chart.i === y.id)
|
|
if (chartIdx !== undefined && chartIdx >= 0) {
|
|
updatedLayout[chartIdx] = {
|
|
...updatedLayout[chartIdx],
|
|
w: chart.w,
|
|
h: chart.h,
|
|
x: chart.x,
|
|
y: chart.y,
|
|
}
|
|
}
|
|
})
|
|
|
|
setEditableReport({ ...editableReport, layout: updatedLayout })
|
|
}
|
|
|
|
const onDropBlock = async (layout: RGL.Layout[], layoutItem: RGL.Layout, e: any) => {
|
|
if (!ref) return console.error('Project ref is required')
|
|
if (!profile) return console.error('Profile is required')
|
|
if (!project) return console.error('Project is required')
|
|
|
|
const data = e.dataTransfer.getData('application/json')
|
|
if (!data) return
|
|
|
|
const queryData = JSON.parse(data)
|
|
const { label, sql, config } = queryData
|
|
if (!label || !sql) return console.error('SQL and Label required')
|
|
|
|
const toastId = toast.loading(`Creating new query: ${label}`)
|
|
|
|
const payload = createSqlSnippetSkeletonV2({
|
|
name: label,
|
|
sql,
|
|
owner_id: profile?.id,
|
|
project_id: project?.id,
|
|
}) as UpsertContentPayload
|
|
|
|
const updatedLayout = layout.map((x) => {
|
|
const existingBlock = editableReport.layout.find((y) => x.i === y.id)
|
|
if (existingBlock) {
|
|
return { ...existingBlock, x: x.x, y: x.y }
|
|
} else {
|
|
return {
|
|
id: payload.id,
|
|
attribute: `new_snippet_${payload.id}`,
|
|
chartConfig: { ...DEFAULT_CHART_CONFIG, ...(config ?? {}) },
|
|
label,
|
|
chart_type: 'bar',
|
|
h: layoutItem.h,
|
|
w: layoutItem.w,
|
|
x: layoutItem.x,
|
|
y: layoutItem.y,
|
|
}
|
|
}
|
|
})
|
|
setEditableReport({ ...editableReport, layout: updatedLayout })
|
|
|
|
upsertContent(
|
|
{ projectRef: ref, payload },
|
|
{
|
|
onSuccess: () => {
|
|
toast.success(`Successfully created new query: ${label}`, { id: toastId })
|
|
const finalLayout = updatedLayout.map((x) => {
|
|
if (x.id === payload.id) {
|
|
return { ...x, attribute: `snippet_${payload.id}` }
|
|
} else return x
|
|
})
|
|
setEditableReport({ ...editableReport, layout: finalLayout })
|
|
},
|
|
}
|
|
)
|
|
track('custom_report_assistant_sql_block_added')
|
|
}
|
|
|
|
if (!editableReport) return null
|
|
|
|
return (
|
|
<ReactGridLayout
|
|
autoSize
|
|
isDraggable
|
|
isDroppable
|
|
isResizable
|
|
rowHeight={270}
|
|
cols={LAYOUT_COLUMN_COUNT}
|
|
containerPadding={[0, 0]}
|
|
resizeHandles={['sw', 'se']}
|
|
compactType="vertical"
|
|
onDrop={onDropBlock}
|
|
onDragStop={onUpdateLayout}
|
|
onResizeStop={onUpdateLayout}
|
|
draggableHandle=".grid-item-drag-handle"
|
|
>
|
|
{editableReport.layout.map((item) => {
|
|
return (
|
|
<div
|
|
key={item.id}
|
|
data-grid={{ ...item, h: 1, minH: 1, maxH: 1, minW: 1, maxW: LAYOUT_COLUMN_COUNT }}
|
|
>
|
|
<ReportBlock
|
|
key={item.id}
|
|
item={item}
|
|
startDate={startDate}
|
|
endDate={endDate}
|
|
interval={interval}
|
|
disableUpdate={disableUpdate}
|
|
isRefreshing={isRefreshing}
|
|
onRemoveChart={onRemoveChart}
|
|
onUpdateChart={(config) => onUpdateChart(item.id, config)}
|
|
/>
|
|
</div>
|
|
)
|
|
})}
|
|
</ReactGridLayout>
|
|
)
|
|
}
|