feat: Added log buffer and get logs

Author: kevinwang5658

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codifycli/plugin-core",
-  "version": "1.1.0-beta20",
+  "version": "1.1.0-beta23",
   "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",

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 {

src/messages/handlers.ts

@@ -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;

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);
     }
   }
 

src/pty/background-pty.ts

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

src/pty/index.ts

@@ -44,8 +44,11 @@ export class SpawnError extends Error {
   cmd: string;
   exitCode: number;
 
-  constructor(cmd: string, exitCode: number, data: string) {
-    super(`Spawn Error: on command "${cmd}" with exit code: ${exitCode}\nOutput:\n${data}`);
+  constructor(cmd: string, exitCode: number, data: string, logs?: string[]) {
+    const logSection = logs?.length
+      ? `\nLast logs:\n${logs.join('\n')}`
+      : '';
+    super(`Spawn Error: on command "${cmd}" with exit code: ${exitCode}\nOutput:\n${data}${logSection}`);
 
     this.data = data;
     this.cmd = cmd;
@@ -60,6 +63,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 {

src/pty/seqeuntial-pty.ts

@@ -28,11 +28,26 @@ 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 = 30;
+
+  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);
 
     if (spawnResult.status !== 'success') {
-      throw new SpawnError(Array.isArray(cmd) ? cmd.join('\n') : cmd, spawnResult.exitCode, spawnResult.data);
+      throw new SpawnError(Array.isArray(cmd) ? cmd.join('\n') : cmd, spawnResult.exitCode, spawnResult.data, this.logBuffer);
     }
 
     return spawnResult;
@@ -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 = () => {