@tiledesk/tiledesk-tybot-connector 0.2.601-rc1 → 0.3.0

package/models/TiledeskChatbot.js

@@ -12,7 +12,8 @@ const { DirUnlockIntent } = require('../tiledeskChatbotPlugs/directives/DirUnloc
 
 class TiledeskChatbot {
 
-  static MAX_STEPS = 200;
+  // static MAX_STEPS = process.env.CHATBOT_MAX_STEPS || 1000; // prod 1000;
+  // static MAX_EXECUTION_TIME = process.env.CHATBOT_MAX_EXECUTION_TIME || 1000 * 3600 * 8;// test // prod1000 * 3600 * 4; // 4 hours
 
   constructor(config) {
     if (!config.botsDataSource) {
@@ -38,31 +39,29 @@ class TiledeskChatbot {
     this.APIKEY = config.APIKEY;
     this.requestId = config.requestId;
     this.projectId = config.projectId;
+    this.MAX_STEPS = config.MAX_STEPS;
+    this.MAX_EXECUTION_TIME = config.MAX_EXECUTION_TIME;
     this.log = config.log;
   }
 
   async replyToMessage(message, callback) {
     return new Promise( async (resolve, reject) => {
-      // get bot info
-      // if (this.log) {
-      //   console.log("replyToMessage():", JSON.stringify(message));
-      // }
       let lead = null;
       if (message.request) {
         this.request = message.request;
-        lead = message.request.lead;
-        if (lead && lead.fullname) {
-          if (this.log) {console.log("lead.fullname => params.userFullname:", lead.fullname)}
-          await this.addParameter(this.requestId, "userFullname", lead.fullname);
-        }
-        if (lead && lead.email) {
-          if (this.log) {console.log("lead.email => params.userEmail:", lead.email)}
-          await this.addParameter(this.requestId, "userEmail", lead.email);
-        }
-      }
-      if (this.log) {
-        console.log("replyToMessage() > lead found:", JSON.stringify(lead));
+        // lead = message.request.lead;
+        // if (lead && lead.fullname) {
+        //   if (this.log) {console.log("lead.fullname => params.userFullname:", lead.fullname)}
+        //   await this.addParameter("userFullname", lead.fullname);
+        // }
+        // if (lead && lead.email) {
+        //   if (this.log) {console.log("lead.email => params.userEmail:", lead.email)}
+        //   await this.addParameter("userEmail", lead.email);
+        // }
       }
+      // if (this.log) {
+      //   console.log("replyToMessage() > lead found:", JSON.stringify(lead));
+      // }
       
       // reset lockedIntent on direct user invocation ( /intent or action => this only?)
       if (message.sender != "_tdinternal") {
@@ -88,6 +87,18 @@ class TiledeskChatbot {
         }
       }
 
+      // resetting any noInput timeout setting userInput = true
+      // if (message.sender != "_tdinternal") {
+      //   if (this.log) {console.log("resetting any noInput timeout setting userInput = (false?)", await this.getParameter(TiledeskChatbotConst.USER_INPUT) );}
+      //   try {
+      //     // await this.addParameter(TiledeskChatbotConst.USER_INPUT, true); // set userInput
+      //     await this.deleteParameter(TiledeskChatbotConst.USER_INPUT); // reset userInput
+      //     if (this.log) {console.log("userInput?", await this.getParameter(TiledeskChatbotConst.USER_INPUT) );}
+      //   } catch(error) {
+      //     console.error("Error resetting userInput:", error);
+      //   }
+      // }
+
       // any external invocation restarts the steps counter
       try {
         if (message.sender != "_tdinternal") {
@@ -95,6 +106,7 @@ class TiledeskChatbot {
             console.log("Resetting current step by request message:", message.text);
           }
           await TiledeskChatbot.resetStep(this.tdcache, this.requestId);
+          await TiledeskChatbot.resetStarted(this.tdcache, this.requestId);
           if (this.log) {
             if (this.tdcache) {
               let currentStep = 
@@ -132,17 +144,21 @@ class TiledeskChatbot {
         let reply;
         if (faq) {
           reply = await this.execIntent(faq, message, lead);//, bot);
-          // if (!reply.attributes) {
-          //   reply.attributes = {}
-          // }
-          // // used by the Clients to get some info about the intent that generated this reply
-          // reply.attributes.intent_display_name = faq.intent_display_name;
-          // reply.attributes.intent_id = faq.intent_id;
+          // resolve(reply);
+          // return;
         }
         else {
           reply = {
-            "text": "An error occurred while getting locked intent:'" + locked_intent + "'"
+            "text": "An error occurred while getting locked intent:'" + locked_intent + "'",
+            "attributes": {
+              "subtype": "info"
+            }
           }
+          // because of some race condition, during a mixed ReplyV2 Action button + Replace bot an
+          // intent can be found locked outside of the original chatbot scope.
+          // The temp solution is to immediatly unlock the intent and let the flow continue.
+          await this.unlockIntent(this.requestId);
+          await this.unlockAction(this.requestId);
         }
         resolve(reply);
         return;
@@ -187,9 +203,7 @@ class TiledeskChatbot {
         let reply;
         if (!intent || (intent && !intent.name)) {
           if (this.log) {console.log("Invalid intent:", explicit_intent_name);}
-          reply = {
-            "text": "Invalid intent: *" + explicit_intent_name + "*"
-          }
+          resolve();
         }
         else {
           if (this.log) {console.log("processing intent:", explicit_intent_name);}
@@ -217,21 +231,12 @@ class TiledeskChatbot {
                 }
                 for (const [key, value] of Object.entries(intent.parameters)) {
                   if (this.log) {console.log(`Adding attribute from intent invocation /intentName{} => ${key}: ${value}`);}
-                  // const parameter_typeof_key = "_tdTypeOf:" + key;
-                  // console.log("intent[parameter_typeof_key]",parameter_typeof_key, intent.parameters[parameter_typeof_key]);
-                  // if (intent.parameters[parameter_typeof_key] === "object") {
-                    // const parameter_value_string = JSON.stringify(value)
-                    // console.log("Adding parameter as string:", parameter_value_string)
                     this.addParameter(key, value);
-                    //this.addParameter(parameter_typeof_key, intent[parameter_typeof_key]);
-                  // }
-                  // else { // TODO: support the other data types
-                  //   this.addParameter(key, value);
-                  // }
-                  
                 }
               }
               reply = await this.execIntent(faq, message, lead);
+              resolve(reply);
+              return;
             }
             catch(error) {
               console.error("error");
@@ -240,22 +245,19 @@ class TiledeskChatbot {
           }
           else {
             if (this.log) {console.log("Intent not found:", explicit_intent_name);}
-            reply = {
-              "text": "Intent not found: " + explicit_intent_name
-            }
+            resolve()
           }
         }
-        resolve(reply);
-        return;
       }
 
       // SEARCH INTENTS
       let faqs;
       try {
         faqs = await this.botsDataSource.getByExactMatch(this.botId, message.text);
+        if (this.log) {console.log("got faq by EXACT MATCH", faqs);}
       }
       catch (error) {
-        console.error("An error occurred during exact match:", error);
+        console.error("(TiledeskChatbot) An error occurred during exact match:", JSON.stringify(error));
       }
       if (faqs && faqs.length > 0 && faqs[0].answer) {
         if (this.log) {console.log("EXACT MATCH OR ACTION FAQ:", faqs[0]);}
@@ -370,8 +372,8 @@ class TiledeskChatbot {
     // ON THE MAIN SERVER. OTHERWISE WE USE TYBOT_ROUTE TO SPECIFY
     // THE ALTERNATIVE ROUTE.
     // let extEndpoint = `${this.APIURL}/modules/tilebot/`;
-    // if (process.env.TYBOT_ENDPOINT) {
-    //   extEndpoint = `${process.env.TYBOT_ENDPOINT}`;
+    // if (process.env.TILEBOT_ENDPOINT) {
+    //   extEndpoint = `${process.env.TILEBOT_ENDPOINT}`;
     // }
     // const apiext = new ExtApi({
     //   ENDPOINT: extEndpoint,
@@ -606,8 +608,17 @@ class TiledeskChatbot {
   }
 
   static async addParameterStatic(_tdcache, requestId, parameter_name, parameter_value) {
+    if (parameter_name === null || parameter_name === undefined) {
+      // console.error("Error saving key:", parameter_name, "value:", parameter_value);
+      return;
+    }
     const parameter_key = TiledeskChatbot.requestCacheKey(requestId) + ":parameters";
     const parameter_value_s = JSON.stringify(parameter_value);
+    // console.log("saving key:", parameter_name, "value:", parameter_value);
+    if (parameter_value_s?.length > 20000000) {
+      // console.log("Error. Attribute size too big (> 20mb):", parameter_value_s);
+      return;
+    }
     await _tdcache.hset(parameter_key, parameter_name, parameter_value_s);
   }
 
@@ -661,44 +672,50 @@ class TiledeskChatbot {
       TiledeskChatbot.requestCacheKey(requestId) + ":parameters", paramName);
   }
 
-  static async checkStep(_tdcache, requestId, max_steps, log) {
+  static async checkStep(_tdcache, requestId, max_steps, max_execution_time, log) {
     if (log) {console.log("CHECKING ON MAX_STEPS:", max_steps);}
-    let go_on = true; // continue
+    // let go_on = true; // continue
     const parameter_key = TiledeskChatbot.requestCacheKey(requestId) + ":step";
     if (log) {console.log("__parameter_key:", parameter_key);}
     await _tdcache.incr(parameter_key);
     // console.log("incr-ed");
     let _current_step = await _tdcache.get(parameter_key);
-    // if (!_current_step) { // this shouldn't be happening
-    //   _current_step = 0;
-    // }
     let current_step = Number(_current_step);
-    // current_step += 1;
-    // await _tdcache.set(parameter_key, current_step); // increment step
-    // console.log("CURRENT-STEP:", current_step);
     if (current_step > max_steps) {
       if (log) {console.log("max_steps limit just violated");}
       if (log) {console.log("CURRENT-STEP > MAX_STEPS!", current_step);}
-      // await TiledeskChatbot.resetStep(_tdcache, requestId);
-      // go_on = 1; // stop execution, send error message
-      go_on = false
-    }
-    // else if (current_step > max_steps + 1) { // max_steps limit already violated
-    //   console.log("CURRENT-STEP > MAX_STEPS!", current_step);
-    //   // await TiledeskChatbot.resetStep(_tdcache, requestId);
-    //   go_on = 2; // stop execution, don't send error message (already sent with go_on = 1)
-    // }
-    else {
-      // go_on = 0;
-      go_on = true;
+      // go_on = false
+      return {
+        error: "Anomaly detection. MAX ACTIONS (" + max_steps + ") exeeded."
+      };
     }
     // else {
-      // console.log("CURRENT-STEP UNDER MAX_STEPS THRESHOLD:)", current_step);
-      // current_step += 1;
-      // await _tdcache.set(parameter_key, current_step); // increment step
-      // console.log("current_step from cache:", await _tdcache.get(parameter_key));
+    //   go_on = true;
     // }
-    return go_on;
+
+    // check execution_time
+    // const TOTAL_ALLOWED_EXECUTION_TIME = 1000 * 60 // * 60 * 12 // 12 hours
+    let start_time_key = TiledeskChatbot.requestCacheKey(requestId) + ":started";
+    let start_time = await _tdcache.get(start_time_key);
+    // console.log("cached start_time is:", start_time, typeof start_time);
+    const now = Date.now();
+    if (start_time === null || Number(start_time) === 0) {
+      // console.log("start_time is null");
+      await _tdcache.set(start_time_key, now);
+      return {};
+    }
+    else {
+      // console.log("start_time:", start_time);
+      const execution_time = now - Number(start_time);
+      // console.log("execution_time:", execution_time);
+      if (execution_time > max_execution_time) {
+        if (log) {console.log("execution_time > TOTAL_ALLOWED_EXECUTION_TIME. Stopping flow");}
+        return {
+          error: "Anomaly detection. MAX EXECUTION TIME (" + max_execution_time + " ms) exeeded."
+        };
+      }
+    }
+    return {};
   }
 
   static async resetStep(_tdcache, requestId) {
@@ -709,6 +726,14 @@ class TiledeskChatbot {
     }
   }
 
+  static async resetStarted(_tdcache, requestId) {
+    const parameter_key = TiledeskChatbot.requestCacheKey(requestId) + ":started";
+    // console.log("resetStarted() parameter_key:", parameter_key);
+    if (_tdcache) {
+      await _tdcache.set(parameter_key, 0);
+    }
+  }
+
   static async currentStep(_tdcache, requestId) {
     const parameter_key = TiledeskChatbot.requestCacheKey(requestId) + ":step";
     // console.log("currentStep() parameter_key:", parameter_key);
@@ -777,15 +802,8 @@ class TiledeskChatbot {
         fullname: all_parameters['userFullname'],
         phone: all_parameters['userPhone']
       }
-      // tdclient.updateLeadData(leadId, all_parameters['userEmail'], all_parameters['userFullname'], null, () => {
-        tdclient.updateLead(leadId, nativeAttributes, null, null, () => {
+      tdclient.updateLead(leadId, nativeAttributes, null, null, () => {
         if (this.log) {console.log("Lead updated.")}
-        // tdclient.updateRequestAttributes(requestId, {
-        //   preChatForm: all_parameters,
-        //   updated: Date.now
-        // }, () => {
-        //   if (this.log) {console.log("Prechat updated.");}
-        // });
       });
     };
   }

package/models/TiledeskChatbotConst.js

@@ -4,6 +4,7 @@ class TiledeskChatbotConst {
     static REQ_PROJECT_ID_KEY = "project_id";
     static REQ_REQUEST_ID_KEY = "conversation_id";
     static REQ_CHATBOT_NAME_KEY = "chatbot_name";
+    static REQ_CHATBOT_ID_KEY = "chatbot_id";
     static REQ_LAST_USER_TEXT_KEY = "last_user_text";
     static REQ_LAST_USER_TEXT_v2_KEY = "lastUserText";
     static REQ_LAST_MESSAGE_ID_KEY = "last_message_id";
@@ -22,23 +23,17 @@ class TiledeskChatbotConst {
     static REQ_CHAT_CHANNEL = "chatChannel";
     static REQ_DECODED_JWT_KEY = "decodedCustomJWT";
     static REQ_REQUESTER_IS_AUTHENTICATED_KEY = "strongAuthenticated";
-
-    // static REQ_DEPARTMENT_ID_KEY = "tdDepartmentId";
-    // static REQ_PROJECT_ID_KEY = "projectId";
-    // static REQ_REQUEST_ID_KEY = "tdRequestId";
-    // static REQ_CHATBOT_NAME_KEY = "tdChatbotName";
-    // static REQ_LAST_USER_TEXT_KEY = "tdLastUserText";
-    // static REQ_LAST_MESSAGE_ID_KEY = "tdLastMessageId";
-    // static REQ_COUNTRY_KEY = "tdCountry";
-    // static REQ_CITY_KEY = "tdCity";
-    // static REQ_USER_SOURCE_PAGE_KEY = "tdUserSourcePage";
-    // static REQ_USER_LANGUAGE_KEY = "tdUserLanguage";
-    // static REQ_USER_AGENT_KEY = "tdUserAgent";
-    // static REQ_DEPARTMENT_NAME_KEY = "tdDepartmentName";
-    // static REQ_END_USER_ID_KEY = "tdEndUserId";
-    // static REQ_END_USER_IP_ADDRESS_KEY = "tdEndUserIpAddress";
-    // static REQ_CHAT_URL = "chat_url";
-    
+    static USER_INPUT = "_userInput";
+    static REQ_LEAD_USERFULLNAME_KEY = "userFullname";
+    static REQ_LEAD_EMAIL_KEY = "userEmail";
+    static REQ_USER_PHONE_KEY = "userPhone";
+    static REQ_CURRENT_PHONE_NUMBER_KEY = "currentPhoneNumber";
+    static REQ_USER_LEAD_ID_KEY = "userLeadId";
+    static REQ_USER_COMPANY_KEY = "userCompany";
+    static REQ_TICKET_ID_KEY = "ticketId";
+    static REQ_CHATBOT_TOKEN = "chatbotToken";
+    static REQ_CHATBOT_TOKEN_v2 = "chatbot_jwt_token";
+    static API_BASE_URL = "api_base_url";
 }
 
 module.exports = { TiledeskChatbotConst };