heroku 10.4.1-beta.1 → 10.5.0-beta.0

package/README.md

@@ -73,6 +73,7 @@ For other issues, [submit a support ticket](https://help.heroku.com/).
 * [`heroku teams`](docs/teams.md) - manage teams
 * [`heroku telemetry`](docs/telemetry.md) - list telemetry drains
 * [`heroku update`](docs/update.md) - update the Heroku CLI
+* [`heroku usage`](docs/usage.md) - list usage values for metered addons associated with a given app or team
 * [`heroku version`](docs/version.md)
 * [`heroku webhooks`](docs/webhooks.md) - list webhooks on an app
 

package/lib/commands/telemetry/info.js

@@ -12,7 +12,7 @@ class Info extends command_1.Command {
                 Accept: 'application/vnd.heroku+json; version=3.sdk',
             },
         });
-        (0, util_1.displayTelemetryDrain)(telemetryDrain);
+        await (0, util_1.displayTelemetryDrain)(telemetryDrain, this.heroku);
     }
 }
 exports.default = Info;

package/lib/commands/telemetry/update.js

@@ -28,7 +28,7 @@ class Update extends command_1.Command {
                 exporter.endpoint = endpoint;
             }
             if (transport) {
-                exporter.type = `otlp${transport}`;
+                exporter.type = (transport === 'grpc') ? 'otlp' : 'otlphttp';
             }
             drainConfig.exporter = exporter;
         }
@@ -40,7 +40,7 @@ class Update extends command_1.Command {
             body: drainConfig,
         });
         core_1.ux.action.stop();
-        (0, util_1.displayTelemetryDrain)(telemetryDrain);
+        await (0, util_1.displayTelemetryDrain)(telemetryDrain, this.heroku);
     }
 }
 exports.default = Update;

package/lib/commands/usage/addons.d.ts

@@ -0,0 +1,14 @@
+import { Command } from '@heroku-cli/command';
+export default class UsageAddons extends Command {
+    static topic: string;
+    static description: string;
+    static flags: {
+        app: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        team: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+    };
+    private displayAppUsage;
+    private fetchAndDisplayAppUsageData;
+    private fetchAndDisplayTeamUsageData;
+    private getAppInfoFromTeamAddons;
+    run(): Promise<void>;
+}

package/lib/commands/usage/addons.js

@@ -0,0 +1,118 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const command_1 = require("@heroku-cli/command");
+const core_1 = require("@oclif/core");
+const color_1 = require("@heroku-cli/color");
+class UsageAddons extends command_1.Command {
+    displayAppUsage(app, usageAddons, appAddons) {
+        const metersArray = usageAddons.flatMap(addon => Object.entries(addon.meters).map(([label, data]) => ({
+            label,
+            quantity: data.quantity,
+            addonId: addon.id,
+        })));
+        core_1.ux.styledHeader(`Usage for ${color_1.default.app(app)}`);
+        core_1.ux.table(metersArray, {
+            Addon: {
+                get: row => {
+                    const matchingAddon = appAddons.find(a => a.id === row.addonId);
+                    return (matchingAddon === null || matchingAddon === void 0 ? void 0 : matchingAddon.name) || row.addonId;
+                },
+            },
+            Meter: {
+                get: row => row.label,
+            },
+            Quantity: {
+                get: row => row.quantity,
+            },
+        });
+    }
+    async fetchAndDisplayAppUsageData(app, team) {
+        let usageData;
+        let appAddons;
+        core_1.ux.action.start('Gathering usage data');
+        if (team) {
+            [{ body: usageData }, { body: appAddons }] = await Promise.all([
+                this.heroku.get(`/teams/${team}/apps/${app}/usage`, {
+                    headers: {
+                        Accept: 'application/vnd.heroku+json; version=3.sdk',
+                    },
+                }),
+                this.heroku.get(`/apps/${app}/addons`),
+            ]);
+        }
+        else {
+            [{ body: usageData }, { body: appAddons }] = await Promise.all([
+                this.heroku.get(`/apps/${app}/usage`, {
+                    headers: {
+                        Accept: 'application/vnd.heroku+json; version=3.sdk',
+                    },
+                }),
+                this.heroku.get(`/apps/${app}/addons`),
+            ]);
+        }
+        core_1.ux.action.stop();
+        core_1.ux.log();
+        const usageAddons = usageData.addons;
+        if (usageAddons.length === 0) {
+            core_1.ux.log(`No usage found for app ${color_1.default.app(app)}`);
+            return;
+        }
+        this.displayAppUsage(app, usageAddons, appAddons);
+    }
+    async fetchAndDisplayTeamUsageData(team) {
+        core_1.ux.action.start(`Gathering usage data for ${color_1.default.magenta(team)}`);
+        const [{ body: usageData }, { body: teamAddons }] = await Promise.all([
+            this.heroku.get(`/teams/${team}/usage`, {
+                headers: {
+                    Accept: 'application/vnd.heroku+json; version=3.sdk',
+                },
+            }),
+            this.heroku.get(`/teams/${team}/addons`),
+        ]);
+        core_1.ux.action.stop();
+        core_1.ux.log();
+        if (!usageData.apps || usageData.apps.length === 0) {
+            core_1.ux.log(`No usage found for team ${color_1.default.magenta(team)}`);
+            return;
+        }
+        const appInfoArray = this.getAppInfoFromTeamAddons(teamAddons);
+        // Display usage for each app
+        usageData.apps.forEach((app) => {
+            const appInfo = appInfoArray.find(info => info.id === app.id);
+            this.displayAppUsage((appInfo === null || appInfo === void 0 ? void 0 : appInfo.name) || app.id, app.addons, teamAddons);
+            core_1.ux.log();
+        });
+    }
+    getAppInfoFromTeamAddons(teamAddons) {
+        const appInfoMap = new Map();
+        teamAddons.forEach(addon => {
+            if (addon.app && addon.app.id && addon.app.name) {
+                appInfoMap.set(addon.app.id, addon.app.name);
+            }
+        });
+        return Array.from(appInfoMap.entries()).map(([id, name]) => ({
+            id,
+            name,
+        }));
+    }
+    async run() {
+        const { flags } = await this.parse(UsageAddons);
+        const { app, team } = flags;
+        if (!app && !team) {
+            core_1.ux.error('Specify an app with --app or a team with --team');
+        }
+        if (app) {
+            await this.fetchAndDisplayAppUsageData(app, team);
+        }
+        else if (team) {
+            await this.fetchAndDisplayTeamUsageData(team);
+        }
+    }
+}
+exports.default = UsageAddons;
+UsageAddons.topic = 'usage';
+UsageAddons.description = 'list usage values for metered addons associated with a given app or team';
+UsageAddons.flags = {
+    app: command_1.flags.string(),
+    team: command_1.flags.string(),
+};

