Files
supabase/apps/studio/components/interfaces/BranchManagement/WorkflowLogs.tsx
Gildas Garcia 375cbcf4a2 feat: add a dashboard button to retrigger a branch workflow (#46626)
## Problem

When workflow runs for branches fail due to stuck tasks, they can sit
idle indefinitely. Users are unaware that they need to make a new commit
to retrigger the workflow — leading to confusion, wasted time, and
silent failures going unnoticed.

## Solution

Provide a button that allows users to retrigger a workflow when it is
not being removed.

## How to test

- Create a branch
- Wait for its row to appear on the branch management page
- Click the _View logs_ button
- You should see a _Retrigger_ button
- Clicking it should make a new row appear in those logs

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

* **New Features**
* Retrigger previously executed workflows directly from branch preview
actions.
  * Confirmation dialog added for retrigger actions.

* **Improvements**
  * Toast-style error notifications when retriggering fails.
* Workflow run list layout updated for a more flexible horizontal
display.
* After retriggering, workflow and action lists refresh so updates
appear promptly.
<!-- end of auto-generated comment: release notes by coderabbit.ai -->
2026-06-04 15:34:59 +02:00

210 lines
7.1 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, TimestampInfo } from 'ui-patterns'
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
type="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"
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)}
type="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>
</>
)
}