feat: Added generic display message method to the reporter. Added messaging after all save file paths for imports.

Author: kevinwang5658

src/orchestrators/apply.ts

@@ -1,5 +1,6 @@
 import { ProcessName, ctx } from '../events/context.js';
 import { Reporter } from '../ui/reporters/reporter.js';
+import { sleep } from '../utils/index.js';
 import { PlanOrchestrator } from './plan.js';
 
 export interface ApplyArgs {
@@ -30,6 +31,11 @@ export const ApplyOrchestrator = {
     await pluginManager.apply(project, filteredPlan);
     ctx.processFinished(ProcessName.APPLY);
 
-    await reporter.displayApplyComplete([]);
+    reporter.displayMessage(`
+🎉 Finished applying 🎉
+Open a new terminal or source '.zshrc' for the new changes to be reflected`);
+
+    // Need to sleep to wait for the message to display before we exit
+    await sleep(100);
   },
 };

src/orchestrators/import.ts

@@ -9,6 +9,7 @@ import { DependencyMap, PluginManager } from '../plugins/plugin-manager.js';
 import { PromptType, Reporter } from '../ui/reporters/reporter.js';
 import { FileUtils } from '../utils/file.js';
 import { FileModificationCalculator, ModificationType } from '../utils/file-modification-calculator.js';
+import { sleep } from '../utils/index.js';
 import { InitializeOrchestrator } from './initialize.js';
 
 export type RequiredParameters = Map<string, RequiredParameter[]>;
@@ -114,14 +115,6 @@ export class ImportOrchestrator {
     }
   }
 
-  private static async parse(path: string): Promise<Project> {
-    ctx.subprocessStarted(SubProcessName.PARSE);
-    const project = await CodifyParser.parse(path);
-    ctx.subprocessFinished(SubProcessName.PARSE);
-
-    return project
-  }
-
   private static async validate(typeIds: string[], project: Project, pluginManager: PluginManager, dependencyMap: DependencyMap): Promise<void> {
     ctx.subprocessStarted(SubProcessName.VALIDATE)
 
@@ -158,10 +151,16 @@ ${JSON.stringify(unsupportedTypeIds)}`);
     } else if (promptResult === 'In a new file') {
       const newFileName = await ImportOrchestrator.generateNewImportFileName();
       await ImportOrchestrator.saveNewFile(newFileName, importResult);
+    } else if (promptResult === 'No') {
     }
   }
 
-  private static async updateExistingFile(reporter: Reporter, filePath: string, importResult: ImportResult, resourceInfoList: ResourceInfo[]): Promise<void> {
+  private static async updateExistingFile(
+    reporter: Reporter,
+    filePath: string,
+    importResult: ImportResult,
+    resourceInfoList: ResourceInfo[]
+  ): Promise<void> {
     const existing = await CodifyParser.parse(filePath);
     ImportOrchestrator.attachResourceInfo(importResult.result, resourceInfoList);
     ImportOrchestrator.attachResourceInfo(existing.resourceConfigs, resourceInfoList);
@@ -172,13 +171,31 @@ ${JSON.stringify(unsupportedTypeIds)}`);
       resource
     })));
 
+    // No changes to be made
+    if (result.diff === '') {
+      reporter.displayMessage('\nNo changes are needed! Exiting...')
+
+      // Wait for the message to display before we exit
+      await sleep(100);
+      process.exit(0);
+    }
+
     reporter.displayFileModification(result.diff);
     const shouldSave = await reporter.promptConfirmation(`Save to file (${filePath})?`);
     if (!shouldSave) {
+      reporter.displayMessage('\nSkipping save! Exiting...');
+
+      // Wait for the message to display before we exit
+      await sleep(100);
       process.exit(0);
     }
 
     await FileUtils.writeFile(filePath, result.newFile);
