mirror of
https://github.com/supabase/supabase.git
synced 2026-09-07 02:20:52 +08:00
## What kind of change does this PR introduce? A11y cleanup follow-up to #47984 / [DEPR-626](https://linear.app/supabase/issue/DEPR-626). ## What is the current behavior? Studio had 82 ratcheted `supabase/require-explicit-tabindex` violations (raw `<button>` / `role="button"` without explicit `tabIndex`). ## What is the new behavior? - Explicit `tabIndex={0}` (or disabled → `-1`) on those Studio call sites across nav, `components/ui`, Database, Storage, and the remainder - Ratchet baseline cleared (**82 → 0**) and the rule **removed from the Studio ratchet** (debt is gone; ratchet is temporary) - Rule remains a shared **`warn`** for now — promoting to `error` (and sweeping www/docs/design-system) is a follow-up - Also fixed the learn/ui-library call sites that surfaced while experimenting with error promotion - Small follow-ups where making controls focusable exposed gaps: accessible names, disabled/focus consistency, focus-ring polish on To-test surfaces, home section `KeyboardSensor`, and an E2E locator tightened after `aria-label="Remove column"` Prefer migrating to `Button` from `ui` in future touch-ups; this PR takes the minimal path so Studio debt can stay at zero. ## Additional context Batches landed together so baseline conflicts stayed simple while chipping away: - Hotspots / nav (FirstLevelNav, Marketplace, AttachmentUpload, Column, Tabs, …) - `components/ui` shared - Database + Storage - Remainder **Out of scope / intentional deferrals** - Promoting `supabase/require-explicit-tabindex` to a lint **error** (follow-up after www/docs/design-system sweeps) - Tabs/Radio roving, tooltips, context menus, in-menu items - Full keyboard-accessible tab-close UX (close stays hover + `tabIndex={-1}`; context menu still closes tabs) - Data API docs links (`/project/<ref>/api` redirect) **Reviewer notes** - Rule only flags raw `<button>` / `role="button"` without a `tabIndex` prop. `Button` from `ui` already bakes this in - `tabIndex={-1}` is intentional for disabled controls, in-menu / roving-focus children, and hover-only tab close - For dnd-kit grips, put `tabIndex` **after** `{...attributes}` so it isn’t overwritten (TS2783) ### To test Use **Safari** with macOS Keyboard navigation **off** (System Settings → Keyboard). Chrome once for a sanity pass. For each surface below: Tab until the control is focused, then activate with Enter/Space where relevant. 1. **API Docs side panel** (Table Editor → open a table → **API docs**) - Floating API Docs panel — **not** `/project/<ref>/api` (that redirects to Data API docs; language ToggleGroup uses arrow keys; links are out of scope) - Left nav buttons — Tab through several and activate one; active highlight / navigation still works 2. **Integrations → Marketplace** - Enable **Integrations layout** feature preview first (avatar menu → Feature previews) - `/org/<slug>/integrations` or project integrations marketplace - “Clear all”, grid/list toggles — Tab + activate 3. **Table Editor → create a table → Columns** - Drag handles only appear while **creating** (not when editing an existing table) - Tab to grip / remove (X) / sensitive-data eye if shown 4. **Project Home** — section drag handles - Tab to a grip (visible focus ring) - Optional: Space to pick up, arrows to move, Space/Esc to drop (KeyboardSensor added) - Mouse dnd still works 5. **Storage → Policies** — expand/collapse bucket list chevron (design-system focus ring, no stuck grey open bg) 6. **Support form** (Help → Support) — attachment remove (×) and add-attachment control when visible Disabled controls should be **skipped** by Tab. <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Accessibility Improvements** * Improved keyboard navigation throughout Studio by explicitly managing focus (`tabIndex`) across many interactive controls (menus, tabs, tables, charts, dialogs, navigation, and form actions). * Disabled or non-interactive controls are now removed from the tab order (or made unfocusable), while available actions remain reachable. * Ensured `type="button"` on relevant controls to prevent unintended submissions, and refined keyboard focus behavior for various toggles and copy/remove actions. * **Chores** * Updated the ESLint rule baseline configuration to match the new focus behavior. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
147 lines
6.1 KiB
TypeScript
147 lines
6.1 KiB
TypeScript
import { ChevronDown, ChevronRight } from 'lucide-react'
|
|
import { useState } from 'react'
|
|
import { cn, Tooltip, TooltipContent, TooltipTrigger } from 'ui'
|
|
|
|
import { parseDetailLines } from './ExplainVisualizer.parser'
|
|
import { RowCountIndicator } from './ExplainVisualizer.RowCountIndicator'
|
|
import type { ExplainNode } from './ExplainVisualizer.types'
|
|
import { formatNodeDuration, getScanBarColor, getScanBorderColor } from './ExplainVisualizer.utils'
|
|
|
|
interface ExplainNodeRowProps {
|
|
node: ExplainNode
|
|
depth: number
|
|
/** Maximum duration across all nodes, used to calculate bar width as % */
|
|
maxDuration: number
|
|
}
|
|
|
|
export function ExplainNodeRow({ node, depth, maxDuration }: ExplainNodeRowProps) {
|
|
const [isExpanded, setIsExpanded] = useState(false)
|
|
const hasChildren = node.children.length > 0
|
|
const hasDetails = Boolean(node.details?.trim())
|
|
const canExpand = hasDetails
|
|
|
|
const detailLines = parseDetailLines(node.details)
|
|
const indentPx = depth * 24
|
|
|
|
// Calculate duration and bar width as % of max duration
|
|
const duration = node.actualTime ? node.actualTime.end - node.actualTime.start : 0
|
|
const hasTimingData = node.actualTime && duration > 0
|
|
const barWidthPercent = maxDuration > 0 ? (duration / maxDuration) * 100 : 0
|
|
const barColorClass = getScanBarColor(node.operation)
|
|
const borderColorClass = getScanBorderColor(node.operation)
|
|
|
|
return (
|
|
<>
|
|
{/* Wrapper for group hover */}
|
|
<div className="group">
|
|
{/* Main row */}
|
|
<div
|
|
className={cn(
|
|
'flex items-stretch border-l-4 transition-colors bg-studio group-hover:bg-surface-100/50',
|
|
borderColorClass
|
|
)}
|
|
>
|
|
{/* Left section: expand button + operation info */}
|
|
<div
|
|
className="flex items-center gap-3 px-4 py-3 shrink-0 min-w-[400px]"
|
|
style={{ paddingLeft: `${16 + indentPx}px` }}
|
|
>
|
|
{/* Expand/collapse button */}
|
|
<button
|
|
type="button"
|
|
tabIndex={canExpand ? 0 : -1}
|
|
onClick={() => canExpand && setIsExpanded(!isExpanded)}
|
|
disabled={!canExpand}
|
|
className={cn(
|
|
'flex items-center justify-center w-5 h-5 rounded-sm border border-border-muted shrink-0',
|
|
canExpand ? 'hover:bg-surface-200 cursor-pointer' : 'opacity-30 cursor-default'
|
|
)}
|
|
aria-label={isExpanded ? 'Collapse details' : 'Expand details'}
|
|
>
|
|
{isExpanded ? (
|
|
<ChevronDown size={12} className="text-foreground-light" />
|
|
) : (
|
|
<ChevronRight size={12} className="text-foreground-light" />
|
|
)}
|
|
</button>
|
|
|
|
{/* Operation name and cost info */}
|
|
<div className="flex items-center gap-2 font-mono text-xs min-w-0">
|
|
<span className="text-foreground uppercase font-medium whitespace-nowrap">
|
|
{node.operation}
|
|
</span>
|
|
<span className="text-foreground-muted whitespace-nowrap">
|
|
(cost {node.cost?.end?.toFixed(1) ?? '-'}, estimated{' '}
|
|
{node.rows?.toLocaleString() ?? '?'} {node.rows === 1 ? 'row' : 'rows'})
|
|
</span>
|
|
</div>
|
|
</div>
|
|
|
|
{/* Right section: duration bar visualization */}
|
|
<div className="flex-1 relative min-h-[43px] flex items-center">
|
|
{hasTimingData && (
|
|
<>
|
|
{/* Duration bar - width represents % of slowest operation */}
|
|
<div
|
|
className={cn('absolute left-0 top-0 h-full', barColorClass)}
|
|
style={{ width: `${barWidthPercent}%` }}
|
|
/>
|
|
{/* Duration and row count info */}
|
|
<div className="relative flex items-center gap-2 font-mono text-xs whitespace-nowrap px-3">
|
|
<Tooltip>
|
|
<TooltipTrigger asChild>
|
|
<span className="text-foreground-light cursor-help">
|
|
{formatNodeDuration(duration)}
|
|
</span>
|
|
</TooltipTrigger>
|
|
<TooltipContent side="top" className="max-w-xs font-sans">
|
|
<p className="font-medium">Execution time: {formatNodeDuration(duration)}</p>
|
|
<p className="text-foreground-lighter text-xs mt-1">
|
|
This is how long this operation took to execute. The bar width shows this as
|
|
a percentage of the slowest operation ({Math.round(barWidthPercent)}%) —
|
|
wider bars indicate where more time is spent.
|
|
</p>
|
|
</TooltipContent>
|
|
</Tooltip>
|
|
<span className="text-foreground-muted">/</span>
|
|
<RowCountIndicator
|
|
actualRows={node.actualRows}
|
|
estimatedRows={node.rows}
|
|
rowsRemovedByFilter={node.rowsRemovedByFilter}
|
|
/>
|
|
</div>
|
|
</>
|
|
)}
|
|
</div>
|
|
</div>
|
|
|
|
{/* Expanded details section */}
|
|
{isExpanded && detailLines.length > 0 && (
|
|
<div
|
|
className={cn(
|
|
'border-t-border-muted border-t border-l-4 bg-studio group-hover:bg-surface-100/50',
|
|
borderColorClass
|
|
)}
|
|
style={{ paddingLeft: `${16 + indentPx + 32}px` }}
|
|
>
|
|
<div className="px-0 py-3 space-y-2 font-mono text-xs">
|
|
{detailLines.map((line, idx) => (
|
|
<div key={idx} className="flex items-start gap-1">
|
|
{line.label && <span className="text-foreground-muted">{line.label}</span>}
|
|
<span className="text-foreground-light break-all">{line.value}</span>
|
|
</div>
|
|
))}
|
|
</div>
|
|
</div>
|
|
)}
|
|
</div>
|
|
|
|
{/* Render children recursively */}
|
|
{hasChildren &&
|
|
node.children.map((child, idx) => (
|
|
<ExplainNodeRow key={idx} node={child} depth={depth + 1} maxDuration={maxDuration} />
|
|
))}
|
|
</>
|
|
)
|
|
}
|