mirror of
https://github.com/supabase/supabase.git
synced 2026-10-06 09:55:06 +03:00
Charis
fa5eb17277
Stacked on #48305. ## What PR 3 of the stacked SQL-editor query-source series (Database vs Logs). Stacked on the PR 2 branch `charislam/log-sql-content-shape`. Turns `SnippetWithContent` into a discriminated union on `type` and makes all snippet writes source-aware: - `data/content/sql-folders-query.ts`: `SnippetWithContent` is now `{ type: 'sql'; content?: SqlSnippets.Content } | { type: 'log_sql'; content?: LogSqlSnippets.Content } | { type: 'report'; content?: never }`. `report` is kept (the content endpoints' wire type carries it) but has no SQL content — its body is `Dashboards.Content`, loaded through the separate `Content` union. - `setSql` brands per type (`untrustedLogSql` vs `untrustedSql`). - `buildUpsertPayload` persists `snippet.type` (no longer hardcoded `'sql'`). - `createSqlSnippetSkeletonV2({ source })` emits the matching type + content shape with the `as any` cast removed. - New `components/interfaces/SQLEditor/querySource.ts`: `SqlSnippetSource` + `getSnippetSource`. - `seedSnippet` test helper gains a `source` arg. - New `remapWireSnippet` boundary helper in `content-remap.ts` concentrates the single wire->domain assertion, so `content-id-query` / `content-upsert-mutation` call sites are cast-free (no `as unknown as`). - Collateral: query result types aligned to the union; `updateSnippet` no longer accepts `type` (source is immutable); db-only editor read paths narrow away `log_sql`. ## Why Impossible-states-impossible typing: a snippet's brand follows its content type, so logs SQL and database SQL can never cross execution paths. No behavior change for existing database snippets. ## Testing - \`pnpm typecheck\` — clean - \`pnpm --filter studio run lint:ratchet\` — no new warnings - \`pnpm test:studio\` (data/content, SQLEditor, state/sql-editor) — passing, including new tests for \`getSnippetSource\`, source-aware \`setSql\`, type-aware \`buildUpsertPayload\`, and both skeleton shapes. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **New Features** * Added source-aware creation for SQL editor snippets, including log-based SQL snippets. * Introduced backend source mapping so log snippets are treated as log_sql. * **Bug Fixes** * Improved SQL retrieval/prettification so log snippets no longer use the wrong fallback content. * Ensured log snippets are sanitized and preserve correct type, content, identifiers, and statuses during save/upsert flows. * **Tests** * Expanded unit and integration coverage for log snippet creation, source mapping, editing, prettification, and upsert payloads. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
83 lines
3.2 KiB
TypeScript
83 lines
3.2 KiB
TypeScript
import { useQuery } from '@tanstack/react-query'
|
|
import { components } from 'api-types'
|
|
|
|
import type { Content } from './content-query'
|
|
import { remapSqlContentField, remapWireSnippet } from './content-remap'
|
|
import { contentKeys } from './keys'
|
|
import type { SnippetWithContent } from './sql-folders-query'
|
|
import { get, handleError } from '@/data/fetchers'
|
|
import type { ResponseError, UseCustomQueryOptions } from '@/types'
|
|
|
|
export type GetUserContentByIdResponse = Omit<
|
|
components['schemas']['GetUserContentByIdResponse'],
|
|
'content'
|
|
> & {
|
|
content: Content['content']
|
|
}
|
|
|
|
export async function getContentById(
|
|
{ projectRef, id }: { projectRef?: string; id?: string },
|
|
signal?: AbortSignal
|
|
) {
|
|
if (typeof projectRef === 'undefined') throw new Error('projectRef is required')
|
|
if (typeof id === 'undefined') throw new Error('Content ID is required')
|
|
|
|
const { data, error } = await get('/platform/projects/{ref}/content/item/{id}', {
|
|
params: { path: { ref: projectRef, id } },
|
|
signal,
|
|
})
|
|
|
|
if (error) throw handleError(error)
|
|
return remapSqlContentField(data as unknown as GetUserContentByIdResponse)
|
|
}
|
|
|
|
export type ContentIdData = Awaited<ReturnType<typeof getContentById>>
|
|
export type ContentIdError = ResponseError
|
|
|
|
// SQL-editor-specific fetch: the editor only ever loads SQL snippets, so the
|
|
// content body is typed as SQL content and the result is a SnippetWithContent
|
|
// (status 'saved') ready to drop into the store — no narrowing/casting at the
|
|
// call site. Reports etc. keep using the generic getContentById above.
|
|
export async function getSqlSnippetById(
|
|
{ projectRef, id }: { projectRef?: string; id?: string },
|
|
signal?: AbortSignal
|
|
): Promise<SnippetWithContent> {
|
|
if (typeof projectRef === 'undefined') throw new Error('projectRef is required')
|
|
if (typeof id === 'undefined') throw new Error('Content ID is required')
|
|
|
|
const { data, error } = await get('/platform/projects/{ref}/content/item/{id}', {
|
|
params: { path: { ref: projectRef, id } },
|
|
signal,
|
|
})
|
|
|
|
if (error) throw handleError(error)
|
|
return remapWireSnippet(data, 'saved')
|
|
}
|
|
|
|
export type SqlSnippetByIdData = Awaited<ReturnType<typeof getSqlSnippetById>>
|
|
|
|
export const useSqlSnippetByIdQuery = <TData = SqlSnippetByIdData>(
|
|
{ projectRef, id }: { projectRef?: string; id?: string },
|
|
{
|
|
enabled = true,
|
|
...options
|
|
}: UseCustomQueryOptions<SqlSnippetByIdData, ContentIdError, TData> = {}
|
|
) =>
|
|
useQuery<SqlSnippetByIdData, ContentIdError, TData>({
|
|
queryKey: contentKeys.resource(projectRef, id),
|
|
queryFn: ({ signal }) => getSqlSnippetById({ projectRef, id }, signal),
|
|
enabled: enabled && typeof projectRef !== 'undefined' && typeof id !== 'undefined',
|
|
...options,
|
|
})
|
|
|
|
export const useContentIdQuery = <TData = ContentIdData>(
|
|
{ projectRef, id }: { projectRef?: string; id?: string },
|
|
{ enabled = true, ...options }: UseCustomQueryOptions<ContentIdData, ContentIdError, TData> = {}
|
|
) =>
|
|
useQuery<ContentIdData, ContentIdError, TData>({
|
|
queryKey: contentKeys.resource(projectRef, id),
|
|
queryFn: ({ signal }) => getContentById({ projectRef, id }, signal),
|
|
enabled: enabled && typeof projectRef !== 'undefined' && typeof id !== 'undefined',
|
|
...options,
|
|
})
|