Added error handling to messgae handlers. Added catch blocks to commands instead of a try-catch. Made error message red

Author: kevinwang5658

src/commands/apply/index.ts

@@ -1,6 +1,7 @@
 import { Args, Command, Flags } from '@oclif/core'
+import chalk from 'chalk';
 import { ResourceOperation } from 'codify-schemas';
-import path from 'node:path';
+import * as path from 'node:path';
 
 import { ApplyOrchestrator } from '../../orchestrators/apply.js';
 import { PlanOrchestrator } from '../../orchestrators/plan.js';
@@ -22,37 +23,37 @@ export default class Apply extends Command {
     path: Flags.string({ char: 'p', description: 'path to project' }),
   }
 
+  protected async catch(err: Error): Promise<void> {
+    console.log(chalk.red(err.message));
+    process.exit(1);
+  }
+
   public async run(): Promise<void> {
     const { flags } = await this.parse(Apply)
     const reporter = new DefaultReporter()
 
-    try {
-      if (flags.path) {
-        this.log(`Applying Codify from: ${flags.path}`);
-      }
-
-      const resolvedPath = path.resolve(flags.path ?? '.');
+    if (flags.path) {
+      this.log(`Applying Codify from: ${flags.path}`);
+    }
 
-      const planResult = await PlanOrchestrator.run(resolvedPath);
-      reporter.displayPlan(planResult.plan);
+    const resolvedPath = path.resolve(flags.path ?? '.');
 
-      // Short circuit and exit if every change is NOOP
-      if (planResult.plan.every((p) => p.operation === ResourceOperation.NOOP)) {
-        console.log('No changes necessary. Exiting');
-        return process.exit(0);
-      }
+    const planResult = await PlanOrchestrator.run(resolvedPath);
+    reporter.displayPlan(planResult.plan);
 
-      const confirm = await reporter.promptApplyConfirmation()
-      if (!confirm) {
-        return process.exit(0);
-      }
+    // Short circuit and exit if every change is NOOP
+    if (planResult.plan.every((p) => p.operation === ResourceOperation.NOOP)) {
+      console.log('No changes necessary. Exiting');
+      return process.exit(0);
+    }
 
-      await ApplyOrchestrator.run(planResult);
-    } catch (error: unknown) {
-      console.error(error);
-      process.exit(1);
+    const confirm = await reporter.promptApplyConfirmation()
+    if (!confirm) {
+      return process.exit(0);
     }
 
+    await ApplyOrchestrator.run(planResult);
+
     process.exit(0);
   }
 }

src/commands/plan/index.ts

@@ -1,4 +1,5 @@
 import { Args, Command, Flags } from '@oclif/core'
+import chalk from 'chalk';
 import * as path from 'node:path';
 
 import { PlanOrchestrator } from '../../orchestrators/plan.js';
@@ -15,6 +16,11 @@ export default class Plan extends Command {
     '<%= config.bin %> <%= command.id %>',
   ]
 
+  protected async catch(err: Error): Promise<void> {
+    console.log(chalk.red(err.message));
+    process.exit(1);
+  }
+
   static flags = {
     // flag with no value (-f, --force)
     force: Flags.boolean({ char: 'f' }),
@@ -28,19 +34,14 @@ export default class Plan extends Command {
     const { flags } = await this.parse(Plan)
     const reporter = new DefaultReporter()
 
-    try {
-      if (flags.path) {
-        this.log(`Applying Codify from: ${flags.path}`);
-      }
-
-      const resolvedPath = path.resolve(flags.path ?? '.');
+    if (flags.path) {
+      this.log(`Applying Codify from: ${flags.path}`);
+    }
 
-      const { plan } = await PlanOrchestrator.run(resolvedPath);
-      reporter.displayPlan(plan);
+    const resolvedPath = path.resolve(flags.path ?? '.');
 
-    } catch (error) {
-      console.error(error);
-    }
+    const { plan } = await PlanOrchestrator.run(resolvedPath);
+    reporter.displayPlan(plan);
 
     process.exit(0);
   }

src/commands/uninstall.ts

@@ -1,7 +1,8 @@
 import { Args, Command } from '@oclif/core'
+import chalk from 'chalk';
+
 import { UninstallOrchestrator } from '../orchestrators/uninstall.js';
 import { DefaultReporter } from '../ui/reporters/default-reporter.js';
-import { ctx } from '../events/context.js';
 
 export default class Uninstall extends Command {
   static description = 'describe the command here'
@@ -21,6 +22,11 @@ export default class Uninstall extends Command {
     }),
   }
 
+  protected async catch(err: Error): Promise<void> {
+    console.log(chalk.red(err.message));
+    process.exit(1);
+  }
+
   public async run(): Promise<void> {
     const { raw } = await this.parse(Uninstall)
     new DefaultReporter()
@@ -36,12 +42,7 @@ export default class Uninstall extends Command {
       throw new Error('A resource id must be specified for uninstall. Ex: "codify uninstall homebrew"')
     }
 
-    try {
-      await UninstallOrchestrator.run(args);
-    } catch (error) {
-      ctx.log(error);
-      process.exit(1);
-    }
+    await UninstallOrchestrator.run(args);
 
     process.exit(0);
   }

