@tiledesk/tiledesk-tybot-connector 2.0.11 → 2.0.12-rc2

package/tiledeskChatbotPlugs/directives/DirReplaceBotV3.js

@@ -6,6 +6,7 @@ const axios = require("axios").default;
 let https = require("https");
 const winston = require('../../utils/winston');
 const httpUtils = require('../../utils/HttpUtils');
+const { Logger } = require('../../Logger');
 
 class DirReplaceBotV3 {
 
@@ -15,30 +16,27 @@ class DirReplaceBotV3 {
     }
     this.context = context;
     this.requestId = context.requestId;
-    this.log = context.log;
-
     this.API_ENDPOINT = context.API_ENDPOINT;
-    this.tdClient = new TiledeskClient({
-      projectId: this.context.projectId,
-      token: this.context.token,
-      APIURL: this.API_ENDPOINT,
-      APIKEY: "___",
-      log: this.log
-    });
+    
+    this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest?.draft, intent_id: this.context.reply?.attributes?.intent_info?.intent_id });
+    this.tdClient = new TiledeskClient({ projectId: this.context.projectId, token: this.context.token, APIURL: this.API_ENDPOINT, APIKEY: "___" });
   }
 
   execute(directive, callback) {
+    this.logger.info("[Replace Bot] Executing action");
     winston.verbose("Execute ReplaceBotV3 directive");
     let action;
     if (directive.action) {
       action = directive.action;
     }
     else {
+      this.logger.error("Incorrect action for ", directive.name, directive)
       winston.warn("DirReplaceBotV3 Incorrect directive: ", directive);
       callback();
       return;
     }
     this.go(action, () => {
+      this.logger.info("[Replace Bot] Action completed");
       callback();
     })
   }

package/tiledeskChatbotPlugs/directives/DirReply.js

@@ -18,19 +18,14 @@ class DirReply {
     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 });
-
     this.API_ENDPOINT = context.API_ENDPOINT;
