@tiledesk/tiledesk-tybot-connector 0.5.0 → 2.0.0

package/ExtApi.js

@@ -1,5 +1,7 @@
 let axios = require('axios');
 let https = require("https");
+const winston = require('./utils/winston');
+const httpUtils = require('./utils/HttpUtils');
 
 class ExtApi {
 
@@ -38,7 +40,7 @@ class ExtApi {
   sendSupportMessageExt(message, projectId, requestId, token, callback) {
     const jwt_token = this.fixToken(token);
     const url = `${this.TILEBOT_ENDPOINT}/ext/${projectId}/requests/${requestId}/messages`;
-    if (this.log) {console.log("sendSupportMessageExt URL", url);}
+    winston.verbose("(ExtApi) sendSupportMessageExt URL" + url);
     const HTTPREQUEST = {
       url: url,
       headers: {
@@ -48,12 +50,10 @@ class ExtApi {
       json: message,
       method: 'POST'
     };
-    this.myrequest(
+    httpUtils.request(
       HTTPREQUEST,
       function(err, resbody) {
-        //console.log("sendSupportMessageExt resbody:", resbody);
         if (err) {
-          //console.error("sendSupportMessageExt error:", err)
           if (callback) {
             callback(err);
           }
@@ -67,85 +67,6 @@ class ExtApi {
     );
   }
 
-  /**
-   * A stub to send message to the "ext/botId" endpoint, hosted by tilebot on:
-   * /${TILEBOT_ROUTE}/ext/${botId}
-   *
-   * @param {Object} message. The message to send
-   * @param {string} botId. Tiledesk botId
-   * @param {string} token. User token
-   */
-  // sendMessageToBot(message, botId, token, callback) {
-  //   const url = `${this.ENDPOINT}/ext/${botId}`;
-  //   if (this.log) {console.log("sendMessageToBot URL", url);}
-  //   const HTTPREQUEST = {
-  //     url: url,
-  //     headers: {
-  //       'Content-Type' : 'application/json',
-  //       'Authorization': jwt_token
-  //     },
-  //     json: message,
-  //     method: 'POST'
-  //   };
-  //   this.myrequest(
-  //     HTTPREQUEST,
-  //     function(err, resbody) {
-  //       if (err) {
-  //         if (callback) {
-  //           callback(err);
-  //         }
-  //       }
-  //       else {
-  //         if (callback) {
-  //           callback(null, resbody);
-  //         }
-  //       }
-  //     }, this.log
-  //   );
-  // }
-
-  myrequest(options, callback, log) {
-    if (this.log) {
-      console.log("API URL:", options.url);
-      console.log("** Options:", JSON.stringify(options));
-    }
-    let axios_options = {
-      url: options.url,
-      method: options.method,
-      data: options.json,
-      params: options.params,
-      headers: options.headers
-    }
-    if (options.url.startsWith("https:")) {
-      const httpsAgent = new https.Agent({
-        rejectUnauthorized: false,
-      });
-      axios_options.httpsAgent = httpsAgent;
-    }
-    axios(axios_options)
-    .then((res) => {
-      if (this.log) {
-        console.log("Response for url:", options.url);
-        console.log("Response headers:\n", JSON.stringify(res.headers));
-      }
-      if (res && res.status == 200 && res.data) {
-        if (callback) {
-          callback(null, res.data);
-        }
-      }
-      else {
-        if (callback) {
-          callback(TiledeskClient.getErr({message: "Response status not 200"}, options, res), null, null);
-        }
-      }
-    })
-    .catch( (error) => {
-      console.error("(ExtApi) An error occurred:", JSON.stringify(error));
-      if (callback) {
-        callback(error, null, null);
-      }
-    });
-  }
 }
 
 module.exports = { ExtApi };

package/ExtUtil.js

@@ -23,7 +23,6 @@ class ExtUtil {
     messagePipeline.addPlug(new MarkbotChatbotPlug(log));
     messagePipeline.addPlug(new FillParamsChatbotPlug(request, tdcache, log)); // in splits
     const bot_answer = await messagePipeline.exec();
-    if (this.log) {console.log("End pipeline ext, bot_answer:", JSON.stringify(bot_answer));}
     return bot_answer;
   }
   

package/Logger.js

@@ -0,0 +1,105 @@
+let { Publisher } = require("@tiledesk/tiledesk-multi-worker");
+
+const FLOW_LOGS_ENABLED = process.env.FLOW_LOGS_ENABLED;
+const AMQP_MANAGER_URL = process.env.AMQP_MANAGER_URL;
+let publisher = new Publisher(AMQP_MANAGER_URL, {
+    debug: false,
+    queueName: "logs_queue",
+    exchange: "tiledesk-multi",
+    topic: "logs",
+})
+
+class Logger {
+
+    constructor(config) {
+
+        if (!config) {
+            throw new Error('config is mandatory');
+        }
+
+        if (!config.request_id) {
+            console.error('config.request_id is mandatory');
+            //throw new Error('config.request_id is mandatory');
+        }
+
+        if (!FLOW_LOGS_ENABLED || FLOW_LOGS_ENABLED === false || FLOW_LOGS_ENABLED === 'false') {
+            console.warn("(Logger) Flow logs disabled");
+            this._disableMethods();
+        }
+
+        if (!AMQP_MANAGER_URL) {
+            console.warn("(Logger) No AQMP Manager url provided. Flow logs disabled");
+            this._disableMethods();
+        }
+
+        this.request_id = config.request_id;
+        this.dev = false;
+        if (config.dev && config.dev === true) {
+            this.dev = true;
+        }
+
+        // if (!AMQP_MANAGER_URL) {
+        //     console.error('AMQP_MANAGER_URL is undefined. Logger not available...');
+        //     return;
+        //     //throw new Error("Error starting logger: AMQP_MANAGER_URL is undefined.")
+        // }
+
+    }
+
+    error(...args) {
+        let log = this.formatLog(args);
+        return this.base('error', log);
+    }
+
+    warn(...args) {
+        let log = this.formatLog(args);
+        return this.base('warn', log);
+    }
+
+    info(...args) {
+        let log = this.formatLog(args);
+        return this.base('info', log);
+    }
+
+    debug(...args) {
+        let log = this.formatLog(args);
+        return this.base('debug', log);
+    }
+
+    base(level, text) {
+        if (!this.request_id || !publisher) {
+            console.log("Return because request or publisher is undefined", this.request_id, publisher);
+            return;
+        }
+
+        let data = {
+            request_id: this.request_id,
+            text: text,
+            level: level,
+            timestamp: new Date(),
+            dev: this.dev
+        }
+
+        publisher.publish(data, (err, ok) => {
+            if (err) console.warn("publish log fail: ", err);
+            return;
+        })
+    }
+
+    formatLog(args) {
+        return args
+            .map(arg => (typeof arg === "object" ? JSON.stringify(arg, null, 2) : arg ))
+            .join(" ")
+    }
+
+    // Substitute methods with empty function if flow flogs are disabled
+    _disableMethods() {
+        const methods = ['error', 'warn', 'info', 'debug'];
+        methods.forEach(method => {
+          this[method] = () => {};
+        });
+      }
+
+}
+
+module.exports = { Logger }

package/TdCache.js

@@ -1,12 +1,16 @@
 const redis = require('redis');
+const winston = require('./utils/winston');
 
 class TdCache {
 
     constructor(config) {
-
+        winston.debug("(TdCache) config: ", config);
         this.redis_host = config.host;
         this.redis_port = config.port;
         this.redis_password = config.password;
+        winston.debug("TdCache redis_host: ", this.redis_host);
+        winston.debug("TdCache redis_port: ", this.redis_port);
+        winston.debug("TdCache redis_password: ", this.redis_password);
         this.client = null;
         this.subscriberClient = null;
     }
@@ -61,7 +65,6 @@ class TdCache {
     }
 
     async set(key, value, options) {
-      //console.log("setting key value", key, value)
       if (!options) {
         options = {EX: 86400}
       }
@@ -115,7 +118,6 @@ class TdCache {
     }
 
     async hget(dict_key, key) {
-      // console.log("hgetting dics", dict_key);
       const value = await this.client.HGET(dict_key, key);
       return value;
     }

package/TiledeskClientTest.js

@@ -7,6 +7,7 @@ const { request } = require('express');
 const { v4: uuidv4 } = require('uuid');
 let https = require("https");
 const { Console } = require('console');
+const winston = require("./utils/winston")
 
 /**
  * This class is a NodeJS stub for Tiledesk's REST APIs
@@ -34,7 +35,6 @@ class TiledeskClientTest {
    * @param {boolean} options.log Optional. If true HTTP requests are logged.
    */
   constructor(options) {
-    // console.log("...options:", options)
 
     if (!options) {
       throw new Error('options.APIKEY, options.projectId and options.token are mandatory.');
@@ -2074,9 +2074,7 @@ class TiledeskClientTest {
       TiledeskClientTest.myrequest(
         HTTPREQUEST,
         function(err, resbody) {
-            console.log("myrequest REPL");
           if (err) {
-            console.log("ERRRRRRRRRR");
             if (callback) {
               callback(err);
             }
@@ -2085,7 +2083,6 @@ class TiledeskClientTest {
             }
           }
           else {
-            console.log("REEEEEESOL");
             resolve(resbody);
             if (callback) {
               callback(null, resbody);
@@ -2426,10 +2423,8 @@ class TiledeskClientTest {
   // ************************************************
 
   static myrequest(options, callback, log) {
-    if (log) {
-      console.log("** API URL:", options.url);
-      console.log("** Options:", JSON.stringify(options));
-    }
+    winston.verbose("(TiledeskClientTest) API URL: " + options.url);
+    winston.verbose("(TiledeskClientTest) Options:", options);
     let axios_settings = {
       url: options.url,
       method: options.method,
@@ -2437,47 +2432,29 @@ class TiledeskClientTest {
       params: options.params,
       headers: options.headers
     }
-    // console.log("options.url.startsWith(https:)", options.url.startsWith("https:"))
-    // console.log("this.httpsOptions", this.httpsOptions)
     
     if (options.url.startsWith("https:") && options.httpsOptions) {
-      // console.log("Tiledesk Client v 0.9.x: url.startsWith https: && httpsOptions");
       const httpsAgent = new https.Agent(options.httpsOptions);
       axios_settings.httpsAgent = httpsAgent;
     }
     else if (options.url.startsWith("https:") && !options.httpsOptions) {
       // HTTPS default is rejectUnauthorized: false
-      // console.log("Tiledesk Client v 0.9.x: url.startsWith https: && NOT httpsOptions");
       const httpsAgent = new https.Agent({
         rejectUnauthorized: false,
       });
       axios_settings.httpsAgent = httpsAgent;
     }
     
-    // console.log("Using axios settings:", axios_settings)
-    // axios(
-    //   {
-    //     url: options.url,
-    //     method: options.method,
-    //     data: options.json,
-    //     params: options.params,
-    //     httpsAgent: httpsAgent,
-    //     headers: options.headers
-    //   })
     axios(axios_settings)
     .then(function (res) {
-    //   if (log) {
-        console.log("Response for url:", options.url);
-        console.log("Response headers:\n", JSON.stringify(res.headers));
-        //console.log("******** Response for url:", res);
-    //   }
+      winston.verbose("(TiledeskClientTest) Response for url:" + options.url);
+      winston.verbose("(TiledeskClientTest) Response headers:\n", res.headers);
       if (res && res.status == 200 && res.data) {
         if (callback) {
           callback(null, res.data);
         }
       }
       else {
-        console.log("PROBLEMIIIII")
         if (callback) {
           callback(TiledeskClientTest.getErr({message: "Response status not 200"}, options, res), null, null);
         }

package/TiledeskExpression.js

@@ -1,4 +1,5 @@
 const {VM} = require('vm2');
+const winston = require('./utils/winston');
 
 class TiledeskExpression {
     // rules:
@@ -234,12 +235,8 @@ class TiledeskExpression {
 
     // public
     evaluateExpression(_expression, variables) {
-        // console.log("Original expression:", _expression);
         let expression = String(_expression).replace(/\$/g, "$data.");
-        // console.log("Evaluating expression:", expression);
-        // console.log("With variables:", JSON.stringify(variables));
         const result = new TiledeskExpression().evaluate(expression, variables);
-        // console.log("Expression result:", result);
         return result;
     }
 
@@ -250,8 +247,6 @@ class TiledeskExpression {
     }
 
     evaluateJavascriptExpression(expression, context) {
-        // console.log("(evaluateJavascriptExpression) evaluating:", expression)
-        // console.log("context:", context)
         let res = null;
         try {
             const vm = new VM({
@@ -260,10 +255,9 @@ class TiledeskExpression {
                 sandbox: context
             });
             res = vm.run(`let $data = this;${expression}`);
-            // console.log("res=", res)
         }
         catch (err) {
-            // console.error("(evaluateJavascriptExpression) TiledeskExpression.evaluate() error:", err.message, "- while evaluating the following expression: '" + expression + "'");
+            winston.error("(TiledeskExpression) evaluateJavascriptExpression error: " + err.message + " - while evaluating the following expression: '" + expression + "'");
         }
         return res;
     }
@@ -273,10 +267,8 @@ class TiledeskExpression {
         if(!operands) {
             return null;
         }
-        // console.log("operands are:", JSON.stringify(operands))
         let expression = operands[0].isVariable ? TiledeskExpression.variableOperand(operands[0].value) : TiledeskExpression.quotedString(operands[0].value);
             expression = operands[0].function ? TiledeskExpression.applyFunctionToOperand(expression, operands[0].function) : expression;
-        // console.log("expression is:", expression)
 
         if (operands.length === 1) {        
             return expression;
@@ -286,12 +278,7 @@ class TiledeskExpression {
                 const applyPattern = operator.applyPattern;
                 let operand = operands[i + 1].isVariable ? TiledeskExpression.variableOperand(operands[i + 1].value) : TiledeskExpression.quotedString(operands[i + 1].value);
                 operand = operands[i + 1].function ? TiledeskExpression.applyFunctionToOperand(operand, operands[i + 1].function) : operand;
-                // console.log("1. expression is:", expression)
-                // console.log("operand is:", operand)
-                
                 expression = applyPattern.replace("#1", expression).replace("#2", operand);
-                // console.log("2. expression is:", expression)
-                
             }
             return expression;
         }
@@ -303,8 +290,6 @@ class TiledeskExpression {
         const operator = TiledeskExpression.OPERATORS[function_name];
         const applyPattern = operator.applyPattern;
         expression += applyPattern.replace("#1", operand);
-        // console.log("operand is:", operand);
-        // console.log("expression is:", expression);
         return expression;
     }
 
@@ -325,8 +310,6 @@ class TiledeskExpression {
 
     // DEPRECATED
     evaluate(expression, context) {
-        // console.log("evaluating:", expression)
-        // console.log("context:", context)
         let res;
         try {
             const vm = new VM({
@@ -343,27 +326,19 @@ class TiledeskExpression {
     }
 
     static JSONConditionToExpression(condition, variables) {
-        // console.log("condition:", condition);
-        // console.log("condition.operand1:", condition.operand1);
-        // console.log("condition.operand2:", condition.operand2);
         const operator_name = condition.operator;
         const operator = TiledeskExpression.OPERATORS[operator_name];
-        // console.log("operator:", operator);
         const applyPattern = operator.applyPattern;
-        // console.log("applyPattern:", applyPattern);
         let operand1_s;
         let is_valid_operand1 = TiledeskExpression.validateVariableName(condition.operand1);
-        // console.log("is_valid_operand1:", condition.operand1, is_valid_operand1);
         if (is_valid_operand1) {
             operand1_s = TiledeskExpression.variableOperand(condition.operand1);
-            // console.log("operand1_s:", operand1_s);
         }
         else {
-            console.error("Condition evaluation stopped because of invalid operand1", condition.operand1);
+            winston.error("(TiledeskExpression) Condition evaluation stopped because of invalid operand1 " + condition.operand1);
             return null;
         }
         
-        // console.log("operand1_s:", operand1_s);
         let operand2_s;
         if (condition.operand2 && condition.operand2.type && condition.operand2.type === "const") {
             operand2_s = TiledeskExpression.stringValueOperand(condition.operand2.value, variables);
@@ -374,41 +349,32 @@ class TiledeskExpression {
                 operand2_s = TiledeskExpression.variableOperand(condition.operand2.name);
             }
             else {
-                console.error("Condition evaluation stopped because of invalid operand2", condition.operand2);
+                winston.error("(TiledeskExpression)Condition evaluation stopped because of invalid operand2 " + condition.operand2);
                 return null;
             }
         }
         else {
-            console.error("Condition evaluation stopped because of: No operand2", JSON.stringify(condition));
+            winston.error("(TiledeskExpression) Condition evaluation stopped because of: No operand2 on condition ", condition);
             return null;
         }
         
-        // console.log("operand1_s, operand2_s:",operand1_s, operand2_s);
         const expression = applyPattern.replace("#1", operand1_s).replace("#2", operand2_s);
-        // console.log("operand1_s is:", operand1_s);
-        // console.log("operand2_s is:", operand2_s);
-        // console.log("expression is:", expression);
         return expression;
     }
 
     static JSONGroupToExpression(group, variables) {
-        // console.log("attributes:", variables);
         let conditions = group.conditions;
         let group_expression = "";
-        // console.log("conditions:", conditions)
         for(let i = 0; i < conditions.length; i++) {
             let part = conditions[i];
             if (part.type === "condition") {
                 let expression = TiledeskExpression.JSONConditionToExpression(part, variables);
-                // console.log("returned expression:", expression);
                 if (expression === null) {
-                    // console.error("Invalid JSON expression", JSON.stringify(part));
                     return null;
                 }
                 group_expression += expression;
             }
             else if (part.type === "operator") {
-                // console.log("operator part:", part);
                 const operator = TiledeskExpression.OPERATORS[part.operator];
                 group_expression += operator.applyPattern;
             }
@@ -418,13 +384,12 @@ class TiledeskExpression {
 
     static JSONGroupsToExpression(groups, variables) {
         let full_expression = "";
-        // console.log("groups:", groups)
         for(let i = 0; i < groups.length; i++) {
             let g = groups[i];
             if (g.type === "expression") {
                 let group_expression = TiledeskExpression.JSONGroupToExpression(g, variables);
                 if (group_expression === null) {
-                    console.error("Invalid JSON Group expression", JSON.stringify(g));
+                    winston.error("(TiledeskExpression) Invalid JSON Group expression ", g);
                     return null;
                 }
                 full_expression += group_expression;
@@ -443,11 +408,8 @@ class TiledeskExpression {
     }
 
     static validateVariableName(variableName) {
-        // console.log("variableName", variableName)
-        // console.log("type of variableName:", typeof variableName);
         // let matches = variableName.match(/^[a-zA-Z_]*[a-zA-Z_]+[a-zA-Z0-9_]*$/gm);
         let matches = variableName.match(/^[a-zA-Z_]+.*$/gm);
-        // console.log("matches:", matches)
         if (matches !== null) {
             return true;
         }
@@ -466,13 +428,10 @@ class TiledeskExpression {
             return TiledeskExpression.quotedString(operand);
         }
         else {
-            // console.log("vars!", variables)
             let _operand = operand.trim();
             let operandAsString = TiledeskExpression.quotedString(operand); //"\"" + JSON.stringify(operand) + "\"";
             if (_operand.startsWith("$")) {
-                // console.log("_operand with $", _operand);
                 let varName = _operand.replace(/\$/g, "");
-                // console.log("varName:", varName);
                 let value = variables[varName];
                 if (value) {
                     operandAsString = TiledeskExpression.quotedString(value); //'"' + JSON.stringify(value) + '"';