heroku 10.13.2 → 11.0.0-alpha.2

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 {};

package/lib/oldCommands/pg/outliers.js

@@ -0,0 +1,110 @@
+export {};
+/*
+import {Command, flags} from '@heroku-cli/command'
+import {Args, ux} from '@oclif/core'
+import {database} from '../../lib/pg/fetcher'
+import {exec, fetchVersion} from '../../lib/pg/psql'
+import {getConnectionDetails} from '../../lib/pg/util'
+import heredoc from 'tsheredoc'
+import {nls} from '../../nls'
+
+export default class Outliers extends Command {
+  static topic = 'pg'
+  static description = 'show 10 queries that have longest execution time in aggregate'
+  static flags = {
+    reset: flags.boolean({description: 'resets statistics gathered by pg_stat_statements'}),
+    truncate: flags.boolean({char: 't', description: 'truncate queries to 40 characters'}),
+    num: flags.string({char: 'n', description: 'the number of queries to display (default: 10)'}),
+    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(Outliers)
+    const {app, reset, truncate, num} = flags
+
+    const db = await database(this.heroku, app, args.database)
+    const version = await fetchVersion(db)
+    await this.ensurePGStatStatement(db)
+
+    if (reset) {
+      await exec(db, 'SELECT pg_stat_statements_reset();')
+      return
+    }
+
+    let limit = 10
+    if (num) {
+      if (/^(\d+)$/.exec(num)) {
+        limit = Number.parseInt(num, 10)
+      } else {
+        ux.error(`Cannot parse num param value "${num}" to a number`)
+      }
+    }
+
+    const query = this.outliersQuery(version, limit, truncate)
+    const output = await exec(db, query)
+    ux.log(output)
+  }
+
+  protected async ensurePGStatStatement(db: ReturnType<typeof getConnectionDetails>) {
+    const query = heredoc`
+      SELECT exists(
+        SELECT 1
+        FROM pg_extension e
+          LEFT JOIN pg_namespace n ON n.oid = e.extnamespace
+        WHERE e.extname = 'pg_stat_statements' AND n.nspname IN ('public', 'heroku_ext')
+      ) AS available;
+    `
+    const output = await exec(db, query)
+
+    if (!output.includes('t')) {
+      ux.error(heredoc`
+        pg_stat_statements extension need to be installed first.
+        You can install it by running: CREATE EXTENSION pg_stat_statements WITH SCHEMA heroku_ext;
+      `)
+    }
+  }
+
+  protected outliersQuery(version: string | undefined, limit: number, truncate: boolean) {
+    const truncatedQueryString = truncate ? heredoc`
+      CASE WHEN length(query) <= 40 THEN query ELSE substr(query, 0, 39) || '…' END
+    ` : 'query'
+
+    let totalExecTimeField = ''
+    if (version && Number.parseInt(version, 10) >= 13) {
+      totalExecTimeField = 'total_exec_time'
+    } else {
+      totalExecTimeField = 'total_time'
+    }
+
+    let blkReadTimeField = ''
+    let blkWriteTimeField = ''
+    if (version && Number.parseInt(version, 10) >= 17) {
+      blkReadTimeField = 'shared_blk_read_time'
+      blkWriteTimeField = 'shared_blk_write_time'
+    } else {
+      blkReadTimeField = 'blk_read_time'
+      blkWriteTimeField = 'blk_write_time'
+    }
+
+    return heredoc`
+        SELECT
+          interval '1 millisecond' * ${totalExecTimeField} AS total_exec_time,
+          to_char((${totalExecTimeField}/sum(${totalExecTimeField}) OVER()) * 100, 'FM90D0') || '%'  AS prop_exec_time,
+          to_char(calls, 'FM999G999G999G990') AS ncalls,
+          interval '1 millisecond' * (${blkReadTimeField} + ${blkWriteTimeField}) AS sync_io_time,
+          ${truncatedQueryString} AS query
+        FROM pg_stat_statements
+        WHERE userid = (
+          SELECT usesysid FROM pg_user WHERE usename = current_user LIMIT 1
+        )
+        ORDER BY ${totalExecTimeField} DESC
+        LIMIT ${limit};
+      `
+  }
+}
+*/

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

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

package/lib/oldCommands/pg/promote.js

