mirror of
https://github.com/supabase/supabase.git
synced 2026-10-09 11:25: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 -->
192 lines
6.3 KiB
TypeScript
192 lines
6.3 KiB
TypeScript
import { useParams } from 'common'
|
|
import { Loader2 } from 'lucide-react'
|
|
import { useRouter } from 'next/router'
|
|
import { parseAsBoolean, parseAsString, useQueryState } from 'nuqs'
|
|
import { MouseEvent, useEffect, useMemo, useRef, useState } from 'react'
|
|
import { toast } from 'sonner'
|
|
import { LoadingLine } from 'ui'
|
|
|
|
import { formatCronJobColumns } from './CronJobs.utils'
|
|
import { CronJobRunDetailsOverflowNotice } from './CronJobsTab.CleanupNotice'
|
|
import { CronJobsTabDataGrid } from './CronJobsTab.DataGrid'
|
|
import { CronJobsTabHeader } from './CronJobsTab.Header'
|
|
import { useCronJobsData } from './CronJobsTab.useCronJobsData'
|
|
import { DeleteCronJob } from './DeleteCronJob'
|
|
import { CreateCronJobSheet } from '@/components/interfaces/Integrations/CronJobs/CreateCronJobSheet/CreateCronJobSheet'
|
|
import { CronJob } from '@/data/database-cron-jobs/database-cron-jobs-infinite-query'
|
|
import { useInfiniteScroll } from '@/hooks/misc/useInfiniteScroll'
|
|
import { useSelectedProjectQuery } from '@/hooks/misc/useSelectedProject'
|
|
import { cleanPointerEventsNoneOnBody } from '@/lib/helpers'
|
|
import { createNavigationHandler } from '@/lib/navigation'
|
|
import { useTrack } from '@/lib/telemetry/track'
|
|
import { SHORTCUT_IDS } from '@/state/shortcuts/registry'
|
|
import { useShortcut } from '@/state/shortcuts/useShortcut'
|
|
|
|
const EMPTY_CRON_JOB = { jobname: '', schedule: '', active: true, command: '' }
|
|
|
|
export const CronjobsTab = () => {
|
|
const router = useRouter()
|
|
const { ref } = useParams()
|
|
const { data: project } = useSelectedProjectQuery()
|
|
const track = useTrack()
|
|
|
|
const [searchQuery, setSearchQuery] = useQueryState('search', parseAsString.withDefault(''))
|
|
|
|
const [search, setSearch] = useState(searchQuery)
|
|
|
|
const handleSearchSubmit = () => {
|
|
const trimmed = search.trim()
|
|
setSearchQuery(trimmed.length > 0 ? trimmed : null)
|
|
}
|
|
const handleClearSearch = () => {
|
|
setSearch('')
|
|
setSearchQuery(null)
|
|
}
|
|
|
|
const { grid, count } = useCronJobsData({
|
|
projectRef: project?.ref,
|
|
connectionString: project?.connectionString,
|
|
searchQuery,
|
|
})
|
|
|
|
const [createCronJobSheetShown, setCreateCronJobSheetShown] = useQueryState(
|
|
'new',
|
|
parseAsBoolean.withDefault(false).withOptions({ clearOnDefault: true })
|
|
)
|
|
|
|
const [cronJobIdForEditing, setCronJobForEditing] = useQueryState('edit', parseAsString)
|
|
const cronJobForEditing = grid.rows.find((j) => j.jobid.toString() === cronJobIdForEditing)
|
|
|
|
const [, setCronJobForDeletion] = useQueryState('delete', parseAsString)
|
|
|
|
const columns = useMemo(
|
|
() =>
|
|
formatCronJobColumns({
|
|
onSelectEdit: (job: CronJob) => {
|
|
track('cron_job_update_clicked')
|
|
setCronJobForEditing(job.jobid.toString())
|
|
},
|
|
onSelectDelete: (job: CronJob) => {
|
|
track('cron_job_delete_clicked')
|
|
setCronJobForDeletion(job.jobid.toString())
|
|
},
|
|
}),
|
|
[track, setCronJobForEditing, setCronJobForDeletion]
|
|
)
|
|
|
|
const handleScroll = useInfiniteScroll({
|
|
isLoading: grid.isLoading,
|
|
isFetchingNextPage: grid.isFetchingNextPage,
|
|
hasNextPage: grid.hasNextPage,
|
|
fetchNextPage: grid.fetchNextPage,
|
|
})
|
|
|
|
const onOpenCreateJobSheet = () => {
|
|
track('cron_job_create_clicked')
|
|
setCreateCronJobSheetShown(true)
|
|
}
|
|
|
|
const searchInputRef = useRef<HTMLInputElement>(null)
|
|
|
|
useShortcut(
|
|
SHORTCUT_IDS.LIST_PAGE_FOCUS_SEARCH,
|
|
() => {
|
|
searchInputRef.current?.focus()
|
|
searchInputRef.current?.select()
|
|
},
|
|
{ label: 'Search cron jobs' }
|
|
)
|
|
useShortcut(SHORTCUT_IDS.LIST_PAGE_RESET_FILTERS, handleClearSearch)
|
|
useShortcut(SHORTCUT_IDS.LIST_PAGE_NEW_ITEM, onOpenCreateJobSheet, { label: 'Create cron job' })
|
|
|
|
// Row click handler
|
|
const handleRowClick = (row: CronJob, event: MouseEvent<HTMLDivElement>) => {
|
|
const { jobid, jobname } = row
|
|
const url = `/project/${ref}/integrations/cron/jobs/${jobid}?child-label=${encodeURIComponent(
|
|
jobname || `Job #${jobid}`
|
|
)}`
|
|
|
|
track('cron_job_history_clicked')
|
|
|
|
createNavigationHandler(url, router)(event)
|
|
}
|
|
|
|
const onClose = () => {
|
|
setCronJobForEditing(null)
|
|
setCreateCronJobSheetShown(false)
|
|
cleanPointerEventsNoneOnBody(500)
|
|
}
|
|
|
|
useEffect(() => {
|
|
if (grid.isSuccess && !!cronJobIdForEditing && !cronJobForEditing) {
|
|
toast('Cron job not found')
|
|
setCronJobForEditing(null)
|
|
}
|
|
}, [cronJobForEditing, cronJobIdForEditing, grid.isSuccess, setCronJobForEditing])
|
|
|
|
return (
|
|
<>
|
|
<div className="h-full w-full space-y-4">
|
|
<div className="h-full w-full flex flex-col relative">
|
|
<CronJobsTabHeader
|
|
search={search}
|
|
isRefreshing={grid.isRefetching && !grid.isFetchingNextPage}
|
|
searchInputRef={searchInputRef}
|
|
onSearchChange={setSearch}
|
|
onSearchSubmit={handleSearchSubmit}
|
|
onClearSearch={handleClearSearch}
|
|
onRefresh={grid.refetch}
|
|
onCreateJob={onOpenCreateJobSheet}
|
|
/>
|
|
<LoadingLine loading={grid.isLoading || grid.isRefetching || grid.isFetchingNextPage} />
|
|
{grid.isMinimal && (
|
|
<CronJobRunDetailsOverflowNotice
|
|
queryCost={grid.queryCost}
|
|
refetchJobs={grid.refetch}
|
|
/>
|
|
)}
|
|
<CronJobsTabDataGrid
|
|
columns={columns}
|
|
rows={grid.rows}
|
|
isLoading={grid.isLoading}
|
|
error={grid.error}
|
|
searchQuery={searchQuery}
|
|
onScroll={handleScroll}
|
|
onRowClick={handleRowClick}
|
|
/>
|
|
<CronJobsFooter count={count} />
|
|
</div>
|
|
</div>
|
|
|
|
<DeleteCronJob />
|
|
|
|
<CreateCronJobSheet
|
|
open={!!createCronJobSheetShown || !!cronJobForEditing}
|
|
selectedCronJob={cronJobForEditing ?? EMPTY_CRON_JOB}
|
|
onClose={onClose}
|
|
/>
|
|
</>
|
|
)
|
|
}
|
|
|
|
// Footer component for displaying job count
|
|
interface CronJobsFooterProps {
|
|
count: {
|
|
value: number | undefined
|
|
isEstimate: boolean
|
|
isLoading: boolean
|
|
}
|
|
}
|
|
|
|
const CronJobsFooter = ({ count }: CronJobsFooterProps) => (
|
|
<div className="flex justify-between min-h-9 h-9 overflow-hidden items-center px-6 w-full border-t text-xs text-foreground-light">
|
|
{count.isLoading ? (
|
|
<span className="flex items-center gap-2">
|
|
<Loader2 size={14} className="animate-spin" /> Loading...
|
|
</span>
|
|
) : (
|
|
`Total: ${count.value ?? 0} jobs${count.isEstimate ? ' (estimate)' : ''}`
|
|
)}
|
|
</div>
|
|
)
|