codify-plugin-lib 1.0.67 → 1.0.69

package/dist/entities/errors.d.ts

@@ -1,11 +1,4 @@
-import { Plan } from './plan.js';
-import { StringIndexedObject } from 'codify-schemas';
 export declare class SudoError extends Error {
     command: string;
     constructor(command: string);
 }
-export declare class ApplyValidationError<T extends StringIndexedObject> extends Error {
-    desiredPlan: Plan<T>;
-    validatedPlan: Plan<T>;
-    constructor(desiredPlan: Plan<T>, validatedPlan: Plan<T>);
-}

package/dist/entities/errors.js

@@ -5,12 +5,3 @@ export class SudoError extends Error {
         this.command = command;
     }
 }
-export class ApplyValidationError extends Error {
-    desiredPlan;
-    validatedPlan;
-    constructor(desiredPlan, validatedPlan) {
-        super();
-        this.desiredPlan = desiredPlan;
-        this.validatedPlan = validatedPlan;
-    }
-}

package/dist/entities/plan-types.d.ts

@@ -11,9 +11,15 @@ export interface PlanOptions<T> {
     statefulMode: boolean;
     parameterOptions?: Record<keyof T, ParameterOptions>;
 }
-export type WithRequired<T, K extends keyof T> = T & {
-    [P in K]-?: T[P];
-};
-export type CreatePlan<T extends StringIndexedObject> = WithRequired<Plan<T>, 'desiredConfig'>;
-export type DestroyPlan<T extends StringIndexedObject> = WithRequired<Plan<T>, 'currentConfig'>;
-export type ModifyPlan<T extends StringIndexedObject> = WithRequired<Plan<T>, 'currentConfig' | 'desiredConfig'>;
+export interface CreatePlan<T extends StringIndexedObject> extends Plan<T> {
+    desiredConfig: T;
+    currentConfig: null;
+}
+export interface DestroyPlan<T extends StringIndexedObject> extends Plan<T> {
+    desiredConfig: null;
+    currentConfig: T;
+}
+export interface ModifyPlan<T extends StringIndexedObject> extends Plan<T> {
+    desiredConfig: T;
+    currentConfig: T;
+}

package/dist/entities/plugin.js

@@ -1,7 +1,5 @@
-import { ResourceOperation } from 'codify-schemas';
 import { Plan } from './plan.js';
 import { splitUserConfig } from '../utils/utils.js';