@@ -0,0 +1,183 @@
+export {};
+/* eslint-disable complexity */
+/*
+import color from '@heroku-cli/color'
+import {Command, flags} from '@heroku-cli/command'
+import {Args, ux} from '@oclif/core'
+import * as Heroku from '@heroku-cli/schema'
+import heredoc from 'tsheredoc'
+import {getAttachment, getRelease} from '../../lib/pg/fetcher'
+import pgHost from '../../lib/pg/host'
+import {PgStatus, PgDatabase} from '../../lib/pg/types'
+import {nls} from '../../nls'
+
+export default class Promote extends Command {
+  static topic = 'pg';
+  static description = 'sets DATABASE as your DATABASE_URL';
+  static flags = {
+    force: flags.boolean({char: 'f'}),
+    app: flags.app({required: true}),
+    remote: flags.remote(),
+  }
+
+  static args = {
+    database: Args.string({required: true, description: nls('pg:database:arg:description')}),
+  }
+
+  public async run(): Promise<void> {
+    const {flags, args} = await this.parse(Promote)
+    const {force, app} = flags
+    const {database} = args
+    const attachment = await getAttachment(this.heroku, app, database)
+    ux.action.start(`Ensuring an alternate alias for existing ${color.green('DATABASE_URL')}`)
+    const {body: attachments} = await this.heroku.get<Heroku.AddOnAttachment[]>(`/apps/${app}/addon-attachments`)
+    const current = attachments.find(a => a.name === 'DATABASE')
+    if (current) {
+      // eslint-disable-next-line eqeqeq
+      if (current.addon?.name === attachment.addon.name && current.namespace == attachment.namespace) {
+        if (attachment.namespace) {
+          ux.error(`${color.cyan(attachment.name)} is already promoted on ${color.app(app)}`)
+        } else {
+          ux.error(`${color.addon(attachment.addon.name)} is already promoted on ${color.app(app)}`)
+        }
+      }
+
+      const existing = attachments.filter(a => a.addon?.id === current.addon?.id && a.namespace === current.namespace)
+        .find(a => a.name !== 'DATABASE')
+      if (existing) {
+        ux.action.stop(color.green(existing.name + '_URL'))
+      } else {
+        // The current add-on occupying the DATABASE attachment has no
+        // other attachments. In order to promote this database without
+        // error, we can create a secondary attachment, just-in-time.
+        const {body: backup} = await this.heroku.post<Heroku.AddOnAttachment>('/addon-attachments', {
+          body: {
+            app: {name: app},
+            addon: {name: current.addon?.name},
+            namespace: current.namespace,
+            confirm: app,
+          },
+        })
+        ux.action.stop(color.green(backup.name + '_URL'))
+      }
+    }
+
+    if (!force) {
+      const {body: status} = await this.heroku.get<PgStatus>(`/client/v11/databases/${attachment.addon.id}/wait_status`, {
+        hostname: pgHost(),
+      })
+      if (status['waiting?']) {
+        ux.error(heredoc(`
+          Database cannot be promoted while in state: ${status.message}
+
+          Promoting this database can lead to application errors and outage. Please run ${color.cmd('heroku pg:wait')} to wait for database to become available.
+
+          To ignore this error, you can pass the --force flag to promote the database and risk application issues.
+        `))
+      }
+    }
+
+    let promotionMessage
+    if (attachment.namespace) {
+      promotionMessage = `Promoting ${color.cyan(attachment.name)} to ${color.green('DATABASE_URL')} on ${color.app(app)}`
+    } else {
+      promotionMessage = `Promoting ${color.addon(attachment.addon.name)} to ${color.green('DATABASE_URL')} on ${color.app(app)}`
+    }
+
+    ux.action.start(promotionMessage)
+    await this.heroku.post('/addon-attachments', {
+      body: {
+        name: 'DATABASE',
+        app: {name: app},
+        addon: {name: attachment.addon.name},
+        namespace: attachment.namespace || null,
+        confirm: app,
+      },
+    })
+    ux.action.stop()
+    const currentPooler = attachments.find(a => a.namespace === 'connection-pooling:default' && a.addon?.id === current?.addon?.id && a.name === 'DATABASE_CONNECTION_POOL')
+    if (currentPooler) {
+      ux.action.start('Reattaching pooler to new leader')
+      await this.heroku.post('/addon-attachments', {
+        body: {
+          name: currentPooler.name,
+          app: {name: app},
+          addon: {name: attachment.addon.name},
+          namespace: 'connection-pooling:default',
+          confirm: app,
+        },
+      })
+      ux.action.stop()
+    }
+
+    const {body: promotedDatabaseDetails} = await this.heroku.get<PgDatabase>(`/client/v11/databases/${attachment.addon.id}`, {
+      hostname: pgHost(),
+    })
+    if (promotedDatabaseDetails.following) {
+      const unfollowLeaderCmd = `heroku pg:unfollow ${attachment.addon.name}`
+      ux.warn(heredoc(`
+        Your database has been promoted but it is currently a follower database in read-only mode.
+
+        Promoting a database with ${color.cmd('heroku pg:promote')} doesn't automatically unfollow its leader.
+
+        Use ${color.cmd(unfollowLeaderCmd)} to stop this follower from replicating from its leader (${color.yellow(promotedDatabaseDetails.leader as string)}) and convert it into a writable database.
+      `))
+    }
+
+    const {body: formation} = await this.heroku.get<Heroku.Formation[]>(`/apps/${app}/formation`)
+    const releasePhase = formation.find(process => process.type === 'release')
+    if (releasePhase) {
+      ux.action.start('Checking release phase')
+      const {body: releases} = await this.heroku.get<Heroku.Release[]>(`/apps/${app}/releases`, {
+        partial: true,
+        headers: {
+          Range: 'version ..; max=5, order=desc',
+        },
+      })
+
+      const attach = releases.find(release => release.description?.includes('Attach DATABASE'))
+      const detach = releases.find(release => release.description?.includes('Detach DATABASE'))
+      if (!attach || !detach) {
+        ux.error('Unable to check release phase. Check your Attach DATABASE release for failures.')
+      }
+
+      const endTime = Date.now() + 900000 // 15 minutes from now
+      const [attachId, detachId] = [attach?.id as string, detach?.id as string]
+      while (true) {
+        const attach = await getRelease(this.heroku, app, attachId)
+        if (attach && attach.status === 'succeeded') {
+          let msg = 'pg:promote succeeded.'
+          const detach = await getRelease(this.heroku, app, detachId)
+          if (detach && detach.status === 'failed') {
+            msg += ` It is safe to ignore the failed ${detach.description} release.`
+          }
+
+          ux.action.stop(msg)
+          return
+        }
+
+        if (attach && attach.status === 'failed') {
+          let msg = `pg:promote failed because ${attach.description} release was unsuccessful. Your application is currently running `
+          const detach = await getRelease(this.heroku, app, detachId)
+          if (detach && detach.status === 'succeeded') {
+            msg += 'without an attached DATABASE_URL.'
+          } else {
+            msg += `with ${current?.addon?.name} attached as DATABASE_URL.`
+          }
+
+          msg += ' Check your release phase logs for failure causes.'
+          ux.action.stop(msg)
+          return
+        }
+
+        if (Date.now() > endTime) {
+          ux.action.stop('timeout. Check your Attach DATABASE release for failures.')
+          return
+        }
+
+        await new Promise(resolve => setTimeout(resolve, 5000))
+      }
+    }
+  }
+}
+*/

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

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

