Files
supabase/apps/studio/components/interfaces/SQLEditor/useRunSource.ts
Charis 0ed49231b7 refactor(studio): unify CellSource and the SQL editor's QuerySource into QuerySourceBinding (#49072)
Third of a stack. **Stacked on #49070** (which is stacked on #49069) —
review those first. Base retargets automatically as each merges.

Mechanical throughout; no behavior change.

## The problem

Three types described where a query runs, and no two agreed:

| | shape |
|---|---|
| `CellSource` (registry) | `{ id, type, parameters: { … } }` — `id` and
`type` always held the same literal |
| `QuerySource` (SQL editor) | `{ type: 'database' } \| { type: 'logs',
dateRange }` |
| notebook cells | flat per-backend fields, neither of the above |

Anything crossing between them needed a translation that dropped fields
on the way — which is how a notebook cell's replica selection had
nowhere to go.

## What changed

One `QuerySourceBinding`: a backend `_tag` with that backend's
parameters spread flat beside it, borrowed from the wire schema (#49069)
so the binding and the persisted cell agree by construction.

- **`QuerySource` is deleted.** `useRunSource` returns the shared
binding, so `runSource.type`/`dateRange` become `_tag`/`time_range`
across the SQL editor — that is most of the file count here.
- **`getQuerySourceBinding`** projects a notebook cell onto a binding;
**`toQuerySourceBinding`** does the same for any backend-tagged carrier.
Both overloaded so an already-narrowed caller gets the matching binding
back rather than the union, which keeps the result spreadable without
re-narrowing.
- **`ExplorerQuerySourceMenu`** drops its inline copy of the
custom-range and upgrade-prompt logic in favor of `useLogsCustomRange`,
which the SQL editor menu already used.

The registry keeps only what is genuinely runtime: endpoints, labels,
icons, availability, defaults. What a query *is* stays in the wire
schema.

## Verification

Typecheck, Prettier, and the lint ratchet clean. 405 tests pass across
the notebook schema, query sources, the logs components, the SQL editor,
and the Explorer surfaces.

<!-- This is an auto-generated comment: release notes by coderabbit.ai
-->
## Summary by CodeRabbit

* **Improvements**
* Updated query source handling across Explorer and SQL Editor for a
more consistent selection experience.
* Database and log sources now preserve identifiers and time ranges more
reliably when switching or editing queries.
* Source menus, labels, icons, validation, and query execution now
reflect the selected source more accurately.

* **Bug Fixes**
* Invalid or outdated saved source settings now safely fall back to a
database source.
* Improved log-source detection and time-range handling throughout query
editing and execution.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->

---------

Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
2026-08-14 15:09:29 +07:00

40 lines
1.7 KiB
TypeScript

import { useParams } from 'common'
import { useMemo } from 'react'
import { isLogsSource, resolveSnippetSource } from './querySource'
import {
DEFAULT_LOG_TIME_RANGE,
type QuerySourceBinding,
} from '@/data/query-sources/query-source-registry'
import { useSqlEditorSessionSnapshot } from '@/state/sql-editor/sql-editor-session-state'
import { useSqlEditorV2StateSnapshot } from '@/state/sql-editor/sql-editor-state'
/**
* Resolves where a snippet's query runs. A `log_sql` snippet targets the logs
* backend and carries its session time range (falling back to the default when
* the user hasn't picked one); every other snippet targets the database. Source
* is derived from the snippet's content type and is NOT flag-gated here — a
* URL-opened logs snippet routes correctly even with the feature flag off.
*
* Before the snippet exists in the store (a fresh `/sql/new` tab, materialized
* lazily on the first keystroke) the source falls back to the `?source=` URL
* param, so a "New logs query" tab shows the logs toolbar and range picker
* immediately rather than flashing the database controls until the user types.
*/
export function useRunSource(id: string): QuerySourceBinding {
const { source: sourceParam } = useParams()
const snapV2 = useSqlEditorV2StateSnapshot()
const sessionSnap = useSqlEditorSessionSnapshot()
const snippet = snapV2.snippets[id]?.snippet
const source = resolveSnippetSource(snippet, sourceParam)
const logRange = sessionSnap.logRange[id]
return useMemo<QuerySourceBinding>(() => {
if (isLogsSource(source)) {
return { _tag: 'logs', time_range: logRange ?? DEFAULT_LOG_TIME_RANGE }
}
return { _tag: 'database' }
}, [source, logRange])
}