heroku 10.13.2 → 11.0.0-alpha.10

package/lib/oldCommands/pg/info.js

@@ -0,0 +1,110 @@
+export {};
+/*
+import color from '@heroku-cli/color'
+import {Command, flags} from '@heroku-cli/command'
+import {Args, ux} from '@oclif/core'
+import {hux} from '@heroku/heroku-cli-util'
+import * as Heroku from '@heroku-cli/schema'
+import pghost from '../../lib/pg/host'
+import {getAddon, all} from '../../lib/pg/fetcher'
+import {configVarNamesFromValue, databaseNameFromUrl} from '../../lib/pg/util'
+import {AddOnAttachmentWithConfigVarsAndPlan, AddOnWithRelatedData, PgDatabaseTenant} from '../../lib/pg/types'
+import {nls} from '../../nls'
+
+type DBObject = {
+  addon: AddOnAttachmentWithConfigVarsAndPlan | AddOnWithRelatedData,
+  configVars?: string[],
+  dbInfo: PgDatabaseTenant | null,
+  config: Heroku.ConfigVars,
+}
+
+function displayDB(db: DBObject, app: string) {
+  if (db.addon.attachment_names) {
+    hux.styledHeader(db.addon.attachment_names.map((c: string) => color.green(c + '_URL'))
+      .join(', '))
+  } else {
+    hux.styledHeader(db.configVars?.map(c => color.green(c))
+      .join(', ') || '')
+  }
+
+  if (db.addon.app.name && db.addon.app.name !== app) {
+    db.dbInfo?.info.push({name: 'Billing App', values: [color.cyan(db.addon.app.name)]})
+  }
+
+  db.dbInfo?.info.push({name: 'Add-on', values: [color.yellow(db.addon.name)]})
+  const info: Record<string, never> | Record<string, string> = {}
+  db.dbInfo?.info.forEach(infoObject => {
+    if (infoObject.values.length > 0) {
+      let valuesArray: string[]
+      if (infoObject.resolve_db_name) {
+        valuesArray = infoObject.values.map(v => databaseNameFromUrl(v, db.config))
+      } else {
+        valuesArray = infoObject.values
+      }
+
+      info[infoObject.name] = valuesArray.join(', ')
+    }
+  })
+  const keys = db.dbInfo?.info.map(i => i.name)
+  hux.styledObject(info, keys)
+  ux.log()
+}
+
+export default class Info extends Command {
+    static topic = 'pg';
+    static description = 'show database information';
+    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:all-dbs:suffix')}`}),
+    };
+
+    static aliases = ['pg']
+
+    public async run(): Promise<void> {
+      const {flags, args} = await this.parse(Info)
+      const {app} = flags
+      const {sortBy} = require('lodash')
+      const {database: db} = args
+      let addons: AddOnAttachmentWithConfigVarsAndPlan[] | AddOnWithRelatedData[]
+      const {body: config} = await this.heroku.get<Heroku.ConfigVars>(`/apps/${app}/config-vars`)
+      if (db) {
+        addons = await Promise.all([getAddon(this.heroku, app, db)])
+      } else {
+        addons = await all(this.heroku, app)
+        if (addons.length === 0) {
+          ux.log(`${color.magenta(app)} has no heroku-postgresql databases.`)
+          return
+        }
+      }
+
+      let dbs: DBObject[] = await Promise.all(addons.map(async addon => {
+        const pgResponse = await this.heroku.get<PgDatabaseTenant>(
+          `/client/v11/databases/${addon.id}`,
+          {
+            hostname: pghost(),
+          })
+          .catch(error => {
+            if (error.statusCode !== 404)
+              throw error
+            ux.warn(`${color.yellow(addon.name)} is not yet provisioned.\nRun ${color.cyan.bold('heroku addons:wait')} to wait until the db is provisioned.`)
+          })
+        const {body: dbInfo} = pgResponse || {body: null}
+        return {
+          addon,
+          config,
+          dbInfo,
+        }
+      }))
+      dbs = dbs.filter(db => db.dbInfo)
+      dbs.forEach(db => {
+        db.configVars = configVarNamesFromValue(db.config, db.dbInfo?.resource_url || '')
+      })
+      dbs = sortBy(dbs, (db: DBObject) => db.configVars && db.configVars[0] !== 'DATABASE_URL', 'configVars[0]')
+      dbs.forEach(db => displayDB(db, app))
+    }
+}
+*/

