feat: add new command 'data:pg:levels' (W-21411625) (#3578)

* Adds command 'data:pg:levels'

* Addressing PR review feedback

Author: sbosio

package-lock.json

@@ -26,6 +26,7 @@
     "@oclif/plugin-version": "^2.2.37",
     "@oclif/plugin-warn-if-update-available": "^3.1.55",
     "@oclif/plugin-which": "^3.2.44",
+    "@oclif/table": "^0.5.2",
     "@opentelemetry/api": "^1.9.0",
     "@opentelemetry/exporter-trace-otlp-http": "^0.52.1",
     "@opentelemetry/instrumentation": "^0.52.1",

package.json

@@ -0,0 +1,38 @@
+import {Command} from '@heroku-cli/command'
+import {hux} from '@heroku/heroku-cli-util'
+import {printTable, TableOptions} from '@oclif/table'
+
+import BaseCommand from '../../../lib/data/baseCommand.js'
+import {PostgresLevelInfo, PostgresLevelsResponse} from '../../../lib/data/types.js'
+
+export default class DataPgLevels extends BaseCommand {
+  static baseFlags = Command.baseFlagsWithoutPrompt()
+  static description = 'show available levels for Heroku Postgres Advanced databases'
+  static promptFlagActive = false
+
+  async run(): Promise<void> {
+    const {body: {items: levels}} = await this.dataApi.get<PostgresLevelsResponse>('/data/postgres/v1/levels/advanced')
+
+    hux.styledHeader('Available levels for Heroku Postgres Advanced databases')
+
+    const defaultStyle = {
+      borderColor: 'whiteBright',
+      borderStyle: 'headers-only-with-underline',
+      headerOptions: {
+        bold: true,
+        color: 'white',
+      },
+    } as Partial<TableOptions<PostgresLevelInfo>>
+
+    printTable<PostgresLevelInfo>({
+      columns: [
+        {key: 'name', name: 'Name'},
+        {horizontalAlignment: 'right', key: 'vcpu', name: 'vCPU'},
+        {horizontalAlignment: 'right', key: 'memory_in_gb', name: 'Memory (GB)'},
+        {horizontalAlignment: 'right', key: 'connection_limit', name: 'Max Connections'},
+      ],
+      data: levels,
+      ...defaultStyle,
+    })
+  }
+}

src/commands/data/pg/levels.ts

@@ -85,6 +85,7 @@ type StorageLimitInGb = {
 export type PlanLimit = ConnectionLimit | StorageLimitInGb | TableLimit
 
 export type PostgresLevelInfo = {
+  connection_limit: number
   memory_in_gb: number
   name: string
   vcpu: number

src/lib/data/types.ts

@@ -109,8 +109,18 @@ export const essentialAddon: DeepRequired<Heroku.AddOn> = {
 
 export const levelsResponse: PostgresLevelsResponse = {
   items: [
-    {memory_in_gb: 4, name: '4G-Performance', vcpu: 2},
-    {memory_in_gb: 8, name: '8G-Performance', vcpu: 4},
+    {
+      connection_limit: 400,
+      memory_in_gb: 4,
+      name: '4G-Performance',
+      vcpu: 2,
+    },
+    {
+      connection_limit: 800,
+      memory_in_gb: 8,
+      name: '8G-Performance',
+      vcpu: 4,
+    },
   ],
 }
 

test/fixtures/data/pg/fixtures.ts

@@ -0,0 +1,65 @@
+import {expect} from 'chai'
+import nock from 'nock'
+import {stderr, stdout} from 'stdout-stderr'
+
+import DataPgLevels from '../../../../../src/commands/data/pg/levels.js'
+import {levelsResponse} from '../../../../fixtures/data/pg/fixtures.js'
+import runCommand from '../../../../helpers/runCommand.js'
+
+describe('data:pg:levels', () => {
+  let dataApi: nock.Scope
+
+  beforeEach(() => {
+    dataApi = nock('https://api.data.heroku.com')
+  })
+
+  afterEach(() => {
+    dataApi.done()
+  })
+
+  it('displays available levels for advanced databases', async () => {
+    dataApi
+      .get('/data/postgres/v1/levels/advanced')
+      .reply(200, levelsResponse)
+
+    await runCommand(DataPgLevels, [])
+
+    expect(stderr.output).to.equal('')
+    expect(stdout.output).to.include('Name')
+    expect(stdout.output).to.include('vCPU')
+    expect(stdout.output).to.include('Memory (GB)')
+    expect(stdout.output).to.include('Max Connections')
+    expect(stdout.output).to.include('4G-Performance')
+    expect(stdout.output).to.include('8G-Performance')
+  })
+
+  it('displays an empty table when no levels are available', async () => {
+    dataApi
+      .get('/data/postgres/v1/levels/advanced')
+      .reply(200, {items: []})
+
+    await runCommand(DataPgLevels, [])
+
+    expect(stderr.output).to.equal('')
+    expect(stdout.output).to.include('Name')
+    expect(stdout.output).to.include('vCPU')
+    expect(stdout.output).to.include('Memory (GB)')
+    expect(stdout.output).to.include('Max Connections')
+    expect(stdout.output).not.to.include('4G-Performance')
+    expect(stdout.output).not.to.include('8G-Performance')
+  })
+
+  it('handles API errors gracefully', async () => {
+    dataApi
+      .get('/data/postgres/v1/levels/advanced')
+      .reply(500, {id: 'server_error', message: 'Internal Server Error'})
+
+    try {
+      await runCommand(DataPgLevels, [])
+      expect.fail('Expected command to throw an error')
+    } catch (error: unknown) {
+      const err = error as Error
+      expect(err.message).to.include('Internal Server Error')
+    }
+  })
+})