heroku-apps/commands/apps/info.js

Heroku CLI plugin to manage apps.

'use strict';

let _        = require('lodash');
let S        = require('string');
let co       = require('co');
let cli      = require('heroku-cli-util');
let extend   = require('util')._extend;
let filesize = require('filesize');
let util     = require('util');

function* run (context, heroku) {
  function getInfo(app) {
    // TODO: Remove variant and consolidate extended/app calls into one when the API no longer requires the variant
    return {
      addons: heroku.apps(app).addons().listByApp(),
      app: heroku.request({path: `/apps/${app}`, headers: {'Accept': 'application/vnd.heroku+json; version=3.dogwood'}}),
      dynos: heroku.apps(app).dynos().list().catch(() => []),
      collaborators: heroku.apps(app).collaborators().list().catch(() => []),
      extended: context.flags.extended ? heroku.request({path: `/apps/${app}?extended=true`}) : {},
    };
  }

  let info = yield getInfo(context.app);
  let addons = _(info.addons).pluck('plan.name').sort().value();
  let collaborators = _(info.collaborators).pluck('user.email').pull(info.app.owner.email).sort().value();

  function print() {
    let data = {};
    data.Addons = addons;
    data.Collaborators = collaborators;

    if (info.app.archived_at) data['Archived At'] = cli.formatDate(info.app.archived_at);
    if (info.app.cron_finished_at) data['Cron Finished At'] = cli.formatDate(info.app.cron_finished_at);
    if (info.app.cron_next_run) data['Cron Next Run'] = cli.formatDate(info.app.cron_next_run);
    if (info.app.database_size) data['Database Size'] = filesize(info.app.database_size, {round: 0});
    if (info.app.create_status !== 'complete') data['Create Status'] = info.app.create_status;
    if (info.app.space) data['Space'] = info.app.space.name;

    data['Git URL'] = info.app.git_url;
    data['Web URL'] = info.app.web_url;
    data['Repo Size'] = filesize(info.app.repo_size, {round: 0});
    data['Slug Size'] = filesize(info.app.slug_size, {round: 0});
    data['Owner'] = info.app.owner.email;
    data['Region'] = info.app.region.name;
    data['Dynos'] = _(info.dynos).countBy('type').value();
    data['Stack'] = info.app.stack.name;

    cli.styledHeader(info.app.name);
    cli.styledObject(data);

    if (context.flags.extended) {
      console.log("\n\n--- Extended Information ---\n\n");
      cli.debug(info.extended.extended);
    }
  }

  function shell() {
    function print(k, v) {
      cli.log(`${S(k).slugify()}=${v}`);
    }
    print('addons', addons);
    print('collaborators', collaborators);

    if (info.app.archived_at) print('archived_at', cli.formatDate(info.app.archived_at));
    if (info.app.cron_finished_at) print('cron_finished_at', cli.formatDate(info.app.cron_finished_at));
    if (info.app.cron_next_run) print('cron_next_run', cli.formatDate(info.app.cron_next_run));
    if (info.app.database_size) print('database_size', filesize(info.app.database_size, {round: 0}));
    if (info.app.create_status !== 'complete') print('create_status', info.app.create_status);

    print('git_url', info.app.git_url);
    print('web_url', info.app.web_url);
    print('repo_size', filesize(info.app.repo_size, {round: 0}));
    print('slug_size', filesize(info.app.slug_size, {round: 0}));
    print('owner', info.app.owner.email);
    print('region', info.app.region.name);
    print('dynos', util.inspect(_(info.dynos).countBy('type').value()));
    print('stack', info.app.stack.name);
  }

  function json() {
    console.log(JSON.stringify(info, null, 2));
  }

  if (context.flags.shell) {
    shell();
  } else if (context.flags.json) {
    json();
  } else {
    print();
  }
}

let cmd = {
  topic: 'apps',
  command: 'info',
  description: 'show detailed app information',
  help: `show detailed app information

Examples:

 $ heroku apps:info
 === example
 Git URL:   https://git.heroku.com/example.git
 Repo Size: 5M
 ...

 $ heroku apps:info --shell
 git_url=https://git.heroku.com/example.git
 repo_size=5000000
 ...`,
  needsApp: true,
  needsAuth: true,
  flags: [
    {name: 'shell', char: 's', description: 'output more shell friendly key/value pairs'},
    {name: 'extended', char: 'x', hidden: true},
    {name: 'json', char: 'j'}
  ],
  run: cli.command(co.wrap(run))
};

module.exports.apps = cmd;
module.exports.root = extend({}, cmd);
module.exports.root.topic = 'info';
delete module.exports.root.command;