feat: added status effects for sub-progresses

Author: kevinwang5658

src/events/context.ts

@@ -31,6 +31,12 @@ export enum ProcessName {
   TERMINATE = 'terminate',
 }
 
+export enum SubprocessFinishStatus {
+  SUCCESS,
+  FAILED,
+  SKIPPED,
+}
+
 export enum SubProcessName {
   APPLYING_RESOURCE = 'apply_resource_',
   GENERATE_PLAN = 'generate_plan',
@@ -107,8 +113,8 @@ export const ctx = new class {
     this.emitter.emit(Event.SUB_PROCESS_START, name, additionalName);
   }
 
-  subprocessFinished(name: string, additionalName?: string) {
-    this.emitter.emit(Event.SUB_PROCESS_FINISH, name, additionalName);
+  subprocessFinished(name: string, additionalName?: string, status: SubprocessFinishStatus = SubprocessFinishStatus.SUCCESS) {
+    this.emitter.emit(Event.SUB_PROCESS_FINISH, name, additionalName, status);
   }
 
   commandRequested(pluginName: string, data: CommandRequestData) {
@@ -138,7 +144,7 @@ export const ctx = new class {
   async subprocess<T>(name: string, run: () => Promise<T>): Promise<T> {
     this.emitter.emit(Event.SUB_PROCESS_START, name);
     const result = await run();
-    this.emitter.emit(Event.SUB_PROCESS_FINISH, name);
+    this.emitter.emit(Event.SUB_PROCESS_FINISH, name, undefined, SubprocessFinishStatus.SUCCESS);
     return result;
   }
 

src/plugins/plugin-manager.ts

@@ -11,7 +11,7 @@ import { Plan, ResourcePlan } from '../entities/plan.js';
 import { Project } from '../entities/project.js';
 import { ResourceConfig } from '../entities/resource-config.js';
 import { ResourceInfo } from '../entities/resource-info.js';
-import { SubProcessName, ctx } from '../events/context.js';
+import { SubProcessName, SubprocessFinishStatus, ctx } from '../events/context.js';
 import { groupBy } from '../utils/index.js';
 import { registerKillListeners } from '../utils/register-kill-listeners.js';
 import { Plugin } from './plugin.js';
@@ -146,7 +146,7 @@ export class PluginManager {
     for (const id of project.evaluationOrder ?? []) {
       if (skippedIds.has(id)) {
         ctx.subprocessStarted(SubProcessName.APPLYING_RESOURCE, id);
-        ctx.subprocessFinished(SubProcessName.APPLYING_RESOURCE, id);
+        ctx.subprocessFinished(SubProcessName.APPLYING_RESOURCE, id, SubprocessFinishStatus.SKIPPED);
         continue;
       }
 
@@ -166,17 +166,17 @@ export class PluginManager {
       try {
         await this.plugins.get(pluginName)!.apply(resourcePlan);
         succeededPlans.push(resourcePlan);
+        ctx.subprocessFinished(SubProcessName.APPLYING_RESOURCE, resourcePlan.id, SubprocessFinishStatus.SUCCESS);
       } catch (err) {
         if (err instanceof PluginError) {
           collectedErrors.push(err);
+          ctx.subprocessFinished(SubProcessName.APPLYING_RESOURCE, resourcePlan.id, SubprocessFinishStatus.FAILED);
           const dependents = plan.computeTransitiveDependents(id);
           for (const depId of dependents) skippedIds.add(depId);
         } else {
           throw err;
         }
       }
-
-      ctx.subprocessFinished(SubProcessName.APPLYING_RESOURCE, resourcePlan.id);
     }
 
     return createApplyResult(succeededPlans, collectedErrors, skippedIds);

src/ui/components/progress/progress-display.tsx

@@ -12,6 +12,8 @@ import Spinner from './spinner.js';
 export enum ProgressStatus {
   IN_PROGRESS,
   FINISHED,
+  FAILED,
+  SKIPPED,
 }
 
 export interface ProgressState {
@@ -94,10 +96,11 @@ export function SubProgressDisplay(
     {hiddenCount > 0 && (
       <Text dimColor><Text color="greenBright" dimColor={false}>✔</Text> and {hiddenCount} other{hiddenCount !== 1 ? 's' : ''}...</Text>
     )}
-    {sorted.map((s, idx) =>
-      s.status === ProgressStatus.IN_PROGRESS
-        ? <Spinner key={idx} label={s.label} type="dots" />
-        : <Text key={idx}><Text color='greenBright'>✔</Text> {s.label}</Text>
-    )}
+    {sorted.map((s, idx) => {
+      if (s.status === ProgressStatus.IN_PROGRESS) return <Spinner key={idx} label={s.label} type="dots" />;
+      if (s.status === ProgressStatus.FAILED) return <Text key={idx}><Text color="red">✘</Text> {s.label}</Text>;
+      if (s.status === ProgressStatus.SKIPPED) return <Text key={idx} dimColor>~ {s.label}</Text>;
+      return <Text key={idx}><Text color='greenBright'>✔</Text> {s.label}</Text>;
+    })}
   </>
 }

src/ui/reporters/default-reporter.tsx

@@ -10,7 +10,7 @@ import { ApplyResult } from '../../entities/apply-result.js';
 import { Plan, ResourcePlan } from '../../entities/plan.js';
 import { ResourceConfig } from '../../entities/resource-config.js';
 import { ResourceInfo } from '../../entities/resource-info.js';
-import { ctx, Event, ProcessName, SubProcessName } from '../../events/context.js';
+import { ctx, Event, ProcessName, SubProcessName, SubprocessFinishStatus } from '../../events/context.js';
 import { FileModificationResult } from '../../generators/index.js';
 import { ImportResult } from '../../orchestrators/import.js';
 import { sleep } from '../../utils/index.js';
@@ -62,7 +62,7 @@ export class DefaultReporter implements Reporter {
     ctx.on(Event.PROCESS_START, (name) => this.onProcessStartEvent(name))
     ctx.on(Event.PROCESS_FINISH, (name) => this.onProcessFinishEvent(name))
     ctx.on(Event.SUB_PROCESS_START, (name, additionalName) => this.onSubprocessStartEvent(name, additionalName));
-    ctx.on(Event.SUB_PROCESS_FINISH, (name, additionalName) => this.onSubprocessFinishEvent(name, additionalName));
+    ctx.on(Event.SUB_PROCESS_FINISH, (name, additionalName, status) => this.onSubprocessFinishEvent(name, additionalName, status));
 
     this.renderEmitter.on(RenderEvent.TOGGLE_VERBOSITY, () => {
       this.verbosityToggleCallback?.();
@@ -321,7 +321,7 @@ export class DefaultReporter implements Reporter {
     store.set(store.progressState, structuredClone(this.progressState));
   }
 
-  private onSubprocessFinishEvent(name: SubProcessName, additionalName?: string): void {
+  private onSubprocessFinishEvent(name: SubProcessName, additionalName?: string, status: SubprocessFinishStatus = SubprocessFinishStatus.SUCCESS): void {
     const label = ProgressLabelMapping[name] + (additionalName ? ' ' + additionalName : '');
 
     const subProgress = this.progressState
@@ -332,9 +332,17 @@ export class DefaultReporter implements Reporter {
       return;
     }
 
-    subProgress.status = ProgressStatus.FINISHED;
+    if (status === SubprocessFinishStatus.FAILED) {
+      subProgress.status = ProgressStatus.FAILED;
+      ctx.log(`${label} failed`);
+    } else if (status === SubprocessFinishStatus.SKIPPED) {
+      subProgress.status = ProgressStatus.SKIPPED;
+      ctx.log(`${label} skipped`);
+    } else {
+      subProgress.status = ProgressStatus.FINISHED;
+      ctx.log(`${label} finished successfully`);
+    }
 
-    ctx.log(`${label} finished successfully`)
     store.set(store.progressState, structuredClone(this.progressState));
   }