mirror of
https://github.com/supabase/supabase.git
synced 2026-09-07 02:20:52 +08:00
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 -->
65 lines
1.8 KiB
TypeScript
65 lines
1.8 KiB
TypeScript
import type { UpsertContentPayload } from '@/data/content/content-upsert-mutation'
|
|
import type { SnippetWithContent } from '@/data/content/sql-folders-query'
|
|
|
|
/**
|
|
*
|
|
* A snippet is read-only when it's shared to the project and you are not its
|
|
* owner. Returns true when editing IS allowed.
|
|
*
|
|
*/
|
|
export function canEditSnippet(
|
|
snippet: Pick<SnippetWithContent, 'visibility' | 'owner_id'>,
|
|
profileId?: number
|
|
): boolean {
|
|
return !(snippet.visibility === 'project' && snippet.owner_id !== profileId)
|
|
}
|
|
|
|
export function isSnippetOwner(
|
|
snippet: Pick<SnippetWithContent, 'owner_id'>,
|
|
profileId?: number
|
|
): boolean {
|
|
return profileId === snippet.owner_id
|
|
}
|
|
|
|
/**
|
|
*
|
|
* Shared snippets cannot live in a folder.
|
|
*
|
|
*/
|
|
export function validateMoveToFolder({
|
|
visibility,
|
|
folderId,
|
|
}: {
|
|
visibility?: SnippetWithContent['visibility']
|
|
folderId?: string | null
|
|
}): { ok: true } | { ok: false; error: string } {
|
|
if (visibility === 'project' && !!folderId) {
|
|
return { ok: false, error: 'Shared snippet cannot be within a folder' }
|
|
}
|
|
return { ok: true }
|
|
}
|
|
|
|
export type LoadedSnippet = SnippetWithContent & {
|
|
content: NonNullable<SnippetWithContent['content']>
|
|
}
|
|
export function isLoadedSnippet(snippet: SnippetWithContent): snippet is LoadedSnippet {
|
|
return snippet.content != null
|
|
}
|
|
|
|
export function buildUpsertPayload(snippet: LoadedSnippet, id: string): UpsertContentPayload {
|
|
const { name, description, visibility, project_id, owner_id, folder_id, content, favorite } =
|
|
snippet
|
|
return {
|
|
id,
|
|
type: snippet.type,
|
|
name: name ?? 'Untitled',
|
|
description: description ?? '',
|
|
visibility: visibility ?? 'user',
|
|
project_id: project_id ?? 0,
|
|
owner_id,
|
|
folder_id: folder_id ?? undefined,
|
|
favorite: favorite ?? false,
|
|
content: { ...content, content_id: id },
|
|
}
|
|
}
|