feat: allow array deletion in the values changes

Author: ElderMatt

src/cmd/migrate.test.ts

@@ -13,8 +13,8 @@ describe('Upgrading values', () => {
     teamConfig: {
       teamA: {
         services: [
-          { name: 'svc1', prop: 'replaceMe', bla: [{ ok: 'replaceMe' }] },
-          { name: 'svc1', prop: 'replaceMe', di: [{ ok: 'replaceMeNot' }] },
+          { name: 'svc1', prop: 'replaceMe', bla: [{ ok: 'replaceMe' }], type: 'cluster' },
+          { name: 'svc1', prop: 'replaceMe', di: [{ ok: 'replaceMeNot' }], type: 'public' },
         ],
       },
     },
@@ -40,11 +40,19 @@ describe('Upgrading values', () => {
       ],
       renamings: [{ 'somefile.yaml': 'newloc.yaml' }],
     },
+    {
+      version: 4,
+      deletions: [
+        // { 'some.k8sVersion': 'printf "v%s" .prev' },
+        'teamConfig.{team}.services[].type',
+        // { 'teamConfig.{team}.services[].bla[].ok': 'print .prev "ee"' },
+      ],
+    },
   ]
 
   describe('Filter changes', () => {
     it('should only select changes whose version >= current version', () => {
-      expect(filterChanges(oldVersion, mockChanges)).toEqual(mockChanges.slice(1, 3))
+      expect(filterChanges(oldVersion, mockChanges)).toEqual(mockChanges.slice(1, 4))
     })
   })
   describe('Apply changes to values', () => {
@@ -68,7 +76,7 @@ describe('Upgrading values', () => {
             },
           },
           some: { bla: {}, k8sVersion: '1.18' },
-          version: 3,
+          version: 4,
         },
         true,
       )

src/cmd/migrate.ts

@@ -5,6 +5,7 @@ import { randomUUID } from 'crypto'
 import { diff } from 'deep-diff'
 import { copy, createFileSync, move, pathExists, renameSync, rm } from 'fs-extra'
 import { mkdir, readFile, writeFile } from 'fs/promises'
+import { glob } from 'glob'
 import { cloneDeep, each, get, isObject, mapKeys, mapValues, omit, pick, pull, set, unset } from 'lodash'
 import { basename, dirname, join } from 'path'
 import { prepareEnvironment } from 'src/common/cli'
@@ -20,7 +21,6 @@ import { v4 as uuidv4 } from 'uuid'
 import { parse } from 'yaml'
 import { Argv } from 'yargs'
 import { $, cd } from 'zx'
-import { glob } from 'glob'
 const cmdName = getFilename(__filename)
 
 interface Arguments extends BasicArguments {
@@ -372,14 +372,40 @@ export const applyChanges = async (
 
 export const unparsePaths = (path: string, values: Record<string, any>): Array<string> => {
   if (path.includes('{team}')) {
-    const paths: Array<string> = []
+    let paths: Array<string> = []
     const teams: Array<string> = Object.keys(values?.teamConfig as Record<string, any>)
     teams.forEach((teamName) => paths.push(path.replace('{team}', teamName)))
+    paths = isArray(paths, values)
     return paths.sort()
   } else {
-    return [path]
+    const paths = isArray([path], values)
+    return paths
   }
 }
+
+function isArray(paths: string[], values: Record<string, any>): string[] {
+  const transformedPaths: string[] = []
+
+  paths.forEach((path) => {
+    const match = path.match(/^(.*)\.(\w+)\[\](.*)$/)
+    if (!match) {
+      transformedPaths.push(path)
+      return
+    }
+
+    const [, beforeArrayPath, arrayKey, afterArrayPath] = match
+
+    const objectPath = beforeArrayPath.split('.').reduce((obj, key) => obj?.[key], values)
+
+    if (objectPath && objectPath[arrayKey]) {
+      objectPath[arrayKey].forEach((_item: any, index: number) => {
+        transformedPaths.push(`${beforeArrayPath}.${arrayKey}[${index}]${afterArrayPath}`)
+      })
+    }
+  })
+
+  return transformedPaths
+}
 export const unsetAtPath = (path: string, values: Record<string, any>): void => {
   const paths = unparsePaths(path, values)
   paths.forEach((p) => unset(values, p))

values-changes.yaml

@@ -343,4 +343,4 @@ changes:
       - 'databases.gitea.useOtomiDB'
   - version: 34
     deletions:
-      - 'teamConfig.{team}.services.{service}.type'
+      - 'teamConfig.{team}.services[].type'