codify-plugin-lib 1.0.54 → 1.0.55

package/dist/entities/change-set.d.ts

@@ -20,4 +20,5 @@ export declare class ChangeSet<T extends StringIndexedObject> {
     static isSame(desired: unknown, current: unknown, options?: ParameterOptions): boolean;
     private static calculateStatefulModeChangeSet;
     private static calculateStatelessModeChangeSet;
+    private static addDefaultValues;
 }

package/dist/entities/change-set.js

@@ -61,6 +61,7 @@ export class ChangeSet {
         const parameterChangeSet = new Array();
         const _desired = { ...desired };
         const _current = { ...current };
+        this.addDefaultValues(_desired, parameterOptions);
         for (const [k, v] of Object.entries(_current)) {
             if (_desired[k] == null) {
                 parameterChangeSet.push({
@@ -109,6 +110,7 @@ export class ChangeSet {
         const parameterChangeSet = new Array();
         const _desired = { ...desired };
         const _current = { ...current };
+        this.addDefaultValues(_desired, parameterOptions);
         for (const [k, v] of Object.entries(_desired)) {
             if (_current[k] == null) {
                 parameterChangeSet.push({
@@ -137,4 +139,14 @@ export class ChangeSet {
         }
         return parameterChangeSet;
     }
+    static addDefaultValues(obj, options) {
+        Object.entries(options ?? {})
+            .filter(([, option]) => option.default !== undefined)
+            .map(([name, option]) => [name, option.default])
+            .forEach(([key, defaultValue]) => {
+            if (obj[key] === undefined) {
+                obj[key] = defaultValue;
+            }
+        });
+    }
 }

package/dist/entities/plan-types.d.ts

@@ -3,6 +3,7 @@ export interface ParameterOptions {
     planOperation?: ResourceOperation.MODIFY | ResourceOperation.RECREATE;
     isEqual?: (desired: any, current: any) => boolean;
     isElementEqual?: (desired: any, current: any) => boolean;
+    default?: unknown;
     isStatefulParameter?: boolean;
 }
 export interface PlanOptions<T> {

package/dist/entities/resource.d.ts

@@ -29,7 +29,6 @@ export declare abstract class Resource<T extends StringIndexedObject> {
     private _applyModify;
     private _applyDestroy;
     private validateRefreshResults;
-    private applyDefaultValueToRefreshResults;
     private applyTransformParameters;
     private addDefaultValues;
     private refreshResourceParameters;

package/dist/entities/resource.js

@@ -142,10 +142,8 @@ export class Resource {
         if (!refresh) {
             return;
         }
-        const desiredKeys = new Set([...desiredMap.keys()]
-            .filter((key) => this.defaultValues[key] === undefined));
-        const refreshKeys = new Set([...Object.keys(refresh)]
-            .filter((key) => this.defaultValues[key] === undefined));
+        const desiredKeys = new Set(desiredMap.keys());
+        const refreshKeys = new Set(Object.keys(refresh));
         if (!setsEqual(desiredKeys, refreshKeys)) {
             throw new Error(`Resource ${this.typeId}
 refresh() must return back exactly the keys that were provided
@@ -153,16 +151,6 @@ Missing: ${[...desiredKeys].filter((k) => !refreshKeys.has(k))};
 Additional: ${[...refreshKeys].filter(k => !desiredKeys.has(k))};`);
         }
     }
-    applyDefaultValueToRefreshResults(refresh) {
-        if (!refresh) {
-            return;
-        }
-        for (const [key, defaultValue] of Object.entries(this.defaultValues)) {
-            if (refresh[key] === undefined) {
-                refresh[key] = defaultValue;
-            }
-        }
-    }
     async applyTransformParameters(transformParameters, desired) {
         const orderedEntries = [...Object.entries(transformParameters)]
             .sort(([keyA], [keyB]) => this.transformParameterOrder.get(keyA) - this.transformParameterOrder.get(keyB));
@@ -191,7 +179,6 @@ Additional: ${[...refreshKeys].filter(k => !desiredKeys.has(k))};`);
         const entriesToRefresh = new Map(Object.entries(resourceParameters));
         const currentParameters = await this.refresh(entriesToRefresh);
         this.validateRefreshResults(currentParameters, entriesToRefresh);
-        this.applyDefaultValueToRefreshResults(currentParameters);
         return currentParameters;
     }
     async refreshStatefulParameters(statefulParametersConfig, isStatefulMode) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codify-plugin-lib",
-  "version": "1.0.54",
+  "version": "1.0.55",
   "description": "",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",

package/src/entities/change-set.ts

@@ -126,6 +126,8 @@ export class ChangeSet<T extends StringIndexedObject> {
     const _desired = { ...desired };
     const _current = { ...current };
 
+    this.addDefaultValues(_desired, parameterOptions);
+
     for (const [k, v] of Object.entries(_current)) {
       if (_desired[k] == null) {
         parameterChangeSet.push({
@@ -191,6 +193,8 @@ export class ChangeSet<T extends StringIndexedObject> {
     const _desired = { ...desired };
     const _current = { ...current };
 
+    this.addDefaultValues(_desired, parameterOptions);
+
     for (const [k, v] of Object.entries(_desired)) {
       if (_current[k] == null) {
         parameterChangeSet.push({
@@ -224,5 +228,16 @@ export class ChangeSet<T extends StringIndexedObject> {
 
     return parameterChangeSet;
   }
+
+  private static addDefaultValues<T extends StringIndexedObject>(obj: Record<string, unknown>, options?: Record<keyof T, ParameterOptions>) {
+    Object.entries(options ?? {})
+      .filter(([, option]) => option.default !== undefined)
+      .map(([name, option]) => [name, option.default] as const)
+      .forEach(([key, defaultValue]) => {
+        if (obj[key] === undefined) {
+          obj[key] = defaultValue;
+        }
+      })
+  }
     
 }

package/src/entities/plan-types.ts

@@ -17,6 +17,8 @@ export interface ParameterOptions {
 
   isElementEqual?: (desired: any, current: any) => boolean;
 
+  default?: unknown,
+
   isStatefulParameter?: boolean;
 }
 

package/src/entities/resource-parameters.test.ts

@@ -27,7 +27,7 @@ class TestParameter extends StatefulParameter<TestConfig, string> {
   }
 }
 
-describe('Resource parameters tests', () => {
+describe('Resource parameter tests', () => {
   it('supports the creation of stateful parameters', async () => {
 
     const statefulParameter = new class extends TestParameter {

package/src/entities/resource.test.ts

@@ -26,7 +26,7 @@ export class TestResource extends Resource<TestConfig> {
     return Promise.resolve(undefined);
   }
 
-  async refresh(): Promise<Partial<TestConfig> | null> {
+  async refresh(keys: Map<string, unknown>): Promise<Partial<TestConfig> | null> {
     return {
       propA: 'a',
       propB: 10,
@@ -329,8 +329,12 @@ describe('Resource tests', () => {
         });
       }
 
-      async refresh(): Promise<Partial<TestConfig> | null> {
-        return {};
+      async refresh(keys: Map<string, unknown>): Promise<Partial<TestConfig> | null> {
+        expect(keys.has('propE')).to.be.true;
+
+        return {
+          propE: keys.get('propE'),
+        };
       }
     }
 
@@ -340,6 +344,28 @@ describe('Resource tests', () => {
     expect(plan.changeSet.operation).to.eq(ResourceOperation.NOOP);
   })
 
+  it('Allows default values to be added even when refresh returns null', async () => {
+    const resource = new class extends TestResource {
+      constructor() {
+        super({
+          type: 'type',
+          parameterOptions: {
+            propE: { default: 'propEDefault' }
+          }
+        });
+      }
+
+      async refresh(): Promise<Partial<TestConfig> | null> {
+        return null;
+      }
+    }
+
+    const plan = await resource.plan({ type: 'resource'})
+    expect(plan.currentConfig.propE).to.eq(null);
+    expect(plan.desiredConfig.propE).to.eq('propEDefault');
+    expect(plan.changeSet.operation).to.eq(ResourceOperation.CREATE);
+  })
+
   it('Allows default values to be added (ignore default value if already present)', async () => {
     const resource = new class extends TestResource {
       constructor() {

package/src/entities/resource.ts

@@ -211,15 +211,8 @@ export abstract class Resource<T extends StringIndexedObject> {
       return;
     }
 
-    const desiredKeys = new Set<keyof T>(
-      [...desiredMap.keys()]
-        .filter((key) => this.defaultValues[key] === undefined)
-    );
-
-    const refreshKeys = new Set(
-      [...Object.keys(refresh)]
-        .filter((key) => this.defaultValues[key] === undefined)
-    ) as Set<keyof T>;
+    const desiredKeys = new Set<keyof T>(desiredMap.keys());
+    const refreshKeys = new Set(Object.keys(refresh)) as Set<keyof T>;
 
     if (!setsEqual(desiredKeys, refreshKeys)) {
       throw new Error(
@@ -231,19 +224,6 @@ Additional: ${[...refreshKeys].filter(k => !desiredKeys.has(k))};`
     }
   }
 
-  private applyDefaultValueToRefreshResults(refresh: Partial<T> | null) {
-    if (!refresh) {
-      return;
-    }
-
-    for (const [key, defaultValue] of Object.entries(this.defaultValues)) {
-      if (refresh[key] === undefined) {
-        // @ts-ignore
-        refresh[key] = defaultValue;
-      }
-    }
-  }
-
   private async applyTransformParameters(transformParameters: Partial<T>, desired: Partial<T>): Promise<void> {
     const orderedEntries = [...Object.entries(transformParameters)]
       .sort(([keyA], [keyB]) => this.transformParameterOrder.get(keyA)! - this.transformParameterOrder.get(keyB)!)
@@ -281,8 +261,6 @@ Additional: ${[...refreshKeys].filter(k => !desiredKeys.has(k))};`
     const currentParameters = await this.refresh(entriesToRefresh);
 
     this.validateRefreshResults(currentParameters, entriesToRefresh);
-    this.applyDefaultValueToRefreshResults(currentParameters);
-
     return currentParameters;
   }