heroku 9.0.0-dev.0 → 9.0.0

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

@@ -0,0 +1,16 @@
+import { Command } from '@heroku-cli/command';
+export default class Destroy extends Command {
+    static topic: string;
+    static description: string;
+    static example: string;
+    static flags: {
+        app: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        confirm: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        remote: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+    };
+    static args: {
+        database: import("@oclif/core/lib/interfaces/parser").Arg<string, Record<string, unknown>>;
+        link: import("@oclif/core/lib/interfaces/parser").Arg<string, Record<string, unknown>>;
+    };
+    run(): Promise<void>;
+}

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

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const color_1 = require("@heroku-cli/color");
+const command_1 = require("@heroku-cli/command");
+const core_1 = require("@oclif/core");
+const fetcher_1 = require("../../../lib/pg/fetcher");
+const util_1 = require("../../../lib/pg/util");
+const confirmCommand_1 = require("../../../lib/confirmCommand");
+const tsheredoc_1 = require("tsheredoc");
+const host_1 = require("../../../lib/pg/host");
+class Destroy extends command_1.Command {
+    async run() {
+        const { flags, args } = await this.parse(Destroy);
+        const { app, confirm } = flags;
+        const { database, link } = args;
+        const db = await (0, fetcher_1.getAddon)(this.heroku, app, database);
+        if ((0, util_1.essentialPlan)(db))
+            throw new Error('pg:links isn’t available for Essential-tier databases.');
+        await (0, confirmCommand_1.default)(app, confirm, (0, tsheredoc_1.default)(`
+      Destructive action
+      This command will affect the database ${color_1.default.yellow(db.name)}
+      This will delete ${color_1.default.cyan(link)} along with the tables and views created within it.
+      This may have adverse effects for software written against the ${color_1.default.cyan(link)} schema.
+    `));
+        core_1.ux.action.start(`Destroying link ${color_1.default.cyan(link)} from ${color_1.default.yellow(db.name)}`);
+        await this.heroku.delete(`/client/v11/databases/${db.id}/links/${encodeURIComponent(link)}`, { hostname: (0, host_1.default)() });
+        core_1.ux.action.stop();
+    }
+}
+exports.default = Destroy;
+Destroy.topic = 'pg';
+Destroy.description = 'destroys a link between data stores';
+Destroy.example = '$ heroku pg:links:destroy HEROKU_POSTGRESQL_CERULEAN redis-symmetrical-100';
+Destroy.flags = {
+    app: command_1.flags.app({ required: true }),
+    confirm: command_1.flags.string({ char: 'c' }),
+    remote: command_1.flags.remote(),
+};
+Destroy.args = {
+    database: core_1.Args.string({ required: true }),
+    link: core_1.Args.string({ required: true }),
+};

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

@@ -0,0 +1,13 @@
+import { Command } from '@heroku-cli/command';
+export default class Index extends Command {
+    static topic: string;
+    static description: string;
+    static flags: {
+        app: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        remote: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+    };
+    static args: {
+        database: import("@oclif/core/lib/interfaces/parser").Arg<string | undefined, Record<string, unknown>>;
+    };
+    run(): Promise<void>;
+}

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

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const color_1 = require("@heroku-cli/color");
+const command_1 = require("@heroku-cli/command");
+const core_1 = require("@oclif/core");
+const fetcher_1 = require("../../../lib/pg/fetcher");
+const host_1 = require("../../../lib/pg/host");
+class Index extends command_1.Command {
+    async run() {
+        const { flags, args } = await this.parse(Index);
+        const { app } = flags;
+        const { database } = args;
+        let dbs;
+        if (database)
+            dbs = await Promise.all([(0, fetcher_1.getAddon)(this.heroku, app, database)]);
+        else
+            dbs = await (0, fetcher_1.all)(this.heroku, app);
+        if (dbs.length === 0)
+            throw new Error(`No databases on ${color_1.default.app(app)}`);
+        dbs = await Promise.all(dbs.map(async (db) => {
+            const { body: links } = await this.heroku.get(`/client/v11/databases/${db.id}/links`, { hostname: (0, host_1.default)() });
+            db.links = links;
+            return db;
+        }));
+        let once;
+        dbs.forEach(db => {
+            if (once)
+                core_1.ux.log();
+            else
+                once = true;
+            core_1.ux.styledHeader(color_1.default.yellow(db.name));
+            if (db.links.message)
+                return core_1.ux.log(db.links.message);
+            if (db.links.length === 0)
+                return core_1.ux.log('No data sources are linked into this database');
+            db.links.forEach((link) => {
+                var _a, _b;
+                core_1.ux.log(` * ${color_1.default.cyan(link.name)}`);
+                const remoteAttachmentName = ((_a = link.remote) === null || _a === void 0 ? void 0 : _a.attachment_name) || '';
+                const remoteName = ((_b = link.remote) === null || _b === void 0 ? void 0 : _b.name) || '';
+                const remoteLinkText = `${color_1.default.green(remoteAttachmentName)} (${color_1.default.yellow(remoteName)})`;
+                core_1.ux.styledObject({
+                    created_at: link.created_at,
+                    remote: remoteLinkText,
+                });
+            });
+        });
+    }
+}
+exports.default = Index;
+Index.topic = 'pg';
+Index.description = 'lists all databases and information on link';
+Index.flags = {
+    app: command_1.flags.app({ required: true }),
+    remote: command_1.flags.remote(),
+};
+Index.args = {
+    database: core_1.Args.string(),
+};

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

