@atomist/automation-client/lib/internal/transport/showStartupMessages.ts

Atomist API for software low-level client

import chalk from "chalk";
import * as cluster from "cluster";
import * as _ from "lodash";
import { promisify } from "util";
import { AutomationClient } from "../../automationClient";
import { Configuration } from "../../configuration";
import { AutomationEventListenerSupport } from "../../server/AutomationEventListener";
import {
    clientLoggingConfiguration,
    logger,
} from "../../util/logger";
import { Automations } from "../metadata/metadata";
import { info } from "../util/info";
import { RegistrationConfirmation } from "./websocket/WebSocketRequestProcessor";

export class StartupTimeMessageUatomationEventListener extends AutomationEventListenerSupport {

    public async startupSuccessful(client: AutomationClient): Promise<void> {
        if (cluster.isMaster || !client.configuration.cluster.enabled) {
            const uptime = process.uptime();
            logger.info(`Atomist automation client startup completed in ${uptime.toFixed(2)}s`);
        }
    }
}

export class StartupMessageAutomationEventListener extends AutomationEventListenerSupport {

    public startupSuccessful(client: AutomationClient): Promise<void> {
        if (cluster.isMaster || !client.configuration.cluster.enabled) {
            return showStartupMessages(client.configuration, client.automations.automations);
        }
    }
}

export const DevModeBannerContributor =
    () => ({ title: "Development", body: chalk.green("watch mode enabled") });

export const LoggingBannerContributor =
    cfg => {
        const loggingConfig = clientLoggingConfiguration(_.cloneDeep(cfg));
        const rows = [`  ${chalk.gray("Logging")}`];
        if (loggingConfig.console.enabled) {
            rows.push(`    ${chalk.gray("Console")} ${loggingConfig.console.level}`);
        }
        if (loggingConfig.file.enabled) {
            rows.push(`    ${chalk.gray("File")} ${loggingConfig.file.level}  ${chalk.gray("Location")} ${loggingConfig.file.filename}`);
        }
        return rows.join("\n");
    };

/**
 * Build and log startup message, including any user banner
 * @param {RegistrationConfirmation} registration
 * @param {Automations} automations
 */
export async function showStartupMessages(configuration: Configuration,
                                          automations: Automations) {
    logger.info(await createStartupMessage(configuration, automations));
}

export async function createStartupMessage(configuration: Configuration,
                                           automations: Automations) {
    const msg = `
${await header(configuration, automations)}
${firstRow(configuration, automations)}
${secondRow(configuration, automations)}
${thirdRow(configuration, automations)}
${forthRow(configuration, automations)}

${handlers(configuration, automations)}

${contributors(configuration)}

${urls(configuration, automations)}

${footer()}
`;
    return msg.replace(/^\s*[\r\n]/gm, "\n");
}

async function toAscii(s: string): Promise<string> {
    const asciify = require("asciify");
    const promisified = promisify(asciify);
    try {
        return promisified(s, { font: "ogre" });
    } catch {
        return s;
    }
}

async function header(configuration: Configuration,
                      automations: Automations): Promise<string> {
    let message = configuration.name;
    const b = configuration.logging.banner.message;

    if (typeof b === "string") {
        message = chalk.green(await toAscii(b));
    } else if (configuration.logging.banner.enabled === true) {
        message = chalk.green(await toAscii(message));
    } else if (_.isFunction(b)) {
        // It's a function returning a banner object
        const banner = b(configuration);
        message = chalk[banner.color](banner.asciify ? await toAscii(banner.banner) : banner.banner);
    } else if (configuration.logging.banner.enabled === false) {
        return;
    }
    return message;
}

function firstRow(configuration: Configuration,
                  automations: Automations): string {
    const gitInfo = info(automations);
    let c: string = "";

    c += `  ${chalk.grey("Version")} ${configuration.version}`;
    if (gitInfo && gitInfo.git) {
        c += `  ${chalk.grey("Sha")} ${gitInfo.git.sha.slice(0, 7)}`;
        c += `  ${chalk.grey("Repository")} ${gitInfo.git.repository}`;
    }
    return c;
}

