Fixing more type discrepancies

Author: sbosio

packages/cli/src/commands/pg/copy.ts

@@ -1,10 +1,12 @@
+import {color, utils} from '@heroku/heroku-cli-util'
 import {APIClient, Command, flags} from '@heroku-cli/command'
 import * as Heroku from '@heroku-cli/schema'
 import {Args, ux} from '@oclif/core'
-import {color, utils} from '@heroku/heroku-cli-util'
+
+import type {NonAdvancedCredentialInfo} from '../../lib/data/types.js'
+import type {BackupTransfer} from '../../lib/pg/types.js'
 
 import ConfirmCommand from '../../lib/confirmCommand.js'
-import type {BackupTransfer, CredentialsInfo} from '../../lib/pg/types.js'
 import backupsFactory from '../../lib/pg/backups.js'
 
 const getAttachmentInfo = async function (heroku: APIClient, db: string, app: string) {
@@ -14,9 +16,9 @@ const getAttachmentInfo = async function (heroku: APIClient, db: string, app: st
     const conn = utils.pg.DatabaseResolver.parsePostgresConnectionString(db)
     const host = `${conn.host}:${conn.port}`
     return {
+      confirm: conn.database || conn.host,
       name: conn.database ? `database ${conn.database} on ${host}` : `database on ${host}`,
       url: db,
-      confirm: conn.database || conn.host,
     }
   }
 
@@ -29,37 +31,39 @@ const getAttachmentInfo = async function (heroku: APIClient, db: string, app: st
   const formattedConfig = Object.fromEntries(Object.entries(config).map(([k, v]) => [k.toUpperCase(), v]))
 
   return {
-    name: attachment.name.replace(/^HEROKU_POSTGRESQL_/, '')
-      .replace(/_URL$/, ''),
-    url: formattedConfig[attachment.name.toUpperCase() + '_URL'],
     attachment: {
       ...attachment,
       addon,
     },
     confirm: app,
+    name: attachment.name.replace(/^HEROKU_POSTGRESQL_/, '')
+      .replace(/_URL$/, ''),
+    url: formattedConfig[attachment.name.toUpperCase() + '_URL'],
   }
 }
 
 export default class Copy extends Command {
-  static description = 'copy all data from source db to target'
-  static help = 'at least one of the databases must be a Heroku PostgreSQL DB'
-  static topic = 'pg'
   static args = {
-    source: Args.string({required: true, description: 'config var exposed to the owning app containing the source database URL'}),
-    target: Args.string({required: true, description: 'config var exposed to the owning app containing the target database URL'}),
+    source: Args.string({description: 'config var exposed to the owning app containing the source database URL', required: true}),
+    target: Args.string({description: 'config var exposed to the owning app containing the target database URL', required: true}),
   }
 
+  static description = 'copy all data from source db to target'
   static flags = {
-    'wait-interval': flags.string(),
-    verbose: flags.boolean(),
-    confirm: flags.string(),
     app: flags.app({required: true}),
+    confirm: flags.string(),
     remote: flags.remote(),
+    verbose: flags.boolean(),
+    'wait-interval': flags.string(),
   }
 
+  static help = 'at least one of the databases must be a Heroku PostgreSQL DB'
+
+  static topic = 'pg'
+
   public async run(): Promise<void> {
-    const {flags, args} = await this.parse(Copy)
-    const {'wait-interval': waitInterval, verbose, confirm, app} = flags
+    const {args, flags} = await this.parse(Copy)
+    const {app, confirm, verbose, 'wait-interval': waitInterval} = flags
     const pgbackups = backupsFactory(app, this.heroku)
     const interval = Math.max(3, Number.parseInt(waitInterval || '0', 10)) || 3
 
@@ -83,13 +87,13 @@ export default class Copy extends Command {
     ux.action.stop()
 
     if (source.attachment) {
-      const {body: credentials} = await this.heroku.get<CredentialsInfo>(
+      const {body: credentials} = await this.heroku.get<NonAdvancedCredentialInfo[]>(
         `/postgres/v0/databases/${source.attachment.addon.name}/credentials`,
         {
-          hostname: utils.pg.host(),
           headers: {
             Authorization: `Basic ${Buffer.from(`:${this.heroku.auth}`).toString('base64')}`,
           },
+          hostname: utils.pg.host(),
         })
       if (credentials.length > 1) {
         ux.warn('pg:copy will only copy your default credential and the data it has access to. Any additional credentials and data that only they can access will not be copied.')

packages/cli/src/commands/pg/credentials.ts

@@ -1,43 +1,50 @@
-import {Command, flags} from '@heroku-cli/command'
-import {Args} from '@oclif/core'
 import {hux, utils} from '@heroku/heroku-cli-util'
+import {Command, flags} from '@heroku-cli/command'
 import * as Heroku from '@heroku-cli/schema'
-import type {CredentialInfo, CredentialsInfo} from '../../lib/pg/types.js'
+import {Args} from '@oclif/core'
+
+import type {NonAdvancedCredentialInfo} from '../../lib/data/types.js'
+
 import {presentCredentialAttachments} from '../../lib/pg/util.js'
 import {nls} from '../../nls.js'
 
 export default class Credentials extends Command {
-  static topic = 'pg'
+  static args = {
+    database: Args.string({description: `${nls('pg:database:arg:description')} ${nls('pg:database:arg:description:default:suffix')}`}),
+  }
+
   static description = 'show information on credentials in the database'
   static flags = {
     app: flags.app({required: true}),
     remote: flags.remote(),
   }
 
-  static args = {
-    database: Args.string({description: `${nls('pg:database:arg:description')} ${nls('pg:database:arg:description:default:suffix')}`}),
+  static topic = 'pg'
+
+  protected isDefaultCredential(cred: NonAdvancedCredentialInfo): boolean {
+    return cred.name === 'default'
   }
 
   public async run(): Promise<void> {
-    const {flags, args} = await this.parse(Credentials)
+    const {args, flags} = await this.parse(Credentials)
     const {app} = flags
     const {database} = args
     const dbResolver = new utils.pg.DatabaseResolver(this.heroku)
     const {addon} = await dbResolver.getAttachment(app, database)
 
-    const {body: credentials} = await this.heroku.get<CredentialsInfo>(
+    const {body: credentials} = await this.heroku.get<NonAdvancedCredentialInfo[]>(
       `/postgres/v0/databases/${addon.id}/credentials`,
       {
-        hostname: utils.pg.host(),
         headers: {
           Authorization: `Basic ${Buffer.from(`:${this.heroku.auth}`).toString('base64')}`,
         },
+        hostname: utils.pg.host(),
       },
     )
     const sortedCredentials = this.sortByDefaultAndName(credentials)
     const {body: attachments} = await this.heroku.get<Required<Heroku.AddOnAttachment>[]>(`/addons/${addon.id}/addon-attachments`)
 
-    const presentCredential = (cred: CredentialInfo): string => {
+    const presentCredential = (cred: NonAdvancedCredentialInfo): string => {
       let credAttachments = [] as Required<Heroku.AddOnAttachment>[]
       if (cred.name === 'default') {
         credAttachments = attachments.filter(a => a.namespace === null)
@@ -60,16 +67,12 @@ export default class Credentials extends Command {
     })
   }
 
-  protected sortByDefaultAndName(credentials: CredentialsInfo) {
-    return credentials.sort((a: CredentialInfo, b: CredentialInfo) => {
+  protected sortByDefaultAndName(credentials: NonAdvancedCredentialInfo[]) {
+    return credentials.sort((a: NonAdvancedCredentialInfo, b: NonAdvancedCredentialInfo) => {
       const isDefaultA = this.isDefaultCredential(a)
       const isDefaultB = this.isDefaultCredential(b)
 
       return isDefaultB < isDefaultA ? -1 : (isDefaultA < isDefaultB ? 1 : a.name.localeCompare(b.name))
     })
   }
-
-  protected isDefaultCredential(cred: CredentialInfo): boolean {
-    return cred.name === 'default'
-  }
 }

packages/cli/src/commands/pg/credentials/url.ts

@@ -4,7 +4,7 @@ import {Args, ux} from '@oclif/core'
 import tsheredoc from 'tsheredoc'
 import {URL} from 'url'
 
-import type {CredentialInfo} from '../../../lib/pg/types.js'
+import type {NonAdvancedCredentialInfo} from '../../../lib/data/types.js'
 
 import {nls} from '../../../nls.js'
 
@@ -38,7 +38,7 @@ export default class Url extends Command {
       ux.error('Legacy Essential-tier databases do not support named credentials.')
     }
 
-    const {body: credInfo} = await this.heroku.get<CredentialInfo>(
+    const {body: credInfo} = await this.heroku.get<NonAdvancedCredentialInfo>(
       `/postgres/v0/databases/${db.name}/credentials/${encodeURIComponent(name)}`,
       {
         headers: {
@@ -52,11 +52,9 @@ export default class Url extends Command {
       ux.error(`Could not find any active credentials for ${name}`, {exit: 1})
     }
 
-    const creds = Object.assign({}, db, {
-      database: credInfo.database, host: credInfo.host, port: credInfo.port,
-    }, {
-      user: activeCreds?.user, password: activeCreds?.password,
-    })
+    const creds = {
+      ...db, database: credInfo.database, host: credInfo.host, password: activeCreds?.password, port: credInfo.port, user: activeCreds?.user,
+    }
     const connUrl = new URL(`postgres://${creds.host}/${creds.database}`)
     connUrl.port = creds.port.toString()
     if (creds.user && creds.password) {

packages/cli/src/lib/data/credentialUtils.ts

@@ -1,7 +1,7 @@
 import type {CredentialInfo} from './types.js'
 
 // NEW This is new. something similar exists in core: packages/cli/src/commands/pg/credentials.ts:61
-// protected sortByDefaultAndName(credentials: CredentialsInfo) {
+// protected sortByDefaultAndName(credentials: CredentialInfo[]) {
 //  return credentials.sort((a, b) => {
 //    const isDefaultA = this.isDefaultCredential(a)
 //    const isDefaultB = this.isDefaultCredential(b)

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

@@ -195,24 +195,6 @@ export type Link = {
     attachment_name: string,
   },
 }
-type CredentialState = 'enabling' | 'active' | 'revoking' | 'revoked' | 'archived'
-export type Credential = {
-  user: string
-  password: string
-  state: CredentialState
-  connections?: number | null
-}
-type CredentialStoreState = 'provisioning' | 'wait_for_provisioning' | 'active' | 'rotating' | 'rotation_completed' | 'revoking' | 'archived'
-export type CredentialInfo = {
-  uuid: string
-  name: string
-  state: CredentialStoreState
-  database: string
-  host: string
-  port: number
-  credentials: Array<Credential>
-}
-export type CredentialsInfo = Array<CredentialInfo>
 export type MaintenanceApiResponse = {
   message: string,
 }