mirror of
https://github.com/supabase/supabase.git
synced 2026-09-06 18:11:51 +08:00
d5653f1f92
## What PR 3 of a stacked refactor of the SQL editor snippet state. Replaces the two overlapping pieces of snippet lifecycle state — the `savingStates` map (`IDLE|UPDATING|UPDATING_FAILED`) and the `isNotSavedInDatabaseYet` boolean — with a single `SnippetStatus` enum. ## Status is attached at the data layer (never absent) - `SnippetStatus` + `SnippetWithContent` now live in `data/content`. The snippet queries attach `status: 'saved'` via a typed `withSavedStatus()` helper, and `upsertContent` returns `SnippetWithContent` so move/rename responses carry status too. - A SQL-typed `getSqlSnippetById`/`useSqlSnippetByIdQuery` returns `SnippetWithContent` (the generic `useContentIdQuery` stays for Reports, which use it). `[id].tsx` loads content with **no casting**. - `'new'` is attached on local creation (`createSqlSnippetSkeletonV2`). ## Behavior Behavior-preserving for the existing auto-save flow (faithful mapping of both old fields, including the replication-lag swallow). One incidental fix: the read-only/saving indicator now also covers a brand-new snippet's first save (previously only re-saves of persisted snippets had distinct saving/failed states in some paths). ## Tests New `sql-editor-lifecycle.test.ts` (29 tests) covering every predicate and transition; existing rules tests updated. `pnpm --filter studio typecheck` clean; 52 state/sql-editor unit tests pass. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit ## Release Notes * **Refactor** * Restructured SQL snippet persistence tracking, replacing boolean flags with a comprehensive status system for clearer visibility into save progress. * Enhanced saving indicator UI to reflect accurate snippet save states. * **Tests** * Added test coverage for snippet persistence state transitions and lifecycle scenarios. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
74 lines
2.3 KiB
TypeScript
74 lines
2.3 KiB
TypeScript
import { InfiniteData, useInfiniteQuery } from '@tanstack/react-query'
|
|
|
|
import { contentKeys } from './keys'
|
|
import { SNIPPET_PAGE_LIMIT, withSavedStatus } from './sql-folders-query'
|
|
import { get, handleError } from '@/data/fetchers'
|
|
import type { ResponseError, UseCustomInfiniteQueryOptions } from '@/types'
|
|
|
|
export type SQLSnippetFolderContentsVariables = {
|
|
projectRef?: string
|
|
folderId?: string
|
|
cursor?: string
|
|
name?: string
|
|
sort?: 'name' | 'inserted_at'
|
|
}
|
|
|
|
export async function getSQLSnippetFolderContents(
|
|
{ projectRef, folderId, cursor, sort, name }: SQLSnippetFolderContentsVariables,
|
|
signal?: AbortSignal
|
|
) {
|
|
if (typeof projectRef === 'undefined') throw new Error('projectRef is required')
|
|
if (typeof folderId === 'undefined') throw new Error('folderId is required')
|
|
|
|
const sortOrder = sort === 'name' ? 'asc' : 'desc'
|
|
|
|
const { data, error } = await get('/platform/projects/{ref}/content/folders/{id}', {
|
|
params: {
|
|
path: { ref: projectRef, id: folderId },
|
|
query: {
|
|
cursor,
|
|
limit: SNIPPET_PAGE_LIMIT.toString(),
|
|
sort_by: sort,
|
|
sort_order: sortOrder,
|
|
name,
|
|
},
|
|
},
|
|
signal,
|
|
})
|
|
|
|
if (error) handleError(error)
|
|
return {
|
|
...data.data,
|
|
contents: (data.data.contents ?? []).map(withSavedStatus),
|
|
cursor: data.cursor,
|
|
}
|
|
}
|
|
|
|
export type SQLSnippetFolderContentsData = Awaited<ReturnType<typeof getSQLSnippetFolderContents>>
|
|
export type SQLSnippetFolderContentsError = ResponseError
|
|
|
|
export const useSQLSnippetFolderContentsQuery = <TData = SQLSnippetFolderContentsData>(
|
|
{ projectRef, folderId, name, sort }: Omit<SQLSnippetFolderContentsVariables, 'cursor'>,
|
|
{
|
|
enabled = true,
|
|
...options
|
|
}: UseCustomInfiniteQueryOptions<
|
|
SQLSnippetFolderContentsData,
|
|
SQLSnippetFolderContentsError,
|
|
InfiniteData<TData>,
|
|
readonly unknown[],
|
|
string | undefined
|
|
> = {}
|
|
) =>
|
|
useInfiniteQuery({
|
|
queryKey: contentKeys.folderContents(projectRef, folderId, { name, sort }),
|
|
queryFn: ({ signal, pageParam }) =>
|
|
getSQLSnippetFolderContents({ projectRef, folderId, cursor: pageParam, name, sort }, signal),
|
|
enabled: enabled && typeof projectRef !== 'undefined' && typeof folderId !== 'undefined',
|
|
initialPageParam: undefined,
|
|
getNextPageParam(lastPage) {
|
|
return lastPage.cursor
|
|
},
|
|
...options,
|
|
})
|