package/lib/lib/addons/util.js

@@ -45,7 +45,7 @@ const formatPriceText = function (price) {
     const priceMonthly = (0, exports.formatPrice)({ price, hourly: false });
     if (!priceHourly)
         return '';
-    if (priceHourly === 'free' || priceHourly === 'contract')
+    if (priceHourly === 'free' || priceHourly === 'contract' || priceHourly === 'metered')
         return `${color_1.default.green(priceHourly)}`;
     return `${color_1.default.green(priceHourly)} (max ${priceMonthly})`;
 };

package/lib/lib/telemetry/util.d.ts

@@ -1,3 +1,4 @@
 import { TelemetryDrain } from '../types/telemetry';
+import { APIClient } from '@heroku-cli/command';
 export declare function validateAndFormatSignals(signalInput: string | undefined): string[];
-export declare function displayTelemetryDrain(telemetryDrain: TelemetryDrain): void;
+export declare function displayTelemetryDrain(telemetryDrain: TelemetryDrain, heroku: APIClient): Promise<void>;

package/lib/lib/telemetry/util.js

@@ -15,15 +15,32 @@ function validateAndFormatSignals(signalInput) {
     return signalArray;
 }
 exports.validateAndFormatSignals = validateAndFormatSignals;
-function displayTelemetryDrain(telemetryDrain) {
+async function displayTelemetryDrain(telemetryDrain, heroku) {
     core_1.ux.styledHeader(telemetryDrain.id);
-    const drainType = telemetryDrain.owner.type.charAt(0).toUpperCase() + telemetryDrain.owner.type.slice(1);
-    core_1.ux.styledObject({
-        [drainType]: telemetryDrain.owner.name,
+    const displayObject = {
         Signals: telemetryDrain.signals.join(', '),
         Endpoint: telemetryDrain.exporter.endpoint,
-        Kind: telemetryDrain.exporter.type,
-        Headers: telemetryDrain.exporter.headers,
-    }, ['App', 'Space', 'Signals', 'Endpoint', 'Kind', 'Headers']);
+        Transport: (telemetryDrain.exporter.type === 'otlp' ? 'gRPC' : 'HTTP'),
+    };
+    if (telemetryDrain.owner.type === 'space') {
+        const { body: space } = await heroku.get(`/spaces/${telemetryDrain.owner.id}`, {
+            headers: {
+                Accept: 'application/vnd.heroku+json; version=3.sdk',
+            },
+        });
+        displayObject.Space = space.name;
+    }
+    else {
+        const { body: app } = await heroku.get(`/apps/${telemetryDrain.owner.id}`, {
+            headers: {
+                Accept: 'application/vnd.heroku+json; version=3.sdk',
+            },
+        });
+        displayObject.App = app.name;
+    }
+    if (telemetryDrain.exporter.headers) {
+        displayObject.Headers = JSON.stringify(telemetryDrain.exporter.headers);
+    }
+    core_1.ux.styledObject(displayObject, ['App', 'Space', 'Signals', 'Endpoint', 'Transport', 'Headers']);
 }
 exports.displayTelemetryDrain = displayTelemetryDrain;