mirror of
https://github.com/supabase/supabase.git
synced 2026-09-07 02:20:52 +08:00
d153bab849
## What PR 6 of the SQL editor state re-layering stack. Moves ephemeral, never-persisted SQL editor state out of the snippet/folder "god store". **Session store** — `state/sql-editor/sql-editor-session-state.ts` holds per-snippet, read-by-many session state: - query `results` - `explainResults` - the row `limit` …with their mutators (`addResult`/`addResultError`/`resetResult`, `addExplainResult`/`addExplainResultError`/`resetExplainResult`, `resetResults`, `setLimit`). `removeSnippet` drops a snippet's session entries via `clearForSnippet(id)`. **Diff-request slice** — `state/sql-editor/sql-editor-diff-request.ts`. The Assistant's "Insert code" / "Replace code" diff is *not* per-snippet session state: it's a transient, fire-and-forget command produced outside the editor (e.g. query blocks / assistant) and consumed exactly once by whichever editor is active. It's modeled as a consume-once request (`requestDiff` / `consumeDiffRequest`) rather than durable state — the editor drains it on apply, so a stale diff can't leak into a later editor or session. (Previously this was `diffContent` in the god store: never cleared and triggered by object-reference identity.) Consumers read session state from `useSqlEditorSessionSnapshot` and the diff channel from `useSqlEditorDiffRequestSnapshot`, keeping `useSqlEditorV2StateSnapshot` only for snippets/folders. ### Why not the TanStack Query cache for results/explain? Editor execution is a **mutation**, not a keyed query — `mutation.data` is per-hook-instance and not keyed by snippet id, and there's no caching value to capture (re-running SQL must return *fresh* data, never a cached result). `EXPLAIN ANALYZE` actually executes the statement, so a declarative/auto-refetching `useQuery` is semantically wrong. Results/explain are imperative mutation outputs, scoped to the session, read by several decoupled consumers keyed by snippet id — exactly what a small in-memory keyed store models honestly. ## Consumers migrated - `SQLEditor.tsx` — results/explain/limit reads + `addResult`/`addResultError`/`addExplainResult`/`addExplainResultError`/`setLimit`; diff-apply effect now drains a consume-once request - `UtilityPanel.tsx`, `UtilityTabResults.tsx`, `UtilityTabExplain.tsx`, `UtilityActions.tsx` - `QueryBlock/EditQueryButton.tsx` — produces via `requestDiff` ## Notes - Result/explain types are kept verbatim from the god store (pre-existing `any` row/error types come along unchanged; tightening them is out of scope for this move). - `ref()` on result rows is preserved to avoid Valtio proxying large row sets. ## Tests - `sql-editor-session-state.test.ts` — result/explain mutators, `resetResults`, `clearForSnippet`, `limit` - `sql-editor-diff-request.test.ts` — `requestDiff`, `consumeDiffRequest` (drain + queue-of-one) Validation: - `pnpm --filter studio typecheck` ✅ - `pnpm exec vitest --run state/sql-editor/` ✅ (110 passed) - lint ✅ (no new errors) <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * SQL editor query results, EXPLAIN output, and the “Limit results to” setting now persist more reliably across a session. * AI-assisted SQL insert/replace actions now use a pending diff workflow to apply updates more consistently. * **Bug Fixes** * Results/EXPLAIN rendering and downloads stay in sync with the latest executed data. * Switching databases/snippets now clears the correct temporary results. * Diff application is more resilient when an editor is still loading, including empty-vs-non-empty editor cases. * **Tests** * Added coverage for the session and diff-request state logic. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
48 lines
1.6 KiB
TypeScript
48 lines
1.6 KiB
TypeScript
import { beforeEach, describe, expect, it } from 'vitest'
|
|
|
|
import { sqlEditorDiffRequestState } from './sql-editor-diff-request'
|
|
import { DiffType } from '@/components/interfaces/SQLEditor/SQLEditor.types'
|
|
|
|
// Module singleton — clear any pending request before each test.
|
|
beforeEach(() => {
|
|
sqlEditorDiffRequestState.pending = undefined
|
|
})
|
|
|
|
describe('sqlEditorDiffRequestState', () => {
|
|
it('is empty by default', () => {
|
|
expect(sqlEditorDiffRequestState.pending).toBeUndefined()
|
|
})
|
|
|
|
it('requestDiff queues a pending request', () => {
|
|
sqlEditorDiffRequestState.requestDiff('select 1', DiffType.Addition)
|
|
|
|
expect(sqlEditorDiffRequestState.pending).toEqual({
|
|
sql: 'select 1',
|
|
diffType: DiffType.Addition,
|
|
})
|
|
})
|
|
|
|
it('consumeDiffRequest returns the pending request and clears it', () => {
|
|
sqlEditorDiffRequestState.requestDiff('select 1', DiffType.Modification)
|
|
|
|
const consumed = sqlEditorDiffRequestState.consumeDiffRequest()
|
|
|
|
expect(consumed).toEqual({ sql: 'select 1', diffType: DiffType.Modification })
|
|
expect(sqlEditorDiffRequestState.pending).toBeUndefined()
|
|
})
|
|
|
|
it('consumeDiffRequest returns undefined when nothing is pending', () => {
|
|
expect(sqlEditorDiffRequestState.consumeDiffRequest()).toBeUndefined()
|
|
})
|
|
|
|
it('a later request replaces an unconsumed one (queue of one)', () => {
|
|
sqlEditorDiffRequestState.requestDiff('select 1', DiffType.Addition)
|
|
sqlEditorDiffRequestState.requestDiff('select 2', DiffType.Modification)
|
|
|
|
expect(sqlEditorDiffRequestState.consumeDiffRequest()).toEqual({
|
|
sql: 'select 2',
|
|
diffType: DiffType.Modification,
|
|
})
|
|
})
|
|
})
|