refactor(alloydb): use migration feature from conf

SUITEDEV-39317

Author: edosrecki

src/commands/configurations/create.ts

@@ -3,7 +3,7 @@ import inquirer from 'inquirer'
 import autocomplete from 'inquirer-autocomplete-prompt'
 import { saveConfiguration } from '../../lib/configurations'
 import { ConfigurationCreateAnswers } from '../../lib/types'
-import { alloyDbInstancePrompt } from './prompts/alloydb-instance'
+import { googleAlloyDbInstancePrompt } from './prompts/google-alloydb-instance'
 import { configurationNamePrompt } from './prompts/configuration-name'
 import { confirmationPrompt } from './prompts/confirmation'
 import { databaseTypePrompt } from './prompts/database-type'
@@ -21,7 +21,7 @@ export const createConfiguration = async () => {
     googleCloudProjectPrompt,
     databaseTypePrompt,
     googleCloudSqlInstancePrompt,
-    alloyDbInstancePrompt,
+    googleAlloyDbInstancePrompt,
     kubernetesContextPrompt,
     kubernetesNamespacePrompt,
     kubernetesServiceAccountPrompt,

…nfigurations/prompts/alloydb-instance.ts …tions/prompts/google-alloydb-instance.tssrc/commands/configurations/prompts/alloydb-instance.ts renamed to src/commands/configurations/prompts/google-alloydb-instance.ts src/commands/configurations/prompts/alloydb-instance.ts renamed to src/commands/configurations/prompts/google-alloydb-instance.ts

@@ -1,13 +1,13 @@
 import { pick } from 'lodash'
 import {
-  fetchAlloyDbInstances,
-  AlloyDbInstance,
+  fetchGoogleAlloyDbInstances,
+  GoogleAlloyDbInstance,
 } from '../../../lib/gcloud/alloydb-instances'
 import { ConfigurationCreateAnswers } from '../../../lib/types'
 import { searchByKey } from '../../../lib/util/search'
 import { tryCatch } from '../../../lib/util/error'
 
-const formatInstance = (instance: AlloyDbInstance) => {
+const formatInstance = (instance: GoogleAlloyDbInstance) => {
   const { name, region, cluster } = instance
   return {
     name: `${name} (cluster: ${cluster}, region: ${region})`,
@@ -17,16 +17,16 @@ const formatInstance = (instance: AlloyDbInstance) => {
 }
 
 const source = tryCatch((answers: ConfigurationCreateAnswers, input?: string) => {
-  const instances = fetchAlloyDbInstances(answers.googleCloudProject)
+  const instances = fetchGoogleAlloyDbInstances(answers.googleCloudProject)
   const filtered = searchByKey(instances, 'connectionName', input)
 
   return filtered.map(formatInstance)
 })
 
-export const alloyDbInstancePrompt = {
+export const googleAlloyDbInstancePrompt = {
   type: 'autocomplete',
   name: 'databaseInstance',
-  message: 'Choose AlloyDB instance:',
+  message: 'Choose Google AlloyDB instance:',
   source,
   when: (answers: ConfigurationCreateAnswers) => answers.databaseType === 'alloydb',
 }

src/lib/configurations/constants.ts

@@ -0,0 +1,5 @@
+export const versionKey = 'version' as const
+export const configurationsKey = 'configurations' as const
+
+// Must be semver ('conf' library requirement)
+export const currentVersion = '2.0.0'

src/lib/configurations/index.ts

@@ -3,70 +3,22 @@ import { omit, kebabCase } from 'lodash'
 import {
   deletePod,
   portForward,
-  runCloudSqlProxyPod,
-  runAlloyDbProxyPod,
+  runProxyPod,
   waitForPodReady,
 } from '../kubectl/pods'
 import { Configuration, ConfigurationCreateAnswers } from '../types'
 import { appendOrReplaceByKey, deleteByKey, findByKey } from '../util/array'
 import { randomString } from '../util/string'
-import { store, CURRENT_VERSION } from './store'
+import { store } from './store'
+import { configurationsKey } from './constants'
 
-const storeKey = 'configurations' as const
 const searchKey = 'configurationName' as const
 const excludeProperties = ['googleCloudProject', 'confirmation'] as const
 
 export const configurationPath = store.path
 
-type LegacyConfiguration = Omit<Configuration, 'databaseType' | 'databaseInstance'> & {
-  googleCloudSqlInstance: {
-    connectionName: string
-    port: number
-  }
-}
-
-const isLegacyConfiguration = (config: Configuration | LegacyConfiguration): config is LegacyConfiguration => {
-  return 'googleCloudSqlInstance' in config && !('databaseType' in config)
-}
-
-const migrateLegacyConfiguration = (legacy: LegacyConfiguration): Configuration => {
-  return {
-    configurationName: legacy.configurationName,
-    databaseType: 'cloudsql',
-    databaseInstance: {
-      connectionName: legacy.googleCloudSqlInstance.connectionName,
-      port: legacy.googleCloudSqlInstance.port,
-    },
-    kubernetesContext: legacy.kubernetesContext,
-    kubernetesNamespace: legacy.kubernetesNamespace,
-    kubernetesServiceAccount: legacy.kubernetesServiceAccount,
-    localPort: legacy.localPort,
-  }
-}
-
-const migrateConfigurationsIfNeeded = (): void => {
-  const currentVersion = store.get('version')
-  const configurations = store.get(storeKey) as (Configuration | LegacyConfiguration)[]
-
-  // Check if migration is needed (no version or configurations in old format)
-  const needsMigration = !currentVersion || configurations.some(isLegacyConfiguration)
-
-  if (needsMigration) {
-    const migratedConfigurations = configurations.map((config) => {
-      if (isLegacyConfiguration(config)) {
-        return migrateLegacyConfiguration(config)
-      }
-      return config
-    })
-
-    store.set(storeKey, migratedConfigurations)
-    store.set('version', CURRENT_VERSION)
-  }
-}
-
 export const getConfigurations = (): Configuration[] => {
-  migrateConfigurationsIfNeeded()
-  return store.get(storeKey)
+  return store.get(configurationsKey)
 }
 
 export const getConfiguration = (name: string): Configuration | undefined => {
@@ -77,24 +29,20 @@ export const getConfiguration = (name: string): Configuration | undefined => {
 export const saveConfiguration = (answers: ConfigurationCreateAnswers): void => {
   const configuration = omit(answers, excludeProperties)
 
-  const configurations = store.get(storeKey)
+  const configurations = store.get(configurationsKey)
   appendOrReplaceByKey(configurations, configuration, searchKey)
-  store.set(storeKey, configurations)
-
-  if (!store.get('version')) {
-    store.set('version', CURRENT_VERSION)
-  }
+  store.set(configurationsKey, configurations)
 }
 
 export const deleteConfiguration = (configuratioName: string): void => {
-  const configurations = store.get(storeKey)
+  const configurations = store.get(configurationsKey)
   deleteByKey(configurations, searchKey, configuratioName)
-  store.set(storeKey, configurations)
+  store.set(configurationsKey, configurations)
 }
 
 export const execConfiguration = (configuration: Configuration) => {
   const pod = {
-    name: `${configuration.databaseType === 'alloydb' ? 'alloydb' : 'sql'}-proxy-${kebabCase(configuration.configurationName)}-${randomString()}`,
+    name: `${configuration.databaseType}-proxy-${kebabCase(configuration.configurationName)}-${randomString()}`,
     context: configuration.kubernetesContext,
     namespace: configuration.kubernetesNamespace,
     serviceAccount: configuration.kubernetesServiceAccount,
@@ -108,12 +56,7 @@ export const execConfiguration = (configuration: Configuration) => {
     deletePod(pod)
   })
 
-  if (configuration.databaseType === 'alloydb') {
-    runAlloyDbProxyPod(pod)
-  }
-  else {
-    runCloudSqlProxyPod(pod)
-  }
+  runProxyPod(pod)
 
   waitForPodReady(pod)
   portForward(pod)

src/lib/configurations/migrations/migrate-v1-v2.ts

@@ -0,0 +1,41 @@
+import Conf from 'conf'
+import { Configuration } from '../../types'
+
+interface V1Configuration {
+  configurationName: string
+  googleCloudSqlInstance: {
+    connectionName: string
+    port: number
+  }
+  kubernetesContext: string
+  kubernetesNamespace: string
+  kubernetesServiceAccount: string
+  localPort: number
+}
+
+export type V1Store = Conf<{
+  configurations: V1Configuration[]
+}>
+
+type V2Configuration = Configuration
+
+const migrateConfigurationV1ToV2 = (v1: V1Configuration): V2Configuration => ({
+  configurationName: v1.configurationName,
+  databaseType: 'cloudsql',
+  databaseInstance: {
+    connectionName: v1.googleCloudSqlInstance.connectionName,
+    port: v1.googleCloudSqlInstance.port,
+  },
+  kubernetesContext: v1.kubernetesContext,
+  kubernetesNamespace: v1.kubernetesNamespace,
+  kubernetesServiceAccount: v1.kubernetesServiceAccount,
+  localPort: v1.localPort,
+})
+
+export const migrateV1ToV2 = (store: V1Store): void => {
+  const v1Configurations = store.get('configurations')
+  const v2Configurations: V2Configuration[] = v1Configurations.map(migrateConfigurationV1ToV2)
+
+  // store.set('version', '2')
+  store.set('configurations', v2Configurations)
+}

src/lib/configurations/store.ts

@@ -1,19 +1,24 @@
 import Conf from 'conf'
 import { Configuration } from '../types'
-
-export const CURRENT_VERSION = 2
+import { migrateV1ToV2, V1Store } from './migrations/migrate-v1-v2'
+import { currentVersion } from './constants'
 
 type Schema = {
-  version?: number
+  version: number
   configurations: Configuration[]
 }
 
 export const store = new Conf<Schema>({
   configName: 'configurations',
   projectSuffix: '',
+  projectVersion: currentVersion,
+  migrations: {
+    '2.0.0': store => migrateV1ToV2(store as unknown as V1Store),
+  },
   schema: {
     version: {
-      type: 'number',
+      type: 'string',
+      default: currentVersion,
     },
     configurations: {
       type: 'array',
@@ -22,7 +27,7 @@ export const store = new Conf<Schema>({
         type: 'object',
         properties: {
           configurationName: { type: 'string' },
-          databaseType: { type: 'string' },
+          databaseType: { type: 'string', enum: ['cloudsql', 'alloydb'] },
           databaseInstance: {
             type: 'object',
             properties: {

src/lib/gcloud/alloydb-instances.ts

@@ -1,64 +1,43 @@
 import memoize from 'memoizee'
 import { execCommandMultiline } from '../util/exec'
-import { parseJson } from '../util/parsers'
 
-export type AlloyDbInstance = {
+export type GoogleAlloyDbInstance = {
   name: string
   region: string
   cluster: string
   connectionName: string
   port: number
 }
 
-type AlloyDbInstanceData = {
-  name: string
-  databaseVersion?: string
-}
-
-const parseInstance = (instanceData: AlloyDbInstanceData): AlloyDbInstance => {
-  // AlloyDB instance name format: projects/{project}/locations/{region}/clusters/{cluster}/instances/{instance}
-  const nameParts = instanceData.name.split('/')
+const parseInstance = (connectionName: string): GoogleAlloyDbInstance => {
+  // projects/{project}/locations/{region}/clusters/{cluster}/instances/{instance}
+  const nameParts = connectionName.split('/')
   const region = nameParts[3]
   const cluster = nameParts[5]
   const instance = nameParts[7]
 
-  // Connection name format: Full resource path (same as name)
-  const connectionName = instanceData.name
-  const port = 5432
-
   return {
     name: instance,
     region,
     cluster,
     connectionName,
-    port,
+    port: 5432,
   }
 }
 
-export const fetchAlloyDbInstances = memoize(
-  (project: string): AlloyDbInstance[] => {
+export const fetchGoogleAlloyDbInstances = memoize(
+  (project: string): GoogleAlloyDbInstance[] => {
     try {
-      const output = execCommandMultiline(`
+      const instances = execCommandMultiline(`
         gcloud alloydb instances list \
           --project=${project} \
-          --format=json \
+          --format='csv(name)' \
           --quiet
       `)
 
-      if (output.length === 0 || output[0].trim() === '') {
-        return []
-      }
-
-      const instances = parseJson(output.join('\n'))
-
-      if (!Array.isArray(instances)) {
-        return []
-      }
-
-      return instances.map(parseInstance)
+      return instances.slice(1).map(parseInstance)
     }
     catch {
-      // If AlloyDB API is not enabled or there are no instances, return empty array
       return []
     }
   },

src/lib/kubectl/pods.ts

@@ -10,7 +10,7 @@ type ProxyPod = {
   instance: string
   localPort: number
   remotePort: number
-  databaseType?: DatabaseType
+  databaseType: DatabaseType
 }
 
 export const runCloudSqlProxyPod = (pod: ProxyPod): string => {
@@ -41,6 +41,15 @@ export const runAlloyDbProxyPod = (pod: ProxyPod): string => {
   `)
 }
 
+export const runProxyPod = (pod: ProxyPod) => {
+  if (pod.databaseType === 'alloydb') {
+    runAlloyDbProxyPod(pod)
+  }
+  else {
+    runCloudSqlProxyPod(pod)
+  }
+}
+
 export const deletePod = (pod: ProxyPod) => {
   console.log(`Deleting pod '${bold(cyan(pod.name))}'.`)
   execCommand(`

src/lib/types.ts

@@ -1,11 +1,9 @@
-import { GoogleCloudSqlInstance } from './gcloud/sql-instances'
-import { AlloyDbInstance } from './gcloud/alloydb-instances'
-
 export type DatabaseType = 'cloudsql' | 'alloydb'
 
-export type DatabaseInstance
-  = | Pick<GoogleCloudSqlInstance, 'connectionName' | 'port'>
-    | Pick<AlloyDbInstance, 'connectionName' | 'port'>
+export type DatabaseInstance = {
+  connectionName: string
+  port: number
+}
 
 export type Configuration = {
   configurationName: string

src/lib/util/parsers.ts

@@ -4,5 +4,3 @@ export const toInt = (value: string): number => parseInt(value, 10)
 
 const trueValues = new Set(['true', 'yes', 'on', '1'])
 export const toBoolean = (value: string): boolean => trueValues.has(value)
-
-export const parseJson = <T = unknown>(value: string): T => JSON.parse(value)