mirror of
https://github.com/supabase/supabase.git
synced 2026-06-13 01:39:53 +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 -->
137 lines
3.9 KiB
TypeScript
137 lines
3.9 KiB
TypeScript
import { screen } from '@testing-library/react'
|
|
import userEvent from '@testing-library/user-event'
|
|
import { beforeEach, describe, expect, it, vi } from 'vitest'
|
|
|
|
import { EdgeFunctionRenderer } from './EdgeFunctionRenderer'
|
|
import { render } from '@/tests/helpers'
|
|
|
|
const {
|
|
mockTrack,
|
|
mockUseEdgeFunctionQuery,
|
|
mockUseParams,
|
|
mockUseProjectSettingsV2Query,
|
|
mockUseSelectedOrganizationQuery,
|
|
} = vi.hoisted(() => ({
|
|
mockTrack: vi.fn(),
|
|
mockUseEdgeFunctionQuery: vi.fn(),
|
|
mockUseParams: vi.fn(),
|
|
mockUseProjectSettingsV2Query: vi.fn(),
|
|
mockUseSelectedOrganizationQuery: vi.fn(),
|
|
}))
|
|
|
|
vi.mock('common', async () => {
|
|
const actual = await vi.importActual<typeof import('common')>('common')
|
|
|
|
return {
|
|
...actual,
|
|
useParams: mockUseParams,
|
|
}
|
|
})
|
|
|
|
vi.mock('@/data/config/project-settings-v2-query', () => ({
|
|
useProjectSettingsV2Query: mockUseProjectSettingsV2Query,
|
|
}))
|
|
|
|
vi.mock('@/data/edge-functions/edge-function-query', () => ({
|
|
useEdgeFunctionQuery: mockUseEdgeFunctionQuery,
|
|
}))
|
|
|
|
vi.mock('@/lib/telemetry/track', () => ({
|
|
useTrack: () => mockTrack,
|
|
}))
|
|
|
|
vi.mock('@/hooks/misc/useSelectedOrganization', () => ({
|
|
useSelectedOrganizationQuery: mockUseSelectedOrganizationQuery,
|
|
}))
|
|
|
|
vi.mock('../EdgeFunctionBlock/EdgeFunctionBlock', () => ({
|
|
EdgeFunctionBlock: ({
|
|
showReplaceWarning,
|
|
onCancelReplace,
|
|
onConfirmReplace,
|
|
}: {
|
|
showReplaceWarning?: boolean
|
|
onCancelReplace?: () => void
|
|
onConfirmReplace?: () => void
|
|
}) => (
|
|
<div>
|
|
{showReplaceWarning && (
|
|
<div>
|
|
<p>An edge function with this name already exists.</p>
|
|
<button onClick={onCancelReplace}>Cancel</button>
|
|
<button onClick={onConfirmReplace}>Replace function</button>
|
|
</div>
|
|
)}
|
|
</div>
|
|
),
|
|
}))
|
|
|
|
vi.mock('./ConfirmFooter', () => ({
|
|
ConfirmFooter: ({
|
|
confirmLabel,
|
|
onConfirm,
|
|
}: {
|
|
confirmLabel?: string
|
|
onConfirm?: () => void
|
|
}) => <button onClick={onConfirm}>{confirmLabel ?? 'Confirm'}</button>,
|
|
}))
|
|
|
|
describe('EdgeFunctionRenderer', () => {
|
|
beforeEach(() => {
|
|
mockTrack.mockReset()
|
|
mockUseEdgeFunctionQuery.mockReset()
|
|
mockUseParams.mockReturnValue({ ref: 'project-ref' })
|
|
mockUseProjectSettingsV2Query.mockReturnValue({ data: undefined })
|
|
mockUseSelectedOrganizationQuery.mockReturnValue({ data: { slug: 'org-slug' } })
|
|
})
|
|
|
|
it('only deploys an existing function from the replace warning confirmation', async () => {
|
|
const user = userEvent.setup()
|
|
const onApprove = vi.fn()
|
|
|
|
mockUseEdgeFunctionQuery.mockReturnValue({ data: { slug: 'hello-world' } })
|
|
|
|
render(
|
|
<EdgeFunctionRenderer
|
|
label="Deploy Edge Function"
|
|
code="Deno.serve(() => new Response('ok'))"
|
|
functionName="hello-world"
|
|
onApprove={onApprove}
|
|
/>
|
|
)
|
|
|
|
await user.click(screen.getByRole('button', { name: 'Deploy' }))
|
|
expect(screen.getByText('An edge function with this name already exists.')).toBeInTheDocument()
|
|
expect(onApprove).not.toHaveBeenCalled()
|
|
|
|
await user.click(screen.getByRole('button', { name: 'Deploy' }))
|
|
expect(onApprove).not.toHaveBeenCalled()
|
|
expect(mockTrack).not.toHaveBeenCalled()
|
|
|
|
await user.click(screen.getByRole('button', { name: 'Replace function' }))
|
|
expect(onApprove).toHaveBeenCalledTimes(1)
|
|
expect(mockTrack).toHaveBeenCalledTimes(1)
|
|
})
|
|
|
|
it('deploys immediately when no existing function is found', async () => {
|
|
const user = userEvent.setup()
|
|
const onApprove = vi.fn()
|
|
|
|
mockUseEdgeFunctionQuery.mockReturnValue({ data: undefined })
|
|
|
|
render(
|
|
<EdgeFunctionRenderer
|
|
label="Deploy Edge Function"
|
|
code="Deno.serve(() => new Response('ok'))"
|
|
functionName="hello-world"
|
|
onApprove={onApprove}
|
|
/>
|
|
)
|
|
|
|
await user.click(screen.getByRole('button', { name: 'Deploy' }))
|
|
|
|
expect(onApprove).toHaveBeenCalledTimes(1)
|
|
expect(mockTrack).toHaveBeenCalledTimes(1)
|
|
})
|
|
})
|