Files
supabase/apps/studio/components/interfaces/ExplainVisualizer/ExplainVisualizer.Header.tsx
Charis 0433eeb5f5 feat(studio): mark sql provenance for safety (#45336)
Mark provenance of SQL via the branded types SafeSqlFragment and
UntrustedSqlFragment. Only SafeSqlFragment should be executed;
UntrustedSqlFragments require some kind of implicit user approval (show
on screen + user has to click something) before they are promoted to
SafeSqlFragment.

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

* **New Features**
* Editor and RLS tester show loading states for inferred/generated SQL
and include a dedicated user SQL editor for safer edits.

* **Refactor**
* Platform-wide SQL handling tightened: snippets and AI-generated SQL
are treated as untrusted/display-only until promoted, improving safety
and consistency.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-05-04 13:08:06 -04:00

148 lines
5.2 KiB
TypeScript

import { Code, Eye, HelpCircle } from 'lucide-react'
import { Button, Tooltip, TooltipContent, TooltipTrigger } from 'ui'
import { buildExplainPrompt } from './ExplainVisualizer.ai'
import type { QueryPlanRow } from './ExplainVisualizer.types'
import { SIDEBAR_KEYS } from '@/components/layouts/ProjectLayout/LayoutSidebar/LayoutSidebarProvider'
import { AiAssistantDropdown } from '@/components/ui/AiAssistantDropdown'
import { useAiAssistantStateSnapshot } from '@/state/ai-assistant-state'
import { useSidebarManagerSnapshot } from '@/state/sidebar-manager-state'
import { useSqlEditorV2StateSnapshot } from '@/state/sql-editor-v2'
export interface ExplainSummary {
totalTime: number
hasSeqScan: boolean
hasIndexScan: boolean
}
export interface ExplainHeaderProps {
mode: 'visual' | 'raw'
onToggleMode: () => void
summary?: ExplainSummary
id?: string
rows?: readonly QueryPlanRow[]
}
export function ExplainHeader({ mode, onToggleMode, summary, id, rows }: ExplainHeaderProps) {
const isVisual = mode === 'visual'
const snapV2 = useSqlEditorV2StateSnapshot()
const { openSidebar } = useSidebarManagerSnapshot()
const aiSnap = useAiAssistantStateSnapshot()
const getPromptData = () => {
if (!id) return null
const snippet = snapV2.snippets[id]?.snippet
if (!snippet?.content?.unchecked_sql) return null
return buildExplainPrompt({
sql: snippet.content.unchecked_sql,
explainPlanRows: (rows as QueryPlanRow[]) ?? [],
})
}
const handleExplainWithAI = () => {
const promptData = getPromptData()
if (!promptData) return
openSidebar(SIDEBAR_KEYS.AI_ASSISTANT)
aiSnap.newChat({
sqlSnippets: [
{
label: 'Query',
content: promptData.query,
},
],
initialMessage: promptData.prompt,
})
}
const buildPromptForCopy = () => {
const promptData = getPromptData()
if (!promptData) return ''
// Combine SQL and prompt into a single copyable text
return `${promptData.prompt}\n\nSQL Query:\n\`\`\`sql\n${promptData.query}\n\`\`\``
}
const hasSummaryStats =
isVisual && summary && (summary.totalTime > 0 || (summary.hasSeqScan && !summary.hasIndexScan))
return (
<div className="bg-surface-100 border-b px-4 py-3 flex flex-col gap-3 text-xs">
{/* Title row */}
<div className="flex items-center justify-between text-sm">
<div className="flex items-center gap-2">
<h3 className="font-medium text-foreground">Query Execution Plan</h3>
<Tooltip>
<TooltipTrigger>
<HelpCircle
size="14"
strokeWidth={2}
className="text-foreground-lighter hover:text-foreground-light transition-colors cursor-help"
/>
</TooltipTrigger>
<TooltipContent side="top" className="max-w-xs p-4">
<h3 className="text-xs font-medium mb-2">How to read</h3>
<p className="text-foreground-light text-xs">
Start at the bottom where data is read from tables, then follow upward as each step
processes the results.
</p>
{isVisual && (
<>
<h3 className="text-xs font-medium mt-4 mb-2">Key</h3>
<div className="flex flex-col gap-1 text-foreground-light">
<div className="flex items-center gap-1.5">
<span className="inline-block w-1.5 h-1.5 rounded-full bg-warning" />
<span>Seq Scan (slow)</span>
</div>
<div className="flex items-center gap-1.5">
<span className="inline-block w-1.5 h-1.5 rounded-full bg-brand" />
<span>Index Scan (fast)</span>
</div>
</div>
</>
)}
</TooltipContent>
</Tooltip>
{/* Summary stats - only show in visual mode when we have the data */}
{hasSummaryStats && (
<div className="flex items-center gap-4 flex-wrap">
{summary.totalTime > 0 && (
<div className="flex items-center gap-2">
<span className="text-foreground-muted">/</span>
<span className="text-foreground-light">Total time</span>
<span className="font-medium text-foreground">
{summary.totalTime.toFixed(2)}ms
</span>
</div>
)}
</div>
)}
</div>
<div className="flex items-center gap-2">
{id && rows && (
<AiAssistantDropdown
label="Explain with AI"
buildPrompt={buildPromptForCopy}
onOpenAssistant={handleExplainWithAI}
telemetrySource="explain_visualizer"
size="tiny"
type="default"
/>
)}
<Button
type="default"
size="tiny"
icon={isVisual ? <Code size={14} /> : <Eye size={14} />}
onClick={onToggleMode}
>
{isVisual ? 'Raw' : 'Visual'}
</Button>
</div>
</div>
</div>
)
}