Added desired values to the refresh methods. This allows plugins to refresh the current value instead of returning everything on the system.

Author: kevinwang5658

package.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-plugin-lib",
-  "version": "1.0.46",
+  "version": "1.0.47",
   "description": "",
   "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.32",
+    "codify-schemas": "1.0.33",
     "@npmcli/promise-spawn": "^7.0.1"
   },
   "devDependencies": {

src/entities/resource.ts

@@ -56,22 +56,22 @@ export abstract class Resource<T extends StringIndexedObject> {
 
     // Refresh resource parameters
     // This refreshes the parameters that configure the resource itself
-    const keysToRefresh = new Set(Object.keys(resourceParameters));
-    const currentParameters = await this.refresh(keysToRefresh);
+    const entriesToRefresh = new Map(Object.entries(resourceParameters));
+    const currentParameters = await this.refresh(entriesToRefresh);
 
     // Short circuit here. If resource is non-existent, then there's no point checking stateful parameters
     if (currentParameters == null) {
       return Plan.create(desiredParameters, null, resourceMetadata, planConfiguration);
     }
 
-    this.validateRefreshResults(currentParameters, keysToRefresh);
+    this.validateRefreshResults(currentParameters, entriesToRefresh);
 
     // Refresh stateful parameters
     // This refreshes parameters that are stateful (they can be added, deleted separately from the resource)
     for(const statefulParameter of statefulParameters) {
       const desiredValue = desiredParameters[statefulParameter.name];
 
-      let currentValue = await statefulParameter.refresh() ?? undefined;
+      let currentValue = await statefulParameter.refresh(desiredValue ?? null) ?? undefined;
 
       // In stateless mode, filter the refreshed parameters by the desired to ensure that no deletes happen
       if (Array.isArray(currentValue)
@@ -224,11 +224,12 @@ export abstract class Resource<T extends StringIndexedObject> {
 
   }
 
-  private validateRefreshResults(refresh: Partial<T> | null, desiredKeys: Set<keyof T>) {
+  private validateRefreshResults(refresh: Partial<T> | null, desiredMap: Map<keyof T, T[keyof T]>) {
     if (!refresh) {
       return;
     }
 
+    const desiredKeys = new Set<keyof T>(desiredMap.keys());
     const refreshKeys = new Set(Object.keys(refresh)) as Set<keyof T>;
 
     if (!setsEqual(desiredKeys, refreshKeys)) {
@@ -243,7 +244,7 @@ Additional: ${[...refreshKeys].filter(k => !desiredKeys.has(k))};`
 
   abstract validate(parameters: unknown): Promise<ValidationResult>;
 
-  abstract refresh(keys: Set<keyof T>): Promise<Partial<T> | null>;
+  abstract refresh(keys: Map<keyof T, T[keyof T]>): Promise<Partial<T> | null>;
 
   abstract applyCreate(plan: Plan<T>): Promise<void>;
 

src/entities/stateful-parameter.ts

@@ -32,7 +32,7 @@ export abstract class StatefulParameter<T extends StringIndexedObject, V extends
     this.configuration = configuration
   }
 
-  abstract refresh(): Promise<V | null>;
+  abstract refresh(desired: V | null): Promise<V | null>;
 
   // TODO: Add an additional parameter here for what has actually changed.
   abstract applyAdd(valueToAdd: V, plan: Plan<T>): Promise<void>;
@@ -88,7 +88,7 @@ export abstract class ArrayStatefulParameter<T extends StringIndexedObject, V> e
     }
   }
 
-  abstract refresh(): Promise<V[] | null>;
+  abstract refresh(desired: V[] | null): Promise<V[] | null>;
   abstract applyAddItem(item: V, plan: Plan<T>): Promise<void>;
   abstract applyRemoveItem(item: V, plan: Plan<T>): Promise<void>;
 }