@@ -0,0 +1,15 @@
+import { Command } from '@heroku-cli/command';
+export default class Locks extends Command {
+    static topic: string;
+    static description: string;
+    static flags: {
+        truncate: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        app: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        remote: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+    };
+    static args: {
+        database: import("@oclif/core/lib/interfaces/parser").Arg<string | undefined, Record<string, unknown>>;
+    };
+    run(): Promise<void>;
+    protected truncatedQueryString(truncate: boolean): string;
+}

package/lib/commands/pg/locks.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const command_1 = require("@heroku-cli/command");
+const core_1 = require("@oclif/core");
+const fetcher_1 = require("../../lib/pg/fetcher");
+const psql_1 = require("../../lib/pg/psql");
+const tsheredoc_1 = require("tsheredoc");
+class Locks extends command_1.Command {
+    async run() {
+        const { flags, args } = await this.parse(Locks);
+        const { app, truncate } = flags;
+        const db = await (0, fetcher_1.database)(this.heroku, app, args.database);
+        const query = (0, tsheredoc_1.default) `
+      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 (0, psql_1.exec)(db, query);
+        core_1.ux.log(output);
+    }
+    truncatedQueryString(truncate) {
+        const column = 'pg_stat_activity.query';
+        if (truncate) {
+            return `CASE WHEN length(${column}) <= 40 THEN ${column} ELSE substr(${column}, 0, 39) || '…' END`;
+        }
+        return column;
+    }
+}
+exports.default = Locks;
+Locks.topic = 'pg';
+Locks.description = 'display queries with active locks';
+Locks.flags = {
+    truncate: command_1.flags.boolean({ char: 't', description: 'truncates queries to 40 characters' }),
+    app: command_1.flags.app({ required: true }),
+    remote: command_1.flags.remote(),
+};
+Locks.args = {
+    database: core_1.Args.string(),
+};

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

@@ -0,0 +1,13 @@
+import { Command } from '@heroku-cli/command';
+export default class Index extends Command {
+    static topic: string;
+    static description: string;
+    static flags: {
+        app: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        remote: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+    };
+    static args: {
+        database: import("@oclif/core/lib/interfaces/parser").Arg<string | undefined, Record<string, unknown>>;
+    };
+    run(): Promise<void>;
+}

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

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const command_1 = require("@heroku-cli/command");
+const core_1 = require("@oclif/core");
+const fetcher_1 = require("../../../lib/pg/fetcher");
+const util_1 = require("../../../lib/pg/util");
+const host_1 = require("../../../lib/pg/host");
+class Index extends command_1.Command {
+    async run() {
+        const { flags, args } = await this.parse(Index);
+        const { app } = flags;
+        const { database } = args;
+        const db = await (0, fetcher_1.getAddon)(this.heroku, app, database);
+        if ((0, util_1.essentialPlan)(db))
+            core_1.ux.error('pg:maintenance isn’t available for Essential-tier databases.');
+        const { body: info } = await this.heroku.get(`/client/v11/databases/${db.id}/maintenance`, { hostname: (0, host_1.default)() });
+        core_1.ux.log(info.message);
+    }
+}
+exports.default = Index;
+Index.topic = 'pg';
+Index.description = 'show current maintenance information';
+Index.flags = {
+    app: command_1.flags.app({ required: true }),
+    remote: command_1.flags.remote(),
+};
+Index.args = {
+    database: core_1.Args.string(),
+};

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

@@ -0,0 +1,14 @@
+import { Command } from '@heroku-cli/command';
+export default class Run extends Command {
+    static topic: string;
+    static description: string;
+    static flags: {
+        force: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        app: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        remote: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+    };
+    static args: {
+        database: import("@oclif/core/lib/interfaces/parser").Arg<string | undefined, Record<string, unknown>>;
+    };
+    run(): Promise<void>;
+}

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

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const color_1 = require("@heroku-cli/color");
+const command_1 = require("@heroku-cli/command");
+const core_1 = require("@oclif/core");
+const fetcher_1 = require("../../../lib/pg/fetcher");
+const util_1 = require("../../../lib/pg/util");
+const host_1 = require("../../../lib/pg/host");
+class Run extends command_1.Command {
+    async run() {
+        const { flags, args } = await this.parse(Run);
+        const { app, force } = flags;
+        const { database } = args;
+        const db = await (0, fetcher_1.getAddon)(this.heroku, app, database);
+        if ((0, util_1.essentialPlan)(db))
+            core_1.ux.error("pg:maintenance isn't available for Essential-tier databases.");
+        core_1.ux.action.start(`Starting maintenance for ${color_1.default.yellow(db.name)}`);
+        if (!force) {
+            const { body: appInfo } = await this.heroku.get(`/apps/${app}`);
+            if (!appInfo.maintenance)
+                core_1.ux.error('Application must be in maintenance mode or run with --force');
+        }
+        const { body: response } = await this.heroku.post(`/client/v11/databases/${db.id}/maintenance`, { hostname: (0, host_1.default)() });
+        core_1.ux.action.stop(response.message || 'done');
+    }
+}
+exports.default = Run;
+Run.topic = 'pg';
+Run.description = 'start maintenance';
+Run.flags = {
+    force: command_1.flags.boolean({ char: 'f' }),
+    app: command_1.flags.app({ required: true }),
+    remote: command_1.flags.remote(),
+};
+Run.args = {
+    database: core_1.Args.string(),
+};

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

@@ -0,0 +1,15 @@
+import { Command } from '@heroku-cli/command';
+export default class Window extends Command {
+    static topic: string;
+    static description: string;
+    static example: string;
+    static flags: {
+        app: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        remote: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+    };
+    static args: {
+        window: import("@oclif/core/lib/interfaces/parser").Arg<string, Record<string, unknown>>;
+        database: import("@oclif/core/lib/interfaces/parser").Arg<string | undefined, Record<string, unknown>>;
+    };
+    run(): Promise<void>;
+}

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

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const color_1 = require("@heroku-cli/color");
+const command_1 = require("@heroku-cli/command");
+const core_1 = require("@oclif/core");
+const host_1 = require("../../../lib/pg/host");
+const util_1 = require("../../../lib/pg/util");
+const fetcher_1 = require("../../../lib/pg/fetcher");
+const tsheredoc_1 = require("tsheredoc");
+class Window extends command_1.Command {
+    async run() {
+        const { args, flags } = await this.parse(Window);
+        const { database, window } = args;
+        const { app } = flags;
+        const db = await (0, fetcher_1.getAddon)(this.heroku, app, database);
+        if ((0, util_1.essentialPlan)(db))
+            core_1.ux.error("pg:maintenance isn't available for Essential-tier databases.");
+        if (!window.match(/^[A-Za-z]{2,10} \d\d?:[03]0$/))
+            core_1.ux.error('Window must be "Day HH:MM" where MM is 00 or 30');
+        core_1.ux.action.start(`Setting maintenance window for ${color_1.default.yellow(db.name)} to ${color_1.default.cyan(window)}`);
+        const { body: response } = await this.heroku.put(`/client/v11/databases/${db.id}/maintenance_window`, {
+            body: { description: window }, hostname: (0, host_1.default)(),
+        });
+        core_1.ux.action.stop(response.message || 'done');
+    }
+}
+exports.default = Window;
+Window.topic = 'pg';
+Window.description = (0, tsheredoc_1.default)(`
+    Set weekly maintenance window.
+    All times are in UTC.
+  `);
+Window.example = '$ heroku pg:maintenance:window "Sunday 06:00" postgres-slippery-100';
+Window.flags = {
+    app: command_1.flags.app({ required: true }),
+    remote: command_1.flags.remote(),
+};
+Window.args = {
+    window: core_1.Args.string({ required: true }),
+    database: core_1.Args.string(),
+};

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

@@ -0,0 +1,19 @@
+import { Command } from '@heroku-cli/command';
+import { getConnectionDetails } from '../../lib/pg/util';
+export default class Outliers extends Command {
+    static topic: string;
+    static description: string;
+    static flags: {
+        reset: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        truncate: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        num: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        app: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        remote: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+    };
+    static args: {
+        database: import("@oclif/core/lib/interfaces/parser").Arg<string | undefined, Record<string, unknown>>;
+    };
+    run(): Promise<void>;
+    protected ensurePGStatStatement(db: ReturnType<typeof getConnectionDetails>): Promise<void>;
+    protected outliersQuery(version: string | undefined, limit: number, truncate: boolean): string;
+}

package/lib/commands/pg/outliers.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const command_1 = require("@heroku-cli/command");
+const core_1 = require("@oclif/core");
+const fetcher_1 = require("../../lib/pg/fetcher");
+const psql_1 = require("../../lib/pg/psql");
+const tsheredoc_1 = require("tsheredoc");
+class Outliers extends command_1.Command {
+    async run() {
+        const { flags, args } = await this.parse(Outliers);
+        const { app, reset, truncate, num } = flags;
+        const db = await (0, fetcher_1.database)(this.heroku, app, args.database);
+        const version = await (0, psql_1.fetchVersion)(db);
+        await this.ensurePGStatStatement(db);
+        if (reset) {
+            await (0, psql_1.exec)(db, 'SELECT pg_stat_statements_reset();');
+            return;
+        }
+        let limit = 10;
+        if (num) {
+            if (/^(\d+)$/.exec(num)) {
+                limit = Number.parseInt(num, 10);
+            }
+            else {
+                core_1.ux.error(`Cannot parse num param value "${num}" to a number`);
+            }
+        }
+        const query = this.outliersQuery(version, limit, truncate);
+        const output = await (0, psql_1.exec)(db, query);
+        core_1.ux.log(output);
+    }
+    async ensurePGStatStatement(db) {
+        const query = (0, tsheredoc_1.default) `
+      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 (0, psql_1.exec)(db, query);
+        if (!output.includes('t')) {
+            core_1.ux.error((0, tsheredoc_1.default) `
+        pg_stat_statements extension need to be installed first.
+        You can install it by running: CREATE EXTENSION pg_stat_statements WITH SCHEMA heroku_ext;
+      `);
+        }
+    }
+    outliersQuery(version, limit, truncate) {
+        const truncatedQueryString = truncate ? (0, tsheredoc_1.default) `
+      CASE WHEN length(query) <= 40 THEN query ELSE substr(query, 0, 39) || '…' END
+    ` : 'query';
+        if (version && Number.parseInt(version, 10) >= 13) {
+            return (0, tsheredoc_1.default) `
+        SELECT
+          interval '1 millisecond' * total_exec_time AS total_exec_time,
+          to_char((total_exec_time/sum(total_exec_time) OVER()) * 100, 'FM90D0') || '%'  AS prop_exec_time,
+          to_char(calls, 'FM999G999G999G990') AS ncalls,
+          interval '1 millisecond' * (blk_read_time + blk_write_time) 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 total_exec_time DESC
+        LIMIT ${limit};
+      `;
+        }
+        return (0, tsheredoc_1.default) `
+      SELECT
+        interval '1 millisecond' * total_time AS total_exec_time,
+        to_char((total_time/sum(total_time) OVER()) * 100, 'FM90D0') || '%'  AS prop_exec_time,
+        to_char(calls, 'FM999G999G999G990') AS ncalls,
+        interval '1 millisecond' * (blk_read_time + blk_write_time) 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 total_time DESC
+      LIMIT ${limit};
+    `;
+    }
+}
+exports.default = Outliers;
+Outliers.topic = 'pg';
+Outliers.description = 'show 10 queries that have longest execution time in aggregate';
+Outliers.flags = {
+    reset: command_1.flags.boolean({ description: 'resets statistics gathered by pg_stat_statements' }),
+    truncate: command_1.flags.boolean({ char: 't', description: 'truncate queries to 40 characters' }),
+    num: command_1.flags.string({ char: 'n', description: 'the number of queries to display (default: 10)' }),
+    app: command_1.flags.app({ required: true }),
+    remote: command_1.flags.remote(),
+};
+Outliers.args = {
+    database: core_1.Args.string(),
+};

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

@@ -0,0 +1,14 @@
+import { Command } from '@heroku-cli/command';
+export default class Promote extends Command {
+    static topic: string;
+    static description: string;
+    static flags: {
+        force: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        app: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        remote: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+    };
+    static args: {
+        database: import("@oclif/core/lib/interfaces/parser").Arg<string, Record<string, unknown>>;
+    };
+    run(): Promise<void>;
+}