Kevin/import and destroy improvements (#14)

* feat: Added itemType parameter, it's like type but for items of arrays (sets default transformation and isElementEqual fns)

* feat: Changed parameter inputTransformations to have to: and from: so they can be mapped back

* feat: Added required parameters as a default matcher for when multiple resources are returned. Updated vitest

* fix: updated typing for schema

* feat: Used the reverse transformation to alter the import output to match a user's config + added tests

* feat: Added reverse transformation for object level transforms

* feat: Revised how setting parameters are set in the resource config

* feat: Updated to import and destroy and added allow multiple to getResourceInfo

* feat: Updated requiredParameters to identifyingParameters

* feat: Added feature to remove un-necessary default values from imports

* feat: Added matcher request to match multiple requests together

* feat: Bug fixes and improvements

* feat: Allow resources with stateful parameters to allow multple as well

* feat: Updated validation checks to ensure that only one of an element exists if allowMultiple: false

* fix: Fixed bug where certain parameters are not passed to stateful parameters

* fix: Changed error message type for multiple resources found

* fix: Added transformations for matcher.

* feat: Added variable resolution for paths. Changed match length to be greater than 1

* feat: Added refresh context

* fix: Fixed defaultRefreshValue not being used if the parameter has a default value

* feat: Improved transformations by providing the original back in from, that way the user has the option to return the original if they are the same. Added a custom refreshMapper to apply logic for generating the refresh keys

* fix: Pass in the original desired parameter (before transformations) for original. Changed directory to return original element if it matches

* fix: Bug fixes for directory transformations

* fix: Fix array transformation using resolve equals fn instead it should be using elementEqualsFn

* fix: Fix bash history being written

Author: kevinwang5658

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-plugin-lib",
-  "version": "1.0.131",
+  "version": "1.0.166",
   "description": "Library plugin library",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -16,7 +16,7 @@
   "dependencies": {
     "ajv": "^8.12.0",
     "ajv-formats": "^2.1.1",
-    "codify-schemas": "1.0.63",
+    "codify-schemas": "1.0.73",
     "@npmcli/promise-spawn": "^7.0.1",
     "@homebridge/node-pty-prebuilt-multiarch": "^0.12.0-beta.5",
     "uuid": "^10.0.0",
@@ -34,7 +34,7 @@
     "@types/uuid": "^10.0.0",
     "@types/lodash.isequal": "^4.5.8",
     "chai-as-promised": "^7.1.1",
-    "vitest": "^1.4.0",
+    "vitest": "^3.0.5",
     "vitest-mock-extended": "^1.3.1",
     "sinon": "^17.0.1",
     "eslint": "^8.51.0",

package.json

@@ -13,6 +13,8 @@ import {
   IpcMessageSchema,
   IpcMessageV2,
   IpcMessageV2Schema,
+  MatchRequestDataSchema,
+  MatchResponseDataSchema,
   MessageStatus,
   PlanRequestDataSchema,
   PlanResponseDataSchema,
@@ -40,6 +42,11 @@ const SupportedRequests: Record<string, { handler: (plugin: Plugin, data: any) =
     requestValidator: GetResourceInfoRequestDataSchema,
     responseValidator: GetResourceInfoResponseDataSchema
   },
+  'match': {
+    handler: async (plugin: Plugin, data: any) => plugin.match(data),
+    requestValidator: MatchRequestDataSchema,
+    responseValidator: MatchResponseDataSchema
+  },
   'import': {
     handler: async (plugin: Plugin, data: any) => plugin.import(data),
     requestValidator: ImportRequestDataSchema,
@@ -106,7 +113,7 @@ export class MessageHandler {
 
       const responseValidator = this.responseValidators.get(message.cmd);
       if (responseValidator && !responseValidator(result)) {
-        throw new Error(`Plugin: ${this.plugin}. Malformed response data: ${JSON.stringify(responseValidator.errors, null, 2)}`)
+        throw new Error(`Plugin: ${this.plugin.name}. Malformed response data: ${JSON.stringify(responseValidator.errors, null, 2)}. Received ${JSON.stringify(result, null, 2)}`);
       }
 
       process.send!({

src/messages/handlers.ts

@@ -230,6 +230,120 @@ describe('Plan entity tests', () => {
       ])
     })
   })
+
+  it('Can use the requiredParameters to match the correct resources together', async () => {
+    const resource1 = new class extends TestResource {
+      getSettings(): ResourceSettings<TestConfig> {
+        return {
+          id: 'type',
+          parameterSettings: {
+            propA: { type: 'string' },
+            propB: { type: 'string', canModify: true },
+          },
+          allowMultiple: {
+            identifyingParameters: ['propA']
+          }
+        }
+      }
+
+      async refresh(): Promise<Partial<any> | null> {
+        return [{
+          propA: 'same',
+          propB: 'old',
+        }, {
+          propA: 'different',
+          propB: 'different',
+        }]
+      }
+    }
+
+    const controller = new ResourceController(resource1);
+    const plan = await controller.plan(
+      { type: 'type' },
+      { propA: 'same', propB: 'new' },
+      null,
+      false
+    )
+
+    expect(plan.changeSet).toMatchObject({
+      operation: ResourceOperation.MODIFY,
+      parameterChanges: expect.arrayContaining([
+        expect.objectContaining({
+          name: 'propA',
+          previousValue: 'same',
+          newValue: 'same',
+          operation: 'noop'
+        }),
+        expect.objectContaining({
+          name: 'propB',
+          previousValue: 'old',
+          newValue: 'new',
+          operation: 'modify'
+        })
+      ])
+    })
+  })
+
+  it('Can use the schema to determine required parameters for multiple allowed', async () => {
+    const resource1 = new class extends TestResource {
+      getSettings(): ResourceSettings<TestConfig> {
+        return {
+          id: 'type',
+          parameterSettings: {
+            propA: { type: 'string' },
+            propB: { type: 'string', canModify: true },
+          },
+          allowMultiple: true,
+          schema: {
+            '$schema': 'http://json-schema.org/draft-07/schema',
+            '$id': 'https://www.codifycli.com/type.json',
+            'type': 'object',
+            'properties': {
+              propA: { type: 'string' },
+              propB: { type: 'string' }
+            },
+            required: ['propA']
+          }
+        }
+      }
+
+      async refresh(): Promise<Partial<any> | null> {
+        return [{
+          propA: 'same',
+          propB: 'old',
+        }, {
+          propA: 'different',
+          propB: 'different',
+        }]
+      }
+    }
+
+    const controller = new ResourceController(resource1);
+    const plan = await controller.plan(
+      { type: 'type' },
+      { propA: 'same', propB: 'new' },
+      null,
+      false
+    )
+
+    expect(plan.changeSet).toMatchObject({
+      operation: ResourceOperation.MODIFY,
+      parameterChanges: expect.arrayContaining([
+        expect.objectContaining({
+          name: 'propA',
+          previousValue: 'same',
+          newValue: 'same',
+          operation: 'noop'
+        }),
+        expect.objectContaining({
+          name: 'propB',
+          previousValue: 'old',
+          newValue: 'new',
+          operation: 'modify'
+        })
+      ])
+    })
+  })
 })
 
 function createTestResource() {

src/plan/plan.test.ts

@@ -241,7 +241,7 @@ export class Plan<T extends StringIndexedObject> {
     desired: Partial<T> | null,
     currentArray: Partial<T>[] | null,
     state: Partial<T> | null,
-    settings: ResourceSettings<T>,
+    settings: ParsedResourceSettings<T>,
     isStateful: boolean,
   }): Partial<T> | null {
     const {
@@ -260,13 +260,23 @@ export class Plan<T extends StringIndexedObject> {
       return null;
     }
 
+    const { matcher: parameterMatcher, id } = settings;
+    const matcher = (desired: Partial<T>, currentArray: Partial<T>[]): Partial<T> | undefined => {
+      const matched = currentArray.filter((c) => parameterMatcher(desired, c))
+      if (matched.length > 1) {
+        console.log(`Resource: ${id} did not uniquely match resources when allow multiple is set to true`)
+      }
+
+      return matched[0];
+    }
+
     if (isStateful) {
       return state
-        ? settings.allowMultiple.matcher(state, currentArray)
+        ? matcher(state, currentArray) ?? null
         : null
     }
 
-    return settings.allowMultiple.matcher(desired!, currentArray);
+    return matcher(desired!, currentArray) ?? null;
   }
 
   /**
@@ -384,15 +394,15 @@ export class Plan<T extends StringIndexedObject> {
       const defaultFilterMethod = ((desired: any[], current: any[]) => {
         const result = [];
 
-        for (let counter = desiredCopy.length - 1; counter >= 0; counter--) {
-          const idx = currentCopy.findIndex((e2) => matcher(desiredCopy[counter], e2))
+        for (let counter = desired.length - 1; counter >= 0; counter--) {
+          const idx = currentCopy.findIndex((e2) => matcher(desired[counter], e2))
 
           if (idx === -1) {
             continue;
           }
 
-          desiredCopy.splice(counter, 1)
-          const [element] = currentCopy.splice(idx, 1)
+          desired.splice(counter, 1)
+          const [element] = current.splice(idx, 1)
           result.push(element)
         }
 
@@ -413,9 +423,7 @@ export class Plan<T extends StringIndexedObject> {
     return this.changeSet.operation !== ResourceOperation.NOOP;
   }
 
-  /**
-   * Convert the plan to a JSON response object
-   */
+  /** Convert the plan to a JSON response object */
   toResponse(): PlanResponseData {
     return {
       planId: this.id,