src/plugins/plugin-process.ts

@@ -7,18 +7,14 @@ import { PluginMessage } from './message.js';
 
 const ipcMessageValidator = ajv.compile(IpcMessageSchema);
 
-type Resolve = (value: unknown) => void;
+type Resolve<T> = (value: T) => void;
 type Reject = (reason?: Error) => void;
 
 const resultFunctionName = (cmd: string) => `${cmd}_Response`;
 
 export class PluginProcess {
   process: ChildProcess;
 
-  constructor(process: ChildProcess) {
-    this.process = process;
-  }
-
   static async start(pluginPath: string, name: string): Promise<PluginProcess> {
     const isTypescript = pluginPath.endsWith('.ts');
     const isTsxInstalled = PluginProcess.isTsxInstalled();
@@ -48,7 +44,11 @@ export class PluginProcess {
     return new PluginProcess(_process);
   }
 
-  async sendMessageForResult(message: PluginMessage): Promise<unknown> {
+  constructor(process: ChildProcess) {
+    this.process = process;
+  }
+
+  async sendMessageForResult(message: PluginMessage): Promise<IpcMessage> {
     return new Promise((resolve, reject) => {
       const handler = new SendMessageForResultHandler(message, this.process, resolve, reject);
 
@@ -76,14 +76,14 @@ export class PluginProcess {
 class SendMessageForResultHandler {
   messageToSend: PluginMessage;
   process: ChildProcess;
-  promiseResolve: Resolve;
+  promiseResolve: Resolve<IpcMessage>;
   promiseReject: Reject;
   timer: NodeJS.Timeout;
 
   constructor(
     messageToSend: PluginMessage,
     process: ChildProcess,
-    resolve: Resolve,
+    resolve: Resolve<IpcMessage>,
     reject: Reject,
     timeout = 600_000, // Default time is 10 minutes for a command
   ) {
@@ -98,11 +98,11 @@ class SendMessageForResultHandler {
     ctx.debug(JSON.stringify(incomingMessage, null, 2));
 
     if (!this.validateIpcMessage(incomingMessage)) {
-      return this.reject(new Error(`Bad message from plugin. ${JSON.stringify(incomingMessage, null, 2)}`))
+      return this.reject(new Error(`Invalid message from plugin. ${JSON.stringify(incomingMessage, null, 2)}`))
     }
 
     if (incomingMessage.cmd === resultFunctionName(this.messageToSend.cmd)) {
-      this.resolve(incomingMessage.data);
+      this.resolve(incomingMessage);
     }
   };
 
@@ -115,7 +115,7 @@ class SendMessageForResultHandler {
     this.promiseReject(err);
   }
 
-  private resolve = (value: unknown) => {
+  private resolve = (value: IpcMessage) => {
     if (this.timer.hasRef()) {
       clearTimeout(this.timer);
     }

src/plugins/plugin.ts

@@ -1,6 +1,7 @@
 import {
   InitializeResponseData,
   InitializeResponseDataSchema,
+  MessageStatus,
   PlanResponseData,
   PlanResponseDataSchema,
   ValidateResponseData,
@@ -35,36 +36,44 @@ export class Plugin {
 
     const initializeResponse = await this.process.sendMessageForResult({ cmd: 'initialize', data: {} });
 
-    if (!this.validateInitializeResponse(initializeResponse)) {
+    if (!this.validateInitializeResponse(initializeResponse.data)) {
       throw new Error(`Invalid initialize response from plugin: ${this.name}`);
     }
 
-    initializeResponse.resourceDefinitions.forEach((d) => {
+    for (const d of initializeResponse.data.resourceDefinitions) {
       this.resourceDependenciesMap.set(d.type, d.dependencies)
-    });
+    }
 
-    return initializeResponse;
+    return initializeResponse.data;
   }
 
   async validate(configs: ResourceConfig[]): Promise<ValidateResponseData> {
     const rawConfigs = configs.map((c) => c.raw);
-    const response = await this.process!.sendMessageForResult({ cmd: 'validate', data: { configs: rawConfigs } });
+    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);
+    }
 
-    if (!this.validateValidateResponse(response)) {
+    if (!this.validateValidateResponse(data)) {
       throw new Error(`Plugin error: Invalid validate response from plugin: ${this.name}`);
     }
 
-    return response;
+    return data;
   }
 
   async plan(resource: ResourceConfig): Promise<PlanResponseData> {
-    const response = await this.process!.sendMessageForResult({ cmd: 'plan', data: resource.raw });
+    const { data, status } = await this.process!.sendMessageForResult({ cmd: 'plan', data: resource.raw });
+
+    if (status === MessageStatus.ERROR) {
+      throw new Error(`Plan error for plugin: "${this.name}", resource: "${resource.type}" \n\n` + data);
+    }
 
-    if (!this.validatePlanResponse(response)) {
+    if (!this.validatePlanResponse(data)) {
       throw new Error(`Plugin error: plugin ${this.name} returned invalid plan response: ${JSON.stringify(planResponseValidator.errors, null, 2)}`)
     }
 
-    return response;
+    return data;
   }
 
   async apply(plan: PlanResponseData): Promise<void> {