@codifycli/plugin-core 1.1.0-beta20 → 1.1.0-beta21

package/dist/common/errors.d.ts

@@ -3,6 +3,7 @@ export declare class ApplyValidationError extends Error {
     resourceType: string;
     resourceName?: string;
     plan: Plan<any>;
-    constructor(plan: Plan<any>);
+    logs: string[];
+    constructor(plan: Plan<any>, logs?: string[]);
     private static prettyPrintPlan;
 }

package/dist/common/errors.js

@@ -2,11 +2,13 @@ export class ApplyValidationError extends Error {
     resourceType;
     resourceName;
     plan;
-    constructor(plan) {
+    logs;
+    constructor(plan, logs = []) {
         super(`Failed to apply changes to resource: "${plan.resourceId}". Additional changes are needed to complete apply.\nChanges remaining:\n${ApplyValidationError.prettyPrintPlan(plan)}`);
         this.resourceType = plan.coreParameters.type;
         this.resourceName = plan.coreParameters.name;
         this.plan = plan;
+        this.logs = logs;
     }
     static prettyPrintPlan(plan) {
         const { operation, parameters } = plan.toResponse();

package/dist/messages/handlers.js

@@ -128,7 +128,7 @@ export class MessageHandler {
             errorPayload = {
                 errorType: 'apply_validation',
                 message: e.message,
-                data: { plan: e.plan.toResponse() },
+                data: { plan: e.plan.toResponse(), logs: e.logs },
             };
         }
         else {

package/dist/plugin/plugin.js

@@ -168,7 +168,11 @@ export class Plugin {
         if (!resource) {
             throw new Error('Malformed plan with resource that cannot be found');
         }
-        await ptyLocalStorage.run(new SequentialPty(), async () => resource.apply(plan));
+        let applyLogs = [];
+        await ptyLocalStorage.run(new SequentialPty(), async () => {
+            await resource.apply(plan);
+            applyLogs = getPty().getLogs();
+        });
         // Validate using desired/desired. If the apply was successful, no changes should be reported back.
         // Default back desired back to current if it is not defined (for destroys only)
         const validationPlan = await ptyLocalStorage.run(new BackgroundPty(), async () => {
@@ -177,7 +181,7 @@ export class Plugin {
             return result;
         });
         if (validationPlan.requiresChanges()) {
-            throw new ApplyValidationError(validationPlan);
+            throw new ApplyValidationError(validationPlan, applyLogs);
         }
     }
     async setVerbosityLevel(data) {

package/dist/pty/background-pty.d.ts

@@ -17,5 +17,6 @@ export declare class BackgroundPty implements IPty {
         signal?: number | undefined;
     }>;
     private initialize;
+    getLogs(): string[];
     private getDefaultShell;
 }

package/dist/pty/background-pty.js

@@ -121,6 +121,9 @@ export class BackgroundPty {
             });
         });
     }
+    getLogs() {
+        return [];
+    }
     getDefaultShell() {
         return process.env.SHELL;
     }

package/dist/pty/index.d.ts

@@ -47,5 +47,6 @@ export interface IPty {
         exitCode: number;
         signal?: number | undefined;
     }>;
+    getLogs(): string[];
 }
 export declare function getPty(): IPty;

package/dist/pty/seqeuntial-pty.d.ts

