feat: adds 'data:pg:upgrade:run/wait' commands (W-21304392) (#3551)

* Add 'data:pg:upgrade:run' command

* Add 'upgrading' status and 'wait' sub-command

* Updating messaging

* Addressing CX feedback

Author: sbosio

src/commands/data/pg/upgrade/run.ts

@@ -0,0 +1,74 @@
+import {flags as Flags} from '@heroku-cli/command'
+import {color, hux, utils} from '@heroku/heroku-cli-util'
+import {Args, ux} from '@oclif/core'
+import tsheredoc from 'tsheredoc'
+
+import BaseCommand from '../../../../lib/data/baseCommand.js'
+import {InfoResponse, UpgradeResponse} from '../../../../lib/data/types.js'
+
+const heredoc = tsheredoc.default
+
+export default class DataPgUpgradeRun extends BaseCommand {
+  static args = {
+    database: Args.string({
+      description: 'database name, database attachment name, or related config var on an app',
+      required: true,
+    }),
+  }
+
+  static description = 'upgrade the Postgres version on a Postgres Advanced database'
+
+  static examples = [
+    heredoc`
+      # Upgrade a Postgres Advanced database to version 17
+      ${color.code('<%= config.bin %> <%= command.id %> DATABASE --version 17 --app my-app')}
+    `,
+  ]
+
+  static flags = {
+    app: Flags.app({required: true}),
+    confirm: Flags.string({char: 'c', description: 'pass in the app name to skip confirmation prompts'}),
+    remote: Flags.remote(),
+    version: Flags.string({char: 'v', description: 'Postgres version to upgrade to'}),
+  }
+
+  public async run(): Promise<void> {
+    const {args, flags} = await this.parse(DataPgUpgradeRun)
+    const {app, confirm, version} = flags
+    const {database} = args
+
+    const dbResolver = new utils.pg.DatabaseResolver(this.heroku)
+    const {addon} = await dbResolver.getAttachment(app, database)
+
+    if (!utils.pg.isAdvancedDatabase(addon)) {
+      ux.error(
+        'You can only use this command on Advanced-tier databases.\n'
+          + `Use ${color.code(`heroku pg:upgrade:run ${addon.name} --app ${app}`)} instead.`,
+      )
+    }
+
+    const {body: databaseInfo} = await this.dataApi.get<InfoResponse>(`/data/postgres/v1/${addon.id}/info`)
+    const {version: currentVersion} = databaseInfo
+    const newVersion = version ?? 'the latest supported Postgres version'
+    await hux.confirmCommand({
+      comparison: app,
+      confirmation: confirm,
+      warningMessage: heredoc(`
+        This command immediately upgrades your ${color.datastore(addon.name)} database from ${currentVersion} to ${newVersion}.
+        Your database will be unavailable until the upgrade is complete.`),
+    })
+
+    try {
+      ux.action.start(`Upgrading your ${color.datastore(addon.name)} database from ${currentVersion} to ${newVersion}`)
+      await this.dataApi.post<UpgradeResponse>(
+        `/data/postgres/v1/${addon.id}/upgrade/run`,
+        {body: {version}},
+      )
+      ux.action.stop()
+      ux.stderr(`Upgrade started. Use ${color.code(`heroku data:pg:upgrade:wait ${addon.name} -a ${app}`)} to monitor progress.`)
+    } catch (error: unknown) {
+      ux.action.stop(color.red('!'))
+      throw error
+    }
+  }
+}

src/commands/data/pg/upgrade/wait.ts

@@ -0,0 +1,23 @@
+import * as color from '@heroku/heroku-cli-util/color'
+import tsheredoc from 'tsheredoc'
+
+import DataPgWait from '../wait.js'
+
+const heredoc = tsheredoc.default
+
+export default class DataPgUpgradeWait extends DataPgWait {
+  static description = 'shows status of an upgrade until it\'s complete'
+
+  static examples = [
+    heredoc(`
+      # Wait for upgrade to complete
+      ${color.code('<%= config.bin %> <%= command.id %> DATABASE --app myapp')}
+    `),
+    heredoc(`
+      # Wait with custom polling interval (to avoid rate limiting)
+      ${color.code('<%= config.bin %> <%= command.id %> DATABASE --app myapp --wait-interval 10')}
+    `),
+  ]
+
+  protected classicWaitCommand: string = 'pg:upgrade:wait'
+}

src/commands/data/pg/wait.ts

@@ -1,6 +1,9 @@
-import {color, pg, utils} from '@heroku/heroku-cli-util'
-import {HTTPError} from '@heroku/http-call'
+import type {pg} from '@heroku/heroku-cli-util'
+
 import {flags as Flags} from '@heroku-cli/command'
+import * as color from '@heroku/heroku-cli-util/color'
+import {DatabaseResolver, isAdvancedDatabase} from '@heroku/heroku-cli-util/utils'
+import {HTTPError} from '@heroku/http-call'
 import {Args, ux} from '@oclif/core'
 import tsheredoc from 'tsheredoc'
 
@@ -23,7 +26,7 @@ export default class DataPgWait extends BaseCommand {
   static examples = [
     heredoc(`
       # Wait for database to be available
-      ${color.command('heroku data:pg:wait DATABASE --app myapp')}
+      ${color.code('<%= config.bin %> <%= command.id %> DATABASE --app myapp')}
     `),
   ]
 
@@ -40,6 +43,8 @@ export default class DataPgWait extends BaseCommand {
     }),
   }
 
+  protected classicWaitCommand: string = 'pg:wait'
+
   public async notify(...args: Parameters<typeof notify>): Promise<void> {
     return notify(...args)
   }
@@ -48,14 +53,14 @@ export default class DataPgWait extends BaseCommand {
     const {args, flags} = await this.parse(DataPgWait)
     const {database} = args
     const {app, 'no-notify': noNotify, 'wait-interval': waitInterval} = flags
-    const databaseResolver = new utils.pg.DatabaseResolver(this.heroku)
+    const databaseResolver = new DatabaseResolver(this.heroku)
     const db = await databaseResolver.getAttachment(app, database)
     const {addon} = db
 
-    if (!utils.pg.isAdvancedDatabase(addon)) {
+    if (!isAdvancedDatabase(addon)) {
       ux.error(heredoc`
         You can only use this command on Advanced-tier databases.
-        Run ${color.code(`heroku pg:wait ${addon.name} -a ${app}`)} instead.`)
+        Use ${color.code(`heroku ${this.classicWaitCommand} ${addon.name} -a ${app}`)} instead.`)
     }
 
     await this.waitFor(addon, waitInterval || 5, noNotify)