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 -->
118 lines
3.5 KiB
TypeScript
118 lines
3.5 KiB
TypeScript
import { useParams } from 'common'
|
|
import { useMemo, useState, type PropsWithChildren } from 'react'
|
|
|
|
import { EdgeFunctionBlock } from '../EdgeFunctionBlock/EdgeFunctionBlock'
|
|
import { ConfirmFooter } from './ConfirmFooter'
|
|
import { useProjectSettingsV2Query } from '@/data/config/project-settings-v2-query'
|
|
import { useEdgeFunctionQuery } from '@/data/edge-functions/edge-function-query'
|
|
import { useTrack } from '@/lib/telemetry/track'
|
|
|
|
interface EdgeFunctionRendererProps {
|
|
label: string
|
|
code: string
|
|
functionName: string
|
|
onApprove?: () => void
|
|
onDeny?: () => void
|
|
isDeploying?: boolean
|
|
initialIsDeployed?: boolean
|
|
showConfirmFooter?: boolean
|
|
}
|
|
|
|
export const EdgeFunctionRenderer = ({
|
|
label,
|
|
code,
|
|
functionName,
|
|
onApprove,
|
|
onDeny,
|
|
isDeploying = false,
|
|
initialIsDeployed,
|
|
showConfirmFooter = true,
|
|
}: PropsWithChildren<EdgeFunctionRendererProps>) => {
|
|
const { ref } = useParams()
|
|
const track = useTrack()
|
|
const [showReplaceWarning, setShowReplaceWarning] = useState(false)
|
|
|
|
const { data: settings } = useProjectSettingsV2Query({ projectRef: ref }, { enabled: !!ref })
|
|
const { data: existingFunction } = useEdgeFunctionQuery(
|
|
{ projectRef: ref, slug: functionName },
|
|
{ enabled: !!ref && !!functionName && !initialIsDeployed }
|
|
)
|
|
|
|
const functionUrl = useMemo(() => {
|
|
const endpoint = settings?.app_config?.endpoint
|
|
if (!endpoint || !ref || !functionName) return undefined
|
|
|
|
try {
|
|
const url = new URL(`https://${endpoint}`)
|
|
const restUrlTld = url.hostname.split('.').pop()
|
|
return restUrlTld
|
|
? `https://${ref}.supabase.${restUrlTld}/functions/v1/${functionName}`
|
|
: undefined
|
|
} catch (error) {
|
|
return undefined
|
|
}
|
|
}, [settings?.app_config?.endpoint, ref, functionName])
|
|
|
|
const deploymentDetailsUrl = useMemo(() => {
|
|
if (!ref || !functionName) return undefined
|
|
return `/project/${ref}/functions/${functionName}/details`
|
|
}, [ref, functionName])
|
|
|
|
const downloadCommand = useMemo(() => {
|
|
if (!functionName) return undefined
|
|
return `supabase functions download ${functionName}`
|
|
}, [functionName])
|
|
|
|
const approveDeploy = () => {
|
|
if (!code || isDeploying || !ref || !functionName) return
|
|
|
|
setShowReplaceWarning(false)
|
|
track('edge_function_deploy_button_clicked', { origin: 'functions_ai_assistant' })
|
|
onApprove?.()
|
|
}
|
|
|
|
const handleDeploy = () => {
|
|
if (!code || isDeploying || !ref || !functionName) return
|
|
|
|
if (existingFunction) {
|
|
setShowReplaceWarning(true)
|
|
return
|
|
}
|
|
|
|
approveDeploy()
|
|
}
|
|
|
|
return (
|
|
<div className="w-auto overflow-x-hidden my-4">
|
|
<EdgeFunctionBlock
|
|
label={label}
|
|
code={code}
|
|
functionName={functionName}
|
|
disabled={showConfirmFooter}
|
|
isDeploying={isDeploying}
|
|
isDeployed={initialIsDeployed}
|
|
functionUrl={functionUrl}
|
|
deploymentDetailsUrl={deploymentDetailsUrl}
|
|
downloadCommand={downloadCommand}
|
|
hideDeployButton={showConfirmFooter || initialIsDeployed}
|
|
showReplaceWarning={showReplaceWarning}
|
|
onCancelReplace={() => setShowReplaceWarning(false)}
|
|
onConfirmReplace={approveDeploy}
|
|
/>
|
|
{showConfirmFooter && (
|
|
<div className="mx-4">
|
|
<ConfirmFooter
|
|
message="Assistant wants to deploy this Edge Function"
|
|
cancelLabel="Skip"
|
|
confirmLabel="Deploy"
|
|
confirmLabelLoading="Deploying..."
|
|
isLoading={isDeploying}
|
|
onCancel={() => onDeny?.()}
|
|
onConfirm={handleDeploy}
|
|
/>
|
|
</div>
|
|
)}
|
|
</div>
|
|
)
|
|
}
|