@naturalcycles/nodejs-lib/dist/slack/slack.service.js

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.slackDefaultMessagePrefixHook = exports.SlackService = void 0;
const time_lib_1 = require("@naturalcycles/time-lib");
const got_1 = require("got");
const __1 = require("..");
const GAE = !!process.env['GAE_INSTANCE'];
const DEFAULTS = () => ({
    username: 'bot',
    channel: '#log',
    icon_emoji: ':spider_web:',
    items: 'no text',
});
const INSPECT_OPT = {
    colors: false,
    includeErrorData: true,
    includeErrorStack: true,
};
const log = (0, __1.Debug)('nc:nodejs-lib:slack');
/**
 * Has 2 main methods:
 *
 * 1. .send({ items: any, channel: ..., ... })
 * Low-level method with all possible options available.
 *
 * 2. .log(...items: any[])
 * Shortcut method to "just log a bunch of things", everything is "by default" there.
 *
 * .send method has a shortcut:
 * .send(string, ctx?: CTX)
 */
class SlackService {
    constructor(cfg) {
        this.cfg = {
            messagePrefixHook: slackDefaultMessagePrefixHook,
            ...cfg,
        };
    }
    /**
     * Allows to "log" many things at once, similar to `console.log(one, two, three).
     */
    async log(...items) {
        await this.send({
            // If it's an Array of just 1 item - treat it as non-array
            items: items.length === 1 ? items[0] : items,
        });
    }
    async send(msg, ctx) {
        const { webhookUrl, messagePrefixHook } = this.cfg;
        // If String is passed as first argument - just transform it to a full SlackMessage
        if (typeof msg === 'string') {
            msg = {
                items: msg,
            };
        }
        if (ctx !== undefined) {
            Object.assign(msg, { ctx });
        }
        if (!msg.noLog) {
            log[msg.level || __1.DebugLogLevel.info](...[msg.items, msg.kv, msg.attachments, msg.mentions].filter(Boolean));
        }
        if (!webhookUrl)
            return;
        // Transform msg.kv into msg.attachments
        if (msg.kv) {
            msg.attachments = [...(msg.attachments || []), { fields: this.kvToFields(msg.kv) }];
            delete msg.kv; // to not pass it all the way to Slack Api
        }
        let text;
        const inspectOpt = {
            ...INSPECT_OPT,
            ...msg.inspectOptions,
        };
        // Array has a special treatment here
        if (Array.isArray(msg.items)) {
            text = msg.items.map(t => (0, __1.inspectAny)(t, inspectOpt)).join('\n');
        }
        else {
            text = (0, __1.inspectAny)(msg.items, inspectOpt);
        }
        // Wrap in markdown-text-block if it's anything but plain String
        if (typeof msg.items !== 'string') {
            text = '```' + text + '```';
        }
        if (msg.mentions?.length) {
            text += '\n' + msg.mentions.map(s => `<@${s}>`).join(' ');
        }
        const prefix = await messagePrefixHook(msg);
        if (prefix === null)
            return; // filtered out!
        const json = {
            ...DEFAULTS(),
            ...this.cfg.defaults,
            ...msg,
            // Text with Prefix
            text: [prefix.join(': '), text].filter(Boolean).join('\n'),
        };
        // they're not needed in the json payload
        delete json['items'];
        delete json['ctx'];
        delete json['noLog'];
        json.channel = (this.cfg.channelByLevel || {})[msg.level] || json.channel;
        await got_1.default
            .post(webhookUrl, {
            json,
            responseType: 'text',
        })
            .catch(err => {
            // ignore (unless throwOnError is set)
            if (msg.throwOnError)
                throw err;
        });
    }
    kvToFields(kv) {
        return Object.entries(kv).map(([k, v]) => ({
            title: k,
            value: String(v),
            short: String(v).length < 80,
        }));
    }
}
exports.SlackService = SlackService;
function slackDefaultMessagePrefixHook(msg) {
    const tokens = [(0, time_lib_1.dayjs)().toPretty()];
    const { ctx } = msg;
    // AppEngine-specific decoration
    if (GAE && ctx && typeof ctx === 'object' && typeof ctx.header === 'function') {
        tokens.push(ctx.header('x-appengine-country'), ctx.header('x-appengine-city'));
    }
    return tokens.filter(Boolean);
}
exports.slackDefaultMessagePrefixHook = slackDefaultMessagePrefixHook;