codify-plugin-lib 1.0.128 → 1.0.130

package/src/resource/config-parser.ts

@@ -1,16 +1,15 @@
-import { ResourceConfig, StringIndexedObject } from 'codify-schemas';
+import { StringIndexedObject } from 'codify-schemas';
 
 import { StatefulParameterController } from '../stateful-parameter/stateful-parameter-controller.js';
-import { splitUserConfig } from '../utils/utils.js';
 
 export class ConfigParser<T extends StringIndexedObject> {
-  private readonly desiredConfig: Partial<T> & ResourceConfig | null;
-  private readonly stateConfig: Partial<T> & ResourceConfig | null;
+  private readonly desiredConfig: Partial<T> | null;
+  private readonly stateConfig: Partial<T> | null;
   private statefulParametersMap: Map<keyof T, StatefulParameterController<T, T[keyof T]>>;
 
   constructor(
-    desiredConfig: Partial<T> & ResourceConfig | null,
-    stateConfig: Partial<T> & ResourceConfig | null,
+    desiredConfig: Partial<T> | null,
+    stateConfig: Partial<T> | null,
     statefulParameters: Map<keyof T, StatefulParameterController<T, T[keyof T]>>,
   ) {
     this.desiredConfig = desiredConfig;
@@ -18,42 +17,8 @@ export class ConfigParser<T extends StringIndexedObject> {
     this.statefulParametersMap = statefulParameters;
   }
 
-  get coreParameters(): ResourceConfig {
-    const desiredCoreParameters = this.desiredConfig ? splitUserConfig(this.desiredConfig).coreParameters : undefined;
-    const currentCoreParameters = this.stateConfig ? splitUserConfig(this.stateConfig).coreParameters : undefined;
-
-    if (!desiredCoreParameters && !currentCoreParameters) {
-      throw new Error(`Unable to parse resource core parameters from:
-       
- Desired: ${JSON.stringify(this.desiredConfig, null, 2)}
-  
- Current: ${JSON.stringify(this.stateConfig, null, 2)}`)
-    }
-
-    return desiredCoreParameters ?? currentCoreParameters!;
-  }
-
-  get desiredParameters(): Partial<T> | null {
-    if (!this.desiredConfig) {
-      return null;
-    }
-
-    const { parameters } = splitUserConfig(this.desiredConfig);
-    return parameters;
-  }
-
-  get stateParameters(): Partial<T> | null {
-    if (!this.stateConfig) {
-      return null;
-    }
-
-    const { parameters } = splitUserConfig(this.stateConfig);
-    return parameters;
-  }
-
-
   get allParameters(): Partial<T> {
-    return { ...this.desiredParameters, ...this.stateParameters } as Partial<T>;
+    return { ...this.desiredConfig, ...this.stateConfig } as Partial<T>;
   }
 
   get allNonStatefulParameters(): Partial<T> {

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

@@ -19,9 +19,9 @@ describe('Resource tests for stateful plans', () => {
 
     const controller = new ResourceController(resource);
     const plan = await controller.plan(
+      { type: 'type' },
       null,
       {
-        type: 'type',
         propA: 'propA',
         propB: 10,
         propC: 'propC',
@@ -67,8 +67,8 @@ describe('Resource tests for stateful plans', () => {
 
     const controller = new ResourceController(resource);
     const plan = await controller.plan(
+      { type: 'resource' },
       {
-        type: 'resource',
         propA: 'propA',
         propB: 10,
         propC: 'propC',
@@ -119,6 +119,7 @@ describe('Resource tests for stateful plans', () => {
 
     const controller = new ResourceController(resource)
     const plan = await controller.plan(
+      { type: 'type' },
       {
         type: 'type',
         propA: 'propA',
@@ -191,15 +192,14 @@ describe('Resource tests for stateful plans', () => {
 
     const controller = new ResourceController(resource);
     const plan = await controller.plan(
+      { type: 'type' },
       {
-        type: 'type',
         propA: 'propA',
         propB: 10,
         propC: 'propC',
         propD: 'propD'
       },
       {
-        type: 'type',
         propA: 'propA',
         propC: 'propC'
       },

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

@@ -34,11 +34,14 @@ describe('Resource tests', () => {
     }
 
     const controller = new ResourceController(resource);
-    await controller.validate({
-      type: 'type',
-      propA: '~/.tool_versions',
-      propB: 10,
-    })
+    await controller.validate(
+      { type: 'type' },
+      {
+        type: 'type',
+        propA: '~/.tool_versions',
+        propB: 10,
+      }
+    )
   })
 
   it('Plans successfully', async () => {
@@ -55,16 +58,17 @@ describe('Resource tests', () => {
     const controller = new ResourceController(resource)
 
     const resourceSpy = spy(controller);
-    const result = await resourceSpy.plan({
-      type: 'type',
-      name: 'name',
-      propA: 'propA',
-      propB: 10,
-    })
+    const result = await resourceSpy.plan(
+      { type: 'type', name: 'name' },
+      {
+        propA: 'propA',
+        propB: 10,
+      },
+      null,
+      false,
+    )
 
     expect(result.desiredConfig).to.deep.eq({
-      type: 'type',
-      name: 'name',
       propA: 'propA',
       propB: 10,
     });
@@ -92,15 +96,16 @@ describe('Resource tests', () => {
     const controller = new ResourceController(resource);
 
     const resourceSpy = spy(controller);
-    const result = await resourceSpy.plan({
-      type: 'type',
-      name: 'name',
-      propA: 'propA',
-      propB: 10,
-      propC: 'somethingAfter'
-    })
-
-    console.log(result.changeSet.parameterChanges)
+    const result = await resourceSpy.plan(
+      { type: 'type', name: 'name' },
+      {
+        propA: 'propA',
+        propB: 10,
+        propC: 'somethingAfter'
+      },
+      null,
+      false,
+    )
 
     expect(result.changeSet.operation).to.eq(ResourceOperation.CREATE);
     expect(result.changeSet.parameterChanges.length).to.eq(3);
@@ -115,7 +120,12 @@ describe('Resource tests', () => {
     const controller = new ResourceController(resource);
 
     const resourceSpy = spy(controller);
-    const result = await resourceSpy.plan({ type: 'type' })
+    const result = await resourceSpy.plan(
+      { type: 'type' },
+      {},
+      null,
+      false
+    )
 
     expect(result.changeSet.operation).to.eq(ResourceOperation.CREATE);
     expect(result.changeSet.parameterChanges.length).to.eq(0);
@@ -150,7 +160,7 @@ describe('Resource tests', () => {
       testPlan({
         current: [{ propA: 'a', propB: 0 }],
         state: { propA: 'a', propB: 0 },
-        statefulMode: true,
+        isStateful: true,
       })
     )
 
@@ -169,7 +179,7 @@ describe('Resource tests', () => {
       testPlan({
         desired: { propA: 'a', propB: 0 },
         current: [{ propA: 'b', propB: -1 }],
-        statefulMode: true
+        isStateful: true
       })
     );
 
@@ -195,7 +205,12 @@ describe('Resource tests', () => {
     }
     const controller = new ResourceController(resource);
 
-    const plan = await controller.plan({ type: 'resource', propA: 'a', propB: 0 })
+    const plan = await controller.plan(
+      { type: 'resource' },
+      { propA: 'a', propB: 0 },
+      null,
+      false,
+    )
 
     const resourceSpy = spy(resource);
     await controller.apply(
@@ -267,7 +282,7 @@ describe('Resource tests', () => {
     }
     const controller = new ResourceController(resource);
 
-    const plan = await controller.plan({ type: 'resource' })
+    const plan = await controller.plan({ type: 'resource' }, {}, null, false)
     expect(plan.currentConfig?.propA).to.eq('propAAfter');
     expect(plan.desiredConfig?.propA).to.eq('propADefault');
     expect(plan.changeSet.operation).to.eq(ResourceOperation.RECREATE);
@@ -294,7 +309,7 @@ describe('Resource tests', () => {
     }
     const controller = new ResourceController(resource);
 
-    const plan = await controller.plan({ type: 'resource' })
+    const plan = await controller.plan({ type: 'resource' }, {}, null, false)
     expect(plan.currentConfig?.propE).to.eq('propEDefault');
     expect(plan.desiredConfig?.propE).to.eq('propEDefault');
     expect(plan.changeSet.operation).to.eq(ResourceOperation.NOOP);
@@ -317,7 +332,7 @@ describe('Resource tests', () => {
     }
     const controller = new ResourceController(resource);
 
-    const plan = await controller.plan({ type: 'resource' })
+    const plan = await controller.plan({ type: 'resource' }, {}, null, false)
     expect(plan.currentConfig).to.be.null
     expect(plan.desiredConfig!.propE).to.eq('propEDefault');
     expect(plan.changeSet.operation).to.eq(ResourceOperation.CREATE);
@@ -345,7 +360,7 @@ describe('Resource tests', () => {
     }
     const controller = new ResourceController(resource);
 
-    const plan = await controller.plan({ type: 'resource', propA: 'propA' })
+    const plan = await controller.plan({ type: 'resource' }, { propA: 'propA' }, null, false)
     expect(plan.currentConfig?.propA).to.eq('propAAfter');
     expect(plan.desiredConfig?.propA).to.eq('propA');
     expect(plan.changeSet.operation).to.eq(ResourceOperation.RECREATE);
@@ -455,7 +470,7 @@ describe('Resource tests', () => {
     }
 
     const controller = new ResourceController(resource);
-    const plan = await controller.plan({ type: 'nvm', global: '20.12', nodeVersions: ['18', '20'] })
+    const plan = await controller.plan({ type: 'nvm' }, { global: '20.12', nodeVersions: ['18', '20'] }, null, false)
 
     expect(plan).toMatchObject({
       changeSet: {
@@ -507,7 +522,7 @@ describe('Resource tests', () => {
     }
 
     const controller = new ResourceController(resource);
-    const plan = await controller.plan({ type: 'nvm', global: '20.12', nodeVersions: ['18', '20'] })
+    const plan = await controller.plan({ type: 'nvm' }, { global: '20.12', nodeVersions: ['18', '20'] }, null, false)
 
     expect(plan).toMatchObject({
       changeSet: {

package/src/resource/resource-controller.ts

@@ -2,6 +2,7 @@ import { Ajv, ValidateFunction } from 'ajv';
 import {
   ParameterOperation,
   ResourceConfig,
+  ResourceJson,
   ResourceOperation,
   StringIndexedObject,
   ValidateResponseData
@@ -10,7 +11,6 @@ import {
 import { ParameterChange } from '../plan/change-set.js';
 import { Plan } from '../plan/plan.js';
 import { CreatePlan, DestroyPlan, ModifyPlan } from '../plan/plan-types.js';
-import { splitUserConfig } from '../utils/utils.js';
 import { ConfigParser } from './config-parser.js';
 import { ParsedResourceSettings } from './parsed-resource-settings.js';
 import { Resource } from './resource.js';
@@ -54,23 +54,21 @@ export class ResourceController<T extends StringIndexedObject> {
   }
 
   async validate(
-    desiredConfig: Partial<T> & ResourceConfig,
+    core: ResourceConfig,
+    parameters: Partial<T>,
   ): Promise<ValidateResponseData['resourceValidations'][0]> {
-    const configToValidate = { ...desiredConfig };
-    await this.applyTransformParameters(configToValidate);
-
-    const { parameters, coreParameters } = splitUserConfig(configToValidate);
+    await this.applyTransformParameters(parameters);
     this.addDefaultValues(parameters);
 
     if (this.schemaValidator) {
       // Schema validator uses pre transformation parameters
-      const isValid = this.schemaValidator(splitUserConfig(desiredConfig).parameters);
+      const isValid = this.schemaValidator(parameters);
 
       if (!isValid) {
         return {
           isValid: false,
-          resourceName: coreParameters.name,
-          resourceType: coreParameters.type,
+          resourceName: core.name,
+          resourceType: core.type,
           schemaValidationErrors: this.schemaValidator?.errors ?? [],
         }
       }
@@ -89,61 +87,59 @@ export class ResourceController<T extends StringIndexedObject> {
       return {
         customValidationErrorMessage,
         isValid: false,
-        resourceName: coreParameters.name,
-        resourceType: coreParameters.type,
+        resourceName: core.name,
+        resourceType: core.type,
         schemaValidationErrors: this.schemaValidator?.errors ?? [],
       }
     }
 
     return {
       isValid: true,
-      resourceName: coreParameters.name,
-      resourceType: coreParameters.type,
+      resourceName: core.name,
+      resourceType: core.type,
       schemaValidationErrors: [],
     }
   }
 
   async plan(
-    desiredConfig: Partial<T> & ResourceConfig | null,
-    stateConfig: Partial<T> & ResourceConfig | null = null,
-    statefulMode = false,
+    core: ResourceConfig,
+    desired: Partial<T> | null,
+    state: Partial<T> | null,
+    isStateful = false,
   ): Promise<Plan<T>> {
-    this.validatePlanInputs(desiredConfig, stateConfig, statefulMode);
+    this.validatePlanInputs(core, desired, state, isStateful);
 
-    this.addDefaultValues(desiredConfig);
-    await this.applyTransformParameters(desiredConfig);
+    this.addDefaultValues(desired);
+    await this.applyTransformParameters(desired);
 
-    this.addDefaultValues(stateConfig);
-    await this.applyTransformParameters(stateConfig);
+    this.addDefaultValues(state);
+    await this.applyTransformParameters(state);
 
     // Parse data from the user supplied config
-    const parsedConfig = new ConfigParser(desiredConfig, stateConfig, this.parsedSettings.statefulParameters)
+    const parsedConfig = new ConfigParser(desired, state, this.parsedSettings.statefulParameters)
     const {
-      coreParameters,
-      desiredParameters,
-      stateParameters,
       allParameters,
       allNonStatefulParameters,
       allStatefulParameters,
     } = parsedConfig;
 
     // Refresh resource parameters. This refreshes the parameters that configure the resource itself
-    const currentParametersArray = await this.refreshNonStatefulParameters(allNonStatefulParameters);
+    const currentArray = await this.refreshNonStatefulParameters(allNonStatefulParameters);
 
     // Short circuit here. If the resource is non-existent, there's no point checking stateful parameters
-    if (currentParametersArray === null
-      || currentParametersArray === undefined
+    if (currentArray === null
+      || currentArray === undefined
       || this.settings.allowMultiple // Stateful parameters are not supported currently if allowMultiple is true
-      || currentParametersArray.length === 0
-      || currentParametersArray.filter(Boolean).length === 0
+      || currentArray.length === 0
+      || currentArray.filter(Boolean).length === 0
     ) {
       return Plan.calculate({
-        desiredParameters,
-        currentParametersArray,
-        stateParameters,
-        coreParameters,
+        desired,
+        currentArray,
+        state,
+        core,
         settings: this.parsedSettings,
-        statefulMode,
+        isStateful,
       });
     }
 
@@ -152,12 +148,12 @@ export class ResourceController<T extends StringIndexedObject> {
     const statefulCurrentParameters = await this.refreshStatefulParameters(allStatefulParameters, allParameters);
 
     return Plan.calculate({
-      desiredParameters,
-      currentParametersArray: [{ ...currentParametersArray[0], ...statefulCurrentParameters }] as Partial<T>[],
-      stateParameters,
-      coreParameters,
+      desired,
+      currentArray: [{ ...currentArray[0], ...statefulCurrentParameters }] as Partial<T>[],
+      state,
+      core,
       settings: this.parsedSettings,
-      statefulMode
+      isStateful
     })
   }
 
@@ -186,9 +182,12 @@ export class ResourceController<T extends StringIndexedObject> {
     }
   }
 
-  async import(config: Partial<T> & ResourceConfig): Promise<(Partial<T> & ResourceConfig)[] | null> {
-    this.addDefaultValues(config);
-    await this.applyTransformParameters(config);
+  async import(
+    core: ResourceConfig,
+    parameters: Partial<T>
+  ): Promise<Array<ResourceJson> | null> {
+    this.addDefaultValues(parameters);
+    await this.applyTransformParameters(parameters);
 
     // Use refresh parameters if specified, otherwise try to refresh as many parameters as possible here
     const parametersToRefresh = this.settings.import?.refreshKeys
@@ -197,14 +196,14 @@ export class ResourceController<T extends StringIndexedObject> {
           this.settings.import?.refreshKeys.map((k) => [k, null])
         ),
         ...this.settings.import?.defaultRefreshValues,
-        ...config,
+        ...parameters,
       }
       : {
         ...Object.fromEntries(
           this.getAllParameterKeys().map((k) => [k, null])
         ),
         ...this.settings.import?.defaultRefreshValues,
-        ...config,
+        ...parameters,
       };
 
     // Parse data from the user supplied config
@@ -212,7 +211,6 @@ export class ResourceController<T extends StringIndexedObject> {
     const {
       allNonStatefulParameters,
       allStatefulParameters,
-      coreParameters,
     } = parsedConfig;
 
     const currentParametersArray = await this.refreshNonStatefulParameters(allNonStatefulParameters);
@@ -220,16 +218,15 @@ export class ResourceController<T extends StringIndexedObject> {
     if (currentParametersArray === null
       || currentParametersArray === undefined
       || this.settings.allowMultiple // Stateful parameters are not supported currently if allowMultiple is true
-      || currentParametersArray.length === 0
       || currentParametersArray.filter(Boolean).length === 0
     ) {
       return currentParametersArray
-          ?.map((r) => ({ ...coreParameters, ...r }))
+          ?.map((r) => ({ core, parameters: r }))
         ?? null;
     }
 
     const statefulCurrentParameters = await this.refreshStatefulParameters(allStatefulParameters, parametersToRefresh);
-    return [{ ...coreParameters, ...currentParametersArray[0], ...statefulCurrentParameters }];
+    return [{ core, parameters: { ...currentParametersArray[0], ...statefulCurrentParameters } }];
   }
 
   private async applyCreate(plan: Plan<T>): Promise<void> {
@@ -308,7 +305,7 @@ ${JSON.stringify(refresh, null, 2)}
     }
   }
 
-  private async applyTransformParameters(config: Partial<T> & ResourceConfig | null): Promise<void> {
+  private async applyTransformParameters(config: Partial<T> | null): Promise<void> {
     if (!config) {
       return;
     }
@@ -322,11 +319,9 @@ ${JSON.stringify(refresh, null, 2)}
     }
 
     if (this.settings.inputTransformation) {
-      const { parameters, coreParameters } = splitUserConfig(config);
-
-      const transformed = await this.settings.inputTransformation(parameters)
+      const transformed = await this.settings.inputTransformation({ ...config })
       Object.keys(config).forEach((k) => delete config[k])
-      Object.assign(config, transformed, coreParameters);
+      Object.assign(config, transformed);
     }
   }
 
@@ -375,15 +370,20 @@ ${JSON.stringify(refresh, null, 2)}
   }
 
   private validatePlanInputs(
-    desired: Partial<T> & ResourceConfig | null,
-    current: Partial<T> & ResourceConfig | null,
-    statefulMode: boolean,
+    core: ResourceConfig,
+    desired: Partial<T> | null,
+    current: Partial<T> | null,
+    isStateful: boolean,
   ) {
+    if (!core || !core.type) {
+      throw new Error('Core parameters type must be defined');
+    }
+
     if (!desired && !current) {
       throw new Error('Desired config and current config cannot both be missing')
     }
 
-    if (!statefulMode && !desired) {
+    if (!isStateful && !desired) {
       throw new Error('Desired config must be provided in non-stateful mode')
     }
   }