feat: Refactored to share the same plugin error type. Use the reporter to determine how to present it.

Author: kevinwang5658

package-lock.json

@@ -5,7 +5,7 @@
   },
   "dependencies": {
     "@codifycli/ink-form": "0.0.12",
-    "@codifycli/schemas": "1.1.0-beta7",
+    "@codifycli/schemas": "1.1.0-beta8",
     "@homebridge/node-pty-prebuilt-multiarch": "^0.12.0-beta.5",
     "@mischnic/json-sourcemap": "^0.1.1",
     "@oclif/core": "^4.0.8",
@@ -43,7 +43,7 @@
   },
   "description": "Codify is a configuration-as-code tool that declaratively installs and manages developer tools and applications. Check out https://dashboard.codifycli.com for an editor.",
   "devDependencies": {
-    "@codifycli/plugin-core": "^1.1.0-beta13",
+    "@codifycli/plugin-core": "^1.1.0-beta19",
     "@oclif/prettier-config": "^0.2.1",
     "@types/chalk": "^2.2.0",
     "@types/cors": "^2.8.19",

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 { PluginApplyValidationError, prettyPrintError } from './errors.js';
+import { PluginError, prettyPrintError } from './errors.js';
 
 export abstract class BaseCommand extends Command {
   static baseFlags = {
@@ -145,9 +145,9 @@ export abstract class BaseCommand extends Command {
   }
 
   protected async catch(err: Error): Promise<void> {
-    if (err instanceof PluginApplyValidationError && this.reporter) {
+    if (err instanceof PluginError && this.reporter) {
       await this.reporter.hide();
-      await this.reporter.displayApplyValidationError(err.resourcePlan);
+      this.reporter.displayPluginError(err);
       process.exit(1);
     }
 

src/common/base-command.ts

@@ -1,7 +1,7 @@
 import { ErrorObject } from 'ajv';
 import chalk from 'chalk';
+import { PluginErrorData } from '@codifycli/schemas';
 
-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';
@@ -232,13 +232,17 @@ 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;
+export class PluginError extends CodifyError {
+  name = 'PluginError';
+  pluginName: string;
+  resourceType: string;
+  errorData: PluginErrorData;
+
+  constructor(pluginName: string, resourceType: string, errorData: PluginErrorData) {
+    super(errorData.message);
+    this.pluginName = pluginName;
+    this.resourceType = resourceType;
+    this.errorData = errorData;
   }
 
   formattedMessage(): string {

src/common/errors.ts

@@ -1,5 +1,5 @@
 import {
-  ErrorCode,
+  ErrorResponseDataSchema,
   GetResourceInfoResponseData,
   GetResourceInfoResponseDataSchema,
   ImportRequestData,
@@ -12,17 +12,19 @@ import {
   PlanRequestData,
   PlanResponseData,
   PlanResponseDataSchema,
+  PluginErrorData,
   ResourceJson,
   ValidateResponseData,
   ValidateResponseDataSchema,
 } from '@codifycli/schemas';
 
 import { ResourcePlan } from '../entities/plan.js';
 import { ResourceConfig } from '../entities/resource-config.js';
-import { PluginApplyValidationError } from '../common/errors.js';
+import { PluginError } from '../common/errors.js';
 import { ajv } from '../utils/ajv.js';
 import { PluginProcess } from './plugin-process.js';
 
+const errorResponseValidator = ajv.compile(ErrorResponseDataSchema);
 const initializeResponseValidator = ajv.compile(InitializeResponseDataSchema);
 const validateResponseValidator = ajv.compile(ValidateResponseDataSchema);
 const getResourceInfoResponseValidator = ajv.compile(GetResourceInfoResponseDataSchema);
@@ -69,9 +71,9 @@ export class Plugin implements IPlugin {
   async validate(configs: ResourceConfig[]): Promise<ValidateResponseData> {
     const jsonConfigs = configs.map((c) => c.toJson());
     const result = await this.process!.sendMessageForResult('validate', { configs: jsonConfigs });
-    
+
     if (!result.isSuccessful()) {
-      throw new Error(`Validate error for plugin: "${this.name}" \n\n${JSON.stringify(result.data, null, 2)}`);
+      throw new PluginError(this.name, 'validate', this.toErrorData(result.data));
     }
 
     if (!this.validateValidateResponse(result.data)) {
@@ -85,7 +87,7 @@ export class Plugin implements IPlugin {
     const result = await this.process!.sendMessageForResult('getResourceInfo', { type });
 
     if (!result.isSuccessful()) {
-      throw new Error(`Unable to get info for resource: "${type}" from plugin: "${this.name}" \n\n` + result.data);
+      throw new PluginError(this.name, type, this.toErrorData(result.data));
     }
 
     if (!this.validateGetResourceInfoResponse(result.data)) {
@@ -102,7 +104,7 @@ export class Plugin implements IPlugin {
     });
 
     if (!result.isSuccessful()) {
-      throw new Error(`Unable to match resource: "${resource.type}" from plugin: "${this.name}" \n\n` + result.data);
+      throw new PluginError(this.name, resource.type, this.toErrorData(result.data));
     }
 
     if (!this.validateMatchResponse(result.data)) {
@@ -112,12 +114,11 @@ export class Plugin implements IPlugin {
     return result.data;
   }
 
-
   async import(config: ResourceJson, autoSearchAll = false): Promise<ImportResponseData> {
     const result = await this.process!.sendMessageForResult('import', <ImportRequestData>{ ...config, autoSearchAll });
 
     if (!result.isSuccessful()) {
-      throw new Error(`Unable import resource ${config.core.type} with plugin: "${this.name}" \n\n` + result.data);
+      throw new PluginError(this.name, config.core.type, this.toErrorData(result.data));
     }
 
     if (!this.validateImportResponse(result.data)) {
@@ -128,13 +129,10 @@ export class Plugin implements IPlugin {
   }
 
   async plan(request: PlanRequestData): Promise<ResourcePlan> {
-    const result = await this.process!.sendMessageForResult(
-      'plan',
-      request
-    );
+    const result = await this.process!.sendMessageForResult('plan', request);
 
     if (!result.isSuccessful()) {
-      throw new Error(`Plan error for plugin: "${this.name}", resource: "${request.core.type}" \n\n` + result.data);
+      throw new PluginError(this.name, request.core.type, this.toErrorData(result.data));
     }
 
     if (!this.validatePlanResponse(result.data)) {
@@ -148,25 +146,23 @@ export class Plugin implements IPlugin {
     const result = await this.process!.sendMessageForResult('apply', { plan });
 
     if (!result.isSuccessful()) {
-      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);
+      throw new PluginError(this.name, plan.resourceType, this.toErrorData(result.data));
     }
   }
 
   async setVerbosityLevel(verbosityLevel: number): Promise<void> {
     const result = await this.process!.sendMessageForResult('setVerbosityLevel', { verbosityLevel });
 
     if (!result.isSuccessful()) {
-      throw new Error(`Set verbosity error for plugin: "${this.name}" \n\n` + result.data);
+      throw new PluginError(this.name, 'setVerbosityLevel', this.toErrorData(result.data));
+    }
+  }
+
+  private toErrorData(data: unknown): PluginErrorData {
+    if (errorResponseValidator(data)) {
+      return data as unknown as PluginErrorData;
     }
+    return { errorType: 'unknown', message: typeof data === 'string' ? data : JSON.stringify(data, null, 2) };
   }
 
   kill() {

src/plugins/plugin.ts

@@ -68,6 +68,17 @@ export function DefaultComponent(props: {
         }</Static>
       )
     }
+    {
+      renderStatus === RenderStatus.PLUGIN_ERROR && (
+        <Static items={[renderData as string]}>{
+          (message, idx) => (
+            <Box key={idx} flexDirection="column" marginTop={1}>
+              <Text color="red">{message}</Text>
+            </Box>
+          )
+        }</Static>
+      )
+    }
     {
       renderStatus === RenderStatus.PROMPT_CONFIRMATION && (
         <Box flexDirection="column">

src/ui/components/default-component.tsx

@@ -0,0 +1,12 @@
+import { PluginError } from '../common/errors.js';
+import { ResourcePlan } from '../entities/plan.js';
+import { prettyFormatResourcePlan } from './plan-pretty-printer.js';
+
+export function formatApplyValidationError(error: PluginError): string {
+  const plan = new ResourcePlan((error.errorData.data as any).plan);
+  return [
+    `Apply validation failed: resource "${plan.id}" did not reach its desired state.`,
+    'Changes still needed:',
+    prettyFormatResourcePlan(plan),
+  ].join('\n');
+}

src/ui/plugin-error-formatter.ts

@@ -6,6 +6,7 @@ import React from 'react';
 import stripAnsi from 'strip-ansi'
 
 import { Plan, ResourcePlan } from '../../entities/plan.js';
+import { PluginError } from '../../common/errors.js';
 import { ResourceConfig } from '../../entities/resource-config.js';
 import { ResourceInfo } from '../../entities/resource-info.js';
 import { ctx, Event, ProcessName, SubProcessName } from '../../events/context.js';
@@ -267,8 +268,13 @@ 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);
+  displayPluginError(error: PluginError): void {
+    if (error.errorData.errorType === 'apply_validation') {
+      const resourcePlan = new ResourcePlan((error.errorData.data as any).plan);
+      void this.updateRenderState(RenderStatus.APPLY_VALIDATION_ERROR, resourcePlan);
+      return;
+    }
+    void this.updateRenderState(RenderStatus.PLUGIN_ERROR, error.message);
   }
 
   private log(log: string): void {

src/ui/reporters/default-reporter.tsx

@@ -1,6 +1,7 @@
 import { CommandRequestData } from '@codifycli/schemas';
 
-import { Plan, ResourcePlan } from '../../entities/plan.js';
+import { Plan } from '../../entities/plan.js';
+import { PluginError } from '../../common/errors.js';
 import { ResourceConfig } from '../../entities/resource-config.js';
 import { ImportResult } from '../../orchestrators/import.js';
 import { Reporter } from './reporter.js';
@@ -72,12 +73,13 @@ export class JsonReporter implements Reporter {
     throw new Error('Json reporter error: disableRawMode is not supported. Raw stdin mode requires interactive terminal access.');
   }
 
-  displayApplyValidationError(resourcePlan: ResourcePlan): void {
+  displayPluginError(error: PluginError): void {
     console.log(JSON.stringify({
-      error: 'apply_validation',
-      resourceId: resourcePlan.id,
-      operation: resourcePlan.operation,
-      parameters: resourcePlan.parameters,
+      errorType: error.errorData.errorType,
+      message: error.message,
+      pluginName: error.pluginName,
+      resourceType: error.resourceType,
+      data: error.errorData.data,
     }, null, 2));
   }
 }