feat: Improved apply validation errors

Author: kevinwang5658

package-lock.json

@@ -5,7 +5,7 @@
   },
   "dependencies": {
     "@codifycli/ink-form": "0.0.12",
-    "@codifycli/schemas": "1.1.0-beta5",
+    "@codifycli/schemas": "1.1.0-beta7",
     "@homebridge/node-pty-prebuilt-multiarch": "^0.12.0-beta.5",
     "@mischnic/json-sourcemap": "^0.1.1",
     "@oclif/core": "^4.0.8",

package.json

@@ -11,7 +11,7 @@ import { DefaultReporter } from '../ui/reporters/default-reporter.js';
 import { Reporter, ReporterFactory, ReporterType } from '../ui/reporters/reporter.js';
 import { spawnSafe } from '../utils/spawn.js';
 import { SudoUtils } from '../utils/sudo.js';
-import { prettyPrintError } from './errors.js';
+import { PluginApplyValidationError, prettyPrintError } from './errors.js';
 
 export abstract class BaseCommand extends Command {
   static baseFlags = {
@@ -145,6 +145,12 @@ export abstract class BaseCommand extends Command {
   }
 
   protected async catch(err: Error): Promise<void> {
+    if (err instanceof PluginApplyValidationError && this.reporter) {
+      await this.reporter.hide();
+      await this.reporter.displayApplyValidationError(err.resourcePlan);
+      process.exit(1);
+    }
+
     prettyPrintError(err);
     process.exit(1);
   }

src/common/base-command.ts

@@ -1,6 +1,7 @@
 import { ErrorObject } from 'ajv';
 import chalk from 'chalk';
 
+import { ResourcePlan } from '../entities/plan.js';
 import { ResourceConfig } from '../entities/resource-config.js';
 import { SourceMapCache } from '../parser/source-maps.js';
 import { formatAjvErrors } from '../utils/ajv.js';
@@ -231,6 +232,20 @@ export class SpawnError extends CodifyError {
   }
 }
 
+export class PluginApplyValidationError extends CodifyError {
+  name = 'PluginApplyValidationError';
+  resourcePlan: ResourcePlan;
+
+  constructor(resourcePlan: ResourcePlan) {
+    super(`Apply validation failed for resource: "${resourcePlan.id}".`);
+    this.resourcePlan = resourcePlan;
+  }
+
+  formattedMessage(): string {
+    return this.message;
+  }
+}
+
 export function prettyPrintError(error: unknown): void {
   if (error instanceof CodifyError) {
     return console.error(chalk.red(error.formattedMessage()));

src/common/errors.ts

@@ -50,7 +50,7 @@ export const ApplyOrchestrator = {
     // Need to sleep to wait for the message to display before we exit
     await sleep(100);
 
-    reporter.displayMessage(`
+    await reporter.displayMessage(`
 🎉 Finished applying 🎉
 Open a new terminal or source '.zshrc' for the new changes to be reflected`);
   },

src/orchestrators/apply.ts

@@ -195,7 +195,7 @@ export class ImportOrchestrator {
 
     // No writes
     reporter.displayImportResult(importResult, true);
-    reporter.displayMessage('\n🎉 Imported completed 🎉')
+    await reporter.displayMessage('\n🎉 Imported completed 🎉')
 
     await sleep(100);
   }

src/orchestrators/import.ts

@@ -1,4 +1,5 @@
 import {
+  ErrorCode,
   GetResourceInfoResponseData,
   GetResourceInfoResponseDataSchema,
   ImportRequestData,
@@ -18,6 +19,7 @@ import {
 
 import { ResourcePlan } from '../entities/plan.js';
 import { ResourceConfig } from '../entities/resource-config.js';
+import { PluginApplyValidationError } from '../common/errors.js';
 import { ajv } from '../utils/ajv.js';
 import { PluginProcess } from './plugin-process.js';
 
@@ -146,7 +148,16 @@ export class Plugin implements IPlugin {
     const result = await this.process!.sendMessageForResult('apply', { plan });
 
     if (!result.isSuccessful()) {
-      throw new Error(`Apply error for plugin: "${this.name}", resource: "${plan.resourceType}" \n\n` + result.data);
+      const data = result.data as any;
+
+      if (data?.errorCode === ErrorCode.APPLY_VALIDATION && data.plan) {
+        throw new PluginApplyValidationError(new ResourcePlan(data.plan));
+      }
+
+      const message = typeof data === 'string'
+        ? data
+        : (data?.message ?? JSON.stringify(data, null, 2));
+      throw new Error(`Apply error for plugin: "${this.name}", resource: "${plan.resourceType}" \n\n` + message);
     }
   }
 

src/plugins/plugin.ts

@@ -5,7 +5,8 @@ import { useAtom } from 'jotai';
 import { EventEmitter } from 'node:events';
 import React, { useLayoutEffect } from 'react';
 
-import { Plan } from '../../entities/plan.js';
+import { Plan, ResourcePlan } from '../../entities/plan.js';
+import { prettyFormatResourcePlan } from '../plan-pretty-printer.js';
 import { FileModificationResult } from '../../generators/index.js';
 import { ImportResult } from '../../orchestrators/import.js';
 import { RenderEvent } from '../reporters/reporter.js';
@@ -49,6 +50,24 @@ export function DefaultComponent(props: {
         (plan, idx) => <PlanComponent key={idx} plan={plan}/>
       }</Static>
     }
+    {
+      renderStatus === RenderStatus.APPLY_VALIDATION_ERROR && (
+        <Static items={[renderData as ResourcePlan]}>{
+          (resourcePlan, idx) => (
+            <Box key={idx} flexDirection="column" marginTop={1}>
+              <Text color="red" bold>
+                {`Apply validation failed: resource "${resourcePlan.id}" did not reach its desired state. \nExiting...`}
+              </Text>
+              <Text> </Text>
+              <Text bold backgroundColor={'red'}>Changes still needed:</Text>
+              <Text>{prettyFormatResourcePlan(resourcePlan)}</Text>
+              <Text> </Text>
+              <Text>Try re-running to see if the changes have applied.</Text>
+            </Box>
+          )
+        }</Static>
+      )
+    }
     {
       renderStatus === RenderStatus.PROMPT_CONFIRMATION && (
         <Box flexDirection="column">

src/ui/components/default-component.tsx

@@ -5,7 +5,7 @@ import { EventEmitter } from 'node:events';
 import React from 'react';
 import stripAnsi from 'strip-ansi'
 
-import { Plan } from '../../entities/plan.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';
@@ -226,8 +226,8 @@ export class DefaultReporter implements Reporter {
     void this.updateRenderState(RenderStatus.DISPLAY_PLAN, plan)
   }
 
-  displayMessage(message: string) {
-    void this.updateRenderState(RenderStatus.DISPLAY_MESSAGE, message);
+  async displayMessage(message: string) {
+     await this.updateRenderState(RenderStatus.DISPLAY_MESSAGE, message);
   }
 
   async promptInitResultSelection(availableTypes: string[]): Promise<string[]> {
@@ -267,6 +267,10 @@ export class DefaultReporter implements Reporter {
     void this.updateRenderState(RenderStatus.DISPLAY_FILE_MODIFICATION, diff);
   }
 
+  async displayApplyValidationError(resourcePlan: ResourcePlan) {
+    await this.updateRenderState(RenderStatus.APPLY_VALIDATION_ERROR, resourcePlan);
+  }
+
   private log(log: string): void {
     if (this.silent) return;
 

src/ui/reporters/default-reporter.tsx

@@ -1,6 +1,6 @@
 import { CommandRequestData } from '@codifycli/schemas';
 
-import { Plan } from '../../entities/plan.js';
+import { Plan, ResourcePlan } from '../../entities/plan.js';
 import { ResourceConfig } from '../../entities/resource-config.js';
 import { ImportResult } from '../../orchestrators/import.js';
 import { Reporter } from './reporter.js';
@@ -71,4 +71,13 @@ export class JsonReporter implements Reporter {
   async disableRawMode(): Promise<void> {
     throw new Error('Json reporter error: disableRawMode is not supported. Raw stdin mode requires interactive terminal access.');
   }
+
+  displayApplyValidationError(resourcePlan: ResourcePlan): void {
+    console.log(JSON.stringify({
+      error: 'apply_validation',
+      resourceId: resourcePlan.id,
+      operation: resourcePlan.operation,
+      parameters: resourcePlan.parameters,
+    }, null, 2));
+  }
 }