+
+    reporter.displayMessage('\n🎉 Imported completed and saved to file 🎉');
+
+    // Wait for the message to display before we exit
+    await sleep(100);
   }
 
   private static async saveNewFile(filePath: string, importResult: ImportResult): Promise<void> {

src/ui/components/default-component.tsx

@@ -37,6 +37,11 @@ export function DefaultComponent(props: {
   }, []);
 
   return <Box flexDirection="column">
+    {
+      renderStatus === RenderStatus.DISPLAY_MESSAGE && (
+        <Text>{renderData as string}</Text>
+      )
+    }
     {
       renderStatus === RenderStatus.PROGRESS && (
         <ProgressDisplay emitter={spinnerEmitter} eventType="data"/>
@@ -70,15 +75,6 @@ export function DefaultComponent(props: {
         </Box>
       )
     }
-    {
-      renderStatus === RenderStatus.APPLY_COMPLETE && (
-        <Box flexDirection="column">
-          <Text> </Text>
-          <Text>🎉 Finished applying 🎉</Text>
-          <Text>Open a new terminal or source '.zshrc' for the new changes to be reflected</Text>
-        </Box>
-      )
-    }
     {
       renderStatus === RenderStatus.SUDO_PROMPT && (
         <Box flexDirection="column">

src/ui/reporters/default-reporter.tsx

@@ -10,7 +10,6 @@ import { ResourceConfig } from '../../entities/resource-config.js';
 import { ResourceInfo } from '../../entities/resource-info.js';
 import { Event, ProcessName, SubProcessName, ctx } from '../../events/context.js';
 import { ImportResult } from '../../orchestrators/import.js';
-import { sleep } from '../../utils/index.js';
 import { SudoUtils } from '../../utils/sudo.js';
 import { DefaultComponent } from '../components/default-component.js';
 import { ProgressState, ProgressStatus } from '../components/progress/progress-display.js';
@@ -102,6 +101,7 @@ export class DefaultReporter implements Reporter {
 
   displayImportResult(importResult: ImportResult): void {
     this.updateRenderState(RenderStatus.DISPLAY_IMPORT_RESULT, importResult);
+    store.set(store.progressState, null);
   }
 
   async promptSudo(pluginName: string, data: SudoRequestData, secureMode: boolean): Promise<SudoRequestResponseData> {
@@ -123,6 +123,10 @@ export class DefaultReporter implements Reporter {
     this.progressState = null;
   }
 
+  displayMessage(message: string) {
+    this.updateRenderState(RenderStatus.DISPLAY_MESSAGE, message);
+  }
+
   async promptConfirmation(message: string): Promise<boolean> {
     const result = await this.updateStateAndAwaitEvent<boolean>(
       () => this.updateRenderState(RenderStatus.PROMPT_CONFIRMATION, message),
@@ -147,11 +151,6 @@ export class DefaultReporter implements Reporter {
     return result
   }
 
-  async displayApplyComplete(messages: string[]): Promise<void> {
-    this.updateRenderState(RenderStatus.APPLY_COMPLETE, messages);
-    await sleep(100); // This gives the renderer enough time to complete before the prompt exits
-  }
-
   displayFileModification(diff: string) {
     this.updateRenderState(RenderStatus.DISPLAY_FILE_MODIFICATION, diff);
   }

src/ui/reporters/reporter.ts

@@ -1,10 +1,8 @@
 import { SudoRequestData , SudoRequestResponseData } from 'codify-schemas';
 
 import { Plan } from '../../entities/plan.js';
-import { ImportResult, RequiredParameters, UserSuppliedParameters } from '../../orchestrators/import.js';
-import { DebugReporter } from './debug-reporter.js';
+import { ImportResult } from '../../orchestrators/import.js';
 import { DefaultReporter } from './default-reporter.js';
-import { PlainReporter } from './plain-reporter.js';
 import { ResourceInfo } from '../../entities/resource-info.js';
 import { ResourceConfig } from '../../entities/resource-config.js';
 
@@ -41,8 +39,6 @@ export enum PromptType {
 }
 
 export interface Reporter {
-  displayApplyComplete(message: string[]): Promise<void> | void;
-
   displayPlan(plan: Plan): void
 
   promptConfirmation(message: string): Promise<boolean>
@@ -56,6 +52,8 @@ export interface Reporter {
   displayImportResult(importResult: ImportResult): void;
 
   displayFileModification(diff: string): void
+
+  displayMessage(message: string): void
 }
 
 export enum ReporterType {

src/ui/store/index.ts

@@ -1,4 +1,4 @@
-import { atom, createStore, getDefaultStore, Setter, Getter, Atom, WritableAtom } from 'jotai'
+import { atom, getDefaultStore, Atom, WritableAtom } from 'jotai'
 
 import { ProgressState } from '../components/progress/progress-display.js';
 
@@ -15,8 +15,8 @@ export enum RenderStatus {
   IMPORT_PROMPT,
   PROMPT_CONFIRMATION,
   PROMPT_OPTIONS,
-  APPLY_COMPLETE,
   SUDO_PROMPT,
+  DISPLAY_MESSAGE
 }
 
 export const store = new class {