Added improved plugin error handling by handling pre-mature plugin exits. Also removed plugin.kill() because it's un-necessary WIP

Author: kevinwang5658

README.md

@@ -41,7 +41,7 @@ USAGE
 * [`codify plugins:uninstall PLUGIN...`](#codify-pluginsuninstall-plugin-1)
 * [`codify plugins:uninstall PLUGIN...`](#codify-pluginsuninstall-plugin-2)
 * [`codify plugins update`](#codify-plugins-update)
-* [`codify uninstall [RESOURCE]`](#codify-uninstall-resource)
+* [`codify uninstall RESOURCES`](#codify-uninstall-resources)
 
 ## `codify apply [FILE]`
 
@@ -402,16 +402,16 @@ DESCRIPTION
 
 _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v3.9.4/src/commands/plugins/update.ts)_
 
-## `codify uninstall [RESOURCE]`
+## `codify uninstall RESOURCES`
 
 describe the command here
 
 ```
 USAGE
-  $ codify uninstall [RESOURCE]
+  $ codify uninstall RESOURCES...
 
 ARGUMENTS
-  RESOURCE  resource type to uninstall
+  RESOURCES...  A resource typeId for uninstalling. Ex: "codify uninstall homebrew"
 
 DESCRIPTION
   describe the command here

codify.json

@@ -2,14 +2,14 @@
   {
     "type": "project",
     "plugins": {
-      "default": "/Users/kevinwang/Projects/codify2/homebrew-plugin/src/index.ts"
+      "default": "../homebrew-plugin"
     }
   },
   {
     "type": "nvm",
     "global": "18.20",
     "nodeVersions": [
-      "18.20.2"
+      "18.20"
     ]
   },
   {
@@ -18,5 +18,13 @@
       "cirruslabs/cli/cirrus",
       "cirruslabs/cli/tart"
     ]
+  },
+  {
+    "type": "vscode"
+  },
+  {
+    "type": "aws-configure",
+    "profile": "codify",
+    "csvCredentials": "../../../Downloads/rootkey.csv"
   }
 ]

src/commands/apply/index.ts

@@ -33,13 +33,12 @@ export default class Apply extends Command {
 
       const resolvedPath = path.resolve(flags.path ?? '.');
 
-      const planResult = await PlanOrchestrator.run(resolvedPath, false);
+      const planResult = await PlanOrchestrator.run(resolvedPath);
       reporter.displayPlan(planResult.plan);
 
       // Short circuit and exit if every change is NOOP
       if (planResult.plan.every((p) => p.operation === ResourceOperation.NOOP)) {
         console.log('No changes necessary. Exiting');
-        await planResult.pluginCollection.destroy();
         return process.exit(0);
       }
 

src/orchestrators/apply.ts

@@ -10,10 +10,7 @@ export const ApplyOrchestrator = {
       .filter((p) => p.operation !== ResourceOperation.NOOP)
 
     ctx.processStarted(ProcessName.APPLY);
-
     await pluginCollection.apply(filteredPlan);
-    await pluginCollection.destroy();
-
     ctx.processFinished(ProcessName.APPLY);
   },
 };

src/orchestrators/common.ts

@@ -13,5 +13,5 @@ export const CommonOrchestrator = {
     ctx.subprocessFinished(SubProcessName.INITIALIZE_PLUGINS)
 
     return { dependencyMap, pluginCollection };
-  },
+  }
 };

src/orchestrators/plan.ts

@@ -4,6 +4,7 @@ import { Project } from '../entities/project.js';
 import { ctx, ProcessName, SubProcessName } from '../events/context.js';
 import { Parser } from '../parser/index.js';
 import { PluginCollection } from '../plugins/plugin-collection.js';
+import { createStartupShellScriptsIfNotExists } from '../utils/file.js';
 import { CommonOrchestrator } from './common.js';
 
 export interface PlanOrchestratorResponse {
@@ -13,14 +14,15 @@ export interface PlanOrchestratorResponse {
 }
 
 export const PlanOrchestrator = {
-  async run(path: string, destroyPlugins = true): Promise<PlanOrchestratorResponse> {
+  async run(path: string): Promise<PlanOrchestratorResponse> {
     ctx.processStarted(ProcessName.PLAN)
 
     ctx.subprocessStarted(SubProcessName.PARSE);
     const project = await Parser.parseProject(path);
     ctx.subprocessFinished(SubProcessName.PARSE);
 
     const { dependencyMap, pluginCollection } = await CommonOrchestrator.initializePlugins(project);
+    await createStartupShellScriptsIfNotExists();
 
     ctx.subprocessStarted(SubProcessName.VALIDATE)
     project.validateWithResourceMap(dependencyMap);
@@ -36,10 +38,6 @@ export const PlanOrchestrator = {
     const plan = await pluginCollection.getPlan(project);
     ctx.subprocessFinished(SubProcessName.GENERATE_PLAN)
 
-    if (destroyPlugins) {
-      await pluginCollection.destroy();
-    }
-
     ctx.processFinished(ProcessName.PLAN)
 
     return {

src/orchestrators/uninstall.ts

@@ -2,6 +2,7 @@ import { PlanResponseData, ResourceOperation } from 'codify-schemas';
 import { randomUUID } from 'node:crypto';
 
 import { ctx, ProcessName } from '../events/context.js';
+import { createStartupShellScriptsIfNotExists } from '../utils/file.js';
 import { CommonOrchestrator } from './common.js';
 
 export const UninstallOrchestrator = {
@@ -18,12 +19,10 @@ export const UninstallOrchestrator = {
     } as PlanResponseData))
 
     const { pluginCollection } = await CommonOrchestrator.initializePlugins();
+    await createStartupShellScriptsIfNotExists();
 
     ctx.processStarted(ProcessName.UNINSTALL);
-
     await pluginCollection.apply(plan);
-    await pluginCollection.destroy();
-
     ctx.processFinished(ProcessName.UNINSTALL);
   },
 };

src/plugins/plugin-collection.ts

@@ -78,12 +78,6 @@ export class PluginCollection {
     }
   }
 
-  async destroy(): Promise<void> {
-    for (const plugin of this.plugins.values()) {
-      plugin.destroy();
-    }
-  }
-
   private async resolvePlugins(project?: Project): Promise<Plugin[]> {
     const pluginDefinitions: Record<string, string> = {
       ...DEFAULT_PLUGINS,

src/plugins/plugin-process.ts

@@ -41,15 +41,13 @@ export class PluginProcess {
 
     _process.stdout!.on('data', (message) => ctx.pluginStdout(message.toString('utf8')));
     _process.stderr!.on('data', (message) => ctx.pluginStderr(message.toString('utf8')));
-
+    _process.on('exit', (code) => {
+      throw new Error(`Plugin ${this.name} exited with code ${code}`);
+    })
 
     return new PluginProcess(_process);
   }
 
-  killPlugin(): void {
-    this.process.kill();
-  }
-
   async sendMessageForResult(message: PluginMessage): Promise<unknown> {
     return new Promise((resolve, reject) => {
       const handler = new SendMessageForResultHandler(message, this.process, resolve, reject);

src/plugins/plugin.ts

@@ -51,7 +51,7 @@ export class Plugin {
     const response = await this.process!.sendMessageForResult({ cmd: 'validate', data: { configs: rawConfigs } });
 
     if (!this.validateValidateResponse(response)) {
-      throw new Error(`Invalid validate response from plugin: ${this.name}`);
+      throw new Error(`Plugin error: Invalid validate response from plugin: ${this.name}`);
     }
 
     return response;
@@ -61,7 +61,7 @@ export class Plugin {
     const response = await this.process!.sendMessageForResult({ cmd: 'plan', data: resource.raw });
 
     if (!this.validatePlanResponse(response)) {
-      throw new Error(`Plugin error: plugin ${this.name} returned invalid plan response`)
+      throw new Error(`Plugin error: plugin ${this.name} returned invalid plan response: ${JSON.stringify(planResponseValidator.errors, null, 2)}`)
     }
 
     return response;
@@ -71,31 +71,15 @@ export class Plugin {
     await this.process!.sendMessageForResult({ cmd: 'apply', data: { plan } });
   }
 
-  destroy() {
-    this.process!.killPlugin();
-  }
-
   private validateInitializeResponse(response: unknown): response is InitializeResponseData {
-    if (!initializeResponseValidator(response)) {
-      throw new Error(`Invalid initialize response from plugin: ${this.name}. Error: ${initializeResponseValidator.errors}`)
-    }
-
-    return true;
+    return initializeResponseValidator(response)
   }
 
   private validateValidateResponse(response: unknown): response is ValidateResponseData {
-    if (!validateResponseValidator(response)) {
-      throw new Error(`Invalid validate response from plugin: ${this.name}. Error: ${initializeResponseValidator.errors}`)
-    }
-
-    return true;
+    return validateResponseValidator(response)
   }
 
   private validatePlanResponse(response: unknown): response is PlanResponseData {
-    if (!planResponseValidator(response)) {
-      throw new Error(`Invalid plan response from plugin: ${this.name}. Error: ${initializeResponseValidator.errors}`)
-    }
-
-    return true;
+    return planResponseValidator(response);
   }
 }