-    this.tdClient = new TiledeskClient({
-      projectId: this.context.projectId,
-      token: this.context.token,
-      APIURL: this.API_ENDPOINT,
-      APIKEY: "___",
-      log: this.log
-    });
+    
+    this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest?.draft, intent_id: this.context.reply?.attributes?.intent_info?.intent_id });
+    this.tdClient = new TiledeskClient({ projectId: this.context.projectId, token: this.context.token, APIURL: this.API_ENDPOINT, APIKEY: "___", log: this.log });
   }
 
   execute(directive, callback) {
+    this.logger.info("[Reply] Executing action");
     let action;
     if (directive.action) {
       action = directive.action;
@@ -40,14 +35,14 @@ class DirReply {
       action.attributes.fillParams = true;
     }
     else {
+      this.logger.error("Incorrect action for ", directive.name, directive)
       winston.error("DirReply Incorrect directive (no action provided):", directive);
       callback();
       return;
     }
-    this.logger.info("1 Execute action reply for " + directive.action.text)
 
     this.go(action, () => {
-      this.logger.info("6 End of action reply " + directive.action.text + " -> callback")
+      this.logger.info("[Reply] Action completed");
       callback();
     });
   }
@@ -68,7 +63,7 @@ class DirReply {
       const filler = new Filler();
       // fill text attribute
       message.text = filler.fill(message.text, requestAttributes);
-      this.logger.info("2 Sending reply " + message.text);
+      this.logger.debug("[Reply] Reply with: " + message.text);
 
       if (message.metadata) {
         winston.debug("DirReply filling message 'metadata':", message.metadata);
@@ -143,8 +138,7 @@ class DirReply {
     }
 
     let cleanMessage = message;
-    this.logger.info("3 Sending reply (text) " + cleanMessage.text);
-    this.logger.info("4 Sending reply with clean message " + JSON.stringify(cleanMessage));
+    
     // cleanMessage = TiledeskChatbotUtil.removeEmptyReplyCommands(message);
     // if (!TiledeskChatbotUtil.isValidReply(cleanMessage)) {
     //   console.log("invalid message", cleanMessage);
@@ -162,10 +156,9 @@ class DirReply {
       (err) => {
         if (err) {
           winston.error("DirReply Error sending reply: ", err);
-          this.logger.error("Error sending reply: " + err);
+          this.logger.error("[Reply] Error sending reply: " + err);
         }
         winston.verbose("DirReply reply message sent")
-        this.logger.info("5 Reply message sent");
         const delay = TiledeskChatbotUtil.totalMessageWait(cleanMessage);
         if (delay > 0 && delay <= 30000) { // prevent long delays
           setTimeout(() => {

package/tiledeskChatbotPlugs/directives/DirReplyV2.js

@@ -8,6 +8,7 @@ const { DirMessageToBot } = require('./DirMessageToBot');
 const { v4: uuidv4 } = require('uuid');
 const { TiledeskClient } = require('@tiledesk/tiledesk-client');
 const winston = require('../../utils/winston');
+const { Logger } = require('../../Logger');
 
 class DirReplyV2 {
 
@@ -20,23 +21,18 @@ class DirReplyV2 {
     this.requestId = context.requestId;
     this.token = context.token;
     this.tdcache = context.tdcache;
-    this.log = context.log;
-    this.intentDir = new DirIntent(context);
     this.chatbot = context.chatbot;
     this.reply = context.reply;
     this.originalMessage = context.message;
-
     this.API_ENDPOINT = context.API_ENDPOINT;
-    this.tdClient = new TiledeskClient({
-      projectId: this.context.projectId,
-      token: this.context.token,
-      APIURL: this.API_ENDPOINT,
-      APIKEY: "___",
-      log: this.log
-    });
+    
+    this.intentDir = new DirIntent(context);
+    this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest?.draft, intent_id: this.context.reply?.attributes?.intent_info?.intent_id });
+    this.tdClient = new TiledeskClient({ projectId: this.context.projectId, token: this.context.token, APIURL: this.API_ENDPOINT, APIKEY: "___" });
   }
 
   execute(directive, callback) {
+    this.logger.info("[Advanced Reply] Executing action");
     winston.verbose("Execute ReplyV2 directive");
     let action;
     if (directive.action) {
@@ -47,11 +43,13 @@ class DirReplyV2 {
       action.attributes.fillParams = true;
     }
     else {
+      this.logger.error("Incorrect action for ", directive.name, directive)
       winston.warn("DirReplyV2 Incorrect directive: ", directive);
       callback();
       return;
     }
     this.go(action, (stop) => {
+      this.logger.info("[Advanced Reply] Action completed");
       callback(stop);
     });
   }

package/tiledeskChatbotPlugs/directives/DirSendEmail.js

@@ -4,6 +4,7 @@ const { TiledeskChatbot } = require('../../engine/TiledeskChatbot');
 const { Filler } = require('../Filler');
 const { TiledeskClient } = require('@tiledesk/tiledesk-client');
 const winston = require('../../utils/winston');
+const { Logger } = require('../../Logger');
 // const { TiledeskClient } = require('@tiledesk/tiledesk-client');
 
 class DirSendEmail {
@@ -15,19 +16,14 @@ class DirSendEmail {
     this.context = context;
     this.tdcache = context.tdcache;
     this.requestId = context.requestId;
-    this.log = context.log;    
-
     this.API_ENDPOINT = context.API_ENDPOINT;
-    this.tdClient = new TiledeskClient({
-      projectId: this.context.projectId,
-      token: this.context.token,
-      APIURL: this.API_ENDPOINT,
-      APIKEY: "___",
-      log: this.log
-    });
+    
+    this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest?.draft, intent_id: this.context.reply?.attributes?.intent_info?.intent_id });
+    this.tdClient = new TiledeskClient({ projectId: this.context.projectId, token: this.context.token, APIURL: this.API_ENDPOINT, APIKEY: "___" });
   }
 
   execute(directive, callback) {
+    this.logger.info("[Send Email] Executing action");
     winston.verbose("Execute SendEmail directive");
     let action;
     if (directive.action) {
@@ -42,11 +38,13 @@ class DirSendEmail {
       }
     }
     else {
+      this.logger.error("Incorrect action for ", directive.name, directive)
       winston.warn("DirSendEmail Incorrect directive: ", directive);
       callback();
       return;
     }
     this.go(action, () => {
+      this.logger.info("[Send Email] Action completed");
       callback();
     });
   }

package/tiledeskChatbotPlugs/directives/DirSendWhatsapp.js

@@ -4,6 +4,7 @@ const { Filler } = require("../Filler");
 const { DirIntent } = require("./DirIntent");
 const winston = require('../../utils/winston');
 const httpUtils = require("../../utils/HttpUtils");
+const { Logger } = require("../../Logger");
 
 let whatsapp_api_url;
 
@@ -17,23 +18,27 @@ class DirSendWhatsapp {
     this.chatbot = context.chatbot;
     this.tdcache = this.context.tdcache;
     this.requestId = this.context.requestId;
-    this.intentDir = new DirIntent(context);
     this.API_ENDPOINT = this.context.API_ENDPOINT;
-    this.log = context.log;
+    
+    this.intentDir = new DirIntent(context);
+    this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest?.draft, intent_id: this.context.reply?.attributes?.intent_info?.intent_id });
   }
 
   execute(directive, callback) {
+    this.logger.info("[Send Whatsapp] Executing action");
     winston.verbose("Execute SendWhatsapp directive");
     let action;
     if (directive.action) {
       action = directive.action;
     }
     else {
+      this.logger.error("Incorrect action for ", directive.name, directive)
       winston.warn("DirSendWhatsapp Incorrect directive: ", directive);
       callback();
       return;
     }
     this.go(action, (stop) => {
+      this.logger.info("[Send Whatsapp] Action completed");
       callback(stop);
     })
   }

package/tiledeskChatbotPlugs/directives/DirSetAttributeV2.js

@@ -6,6 +6,7 @@ const { Filler } = require('../Filler');
 const validate = require('jsonschema').validate;
 const winston = require('../../utils/winston');
 const httpUtils = require('../../utils/HttpUtils');
+const { Logger } = require('../../Logger');
 
 const schema = {
     "type": "object",
@@ -79,21 +80,26 @@ class DirSetAttributeV2 {
         }
         this.context = context;
         this.tdcache = context.tdcache;
-        this.log = context.log;
+        this.requestId = context.requestId;
+
+        this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest?.draft, intent_id: this.context.reply?.attributes?.intent_info?.intent_id });
     }
 
     execute(directive, callback) {
+        this.logger.info("[Set Attribute] Executing action");
         winston.verbose("Execute SetAttributeV2 directive");
         let action;
         if (directive.action) {
             action = directive.action
         }
         else {
+            this.logger.error("Incorrect action for ", directive.name, directive)
             winston.warn("DirSetAttributeV2 Incorrect directive: ", directive);
             callback();
             return;
         }
         this.go(action, () => {
+            this.logger.info("[Set Attribute] Action completed");
             callback();
         });
     }

package/tiledeskChatbotPlugs/directives/DirSetConversationTags.js

@@ -11,15 +11,9 @@ class DirSetConversationTags {
     this.context = context;
     this.log = context.log;
     this.requestId = context.requestId;
-
     this.API_ENDPOINT = context.API_ENDPOINT;
-    this.tdClient = new TiledeskClient({
-      projectId: this.context.projectId,
-      token: this.context.token,
-      APIURL: this.API_ENDPOINT,
-      APIKEY: "___",
-      log: this.log
-    });
+    
+    this.tdClient = new TiledeskClient({ projectId: this.context.projectId, token: this.context.token, APIURL: this.API_ENDPOINT, APIKEY: "___", log: this.log });
   }
 
   execute(directive, callback) {

package/tiledeskChatbotPlugs/directives/DirWait.js

@@ -1,4 +1,5 @@
 
+const { Logger } = require('../../Logger');
 const { TiledeskChatbot } = require('../../engine/TiledeskChatbot');
 const winston = require('../../utils/winston');
 
@@ -12,11 +13,13 @@ class DirWait {
     this.chatbot = context.chatbot;
     this.tdcache = context.tdcache;
     this.requestId = context.requestId;
-    this.log = context.log;
+    
+    this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest?.draft, intent_id: this.context.reply?.attributes?.intent_info?.intent_id });
   }
 
   execute(directive, callback) {
     //  500ms < wait-time < 10.000ms
+    this.logger.info("[Wait] Executing action");
     winston.verbose("Execute Wait directive");
     let action;
     if (directive.action) {
@@ -45,6 +48,7 @@ class DirWait {
     }
 
     this.go(action, () => {
+      this.logger.info("[Wait] Action completed");
       callback();
     })
   }
@@ -57,6 +61,7 @@ class DirWait {
       // await this.tdcache.set(step_key, 0);
       await TiledeskChatbot.resetStep(this.tdcache, this.requestId);
     }
+    this.logger.verbose("[Wait] Waiting for ", action.millis, "[ms]")
     setTimeout(() => {
       callback();
     }, action.millis);

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 {
 
@@ -15,8 +16,10 @@ class DirWebRequestV2 {
     this.tdcache = context.tdcache;
     this.requestId = context.requestId;
     this.chatbot = context.chatbot;
-    this.intentDir = new DirIntent(context);
     this.log = context.log;
+    
+    this.intentDir = new DirIntent(context);
+    this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest?.draft, intent_id: this.context.reply?.attributes?.intent_info?.intent_id });
   }
 
   execute(directive, callback) {
@@ -30,7 +33,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
@@ -50,10 +55,10 @@ class DirWebRequestV2 {
     let trueIntentAttributes = action.trueIntentAttributes;
     let falseIntentAttributes = action.falseIntentAttributes;
 
-    winston.debug("DirWebRequestV2  trueIntent " + trueIntent)
-    winston.debug("DirWebRequestV2  falseIntent " + falseIntent)
-    winston.debug("DirWebRequestV2  trueIntentAttributes " + trueIntentAttributes)
-    winston.debug("DirWebRequestV2  falseIntentAttributes " + falseIntentAttributes)
+    winston.debug("DirWebRequestV2 trueIntent " + trueIntent)
+    winston.debug("DirWebRequestV2 falseIntent " + falseIntent)
+    winston.debug("DirWebRequestV2 trueIntentAttributes " + trueIntentAttributes)
+    winston.debug("DirWebRequestV2 falseIntentAttributes " + falseIntentAttributes)
 
     let requestAttributes = null;
     requestAttributes =
@@ -65,6 +70,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 +82,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 +114,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 +139,8 @@ class DirWebRequestV2 {
           return;
         }
         else {
+          this.logger.warn("WebRequest status ", status);
+          this.logger.error("WebRequest error ", error);
           if (falseIntent) {
             await this.#executeCondition(false, trueIntent, trueIntentAttributes, falseIntent, falseIntentAttributes);
             callback(true);
@@ -228,6 +239,7 @@ class DirWebRequestV2 {
     }
     if (result === true) {
       if (trueIntentDirective) {
+        this.logger.info("WebRequest: executing true condition");
         this.intentDir.execute(trueIntentDirective, () => {
           if (callback) {
             callback();
@@ -235,6 +247,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 +256,7 @@ class DirWebRequestV2 {
     }
     else {
       if (falseIntentDirective) {
+        this.logger.info("WebRequest: executing false condition");
         this.intentDir.execute(falseIntentDirective, () => {
           if (callback) {
             callback();
@@ -250,6 +264,7 @@ class DirWebRequestV2 {
         });
       }
       else {
+        this.logger.info("WebRequest: no block connected to false condition");
         winston.debug("DirWebRequestV2 No falseIntentDirective specified");
         if (callback) {
           callback();

package/tiledeskChatbotPlugs/directives/DirWebRequestV2_old.js

@@ -13,8 +13,9 @@ class DirWebRequestV2 {
     this.tdcache = context.tdcache;
     this.requestId = context.requestId;
     this.chatbot = context.chatbot;
-    this.intentDir = new DirIntent(context);
     this.log = context.log;
+    
+    this.intentDir = new DirIntent(context);
   }
 
   execute(directive, callback) {

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,22 +16,25 @@ 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, intent_id: this.context.reply?.attributes?.intent_info?.intent_id });
   }
 
   execute(directive, callback) {
+    this.logger.info("[Web Response] Executing action");
     winston.debug("Execute WebResponse directive: ", directive);
     let action;
     if (directive.action) {
       action = directive.action;
     }
     else {
+      this.logger.error("Incorrect action for ", directive.name, directive)
       winston.debug("DirWebResponse Incorrect directive: ", directive);
       callback();
       return;
     }
     this.go(action, () => {
-        // return stop true?
+      this.logger.info("[Web Response] Action completed");
         callback();
     });
   }
@@ -59,6 +63,8 @@ class DirWebResponse {
       payload: json
     }
 
+    this.logger.debug("[Web Response] payload: ", webResponse);
+
     const topic = `/webhooks/${this.requestId}`;
     
     try {
@@ -96,42 +102,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

@@ -1,4 +1,5 @@
 const axios = require("axios").default;
+const { Logger } = require("../../Logger");
 const { TiledeskChatbot } = require('../../engine/TiledeskChatbot');
 const httpUtils = require("../../utils/HttpUtils");
 const winston = require('../../utils/winston');
@@ -12,22 +13,27 @@ class DirWhatsappByAttribute {
       throw new Error('context object is mandatory');
     }
     this.context = context;
+    this.requestId = this.context.requestId;
     this.API_ENDPOINT = context.API_ENDPOINT;
-    this.log = context.log;
+    
+    this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest?.draft, intent_id: this.context.reply?.attributes?.intent_info?.intent_id });
   }
 
   execute(directive, callback) {
+    this.logger.info("[Whatsapp by Attribute] Executing action");
     winston.verbose("Execute WhatsappByAttribute directive");
     let action;
     if (directive.action) {
       action = directive.action;
     }
     else {
+      this.logger.error("Incorrect action for ", directive.name, directive)
       winston.warn("DirWhatsappByAttribute Incorrect directive: ", directive);
       callback();
       return;
     }
     this.go(action, () => {
+      this.logger.info("[Whatsapp by Attribute] Action completed");
       callback();
     })
   }

package/tiledeskChatbotPlugs/directives/Directives.js

@@ -59,6 +59,7 @@ class Directives {
   static CONNECT_BLOCK = "connect_block";
   static ADD_TAGS = 'add_tags'
   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

@@ -605,10 +605,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); }
+                if (chatbot.log) { winston.debug("(TiledeskChatbotUtil) You lead name from attributes: " + currentLeadName); }
                 if (message.request.lead.fullname && !currentLeadName) {
                     // worth saving
-                    if (chatbot.log) { winston.debug("(TiledeskChatbotUtil) worth saving email"); }
+                    if (chatbot.log) { winston.debug("(TiledeskChatbotUtil) worth saving name"); }
                     try {
                         await chatbot.addParameter(TiledeskChatbotConst.REQ_LEAD_USERFULLNAME_KEY, message.request.lead.fullname);
                     }