mirror of
https://github.com/supabase/supabase.git
synced 2026-10-05 17:35:10 +03:00
## What kind of change does this PR introduce? Bug fix and design-system update. Resolves DEPR-316. Follow-up rename (`text-brand` → `text-primary`) is in a dedicated PR (https://github.com/supabase/supabase/pull/50564) stacked on this one. ## What is the current behavior? `text-brand` resolves to the canonical bright brand green in places that need readable text, which fails WCAG AA on light surfaces. A separate `text-brand-display` token adds another green for large type. ## What is the new behavior? - `text-brand` maps to accessible `--primary` (light mode darkened to meet ~4.5:1 AA) - `--hue` / `--primary-hue` aligned to 157.5 - `text-brand-display` removed; former display callsites use `text-brand` - Bright fills/borders stay on `brand-default` - Design-system colour and typography docs updated | Before | After | | --- | --- | | <img width="514" height="112" alt="CleanShot 2026-09-02 at 11 13 09@2x" src="https://github.com/user-attachments/assets/4e0138a9-a32d-4e4c-a426-90736706e1e7" /> | <img width="512" height="138" alt="CleanShot 2026-09-21 at 11 42 05@2x" src="https://github.com/user-attachments/assets/164cc5b1-a0c5-4e93-95f1-80016641a114" /> | | <img width="864" height="266" alt="CleanShot 2026-09-02 at 11 13 53@2x" src="https://github.com/user-attachments/assets/3c1ca53f-bf9e-431e-bc15-816b4a275b8e" /> | <img width="882" height="248" alt="CleanShot 2026-09-21 at 11 41 37@2x" src="https://github.com/user-attachments/assets/24828e7b-ed6b-44cb-b9dc-becc3398bdfc" /> | | <img width="782" height="692" alt="CleanShot 2026-09-02 at 11 16 30@2x" src="https://github.com/user-attachments/assets/fc871977-77bc-47fb-9e0e-9284e0ecd5cc" /> | <img width="730" height="690" alt="CleanShot 2026-09-21 at 11 42 52@2x" src="https://github.com/user-attachments/assets/bf479515-d5f9-471e-b82d-f097c0f4b56c" /> | | <img width="480" height="306" alt="CleanShot 2026-09-02 at 11 18 53@2x" src="https://github.com/user-attachments/assets/03f341f4-f02e-44f8-a2b2-8c31670d0427" /> | <img width="470" height="300" alt="CleanShot 2026-09-21 at 11 43 19@2x" src="https://github.com/user-attachments/assets/9df18217-d5e6-48b8-ba0b-579d2664b94b" /> | | <img width="960" height="300" alt="CleanShot 2026-09-02 at 11 32 04@2x" src="https://github.com/user-attachments/assets/6b1d9373-7a71-4247-81ff-26441604b09d" /> | <img width="980" height="306" alt="CleanShot 2026-09-21 at 11 44 13@2x" src="https://github.com/user-attachments/assets/41ad4784-02ec-4b29-b860-32af9fa79aa8" /> | | <img width="924" height="214" alt="CleanShot 2026-09-02 at 11 34 44@2x" src="https://github.com/user-attachments/assets/1de661fe-c7b6-499b-a94f-e4737436ec79" /> | <img width="752" height="162" alt="CleanShot 2026-09-21 at 11 44 56@2x" src="https://github.com/user-attachments/assets/1811890f-0660-4445-84e9-447720954fa1" /> | ## To test Test each callsite **in light mode** (dark mode is largely unchanged). ### WWW - [Homepage](https://zone-www-dot-com-git-dnywh-depr-316-brand-text-tokens-supabase.vercel.app/): “Scale to millions” uses readable brand text (display token is gone) - [Careers](https://zone-www-dot-com-git-dnywh-depr-316-brand-text-tokens-supabase.vercel.app/careers): small “Careers” eyebrow readable; green dividers stay bright `brand-default` - [Contact](https://zone-www-dot-com-git-dnywh-depr-316-brand-text-tokens-supabase.vercel.app/contact-us): email / policy links use readable brand text - [Regions](https://zone-www-dot-com-git-dnywh-depr-316-brand-text-tokens-supabase.vercel.app/regions): “Ask about early access to BYOC” readable ### Docs - [Docs homepage](https://docs-git-dnywh-depr-316-brand-text-tokens-supabase.vercel.app/docs): “DOCS” wordmark and resource links readable - [Database overview](https://docs-git-dnywh-depr-316-brand-text-tokens-supabase.vercel.app/docs/guides/database/overview): nav / footer brand links readable - [JavaScript reference](https://docs-git-dnywh-depr-316-brand-text-tokens-supabase.vercel.app/docs/reference/javascript/introduction): active sidebar treatment readable ### Design system - [Typography](https://design-system-git-dnywh-depr-316-brand-text-tokens-supabase.vercel.app/docs/typography): documents `text-brand` only (no display) - [Colour usage](https://design-system-git-dnywh-depr-316-brand-text-tokens-supabase.vercel.app/docs/color-usage): `text-brand` vs `bg-brand-default` - [Design-system homepage](https://design-system-git-dnywh-depr-316-brand-text-tokens-supabase.vercel.app/): brand text examples across themes ### Studio - [Auth providers](https://studio-staging-git-dnywh-depr-316-brand-text-tokens-supabase.vercel.app/dashboard/project/_/auth/providers): enabled provider badge text readable; status dot stays bright - [Database policies](https://studio-staging-git-dnywh-depr-316-brand-text-tokens-supabase.vercel.app/dashboard/project/_/database/policies?new=true): template hover text more legible - [Database connections](https://studio-staging-git-dnywh-depr-316-brand-text-tokens-supabase.vercel.app/dashboard/project/_/observability/connections): “Live” status readable; animated dot stays bright green --------- Co-authored-by: Joshen Lim <joshenlimek@gmail.com>
147 lines
5.2 KiB
TypeScript
147 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/sql-editor-state'
|
|
|
|
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-default" />
|
|
<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"
|
|
variant="default"
|
|
/>
|
|
)}
|
|
<Button
|
|
size="tiny"
|
|
icon={isVisual ? <Code size={14} /> : <Eye size={14} />}
|
|
onClick={onToggleMode}
|
|
>
|
|
{isVisual ? 'Raw' : 'Visual'}
|
|
</Button>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
)
|
|
}
|