package/lib/oldCommands/pg/kill.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/oldCommands/pg/kill.js

@@ -0,0 +1,37 @@
+export {};
+/*
+import {Command, flags} from '@heroku-cli/command'
+import {Args, ux} from '@oclif/core'
+import {database} from '../../lib/pg/fetcher'
+import {exec} from '../../lib/pg/psql'
+import heredoc from 'tsheredoc'
+import {nls} from '../../nls'
+
+export default class Kill extends Command {
+  static topic = 'pg';
+  static description = 'kill a query';
+  static flags = {
+    force: flags.boolean({char: 'f'}),
+    app: flags.app({required: true}),
+    remote: flags.remote(),
+  };
+
+  static args = {
+    pid: Args.string({required: true, description: 'ID of the process'}),
+    database: Args.string({description: `${nls('pg:database:arg:description')} ${nls('pg:database:arg:description:default:suffix')}`}),
+  };
+
+  public async run(): Promise<void> {
+    const {flags, args} = await this.parse(Kill)
+    const {app, force} = flags
+    const {pid} = args
+
+    const db = await database(this.heroku, app, args.database)
+    const query = heredoc`
+      SELECT ${force ? 'pg_terminate_backend' : 'pg_cancel_backend'}(${Number.parseInt(pid, 10)});
+    `
+    const output = await exec(db, query)
+    ux.log(output)
+  }
+}
+*/

package/lib/oldCommands/pg/killall.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/oldCommands/pg/killall.js

@@ -0,0 +1,31 @@
+export {};
+/*
+import {Command, flags} from '@heroku-cli/command'
+import {Args, ux} from '@oclif/core'
+import {getAddon} from '../../lib/pg/fetcher'
+import pghost from '../../lib/pg/host'
+import {nls} from '../../nls'
+
+export default class Killall extends Command {
+  static topic = 'pg'
+  static description = 'terminates all connections for all credentials'
+  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')}`}),
+  }
+
+  public async run(): Promise<void> {
+    const {flags, args} = await this.parse(Killall)
+    const {app} = flags
+
+    ux.action.start('Terminating connections for all credentials')
+    const database = await getAddon(this.heroku, app, args.database)
+    await this.heroku.post(`/client/v11/databases/${database.id}/connection_reset`, {hostname: pghost()})
+    ux.action.stop()
+  }
+}
+*/

package/lib/oldCommands/pg/links/create.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/oldCommands/pg/links/create.js

@@ -0,0 +1,70 @@
+export {};
+/*
+import color from '@heroku-cli/color'
+import {Command, flags} from '@heroku-cli/command'
+import {Args, ux} from '@oclif/core'
+import heredoc from 'tsheredoc'
+import {addonResolver} from '../../../lib/addons/resolve'
+import {getAddon} from '../../../lib/pg/fetcher'
+import host from '../../../lib/pg/host'
+import type {AddOnAttachmentWithConfigVarsAndPlan, Link} from '../../../lib/pg/types'
+import {essentialPlan} from '../../../lib/pg/util'
+import {nls} from '../../../nls'
+
+export default class Create extends Command {
+  static topic = 'pg'
+  static description = heredoc(`
+  create a link between data stores
+  Example:
+  heroku pg:links:create HEROKU_REDIS_RED HEROKU_POSTGRESQL_CERULEAN
+  `)
+
+  static flags = {
+    as: flags.string({description: 'name of link to create'}),
+    app: flags.app({required: true}),
+    remote: flags.remote(),
+  }
+
+  static args = {
+    remote: Args.string({required: true, description: nls('pg:database:arg:description')}),
+    database: Args.string({required: true, description: nls('pg:database:arg:description')}),
+  }
+
+  public async run(): Promise<void> {
+    const {flags, args} = await this.parse(Create)
+    const {app} = flags
+
+    const service = async (remoteId: string) => {
+      const addon = await addonResolver(this.heroku, app, remoteId)
+      if (!addon.plan.name.match(/^heroku-(redis|postgresql)/))
+        throw new Error('Remote database must be heroku-redis or heroku-postgresql')
+      return addon
+    }
+
+    const [db, target] = await Promise.all([
+      getAddon(this.heroku, app, args.database),
+      service(args.remote),
+    ]) as [AddOnAttachmentWithConfigVarsAndPlan, AddOnAttachmentWithConfigVarsAndPlan]
+
+    if (essentialPlan(db))
+      throw new Error('pg:links isn’t available for Essential-tier databases.')
+    if (essentialPlan(target))
+      throw new Error('pg:links isn’t available for Essential-tier databases.')
+
+    ux.action.start(`Adding link from ${color.yellow(target.name)} to ${color.yellow(db.name)}`)
+    const {body: link} = await this.heroku.post<Link>(`/client/v11/databases/${db.id}/links`, {
+      body: {
+        target: target.name,
+        as: flags.as,
+      },
+      hostname: host(),
+    })
+
+    if (link.message) {
+      throw new Error(link.message)
+    }
+
+    ux.action.stop(`done, ${color.cyan(link.name)}`)
+  }
+}
+*/

