feat: Added refresh context

Author: kevinwang5658

src/resource/resource-controller.test.ts

@@ -746,4 +746,51 @@ describe('Resource tests', () => {
       }
     })
   })
+
+  it('Can plan with settings', async () => {
+    const resource = new class extends TestResource {
+      getSettings(): ResourceSettings<any> {
+        return {
+          id: 'path',
+          parameterSettings: {
+            path: { type: 'string', isEqual: 'directory' },
+            paths: { canModify: true, type: 'array', isElementEqual: 'directory' },
+            prepend: { default: false, setting: true },
+            declarationsOnly: { default: false, setting: true },
+          },
+          importAndDestroy: {
+            refreshKeys: ['paths', 'declarationsOnly'],
+            defaultRefreshValues: {
+              paths: [],
+              declarationsOnly: true,
+            }
+          },
+          allowMultiple: {
+            matcher: (desired, current) => {
+              // console.log('Matcher');
+              // console.log(desired);
+              // console.log(current);
+
+              if (desired.path) {
+                return desired.path === current.path;
+              }
+
+              const currentPaths = new Set(current.paths)
+              return desired.paths?.some((p) => currentPaths.has(p));
+            }
+          }
+        }
+      }
+
+      async refresh(parameters: Partial<TestConfig>): Promise<Partial<TestConfig> | null> {
+        return { path: '$HOME/.bun/bin', prepend: false, declarationsOnly: false }
+      }
+    }
+
+    const controller = new ResourceController(resource);
+    const plan = await controller.plan({ type: 'path' }, { path: '$HOME/.bun/bin' }, null, false);
+
+    expect(plan.requiresChanges()).to.be.false;
+    console.log(JSON.stringify(plan, null, 2));
+  })
 });

src/resource/resource-controller.ts

@@ -13,7 +13,7 @@ import { Plan } from '../plan/plan.js';
 import { CreatePlan, DestroyPlan, ModifyPlan } from '../plan/plan-types.js';
 import { ConfigParser } from './config-parser.js';
 import { ParsedResourceSettings } from './parsed-resource-settings.js';
-import { Resource } from './resource.js';
+import { RefreshContext, Resource } from './resource.js';
 import { ResourceSettings } from './resource-settings.js';
 
 export class ResourceController<T extends StringIndexedObject> {
@@ -151,6 +151,11 @@ export class ResourceController<T extends StringIndexedObject> {
     isStateful = false,
   ): Promise<Plan<T>> {
     this.validatePlanInputs(core, desired, state, isStateful);
+    const context: RefreshContext<T> = {
+      commandType: 'plan',
+      isStateful,
+      originalDesiredConfig: structuredClone(desired),
+    };
 
     this.addDefaultValues(desired);
     await this.applyTransformParameters(desired);
@@ -167,7 +172,7 @@ export class ResourceController<T extends StringIndexedObject> {
     } = parsedConfig;
 
     // Refresh resource parameters. This refreshes the parameters that configure the resource itself
-    const currentArray = await this.refreshNonStatefulParameters(allNonStatefulParameters);
+    const currentArray = await this.refreshNonStatefulParameters(allNonStatefulParameters, context);
 
     // Short circuit here. If the resource is non-existent, there's no point checking stateful parameters
     if (currentArray === null
@@ -259,6 +264,12 @@ export class ResourceController<T extends StringIndexedObject> {
       throw new Error(`Type: ${this.typeId} cannot be imported`);
     }
 
+    const context: RefreshContext<T> = {
+      commandType: 'import',
+      isStateful: true,
+      originalDesiredConfig: structuredClone(parameters),
+    };
+
     this.addDefaultValues(parameters);
     await this.applyTransformParameters(parameters);
 
@@ -287,7 +298,7 @@ export class ResourceController<T extends StringIndexedObject> {
       allStatefulParameters,
     } = parsedConfig;
 
-    const currentParametersArray = await this.refreshNonStatefulParameters(allNonStatefulParameters);
+    const currentParametersArray = await this.refreshNonStatefulParameters(allNonStatefulParameters, context);
 
     if (currentParametersArray === null
       || currentParametersArray === undefined
@@ -434,8 +445,8 @@ ${JSON.stringify(refresh, null, 2)}
 
   }
 
-  private async refreshNonStatefulParameters(resourceParameters: Partial<T>): Promise<Array<Partial<T>> | null> {
-    const result = await this.resource.refresh(resourceParameters);
+  private async refreshNonStatefulParameters(resourceParameters: Partial<T>, context: RefreshContext<T>): Promise<Array<Partial<T>> | null> {
+    const result = await this.resource.refresh(resourceParameters, context);
 
     const currentParametersArray = Array.isArray(result) || result === null
       ? result

src/resource/resource.ts

@@ -4,6 +4,12 @@ import { ParameterChange } from '../plan/change-set.js';
 import { CreatePlan, DestroyPlan, ModifyPlan } from '../plan/plan-types.js';
 import { ResourceSettings } from './resource-settings.js';
 
+export interface RefreshContext<T extends StringIndexedObject> {
+  isStateful: boolean;
+  commandType: 'destroy' | 'import' | 'plan';
+  originalDesiredConfig: Partial<T> | null;
+}
+
 /**
  * A resource represents an object on the system (application, CLI tool, or setting)
  * that has state and can be created and destroyed. Examples of resources include CLI tools
@@ -73,10 +79,12 @@ export abstract class Resource<T extends StringIndexedObject> {
    * of the desired config. In stateful mode, this will be parameters of the state config + the desired
    * config of any new parameters.
    *
+   * @param context Context surrounding the request
+   *
    * @return A config or an array of configs representing the status of the resource on the
    * system currently
    */
-  abstract refresh(parameters: Partial<T>): Promise<Array<Partial<T>> | Partial<T> | null>;
+  abstract refresh(parameters: Partial<T>, context: RefreshContext<T>): Promise<Array<Partial<T>> | Partial<T> | null>;
 
   /**
    * Create the resource (install) based on the parameters passed in. Only the desired parameters will