-import { ApplyValidationError } from './errors.js';
 export class Plugin {
     name;
     resources;
@@ -64,10 +62,6 @@ export class Plugin {
             throw new Error('Malformed plan with resource that cannot be found');
         }
         await resource.apply(plan);
-        const validationPlan = await resource.plan(plan.desiredConfig, plan.currentConfig, true);
-        if (validationPlan.changeSet.operation !== ResourceOperation.NOOP) {
-            throw new ApplyValidationError(plan, validationPlan);
-        }
     }
     resolvePlan(data) {
         const { planId, plan: planRequest } = data;

package/dist/messages/handlers.js

@@ -1,7 +1,7 @@
 import addFormats from 'ajv-formats';
 import { ApplyRequestDataSchema, ApplyResponseDataSchema, InitializeRequestDataSchema, InitializeResponseDataSchema, IpcMessageSchema, MessageStatus, PlanRequestDataSchema, PlanResponseDataSchema, ResourceSchema, ValidateRequestDataSchema, ValidateResponseDataSchema } from 'codify-schemas';
 import Ajv2020 from 'ajv/dist/2020.js';
-import { ApplyValidationError, SudoError } from '../entities/errors.js';
+import { SudoError } from '../entities/errors.js';
 const SupportedRequests = {
     'initialize': {
         requestValidator: InitializeRequestDataSchema,
@@ -89,20 +89,6 @@ export class MessageHandler {
                 data: `Plugin: '${this.plugin.name}'. Forbidden usage of sudo for command '${e.command}'. Please contact the plugin developer to fix this.`,
             });
         }
-        if (e instanceof ApplyValidationError) {
-            return process.send?.({
-                cmd,
-                status: MessageStatus.ERROR,
-                data: `Plugin: '${this.plugin.name}'. Apply validation was not successful (additional changes are needed to match the desired plan).
-
-Validation plan:
-${JSON.stringify(e.validatedPlan, null, 2)},
-        
-User desired plan:
-${JSON.stringify(e.desiredPlan, null, 2)}
-`
-            });
-        }
         const isDebug = process.env.DEBUG?.includes('*') ?? false;
         process.send?.({
             cmd,

package/package.json

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

package/src/entities/errors.ts

@@ -9,17 +9,3 @@ export class SudoError extends Error {
     this.command = command;
   }
 }
-
-export class ApplyValidationError<T extends StringIndexedObject> extends Error {
-  desiredPlan: Plan<T>;
-  validatedPlan: Plan<T>;
-
-  constructor(
-    desiredPlan: Plan<T>,
-    validatedPlan: Plan<T>
-  ) {
-    super();
-    this.desiredPlan = desiredPlan;
-    this.validatedPlan = validatedPlan;
-  }
-}

package/src/entities/plan-types.ts

@@ -28,7 +28,17 @@ export interface PlanOptions<T> {
   parameterOptions?: Record<keyof T, ParameterOptions>;
 }
 
-export type WithRequired<T, K extends keyof T> = T & { [P in K]-?: T[P] }
-export type CreatePlan<T extends StringIndexedObject> = WithRequired<Plan<T>, 'desiredConfig'>
-export type DestroyPlan<T extends StringIndexedObject> = WithRequired<Plan<T>, 'currentConfig'>
-export type ModifyPlan<T extends StringIndexedObject> = WithRequired<Plan<T>, 'currentConfig' | 'desiredConfig'>
+export interface CreatePlan<T extends StringIndexedObject> extends Plan<T> {
+  desiredConfig: T;
+  currentConfig: null;
+}
+
+export interface DestroyPlan<T extends StringIndexedObject> extends Plan<T> {
+  desiredConfig: null;
+  currentConfig: T;
+}
+
+export interface ModifyPlan<T extends StringIndexedObject> extends Plan<T> {
+  desiredConfig: T;
+  currentConfig: T;
+}

package/src/entities/plugin.ts

@@ -11,7 +11,6 @@ import {
 } from 'codify-schemas';
 import { Plan } from './plan.js';
 import { splitUserConfig } from '../utils/utils.js';
-import { ApplyValidationError } from './errors.js';
 
 export class Plugin {
   planStorage: Map<string, Plan<any>>;
@@ -92,17 +91,6 @@ export class Plugin {
     }
 
     await resource.apply(plan);
-
-    // Perform a validation check after to ensure that the plan was properly applied.
-    // Sometimes no errors are returned (exit code 0) but the apply was not successful
-    const validationPlan = await resource.plan(
-      plan.desiredConfig,
-      plan.currentConfig,
-      true,
-    );
-    if (validationPlan.changeSet.operation !== ResourceOperation.NOOP) {
-      throw new ApplyValidationError(plan, validationPlan);
-    }
   }
 
   private resolvePlan(data: ApplyRequestData): Plan<ResourceConfig> {

package/src/entities/resource.test.ts

@@ -6,6 +6,8 @@ import { describe, expect, it } from 'vitest'
 import { ValidationResult } from './resource-types.js';
 import { StatefulParameter } from './stateful-parameter.js';
 import { ResourceOptions } from './resource-options.js';
+import { CreatePlan, DestroyPlan, ModifyPlan } from './plan-types.js';
+import { ParameterChange } from './change-set.js';
 
 export interface TestConfig extends StringIndexedObject {
   propA: string;
@@ -221,12 +223,15 @@ describe('Resource tests', () => {
       async refresh(): Promise<string | null> {
         return null;
       }
+
       applyAdd(valueToAdd: string, plan: Plan<TestConfig>): Promise<void> {
         throw new Error('Method not implemented.');
       }
+
       applyModify(newValue: string, previousValue: string, allowDeletes: boolean, plan: Plan<TestConfig>): Promise<void> {
         throw new Error('Method not implemented.');
       }
+
       applyRemove(valueToRemove: string, plan: Plan<TestConfig>): Promise<void> {
         throw new Error('Method not implemented.');
       }
@@ -252,12 +257,15 @@ describe('Resource tests', () => {
       async refresh(): Promise<string | null> {
         return null;
       }
+
       applyAdd(valueToAdd: string, plan: Plan<TestConfig>): Promise<void> {
         throw new Error('Method not implemented.');
       }
+
       applyModify(newValue: string, previousValue: string, allowDeletes: boolean, plan: Plan<TestConfig>): Promise<void> {
         throw new Error('Method not implemented.');
       }
+
       applyRemove(valueToRemove: string, plan: Plan<TestConfig>): Promise<void> {
         throw new Error('Method not implemented.');
       }
@@ -300,7 +308,7 @@ describe('Resource tests', () => {
       }
     }
 
-    const plan = await resource.plan({ type: 'resource'})
+    const plan = await resource.plan({ type: 'resource' })
     expect(plan.currentConfig?.propA).to.eq('propAAfter');
     expect(plan.desiredConfig?.propA).to.eq('propADefault');
     expect(plan.changeSet.operation).to.eq(ResourceOperation.RECREATE);
@@ -326,7 +334,7 @@ describe('Resource tests', () => {
       }
     }
 
-    const plan = await resource.plan({ type: 'resource'})
+    const plan = await resource.plan({ type: 'resource' })
     expect(plan.currentConfig?.propE).to.eq('propEDefault');
     expect(plan.desiredConfig?.propE).to.eq('propEDefault');
     expect(plan.changeSet.operation).to.eq(ResourceOperation.NOOP);
@@ -348,7 +356,7 @@ describe('Resource tests', () => {
       }
     }
 
-    const plan = await resource.plan({ type: 'resource'})
+    const plan = await resource.plan({ type: 'resource' })
     expect(plan.currentConfig).to.be.null
     expect(plan.desiredConfig!.propE).to.eq('propEDefault');
     expect(plan.changeSet.operation).to.eq(ResourceOperation.CREATE);
@@ -376,7 +384,7 @@ describe('Resource tests', () => {
       }
     }
 
-    const plan = await resource.plan({ type: 'resource', propA: 'propA'})
+    const plan = await resource.plan({ type: 'resource', propA: 'propA' })
     expect(plan.currentConfig?.propA).to.eq('propAAfter');
     expect(plan.desiredConfig?.propA).to.eq('propA');
     expect(plan.changeSet.operation).to.eq(ResourceOperation.RECREATE);
@@ -398,4 +406,29 @@ describe('Resource tests', () => {
       propA: 'propADefault',
     })
   })
+
+  it('Has the correct typing for applys', () => {
+    const resource = new class extends Resource<TestConfig> {
+      constructor() {
+        super({ type: 'type' });
+      }
+
+      async refresh(values: Map<keyof TestConfig, unknown>): Promise<Partial<TestConfig> | null> {
+        return null;
+      }
+
+      async applyCreate(plan: CreatePlan<TestConfig>): Promise<void> {
+        plan.desiredConfig.propA
+      }
+
+      async applyDestroy(plan: DestroyPlan<TestConfig>): Promise<void> {
+        plan.currentConfig.propB
+      }
+
+      async applyModify(pc: ParameterChange<TestConfig>, plan: ModifyPlan<TestConfig>): Promise<void> {
+        plan.desiredConfig.propA
+        plan.currentConfig.propB
+      }
+    }
+  })
 });

package/src/entities/resource.ts

@@ -147,7 +147,7 @@ export abstract class Resource<T extends StringIndexedObject> {
   }
 
   private async _applyCreate(plan: Plan<T>): Promise<void> {
-    await this.applyCreate(plan);
+    await this.applyCreate(plan as CreatePlan<T>);
 
     const statefulParameterChanges = plan.changeSet.parameterChanges
       .filter((pc: ParameterChange<T>) => this.statefulParameters.has(pc.name))
@@ -170,7 +170,7 @@ export abstract class Resource<T extends StringIndexedObject> {
 
     for (const pc of statelessParameterChanges) {
       // TODO: When stateful mode is added in the future. Dynamically choose if deletes are allowed
-      await this.applyModify(pc, plan);
+      await this.applyModify(pc, plan as ModifyPlan<T>);
     }
 
     const statefulParameterChanges = parameterChanges
@@ -212,7 +212,7 @@ export abstract class Resource<T extends StringIndexedObject> {
       }
     }
 
-    await this.applyDestroy(plan);
+    await this.applyDestroy(plan as DestroyPlan<T>);
   }
 
   private validateRefreshResults(refresh: Partial<T> | null, desiredMap: Map<keyof T, T[keyof T]>) {

package/src/messages/handlers.ts

@@ -15,7 +15,7 @@ import {
   ValidateResponseDataSchema
 } from 'codify-schemas';
 import Ajv2020, { SchemaObject, ValidateFunction } from 'ajv/dist/2020.js';
-import { ApplyValidationError, SudoError } from '../entities/errors.js';
+import { SudoError } from '../entities/errors.js';
 
 const SupportedRequests: Record<string, { requestValidator: SchemaObject; responseValidator: SchemaObject; handler: (plugin: Plugin, data: any) => Promise<unknown> }> = {
   'initialize': {
@@ -124,21 +124,6 @@ export class MessageHandler {
       })
     }
 
-    if (e instanceof ApplyValidationError) {
-      return process.send?.({
-        cmd,
-        status: MessageStatus.ERROR,
-        data: `Plugin: '${this.plugin.name}'. Apply validation was not successful (additional changes are needed to match the desired plan).
-
-Validation plan:
-${JSON.stringify(e.validatedPlan, null, 2)},
-        
-User desired plan:
-${JSON.stringify(e.desiredPlan, null, 2)}
-`
-      })
-    }
-
     const isDebug = process.env.DEBUG?.includes('*') ?? false;
 
     process.send?.({