feat: Added reverse transformation for object level transforms

kevinwang5658 · kevinwang5658 · commit 90826bc71f6e · 2025-02-15T17:24:06.000-05:00
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "codify-plugin-lib",
-  "version": "1.0.135",
+  "version": "1.0.136",
   "description": "Library plugin library",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
diff --git a/src/resource/parsed-resource-settings.ts b/src/resource/parsed-resource-settings.ts
@@ -44,7 +44,7 @@ export class ParsedResourceSettings<T extends StringIndexedObject> implements Re
 
   removeStatefulParametersBeforeDestroy?: boolean | undefined;
   dependencies?: string[] | undefined;
-  inputTransformation?: ((desired: Partial<T>) => unknown) | undefined;
+  transformation?: InputTransformation;
   private settings: ResourceSettings<T>;
 
   constructor(settings: ResourceSettings<T>) {
@@ -54,7 +54,7 @@ export class ParsedResourceSettings<T extends StringIndexedObject> implements Re
     this.allowMultiple = settings.allowMultiple;
     this.removeStatefulParametersBeforeDestroy = settings.removeStatefulParametersBeforeDestroy;
     this.dependencies = settings.dependencies;
-    this.inputTransformation = settings.inputTransformation;
+    this.transformation = settings.transformation;
 
     this.validateSettings();
   }
diff --git a/src/resource/resource-controller.test.ts b/src/resource/resource-controller.test.ts
@@ -7,7 +7,7 @@ import { CreatePlan, DestroyPlan, ModifyPlan } from '../plan/plan-types.js';
 import { ParameterChange } from '../plan/change-set.js';
 import { ResourceController } from './resource-controller.js';
 import { TestConfig, testPlan, TestResource, TestStatefulParameter } from '../utils/test-utils.test.js';
-import { untildify } from '../utils/utils.js';
+import { tildify, untildify } from '../utils/utils.js';
 import { ArrayStatefulParameter, StatefulParameter } from '../stateful-parameter/stateful-parameter.js';
 import { Plan } from '../plan/plan.js';
 
@@ -20,9 +20,11 @@ describe('Resource tests', () => {
           id: 'type',
           dependencies: ['homebrew', 'python'],
           parameterSettings: {
-            propA: { canModify: true, inputTransformation: (input) => untildify(input) },
+            propA: {
+              canModify: true,
+              transformation: { to: (input) => untildify(input), from: (input) => tildify(input) }
+            },
           },
-          inputTransformation: (config) => ({ propA: config.propA, propC: config.propB }),
         }
       }
 
