[CODE-70] Added apply complete message with insturctions to source .zshrc or go to a new terminal. Fixed various text bugs with messages missing "". Fixed bug with sudo not working. Fixed plugin name display

Author: kevinwang5658

src/commands/apply/index.ts

@@ -46,6 +46,7 @@ export default class Apply extends BaseCommand {
     }
 
     await ApplyOrchestrator.run(planResult);
+    await this.reporter.displayApplyComplete([]);
 
     process.exit(0);
   }

src/plugins/plugin-process.ts

@@ -44,7 +44,7 @@ export class PluginProcess {
     _process.on('exit', (code) => {
       throw new Error(`Plugin ${this.name} exited with code ${code}`);
     })
-    PluginProcess.handleSudoRequests(_process);
+    PluginProcess.handleSudoRequests(_process, name);
 
     return new PluginProcess(_process);
   }
@@ -78,7 +78,7 @@ export class PluginProcess {
     return true;
   }
 
-  private static handleSudoRequests(process: ChildProcess) {
+  private static handleSudoRequests(process: ChildProcess, pluginName: string) {
     // Listen for incoming sudo incoming sudo requests
     process.on('message', (message) => {
       if (!ipcMessageValidator(message)) {
@@ -88,16 +88,16 @@ export class PluginProcess {
       if (message.cmd === MessageCmd.SUDO_REQUEST) {
         const { data } = message;
         if (!sudoRequestValidator(data)) {
-          throw new Error(`Invalid sudo request from plugin ${this.name}. ${JSON.stringify(sudoRequestValidator.errors, null, 2)}`);
+          throw new Error(`Invalid sudo request from plugin ${pluginName}. ${JSON.stringify(sudoRequestValidator.errors, null, 2)}`);
         }
 
-        ctx.sudoRequested(this.name, data as unknown as SudoRequestData);
+        ctx.sudoRequested(pluginName, data as unknown as SudoRequestData);
       }
     })
 
     // Send out sudo granted events
-    ctx.on(Event.SUDO_REQUEST_GRANTED, (pluginName, data) => {
-      if (pluginName === this.name) {
+    ctx.on(Event.SUDO_REQUEST_GRANTED, (_pluginName, data) => {
+      if (_pluginName === pluginName) {
         process.send({
           cmd: resultFunctionName(MessageCmd.SUDO_REQUEST),
           data

src/plugins/plugin.ts

@@ -52,7 +52,7 @@ export class Plugin {
     const { data, status } = await this.process!.sendMessageForResult({ cmd: 'validate', data: { configs: rawConfigs } });
 
     if (status === MessageStatus.ERROR) {
-      throw new Error(`Initialize error for plugin: "${this.name} \n\n` + data);
+      throw new Error(`Initialize error for plugin: "${this.name}" \n\n` + data);
     }
 
     if (!this.validateValidateResponse(data)) {

src/ui/components/default-component.tsx

@@ -64,7 +64,7 @@ export function DefaultComponent(props: {
 
   return <Box flexDirection="column">
     {
-      ([RenderState.APPLYING, RenderState.GENERATING_PLAN].includes(state)) && progressState && !hideProgress && (
+      ([RenderState.APPLY_COMPLETE, RenderState.APPLYING, RenderState.GENERATING_PLAN].includes(state)) && progressState && !hideProgress && (
         <ProgressDisplay progress={progressState}/>
       )
     }
@@ -84,6 +84,15 @@ export function DefaultComponent(props: {
         </Box>
       )
     }
+    {
+      state === RenderState.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>
+      )
+    }
     {
       showSudoPrompt && (
         <Box flexDirection="column">

src/ui/reporters/debug-reporter.ts

@@ -26,13 +26,13 @@ export class DebugReporter implements Reporter {
   }
 
   async promptSudo(pluginName: string, data: SudoRequestData, secureMode: boolean): Promise<SudoRequestResponseData> {
-    console.log(chalk.blue(`Plugin: ${pluginName} requires root access to run command: '${data.command}'`));
+    console.log(chalk.blue(`Plugin: "${pluginName}" requires root access to run command: "${data.command}"`));
     return SudoUtils.runCommand(data.command, data.options, secureMode, pluginName);
   }
 
   async promptApplyConfirmation(): Promise<boolean> {
     const response = await new Promise((resolve) => {
-      this.rl.question('Is this okay?\n', (answer) => resolve(answer));
+      this.rl.question('Is this okay? (only \'yes\' is accepted)\n', (answer) => resolve(answer));
     });
 
     return response === 'yes';
@@ -42,6 +42,11 @@ export class DebugReporter implements Reporter {
     console.log(JSON.stringify(plan, null, 2));
   }
 
+  displayApplyComplete(message: string[]): void {
+    console.log('🎉 Finished applying 🎉');
+    console.log('Open a new terminal or source \'.zshrc\' for the new changes to be reflected')
+  }
+
   private getDebug(name: string): Debugger {
     if (!this.debuggerCache.has(name)) {
       this.debuggerCache.set(name, createDebug(`plugin:${name}`));

src/ui/reporters/default-reporter.tsx

@@ -37,7 +37,7 @@ export class DefaultReporter implements Reporter {
   }
 
   async promptSudo(pluginName: string, data: SudoRequestData, secureMode: boolean): Promise<SudoRequestResponseData> {
-    console.log(chalk.blue(`Plugin: ${pluginName} requires root access to run command: '${data.command}'`));
+    console.log(chalk.blue(`Plugin: "${pluginName}" requires root access to run command: "${data.command}"`));
 
     let password;
 
@@ -84,6 +84,12 @@ export class DefaultReporter implements Reporter {
     return continueApply;
   }
 
+  displayApplyComplete(messages: string[]): Promise<void> | void {
+    this.renderEmitter.emit(RenderEvent.STATE_TRANSITION, {
+      nextState: RenderState.APPLY_COMPLETE,
+    });
+  }
+
   private log(args: string): void {
     this.renderEmitter.emit(RenderEvent.LOG, args);
   }

src/ui/reporters/plain-reporter.ts

@@ -18,20 +18,25 @@ export class PlainReporter implements Reporter {
   }
 
   async promptSudo(pluginName: string, data: SudoRequestData, secureMode: boolean): Promise<SudoRequestResponseData> {
-    console.log(chalk.blue(`Plugin: ${pluginName} requires root access to run command: '${data.command}'`));
+    console.log(chalk.blue(`Plugin: "${pluginName}" requires root access to run command: "${data.command}"`));
     return SudoUtils.runCommand(data.command, data.options, secureMode, pluginName);
   }
 
   async promptApplyConfirmation(): Promise<boolean> {
     const response = await new Promise((resolve) => {
-      this.rl.question('Is this okay?\n', (answer) => resolve(answer));
+      this.rl.question('Is this okay? (only \'yes\' is accepted)\n', (answer) => resolve(answer));
     });
 
     return response === 'yes';
   }
 
   displayPlan(plan: PlanResponseData[]): void {
-    console.log(JSON.stringify(plan));
+    console.log(JSON.stringify(plan, null, 2));
+  }
+
+  displayApplyComplete(message: string[]): void {
+    console.log('🎉 Finished applying 🎉');
+    console.log('Open a new terminal or source \'.zshrc\' for the new changes to be reflected')
   }
 
 }

src/ui/reporters/reporter.ts

@@ -23,6 +23,7 @@ export enum RenderState { // TODO: instead of having GENERATE_PLAN and APPLYING
   DISPLAY_PLAN,
   PROMPT_APPLY_CONFIRMATION,
   APPLYING,
+  APPLY_COMPLETE
 }
 
 export interface StateTransition {
@@ -34,6 +35,8 @@ export interface DisplayPlanStateTransition extends StateTransition {
 }
 
 export interface Reporter {
+  displayApplyComplete(message: string[]): Promise<void> | void;
+
   displayPlan(plan: PlanResponseData[]): void
 
   promptApplyConfirmation(): Promise<boolean>

src/utils/sudo.ts

@@ -66,7 +66,7 @@ async function codifySpawn(
     const _cmd = password ?
       secureMode
         ? `sudo -k; sudo -SN <<< "${password}" ${cmd}`
-        : `sudo -S <<< "password" ${cmd}`
+        : `sudo -S <<< "${password}" ${cmd}`
       : secureMode
         ? `sudo -k; sudo -N ${cmd}`
         : `sudo ${cmd}`;