feat(pg,redis): add --as flag to pg:promote and redis:promote (W-23597911, #1819) (#3841)

feat(pg,redis): add --as flag to pg:promote and redis:promote for custom attachment names

Resolves W-23597911 / GitHub #1819. Previously, both commands hardcoded
the attachment name (DATABASE and REDIS respectively). With this change,
users can pass --as NAME to create the promoted attachment under a custom
name, falling back to the original default when the flag is omitted.

Co-authored-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
Co-authored-by: Michael Malave <michael.malave@salesforce.com>

Author: 3 people

src/commands/pg/promote.ts

@@ -18,14 +18,15 @@ export default class Promote extends Command {
   static description = 'sets DATABASE as your DATABASE_URL'
   static flags = {
     app: flags.app({required: true}),
+    as: flags.string({description: 'name for the database attachment'}),
     force: flags.boolean({char: 'f'}),
     remote: flags.remote(),
   }
   static topic = 'pg'
 
   public async run(): Promise<void> {
     const {args, flags} = await this.parse(Promote)
-    const {app, force} = flags
+    const {app, as, force} = flags
     const {database} = args
     const dbResolver = new utils.pg.DatabaseResolver(this.heroku)
     const attachment = await dbResolver.getAttachment(app, database)
@@ -87,7 +88,7 @@ export default class Promote extends Command {
         addon: {name: attachment.addon.name},
         app: {name: app},
         confirm: app,
-        name: 'DATABASE',
+        name: as || 'DATABASE',
         namespace: attachment.namespace || null,
       },
     })

src/commands/redis/promote.ts

@@ -11,30 +11,32 @@ export default class Promote extends Command {
   static description = 'sets DATABASE as your REDIS_URL'
   static flags = {
     app: flags.app({required: true}),
+    as: flags.string({description: 'name for the Key-Value Store attachment'}),
     remote: flags.remote(),
   }
   static topic = 'redis'
 
   public async run(): Promise<void> {
     const {args, flags} = await this.parse(Promote)
-    const api = apiFactory(flags.app, args.database, false, this.heroku)
-    const {body: addonsList} = await this.heroku.get<Required<Heroku.AddOn>[]>(`/apps/${flags.app}/addons`)
+    const {app, as} = flags
+    const api = apiFactory(app, args.database, false, this.heroku)
+    const {body: addonsList} = await this.heroku.get<Required<Heroku.AddOn>[]>(`/apps/${app}/addons`)
     const addon = await api.getRedisAddon(addonsList)
     const redisFilter = api.makeAddonsFilter('REDIS_URL')
     const redis = redisFilter(addonsList) as Required<Heroku.AddOn>[]
     if (redis.length === 1 && redis[0].config_vars.filter((c: string) => c.endsWith('_URL')).length === 1) {
       const attachment = redis[0]
       await this.heroku.post('/addon-attachments', {
         body: {
-          addon: {name: attachment.name}, app: {name: flags.app}, confirm: flags.app,
+          addon: {name: attachment.name}, app: {name: app}, confirm: app,
         },
       })
     }
 
-    ux.stdout(`Promoting ${addon.name} to REDIS_URL on ${flags.app}`)
+    ux.stdout(`Promoting ${addon.name} to REDIS_URL on ${app}`)
     await this.heroku.post('/addon-attachments', {
       body: {
-        addon: {name: addon.name}, app: {name: flags.app}, confirm: flags.app, name: 'REDIS',
+        addon: {name: addon.name}, app: {name: app}, confirm: app, name: as || 'REDIS',
       },
     })
   }

test/unit/commands/pg/promote.unit.test.ts

@@ -227,6 +227,45 @@ describe('pg:promote when argument is database', function () {
     `))
   })
 
+  it('promotes the db with a custom attachment name when --as is provided', async function () {
+    nock('https://api.heroku.com')
+      .get('/apps/myapp/formation')
+      .reply(200, [])
+      .get('/apps/myapp/addon-attachments')
+      .reply(200, [
+        {
+          addon: {name: 'postgres-2'},
+          name: 'DATABASE',
+          namespace: null,
+        },
+        {
+          addon: {name: 'postgres-2'},
+          name: 'RED',
+          namespace: null,
+        },
+      ])
+      .post('/addon-attachments', {
+        addon: {name: addon.name},
+        app: {name: 'myapp'},
+        confirm: 'myapp',
+        name: 'CUSTOM_DB',
+        namespace: null,
+      })
+      .reply(201)
+
+    const {stderr} = await runCommand(Cmd, [
+      '--app',
+      'myapp',
+      '--as',
+      'CUSTOM_DB',
+      'DATABASE',
+    ])
+    expectOutput(stderr, heredoc(`
+      Ensuring an alternate alias for existing ⛁ DATABASE_URL... RED_URL
+      Promoting ⛁ ${addon.name} to ⛁ DATABASE_URL on ⬢ myapp... done
+    `))
+  })
+
   it('does not promote the db if is already is DATABASE', async function () {
     nock('https://api.heroku.com')
       .get('/apps/myapp/formation')

test/unit/commands/redis/promote.unit.test.ts

@@ -49,6 +49,43 @@ describe('heroku redis:promote', function () {
     expect(stderr).to.equal('')
   })
 
+  it('# promotes with a custom attachment name when --as is provided', async function () {
+    const app = nock('https://api.heroku.com:443')
+      .get('/apps/example/addons')
+      .reply(200, [
+        {
+          addon_service: {name: 'heroku-redis'},
+          config_vars: ['REDIS_URL', 'HEROKU_REDIS_SILVER_URL'],
+          name: 'redis-silver-haiku',
+        }, {
+          addon_service: {name: 'heroku-redis'},
+          config_vars: ['HEROKU_REDIS_GOLD_URL'],
+          name: 'redis-gold-haiku',
+        },
+      ])
+
+    const attach = nock('https://api.heroku.com:443')
+      .post('/addon-attachments', {
+        addon: {name: 'redis-gold-haiku'},
+        app: {name: 'example'},
+        confirm: 'example',
+        name: 'CUSTOM_REDIS',
+      })
+      .reply(200, {})
+
+    const {stderr, stdout} = await runCommand(Cmd, [
+      '--app',
+      'example',
+      '--as',
+      'CUSTOM_REDIS',
+      'redis-gold-haiku',
+    ])
+    app.done()
+    attach.done()
+    expect(stdout).to.equal('Promoting redis-gold-haiku to REDIS_URL on example\n')
+    expect(stderr).to.equal('')
+  })
+
   it('# promotes and replaces attachment of existing REDIS_URL if necessary', async function () {
     const app = nock('https://api.heroku.com:443')
       .get('/apps/example/addons')