List the names of the failing benchmark subworkflows

Author: cezudas

packages/react-ui/src/app/features/benchmark/components/benchmark-wizard.tsx

@@ -87,6 +87,7 @@ export const BenchmarkWizard = ({
   const {
     runPhase,
     runningProgress,
+    failedWorkflowNames,
     isRunPending,
     handleRunBenchmark,
     handleResetRun,
@@ -174,6 +175,7 @@ export const BenchmarkWizard = ({
                     result={benchmarkCreateResult}
                     runPhase={runPhase}
                     runningProgress={runningProgress ?? undefined}
+                    failedWorkflowNames={failedWorkflowNames}
                   />
                 )}
               </WizardStep>

packages/react-ui/src/app/features/benchmark/tests/use-benchmark-run.test.ts

@@ -136,6 +136,14 @@ describe('useBenchmarkRun', () => {
 
       expect(result.current.isRunPending).toBe(false);
     });
+
+    it('should start with empty failedWorkflowNames', () => {
+      const { result } = renderHook(() =>
+        useBenchmarkRun(buildBenchmarkCreationResult()),
+      );
+
+      expect(result.current.failedWorkflowNames).toEqual([]);
+    });
   });
 
   describe('handleRunBenchmark', () => {
@@ -255,6 +263,7 @@ describe('useBenchmarkRun', () => {
       });
 
       expect(result.current.runPhase).toBe('succeeded');
+      expect(result.current.failedWorkflowNames).toEqual([]);
     });
 
     it('should transition to succeeded_with_failures when some sub-workflows failed', async () => {
@@ -293,6 +302,7 @@ describe('useBenchmarkRun', () => {
       });
 
       expect(result.current.runPhase).toBe('succeeded_with_failures');
+      expect(result.current.failedWorkflowNames).toEqual(['Sub']);
     });
 
     it('should transition to failed when status is FAILED', async () => {

packages/react-ui/src/app/features/benchmark/use-benchmark-run.ts

@@ -18,6 +18,7 @@ import { benchmarkApi } from './benchmark-api';
 export type UseBenchmarkRunResult = {
   runPhase: BenchmarkRunPhase;
   runningProgress: { completed: number; total: number } | null;
+  failedWorkflowNames: string[];
   isRunPending: boolean;
   handleRunBenchmark: () => Promise<void>;
   handleResetRun: () => void;
@@ -43,11 +44,23 @@ function mapStatusToRunPhase(
   }
 }
 
+function getFailedSubWorkflowNames(data: BenchmarkStatusResponse): string[] {
+  return data.workflows
+    .filter(
+      (w) =>
+        !w.isOrchestrator &&
+        !w.isCleanup &&
+        w.runStatus === BenchmarkStatus.FAILED,
+    )
+    .map((w) => w.displayName);
+}
+
 export const useBenchmarkRun = (
   benchmarkCreateResult: BenchmarkCreationResult | null,
 ): UseBenchmarkRunResult => {
   const [runPhase, setRunPhase] = useState<BenchmarkRunPhase>('idle');
   const [lastRunId, setLastRunId] = useState<string | undefined>();
+  const [failedWorkflowNames, setFailedWorkflowNames] = useState<string[]>([]);
   const [runCount, setRunCount] = useState(0);
 
   const benchmarkId = benchmarkCreateResult?.benchmarkId ?? null;
@@ -80,6 +93,9 @@ export const useBenchmarkRun = (
       setLastRunId(statusData.lastRunId);
     }
     const newPhase = mapStatusToRunPhase(statusData);
+    if (newPhase === 'succeeded_with_failures') {
+      setFailedWorkflowNames(getFailedSubWorkflowNames(statusData));
+    }
     if (newPhase !== null) {
       setRunPhase(newPhase);
     }
@@ -122,6 +138,7 @@ export const useBenchmarkRun = (
   const handleResetRun = () => {
     setRunPhase('idle');
     setLastRunId(undefined);
+    setFailedWorkflowNames([]);
   };
 
   const runningProgress = useMemo(() => {
@@ -148,6 +165,7 @@ export const useBenchmarkRun = (
   return {
     runPhase,
     runningProgress,
+    failedWorkflowNames,
     isRunPending,
     handleRunBenchmark,
     handleResetRun,

packages/ui-components/src/components/benchmark/benchmark-ready-step.tsx

@@ -7,18 +7,33 @@ import { BenchmarkFailedPhase } from './benchmark-failed-phase';
 import { BenchmarkRunningPhase } from './benchmark-running-phase';
 import { BenchmarkWorkflowList } from './benchmark-workflow-list';
 
+const FailedWorkflowsList = ({ names }: { names: string[] }) => (
+  <div className="flex flex-col gap-1 py-2">
+    <p className="text-sm dark:text-muted-foreground font-medium">
+      {t('The following workflows failed:')}
+    </p>
+    <ul className="list-disc pl-5 text-sm dark:text-muted-foreground">
+      {names.map((name) => (
+        <li key={name}>{name}</li>
+      ))}
+    </ul>
+  </div>
+);
+
 interface BenchmarkReadyStepProps {
   providerName: string;
   result: BenchmarkCreationResult;
   runPhase: BenchmarkRunPhase;
   runningProgress?: { completed: number; total: number };
+  failedWorkflowNames?: string[];
 }
 
 export const BenchmarkReadyStep = ({
   providerName,
   result,
   runPhase,
   runningProgress,
+  failedWorkflowNames,
 }: BenchmarkReadyStepProps) => {
   const subWorkflows = result.workflows.filter(
     (w) => !w.isOrchestrator && !w.isCleanup,
@@ -52,12 +67,17 @@ export const BenchmarkReadyStep = ({
       {runPhase === 'failed' && <BenchmarkFailedPhase />}
 
       {runPhase === 'succeeded_with_failures' && (
-        <BenchmarkAnalyticsPhase
-          provider={providerName}
-          message={t(
-            "You can review your Benchmark Report here (it's not final since there are some failed workflows)",
+        <>
+          <BenchmarkAnalyticsPhase
+            provider={providerName}
+            message={t(
+              "You can review your Benchmark Report here (it's not final since there are some failed workflows)",
+            )}
+          />
+          {failedWorkflowNames && failedWorkflowNames.length > 0 && (
+            <FailedWorkflowsList names={failedWorkflowNames} />
           )}
-        />
+        </>
       )}
 
       {runPhase === 'succeeded' && (

packages/ui-components/src/stories/benchmark/benchmark-ready-step.stories.tsx

@@ -67,6 +67,12 @@ export const RunningWithProgress: ReadyStepStory = {
 };
 export const Failed: ReadyStepStory = { args: { runPhase: 'failed' } };
 export const SucceededWithFailures: ReadyStepStory = {
-  args: { runPhase: 'succeeded_with_failures' },
+  args: {
+    runPhase: 'succeeded_with_failures',
+    failedWorkflowNames: [
+      'EC2 Reserved Instances Analysis',
+      'S3 Storage Optimization',
+    ],
+  },
 };
 export const Succeeded: ReadyStepStory = { args: { runPhase: 'succeeded' } };