codify-plugin-lib 1.0.106 → 1.0.108

package/dist/messages/handlers.d.ts

@@ -2,11 +2,13 @@ import { Plugin } from '../plugin/plugin.js';
 export declare class MessageHandler {
     private ajv;
     private readonly plugin;
-    private messageSchemaValidator;
+    private messageSchemaValidatorV1;
+    private messageSchemaValidatorV2;
     private requestValidators;
     private responseValidators;
     constructor(plugin: Plugin);
     onMessage(message: unknown): Promise<void>;
     private validateMessage;
+    private validateMessageV2;
     private handleErrors;
 }

package/dist/messages/handlers.js

@@ -1,6 +1,6 @@
 import { Ajv } from 'ajv';
 import addFormats from 'ajv-formats';
-import { ApplyRequestDataSchema, ApplyResponseDataSchema, GetResourceInfoRequestDataSchema, GetResourceInfoResponseDataSchema, ImportRequestDataSchema, ImportResponseDataSchema, InitializeRequestDataSchema, InitializeResponseDataSchema, IpcMessageSchema, MessageStatus, PlanRequestDataSchema, PlanResponseDataSchema, ResourceSchema, ValidateRequestDataSchema, ValidateResponseDataSchema } from 'codify-schemas';
+import { ApplyRequestDataSchema, ApplyResponseDataSchema, GetResourceInfoRequestDataSchema, GetResourceInfoResponseDataSchema, ImportRequestDataSchema, ImportResponseDataSchema, InitializeRequestDataSchema, InitializeResponseDataSchema, IpcMessageSchema, IpcMessageV2Schema, MessageStatus, PlanRequestDataSchema, PlanResponseDataSchema, ResourceSchema, ValidateRequestDataSchema, ValidateResponseDataSchema } from 'codify-schemas';
 import { SudoError } from '../errors.js';
 const SupportedRequests = {
     'initialize': {
@@ -40,7 +40,8 @@ const SupportedRequests = {
 export class MessageHandler {
     ajv;
     plugin;
-    messageSchemaValidator;
+    messageSchemaValidatorV1;
+    messageSchemaValidatorV2;
     requestValidators;
     responseValidators;
     constructor(plugin) {
@@ -48,7 +49,8 @@ export class MessageHandler {
         addFormats.default(this.ajv);
         this.ajv.addSchema(ResourceSchema);
         this.plugin = plugin;
-        this.messageSchemaValidator = this.ajv.compile(IpcMessageSchema);
+        this.messageSchemaValidatorV1 = this.ajv.compile(IpcMessageSchema);
+        this.messageSchemaValidatorV2 = this.ajv.compile(IpcMessageV2Schema);
         this.requestValidators = new Map(Object.entries(SupportedRequests)
             .map(([k, v]) => [k, this.ajv.compile(v.requestValidator)]));
         this.responseValidators = new Map(Object.entries(SupportedRequests)
@@ -56,8 +58,8 @@ export class MessageHandler {
     }
     async onMessage(message) {
         try {
-            if (!this.validateMessage(message)) {
-                throw new Error(`Plugin: ${this.plugin}. Message is malformed: ${JSON.stringify(this.messageSchemaValidator.errors, null, 2)}`);
+            if (!this.validateMessageV2(message) && !this.validateMessage(message)) {
+                throw new Error(`Plugin: ${this.plugin}. Message is malformed: ${JSON.stringify(this.messageSchemaValidatorV1.errors, null, 2)}`);
             }
             if (!this.requestValidators.has(message.cmd)) {
                 throw new Error(`Plugin: ${this.plugin}. Unsupported message: ${message.cmd}`);
@@ -74,6 +76,8 @@ export class MessageHandler {
             process.send({
                 cmd: message.cmd + '_Response',
                 data: result,
+                // @ts-expect-error TS2239
+                requestId: message.requestId || undefined,
                 status: MessageStatus.SUCCESS,
             });
         }
@@ -82,7 +86,10 @@ export class MessageHandler {
         }
     }
     validateMessage(message) {
-        return this.messageSchemaValidator(message);
+        return this.messageSchemaValidatorV1(message);
+    }
+    validateMessageV2(message) {
+        return this.messageSchemaValidatorV2(message);
     }
     handleErrors(message, e) {
         if (!message) {
@@ -91,11 +98,13 @@ export class MessageHandler {
         if (!message.hasOwnProperty('cmd')) {
             return;
         }
-        // @ts-ignore
+        // @ts-expect-error TS2239
         const cmd = message.cmd + '_Response';
         if (e instanceof SudoError) {
             return process.send?.({
                 cmd,
+                // @ts-expect-error TS2239
+                requestId: message.requestId || undefined,
                 data: `Plugin: '${this.plugin.name}'. Forbidden usage of sudo for command '${e.command}'. Please contact the plugin developer to fix this.`,
                 status: MessageStatus.ERROR,
             });
@@ -103,6 +112,8 @@ export class MessageHandler {
         const isDebug = process.env.DEBUG?.includes('*') ?? false;
         process.send?.({
             cmd,
+            // @ts-expect-error TS2239
+            requestId: message.requestId || undefined,
             data: isDebug ? e.stack : e.message,
             status: MessageStatus.ERROR,
         });

package/dist/resource/parsed-resource-settings.d.ts

@@ -1,6 +1,6 @@
 import { StringIndexedObject } from 'codify-schemas';
 import { StatefulParameterController } from '../stateful-parameter/stateful-parameter-controller.js';
-import { ArrayParameterSetting, DefaultParameterSetting, ResourceSettings } from './resource-settings.js';
+import { ArrayParameterSetting, DefaultParameterSetting, ParameterSetting, ResourceSettings } from './resource-settings.js';
 export interface ParsedStatefulParameterSetting extends DefaultParameterSetting {
     type: 'stateful';
     controller: StatefulParameterController<any, unknown>;
@@ -30,7 +30,7 @@ export declare class ParsedResourceSettings<T extends StringIndexedObject> imple
     get statefulParameters(): Map<keyof T, StatefulParameterController<T, T[keyof T]>>;
     get parameterSettings(): Record<keyof T, ParsedParameterSetting>;
     get defaultValues(): Partial<Record<keyof T, unknown>>;
-    get inputTransformations(): Partial<Record<keyof T, (a: unknown) => unknown>>;
+    get inputTransformations(): Partial<Record<keyof T, (a: unknown, parameter: ParameterSetting) => unknown>>;
     get statefulParameterOrder(): Map<keyof T, number>;
     private validateSettings;
     private validateParameterEqualsFn;

package/dist/resource/parsed-resource-settings.js

@@ -83,7 +83,7 @@ export class ParsedResourceSettings {
                 return {};
             }
             return Object.fromEntries(Object.entries(this.settings.parameterSettings)
-                .filter(([, v]) => resolveParameterTransformFn(v) !== undefined)
+                .filter(([_, v]) => resolveParameterTransformFn(v) !== undefined)
                 .map(([k, v]) => [k, resolveParameterTransformFn(v)]));
         });
     }

package/dist/resource/resource-controller.js

@@ -230,7 +230,7 @@ ${JSON.stringify(refresh, null, 2)}
             if (config[key] === undefined || !inputTransformation) {
                 continue;
             }
-            config[key] = await inputTransformation(config[key]);
+            config[key] = await inputTransformation(config[key], this.settings.parameterSettings[key]);
         }
         if (this.settings.inputTransformation) {
             const { parameters, coreParameters } = splitUserConfig(config);

package/dist/resource/resource-settings.d.ts

@@ -216,4 +216,4 @@ export interface StatefulParameterSetting extends DefaultParameterSetting {
 }
 export declare function resolveEqualsFn(parameter: ParameterSetting): (desired: unknown, current: unknown) => boolean;
 export declare function resolveFnFromEqualsFnOrString(fnOrString: ((a: unknown, b: unknown) => boolean) | ParameterSettingType | undefined): ((a: unknown, b: unknown) => boolean) | undefined;
-export declare function resolveParameterTransformFn(parameter: ParameterSetting): ((input: any) => Promise<any> | any) | undefined;
+export declare function resolveParameterTransformFn(parameter: ParameterSetting): ((input: any, parameter: ParameterSetting) => Promise<any> | any) | undefined;

package/dist/resource/resource-settings.js

@@ -35,6 +35,12 @@ export function resolveFnFromEqualsFnOrString(fnOrString) {
 }
 const ParameterTransformationDefaults = {
     'directory': (a) => path.resolve(untildify(String(a))),
+    'stateful': (a, b) => {
+        const sp = b;
+        return (sp.definition?.getSettings()?.inputTransformation)
+            ? (sp.definition.getSettings().inputTransformation(a))
+            : a;
+    },
     'string': String,
 };
 export function resolveParameterTransformFn(parameter) {

package/dist/utils/utils.js

@@ -73,6 +73,9 @@ export function untildify(pathWithTilde) {
     return homeDirectory ? pathWithTilde.replace(/^~(?=$|\/|\\)/, homeDirectory) : pathWithTilde;
 }
 export function areArraysEqual(isElementEqual, desired, current) {
+    if (!desired || !current) {
+        return false;
+    }
     if (!Array.isArray(desired) || !Array.isArray(current)) {
         throw new Error(`A non-array value:
           

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-plugin-lib",
-  "version": "1.0.106",
+  "version": "1.0.108",
   "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.52",
+    "codify-schemas": "1.0.53",
     "@npmcli/promise-spawn": "^7.0.1",
     "uuid": "^10.0.0",
     "lodash.isequal": "^4.5.0"

package/src/messages/handlers.test.ts

@@ -207,7 +207,6 @@ describe('Message handler tests', () => {
   it('handles errors for apply (destroy)', async () => {
     const resource = new TestResource()
     const plugin = testPlugin(resource);
-
     const handler = new MessageHandler(plugin);
 
     process.send = (message) => {
@@ -228,6 +227,71 @@ describe('Message handler tests', () => {
         }
       }
     })).rejects.to.not.throw;
+
+    process.send = undefined;
+  })
+
+  it('Supports ipc message v2 (success)', async () => {
+    const resource = new TestResource()
+    const plugin = testPlugin(resource);
+    const handler = new MessageHandler(plugin);
+
+    process.send = (message) => {
+      console.log(message)
+      expect(message).toMatchObject({
+        cmd: 'plan_Response',
+        requestId: 'abcdef',
+        status: MessageStatus.SUCCESS,
+      })
+      return true;
+    }
+
+    await expect(handler.onMessage({
+      cmd: 'plan',
+      requestId: 'abcdef',
+      data: {
+        desired: {
+          type: 'type',
+          name: 'name',
+          prop1: 'A',
+          prop2: 'B',
+        },
+        isStateful: false,
+      }
+    })).resolves.to.eq(undefined);
+
+    process.send = undefined;
+  })
+
+  it('Supports ipc message v2 (error)', async () => {
+    const resource = new TestResource()
+    const plugin = testPlugin(resource);
+    const handler = new MessageHandler(plugin);
+
+    process.send = (message) => {
+      expect(message).toMatchObject({
+        cmd: 'apply_Response',
+        requestId: 'abcdef',
+        status: MessageStatus.ERROR,
+      })
+      return true;
+    }
+
+    await expect(handler.onMessage({
+      cmd: 'apply', // Supposed to be a plan so that's why it throws
+      requestId: 'abcdef',
+      data: {
+        desired: {
+          type: 'type',
+          name: 'name',
+          prop1: 'A',
+          prop2: 'B',
+        },
+        isStateful: false,
+      }
+    })).resolves.to.eq(undefined);
+
+    process.send = undefined;
   })
 });
 

package/src/messages/handlers.ts

@@ -11,6 +11,8 @@ import {
   InitializeResponseDataSchema,
   IpcMessage,
   IpcMessageSchema,
+  IpcMessageV2,
+  IpcMessageV2Schema,
   MessageStatus,
   PlanRequestDataSchema,
   PlanResponseDataSchema,
@@ -61,7 +63,8 @@ const SupportedRequests: Record<string, { handler: (plugin: Plugin, data: any) =
 export class MessageHandler {
   private ajv: Ajv;
   private readonly plugin: Plugin;
-  private messageSchemaValidator: ValidateFunction;
+  private messageSchemaValidatorV1: ValidateFunction;
+  private messageSchemaValidatorV2: ValidateFunction;
   private requestValidators: Map<string, ValidateFunction>;
   private responseValidators: Map<string, ValidateFunction>;
 
@@ -71,7 +74,9 @@ export class MessageHandler {
     this.ajv.addSchema(ResourceSchema);
     this.plugin = plugin;
 
-    this.messageSchemaValidator = this.ajv.compile(IpcMessageSchema);
+    this.messageSchemaValidatorV1 = this.ajv.compile(IpcMessageSchema);
+    this.messageSchemaValidatorV2 = this.ajv.compile(IpcMessageV2Schema);
+
     this.requestValidators = new Map(
       Object.entries(SupportedRequests)
         .map(([k, v]) => [k, this.ajv.compile(v.requestValidator)])
@@ -84,8 +89,8 @@ export class MessageHandler {
 
   async onMessage(message: unknown): Promise<void> {
     try {
-      if (!this.validateMessage(message)) {
-        throw new Error(`Plugin: ${this.plugin}. Message is malformed: ${JSON.stringify(this.messageSchemaValidator.errors, null, 2)}`);
+      if (!this.validateMessageV2(message) && !this.validateMessage(message)) {
+        throw new Error(`Plugin: ${this.plugin}. Message is malformed: ${JSON.stringify(this.messageSchemaValidatorV1.errors, null, 2)}`);
       }
 
       if (!this.requestValidators.has(message.cmd)) {
@@ -107,6 +112,8 @@ export class MessageHandler {
       process.send!({
         cmd: message.cmd + '_Response',
         data: result,
+        // @ts-expect-error TS2239
+        requestId: message.requestId || undefined,
         status: MessageStatus.SUCCESS,
       })
 
@@ -116,7 +123,11 @@ export class MessageHandler {
   }
 
   private validateMessage(message: unknown): message is IpcMessage {
-    return this.messageSchemaValidator(message);
+    return this.messageSchemaValidatorV1(message);
+  }
+
+  private validateMessageV2(message: unknown): message is IpcMessageV2 {
+    return this.messageSchemaValidatorV2(message);
   }
 
   private handleErrors(message: unknown, e: Error) {
@@ -128,12 +139,14 @@ export class MessageHandler {
       return;
     }
 
-    // @ts-ignore
+    // @ts-expect-error TS2239
     const cmd = message.cmd + '_Response';
 
     if (e instanceof SudoError) {
       return process.send?.({
         cmd,
+        // @ts-expect-error TS2239
+        requestId: message.requestId || undefined,
         data: `Plugin: '${this.plugin.name}'. Forbidden usage of sudo for command '${e.command}'. Please contact the plugin developer to fix this.`,
         status: MessageStatus.ERROR,
       })
@@ -143,6 +156,8 @@ export class MessageHandler {
 
     process.send?.({
       cmd,
+      // @ts-expect-error TS2239
+      requestId: message.requestId || undefined,
       data: isDebug ? e.stack : e.message,
       status: MessageStatus.ERROR,
     })

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

@@ -133,7 +133,7 @@ export class ParsedResourceSettings<T extends StringIndexedObject> implements Re
     });
   }
 
-  get inputTransformations(): Partial<Record<keyof T, (a: unknown) => unknown>> {
+  get inputTransformations(): Partial<Record<keyof T, (a: unknown, parameter: ParameterSetting) => unknown>> {
     return this.getFromCacheOrCreate('inputTransformations', () => {
       if (!this.settings.parameterSettings) {
         return {};
@@ -141,7 +141,7 @@ export class ParsedResourceSettings<T extends StringIndexedObject> implements Re
 
       return Object.fromEntries(
         Object.entries(this.settings.parameterSettings)
-          .filter(([, v]) => resolveParameterTransformFn(v!) !== undefined)
+          .filter(([_, v]) => resolveParameterTransformFn(v!) !== undefined)
           .map(([k, v]) => [k, resolveParameterTransformFn(v!)] as const)
       ) as Record<keyof T, (a: unknown) => unknown>;
     });

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

@@ -401,12 +401,19 @@ describe('Resource tests', () => {
           type: 'version'
         }
       }
+
       override async refresh(desired: any, config: Partial<any>): Promise<any> {
         return null;
       }
-      override async add(valueToAdd: any, plan: Plan<any>): Promise<void> {}
-      override async modify(newValue: any, previousValue: any, plan: Plan<any>): Promise<void> {}
-      override async remove(valueToRemove: any, plan: Plan<any>): Promise<void> {}
+
+      override async add(valueToAdd: any, plan: Plan<any>): Promise<void> {
+      }
+
+      override async modify(newValue: any, previousValue: any, plan: Plan<any>): Promise<void> {
+      }
+
+      override async remove(valueToRemove: any, plan: Plan<any>): Promise<void> {
+      }
     }
 
     const parameter2 = new class extends ArrayStatefulParameter<any, any> {
@@ -420,8 +427,12 @@ describe('Resource tests', () => {
       override async refresh(desired: any[] | null, config: Partial<any>): Promise<any[] | null> {
         return null;
       }
-      override async addItem(item: any, plan: Plan<any>): Promise<void> {}
-      override async removeItem(item: any, plan: Plan<any>): Promise<void> {}
+
+      override async addItem(item: any, plan: Plan<any>): Promise<void> {
+      }
+
+      override async removeItem(item: any, plan: Plan<any>): Promise<void> {
+      }
     }
 
     const p1Spy = spy(parameter1);
@@ -471,8 +482,12 @@ describe('Resource tests', () => {
       async refresh(desired: any[] | null, config: Partial<any>): Promise<any[] | null> {
         return ['20']
       }
-      async addItem(item: any, plan: Plan<any>): Promise<void> {}
-      async removeItem(item: any, plan: Plan<any>): Promise<void> {}
+
+      async addItem(item: any, plan: Plan<any>): Promise<void> {
+      }
+
+      async removeItem(item: any, plan: Plan<any>): Promise<void> {
+      }
     })
 
     const resource = new class extends TestResource {

package/src/resource/resource-controller.ts

@@ -318,7 +318,7 @@ ${JSON.stringify(refresh, null, 2)}
         continue;
       }
 
-      (config as Record<string, unknown>)[key] = await inputTransformation(config[key]);
+      (config as Record<string, unknown>)[key] = await inputTransformation(config[key], this.settings.parameterSettings![key]!);
     }
 
     if (this.settings.inputTransformation) {

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

@@ -818,4 +818,122 @@ describe('Resource parameter tests', () => {
       operation: ResourceOperation.RECREATE,
     })
   });
+
+  it('Transforms input parameters', async () => {
+    const resource = new class extends TestResource {
+      getSettings(): ResourceSettings<TestConfig> {
+        return {
+          id: 'resourceType',
+          parameterSettings: {
+            propD: {
+              type: 'array',
+              inputTransformation: (hosts: Record<string, unknown>[]) => hosts.map((h) => Object.fromEntries(
+                  Object.entries(h)
+                    .map(([k, v]) => [
+                      k,
+                      typeof v === 'boolean'
+                        ? (v ? 'yes' : 'no') // The file takes 'yes' or 'no' instead of booleans
+                        : v,
+                    ])
+                )
+              )
+            }
+          }
+        }
+      }
+
+      async refresh(parameters: Partial<TestConfig>): Promise<Partial<TestConfig> | null> {
+        expect(parameters.propD[0].AddKeysToAgent).to.eq('yes')
+        expect(parameters.propD[1].AddKeysToAgent).to.eq('yes')
+        expect(parameters.propD[1].UseKeychain).to.eq('yes')
+        expect(parameters.propD[2].PasswordAuthentication).to.eq('yes')
+
+        return null;
+      }
+    }
+
+    const controller = new ResourceController(resource);
+    await controller.plan({
+      type: 'resourceType',
+      propD: [
+        {
+          Host: 'new.com',
+          AddKeysToAgent: true,
+          IdentityFile: 'id_ed25519'
+        },
+        {
+          Host: 'github.com',
+          AddKeysToAgent: true,
+          UseKeychain: true,
+        },
+        {
+          Match: 'User bob,joe,phil',
+          PasswordAuthentication: true,
+        }
+      ]
+    });
+
+  })
+
+  it('Transforms input parameters for stateful parameters', async () => {
+    const sp = new class extends TestStatefulParameter {
+      getSettings(): ResourceSettings<TestConfig> {
+        return {
+          type: 'array',
+          inputTransformation: (hosts: Record<string, unknown>[]) => hosts.map((h) => Object.fromEntries(
+              Object.entries(h)
+                .map(([k, v]) => [
+                  k,
+                  typeof v === 'boolean'
+                    ? (v ? 'yes' : 'no') // The file takes 'yes' or 'no' instead of booleans
+                    : v,
+                ])
+            )
+          )
+        }
+      }
+
+      async refresh(desired: any): Promise<Partial<TestConfig> | null> {
+        expect(desired[0].AddKeysToAgent).to.eq('yes')
+        expect(desired[1].AddKeysToAgent).to.eq('yes')
+        expect(desired[1].UseKeychain).to.eq('yes')
+        expect(desired[2].PasswordAuthentication).to.eq('yes')
+
+        return null;
+      }
+    }
+
+    const resource = new class extends TestResource {
+      getSettings(): ResourceSettings<TestConfig> {
+        return {
+          id: 'resourceType',
+          parameterSettings: {
+            propD: { type: 'stateful', definition: sp }
+          }
+        }
+      }
+    }
+
+    const controller = new ResourceController(resource);
+    await controller.plan({
+      type: 'resourceType',
+      propD: [
+        {
+          Host: 'new.com',
+          AddKeysToAgent: true,
+          IdentityFile: 'id_ed25519'
+        },
+        {
+          Host: 'github.com',
+          AddKeysToAgent: true,
+          UseKeychain: true,
+        },
+        {
+          Match: 'User bob,joe,phil',
+          PasswordAuthentication: true,
+        }
+      ]
+    });
+
+  })
 })

package/src/resource/resource-settings.ts

@@ -303,13 +303,19 @@ export function resolveFnFromEqualsFnOrString(
   return fnOrString as ((a: unknown, b: unknown) => boolean) | undefined;
 }
 
-const ParameterTransformationDefaults: Partial<Record<ParameterSettingType, (input: any) => Promise<any> | any>> = {
+const ParameterTransformationDefaults: Partial<Record<ParameterSettingType, (input: any, parameter: ParameterSetting) => Promise<any> | any>> = {
   'directory': (a: unknown) => path.resolve(untildify(String(a))),
+  'stateful': (a: unknown, b: ParameterSetting) => {
+    const sp = b as StatefulParameterSetting;
+    return (sp.definition?.getSettings()?.inputTransformation)
+      ? (sp.definition.getSettings().inputTransformation!(a))
+      : a;
+  },
   'string': String,
 }
 
 export function resolveParameterTransformFn(
   parameter: ParameterSetting
-): ((input: any) => Promise<any> | any) | undefined {
+): ((input: any, parameter: ParameterSetting) => Promise<any> | any) | undefined {
   return parameter.inputTransformation ?? ParameterTransformationDefaults[parameter.type as ParameterSettingType] ?? undefined;
 }

package/src/utils/utils.ts

@@ -114,6 +114,10 @@ export function areArraysEqual(
   desired: unknown,
   current: unknown
 ): boolean {
+  if (!desired || !current) {
+    return false;
+  }
+
   if (!Array.isArray(desired) || !Array.isArray(current)) {
     throw new Error(`A non-array value: