mirror of
https://github.com/supabase/supabase.git
synced 2026-06-12 17:27:58 +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 -->
192 lines
5.6 KiB
TypeScript
192 lines
5.6 KiB
TypeScript
import { AuthUsersSearchSubmittedEvent } from 'common/telemetry-constants'
|
|
import { Search, X } from 'lucide-react'
|
|
import { parseAsString, parseAsStringEnum, useQueryState } from 'nuqs'
|
|
import { Dispatch, forwardRef, SetStateAction } from 'react'
|
|
import {
|
|
Button,
|
|
cn,
|
|
Select,
|
|
SelectContent,
|
|
SelectGroup,
|
|
SelectItem,
|
|
SelectSeparator,
|
|
SelectTrigger,
|
|
SelectValue,
|
|
Tooltip,
|
|
TooltipContent,
|
|
TooltipTrigger,
|
|
} from 'ui'
|
|
import { Input } from 'ui-patterns/DataInputs/Input'
|
|
|
|
import {
|
|
PHONE_NUMBER_LEFT_PREFIX_REGEX,
|
|
SpecificFilterColumn,
|
|
UUIDV4_LEFT_PREFIX_REGEX,
|
|
} from './Users.constants'
|
|
import { onSearchInputEscape } from '@/lib/keyboard'
|
|
import { useTrack } from '@/lib/telemetry/track'
|
|
|
|
const getSearchPlaceholder = (column: SpecificFilterColumn): string => {
|
|
switch (column) {
|
|
case 'id':
|
|
return 'Search by user ID'
|
|
case 'email':
|
|
return 'Search by email'
|
|
case 'name':
|
|
return 'Search by name'
|
|
case 'phone':
|
|
return 'Search by phone'
|
|
case 'freeform':
|
|
return 'Search by user ID, email, phone or name'
|
|
default:
|
|
return 'Search users...'
|
|
}
|
|
}
|
|
|
|
interface UsersSearchProps {
|
|
search: string
|
|
setSearch: Dispatch<SetStateAction<string>>
|
|
improvedSearchEnabled?: boolean
|
|
telemetryProps: Omit<AuthUsersSearchSubmittedEvent['properties'], 'trigger'>
|
|
onSelectFilterColumn: (value: SpecificFilterColumn) => void
|
|
}
|
|
|
|
export const UsersSearch = forwardRef<HTMLInputElement, UsersSearchProps>(function UsersSearch(
|
|
{ search, setSearch, improvedSearchEnabled = false, telemetryProps, onSelectFilterColumn },
|
|
ref
|
|
) {
|
|
const [, setSelectedId] = useQueryState(
|
|
'show',
|
|
parseAsString.withOptions({ history: 'push', clearOnDefault: true })
|
|
)
|
|
const [, setFilterKeywords] = useQueryState('keywords', { defaultValue: '' })
|
|
const [specificFilterColumn] = useQueryState<SpecificFilterColumn>(
|
|
'filter',
|
|
parseAsStringEnum<SpecificFilterColumn>([
|
|
'id',
|
|
'email',
|
|
'phone',
|
|
'name',
|
|
'freeform',
|
|
]).withDefault('email')
|
|
)
|
|
|
|
const track = useTrack()
|
|
|
|
const searchInvalid =
|
|
!search ||
|
|
specificFilterColumn === 'freeform' ||
|
|
specificFilterColumn === 'email' ||
|
|
specificFilterColumn === 'name'
|
|
? false
|
|
: specificFilterColumn === 'id'
|
|
? !search.match(UUIDV4_LEFT_PREFIX_REGEX)
|
|
: !search.match(PHONE_NUMBER_LEFT_PREFIX_REGEX)
|
|
|
|
const onSubmitSearch = () => {
|
|
const s = search.trim().toLocaleLowerCase()
|
|
setFilterKeywords(s)
|
|
setSelectedId(null)
|
|
track('auth_users_search_submitted', {
|
|
trigger: 'search_input',
|
|
...telemetryProps,
|
|
keywords: s,
|
|
})
|
|
}
|
|
|
|
return (
|
|
<div className="flex items-center">
|
|
<div className="text-xs h-[26px] flex items-center px-1.5 border border-strong rounded-l-md bg-surface-300">
|
|
<Search size={14} />
|
|
</div>
|
|
|
|
<Select
|
|
value={specificFilterColumn}
|
|
onValueChange={(v) => onSelectFilterColumn(v as typeof specificFilterColumn)}
|
|
>
|
|
<SelectTrigger
|
|
size="tiny"
|
|
className={cn(
|
|
'w-[130px] bg-transparent! rounded-none -ml-px',
|
|
specificFilterColumn === 'freeform' && 'text-warning'
|
|
)}
|
|
>
|
|
<SelectValue />
|
|
</SelectTrigger>
|
|
<SelectContent>
|
|
<SelectGroup>
|
|
<SelectItem value="id" className="text-xs">
|
|
User ID
|
|
</SelectItem>
|
|
<SelectItem value="email" className="text-xs">
|
|
Email address
|
|
</SelectItem>
|
|
{improvedSearchEnabled && (
|
|
<SelectItem value="name" className="text-xs">
|
|
Name
|
|
</SelectItem>
|
|
)}
|
|
<SelectItem value="phone" className="text-xs">
|
|
Phone number
|
|
</SelectItem>
|
|
{!improvedSearchEnabled && (
|
|
<>
|
|
<SelectSeparator />
|
|
<Tooltip>
|
|
<TooltipTrigger>
|
|
<SelectItem value="freeform" className="text-xs">
|
|
Unified search
|
|
</SelectItem>
|
|
</TooltipTrigger>
|
|
<TooltipContent side="right" className="w-64 text-center">
|
|
Search by all columns at once, including mid-string search. May impact database
|
|
performance if you have many users.
|
|
</TooltipContent>
|
|
</Tooltip>
|
|
</>
|
|
)}
|
|
</SelectGroup>
|
|
</SelectContent>
|
|
</Select>
|
|
|
|
<Input
|
|
ref={ref}
|
|
size="tiny"
|
|
containerClassName="w-[245px] rounded-l-none -ml-px"
|
|
className={cn(
|
|
'bg-transparent',
|
|
searchInvalid ? 'text-red-900 dark:border-red-900' : '',
|
|
search.length > 1 && 'pr-6'
|
|
)}
|
|
placeholder={getSearchPlaceholder(specificFilterColumn)}
|
|
value={search}
|
|
onChange={(e) => setSearch(e.target.value)}
|
|
onKeyDown={(e) => {
|
|
if (e.code === 'Enter' || e.code === 'NumpadEnter') {
|
|
if (!searchInvalid) onSubmitSearch()
|
|
return
|
|
}
|
|
onSearchInputEscape(search, () => {
|
|
setSearch('')
|
|
setFilterKeywords('')
|
|
})(e)
|
|
}}
|
|
actions={
|
|
search ? (
|
|
<Button
|
|
size="tiny"
|
|
type="text"
|
|
className="p-0 h-5 w-5"
|
|
icon={<X className={cn(searchInvalid ? 'text-red-900' : '')} />}
|
|
onClick={() => {
|
|
setSearch('')
|
|
setFilterKeywords('')
|
|
}}
|
|
/>
|
|
) : null
|
|
}
|
|
/>
|
|
</div>
|
|
)
|
|
})
|