function secondRow(configuration: Configuration,
                   automations: Automations): string {
    let c: string = "";
    if (automations.groups && automations.groups.length > 0) {
        c += `  ${chalk.grey("Groups")} all`;
    } else {
        c += `  ${chalk.grey(`${automations.team_ids.length > 1 ? "Workspaces" : "Workspace"}`)} ${automations.team_ids.join(", ")}`;
    }
    c += `  ${chalk.grey("Policy")} ${automations.policy ? automations.policy : "ephemeral"}`;
    c += `  ${chalk.grey("Cluster")} ${configuration.cluster.enabled ? "enabled" : "disabled"}`;
    c += `  ${chalk.grey("Environment")} ${configuration.environment}`;
    return c;
}

function thirdRow(configuration: Configuration,
                  automations: Automations): string {
    let c: string = "";
    c += `  ${chalk.grey(automations.commands.length === 1 ? "Command" : "Commands")} ${automations.commands.length}`;
    c += `  ${chalk.grey(automations.events.length === 1 ? "Event" : "Events")} ${automations.events.length}`;
    c += `  ${chalk.grey(automations.ingesters.length === 1 ? "Ingester" : "Ingesters")} ${automations.ingesters.length}`;
    return c;
}

function forthRow(configuration: Configuration,
                  automations: Automations): string {
    let c: string = "";
    if ((configuration.ws as any).session) {
        c += `  ${chalk.grey("Session")} ${(configuration.ws as any).session.jwt}`;
    }
    return c;
}

function handlers(configuration: Configuration,
                  automations: Automations): string {

    const events = automations.events
        .sort((e1, e2) => e1.name.localeCompare(e2.name))
        .map(e => `   ${e.expose === false ? chalk.gray("[") : " "}${e.name}${e.expose === false ? chalk.gray("]") : ""} ${e.description ? `(${_.upperFirst(e.description)})` : ""}`);
    const commands = automations.commands
        .sort((c1, c2) => c1.name.localeCompare(c2.name))
        .map(cmd => `   ${cmd.expose === false ? chalk.gray("[") : " "}${cmd.name}${cmd.expose === false ? chalk.gray("]") : ""} ${cmd.description ?
            `(${_.upperFirst(cmd.description)})` : ""} ${cmd.intent ? chalk.gray(cmd.intent.join(", ")) : ""}`);

    let c = "";
    if (commands.length > 0 || events.length > 0) {
        c += "\n\n";
    }
    if (commands.length > 0) {
        c += `${chalk.grey(commands.length === 1 ? "  Command" : "  Commands")}
${commands.join("\n")}`;
    }
    if (commands.length > 0 && events.length > 0) {
        c += "\n\n";
    }
    if (events.length > 0) {
        c += `${chalk.grey(events.length === 1 ? "  Event" : "  Events")}
${events.join("\n")}`;
    }
    return c;
}

function contributors(configuration: Configuration): string {
    let c: string = "";
    const contribs = [LoggingBannerContributor, ...(configuration.logging.banner.contributors || [])];
    if (contribs && contribs.length > 0) {
        c += contribs.map(cfg => {
            const section = cfg(configuration);

            if (typeof section === "string") {
                return section;
            } else {
                const bs = section;
                return `  ${chalk.gray(bs.title)}
    ${bs.body.split("\n").join("\n    ")}`;
            }

        }).join("\n\n");
    }
    return c;
}

function urls(configuration: Configuration,
              automations: Automations): string {
    if (configuration.ws.enabled) {
        const c = automations.team_ids.filter(t => t !== "local").map(t => {
            return `
  ${chalk.grey("Url")} ${chalk.underline(`https://app.atomist.com/workspace/${t}/sdms`)}
  ${chalk.grey("GraphQL")} ${chalk.underline(`https://app.atomist.com/workspace/${t}/graphql`)}`;
        });
        return c.join("\n\n");
    } else {
        return "";
    }
}

function footer() {
    return `  ${chalk.grey("Docs")} https://docs.atomist.com  ${chalk.grey("Support")} https://join.atomist.com`;
}