@@ -544,7 +546,7 @@ describe('Resource tests', () => {
           parameterSettings: {
             propD: {
               type: 'array',
-              inputTransformation: {
+              transformation: {
                 to: (hosts: Record<string, unknown>[]) => hosts.map((h) => Object.fromEntries(
                     Object.entries(h)
                       .map(([k, v]) => [
@@ -619,4 +621,94 @@ describe('Resource tests', () => {
       }
     })
   })
+
+  it('Applies reverse input transformations for imports (object level)', async () => {
+    const resource = new class extends TestResource {
+      getSettings(): ResourceSettings<TestConfig> {
+        return {
+          id: 'resourceType',
+          parameterSettings: {
+            propD: {
+              type: 'array',
+            }
+          },
+          transformation: {
+            to: (input: any) => ({
+              ...input,
+              propD: input.propD?.map((h) => Object.fromEntries(
+                  Object.entries(h)
+                    .map(([k, v]) => [
+                      k,
+                      typeof v === 'boolean'
+                        ? (v ? 'yes' : 'no') // The file takes 'yes' or 'no' instead of booleans
+                        : v,
+                    ])
+                )
+              )
+            }),
+            from: (output: any) => ({
+              ...output,
+              propD: output.propD?.map((h) => Object.fromEntries(
+                Object.entries(h)
+                  .map(([k, v]) => [
+                    k,
+                    v === 'yes' || v === 'no'
+                      ? (v === 'yes')
+                      : v,
+                  ])
+              ))
+            })
+          }
+        }
+      }
+
+      async refresh(parameters: Partial<TestConfig>): Promise<Partial<TestConfig> | null> {
+        return {
+          propD: [
+            {
+              Host: 'new.com',
+              AddKeysToAgent: true,
+              IdentityFile: 'id_ed25519'
+            },
+            {
+              Host: 'github.com',
+              AddKeysToAgent: true,
+              UseKeychain: true,
+            },
+            {
+              Match: 'User bob,joe,phil',
+              PasswordAuthentication: true,
+            }
+          ],
+        }
+      }
+    }
+
+    const controller = new ResourceController(resource);
+    const plan = await controller.import({ type: 'resourceType' }, {});
+
+    expect(plan![0]).toMatchObject({
+      'core': {
+        'type': 'resourceType'
+      },
+      'parameters': {
+        'propD': [
+          {
+            'Host': 'new.com',
+            'AddKeysToAgent': true,
+            'IdentityFile': 'id_ed25519'
+          },
+          {
+            'Host': 'github.com',
+            'AddKeysToAgent': true,
+            'UseKeychain': true
+          },
+          {
+            'Match': 'User bob,joe,phil',
+            'PasswordAuthentication': true
+          }
+        ]
+      }
+    })
+  })
 });
diff --git a/src/resource/resource-controller.ts b/src/resource/resource-controller.ts
@@ -351,8 +351,11 @@ ${JSON.stringify(refresh, null, 2)}
         : await inputTransformation.to(config[key]);
     }
 
-    if (this.settings.inputTransformation) {
-      const transformed = await this.settings.inputTransformation({ ...config })
+    if (this.settings.transformation) {
+      const transformed = reverse
+        ? await this.settings.transformation.from({ ...config })
+        : await this.settings.transformation.to({ ...config })
+
       Object.keys(config).forEach((k) => delete config[k])
       Object.assign(config, transformed);
     }
diff --git a/src/resource/resource-settings.test.ts b/src/resource/resource-settings.test.ts
@@ -569,10 +569,16 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
-          inputTransformation: (desired) => ({
-            propA: 'propA',
-            propB: 10,
-          })
+          transformation: {
+            to: (desired) => ({
+              propA: 'propA',
+              propB: 10,
+            }),
+            from: (current) => ({
+              propA: 'propA',
+              propB: 10,
+            })
+          }
         }
       }
 
@@ -604,10 +610,16 @@ describe('Resource parameter tests', () => {
       getSettings(): ResourceSettings<TestConfig> {
         return {
           id: 'resourceType',
-          inputTransformation: (desired) => ({
-            propA: 'propA',
-            propB: 10,
-          })
+          transformation: {
+            to: (desired) => ({
+              propA: 'propA',
+              propB: 10,
+            }),
+            from: (desired) => ({
+              propA: 'propA',
+              propB: 10,
+            })
+          }
         }
       }
 
@@ -852,7 +864,7 @@ describe('Resource parameter tests', () => {
           parameterSettings: {
             propD: {
               type: 'array',
-              inputTransformation: {
+              transformation: {
                 to: (hosts: Record<string, unknown>[]) => hosts.map((h) => Object.fromEntries(
                     Object.entries(h)
                       .map(([k, v]) => [
@@ -918,7 +930,7 @@ describe('Resource parameter tests', () => {
       getSettings(): any {
         return {
           type: 'array',
-          inputTransformation: {
+          transformation: {
             to: (hosts: Record<string, unknown>[]) => hosts.map((h) => Object.fromEntries(
                 Object.entries(h)
                   .map(([k, v]) => [
diff --git a/src/resource/resource-settings.ts b/src/resource/resource-settings.ts
@@ -81,7 +81,7 @@ export interface ResourceSettings<T extends StringIndexedObject> {
    *
    * @param desired
    */
-  inputTransformation?: (desired: Partial<T>) => Promise<unknown> | unknown;
+  transformation?: InputTransformation;
 
   /**
    * Customize the import and destory behavior of the resource. By default, <code>codify import</code> and <code>codify destroy</code> will call
@@ -189,7 +189,7 @@ export interface DefaultParameterSetting {
    *
    * @param input The original parameter value from the desired config.
    */
-  inputTransformation?: InputTransformation;
+  transformation?: InputTransformation;
 
   /**
    * Customize the equality comparison for a parameter. This is used in the diffing algorithm for generating the plan.
@@ -354,10 +354,10 @@ export function resolveParameterTransformFn(
   parameter: ParameterSetting
 ): InputTransformation | undefined {
 
-  if (parameter.type === 'stateful' && !parameter.inputTransformation) {
+  if (parameter.type === 'stateful' && !parameter.transformation) {
     const sp = (parameter as StatefulParameterSetting).definition.getSettings();
-    if (sp.inputTransformation) {
-      return (parameter as StatefulParameterSetting).definition?.getSettings()?.inputTransformation
+    if (sp.transformation) {
+      return (parameter as StatefulParameterSetting).definition?.getSettings()?.transformation
     }
 
     return sp.type ? ParameterTransformationDefaults[sp.type] : undefined;
@@ -366,7 +366,7 @@ export function resolveParameterTransformFn(
   if (parameter.type === 'array'
     && (parameter as ArrayParameterSetting).itemType
     && ParameterTransformationDefaults[(parameter as ArrayParameterSetting).itemType!]
-    && !parameter.inputTransformation
+    && !parameter.transformation
   ) {
     const itemType = (parameter as ArrayParameterSetting).itemType!;
     const itemTransformation = ParameterTransformationDefaults[itemType]!;
@@ -381,5 +381,5 @@ export function resolveParameterTransformFn(
     }
   }
 
-  return parameter.inputTransformation ?? ParameterTransformationDefaults[parameter.type as ParameterSettingType] ?? undefined;
+  return parameter.transformation ?? ParameterTransformationDefaults[parameter.type as ParameterSettingType] ?? undefined;
 }

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "codify-plugin-lib",`
`3`		`- "version": "1.0.135",`
	`3`	`+ "version": "1.0.136",`
`4`	`4`	`"description": "Library plugin library",`
`5`	`5`	`"main": "dist/index.js",`
`6`	`6`	`"typings": "dist/index.d.ts",`
Original file line number	Diff line number	Diff line change
`@@ -351,8 +351,11 @@ ${JSON.stringify(refresh, null, 2)}`
`351`	`351`	`: await inputTransformation.to(config[key]);`
`352`	`352`	`}`
`353`	`353`
`354`		`- if (this.settings.inputTransformation) {`
`355`		`- const transformed = await this.settings.inputTransformation({ ...config })`
	`354`	`+ if (this.settings.transformation) {`
	`355`	`+ const transformed = reverse`
	`356`	`+ ? await this.settings.transformation.from({ ...config })`
	`357`	`+ : await this.settings.transformation.to({ ...config })`
	`358`	`+`
`356`	`359`	`Object.keys(config).forEach((k) => delete config[k])`
`357`	`360`	`Object.assign(config, transformed);`
`358`	`361`	`}`