heroku-kafka/dist/commands/kafka/topics/index.js

heroku plugin to manage heroku kafka

import { Command, flags } from '@heroku-cli/command';
import { color, hux } from '@heroku/heroku-cli-util';
import { Args, ux } from '@oclif/core';
import humanize from 'humanize-plus';
import { request, withCluster } from '../../../lib/clusters.js';
const VERSION = 'v0';
export default class Topics extends Command {
    static args = {
        cluster: Args.string({ description: 'cluster to operate on', required: false }),
    };
    static description = 'lists available Kafka topics';
    static examples = [
        '$ heroku kafka:topics',
        '$ heroku kafka:topics HEROKU_KAFKA_BROWN_URL',
    ];
    static flags = {
        app: flags.app({ required: true }),
        remote: flags.remote(),
    };
    static topic = 'kafka';
    async run() {
        const { args, flags } = await this.parse(Topics);
        await withCluster(this.heroku, flags.app, args.cluster, async (addon) => {
            const result = await request(this.heroku, {
                path: `/data/kafka/${VERSION}/clusters/${addon.id}/topics`,
            });
            const topics = result?.body || result;
            hux.styledHeader('Kafka Topics on ' + (topics.attachment_name || 'HEROKU_KAFKA'));
            if (topics.topics.length > 0) {
                const extraInfo = [];
                if (topics.limits && topics.limits.max_topics) {
                    extraInfo.push(`${topics.topics.length} / ${topics.limits.max_topics} topics`);
                }
                if (topics.prefix) {
                    extraInfo.push(`prefix: ${color.green(topics.prefix)}`);
                }
                if (extraInfo.length > 0) {
                    ux.stdout(extraInfo.join('; ') + '\n');
                }
            }
            const filtered = topics.topics.filter((t) => t.name !== '__consumer_offsets');
            const topicData = filtered.map((t) => ({
                name: t.name,
                messages: `${humanize.intComma(t.messages_in_per_second)}/sec`,
                bytes: `${humanize.fileSize(t.bytes_in_per_second)}/sec`,
            }));
            if (topicData.length === 0) {
                ux.stdout('No topics found on this Kafka cluster.\n');
                if (topics.limits && topics.limits.max_topics) {
                    ux.stdout(`Use heroku kafka:topics:create to create a topic (limit ${topics.limits.max_topics}).\n`);
                }
                else {
                    ux.stdout('Use heroku kafka:topics:create to create a topic.\n');
                }
            }
            else {
                hux.table(topicData, {
                    name: {},
                    messages: { header: 'Messages' },
                    bytes: { header: 'Traffic' },
                });
            }
        });
    }
}