package/lib/oldCommands/pg/ps.js

@@ -0,0 +1,56 @@
+export {};
+/*
+import {Command, flags} from '@heroku-cli/command'
+import {Args} from '@oclif/core'
+import heredoc from 'tsheredoc'
+import {database} from '../../lib/pg/fetcher'
+import {exec} from '../../lib/pg/psql'
+import {nls} from '../../nls'
+
+export default class Ps extends Command {
+  static topic = 'pg'
+  static description = 'view active queries with execution time'
+  static flags = {
+    verbose: flags.boolean({char: 'v'}),
+    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(Ps)
+    const {database: databaseName} = args
+    const {verbose, app} = flags
+    const db = await database(this.heroku, app, databaseName)
+    const num = Math.random()
+    const waitingMarker = `${num}${num}`
+    const waitingQuery = heredoc(`
+    SELECT '${num}' || '${num}'
+    WHERE EXISTS
+        (SELECT 1
+         FROM information_schema.columns
+         WHERE table_schema = 'pg_catalog'
+           AND TABLE_NAME = 'pg_stat_activity'
+           AND COLUMN_NAME = 'waiting')
+    `)
+    const waitingOutput = await exec(db, waitingQuery)
+    const waiting = waitingOutput.includes(waitingMarker) ? 'waiting' : 'wait_event IS NOT NULL AS waiting'
+    const query = heredoc(`SELECT pid,
+           state,
+           application_name AS SOURCE,
+           usename AS username,
+           age(now(), xact_start) AS running_for,
+           xact_start AS transaction_start, ${waiting}, query
+    FROM pg_stat_activity
+    WHERE query <> '<insufficient privilege>' ${verbose ? '' : "AND state <> 'idle'"}
+      AND pid <> pg_backend_pid()
+    ORDER BY query_start DESC
+    `)
+    const output = await exec(db, query)
+    process.stdout.write(output)
+  }
+}
+*/

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

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

package/lib/oldCommands/pg/psql.js

@@ -0,0 +1,53 @@
+export {};
+/*
+import color from '@heroku-cli/color'
+import {Command, flags} from '@heroku-cli/command'
+import {Args} from '@oclif/core'
+import {database} from '../../lib/pg/fetcher'
+import {exec, execFile, interactive} from '../../lib/pg/psql'
+import {nls} from '../../nls'
+
+export default class Psql extends Command {
+    static description = 'open a psql shell to the database';
+    static flags = {
+      command: flags.string({char: 'c', description: 'SQL command to run'}),
+      file: flags.string({char: 'f', description: 'SQL file to run'}),
+      credential: flags.string({description: 'credential to use'}),
+      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 aliases = ['psql']
+
+    public async run(): Promise<void> {
+      const {flags, args} = await this.parse(Psql)
+      const {app, command, credential, file} = flags
+      const namespace = credential ? `credential:${credential}` : undefined
+      let db
+      try {
+        db = await database(this.heroku, app, args.database, namespace)
+      } catch (error) {
+        if (namespace && error instanceof Error && error.message === "Couldn't find that addon.") {
+          throw new Error("Credential doesn't match, make sure credential is attached")
+        }
+
+        throw error
+      }
+
+      console.error(`--> Connecting to ${color.yellow(db.attachment.addon.name)}`)
+      if (command) {
+        const output = await exec(db, command)
+        process.stdout.write(output)
+      } else if (file) {
+        const output = await execFile(db, file)
+        process.stdout.write(output)
+      } else {
+        await interactive(db)
+      }
+    }
+}
+*/

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

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