Files
supabase/apps/studio/components/interfaces/Functions/FunctionsEmptyState.tsx
T
Pamela Chia 47c084e51d refactor(studio): migrate telemetry to useTrack (#46140)
## 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 -->

[![Review Change
Stack](https://storage.googleapis.com/coderabbit_public_assets/review-stack-in-coderabbit-ui.svg)](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 -->
2026-05-27 15:19:54 +08:00

388 lines
15 KiB
TypeScript

import { useParams } from 'common'
import { Code, Play, Terminal } from 'lucide-react'
import Link from 'next/link'
import { useRouter } from 'next/router'
import { parseAsString, useQueryState } from 'nuqs'
import { useMemo } from 'react'
import {
AiIconAnimation,
Button,
Card,
CardContent,
CardHeader,
CardTitle,
cn,
Dialog,
DialogContent,
DialogDescription,
DialogHeader,
DialogSection,
DialogTitle,
DialogTrigger,
Separator,
} from 'ui'
import { CodeBlock } from 'ui-patterns/CodeBlock'
import { EDGE_FUNCTION_TEMPLATES } from './Functions.templates'
import { SIDEBAR_KEYS } from '@/components/layouts/ProjectLayout/LayoutSidebar/LayoutSidebarProvider'
import { ScaffoldSectionTitle } from '@/components/layouts/Scaffold'
import { DocsButton } from '@/components/ui/DocsButton'
import { ResourceItem } from '@/components/ui/Resource/ResourceItem'
import { ResourceList } from '@/components/ui/Resource/ResourceList'
import { useIsFeatureEnabled } from '@/hooks/misc/useIsFeatureEnabled'
import { DOCS_URL } from '@/lib/constants'
import { useTrack } from '@/lib/telemetry/track'
import { useAiAssistantStateSnapshot } from '@/state/ai-assistant-state'
import { useSidebarManagerSnapshot } from '@/state/sidebar-manager-state'
export const FunctionsEmptyState = () => {
const { ref } = useParams()
const router = useRouter()
const aiSnap = useAiAssistantStateSnapshot()
const { openSidebar } = useSidebarManagerSnapshot()
const track = useTrack()
const [, setCreateMethod] = useQueryState('create', parseAsString)
const showStripeExample = useIsFeatureEnabled('edge_functions:show_stripe_example')
const templates = useMemo(() => {
if (showStripeExample) {
return EDGE_FUNCTION_TEMPLATES
}
// Filter out Stripe template
return EDGE_FUNCTION_TEMPLATES.filter((template) => template.value !== 'stripe-webhook')
}, [showStripeExample])
return (
<>
<Card>
<CardHeader>
<CardTitle>Deploy your first edge function</CardTitle>
</CardHeader>
<CardContent className="p-0 grid grid-cols-[repeat(auto-fit,minmax(240px,1fr))] divide-y md:divide-y-0 md:divide-x divide-default items-stretch">
{/* Editor Option */}
<div className="p-8">
<div className="flex items-center gap-2">
<Code strokeWidth={1.5} size={20} />
<h4 className="text-base text-foreground">Via Editor</h4>
</div>
<p className="text-sm text-foreground-light mb-4 mt-1">
Create and edit functions directly in the browser. Download to local at any time.
</p>
<Button
type="default"
onClick={() => {
router.push(`/project/${ref}/functions/new`)
track('edge_function_via_editor_button_clicked', { origin: 'no_functions_block' })
}}
>
Open Editor
</Button>
</div>
{/* AI Assistant Option */}
<div className="p-8">
<div className="flex items-center gap-2">
<AiIconAnimation size={20} />
<h4 className="text-base text-foreground">AI Assistant</h4>
</div>
<p className="text-sm text-foreground-light mb-4 mt-1">
Let our AI assistant help you create functions. Perfect for kickstarting a function.
</p>
<Button
type="default"
onClick={() => {
openSidebar(SIDEBAR_KEYS.AI_ASSISTANT)
aiSnap.newChat({
name: 'Create new edge function',
initialInput: 'Create a new edge function that ...',
suggestions: {
title:
'I can help you create a new edge function. Here are a few example prompts to get you started:',
prompts: [
{
label: 'Stripe Payments',
description:
'Create a new edge function that processes payments with Stripe',
},
{
label: 'Email with Resend',
description: 'Create a new edge function that sends emails with Resend',
},
{
label: 'PDF Generator',
description:
'Create a new edge function that generates PDFs from HTML templates',
},
],
},
})
track('edge_function_ai_assistant_button_clicked', { origin: 'no_functions_block' })
}}
>
Open Assistant
</Button>
</div>
{/* CLI Option */}
<div className="p-8">
<div className="flex items-center gap-2">
<Terminal strokeWidth={1.5} size={20} />
<h4 className="text-base text-foreground">Via CLI</h4>
</div>
<p className="text-sm text-foreground-light mb-4 mt-1">
Create and deploy functions using the Supabase CLI. Ideal for local development and
version control.
</p>
<Button
type="default"
onClick={() => {
setCreateMethod('cli')
track('edge_function_via_cli_button_clicked', { origin: 'no_functions_block' })
}}
>
View CLI Instructions
</Button>
</div>
</CardContent>
</Card>
<ScaffoldSectionTitle className="text-xl mb-4 mt-12">
Start with a template
</ScaffoldSectionTitle>
<ResourceList>
{templates.map((template) => (
<ResourceItem
key={template.name}
media={<Code strokeWidth={1.5} size={16} className="translate-y-[-9px]" />}
onClick={() => {
track('edge_function_template_clicked', {
templateName: template.name,
origin: 'functions_page',
})
}}
>
<Link href={`/project/${ref}/functions/new?template=${template.value}`}>
<p>{template.name}</p>
<p className="text-sm text-foreground-lighter">{template.description}</p>
</Link>
</ResourceItem>
))}
</ResourceList>
</>
)
}
export const FunctionsInstructionsLocal = () => {
const showStripeExample = useIsFeatureEnabled('edge_functions:show_stripe_example')
const templates = useMemo(() => {
if (showStripeExample) {
return EDGE_FUNCTION_TEMPLATES
}
// Filter out Stripe template
return EDGE_FUNCTION_TEMPLATES.filter((template) => template.value !== 'stripe-webhook')
}, [showStripeExample])
return (
<>
<div className="flex flex-col gap-y-4">
<Card>
<CardHeader>
<CardTitle>Developing Edge Functions with the CLI</CardTitle>
</CardHeader>
<CardContent
className={cn(
'p-0 flex flex-col',
'2xl:grid 2xl:grid-cols-[repeat(auto-fit,minmax(240px,1fr))] 2xl:divide-y-0 2xl:divide-x',
'divide-y divide-default items-stretch'
)}
>
<div className="p-8">
<div className="flex items-center gap-2">
<Code size={20} />
<h4 className="text-base text-foreground">Create an Edge Function</h4>
</div>
<p className="text-sm text-foreground-light mt-1 mb-4 prose [&>code]:text-xs text-sm max-w-full">
Create a new edge function called <code>hello-world</code> in your project via the
Supabase CLI.
</p>
<div className="mb-4">
<CodeBlock
language="bash"
hideLineNumbers={true}
className={cn(
'px-3.5 max-w-full prose dark:prose-dark [&>code]:m-0 2xl:min-h-28'
)}
value="supabase functions new hello-world"
/>
</div>
<DocsButton
href={`${DOCS_URL}/guides/functions/local-quickstart#create-an-edge-function`}
/>
</div>
<div className="p-8">
<div className="flex items-center gap-2">
<Play size={20} />
<h4 className="text-base text-foreground">Run Edge Functions</h4>
</div>
<p className="text-sm text-foreground-light mt-1 mb-4 prose [&>code]:text-xs text-sm max-w-full">
You can run your Edge Function locally using <code>supabase functions serve</code>.
</p>
<div className="mb-4">
<CodeBlock
language="bash"
hideLineNumbers={true}
className={cn(
'px-3.5 max-w-full prose dark:prose-dark [&>code]:m-0 2xl:min-h-28'
)}
value={`
supabase start # start the supabase stack
supabase functions serve # start the Functions watcher`.trim()}
/>
</div>
<DocsButton
href={`${DOCS_URL}/guides/functions/local-quickstart#running-edge-functions-locally`}
/>
</div>
<div className="p-8">
<div className="flex items-center gap-2">
<Terminal strokeWidth={1.5} size={20} />
<h4 className="text-base text-foreground">Invoke Edge Functions</h4>
</div>
<p className="text-sm text-foreground-light mt-1 mb-4">
While serving your local Edge Functions, you can invoke it using cURL or one of the
client libraries.
</p>
<div className="mb-4">
<CodeBlock
language="bash"
hideLineNumbers={true}
className={cn(
'px-3.5 max-w-full prose dark:prose-dark [&>code]:m-0 2xl:min-h-28'
)}
value={`
curl --request POST 'http://localhost:54321/functions/v1/hello-world' \\
--header 'Authorization: Bearer SUPABASE_ANON_KEY' \\
--header 'Content-Type: application/json' \\
--data '{ "name":"Functions" }'`.trim()}
/>
</div>
<DocsButton
href={`${DOCS_URL}/guides/functions/local-quickstart#invoking-edge-functions-locally`}
/>
</div>
</CardContent>
</Card>
<Card>
<CardHeader>
<CardTitle>Self-hosted Supabase</CardTitle>
</CardHeader>
<CardContent className="p-0 grid grid-cols-[repeat(auto-fit,minmax(240px,1fr))] divide-y md:divide-y-0 md:divide-x divide-default items-stretch">
<div className="p-8">
<p className="text-sm text-foreground-light mt-1 mb-4">
Edge Functions are available in self-hosted Supabase via Supabase Edge Runtime.
Unlike the platform, functions must be added manually — place each function at{' '}
<code className="text-code-inline">
volumes/functions/&lt;function-name&gt;/index.ts
</code>{' '}
and restart the <code className="text-code-inline">functions</code> service to pick
up changes. See the guide to learn more about configuration, secrets, and routing.
</p>
<DocsButton href={`${DOCS_URL}/guides/self-hosting/self-hosted-functions`} />
</div>
</CardContent>
</Card>
<ScaffoldSectionTitle className="text-xl mt-12">Explore our templates</ScaffoldSectionTitle>
<ResourceList>
{templates.map((template) => (
<Dialog key={template.name}>
<DialogTrigger asChild>
<ResourceItem
key={template.name}
media={<Code strokeWidth={1.5} size={16} className="translate-y-[-9px]" />}
>
<div>
<p>{template.name}</p>
<p className="text-sm text-foreground-lighter">{template.description}</p>
</div>
</ResourceItem>
</DialogTrigger>
<DialogContent size="large">
<DialogHeader>
<DialogTitle>{template.name}</DialogTitle>
<DialogDescription>{template.description}</DialogDescription>
</DialogHeader>
<Separator />
<DialogSection className="p-0!">
<CodeBlock
language="ts"
hideLineNumbers={true}
className={cn(
'border-0 rounded-none px-3.5 max-w-full prose dark:prose-dark [&>code]:m-0 max-h-[420px]'
)}
value={template.content}
/>
</DialogSection>
</DialogContent>
</Dialog>
))}
</ResourceList>
</div>
</>
)
}
export const FunctionsSecretsEmptyStateLocal = () => {
return (
<>
<Card>
<CardHeader>
<CardTitle>Local development & CLI</CardTitle>
</CardHeader>
<CardContent>
<div className="text-sm text-foreground-light mb-4">
<p className="mb-2">Secrets can be loaded in two ways:</p>
<ul className="list-disc pl-6 space-y-1">
<li>
Place a <code className="text-code-inline">.env</code> file at{' '}
<code className="text-code-inline">supabase/functions/.env</code> — picked up
automatically on <code className="text-code-inline">supabase start</code>.
</li>
<li>
Pass <code className="text-code-inline">--env-file</code> to{' '}
<code className="text-code-inline">supabase functions serve</code>, e.g.{' '}
<code className="text-code-inline">
supabase functions serve --env-file ./path/to/.env-file
</code>
</li>
</ul>
</div>
<DocsButton href={`${DOCS_URL}/guides/functions/secrets#using-the-cli`} />
</CardContent>
</Card>
<Card>
<CardHeader>
<CardTitle>Self-Hosted Supabase</CardTitle>
</CardHeader>
<CardContent>
<p className="text-sm text-foreground-light mb-4">
Configure secrets in your <code className="text-code-inline">.env</code> file and{' '}
<code className="text-code-inline">docker-compose.yml</code> under the{' '}
<code className="text-code-inline">functions</code> service.
</p>
<DocsButton
href={`${DOCS_URL}/guides/self-hosting/self-hosted-functions#custom-environment-variables`}
/>
</CardContent>
</Card>
</>
)
}