All files / services BotService.js

33.61% Statements 40/119
100% Branches 3/3
16.66% Functions 2/12
33.61% Lines 40/119

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 1191x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x           1x 1x         1x 1x             1x 1x                     1x 1x                 1x 1x                                               1x 1x               1x 1x                   1x 1x           1x 1x 1x 1x 7x 7x 1x     1x 1x
import {clearSummaryCache} from "./SummaryService.js";
import ServiceUnavailableException from "../exceptions/ServiceUnavailableException.js";
import TooManyRequestsException from "../exceptions/TooManyRequestsException.js";
 
export default class BotService {
 
    constructor(config, loggerService, auditLogsService, newsService, plugins) {
        this.logger = loggerService.getLogger().child({label: 'BotService'});
        this.intervalMs = config.bot.engineMinIntervalMs;
        this.auditLogsService = auditLogsService;
        this.newsService = newsService;
        this.plugins = plugins;
    }
 
    run() {
        this.logger.debug("run()");
        let bot = this;
        bot.defaultPlugin = bot.plugins && bot.plugins.length > 0 ? bot.plugins[0] : null;
        bot.logger.info(`started - minInterval:${this.intervalMs} - ${this.getPluginsDetails()}`);
    }
 
    getPNQuestions() {
        const engine = this;
        const pnPlugin = engine.getPluginByName("Plantnet");
        return pnPlugin?.getQuestions();
    }
 
    getPluginsDetails() {
        if (!Array.isArray(this.plugins) || this.plugins.length < 1) {
            return "(none)";
        }
        const pluginsNames = this.plugins.map(p => p.getName()).join(",");
        return `${this.plugins.length} plugin(s) : ${pluginsNames}`;
    }
 
    assumeProcessRateLimit(remoteAddress) {
        const bot = this;
        const nowMs = (new Date()).getTime();
        const allowedTs = bot.lastProcess + bot.intervalMs;
        const needToWaitSec = Math.floor((allowedTs - nowMs) / 1000);
        if (bot.lastProcess && allowedTs > nowMs) {
            bot.logger.info(`${remoteAddress} | need to wait ${needToWaitSec} sec`);
            throw new TooManyRequestsException();
        }
        bot.lastProcess = nowMs;
    }
 
    assumeBotReadyPlugin(pluginName, remoteAddress) {
        const bot = this;
        const plugin = bot.getPluginByName(pluginName);
        if (!plugin || !plugin.isReady()) {
            bot.logger.info(`${remoteAddress} | no plugin '${pluginName}' available`);
            throw new ServiceUnavailableException();
        }
        return plugin;
    }
 
    async process(remoteAddress, doSimulate, pluginName) {
        const bot = this;
        const context = {remoteAddress, pluginName};
        try {
            this.assumeProcessRateLimit(remoteAddress);
            const plugin = this.assumeBotReadyPlugin(pluginName, remoteAddress);
            bot.logger.info(`${(doSimulate ? "Simulation" : "Exécution")} du plugin - ${pluginName}`, context);
            const result = await plugin.process({"doSimulate": doSimulate, context});
            // DEBUG // bot.logger.info(`plugin result ${result.text}`, context);
            bot.newsService.add(result.html);
            if (result.post > 0) {
                clearSummaryCache();
            }
            return result;
        } catch (error) {
            if (error.status && error.message) {
                throw error;
            }
            bot.logger.warn(`plugin error: ${error.message}`, context);
            bot.auditLogsService.createAuditLog(`${error.message} ${JSON.stringify(context)}`);
            bot.newsService.add(error.html ? error.html : error.message);
            throw error;
        }
    }
 
    getState() {
        let engine = this;
        let pluginsNames = [];
        engine.plugins.forEach((p) => {
            pluginsNames.push(p.getName());
        });
        return "Plugins : " + pluginsNames.join(", ");
    }
 
    getPluginByName(pluginName) {
        let engine = this;
        if (!pluginName) {
            return engine.defaultPlugin;
        }
        let availablePlugins = engine.plugins.filter((p) => {
            return pluginName === p.getName();
        });
        return availablePlugins.length > 0 ? this.randomFromArray(availablePlugins) : false;
    }
 
    randomFromArray(arr) {
        if (!Array.isArray(arr) || arr.length <= 0) {
            return undefined;
        }
        return arr[Math.floor(Math.random() * arr.length)];
    }
}
 
 
export const pluginResolve = (text, html, status = 200, post = 0) => {
    return {text, html, status, post};
}
export const pluginReject = (text, html, status, shortResponseMessage) => {
    return {text, html, status, message: shortResponseMessage};
}
 
export const dataSimulationDirectory = "src/data/simulation"