package/lib/oldCommands/pg/links/destroy.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/oldCommands/pg/links/destroy.js

@@ -0,0 +1,51 @@
+export {};
+/*
+import color from '@heroku-cli/color'
+import {Command, flags} from '@heroku-cli/command'
+import {Args, ux} from '@oclif/core'
+import {getAddon} from '../../../lib/pg/fetcher'
+import {essentialPlan} from '../../../lib/pg/util'
+import confirmCommand from '../../../lib/confirmCommand'
+import heredoc from 'tsheredoc'
+import pgHost from '../../../lib/pg/host'
+import {nls} from '../../../nls'
+
+export default class Destroy extends Command {
+  static topic = 'pg';
+  static description = 'destroys a link between data stores';
+  static example = '$ heroku pg:links:destroy HEROKU_POSTGRESQL_CERULEAN redis-symmetrical-100';
+
+  static flags = {
+    app: flags.app({required: true}),
+    confirm: flags.string({char: 'c'}),
+    remote: flags.remote(),
+  };
+
+  static args = {
+    database: Args.string({required: true, description: nls('pg:database:arg:description')}),
+    link: Args.string({required: true, description: 'name of the linked data store'}),
+  };
+
+  public async run(): Promise<void> {
+    const {flags, args} = await this.parse(Destroy)
+    const {app, confirm} = flags
+    const {database, link} = args
+    const db = await getAddon(this.heroku, app, database)
+    if (essentialPlan(db))
+      throw new Error('pg:links isn’t available for Essential-tier databases.')
+    await confirmCommand(app, confirm, heredoc(`
+      Destructive action
+      This command will affect the database ${color.yellow(db.name)}
+      This will delete ${color.cyan(link)} along with the tables and views created within it.
+      This may have adverse effects for software written against the ${color.cyan(link)} schema.
+    `))
+
+    ux.action.start(`Destroying link ${color.cyan(link)} from ${color.yellow(db.name)}`)
+    await this.heroku.delete(
+      `/client/v11/databases/${db.id}/links/${encodeURIComponent(link)}`,
+      {hostname: pgHost()},
+    )
+    ux.action.stop()
+  }
+}
+*/

package/lib/oldCommands/pg/links/index.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/oldCommands/pg/links/index.js

