codify-plugin-lib 1.0.68 → 1.0.70

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/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/entities/resource.d.ts

@@ -23,7 +23,7 @@ export declare abstract class Resource<T extends StringIndexedObject> {
     protected schemaValidator?: ValidateFunction;
     protected constructor(options: ResourceOptions<T>);
     onInitialize(): Promise<void>;
-    validateResource(parameters: unknown): Promise<ValidationResult>;
+    validateResource(parameters: Partial<T>): Promise<ValidationResult>;
     plan(desiredConfig: Partial<T> & ResourceConfig | null, currentConfig?: Partial<T> & ResourceConfig | null, statefulMode?: boolean): Promise<Plan<T>>;
     apply(plan: Plan<T>): Promise<void>;
     private _applyCreate;
@@ -35,8 +35,8 @@ export declare abstract class Resource<T extends StringIndexedObject> {
     private refreshNonStatefulParameters;
     private refreshStatefulParameters;
     private validatePlanInputs;
-    validate(parameters: unknown): Promise<ValidationResult>;
-    abstract refresh(values: Map<keyof T, T[keyof T]>): Promise<Partial<T> | null>;
+    validate(parameters: Partial<T>): Promise<ValidationResult>;
+    abstract refresh(values: Partial<T>): Promise<Partial<T> | null>;
     abstract applyCreate(plan: CreatePlan<T>): Promise<void>;
     applyModify(pc: ParameterChange<T>, plan: ModifyPlan<T>): Promise<void>;
     abstract applyDestroy(plan: DestroyPlan<T>): Promise<void>;

package/dist/entities/resource.js

@@ -139,11 +139,11 @@ export class Resource {
         }
         await this.applyDestroy(plan);
     }
-    validateRefreshResults(refresh, desiredMap) {
+    validateRefreshResults(refresh, desired) {
         if (!refresh) {
             return;
         }
-        const desiredKeys = new Set(desiredMap.keys());
+        const desiredKeys = new Set(Object.keys(refresh));
         const refreshKeys = new Set(Object.keys(refresh));
         if (!setsEqual(desiredKeys, refreshKeys)) {
             throw new Error(`Resource ${this.typeId}
@@ -184,9 +184,8 @@ Additional: ${[...refreshKeys].filter(k => !desiredKeys.has(k))};`);
         });
     }
     async refreshNonStatefulParameters(resourceParameters) {
-        const entriesToRefresh = new Map(Object.entries(resourceParameters));
-        const currentParameters = await this.refresh(entriesToRefresh);
-        this.validateRefreshResults(currentParameters, entriesToRefresh);
+        const currentParameters = await this.refresh(resourceParameters);
+        this.validateRefreshResults(currentParameters, resourceParameters);
         return currentParameters;
     }
     async refreshStatefulParameters(statefulParametersConfig, isStatefulMode) {

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.68",
+  "version": "1.0.70",
   "description": "",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",

package/src/entities/errors.ts

@@ -1,6 +1,3 @@
-import { Plan } from './plan.js';
-import { StringIndexedObject } from 'codify-schemas';
-
 export class SudoError extends Error {
   command: string;
 
@@ -9,17 +6,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/plugin.ts

@@ -5,13 +5,11 @@ import {
   PlanRequestData,
   PlanResponseData,
   ResourceConfig,
-  ResourceOperation,
   ValidateRequestData,
   ValidateResponseData
 } 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 +90,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.ts

@@ -59,7 +59,7 @@ export abstract class Resource<T extends StringIndexedObject> {
 
   async onInitialize(): Promise<void> {}
 
-  async validateResource(parameters: unknown): Promise<ValidationResult> {
+  async validateResource(parameters: Partial<T>): Promise<ValidationResult> {
     if (this.schemaValidator) {
       const isValid = this.schemaValidator(parameters);
 
@@ -215,12 +215,12 @@ export abstract class Resource<T extends StringIndexedObject> {
     await this.applyDestroy(plan as DestroyPlan<T>);
   }
 
-  private validateRefreshResults(refresh: Partial<T> | null, desiredMap: Map<keyof T, T[keyof T]>) {
+  private validateRefreshResults(refresh: Partial<T> | null, desired: Partial<T>) {
     if (!refresh) {
       return;
     }
 
-    const desiredKeys = new Set<keyof T>(desiredMap.keys());
+    const desiredKeys = new Set(Object.keys(refresh)) as Set<keyof T>;
     const refreshKeys = new Set(Object.keys(refresh)) as Set<keyof T>;
 
     if (!setsEqual(desiredKeys, refreshKeys)) {
@@ -278,11 +278,8 @@ Additional: ${[...refreshKeys].filter(k => !desiredKeys.has(k))};`
   }
 
   private async refreshNonStatefulParameters(resourceParameters: Partial<T>): Promise<Partial<T> | null> {
-    const entriesToRefresh = new Map<keyof T, T[keyof T]>(
-      Object.entries(resourceParameters)
-    )
-    const currentParameters = await this.refresh(entriesToRefresh);
-    this.validateRefreshResults(currentParameters, entriesToRefresh);
+    const currentParameters = await this.refresh(resourceParameters);
+    this.validateRefreshResults(currentParameters, resourceParameters);
     return currentParameters;
   }
 
@@ -340,13 +337,13 @@ Additional: ${[...refreshKeys].filter(k => !desiredKeys.has(k))};`
     }
   }
 
-  async validate(parameters: unknown): Promise<ValidationResult> {
+  async validate(parameters: Partial<T>): Promise<ValidationResult> {
     return {
       isValid: true,
     }
   };
 
-  abstract refresh(values: Map<keyof T, T[keyof T]>): Promise<Partial<T> | null>;
+  abstract refresh(values: Partial<T>): Promise<Partial<T> | null>;
 
   abstract applyCreate(plan: CreatePlan<T>): Promise<void>;
 

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?.({