@codifycli/plugin-core 1.1.0-beta9 → 1.2.1-beta.1

package/src/plan/change-set.test.ts

@@ -107,6 +107,7 @@ describe('Change set tests', () => {
 
     const parameterSettings = new ParsedResourceSettings({
       id: 'type',
+      operatingSystems: [],
       parameterSettings: {
         propA: { type: 'array' }
       }
@@ -129,6 +130,7 @@ describe('Change set tests', () => {
 
     const parameterSettings = new ParsedResourceSettings({
       id: 'type',
+      operatingSystems: [],
       parameterSettings: {
         propA: { type: 'array' }
       }
@@ -152,6 +154,7 @@ describe('Change set tests', () => {
 
     const parameterSettings = new ParsedResourceSettings({
       id: 'type',
+      operatingSystems: [],
       parameterSettings: {
         propA: { canModify: true }
       }
@@ -176,6 +179,7 @@ describe('Change set tests', () => {
 
     const parameterSettings = new ParsedResourceSettings({
       id: 'type',
+      operatingSystems: [],
       parameterSettings: {
         propA: { canModify: true },
         propB: { canModify: true }
@@ -196,6 +200,7 @@ describe('Change set tests', () => {
 
     const parameterSettings = new ParsedResourceSettings({
       id: 'type',
+      operatingSystems: [],
       parameterSettings: {
         propA: { type: 'array' }
       },
@@ -213,6 +218,7 @@ describe('Change set tests', () => {
 
     const parameterSettings = new ParsedResourceSettings({
       id: 'type',
+      operatingSystems: [],
       parameterSettings: {
         propA: { type: 'array' }
       },
@@ -229,6 +235,7 @@ describe('Change set tests', () => {
 
     const parameterSettings = new ParsedResourceSettings({
       id: 'type',
+      operatingSystems: [],
       parameterSettings: {
         propA: { type: 'array' }
       },
@@ -245,6 +252,7 @@ describe('Change set tests', () => {
 
     const parameterSettings = new ParsedResourceSettings({
       id: 'type',
+      operatingSystems: [],
       parameterSettings: {
         propA: {
           type: 'array',
@@ -259,12 +267,50 @@ describe('Change set tests', () => {
     expect(result.parameterChanges[0].operation).to.eq(ParameterOperation.MODIFY);
   })
 
+  it('excludes setting parameters from destroy change set', () => {
+    const settings = {
+      id: 'type',
+      operatingSystems: [],
+      parameterSettings: {
+        propA: {},
+        propB: { setting: true },
+      },
+    };
+
+    const cs = ChangeSet.destroy({ propA: 'val', propB: true }, settings as any);
+    expect(cs.parameterChanges.length).to.eq(1);
+    expect(cs.parameterChanges[0].name).to.eq('propA');
+    expect(cs.parameterChanges[0].operation).to.eq(ParameterOperation.REMOVE);
+    expect(cs.operation).to.eq(ResourceOperation.DESTROY);
+  })
+
+  it('excludes multiple setting parameters from destroy change set', () => {
+    const settings = {
+      id: 'type',
+      operatingSystems: [],
+      parameterSettings: {
+        skipAlreadyInstalledCasks: { type: 'boolean', default: true, setting: true },
+        onlyPlanUserInstalled: { type: 'boolean', default: true, setting: true },
+        directory: { type: 'directory' },
+      },
+    };
+
+    const cs = ChangeSet.destroy(
+      { skipAlreadyInstalledCasks: true, onlyPlanUserInstalled: true, directory: '/opt/homebrew' },
+      settings as any
+    );
+    expect(cs.parameterChanges.length).to.eq(1);
+    expect(cs.parameterChanges[0].name).to.eq('directory');
+    expect(cs.operation).to.eq(ResourceOperation.DESTROY);
+  })
+
   it('correctly determines array equality 5', () => {
     const arrA = [{ key1: 'b' }, { key1: 'a' }, { key1: 'a' }];
     const arrB = [{ key1: 'a' }, { key1: 'a' }, { key1: 'b' }];
 
     const parameterSettings = new ParsedResourceSettings({
       id: 'type',
+      operatingSystems: [],
       parameterSettings: {
         propA: {
           type: 'array',

package/src/plan/change-set.ts

@@ -94,6 +94,7 @@ export class ChangeSet<T extends StringIndexedObject> {
 
   static destroy<T extends StringIndexedObject>(current: Partial<T>, settings?: ResourceSettings<T>): ChangeSet<T> {
     const parameterChanges = Object.entries(current)
+      .filter(([k]) => !settings?.parameterSettings?.[k]?.setting)
       .map(([k, v]) => ({
         name: k,
         operation: ParameterOperation.REMOVE,
@@ -153,13 +154,13 @@ export class ChangeSet<T extends StringIndexedObject> {
   ): ParameterChange<T>[] {
     const parameterChangeSet = new Array<ParameterChange<T>>();
 
-    // Filter out null and undefined values or else the diff below will not work
+    // Filter out null, undefined, [], and {} — all treated as "no value"
     const desired = Object.fromEntries(
-      Object.entries(desiredParameters).filter(([, v]) => v !== null && v !== undefined)
+      Object.entries(desiredParameters).filter(([, v]) => !ChangeSet.isAbsent(v))
     ) as Partial<T>
 
     const current = Object.fromEntries(
-      Object.entries(currentParameters).filter(([, v]) => v !== null && v !== undefined)
+      Object.entries(currentParameters).filter(([, v]) => !ChangeSet.isAbsent(v))
     ) as Partial<T>
 
     for (const k of new Set([...Object.keys(current), ...Object.keys(desired)])) {
@@ -226,6 +227,13 @@ export class ChangeSet<T extends StringIndexedObject> {
     return orderOfOperations[Math.max(indexPrev, indexNext)];
   }
 
+  private static isAbsent(v: unknown): boolean {
+    if (v === null || v === undefined) return true;
+    if (Array.isArray(v)) return v.length === 0;
+    if (typeof v === 'object') return Object.keys(v as object).length === 0;
+    return false;
+  }
+
   private static isSame(
     desired: unknown,
     current: unknown,

package/src/plugin/plugin.ts

@@ -31,15 +31,22 @@ import { VerbosityLevel } from '../utils/verbosity-level.js';
 export class Plugin {
   planStorage: Map<string, Plan<any>>;
   planPty = new BackgroundPty();
+  minSupportedCliVersion: string | undefined;
 
   constructor(
     public name: string,
-    public resourceControllers: Map<string, ResourceController<ResourceConfig>>
+    public resourceControllers: Map<string, ResourceController<ResourceConfig>>,
+    options?: { minSupportedCliVersion?: string }
   ) {
     this.planStorage = new Map();
+    this.minSupportedCliVersion = options?.minSupportedCliVersion;
   }
 
-  static create(name: string, resources: Resource<any>[]) {
+  static create(
+    name: string,
+    resources: Resource<any>[],
+    options?: { minSupportedCliVersion?: string }
+  ) {
     const controllers = resources
       .map((resource) => new ResourceController(resource))
 
@@ -47,7 +54,7 @@ export class Plugin {
       controllers.map((r) => [r.typeId, r] as const)
     );
 
-    return new Plugin(name, controllersMap);
+    return new Plugin(name, controllersMap, options);
   }
 
   async initialize(data: InitializeRequestData): Promise<InitializeResponseData> {
@@ -60,6 +67,7 @@ export class Plugin {
     }
 
     return {
+      minSupportedCliVersion: this.minSupportedCliVersion,
       resourceDefinitions: [...this.resourceControllers.values()]
         .map((r) => {
           const sensitiveParameters = Object.entries(r.settings.parameterSettings ?? {})
@@ -174,9 +182,11 @@ export class Plugin {
         throw new Error(`Resource type not found: ${core.type}`);
       }
 
-      const validation = await this.resourceControllers
-        .get(core.type)!
-        .validate(core, parameters);
+      const validation = await ptyLocalStorage.run(this.planPty, () =>
+        this.resourceControllers
+          .get(core.type)!
+          .validate(core, parameters)
+      );
 
       validationResults.push(validation);
     }
@@ -240,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)
@@ -258,7 +272,7 @@ export class Plugin {
     })
 
     if (validationPlan.requiresChanges()) {
-      throw new ApplyValidationError(plan);
+      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

@@ -34,6 +34,7 @@ export interface SpawnOptions {
   env?: Record<string, unknown>;
   interactive?: boolean;
   requiresRoot?: boolean;
+  requiresSudoAskpass?: boolean;
   stdin?: boolean;
   disableWrapping?: boolean;
 }
@@ -43,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;
@@ -59,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 {

package/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;
@@ -46,11 +61,13 @@ export class SequentialPty implements IPty {
     }
 
     // If sudo is required, we must delegate to the main codify process.
-    if (options?.stdin || options?.requiresRoot) {
+    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: string[] = [];
@@ -87,6 +104,7 @@ export class SequentialPty implements IPty {
         }
 
         output.push(data.toString());
+        this.appendLog(data.toString());
       })
 
       const resizeListener = () => {

package/src/resource/parsed-resource-settings.ts

@@ -76,7 +76,7 @@ export class ParsedResourceSettings<T extends StringIndexedObject> implements Re
             if (ctx.path.length === 0) {
               ctx.jsonSchema.title = settings.id;
               ctx.jsonSchema.description = schema.description ?? settings.description ?? `${settings.id} resource. Can be used to manage ${settings.id}`;
-              ctx.jsonSchema.$comment = (schema.meta() as Record<string, string | undefined>).$comment;
+              ctx.jsonSchema.$comment = (schema.meta() as Record<string, string | undefined> | undefined)?.$comment;
             }
           }
         }) as JSONSchemaType<T>

package/src/utils/file-utils.ts

@@ -4,6 +4,8 @@ import path from 'node:path';
 import { Readable } from 'node:stream';
 import { finished } from 'node:stream/promises';
 
+import { ApplyNotes } from '../common/apply-notes.js';
+import { CodifyCliSender } from '../messages/sender.js';
 import { Utils } from './index.js';
 
 const SPACE_REGEX = /^\s*$/
@@ -33,6 +35,7 @@ export class FileUtils {
     );
 
     await fs.appendFile(Utils.getPrimaryShellRc(), lineToInsert)
+    await CodifyCliSender.sendApplyNote(ApplyNotes.sourceShellRc());
 
     function addLeadingSpacer(line: string): string {
       return line.startsWith('\n')
@@ -57,6 +60,7 @@ export class FileUtils {
 ${lines.join('\n')}`)
 
     await fs.appendFile(shellRc, formattedLines)
+    await CodifyCliSender.sendApplyNote(ApplyNotes.sourceShellRc());
   }
 
   /**
@@ -77,10 +81,11 @@ ${lines.join('\n')}`)
 
     if (prepend) {
       await fs.appendFile(shellRc, `\nexport PATH=$PATH:${value};`, { encoding: 'utf8' });
-      return;
+    } else {
+      await fs.appendFile(shellRc, `\nexport PATH=${value}:$PATH;`, { encoding: 'utf8' });
     }
 
-    await fs.appendFile(shellRc, `\nexport PATH=${value}:$PATH;`, { encoding: 'utf8' });
+    await CodifyCliSender.sendApplyNote(ApplyNotes.sourceShellRc());
   }
 
   static async removeFromFile(filePath: string, search: string): Promise<void> {

package/src/utils/functions.ts

@@ -10,10 +10,11 @@ export function splitUserConfig<T extends StringIndexedObject>(
     ...(config.name ? { name: config.name } : {}),
     ...(config.dependsOn ? { dependsOn: config.dependsOn } : {}),
     ...(config.os ? { os: config.os } : {}),
+    ...(config.distro ? { distro: config.distro } : {})
   };
 
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  const { type, name, dependsOn, os, ...parameters } = config;
+  const { type, name, dependsOn, os, distro, ...parameters } = config;
 
   return {
     parameters: parameters as T,
@@ -42,7 +43,7 @@ export function resolvePathWithVariables(pathWithVariables: string) {
 export function addVariablesToPath(pathWithoutVariables: string) {
   let result = pathWithoutVariables;
   for (const [key, value] of Object.entries(process.env)) {
-    if (!value || !path.isAbsolute(value) || value === '/' || key === 'HOME' || key === 'PATH' || key === 'SHELL' || key === 'PWD') {
+    if (!value || !path.isAbsolute(value) || value === '/' || value === homeDirectory || key === 'HOME' || key === 'PATH' || key === 'SHELL' || key === 'PWD') {
       continue;
     }
 

package/src/utils/index.ts

@@ -225,7 +225,24 @@ Brew can be installed using Codify:
         }
 
         if (status === SpawnStatus.ERROR) {
-          throw new Error(`Failed to install package ${packageName} via apt: ${data}`);
+          // Attempt to fix broken dependencies then retry
+          const fixResult = await $.spawnSafe('apt-get install -f -y -o Dpkg::Use-Pty=0 -o Dpkg::Progress-Fancy=0', {
+            requiresRoot: true,
+            env: { DEBIAN_FRONTEND: 'noninteractive', NEEDRESTART_MODE: 'a' }
+          });
+
+          if (fixResult.status === SpawnStatus.ERROR) {
+            throw new Error(`Failed to install package ${packageName} via apt: ${data}`);
+          }
+
+          const retryResult = await $.spawnSafe(`apt-get -y -qq install -o Dpkg::Use-Pty=0 -o Dpkg::Progress-Fancy=0 ${packageName}`, {
+            requiresRoot: true,
+            env: { DEBIAN_FRONTEND: 'noninteractive', NEEDRESTART_MODE: 'a' }
+          });
+
+          if (retryResult.status === SpawnStatus.ERROR) {
+            throw new Error(`Failed to install package ${packageName} via apt after fixing dependencies: ${retryResult.data}`);
+          }
         }
       }
 

package/src/utils/internal-utils.test.ts

@@ -9,6 +9,7 @@ describe('Utils tests', () => {
       name: 'name',
       dependsOn: ['a', 'b', 'c'],
       os: ['linux'],
+      distro: ['debian-based'],
       propA: 'propA',
       propB: 'propB',
       propC: 'propC',

package/.claude/settings.local.json

@@ -1,5 +0,0 @@
-{
-  "disabledMcpjsonServers": [
-    "supabase"
-  ]
-}

package/dist/bin/build.d.ts

@@ -1 +0,0 @@
-export declare function build(): Promise<void>;

package/dist/bin/build.js

@@ -1,80 +0,0 @@
-import { Ajv } from 'ajv';
-import { IpcMessageSchema, MessageStatus, ResourceSchema } from 'codify-schemas';
-// @ts-ignore
-import mergeJsonSchemas from 'merge-json-schemas';
-import { fork } from 'node:child_process';
-import fs from 'node:fs/promises';
-import path from 'node:path';
-import * as url from 'node:url';
-import { codifySpawn } from '../utils/codify-spawn.js';
-const ajv = new Ajv({
-    strict: true
-});
-const ipcMessageValidator = ajv.compile(IpcMessageSchema);
-function sendMessageAndAwaitResponse(process, message) {
-    return new Promise((resolve, reject) => {
-        process.on('message', (response) => {
-            if (!ipcMessageValidator(response)) {
-                throw new Error(`Invalid message from plugin. ${JSON.stringify(message, null, 2)}`);
-            }
-            // Wait for the message response. Other messages such as sudoRequest may be sent before the response returns
-            if (response.cmd === message.cmd + '_Response') {
-                if (response.status === MessageStatus.SUCCESS) {
-                    resolve(response.data);
-                }
-                else {
-                    reject(new Error(String(response.data)));
-                }
-            }
-        });
-        // Send message last to ensure listeners are all registered
-        process.send(message);
-    });
-}
-export async function build() {
-    await fs.rm('./dist', { force: true, recursive: true });
-    await codifySpawn('npm run rollup -- -f es');
-    const plugin = fork('./dist/index.js', [], {
-        // Use default true to test plugins in secure mode (un-able to request sudo directly)
-        detached: true,
-        env: { ...process.env },
-        execArgv: ['--import', 'tsx/esm'],
-    });
-    const initializeResult = await sendMessageAndAwaitResponse(plugin, {
-        cmd: 'initialize',
-        data: {}
-    });
-    const { resourceDefinitions } = initializeResult;
-    const resourceTypes = resourceDefinitions.map((i) => i.type);
-    const schemasMap = new Map();
-    for (const type of resourceTypes) {
-        const resourceInfo = await sendMessageAndAwaitResponse(plugin, {
-            cmd: 'getResourceInfo',
-            data: { type }
-        });
-        schemasMap.set(type, resourceInfo.schema);
-    }
-    const mergedSchemas = [...schemasMap.entries()].map(([type, schema]) => {
-        // const resolvedSchema = await $RefParser.dereference(schema)
-        const resourceSchema = JSON.parse(JSON.stringify(ResourceSchema));
-        delete resourceSchema.$id;
-        delete resourceSchema.$schema;
-        delete resourceSchema.title;
-        delete resourceSchema.oneOf;
-        delete resourceSchema.properties.type;
-        if (schema) {
-            delete schema.$id;
-            delete schema.$schema;
-            delete schema.title;
-            delete schema.oneOf;
-        }
-        return mergeJsonSchemas([schema ?? {}, resourceSchema, { properties: { type: { const: type, type: 'string' } } }]);
-    });
-    await fs.rm('./dist', { force: true, recursive: true });
-    await codifySpawn('npm run rollup'); // re-run rollup without building for es
-    console.log('Generated JSON Schemas for all resources');
-    const distFolder = path.resolve(path.dirname(url.fileURLToPath(import.meta.url)), '..', 'dist');
-    const schemaOutputPath = path.resolve(distFolder, 'schemas.json');
-    await fs.writeFile(schemaOutputPath, JSON.stringify(mergedSchemas, null, 2));
-    console.log('Successfully wrote schema to ./dist/schemas.json');
-}

package/dist/bin/deploy-plugin.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};

package/dist/bin/deploy-plugin.js

@@ -1,8 +0,0 @@
-#!/usr/bin/env node
-import path from 'node:path';
-import * as fs from 'node:fs';
-import { build } from './build.js';
-const packageJson = fs.readFileSync(path.join(process.env['npm_config_local_prefix'], 'package.json'), 'utf8');
-const { name: libraryName, version: libraryVersion } = JSON.parse(packageJson);
-console.log(libraryName, libraryVersion);
-await build();

package/dist/entities/change-set.d.ts

@@ -1,24 +0,0 @@
-import { ParameterOperation, ResourceOperation, StringIndexedObject } from 'codify-schemas';
-import { ParameterOptions } from './plan-types.js';
-export interface ParameterChange<T extends StringIndexedObject> {
-    name: keyof T & string;
-    operation: ParameterOperation;
-    previousValue: any | null;
-    newValue: any | null;
-}
-export declare class ChangeSet<T extends StringIndexedObject> {
-    operation: ResourceOperation;
-    parameterChanges: Array<ParameterChange<T>>;
-    constructor(operation: ResourceOperation, parameterChanges: Array<ParameterChange<T>>);
-    get desiredParameters(): T;
-    get currentParameters(): T;
-    static calculateParameterChangeSet<T extends StringIndexedObject>(desired: T | null, current: T | null, options: {
-        statefulMode: boolean;
-        parameterOptions?: Record<keyof T, ParameterOptions>;
-    }): ParameterChange<T>[];
-    static combineResourceOperations(prev: ResourceOperation, next: ResourceOperation): ResourceOperation;
-    static isSame(desired: unknown, current: unknown, options?: ParameterOptions): boolean;
-    private static calculateStatefulModeChangeSet;
-    private static calculateStatelessModeChangeSet;
-    private static addDefaultValues;
-}