codify-plugin-lib 1.0.115 → 1.0.116

package/dist/index.js

@@ -13,4 +13,7 @@ export * from './utils/utils.js';
 export async function runPlugin(plugin) {
     const messageHandler = new MessageHandler(plugin);
     process.on('message', (message) => messageHandler.onMessage(message));
+    process.on('beforeExit', () => {
+        plugin.kill();
+    });
 }

package/dist/plan/plan.d.ts

@@ -27,7 +27,14 @@ export declare class Plan<T extends StringIndexedObject> {
      */
     get currentConfig(): T | null;
     get resourceId(): string;
-    requiresChanges(): boolean;
+    static calculate<T extends StringIndexedObject>(params: {
+        desiredParameters: Partial<T> | null;
+        currentParametersArray: Partial<T>[] | null;
+        stateParameters: Partial<T> | null;
+        coreParameters: ResourceConfig;
+        settings: ParsedResourceSettings<T>;
+        statefulMode: boolean;
+    }): Plan<T>;
     /**
      * 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
@@ -43,14 +50,7 @@ export declare class Plan<T extends StringIndexedObject> {
      * @return string
      */
     getResourceType(): string;
-    static calculate<T extends StringIndexedObject>(params: {
-        desiredParameters: Partial<T> | null;
-        currentParametersArray: Partial<T>[] | null;
-        stateParameters: Partial<T> | null;
-        coreParameters: ResourceConfig;
-        settings: ParsedResourceSettings<T>;
-        statefulMode: boolean;
-    }): Plan<T>;
+    static fromResponse<T extends ResourceConfig>(data: ApplyRequestData['plan'], defaultValues?: Partial<Record<keyof T, unknown>>): Plan<T>;
     /**
      *  Only keep relevant params for the plan. We don't want to change settings that were not already
      *  defined.
@@ -60,7 +60,7 @@ export declare class Plan<T extends StringIndexedObject> {
      *  or wants to set. If a parameter is not specified then it's not managed by Codify.
      */
     private static filterCurrentParams;
-    static fromResponse<T extends ResourceConfig>(data: ApplyRequestData['plan'], defaultValues?: Partial<Record<keyof T, unknown>>): Plan<T>;
+    requiresChanges(): boolean;
     /**
      * Convert the plan to a JSON response object
      */

package/dist/plan/plan.js

@@ -52,8 +52,37 @@ export class Plan {
             ? `${this.coreParameters.type}.${this.coreParameters.name}`
             : this.coreParameters.type;
     }
-    requiresChanges() {
-        return this.changeSet.operation !== ResourceOperation.NOOP;
+    static calculate(params) {
+        const { desiredParameters, currentParametersArray, stateParameters, coreParameters, settings, statefulMode } = params;
+        const currentParameters = Plan.matchCurrentParameters({
+            desiredParameters,
+            currentParametersArray,
+            stateParameters,
+            settings,
+            statefulMode
+        });
+        const filteredCurrentParameters = Plan.filterCurrentParams({
+            desiredParameters,
+            currentParameters,
+            stateParameters,
+            settings,
+            statefulMode
+        });
+        // Empty
+        if (!filteredCurrentParameters && !desiredParameters) {
+            return new Plan(uuidV4(), ChangeSet.empty(), coreParameters, statefulMode);
+        }
+        // CREATE
+        if (!filteredCurrentParameters && desiredParameters) {
+            return new Plan(uuidV4(), ChangeSet.create(desiredParameters), coreParameters, statefulMode);
+        }
+        // DESTROY
+        if (filteredCurrentParameters && !desiredParameters) {
+            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, statefulMode);
     }
     /**
      * When multiples of the same resource are allowed, this matching function will match a given config with one of the
@@ -86,37 +115,59 @@ export class Plan {
     getResourceType() {
         return this.coreParameters.type;
     }
-    static calculate(params) {
-        const { desiredParameters, currentParametersArray, stateParameters, coreParameters, settings, statefulMode } = params;
-        const currentParameters = Plan.matchCurrentParameters({
-            desiredParameters,
-            currentParametersArray,
-            stateParameters,
-            settings,
-            statefulMode
-        });
-        const filteredCurrentParameters = Plan.filterCurrentParams({
-            desiredParameters,
-            currentParameters,
-            stateParameters,
-            settings,
-            statefulMode
-        });
-        // Empty
-        if (!filteredCurrentParameters && !desiredParameters) {
-            return new Plan(uuidV4(), ChangeSet.empty(), coreParameters, statefulMode);
-        }
-        // CREATE
-        if (!filteredCurrentParameters && desiredParameters) {
-            return new Plan(uuidV4(), ChangeSet.create(desiredParameters), coreParameters, statefulMode);
+    //   2. Even if there was (maybe for testing reasons), the plan values should not be adjusted
+    static fromResponse(data, defaultValues) {
+        if (!data) {
+            throw new Error('Data is empty');
         }
-        // DESTROY
-        if (filteredCurrentParameters && !desiredParameters) {
-            return new Plan(uuidV4(), ChangeSet.destroy(filteredCurrentParameters), coreParameters, statefulMode);
+        addDefaultValues();
+        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]) => {
+                const configValueExists = data
+                    .parameters
+                    .some((p) => p.name === key);
+                // Only set default values if the value does not exist in the config
+                if (configValueExists) {
+                    return;
+                }
+                switch (data.operation) {
+                    case ResourceOperation.CREATE: {
+                        data.parameters.push({
+                            name: key,
+                            operation: ParameterOperation.ADD,
+                            previousValue: null,
+                            newValue: defaultValue,
+                        });
+                        break;
+                    }
+                    case ResourceOperation.DESTROY: {
+                        data.parameters.push({
+                            name: key,
+                            operation: ParameterOperation.REMOVE,
+                            previousValue: defaultValue,
+                            newValue: null,
+                        });
+                        break;
+                    }
+                    case ResourceOperation.MODIFY:
+                    case ResourceOperation.RECREATE:
+                    case ResourceOperation.NOOP: {
+                        data.parameters.push({
+                            name: key,
+                            operation: ParameterOperation.NOOP,
+                            previousValue: defaultValue,
+                            newValue: defaultValue,
+                        });
+                        break;
+                    }
+                }
+            });
         }
-        // NO-OP, MODIFY or RE-CREATE
-        const changeSet = ChangeSet.calculateModification(desiredParameters, filteredCurrentParameters, settings.parameterSettings);
-        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
@@ -215,59 +266,8 @@ export class Plan {
     }
     // TODO: This needs to be revisited. I don't think this is valid anymore.
     //   1. For all scenarios, there shouldn't be an apply without a plan beforehand
-    //   2. Even if there was (maybe for testing reasons), the plan values should not be adjusted
-    static fromResponse(data, defaultValues) {
-        if (!data) {
-            throw new Error('Data is empty');
-        }
-        addDefaultValues();
-        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]) => {
-                const configValueExists = data
-                    .parameters
-                    .some((p) => p.name === key);
-                // Only set default values if the value does not exist in the config
-                if (configValueExists) {
-                    return;
-                }
-                switch (data.operation) {
-                    case ResourceOperation.CREATE: {
-                        data.parameters.push({
-                            name: key,
-                            operation: ParameterOperation.ADD,
-                            previousValue: null,
-                            newValue: defaultValue,
-                        });
-                        break;
-                    }
-                    case ResourceOperation.DESTROY: {
-                        data.parameters.push({
-                            name: key,
-                            operation: ParameterOperation.REMOVE,
-                            previousValue: defaultValue,
-                            newValue: null,
-                        });
-                        break;
-                    }
-                    case ResourceOperation.MODIFY:
-                    case ResourceOperation.RECREATE:
-                    case ResourceOperation.NOOP: {
-                        data.parameters.push({
-                            name: key,
-                            operation: ParameterOperation.NOOP,
-                            previousValue: defaultValue,
-                            newValue: defaultValue,
-                        });
-                        break;
-                    }
-                }
-            });
-        }
+    requiresChanges() {
+        return this.changeSet.operation !== ResourceOperation.NOOP;
     }
     /**
      * Convert the plan to a JSON response object

package/dist/plugin/plugin.d.ts

@@ -16,6 +16,7 @@ export declare class Plugin {
     validate(data: ValidateRequestData): Promise<ValidateResponseData>;
     plan(data: PlanRequestData): Promise<PlanResponseData>;
     apply(data: ApplyRequestData): Promise<void>;
+    kill(): Promise<void>;
     private resolvePlan;
     protected crossValidateResources(configs: ResourceConfig[]): Promise<void>;
 }

package/dist/plugin/plugin.js

@@ -1,6 +1,7 @@
 import { ApplyValidationError } from '../common/errors.js';
 import { Plan } from '../plan/plan.js';
 import { BackgroundPty } from '../pty/background-pty.js';
+import { getPty } from '../pty/index.js';
 import { ResourceController } from '../resource/resource-controller.js';
 import { ptyLocalStorage } from '../utils/pty-local-storage.js';
 export class Plugin {
@@ -97,11 +98,18 @@ 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));
+        const validationPlan = await ptyLocalStorage.run(new BackgroundPty(), async () => {
+            const result = await resource.plan(plan.desiredConfig, plan.currentConfig, plan.statefulMode);
+            await getPty().kill();
+            return result;
+        });
         if (validationPlan.requiresChanges()) {
             throw new ApplyValidationError(plan);
         }
     }
+    async kill() {
+        await this.planPty.kill();
+    }
     resolvePlan(data) {
         const { plan: planRequest, planId } = data;
         if (planId) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-plugin-lib",
-  "version": "1.0.115",
+  "version": "1.0.116",
   "description": "Library plugin library",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",

package/src/common/errors.test.ts

@@ -1,6 +1,5 @@
 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', () => {
@@ -21,7 +20,7 @@ describe('Test file for errors file', () => {
     } catch (e) {
       console.error(e);
       expect(e.message).toMatch(
-`Failed to apply changes to resource: "homebrew.first". Additional changes are needed to complete apply.
+        `Failed to apply changes to resource: "homebrew.first". Additional changes are needed to complete apply.
 Changes remaining:
 {
   "operation": "destroy",

package/src/common/errors.ts

@@ -16,7 +16,7 @@ export class ApplyValidationError extends Error {
   private static prettyPrintPlan(plan: Plan<any>): string {
     const { operation, parameters } = plan.toResponse();
 
-    const prettyParameters = parameters.map(({ name, operation, previousValue, newValue}) => ({
+    const prettyParameters = parameters.map(({ name, operation, previousValue, newValue }) => ({
       name,
       operation,
       currentValue: previousValue,

package/src/index.ts

@@ -16,4 +16,8 @@ export * from './utils/utils.js'
 export async function runPlugin(plugin: Plugin) {
   const messageHandler = new MessageHandler(plugin);
   process.on('message', (message) => messageHandler.onMessage(message))
+
+  process.on('beforeExit', () => {
+    plugin.kill();
+  })
 }

package/src/plan/plan.ts

@@ -70,65 +70,12 @@ 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
-   * existing configs on the system. For example if there are multiple versions of Android Studios installed, we can use
-   * the application name and location to match it to our desired configs name and location.
-   *
-   * @param params
-   * @private
-   */
-  private static matchCurrentParameters<T extends StringIndexedObject>(params: {
-    desiredParameters: Partial<T> | null,
-    currentParametersArray: Partial<T>[] | null,
-    stateParameters: Partial<T> | null,
-    settings: ResourceSettings<T>,
-    statefulMode: boolean,
-  }): Partial<T> | null {
-    const {
-      desiredParameters,
-      currentParametersArray,
-      stateParameters,
-      settings,
-      statefulMode
-    } = params;
-
-    if (!settings.allowMultiple) {
-      return currentParametersArray?.[0] ?? null;
-    }
-
-    if (!currentParametersArray) {
-      return null;
-    }
-
-    if (statefulMode) {
-      return stateParameters
-        ? settings.allowMultiple.matcher(stateParameters, currentParametersArray)
-        : null
-    }
-
-    return settings.allowMultiple.matcher(desiredParameters!, currentParametersArray);
-  }
-
-  /**
-   * The type (id) of the resource
-   *
-   * @return string
-   */
-  getResourceType(): string {
-    return this.coreParameters.type
-  }
 
   static calculate<T extends StringIndexedObject>(params: {
     desiredParameters: Partial<T> | null,
@@ -208,6 +155,126 @@ export class Plan<T extends StringIndexedObject> {
     );
   }
 
+  /**
+   * 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
+   * the application name and location to match it to our desired configs name and location.
+   *
+   * @param params
+   * @private
+   */
+  private static matchCurrentParameters<T extends StringIndexedObject>(params: {
+    desiredParameters: Partial<T> | null,
+    currentParametersArray: Partial<T>[] | null,
+    stateParameters: Partial<T> | null,
+    settings: ResourceSettings<T>,
+    statefulMode: boolean,
+  }): Partial<T> | null {
+    const {
+      desiredParameters,
+      currentParametersArray,
+      stateParameters,
+      settings,
+      statefulMode
+    } = params;
+
+    if (!settings.allowMultiple) {
+      return currentParametersArray?.[0] ?? null;
+    }
+
+    if (!currentParametersArray) {
+      return null;
+    }
+
+    if (statefulMode) {
+      return stateParameters
+        ? settings.allowMultiple.matcher(stateParameters, currentParametersArray)
+        : null
+    }
+
+    return settings.allowMultiple.matcher(desiredParameters!, currentParametersArray);
+  }
+
+  /**
+   * The type (id) of the resource
+   *
+   * @return string
+   */
+  getResourceType(): string {
+    return this.coreParameters.type
+  }
+
+  //   2. Even if there was (maybe for testing reasons), the plan values should not be adjusted
+  static fromResponse<T extends ResourceConfig>(data: ApplyRequestData['plan'], defaultValues?: Partial<Record<keyof T, unknown>>): Plan<T> {
+    if (!data) {
+      throw new Error('Data is empty');
+    }
+
+    addDefaultValues();
+
+    return new Plan(
+      uuidV4(),
+      new ChangeSet<T>(
+        data.operation,
+        data.parameters
+      ),
+      {
+        type: data.resourceType,
+        name: data.resourceName,
+      },
+      data.statefulMode
+    );
+
+   function addDefaultValues(): void {
+      Object.entries(defaultValues ?? {})
+        .forEach(([key, defaultValue]) => {
+          const configValueExists = data!
+            .parameters
+            .some((p) => p.name === key);
+
+          // Only set default values if the value does not exist in the config
+          if (configValueExists) {
+            return;
+          }
+
+          switch (data!.operation) {
+            case ResourceOperation.CREATE: {
+              data!.parameters.push({
+                name: key,
+                operation: ParameterOperation.ADD,
+                previousValue: null,
+                newValue: defaultValue,
+              });
+              break;
+            }
+
+            case ResourceOperation.DESTROY: {
+              data!.parameters.push({
+                name: key,
+                operation: ParameterOperation.REMOVE,
+                previousValue: defaultValue,
+                newValue: null,
+              });
+              break;
+            }
+
+            case ResourceOperation.MODIFY:
+            case ResourceOperation.RECREATE:
+            case ResourceOperation.NOOP: {
+              data!.parameters.push({
+                name: key,
+                operation: ParameterOperation.NOOP,
+                previousValue: defaultValue,
+                newValue: defaultValue,
+              });
+              break;
+            }
+          }
+        });
+    }
+
+  }
+
   /**
    *  Only keep relevant params for the plan. We don't want to change settings that were not already
    *  defined.
@@ -347,75 +414,9 @@ export class Plan<T extends StringIndexedObject> {
 
   // TODO: This needs to be revisited. I don't think this is valid anymore.
   //   1. For all scenarios, there shouldn't be an apply without a plan beforehand
-  //   2. Even if there was (maybe for testing reasons), the plan values should not be adjusted
-  static fromResponse<T extends ResourceConfig>(data: ApplyRequestData['plan'], defaultValues?: Partial<Record<keyof T, unknown>>): Plan<T> {
-    if (!data) {
-      throw new Error('Data is empty');
-    }
-
-    addDefaultValues();
-
-    return new Plan(
-      uuidV4(),
-      new ChangeSet<T>(
-        data.operation,
-        data.parameters
-      ),
-      {
-        type: data.resourceType,
-        name: data.resourceName,
-      },
-      data.statefulMode
-    );
-
-   function addDefaultValues(): void {
-      Object.entries(defaultValues ?? {})
-        .forEach(([key, defaultValue]) => {
-          const configValueExists = data!
-            .parameters
-            .some((p) => p.name === key);
-
-          // Only set default values if the value does not exist in the config
-          if (configValueExists) {
-            return;
-          }
-
-          switch (data!.operation) {
-            case ResourceOperation.CREATE: {
-              data!.parameters.push({
-                name: key,
-                operation: ParameterOperation.ADD,
-                previousValue: null,
-                newValue: defaultValue,
-              });
-              break;
-            }
-
-            case ResourceOperation.DESTROY: {
-              data!.parameters.push({
-                name: key,
-                operation: ParameterOperation.REMOVE,
-                previousValue: defaultValue,
-                newValue: null,
-              });
-              break;
-            }
-
-            case ResourceOperation.MODIFY:
-            case ResourceOperation.RECREATE:
-            case ResourceOperation.NOOP: {
-              data!.parameters.push({
-                name: key,
-                operation: ParameterOperation.NOOP,
-                previousValue: defaultValue,
-                newValue: defaultValue,
-              });
-              break;
-            }
-          }
-        });
-    }
 
+  requiresChanges(): boolean {
+    return this.changeSet.operation !== ResourceOperation.NOOP;
   }
 
   /**

package/src/plugin/plugin.test.ts

@@ -7,7 +7,6 @@ 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 {
@@ -42,7 +41,7 @@ class TestResource extends Resource<TestConfig> {
 
 describe('Plugin tests', () => {
   it('Can apply resource', async () => {
-    const resource= spy(new class extends TestResource {
+    const resource = spy(new class extends TestResource {
       async refresh(): Promise<Partial<TestConfig> | null> {
         return {
           propA: 'abc',

package/src/plugin/plugin.ts

@@ -16,6 +16,7 @@ import {
 import { ApplyValidationError } from '../common/errors.js';
 import { Plan } from '../plan/plan.js';
 import { BackgroundPty } from '../pty/background-pty.js';
+import { getPty } from '../pty/index.js';
 import { Resource } from '../resource/resource.js';
 import { ResourceController } from '../resource/resource-controller.js';
 import { ptyLocalStorage } from '../utils/pty-local-storage.js';
@@ -127,7 +128,7 @@ export class Plugin {
         data.desired ?? null,
         data.state ?? null,
         data.isStateful
-      ))
+    ))
 
     this.planStorage.set(plan.id, plan);
 
@@ -148,17 +149,26 @@ export class Plugin {
 
     await resource.apply(plan);
 
-    const validationPlan = await ptyLocalStorage.run(new BackgroundPty(), async () => resource.plan(
-      plan.desiredConfig,
-      plan.currentConfig,
-      plan.statefulMode
-    ))
-    
+    const validationPlan = await ptyLocalStorage.run(new BackgroundPty(), async () => {
+      const result = await resource.plan(
+        plan.desiredConfig,
+        plan.currentConfig,
+        plan.statefulMode
+      );
+
+      await getPty().kill();
+      return result;
+    })
+
     if (validationPlan.requiresChanges()) {
       throw new ApplyValidationError(plan);
     }
   }
 
+  async kill() {
+    await this.planPty.kill();
+  }
+
   private resolvePlan(data: ApplyRequestData): Plan<ResourceConfig> {
     const { plan: planRequest, planId } = data;
 
@@ -179,5 +189,4 @@ export class Plugin {
   }
 
   protected async crossValidateResources(configs: ResourceConfig[]): Promise<void> {}
-
 }