@@ -0,0 +1,64 @@
+export {};
+/*
+import color from '@heroku-cli/color'
+import {Command, flags} from '@heroku-cli/command'
+import {Args, ux} from '@oclif/core'
+import {hux} from '@heroku/heroku-cli-util'
+import {getAddon, all} from '../../../lib/pg/fetcher'
+import pgHost from '../../../lib/pg/host'
+import type {Link} from '../../../lib/pg/types'
+import {nls} from '../../../nls'
+
+export default class Index extends Command {
+  static topic = 'pg';
+  static description = 'lists all databases and information on link';
+  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')}`}),
+  };
+
+  public async run(): Promise<void> {
+    const {flags, args} = await this.parse(Index)
+    const {app} = flags
+    const {database} = args
+    let dbs
+    if (database)
+      dbs = await Promise.all([getAddon(this.heroku, app, database)])
+    else
+      dbs = await all(this.heroku, app)
+    if (dbs.length === 0)
+      throw new Error(`No databases on ${color.app(app)}`)
+    dbs = await Promise.all(dbs.map(async db => {
+      const {body: links} = await this.heroku.get<Link[]>(`/client/v11/databases/${db.id}/links`, {hostname: pgHost()})
+      db.links = links
+      return db
+    }))
+    let once: boolean
+    dbs.forEach(db => {
+      if (once)
+        ux.log()
+      else
+        once = true
+      hux.styledHeader(color.yellow(db.name))
+      if (db.links.message)
+        return ux.log(db.links.message)
+      if (db.links.length === 0)
+        return ux.log('No data sources are linked into this database')
+      db.links.forEach((link: Link) => {
+        ux.log(` * ${color.cyan(link.name)}`)
+        const remoteAttachmentName = link.remote?.attachment_name || ''
+        const remoteName = link.remote?.name || ''
+        const remoteLinkText = `${color.green(remoteAttachmentName)} (${color.yellow(remoteName)})`
+        hux.styledObject({
+          created_at: link.created_at,
+          remote: remoteLinkText,
+        })
+      })
+    })
+  }
+}
+*/

package/lib/oldCommands/pg/locks.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/oldCommands/pg/locks.js

@@ -0,0 +1,60 @@
+export {};
+/*
+import {Command, flags} from '@heroku-cli/command'
+import {Args, ux} from '@oclif/core'
+import {database} from '../../lib/pg/fetcher'
+import {exec} from '../../lib/pg/psql'
+import heredoc from 'tsheredoc'
+import {nls} from '../../nls'
+
+export default class Locks extends Command {
+  static topic = 'pg'
+  static description = 'display queries with active locks'
+  static flags = {
+    truncate: flags.boolean({char: 't', description: 'truncates queries to 40 characters'}),
+    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')}`}),
+  }
+
+  public async run(): Promise<void> {
+    const {flags, args} = await this.parse(Locks)
+    const {app, truncate} = flags
+    const db = await database(this.heroku, app, args.database)
+    const query = heredoc`
+      SELECT
+        pg_stat_activity.pid,
+        pg_class.relname,
+        pg_locks.transactionid,
+        pg_locks.granted,
+        ${this.truncatedQueryString(truncate)} AS query_snippet,
+        age(now(), pg_stat_activity.query_start) AS "age"
+      FROM
+        pg_stat_activity,
+        pg_locks
+          LEFT OUTER JOIN pg_class
+          ON pg_locks.relation = pg_class.oid
+      WHERE
+        pg_stat_activity.query <> '<insufficient privilege>'
+        AND pg_locks.pid = pg_stat_activity.pid
+        AND pg_locks.mode = 'ExclusiveLock'
+        AND pg_stat_activity.pid <> pg_backend_pid() order by query_start;
+    `
+
+    const output = await exec(db, query)
+    ux.log(output)
+  }
+
+  protected truncatedQueryString(truncate: boolean) {
+    const column = 'pg_stat_activity.query'
+    if (truncate) {
+      return `CASE WHEN length(${column}) <= 40 THEN ${column} ELSE substr(${column}, 0, 39) || '…' END`
+    }
+
+    return column
+  }
+}
+*/

package/lib/oldCommands/pg/maintenance/index.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/oldCommands/pg/maintenance/index.js

@@ -0,0 +1,34 @@
+export {};
+/*
+import {Command, flags} from '@heroku-cli/command'
+import {Args, ux} from '@oclif/core'
+import {getAddon} from '../../../lib/pg/fetcher'
+import {essentialPlan} from '../../../lib/pg/util'
+import pgHost from '../../../lib/pg/host'
+import {MaintenanceApiResponse} from '../../../lib/pg/types'
+import {nls} from '../../../nls'
+
+export default class Index extends Command {
+  static topic = 'pg';
+  static description = 'show current maintenance information';
+  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')}`}),
+  }
+
+  public async run(): Promise<void> {
+    const {flags, args} = await this.parse(Index)
+    const {app} = flags
+    const {database} = args
+    const db = await getAddon(this.heroku, app, database)
+    if (essentialPlan(db))
+      ux.error('pg:maintenance isn’t available for Essential-tier databases.')
+    const {body: info} = await this.heroku.get<MaintenanceApiResponse>(`/client/v11/databases/${db.id}/maintenance`, {hostname: pgHost()})
+    ux.log(info.message)
+  }
+}
+*/

