mirror of
https://github.com/supabase/supabase.git
synced 2026-10-07 02:15:05 +03: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 -->
212 lines
7.2 KiB
TypeScript
212 lines
7.2 KiB
TypeScript
import { groupBy } from 'lodash'
|
|
import { ArrowLeft, ArrowRight } from 'lucide-react'
|
|
import { useState } from 'react'
|
|
import {
|
|
Button,
|
|
cn,
|
|
Dialog,
|
|
DialogContent,
|
|
DialogDescription,
|
|
DialogHeader,
|
|
DialogSection,
|
|
DialogSectionSeparator,
|
|
DialogTitle,
|
|
DialogTrigger,
|
|
StatusIcon,
|
|
} from 'ui'
|
|
import { GenericSkeletonLoader } from 'ui-patterns/ShimmeringLoader'
|
|
import { TimestampInfo } from 'ui-patterns/TimestampInfo'
|
|
|
|
import { ActionStatusBadge, ActionStatusBadgeCondensed, STATUS_TO_LABEL } from './ActionStatusBadge'
|
|
import BranchStatusBadge from './BranchStatusBadge'
|
|
import { AlertError } from '@/components/ui/AlertError'
|
|
import { ActionRunData } from '@/data/actions/action-detail-query'
|
|
import { useActionRunLogsQuery } from '@/data/actions/action-logs-query'
|
|
import {
|
|
useActionsQuery,
|
|
type ActionRunStep,
|
|
type ActionStatus,
|
|
} from '@/data/actions/action-runs-query'
|
|
import type { Branch } from '@/data/branches/branches-query'
|
|
|
|
interface WorkflowLogsProps {
|
|
branch: Branch
|
|
}
|
|
|
|
type StatusType = Branch['status']
|
|
|
|
const HEALTHY_STATUSES: StatusType[] = ['FUNCTIONS_DEPLOYED', 'MIGRATIONS_PASSED']
|
|
const UNHEALTHY_STATUSES: StatusType[] = ['MIGRATIONS_FAILED', 'FUNCTIONS_FAILED']
|
|
|
|
export const WorkflowLogs = ({ branch }: WorkflowLogsProps) => {
|
|
const { project_ref: projectRef, status, name } = branch
|
|
const [isOpen, setIsOpen] = useState(false)
|
|
|
|
const {
|
|
data: workflowRuns,
|
|
isSuccess: isWorkflowRunsSuccess,
|
|
isPending: isWorkflowRunsLoading,
|
|
isError: isWorkflowRunsError,
|
|
error: workflowRunsError,
|
|
} = useActionsQuery({ ref: projectRef }, { enabled: isOpen })
|
|
|
|
const [selectedWorkflowRun, setSelectedWorkflowRun] = useState<ActionRunData>()
|
|
|
|
const {
|
|
data: workflowRunLogs,
|
|
isSuccess: isWorkflowRunLogsSuccess,
|
|
isPending: isWorkflowRunLogsLoading,
|
|
isError: isWorkflowRunLogsError,
|
|
error: workflowRunLogsError,
|
|
} = useActionRunLogsQuery(
|
|
{ projectRef, runId: selectedWorkflowRun?.id },
|
|
{ enabled: isOpen && Boolean(selectedWorkflowRun) }
|
|
)
|
|
|
|
const showStatusIcon = !HEALTHY_STATUSES.includes(status)
|
|
const isUnhealthy = UNHEALTHY_STATUSES.includes(status)
|
|
|
|
return (
|
|
<Dialog open={isOpen} onOpenChange={setIsOpen}>
|
|
<DialogTrigger asChild>
|
|
<Button
|
|
variant="default"
|
|
icon={
|
|
showStatusIcon ? (
|
|
<StatusIcon variant={isUnhealthy ? 'destructive' : 'default'} hideBackground />
|
|
) : undefined
|
|
}
|
|
onClick={(e) => e.stopPropagation()}
|
|
>
|
|
View Logs
|
|
</Button>
|
|
</DialogTrigger>
|
|
|
|
<DialogContent size="xlarge">
|
|
<DialogHeader>
|
|
<DialogTitle>Workflow logs for {name}</DialogTitle>
|
|
<DialogDescription>
|
|
{!selectedWorkflowRun ? (
|
|
'Select a workflow run to view logs'
|
|
) : (
|
|
<>
|
|
Run created at{' '}
|
|
<TimestampInfo className="text-sm" utcTimestamp={selectedWorkflowRun.created_at} />
|
|
</>
|
|
)}
|
|
</DialogDescription>
|
|
</DialogHeader>
|
|
|
|
<DialogSectionSeparator />
|
|
|
|
<DialogSection className={cn('px-0!', isWorkflowRunLogsSuccess ? 'py-0 pt-2' : 'py-0!')}>
|
|
{!selectedWorkflowRun ? (
|
|
<>
|
|
{isWorkflowRunsLoading && <GenericSkeletonLoader className="py-4" />}
|
|
{isWorkflowRunsError && (
|
|
<div className="py-4">
|
|
<AlertError error={workflowRunsError} />
|
|
</div>
|
|
)}
|
|
{isWorkflowRunsSuccess &&
|
|
(workflowRuns.length > 0 ? (
|
|
<ul className="divide-y">
|
|
{workflowRuns.map((workflowRun) => (
|
|
<li key={workflowRun.id} className="flex justify-between px-4 py-3 gap-2">
|
|
<button
|
|
type="button"
|
|
tabIndex={workflowRun.id === projectRef ? -1 : 0}
|
|
disabled={workflowRun.id === projectRef}
|
|
onClick={() => setSelectedWorkflowRun(workflowRun)}
|
|
className="flex items-center gap-2 w-full justify-between"
|
|
>
|
|
<div className="flex items-center gap-4">
|
|
{workflowRun.run_steps.length > 0 ? (
|
|
<RunSteps steps={workflowRun.run_steps} />
|
|
) : (
|
|
<BranchStatusBadge status={status} />
|
|
)}
|
|
|
|
<TimestampInfo
|
|
className="text-sm"
|
|
utcTimestamp={workflowRun.created_at}
|
|
/>
|
|
</div>
|
|
{workflowRun.id !== projectRef && <ArrowRight size={16} />}
|
|
</button>
|
|
</li>
|
|
))}
|
|
</ul>
|
|
) : (
|
|
<p className="text-center text-sm text-foreground-light py-4">
|
|
No workflow runs found.
|
|
</p>
|
|
))}
|
|
</>
|
|
) : (
|
|
<div className="px-4 flex flex-col gap-2 py-2">
|
|
<Button
|
|
onClick={() => setSelectedWorkflowRun(undefined)}
|
|
variant="text"
|
|
icon={<ArrowLeft />}
|
|
className="self-start"
|
|
>
|
|
Back to workflow runs
|
|
</Button>
|
|
|
|
{isWorkflowRunLogsLoading && <GenericSkeletonLoader className="py-2" />}
|
|
{isWorkflowRunLogsError && (
|
|
<div className="py-2">
|
|
<AlertError
|
|
className="rounded-none"
|
|
subject="Failed to retrieve workflow logs"
|
|
error={workflowRunLogsError}
|
|
/>
|
|
</div>
|
|
)}
|
|
{isWorkflowRunLogsSuccess && (
|
|
<pre className="whitespace-pre max-h-[500px] overflow-scroll pb-5 text-sm">
|
|
{workflowRunLogs}
|
|
</pre>
|
|
)}
|
|
</div>
|
|
)}
|
|
</DialogSection>
|
|
</DialogContent>
|
|
</Dialog>
|
|
)
|
|
}
|
|
|
|
function RunSteps({ steps }: { steps: Array<ActionRunStep> }) {
|
|
const stepsByStatus = groupBy(steps, 'status') as Record<ActionStatus, Array<ActionRunStep>>
|
|
const firstFailedStep = stepsByStatus.DEAD?.[0]
|
|
const numberFailedSteps = stepsByStatus.DEAD?.length ?? 0
|
|
|
|
return (
|
|
<>
|
|
{firstFailedStep && (
|
|
<ActionStatusBadge name={firstFailedStep.name} status={firstFailedStep.status} />
|
|
)}
|
|
{numberFailedSteps > 1 && (
|
|
<ActionStatusBadgeCondensed status={'DEAD'} details={stepsByStatus.DEAD.slice(1)}>
|
|
{numberFailedSteps - 1} more
|
|
</ActionStatusBadgeCondensed>
|
|
)}
|
|
|
|
<div className="flex items-center gap-x-2">
|
|
{(Object.keys(stepsByStatus) as Array<ActionStatus>)
|
|
.filter((status) => status !== 'DEAD')
|
|
.map((status) => (
|
|
<ActionStatusBadgeCondensed
|
|
key={status}
|
|
status={status}
|
|
details={stepsByStatus[status]}
|
|
>
|
|
{stepsByStatus[status].length} {STATUS_TO_LABEL[status]}
|
|
</ActionStatusBadgeCondensed>
|
|
))}
|
|
</div>
|
|
</>
|
|
)
|
|
}
|