refactor: Reconciliation for 'create_addon' and 'destroy_addon' (W-20610672) (#3497)

CLI reconciliation for 'create_addon' and 'destroy_addon' for NGPG migration

Author: sbosio

packages/cli/src/commands/addons/create.ts

@@ -1,11 +1,13 @@
-
 import {color} from '@heroku/heroku-cli-util'
 import {Command, flags} from '@heroku-cli/command'
+import * as Heroku from '@heroku-cli/schema'
 import {Args, ux} from '@oclif/core'
 import tsheredoc from 'tsheredoc'
 
 import createAddon from '../../lib/addons/create_addon.js'
+import * as util from '../../lib/addons/util.js'
 import notify from '../../lib/notify.js'
+
 const heredoc = tsheredoc.default
 
 function parseConfig(args: string[]) {
@@ -46,9 +48,9 @@ export default class Create extends Command {
   }
 
   static description = heredoc`
-  Create a new add-on resource.
+    Create a new add-on resource.
 
-  In order to add additional config items, please place them at the end of the command after a double-dash (--).
+    In order to add additional config items, please place them at the end of the command after a double-dash (--).
   `
 
   static examples = [
@@ -76,15 +78,13 @@ export default class Create extends Command {
 
   static strict = false
 
-  static topic = 'addons'
-
   public async run(): Promise<void> {
     this.allowArbitraryFlags = true
     const {args, flags, ...restParse} = await this.parse(Create)
     const {app, as, confirm, name, wait} = flags
     const servicePlan = args['service:plan']
-    const argv = (restParse.argv as string[])
     // oclif duplicates specified args in argv
+    const argv = (restParse.argv as string[])
       .filter(arg => arg !== servicePlan)
 
     if (restParse.nonExistentFlags && restParse.nonExistentFlags.length > 0) {
@@ -93,9 +93,9 @@ export default class Create extends Command {
     }
 
     const config = parseConfig(argv)
-    let addon
+    let addon: Heroku.AddOn
     try {
-      addon = await createAddon(this.heroku, app, servicePlan, confirm, wait, {config, name, as})
+      addon = await createAddon(this.heroku, app, servicePlan, confirm, wait, {as, config, name})
       if (wait) {
         Create.notifier(`heroku addons:create ${addon.name}`, 'Add-on successfully provisioned')
       }
@@ -109,6 +109,6 @@ export default class Create extends Command {
 
     await this.config.runHook('recache', {addon, app, type: 'addon'})
     // eslint-disable-next-line no-unsafe-optional-chaining
-    ux.stdout(`Use ${color.code('heroku addons:docs ' + addon?.addon_service?.name || '')} to view documentation`)
+    ux.stdout(`Run ${color.code('heroku addons:docs ' + addon?.addon_service?.name || '')} to view documentation.`)
   }
 }

packages/cli/src/commands/addons/destroy.ts

@@ -1,11 +1,10 @@
-import {color} from '@heroku/heroku-cli-util'
+import {color, utils} from '@heroku/heroku-cli-util'
 import {Command, flags} from '@heroku-cli/command'
 import * as Heroku from '@heroku-cli/schema'
 import {Args} from '@oclif/core'
 import _ from 'lodash'
 
 import destroyAddon from '../../lib/addons/destroy_addon.js'
-import {resolveAddon} from '../../lib/addons/resolve.js'
 import ConfirmCommand from '../../lib/confirmCommand.js'
 import notify from '../../lib/notify.js'
 
@@ -36,8 +35,9 @@ export default class Destroy extends Command {
     const {argv, flags} = await this.parse(Destroy)
     const {app, confirm, wait} = flags
     const force = flags.force || process.env.HEROKU_FORCE === '1'
+    const addonResolver = new utils.AddonResolver(this.heroku)
 
-    const addons = await Promise.all(argv.map((name: string) => resolveAddon(this.heroku, app, name as string)))
+    const addons = await Promise.all(argv.map((name: string) => addonResolver.resolve(name as string, app)))
     for (const addon of addons) {
       // prevent deletion of add-on when context.app is set but the addon is attached to a different app
       const addonApp = addon.app?.name

packages/cli/src/lib/addons/create_addon.ts

@@ -1,4 +1,4 @@
-import {color} from '@heroku/heroku-cli-util'
+import {color, utils} from '@heroku/heroku-cli-util'
 import {APIClient} from '@heroku-cli/command'
 import * as Heroku from '@heroku-cli/schema'
 import {ux} from '@oclif/core'
@@ -16,14 +16,19 @@ function formatConfigVarsMessage(addon: Heroku.AddOn) {
   return `Created ${color.addon(addon.name || '')}`
 }
 
-// eslint-disable-next-line max-params
 export default async function (
   heroku: APIClient,
   app: string,
   plan: string,
   confirm: string | undefined,
   wait: boolean,
-  options: {as?: string, config: Record<string, boolean | string>, name?: string},
+  options: {
+    actionStartMessage?: string,
+    actionStopMessage?: string,
+    as?: string,
+    config: Record<string, boolean | string>,
+    name?: string,
+  },
 ) {
   async function createAddonRequest(confirmed?: string) {
     const body = {
@@ -34,7 +39,7 @@ export default async function (
       plan: {name: plan},
     }
 
-    ux.action.start(`Creating ${plan} on ${color.app(app)}`)
+    ux.action.start(options.actionStartMessage || `Creating ${plan} on ${color.app(app)}`)
     const {body: addon} = await heroku.post<Heroku.AddOn>(`/apps/${app}/addons`, {
       body,
       headers: {
@@ -43,7 +48,7 @@ export default async function (
       },
     })
 
-    ux.action.stop(color.green(util.formatPriceText(addon.plan?.price || '')))
+    ux.action.stop(options.actionStopMessage || color.green(util.formatPriceText(addon.plan?.price || '')))
 
     return addon
   }
@@ -61,7 +66,10 @@ export default async function (
       ux.stdout(formatConfigVarsMessage(addon))
     } else {
       ux.stdout(`${color.addon(addon.name || '')} is being created in the background. The app will restart when complete...`)
-      ux.stdout(`Use ${color.code('heroku addons:info ' + addon.name)} to check creation progress`)
+      if (utils.pg.isAdvancedDatabase(addon))
+        ux.stdout(`Run ${color.code('heroku data:pg:info ' + addon.name + ' -a ' + addon.app!.name)} to check creation progress.`)
+      else
+        ux.stdout(`Run ${color.code('heroku addons:info ' + addon.name)} to check creation progress.`)
     }
   } else if (addon.state === 'deprovisioned') {
     throw new Error(`The add-on was unable to be created, with status ${addon.state}`)

packages/cli/src/lib/addons/destroy_addon.ts

@@ -1,4 +1,4 @@
-import {color} from '@heroku/heroku-cli-util'
+import {color, utils} from '@heroku/heroku-cli-util'
 import {APIClient} from '@heroku-cli/command'
 import * as Heroku from '@heroku-cli/schema'
 import {ux} from '@oclif/core'
@@ -15,10 +15,11 @@ export default async function (heroku: APIClient, addon: Heroku.AddOn, force = f
       body: {force},
       headers: {'Accept-Expansion': 'plan'},
     }).catch(error => {
-      if (error.body && error.body.message) {
-        throw new Error(`The add-on was unable to be destroyed: ${error.body.message}.`)
+      const errorMessage = error.body?.message || error
+      if (utils.pg.isAdvancedDatabase(addon)) {
+        throw new Error(`We can't destroy your database due to an error: ${errorMessage}. Try again or open a ticket with Heroku Support: https://help.heroku.com/`)
       } else {
-        throw new Error(`The add-on was unable to be destroyed: ${error}.`)
+        throw new Error(`The add-on was unable to be destroyed: ${errorMessage}.`)
       }
     })
 
@@ -41,10 +42,14 @@ export default async function (heroku: APIClient, addon: Heroku.AddOn, force = f
       addonResponse = await waitForAddonDeprovisioning(heroku, addonResponse, 5)
     } else {
       ux.stdout(`${color.addon(addonName)} is being destroyed in the background. The app will restart when complete...`)
-      ux.stdout(`Use ${color.code('heroku addons:info ' + addonName)} to check destruction progress`)
+      ux.stdout(`Run ${color.code('heroku addons:info ' + addonName)} to check destruction progress`)
     }
   } else if (addonResponse.state !== 'deprovisioned') {
-    throw new Error(`The add-on was unable to be destroyed, with status ${addonResponse.state}.`)
+    if (utils.pg.isAdvancedDatabase(addonResponse)) {
+      throw new Error(`You can't destroy a database with a ${addonResponse.state} status.`)
+    } else {
+      throw new Error(`The add-on was unable to be destroyed, with status ${addonResponse.state}.`)
+    }
   }
 
   return addonResponse