refactor(pg-v5): Move command pg:settings:auto-explain:log-buffers to oclif

packages/cli/src/commands/pg/settings/auto-explain/log-buffers.ts

@@ -0,0 +1,30 @@
+import {Args} from '@oclif/core'
+import heredoc from 'tsheredoc'
+import {PGSettingsCommand, type Setting, type SettingKey, booleanConverter} from '../../../../lib/pg/setter'
+
+export default class LogBuffersWaits extends PGSettingsCommand {
+  static topic = 'pg'
+  static description = heredoc(`
+    Includes buffer usage statistics when execution plans are logged.
+    This is equivalent to calling EXPLAIN BUFFERS and can only be used in conjunction with pg:settings:auto-explain:log-analyze turned on.
+  `)
+
+  static args = {
+    database: Args.string(),
+    value: Args.string(),
+  }
+
+  protected settingKey: SettingKey = 'auto_explain.log_buffers'
+
+  protected convertValue(val: boolean): boolean {
+    return booleanConverter(val)
+  }
+
+  protected explain(setting: Setting) {
+    if (setting.value) {
+      return 'Buffer statistics have been enabled for auto_explain.'
+    }
+
+    return 'Buffer statistics have been disabled for auto_explain.'
+  }
+}

packages/cli/src/lib/pg/setter.ts

@@ -1,4 +1,4 @@
-import {Command} from '@heroku-cli/command'
+import {Command, flags} from '@heroku-cli/command'
 import {ux} from '@oclif/core'
 import {addonResolver} from '../addons/resolve'
 import host from './host'
@@ -29,14 +29,19 @@ export abstract class PGSettingsCommand extends Command {
 
   protected abstract explain(setting: Setting): string
 
+  static flags = {
+    app: flags.app({required: true}),
+    remote: flags.remote(),
+  }
+
   public async run(): Promise<void> {
     const {flags, args} = await this.parse()
     const {app} = flags
     const {value, database} = args
 
     const db = await addonResolver(this.heroku, app, database || '')
 
-    if (essentialPlan(db)) throw new Error('You can’t perform this operation on Essential-tier databases.')
+    if (essentialPlan(db)) ux.error('You can’t perform this operation on Essential-tier databases.')
 
     if (value) {
       const {body: settings} = await this.heroku.patch<Record<SettingKey, Setting>>(`/postgres/v0/databases/${db.id}/config`, {

packages/cli/test/unit/commands/pg/settings/auto-explain/log-buffers.unit.test.ts

@@ -0,0 +1,43 @@
+import {expect} from '@oclif/test'
+import * as nock from 'nock'
+import {stdout} from 'stdout-stderr'
+import heredoc from 'tsheredoc'
+import runCommand from '../../../../../helpers/runCommand'
+import Cmd from '../../../../../../src/commands/pg/settings/auto-explain/log-buffers'
+import * as fixtures from '../../../../../fixtures/addons/fixtures'
+
+describe('pg:settings:auto-explain:log-buffers', () => {
+  const addon = fixtures.addons['dwh-db']
+
+  beforeEach(() => {
+    nock('https://api.heroku.com')
+      .post('/actions/addons/resolve', {
+        app: 'myapp',
+        addon: 'test-database',
+      }).reply(200, [addon])
+  })
+
+  afterEach(() => {
+    nock.cleanAll()
+  })
+
+  it('shows settings for auto_explain with value', async () => {
+    nock('https://api.data.heroku.com')
+      .get(`/postgres/v0/databases/${addon.id}/config`).reply(200, {'auto_explain.log_buffers': {value: 'test_value'}})
+    await runCommand(Cmd, ['--app', 'myapp', 'test-database'])
+    expect(stdout.output).to.equal(heredoc(`
+      auto-explain.log-buffers is set to test_value for ${addon.name}.
+      Buffer statistics have been enabled for auto_explain.
+    `))
+  })
+
+  it('shows settings for auto_explain with no value', async () => {
+    nock('https://api.data.heroku.com')
+      .get(`/postgres/v0/databases/${addon.id}/config`).reply(200, {'auto_explain.log_buffers': {value: ''}})
+    await runCommand(Cmd, ['--app', 'myapp', 'test-database'])
+    expect(stdout.output).to.equal(heredoc(`
+      auto-explain.log-buffers is set to  for ${addon.name}.
+      Buffer statistics have been disabled for auto_explain.
+    `))
+  })
+})

packages/pg-v5/index.js

@@ -28,7 +28,6 @@ exports.commands = flatten([
   require('./commands/reset'),
   require('./commands/settings'),
   require('./commands/settings/auto_explain_log_analyze'),
-  require('./commands/settings/auto_explain_log_buffers'),
   require('./commands/settings/auto_explain_log_min_duration'),
   require('./commands/settings/auto_explain_log_nested_statements'),
   require('./commands/settings/auto_explain_log_triggers'),

packages/pg-v5/test/unit/commands/settings/settings.unit.test.js

@@ -120,30 +120,6 @@ describe('pg:settings', () => {
       .then(() => expect(cli.stdout).to.equal('auto-explain.log-analyze is set to  for postgres-1.\nEXPLAIN ANALYZE execution plans will not be logged.\n'))
   })
 
-  it('shows settings for auto_explain_log_buffers with value', () => {
-    setupSettingsMockData('auto_explain.log_buffers')
-    cmd = proxyquire('../../../../commands/settings/auto_explain_log_buffers', {
-      settings: proxyquire.noCallThru().load('../../../../lib/setter', {
-        './fetcher': fetcher,
-      }),
-    })
-    pg.get('/postgres/v0/databases/1/config').reply(200, settingsResult)
-    return cmd.run({args: {database: 'test-database', value: ''}, flags: {}})
-      .then(() => expect(cli.stdout).to.equal('auto-explain.log-buffers is set to test_value for postgres-1.\nBuffer statistics have been enabled for auto_explain.\n'))
-  })
-
-  it('shows settings for auto_explain_log_buffers with no value', () => {
-    setupSettingsMockData('auto_explain.log_buffers', '')
-    cmd = proxyquire('../../../../commands/settings/auto_explain_log_buffers', {
-      settings: proxyquire.noCallThru().load('../../../../lib/setter', {
-        './fetcher': fetcher,
-      }),
-    })
-    pg.get('/postgres/v0/databases/1/config').reply(200, settingsResult)
-    return cmd.run({args: {database: 'test-database', value: ''}, flags: {}})
-      .then(() => expect(cli.stdout).to.equal('auto-explain.log-buffers is set to  for postgres-1.\nBuffer statistics have been disabled for auto_explain.\n'))
-  })
-
   it('shows settings for auto_explain_log_min_duration with value', () => {
     setupSettingsMockData('auto_explain.log_min_duration')
     cmd = proxyquire('../../../../commands/settings/auto_explain_log_min_duration', {