codify-plugin-lib 1.0.114 → 1.0.115

package/dist/common/errors.d.ts

@@ -0,0 +1,8 @@
+import { Plan } from '../plan/plan.js';
+export declare class ApplyValidationError extends Error {
+    resourceType: string;
+    resourceName?: string;
+    plan: Plan<any>;
+    constructor(plan: Plan<any>);
+    private static prettyPrintPlan;
+}

package/dist/common/errors.js

@@ -0,0 +1,24 @@
+export class ApplyValidationError extends Error {
+    resourceType;
+    resourceName;
+    plan;
+    constructor(plan) {
+        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;
+    }
+    static prettyPrintPlan(plan) {
+        const { operation, parameters } = plan.toResponse();
+        const prettyParameters = parameters.map(({ name, operation, previousValue, newValue }) => ({
+            name,
+            operation,
+            currentValue: previousValue,
+            desiredValue: newValue,
+        }));
+        return JSON.stringify({
+            operation,
+            parameters: prettyParameters,
+        }, null, 2);
+    }
+}

package/dist/plan/plan.d.ts

@@ -8,9 +8,16 @@ import { ChangeSet } from './change-set.js';
  */
 export declare class Plan<T extends StringIndexedObject> {
     id: string;
+    /**
+     * List of changes to make
+     */
     changeSet: ChangeSet<T>;
+    /**
+     * Ex: name, type, dependsOn etc. Metadata parameters
+     */
     coreParameters: ResourceConfig;
-    constructor(id: string, changeSet: ChangeSet<T>, resourceMetadata: ResourceConfig);
+    statefulMode: boolean;
+    constructor(id: string, changeSet: ChangeSet<T>, resourceMetadata: ResourceConfig, statefulMode: boolean);
     /**
      * The desired config that a plan will achieve after executing all the actions.
      */
@@ -19,6 +26,8 @@ export declare class Plan<T extends StringIndexedObject> {
      * The current config that the plan is changing.
      */
     get currentConfig(): T | null;
+    get resourceId(): string;
+    requiresChanges(): boolean;
     /**
      * When multiples of the same resource are allowed, this matching function will match a given config with one of the
      * existing configs on the system. For example if there are multiple versions of Android Studios installed, we can use

package/dist/plan/plan.js

@@ -8,12 +8,20 @@ import { ChangeSet } from './change-set.js';
  */
 export class Plan {
     id;
+    /**
+     * List of changes to make
+     */
     changeSet;
+    /**
+     * Ex: name, type, dependsOn etc. Metadata parameters
+     */
     coreParameters;
-    constructor(id, changeSet, resourceMetadata) {
+    statefulMode;
+    constructor(id, changeSet, resourceMetadata, statefulMode) {
         this.id = id;
         this.changeSet = changeSet;
         this.coreParameters = resourceMetadata;
+        this.statefulMode = statefulMode;
     }
     /**
      * The desired config that a plan will achieve after executing all the actions.
@@ -39,6 +47,14 @@ export class Plan {
             ...this.changeSet.currentParameters,
         };
     }
+    get resourceId() {
+        return this.coreParameters.name
+            ? `${this.coreParameters.type}.${this.coreParameters.name}`
+            : this.coreParameters.type;
+    }
+    requiresChanges() {
+        return this.changeSet.operation !== ResourceOperation.NOOP;
+    }
     /**
      * When multiples of the same resource are allowed, this matching function will match a given config with one of the
      * existing configs on the system. For example if there are multiple versions of Android Studios installed, we can use
@@ -88,19 +104,19 @@ export class Plan {
         });
         // Empty
         if (!filteredCurrentParameters && !desiredParameters) {
-            return new Plan(uuidV4(), ChangeSet.empty(), coreParameters);
+            return new Plan(uuidV4(), ChangeSet.empty(), coreParameters, statefulMode);
         }
         // CREATE
         if (!filteredCurrentParameters && desiredParameters) {
-            return new Plan(uuidV4(), ChangeSet.create(desiredParameters), coreParameters);
+            return new Plan(uuidV4(), ChangeSet.create(desiredParameters), coreParameters, statefulMode);
         }
         // DESTROY
         if (filteredCurrentParameters && !desiredParameters) {
-            return new Plan(uuidV4(), ChangeSet.destroy(filteredCurrentParameters), coreParameters);
+            return new Plan(uuidV4(), ChangeSet.destroy(filteredCurrentParameters), coreParameters, statefulMode);
         }
         // NO-OP, MODIFY or RE-CREATE
         const changeSet = ChangeSet.calculateModification(desiredParameters, filteredCurrentParameters, settings.parameterSettings);
-        return new Plan(uuidV4(), changeSet, coreParameters);
+        return new Plan(uuidV4(), changeSet, coreParameters, statefulMode);
     }
     /**
      *  Only keep relevant params for the plan. We don't want to change settings that were not already
@@ -208,7 +224,7 @@ export class Plan {
         return new Plan(uuidV4(), new ChangeSet(data.operation, data.parameters), {
             type: data.resourceType,
             name: data.resourceName,
-        });
+        }, data.statefulMode);
         function addDefaultValues() {
             Object.entries(defaultValues ?? {})
                 .forEach(([key, defaultValue]) => {

package/dist/plugin/plugin.d.ts

@@ -1,8 +1,8 @@
 import { ApplyRequestData, GetResourceInfoRequestData, GetResourceInfoResponseData, ImportRequestData, ImportResponseData, InitializeResponseData, PlanRequestData, PlanResponseData, ResourceConfig, ValidateRequestData, ValidateResponseData } from 'codify-schemas';
 import { Plan } from '../plan/plan.js';
+import { BackgroundPty } from '../pty/background-pty.js';
 import { Resource } from '../resource/resource.js';
 import { ResourceController } from '../resource/resource-controller.js';
-import { BackgroundPty } from '../pty/background-pty.js';
 export declare class Plugin {
     name: string;
     resourceControllers: Map<string, ResourceController<ResourceConfig>>;

package/dist/plugin/plugin.js

@@ -1,7 +1,8 @@
+import { ApplyValidationError } from '../common/errors.js';
 import { Plan } from '../plan/plan.js';
+import { BackgroundPty } from '../pty/background-pty.js';
 import { ResourceController } from '../resource/resource-controller.js';
 import { ptyLocalStorage } from '../utils/pty-local-storage.js';
-import { BackgroundPty } from '../pty/background-pty.js';
 export class Plugin {
     name;
     resourceControllers;
@@ -82,9 +83,7 @@ export class Plugin {
         if (!type || !this.resourceControllers.has(type)) {
             throw new Error(`Resource type not found: ${type}`);
         }
-        const plan = await ptyLocalStorage.run(this.planPty, async () => {
-            return this.resourceControllers.get(type).plan(data.desired ?? null, data.state ?? null, data.isStateful);
-        });
+        const plan = await ptyLocalStorage.run(this.planPty, async () => this.resourceControllers.get(type).plan(data.desired ?? null, data.state ?? null, data.isStateful));
         this.planStorage.set(plan.id, plan);
         return plan.toResponse();
     }
@@ -98,6 +97,10 @@ export class Plugin {
             throw new Error('Malformed plan with resource that cannot be found');
         }
         await resource.apply(plan);
+        const validationPlan = await ptyLocalStorage.run(new BackgroundPty(), async () => resource.plan(plan.desiredConfig, plan.currentConfig, plan.statefulMode));
+        if (validationPlan.requiresChanges()) {
+            throw new ApplyValidationError(plan);
+        }
     }
     resolvePlan(data) {
         const { plan: planRequest, planId } = data;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-plugin-lib",
-  "version": "1.0.114",
+  "version": "1.0.115",
   "description": "Library plugin library",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -14,7 +14,7 @@
   "dependencies": {
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
-    "codify-schemas": "1.0.53",
+    "codify-schemas": "1.0.54",
     "@npmcli/promise-spawn": "^7.0.1",
     "uuid": "^10.0.0",
     "lodash.isequal": "^4.5.0",

package/src/common/errors.test.ts

@@ -0,0 +1,44 @@
+import { describe, expect, it } from 'vitest';
+import { ApplyValidationError } from './errors.js';
+import { Plan } from '../plan/plan.js';
+import { testPlan } from '../utils/test-utils.test.js';
+
+describe('Test file for errors file', () => {
+  it('Can properly format ApplyValidationError', () => {
+    const plan = testPlan({
+      desired: null,
+      current: [{ propZ: ['a', 'b', 'c'] }],
+      state: { propZ: ['a', 'b', 'c'] },
+      core: {
+        type: 'homebrew',
+        name: 'first'
+      },
+      statefulMode: true,
+    })
+
+    try {
+      throw new ApplyValidationError(plan);
+    } catch (e) {
+      console.error(e);
+      expect(e.message).toMatch(
+`Failed to apply changes to resource: "homebrew.first". Additional changes are needed to complete apply.
+Changes remaining:
+{
+  "operation": "destroy",
+  "parameters": [
+    {
+      "name": "propZ",
+      "operation": "remove",
+      "currentValue": [
+        "a",
+        "b",
+        "c"
+      ],
+      "desiredValue": null
+    }
+  ]
+}`
+      )
+    }
+  })
+})

package/src/common/errors.ts

@@ -0,0 +1,31 @@
+import { Plan } from '../plan/plan.js';
+
+export class ApplyValidationError extends Error {
+  resourceType: string;
+  resourceName?: string;
+  plan: Plan<any>;
+
+  constructor(plan: Plan<any>) {
+    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;
+  }
+
+  private static prettyPrintPlan(plan: Plan<any>): string {
+    const { operation, parameters } = plan.toResponse();
+
+    const prettyParameters = parameters.map(({ name, operation, previousValue, newValue}) => ({
+      name,
+      operation,
+      currentValue: previousValue,
+      desiredValue: newValue,
+    }));
+
+    return JSON.stringify({
+      operation,
+      parameters: prettyParameters,
+    }, null, 2);
+  }
+}

package/src/plan/plan.test.ts

@@ -19,7 +19,8 @@ describe('Plan entity tests', () => {
         operation: ParameterOperation.ADD,
         previousValue: null,
         newValue: 'propBValue'
-      }]
+      }],
+      statefulMode: false,
     }, controller.parsedSettings.defaultValues);
 
     expect(plan.currentConfig).to.be.null;
@@ -47,7 +48,8 @@ describe('Plan entity tests', () => {
         operation: ParameterOperation.REMOVE,
         previousValue: 'propBValue',
         newValue: null,
-      }]
+      }],
+      statefulMode: false,
     }, controller.parsedSettings.defaultValues);
 
     expect(plan.currentConfig).toMatchObject({
@@ -75,7 +77,8 @@ describe('Plan entity tests', () => {
         operation: ParameterOperation.NOOP,
         previousValue: 'propBValue',
         newValue: 'propBValue',
-      }]
+      }],
+      statefulMode: false,
     }, controller.parsedSettings.defaultValues);
 
     expect(plan.currentConfig).toMatchObject({
@@ -112,7 +115,8 @@ describe('Plan entity tests', () => {
         operation: ParameterOperation.ADD,
         previousValue: null,
         newValue: 'propAValue',
-      }]
+      }],
+      statefulMode: false,
     }, controller.parsedSettings.defaultValues);
 
     expect(plan.currentConfig).to.be.null

package/src/plan/plan.ts

@@ -23,13 +23,24 @@ import { ChangeSet } from './change-set.js';
  */
 export class Plan<T extends StringIndexedObject> {
   id: string;
+
+  /**
+   * List of changes to make
+   */
   changeSet: ChangeSet<T>;
-  coreParameters: ResourceConfig
 
-  constructor(id: string, changeSet: ChangeSet<T>, resourceMetadata: ResourceConfig) {
+  /**
+   * Ex: name, type, dependsOn etc. Metadata parameters
+   */
+  coreParameters: ResourceConfig;
+
+  statefulMode: boolean;
+
+  constructor(id: string, changeSet: ChangeSet<T>, resourceMetadata: ResourceConfig, statefulMode: boolean) {
     this.id = id;
     this.changeSet = changeSet;
     this.coreParameters = resourceMetadata;
+    this.statefulMode = statefulMode;
   }
 
   /**
@@ -59,6 +70,16 @@ export class Plan<T extends StringIndexedObject> {
       ...this.changeSet.currentParameters,
     }
   }
+  
+  get resourceId(): string {
+    return this.coreParameters.name
+      ? `${this.coreParameters.type}.${this.coreParameters.name}`
+      : this.coreParameters.type;
+  }
+  
+  requiresChanges(): boolean {
+    return this.changeSet.operation !== ResourceOperation.NOOP;
+  }
 
   /**
    * When multiples of the same resource are allowed, this matching function will match a given config with one of the
@@ -148,6 +169,7 @@ export class Plan<T extends StringIndexedObject> {
         uuidV4(),
         ChangeSet.empty<T>(),
         coreParameters,
+        statefulMode,
       )
     }
 
@@ -156,7 +178,8 @@ export class Plan<T extends StringIndexedObject> {
       return new Plan(
         uuidV4(),
         ChangeSet.create(desiredParameters),
-        coreParameters
+        coreParameters,
+        statefulMode,
       )
     }
 
@@ -165,7 +188,8 @@ export class Plan<T extends StringIndexedObject> {
       return new Plan(
         uuidV4(),
         ChangeSet.destroy(filteredCurrentParameters),
-        coreParameters
+        coreParameters,
+        statefulMode,
       )
     }
 
@@ -180,6 +204,7 @@ export class Plan<T extends StringIndexedObject> {
       uuidV4(),
       changeSet,
       coreParameters,
+      statefulMode,
     );
   }
 
@@ -340,6 +365,7 @@ export class Plan<T extends StringIndexedObject> {
         type: data.resourceType,
         name: data.resourceName,
       },
+      data.statefulMode
     );
 
    function addDefaultValues(): void {

package/src/plugin/plugin.test.ts

@@ -1,10 +1,14 @@
 import { describe, expect, it } from 'vitest';
 import { Plugin } from './plugin.js';
-import { ParameterOperation, ResourceOperation, StringIndexedObject } from 'codify-schemas';
+import { ApplyRequestData, ParameterOperation, ResourceOperation, StringIndexedObject } from 'codify-schemas';
 import { Resource } from '../resource/resource.js';
 import { Plan } from '../plan/plan.js';
 import { spy } from 'sinon';
 import { ResourceSettings } from '../resource/resource-settings.js';
+import { TestConfig } from '../utils/test-utils.test.js';
+import { ApplyValidationError } from '../common/errors.js';
+import { ResourceController } from '../resource/resource-controller.js';
+import { getPty } from '../pty/index.js';
 
 interface TestConfig extends StringIndexedObject {
   propA: string;
@@ -38,15 +42,22 @@ class TestResource extends Resource<TestConfig> {
 
 describe('Plugin tests', () => {
   it('Can apply resource', async () => {
-    const resource= spy(new TestResource())
+    const resource= spy(new class extends TestResource {
+      async refresh(): Promise<Partial<TestConfig> | null> {
+        return {
+          propA: 'abc',
+        }
+      }
+    })
     const plugin = Plugin.create('testPlugin', [resource as any])
 
-    const plan = {
+    const plan: ApplyRequestData['plan'] = {
       operation: ResourceOperation.CREATE,
       resourceType: 'testResource',
       parameters: [
         { name: 'propA', operation: ParameterOperation.ADD, newValue: 'abc', previousValue: null },
-      ]
+      ],
+      statefulMode: false,
     };
 
     await plugin.apply({ plan });
@@ -54,15 +65,20 @@ describe('Plugin tests', () => {
   });
 
   it('Can destroy resource', async () => {
-    const resource = spy(new TestResource());
+    const resource = spy(new class extends TestResource {
+      async refresh(): Promise<Partial<TestConfig> | null> {
+        return null;
+      }
+    });
     const testPlugin = Plugin.create('testPlugin', [resource as any])
 
-    const plan = {
+    const plan: ApplyRequestData['plan'] = {
       operation: ResourceOperation.DESTROY,
       resourceType: 'testResource',
       parameters: [
         { name: 'propA', operation: ParameterOperation.REMOVE, newValue: null, previousValue: 'abc' },
-      ]
+      ],
+      statefulMode: true,
     };
 
     await testPlugin.apply({ plan })
@@ -70,15 +86,22 @@ describe('Plugin tests', () => {
   });
 
   it('Can re-create resource', async () => {
-    const resource = spy(new TestResource())
+    const resource = spy(new class extends TestResource {
+      async refresh(): Promise<Partial<TestConfig> | null> {
+        return {
+          propA: 'def',
+        }
+      }
+    })
     const testPlugin = Plugin.create('testPlugin', [resource as any])
 
-    const plan = {
+    const plan: ApplyRequestData['plan'] = {
       operation: ResourceOperation.RECREATE,
       resourceType: 'testResource',
       parameters: [
         { name: 'propA', operation: ParameterOperation.MODIFY, newValue: 'def', previousValue: 'abc' },
-      ]
+      ],
+      statefulMode: false,
     };
 
     await testPlugin.apply({ plan })
@@ -87,15 +110,22 @@ describe('Plugin tests', () => {
   });
 
   it('Can modify resource', async () => {
-    const resource = spy(new TestResource())
+    const resource = spy(new class extends TestResource {
+      async refresh(): Promise<Partial<TestConfig> | null> {
+        return {
+          propA: 'def',
+        }
+      }
+    })
     const testPlugin = Plugin.create('testPlugin', [resource as any])
 
-    const plan = {
+    const plan: ApplyRequestData['plan'] = {
       operation: ResourceOperation.MODIFY,
       resourceType: 'testResource',
       parameters: [
         { name: 'propA', operation: ParameterOperation.MODIFY, newValue: 'def', previousValue: 'abc' },
-      ]
+      ],
+      statefulMode: false,
     };
 
     await testPlugin.apply({ plan })
@@ -178,4 +208,78 @@ describe('Plugin tests', () => {
       requiredParameters: []
     })
   })
+
+  it('Fails an apply if the validation fails', async () => {
+    const resource = spy(new class extends TestResource {
+      async refresh(): Promise<Partial<TestConfig> | null> {
+        return {
+          propA: 'abc',
+        }
+      }
+    })
+    const testPlugin = Plugin.create('testPlugin', [resource as any])
+
+    const plan: ApplyRequestData['plan'] = {
+      operation: ResourceOperation.MODIFY,
+      resourceType: 'testResource',
+      parameters: [
+        { name: 'propA', operation: ParameterOperation.MODIFY, newValue: 'def', previousValue: 'abc' },
+      ],
+      statefulMode: false,
+    };
+
+    await expect(() => testPlugin.apply({ plan }))
+      .rejects
+      .toThrowError(new ApplyValidationError(Plan.fromResponse(plan)));
+    expect(resource.modify.calledOnce).to.be.true;
+  })
+
+  it('Allows the usage of pty in refresh (plan)', async () => {
+    const resource = spy(new class extends TestResource {
+      async refresh(): Promise<Partial<TestConfig> | null> {
+        expect(getPty()).to.not.be.undefined;
+        expect(getPty()).to.not.be.null;
+
+        return null;
+      }
+    })
+
+    const testPlugin = Plugin.create('testPlugin', [resource as any]);
+    await testPlugin.plan({
+      desired: {
+        type: 'testResource'
+      },
+      state: undefined,
+      isStateful: false,
+    })
+
+    expect(resource.refresh.calledOnce).to.be.true;
+  });
+
+  it('Allows the usage of pty in validation refresh (apply)', async () => {
+    const resource = spy(new class extends TestResource {
+      async refresh(): Promise<Partial<TestConfig> | null> {
+        expect(getPty()).to.not.be.undefined;
+        expect(getPty()).to.not.be.null;
+
+        return {
+          propA: 'abc'
+        };
+      }
+    })
+
+    const testPlugin = Plugin.create('testPlugin', [resource as any]);
+
+    const plan: ApplyRequestData['plan'] = {
+      operation: ResourceOperation.CREATE,
+      resourceType: 'testResource',
+      parameters: [
+        { name: 'propA', operation: ParameterOperation.ADD, newValue: 'abc', previousValue: null },
+      ],
+      statefulMode: false,
+    };
+
+    await testPlugin.apply({ plan })
+    expect(resource.refresh.calledOnce).to.be.true;
+  })
 });

package/src/plugin/plugin.ts

@@ -13,11 +13,12 @@ import {
   ValidateResponseData
 } from 'codify-schemas';
 
+import { ApplyValidationError } from '../common/errors.js';
 import { Plan } from '../plan/plan.js';
+import { BackgroundPty } from '../pty/background-pty.js';
 import { Resource } from '../resource/resource.js';
 import { ResourceController } from '../resource/resource-controller.js';
 import { ptyLocalStorage } from '../utils/pty-local-storage.js';
-import { BackgroundPty } from '../pty/background-pty.js';
 
 export class Plugin {
   planStorage: Map<string, Plan<any>>;
@@ -122,13 +123,11 @@ export class Plugin {
       throw new Error(`Resource type not found: ${type}`);
     }
 
-    const plan = await ptyLocalStorage.run(this.planPty, async () => {
-      return this.resourceControllers.get(type)!.plan(
+    const plan = await ptyLocalStorage.run(this.planPty, async () => this.resourceControllers.get(type)!.plan(
         data.desired ?? null,
         data.state ?? null,
         data.isStateful
-      );
-    })
+      ))
 
     this.planStorage.set(plan.id, plan);
 
@@ -148,6 +147,16 @@ export class Plugin {
     }
 
     await resource.apply(plan);
+
+    const validationPlan = await ptyLocalStorage.run(new BackgroundPty(), async () => resource.plan(
+      plan.desiredConfig,
+      plan.currentConfig,
+      plan.statefulMode
+    ))
+    
+    if (validationPlan.requiresChanges()) {
+      throw new ApplyValidationError(plan);
+    }
   }
 
   private resolvePlan(data: ApplyRequestData): Plan<ResourceConfig> {

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

@@ -499,7 +499,8 @@ describe('Resource parameter tests', () => {
           { name: 'propA', operation: ParameterOperation.ADD, previousValue: null, newValue: null },
           { name: 'propB', operation: ParameterOperation.ADD, previousValue: null, newValue: null },
           { name: 'propC', operation: ParameterOperation.ADD, previousValue: null, newValue: null },
-        ]
+        ],
+        statefulMode: false,
       }, {}) as any
     );
 
@@ -521,7 +522,8 @@ describe('Resource parameter tests', () => {
           { name: 'propA', operation: ParameterOperation.MODIFY, previousValue: null, newValue: null },
           { name: 'propB', operation: ParameterOperation.MODIFY, previousValue: null, newValue: null },
           { name: 'propC', operation: ParameterOperation.MODIFY, previousValue: null, newValue: null },
-        ]
+        ],
+        statefulMode: false,
       }, {}) as any
     );
 
@@ -539,7 +541,8 @@ describe('Resource parameter tests', () => {
           { name: 'propA', operation: ParameterOperation.REMOVE, previousValue: null, newValue: null },
           { name: 'propB', operation: ParameterOperation.REMOVE, previousValue: null, newValue: null },
           { name: 'propC', operation: ParameterOperation.REMOVE, previousValue: null, newValue: null },
-        ]
+        ],
+        statefulMode: false,
       }, {}) as any
     );
 

package/vitest.config.ts

@@ -2,6 +2,7 @@ import { defaultExclude, defineConfig } from 'vitest/config';
 
 export default defineConfig({
   test: {
+    pool: 'forks',
     exclude: [
       ...defaultExclude,
       './src/utils/test-utils.test.ts',