@@ -6,6 +6,10 @@ import { IPty, SpawnOptions, SpawnResult } from './index.js';
  * without a tty (or even a stdin) attached so interactive commands will not work.
  */
 export declare class SequentialPty implements IPty {
+    private logBuffer;
+    private static readonly MAX_LOG_LINES;
+    getLogs(): string[];
+    private appendLog;
     spawn(cmd: string | string[], options?: SpawnOptions): Promise<SpawnResult>;
     spawnSafe(cmd: string | string[], options?: SpawnOptions): Promise<SpawnResult>;
     kill(): Promise<{

package/dist/pty/seqeuntial-pty.js

@@ -19,6 +19,18 @@ const validateSudoRequestResponse = ajv.compile(CommandRequestResponseDataSchema
  * without a tty (or even a stdin) attached so interactive commands will not work.
  */
 export class SequentialPty {
+    logBuffer = [];
+    static MAX_LOG_LINES = 100;
+    getLogs() {
+        return [...this.logBuffer];
+    }
+    appendLog(data) {
+        const lines = data.split('\n');
+        this.logBuffer.push(...lines);
+        if (this.logBuffer.length > SequentialPty.MAX_LOG_LINES) {
+            this.logBuffer = this.logBuffer.slice(-SequentialPty.MAX_LOG_LINES);
+        }
+    }
     async spawn(cmd, options) {
         const spawnResult = await this.spawnSafe(cmd, options);
         if (spawnResult.status !== 'success') {
@@ -35,7 +47,9 @@ export class SequentialPty {
         if (options?.stdin || options?.requiresRoot || options?.requiresSudoAskpass) {
             return this.externalSpawn(cmd, options);
         }
-        console.log(`Running command: ${Array.isArray(cmd) ? cmd.join('\\\n') : cmd}` + (options?.cwd ? `(${options?.cwd})` : ''));
+        const cmdLine = `Running command: ${Array.isArray(cmd) ? cmd.join('\\\n') : cmd}` + (options?.cwd ? `(${options?.cwd})` : '');
+        console.log(cmdLine);
+        this.appendLog(cmdLine);
         return new Promise((resolve) => {
             const output = [];
             const historyIgnore = Utils.getShell() === Shell.ZSH ? { HISTORY_IGNORE: '*' } : { HISTIGNORE: '*' };
@@ -65,6 +79,7 @@ export class SequentialPty {
                     process.stdout.write(data);
                 }
                 output.push(data.toString());
+                this.appendLog(data.toString());
             });
             const resizeListener = () => {
                 const { columns, rows } = process.stdout;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codifycli/plugin-core",
-  "version": "1.1.0-beta20",
+  "version": "1.1.0-beta21",
   "description": "TypeScript library for building Codify plugins to manage system resources (applications, CLI tools, settings) through infrastructure-as-code",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",

package/src/common/errors.ts

@@ -4,13 +4,15 @@ export class ApplyValidationError extends Error {
   resourceType: string;
   resourceName?: string;
   plan: Plan<any>;
+  logs: string[];
 
-  constructor(plan: Plan<any>) {
+  constructor(plan: Plan<any>, logs: string[] = []) {
     super(`Failed to apply changes to resource: "${plan.resourceId}". Additional changes are needed to complete apply.\nChanges remaining:\n${ApplyValidationError.prettyPrintPlan(plan)}`);
 
     this.resourceType = plan.coreParameters.type;
     this.resourceName = plan.coreParameters.name;
     this.plan = plan;
+    this.logs = logs;
   }
 
   private static prettyPrintPlan(plan: Plan<any>): string {

package/src/messages/handlers.ts

@@ -14,9 +14,9 @@ import {
   MatchRequestDataSchema,
   MatchResponseDataSchema,
   MessageStatus,
-  PluginErrorData,
   PlanRequestDataSchema,
   PlanResponseDataSchema,
+  PluginErrorData,
   ResourceSchema,
   SetVerbosityRequestDataSchema,
   ValidateRequestDataSchema,
@@ -174,7 +174,7 @@ export class MessageHandler {
       errorPayload = {
         errorType: 'apply_validation',
         message: e.message,
-        data: { plan: e.plan.toResponse() },
+        data: { plan: e.plan.toResponse(), logs: e.logs },
       };
     } else {
       const isDebug = process.env.DEBUG?.includes('*') ?? false;

package/src/plugin/plugin.ts

@@ -250,7 +250,11 @@ export class Plugin {
       throw new Error('Malformed plan with resource that cannot be found');
     }
 
-    await ptyLocalStorage.run(new SequentialPty(), async () => resource.apply(plan))
+    let applyLogs: string[] = [];
+    await ptyLocalStorage.run(new SequentialPty(), async () => {
+      await resource.apply(plan);
+      applyLogs = getPty().getLogs();
+    });
 
     // Validate using desired/desired. If the apply was successful, no changes should be reported back.
     // Default back desired back to current if it is not defined (for destroys only)
@@ -268,7 +272,7 @@ export class Plugin {
     })
 
     if (validationPlan.requiresChanges()) {
-      throw new ApplyValidationError(validationPlan);
+      throw new ApplyValidationError(validationPlan, applyLogs);
     }
   }
 

package/src/pty/background-pty.ts

@@ -148,6 +148,10 @@ export class BackgroundPty implements IPty {
     })
   }
 
+  getLogs(): string[] {
+    return [];
+  }
+
   private getDefaultShell(): string {
     return process.env.SHELL!;
   }

package/src/pty/index.ts

@@ -60,6 +60,8 @@ export interface IPty {
   spawnSafe(cmd: string | string[], options?: SpawnOptions): Promise<SpawnResult>
 
   kill(): Promise<{ exitCode: number, signal?: number | undefined }>
+
+  getLogs(): string[]
 }
 
 export function getPty(): IPty {

package/src/pty/seqeuntial-pty.ts

@@ -28,6 +28,21 @@ const validateSudoRequestResponse = ajv.compile(CommandRequestResponseDataSchema
  * without a tty (or even a stdin) attached so interactive commands will not work.
  */
 export class SequentialPty implements IPty {
+  private logBuffer: string[] = [];
+  private static readonly MAX_LOG_LINES = 100;
+
+  getLogs(): string[] {
+    return [...this.logBuffer];
+  }
+
+  private appendLog(data: string): void {
+    const lines = data.split('\n');
+    this.logBuffer.push(...lines);
+    if (this.logBuffer.length > SequentialPty.MAX_LOG_LINES) {
+      this.logBuffer = this.logBuffer.slice(-SequentialPty.MAX_LOG_LINES);
+    }
+  }
+
   async spawn(cmd: string | string[], options?: SpawnOptions): Promise<SpawnResult> {
     const spawnResult = await this.spawnSafe(cmd, options);
 
@@ -50,7 +65,9 @@ export class SequentialPty implements IPty {
       return this.externalSpawn(cmd, options);
     }
 
-    console.log(`Running command: ${Array.isArray(cmd) ? cmd.join('\\\n') : cmd}` + (options?.cwd ? `(${options?.cwd})` : ''))
+    const cmdLine = `Running command: ${Array.isArray(cmd) ? cmd.join('\\\n') : cmd}` + (options?.cwd ? `(${options?.cwd})` : '');
+    console.log(cmdLine);
+    this.appendLog(cmdLine);
 
     return new Promise((resolve) => {
       const output: string[] = [];
@@ -87,6 +104,7 @@ export class SequentialPty implements IPty {
         }
 
         output.push(data.toString());
+        this.appendLog(data.toString());
       })
 
       const resizeListener = () => {