@tiledesk/tiledesk-tybot-connector 2.0.9 → 2.0.10-rc2

package/tiledeskChatbotPlugs/directives/DirWebRequestV2.js

@@ -4,6 +4,7 @@ const { Filler } = require('../Filler');
 const { TiledeskChatbot } = require('../../engine/TiledeskChatbot');
 const { DirIntent } = require('./DirIntent');
 const winston = require('../../utils/winston');
+const { Logger } = require('../../Logger');
 
 class DirWebRequestV2 {
 
@@ -17,6 +18,7 @@ class DirWebRequestV2 {
     this.chatbot = context.chatbot;
     this.intentDir = new DirIntent(context);
     this.log = context.log;
+    this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest.draft });
   }
 
   execute(directive, callback) {
@@ -30,7 +32,9 @@ class DirWebRequestV2 {
       callback();
       return;
     }
+    this.logger.info("Executing WebRequest action ", directive.action)
     this.go(action, (stop) => {
+      this.logger.info("WebRequest action terminated")
       callback(stop);
     }).catch((err) => {
       // do not nothing
@@ -65,6 +69,7 @@ class DirWebRequestV2 {
     const url = filler.fill(action.url, requestAttributes);
 
     let headers = await this.getHeadersFromAction(action, filler, requestAttributes).catch( async (err) => {
+      this.logger.error("WebRequest: error getting headers");
       await this.chatbot.addParameter("flowError", "Error getting headers");
       if (falseIntent) {
         await this.#executeCondition(false, trueIntent, trueIntentAttributes, falseIntent, falseIntentAttributes);
@@ -76,6 +81,7 @@ class DirWebRequestV2 {
     });
 
     let json = await this.getJsonFromAction(action, filler, requestAttributes).catch( async (err) => {
+      this.logger.error("WebRequest: error parsing json body");
       await this.chatbot.addParameter("flowError", "Error parsing json body");
       if (falseIntent) {
         await this.#executeCondition(false, trueIntent, trueIntentAttributes, falseIntent, falseIntentAttributes);
@@ -107,8 +113,10 @@ class DirWebRequestV2 {
         let error = res.error;
         await this.#assignAttributes(action, resbody, status, error)
         winston.debug("DirWebRequestV2 resbody:", resbody);
+        this.logger.info("WebRequest resbody: ", resbody);
         
         if (err) {
+          this.logger.error("WebRequest error: ", err);
           winston.log("webRequest error: ", err);
           if (callback) {
             if (falseIntent) {
@@ -130,6 +138,7 @@ class DirWebRequestV2 {
           return;
         }
         else {
+          this.logger.warn("WebRequest status ", status);
           if (falseIntent) {
             await this.#executeCondition(false, trueIntent, trueIntentAttributes, falseIntent, falseIntentAttributes);
             callback(true);
@@ -228,6 +237,7 @@ class DirWebRequestV2 {
     }
     if (result === true) {
       if (trueIntentDirective) {
+        this.logger.info("WebRequest: executing true condition");
         this.intentDir.execute(trueIntentDirective, () => {
           if (callback) {
             callback();
@@ -235,6 +245,7 @@ class DirWebRequestV2 {
         });
       }
       else {
+        this.logger.info("WebRequest: no block connected to true condition");
         winston.debug("DirWebRequestV2 No trueIntentDirective specified");
         if (callback) {
           callback();
@@ -243,6 +254,7 @@ class DirWebRequestV2 {
     }
     else {
       if (falseIntentDirective) {
+        this.logger.info("WebRequest: executing false condition");
         this.intentDir.execute(falseIntentDirective, () => {
           if (callback) {
             callback();
@@ -250,6 +262,7 @@ class DirWebRequestV2 {
         });
       }
       else {
+        this.logger.info("WebRequest: no block connected to false condition");
         winston.debug("DirWebRequestV2 No falseIntentDirective specified");
         if (callback) {
           callback();
@@ -302,21 +315,7 @@ class DirWebRequestV2 {
           }
         })
         .catch((err) => {
-          if (this.log) {
-            // FIX THE STRINGIFY OF CIRCULAR STRUCTURE BUG - START
-            let cache = [];
-            let error_log = JSON.stringify(err, function (key, value) { // try to use a separate function
-              if (typeof value === 'object' && value != null) {
-                if (cache.indexOf(value) !== -1) {
-                  return;
-                }
-                cache.push(value);
-              }
-              return value;
-            });
-            winston.error("(DirWebRequestv2) An error occurred: ", error_log);
-            // FIX THE STRINGIFY OF CIRCULAR STRUCTURE BUG - END
-          }
+          // FIX THE STRINGIFY OF CIRCULAR STRUCTURE BUG - END
           if (callback) {
             let status = 1000;
             let cache = [];

package/tiledeskChatbotPlugs/directives/DirWebResponse.js

@@ -3,6 +3,7 @@ const { TiledeskChatbot } = require('../../engine/TiledeskChatbot');
 const { TiledeskChatbotUtil } = require('../../utils/TiledeskChatbotUtil');
 const winston = require('../../utils/winston');
 let axios = require('axios');
+const { Logger } = require('../../Logger');
 
 class DirWebResponse {
 
@@ -15,7 +16,7 @@ class DirWebResponse {
     this.requestId = context.requestId;
     this.token = context.token;
     this.tdcache = context.tdcache;
-    this.log = context.log;
+    this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest.draft });
   }
 
   execute(directive, callback) {
@@ -29,8 +30,9 @@ class DirWebResponse {
       callback();
       return;
     }
+    this.logger.info("Executing WebResponse action ", directive.action)
     this.go(action, () => {
-        // return stop true?
+      this.logger.info("WebResponse action terminated")
         callback();
     });
   }
@@ -59,6 +61,8 @@ class DirWebResponse {
       payload: json
     }
 
+    this.logger.debug("WebResponse payload: ", webResponse);
+
     const topic = `/webhooks/${this.requestId}`;
     
     try {
@@ -96,42 +100,4 @@ class DirWebResponse {
 
 }
 
-
-
-/**
- * A stub to send message to the "ext/botId" endpoint, hosted by tilebot on:
- * /${TILEBOT_ROUTE}/ext/${botId}
- *
- * @param {Object} webResponse. The webhook response to send back
- * @param {Object} projectId. The projectId
- * @param {string} botId. Tiledesk botId
- * @param {string} token. User token
- */
-// function sendResponse(webResponse, projectId, botId, callback) {
-//   const url = `${WEBHOOK_URL}/${projectId}/${botId}`;
-//   const HTTPREQUEST = {
-//     url: url,
-//     headers: {
-//       'Content-Type': 'application/json'
-//     },
-//     json: webResponse,
-//     method: 'POST'
-//   };
-//   myrequest(
-//     HTTPREQUEST,
-//     function (err, resbody) {
-//       if (err) {
-//         if (callback) {
-//           callback(err);
-//         }
-//       }
-//       else {
-//         if (callback) {
-//           callback(null, resbody);
-//         }
-//       }
-//     }, false
-//   );
-// }
-
 module.exports = { DirWebResponse };

package/tiledeskChatbotPlugs/directives/DirWhatsappByAttribute.js

@@ -13,7 +13,6 @@ class DirWhatsappByAttribute {
     }
     this.context = context;
     this.API_ENDPOINT = context.API_ENDPOINT;
-    this.log = context.log;
   }
 
   execute(directive, callback) {

package/tiledeskChatbotPlugs/directives/Directives.js

@@ -58,7 +58,9 @@ class Directives {
   static MOVE_TO_UNASSIGNED = "move_to_unassigned";
   static CONNECT_BLOCK = "connect_block";
   static ADD_TAGS = 'add_tags'
+  static WEBHOOK = 'webhook';
   static WEB_RESPONSE = "web_response";
+  static FLOW_LOG = "flow_log";
 
   // static WHEN_ONLINE_MOVE_TO_AGENT = "whenonlinemovetoagent"; // DEPRECATED?
   // static WHEN_OFFLINE_HOURS = "whenofflinehours"; // DEPRECATED // adds a message on top of the original message when offline hours opts: --replace

package/utils/TiledeskChatbotUtil.js

@@ -252,24 +252,24 @@ class TiledeskChatbotUtil {
         }
     }
 
-    static fillCommandAttachments(command, variables, log) {
-        if (log) { winston.debug("(TiledeskChatbotUtils) Filling command button: ", command) }
+    static fillCommandAttachments(command, variables) {
+        winston.debug("(TiledeskChatbotUtils) Filling command button: ", command)
         if (command.message && command.message.attributes && command.message.attributes.attachment && command.message.attributes.attachment.buttons && command.message.attributes.attachment.buttons.length > 0) {
             let buttons = command.message.attributes.attachment.buttons;
             const filler = new Filler();
             buttons.forEach(button => {
                 if (button.link) {
                     button.link = filler.fill(button.link, variables);
-                    if (log) { winston.debug("(TiledeskChatbotUtils) button.link filled: " + button.link) }
+                    winston.debug("(TiledeskChatbotUtils) button.link filled: " + button.link)
                 }
                 if (button.value) {
                     button.value = filler.fill(button.value, variables);
-                    if (log) { winston.debug("(TiledeskChatbotUtils) button.value filled: " + button.value) }
+                    winston.debug("(TiledeskChatbotUtils) button.value filled: " + button.value)
                 }
             });
         }
         else {
-            if (log) { winston.debug("(TiledeskChatbotUtils) No attachments to fill in command") }
+            winston.debug("(TiledeskChatbotUtils) No attachments to fill in command")
         }
     }
 
@@ -319,55 +319,31 @@ class TiledeskChatbotUtil {
                                     json_buttons.forEach(button => {
                                         if (button.value && button.type === "action" && button.action) {
                                             button.show_echo = true;
-                                            // console.log("pushing:", button)
                                             final_buttons.push(button);
                                         }
                                         else if (button.value && button.type === "text") {
                                             button.show_echo = true;
-                                            // console.log("pushing:", button)
                                             final_buttons.push(button);
                                         }
                                         else if (button.value && button.type === "url" && button.link) {
                                             button.show_echo = true;
-                                            // console.log("pushing:", button)
                                             final_buttons.push(button);
                                         }
                                         else {
-                                            console.log("Invalid button. Skipping:", JSON.stringify(button) );
+                                            winston.verbose("Invalid button. Skipping:", button);
                                         }
                                     });
                                 }
-
-                                // "buttons": [
-                                //                 {
-                                //                     "type": "action",
-                                //                     "value": "Button1", // obbligatorio sempre
-                                //                     "action": "#bb347206-d639-4926-94c9-e94930623dce", // mandatory
-                                //                     "show_echo": true, // lo inserisco sempre
-                                //                     "alias": "button1 alias"
-                                //                 },
-                                //                 {
-                                //                     "type": "text",
-                                //                     "value": "Button2 text", // obbligatorio sempre
-                                //                     "show_echo": true // lo inserisco sempre
-                                //                 },
-                                //                 {
-                                //                     "type": "url",
-                                //                     "value": "Button3 link", // obbligatorio sempre
-                                //                     "link": "http://", // obbligatorio
-                                //                     "show_echo": true // lo inserisco sempre
-                                //                 }
-                                //             ]
                             }
                             catch(error) {
-                                console.error("Invalid json_buttons:", error)
+                                winston.warn("Invalid json_buttons:", error)
                             }
                             if (final_buttons && final_buttons.length > 0) {
                                 command.message.attributes.attachment.buttons = final_buttons;
                                 delete command.message.attributes.attachment.json_buttons;
                             }
                             else {
-                                console.log("Invalid json_buttons. Skipping")
+                                winston.verbose("Invalid json_buttons. Skipping...")
                             }
                         }
                     }
@@ -520,7 +496,7 @@ class TiledeskChatbotUtil {
     static async updateRequestAttributes(chatbot, chatbotToken, message, projectId, requestId) {
         // update request context
         try {
-            if (chatbot.log) { winston.debug("Updating request variables. Message:", message); }
+            winston.debug("Updating request variables. Message:", message);
             const messageId = message._id;
             const chat_url = `https://panel.tiledesk.com/v3/dashboard/#/project/${projectId}/wsrequest/${requestId}/messages`
 
@@ -591,12 +567,12 @@ class TiledeskChatbotUtil {
             }
             
             if (message && message.request && message.request.lead) {
-                if (chatbot.log) { winston.debug("(TiledeskChatbotUtil) Lead found with email: " + message.request.lead.email + " and lead.fullname " + message.request.lead.fullname); }
+                winston.debug("(TiledeskChatbotUtil) Lead found with email: " + message.request.lead.email + " and lead.fullname " + message.request.lead.fullname);
                 let currentLeadEmail = await chatbot.getParameter(TiledeskChatbotConst.REQ_LEAD_EMAIL_KEY);
-                if (chatbot.log) { winston.debug("(TiledeskChatbotUtil) You lead email from attributes: " + currentLeadEmail); }
+                winston.debug("(TiledeskChatbotUtil) You lead email from attributes: " + currentLeadEmail);
                 if (message.request.lead.email && !currentLeadEmail) {
                     // worth saving
-                    if (chatbot.log) { winston.debug("(TiledeskChatbotUtil) worth saving email"); }
+                    winston.debug("(TiledeskChatbotUtil) worth saving email");
                     try {
                         await chatbot.addParameter(TiledeskChatbotConst.REQ_LEAD_EMAIL_KEY, message.request.lead.email);
                     }
@@ -605,10 +581,10 @@ class TiledeskChatbotUtil {
                     }
                 }
                 let currentLeadName = await chatbot.getParameter(TiledeskChatbotConst.REQ_LEAD_USERFULLNAME_KEY);
-                if (chatbot.log) { winston.debug("(TiledeskChatbotUtil) You lead email from attributes: " + currentLeadEmail); }
+                winston.debug("(TiledeskChatbotUtil) You lead email from attributes: " + currentLeadEmail);
                 if (message.request.lead.fullname && !currentLeadName) {
                     // worth saving
-                    if (chatbot.log) { winston.debug("(TiledeskChatbotUtil) worth saving email"); }
+                    winston.debug("(TiledeskChatbotUtil) worth saving email");
                     try {
                         await chatbot.addParameter(TiledeskChatbotConst.REQ_LEAD_USERFULLNAME_KEY, message.request.lead.fullname);
                     }
@@ -685,10 +661,10 @@ class TiledeskChatbotUtil {
                     message.attributes = {}
                 }
                 message.attributes.payload = { ...message.attributes.payload, ...message.request.attributes.payload }
-                if (chatbot.log) { winston.debug("(TiledeskChatbotUtil) Forced Set message.attributes.payload ", message.attributes.payload); }
+                winston.debug("(TiledeskChatbotUtil) Forced Set message.attributes.payload ", message.attributes.payload); 
             }
             if (message.attributes) {
-                if (chatbot.log) { winston.debug("(TiledeskChatbotUtil) Ok message.attributes ", message.attributes); }
+                winston.debug("(TiledeskChatbotUtil) Ok message.attributes ", message.attributes);
 
                 await chatbot.addParameter(TiledeskChatbotConst.REQ_END_USER_ID_KEY, message.attributes.requester_id);
                 await chatbot.addParameter(TiledeskChatbotConst.REQ_END_USER_IP_ADDRESS_KEY, message.attributes.ipAddress);
@@ -722,12 +698,12 @@ class TiledeskChatbotUtil {
             
             
             const _bot = chatbot.bot; // aka FaqKB
-            if (chatbot.log) { winston.debug("(TiledeskChatbotUtil) Adding Globals to context: ", _bot); }
+            winston.debug("(TiledeskChatbotUtil) Adding Globals to context: ", _bot); 
             
             if (_bot.attributes && _bot.attributes.globals) {
-                if (chatbot.log) { winston.error("(TiledeskChatbotUtil) Got Globals: ", _bot.attributes.globals); }
+                winston.error("(TiledeskChatbotUtil) Got Globals: ", _bot.attributes.globals);
                 _bot.attributes.globals.forEach(async (global_var) => {
-                    if (chatbot.log) { winston.error("(TiledeskChatbotUtil) Adding global: " + global_var.key + " value: " + global_var.value); }
+                    winston.error("(TiledeskChatbotUtil) Adding global: " + global_var.key + " value: " + global_var.value);
                     await chatbot.addParameter(global_var.key, global_var.value);
                 });
             }
@@ -740,20 +716,6 @@ class TiledeskChatbotUtil {
             //     }
             // );
             
-            if (chatbot.log) {
-                if (chatbot.log) { winston.debug("(TiledeskChatbotUtil) requestId: " + requestId); }
-                if (chatbot.log) { winston.debug("(TiledeskChatbotUtil) Key: " + TiledeskChatbotConst.REQ_PROJECT_ID_KEY); }
-
-                let proj_ = await chatbot.getParameter(TiledeskChatbotConst.REQ_PROJECT_ID_KEY);
-                if (chatbot.log) { winston.debug("(TiledeskChatbotUtil) request parameter proj_: " + proj_); }
-
-                const all_parameters = await chatbot.allParameters();
-                for (const [key, value] of Object.entries(all_parameters)) {
-                    const value_type = typeof value;
-                    if (chatbot.log) { winston.debug("(TiledeskChatbotUtil) Request Attribute: " + key + " value: " + value + " type: " + value_type); }
-                    
-                }
-            }
         } catch(error) {
             winston.error("(TiledeskChatbotUtil) updateRequestAttributes Error: ", error);
             process.exit(1)

package/TdCache copy.js

@@ -1,242 +0,0 @@
-const redis = require('redis');
-
-class TdCache {
-
-    constructor(config) {
-        this.redis_host = config.host;
-        this.redis_port = config.port;
-        this.redis_password = config.password;
-        this.client = null;
-    }
-
-    async connect(callback) {
-        // client = redis.createClient();
-        return new Promise( async (resolve, reject) => {
-            this.client = redis.createClient(
-                {
-                    host: this.redis_host,
-                    port: this.redis_port,
-                    password: this.redis_password
-                });
-            this.client.on('error', err => {
-                reject(err);
-                if (callback) {
-                    callback(err);
-                }
-            });
-            // this.client.on('connect', function() {
-            //     console.log('Redis Connected!');
-            // });
-            this.client.on('ready',function() {
-              console.log("connected")
-                resolve();
-                if (callback) {
-                    callback();
-                }
-                //console.log("Redis is ready.");
-            });
-        });
-    }
-
-    async set(key, value, options) {
-      //console.log("setting key value", key, value)
-      if (!options) {
-        options = {EX: 86400}
-      }
-      return new Promise( async (resolve, reject) => {
-        if (options && options.EX) {
-          //console.log("expires:", options.EX)
-          try {
-            await this.client.set(
-              key,
-              value,
-              'EX', options.EX);
-          }
-          catch(error) {
-            reject(error)
-          }
-        }
-        else {
-          try {
-            //console.log("setting here...key", key, value)
-            await this.client.set(
-              key,
-              value);
-          }
-          catch(error) {
-            console.error("Error", error);
-            reject(error)
-          }
-        }
-        if (options && options.callback) {
-            options.callback();
-        }
-        //console.log("resolving...", key);
-        return resolve();
-      });
-    }
-
-    async incr(key) {
-      // console.log("incr key:", key)
-      return new Promise( async (resolve, reject) => {
-          try {
-            // console.log("incr here...key", key)
-            await this.client.incr(key);
-          }
-          catch(error) {
-            console.error("Error on incr:", error);
-            reject(error)
-          }
-        return resolve();
-      });
-    }
-
-    async hset(dict_key, key, value, options) {
-      //console.log("hsetting dict_key key value", dict_key, key, value)
-      return new Promise( async (resolve, reject) => {
-        if (options && options.EX) {
-          //console.log("expires:", options.EX)
-          try {
-            await this.client.hset(
-              dict_key,
-              key,
-              value,
-              'EX', options.EX);
-          }
-          catch(error) {
-            reject(error)
-          }
-        }
-        else {
-          try {
-            //console.log("setting here...key", key, value)
-            await this.client.hset(
-              dict_key,
-              key,
-              value);
-          }
-          catch(error) {
-            console.error("Error", error);
-            reject(error)
-          }
-        }
-        if (options && options.callback) {
-            options.callback();
-        }
-        return resolve();
-      });
-    }
-
-    async hdel(dict_key, key, options) {
-      //console.log("hsetting dict_key key value", dict_key, key, value)
-      return new Promise( async (resolve, reject) => {
-        if (options && options.EX) {
-          //console.log("expires:", options.EX)
-          try {
-            await this.client.hdel(
-              dict_key,
-              key,
-              'EX', options.EX);
-          }
-          catch(error) {
-            reject(error)
-          }
-        }
-        else {
-          try {
-            //console.log("setting here...key", key, value)
-            await this.client.hdel(
-              dict_key,
-              key);
-          }
-          catch(error) {
-            console.error("Error", error);
-            reject(error);
-          }
-        }
-        if (options && options.callback) {
-            options.callback();
-        }
-        return resolve();
-      });
-    }
-    
-    async setJSON(key, value, options) {
-      const _string = JSON.stringify(value);
-      return await this.set(key, _string, options);
-    }
-    
-    async get(key, callback) {
-      //console.log("getting key", key)
-      return new Promise( async (resolve, reject) => {
-        this.client.get(key, (err, value) => {
-          if (err) {
-            reject(err);
-          }
-          else {
-            if (callback) {
-              callback(value);
-          }
-          return resolve(value);
-          }
-        });
-      });
-    }
-
-    async hgetall(dict_key, callback) {
-      //console.log("hgetting dics", dict_key);
-      return new Promise( async (resolve, reject) => {
-        this.client.hgetall(dict_key, (err, value) => {
-          if (err) {
-            reject(err);
-            if (callback) {
-              callback(err, null);
-            }
-          }
-          else {
-            if (callback) {
-              callback(null, value);
-            }
-            resolve(value);
-          }
-        });
-      });
-    }
-
-    async hget(dict_key, key, callback) {
-      //console.log("hgetting dics", dict_key);
-      return new Promise( async (resolve, reject) => {
-        this.client.hget(dict_key, key, (err, value) => {
-          if (err) {
-            reject(err);
-            if (callback) {
-              callback(err, null);
-            }
-          }
-          else {
-            if (callback) {
-              callback(null, value);
-            }
-            resolve(value);
-          }
-        });
-      });
-    }
-    
-    async getJSON(key, callback) {
-      const value = await this.get(key);
-      return JSON.parse(value);
-    }
-    
-    async del(key, callback) {
-      return new Promise( async (resolve, reject) => {
-        await this.client.del(key);
-        if (callback) {
-            callback();
-        }
-        return resolve();
-      })
-    }
-}
-
-module.exports = { TdCache };