package/lib/oldCommands/pg/maintenance/run.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/oldCommands/pg/maintenance/run.js

@@ -0,0 +1,44 @@
+export {};
+/*
+import color from '@heroku-cli/color'
+import {Command, flags} from '@heroku-cli/command'
+import {Args, ux} from '@oclif/core'
+import {getAddon} from '../../../lib/pg/fetcher'
+import {essentialPlan} from '../../../lib/pg/util'
+import pgHost from '../../../lib/pg/host'
+import {MaintenanceApiResponse} from '../../../lib/pg/types'
+import * as Heroku from '@heroku-cli/schema'
+import {nls} from '../../../nls'
+
+export default class Run extends Command {
+  static topic = 'pg'
+  static description = 'start maintenance'
+  static flags = {
+    force: flags.boolean({char: 'f'}),
+    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')}`}),
+  }
+
+  public async run(): Promise<void> {
+    const {flags, args} = await this.parse(Run)
+    const {app, force} = flags
+    const {database} = args
+    const db = await getAddon(this.heroku, app, database)
+    if (essentialPlan(db))
+      ux.error("pg:maintenance isn't available for Essential-tier databases.")
+    ux.action.start(`Starting maintenance for ${color.yellow(db.name)}`)
+    if (!force) {
+      const {body: appInfo} = await this.heroku.get<Heroku.App>(`/apps/${app}`)
+      if (!appInfo.maintenance)
+        ux.error('Application must be in maintenance mode or run with --force')
+    }
+
+    const {body: response} = await this.heroku.post<MaintenanceApiResponse>(`/client/v11/databases/${db.id}/maintenance`, {hostname: pgHost()})
+    ux.action.stop(response.message || 'done')
+  }
+}
+*/

package/lib/oldCommands/pg/maintenance/window.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/oldCommands/pg/maintenance/window.js

@@ -0,0 +1,52 @@
+export {};
+/*
+import color from '@heroku-cli/color'
+import {Command, flags} from '@heroku-cli/command'
+import {Args, ux} from '@oclif/core'
+import pgHost from '../../../lib/pg/host'
+import {essentialPlan} from '../../../lib/pg/util'
+import {getAddon} from '../../../lib/pg/fetcher'
+import {MaintenanceApiResponse} from '../../../lib/pg/types'
+import heredoc from 'tsheredoc'
+import {nls} from '../../../nls'
+
+export default class Window extends Command {
+  static topic = 'pg';
+  static description = heredoc(`
+    Set weekly maintenance window.
+    All times are in UTC.
+  `);
+
+  static example = '$ heroku pg:maintenance:window "Sunday 06:00" postgres-slippery-100';
+
+  static flags = {
+    app: flags.app({required: true}),
+    remote: flags.remote(),
+  };
+
+  static args = {
+    window: Args.string({required: true, description: 'timestamp of the maintenance window'}),
+    database: Args.string({description: `${nls('pg:database:arg:description')} ${nls('pg:database:arg:description:default:suffix')}`}),
+  };
+
+  public async run(): Promise<void> {
+    const {args, flags} = await this.parse(Window)
+    const {database, window} = args
+    const {app} = flags
+    const db = await getAddon(this.heroku, app, database)
+    if (essentialPlan(db))
+      ux.error("pg:maintenance isn't available for Essential-tier databases.")
+    if (!window.match(/^[A-Za-z]{2,10} \d\d?:[03]0$/))
+      ux.error('Window must be "Day HH:MM" where MM is 00 or 30')
+
+    ux.action.start(`Setting maintenance window for ${color.yellow(db.name)} to ${color.cyan(window)}`)
+    const {body: response} = await this.heroku.put<MaintenanceApiResponse>(
+      `/client/v11/databases/${db.id}/maintenance_window`,
+      {
+        body: {description: window}, hostname: pgHost(),
+      },
+    )
+    ux.action.stop(response.message || 'done')
+  }
+}
+*/

package/lib/oldCommands/pg/outliers.d.ts

@@ -0,0 +1 @@
+export {};