@tiledesk/tiledesk-tybot-connector 0.2.96 → 0.2.98

package/CHANGELOG.md

@@ -17,6 +17,17 @@ available on:
 - Added flowError on JSONCondition when result = null
 - Added fix on Filler -->
 
+# v0.2.98
+- Support for MAX_EXECUTION_TIME (total execution time of a flow without user interaction)
+- MAX_STEPS = 1000
+- MAX_EXECUTION_TIME = 12 hrs
+
+# v0.2.97
+- Added support for "chatbotToken” attribute
+- Added new Action: clear_transcript
+- Exclude transcript generation when request type differs from "support-group-*"
+- "step" key reset on DirWait => this.chatbot.addParameter( step_key, 0 )
+
 # v0.2.96
 - Added timestamp (number) and now (Date Object) attributes
 

package/index.js

@@ -171,8 +171,10 @@ router.post('/ext/:botid', async (req, res) => {
   //   if (log) {console.log("forced conversion of \\\\start /start");}
   //   message.text = "/start";
   // }
-  await TiledeskChatbotUtil.updateRequestAttributes(chatbot, message, projectId, requestId);
-  await TiledeskChatbotUtil.updateConversationTranscript(chatbot, message);
+  await TiledeskChatbotUtil.updateRequestAttributes(chatbot, token, message, projectId, requestId);
+  if (requestId.startsWith("support-group-")) {
+    await TiledeskChatbotUtil.updateConversationTranscript(chatbot, message);
+  }
 
   let reply = null;
   try {

package/models/TiledeskChatbot.js

@@ -13,7 +13,8 @@ const { TiledeskChatbotConst } = require('./TiledeskChatbotConst.js');
 
 class TiledeskChatbot {
 
-  static MAX_STEPS = 200;
+  static MAX_STEPS = 1000;
+  static MAX_EXECUTION_TIME = 1000 * 60 * 60 * 12 // 12 hours = 43.200 secs;
 
   constructor(config) {
     if (!config.botsDataSource) {
@@ -104,6 +105,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 = 
@@ -671,44 +673,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) {
@@ -719,6 +727,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);

package/models/TiledeskChatbotConst.js

@@ -30,6 +30,7 @@ class TiledeskChatbotConst {
     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_DEPARTMENT_ID_KEY = "tdDepartmentId";

package/models/TiledeskChatbotUtil.js

@@ -442,6 +442,13 @@ class TiledeskChatbotUtil {
         }
     }
 
+    static async clearConversationTranscript(chatbot, callback) {
+        await chatbot.addParameter("transcript", "");
+        if (callback) {
+            callback();
+        }
+    }
+
     static transcriptJSON(transcript) {
         const regexp = /(<.*>)/gm;
         const parts = transcript.split(regexp);
@@ -506,7 +513,7 @@ class TiledeskChatbotUtil {
         return message;
     }
 
-    static async updateRequestAttributes(chatbot, message, projectId, requestId) {
+    static async updateRequestAttributes(chatbot, chatbotToken, message, projectId, requestId) {
         // update request context
         try {
             if (chatbot.log) {console.log("Updating request variables. Message:", JSON.stringify(message));}
@@ -519,7 +526,10 @@ class TiledeskChatbotUtil {
             // TODO add projectName too
             await chatbot.addParameter(TiledeskChatbotConst.REQ_REQUEST_ID_KEY, requestId);
             if (chatbot.bot) {
-            await chatbot.addParameter(TiledeskChatbotConst.REQ_CHATBOT_NAME_KEY, chatbot.bot.name);
+                await chatbot.addParameter(TiledeskChatbotConst.REQ_CHATBOT_NAME_KEY, chatbot.bot.name);
+            }
+            if (chatbotToken) {
+                await chatbot.addParameter(TiledeskChatbotConst.REQ_CHATBOT_TOKEN, chatbotToken);
             }
             
             if (message.text && message.sender !== "_tdinternal") {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tiledesk/tiledesk-tybot-connector",
-  "version": "0.2.96",
+  "version": "0.2.98",
   "description": "Tiledesk Tybot connector",
   "main": "index.js",
   "scripts": {

package/tiledeskChatbotPlugs/DirectivesChatbotPlug.js

@@ -50,6 +50,7 @@ const { DirAssistant } = require('./directives/DirAssistant');
 const { DirReplyV2 } = require('./directives/DirReplyV2');
 const { DirIfOnlineAgentsV2 } = require('./directives/DirIfOnlineAgentsV2');
 const { DirContactUpdate } = require('./directives/DirContactUpdate');
+const { DirClearTranscript } = require('./directives/DirClearTranscript');
 
 class DirectivesChatbotPlug {
 
@@ -170,13 +171,13 @@ class DirectivesChatbotPlug {
   async nextDirective(directives) {
     if (this.log) {console.log("....nextDirective() checkStep():");}
     const go_on = await TiledeskChatbot.checkStep(
-      this.context.tdcache, this.context.requestId, TiledeskChatbot.MAX_STEPS, this.log
+      this.context.tdcache, this.context.requestId, TiledeskChatbot.MAX_STEPS,  TiledeskChatbot.MAX_EXECUTION_TIME, this.log
     );
     // const current_step = await TiledeskChatbot.currentStep(this.context.tdcache, this.context.requestId);
     // if (this.log) {console.log("........nextDirective() currentStep:", current_step);}
-    if (go_on == false) {
+    if (go_on.error) {
       if (this.log) {console.log("go_on == false! nextDirective() Stopped!");}
-      return this.errorMessage("Request error: anomaly detection. MAX ACTIONS exeeded.");
+      return this.errorMessage(go_on.error); //"Request error: anomaly detection. MAX ACTIONS exeeded.");
     }
     // else if (go_on == 2) {
     //   return null;
@@ -684,12 +685,19 @@ class DirectivesChatbotPlug {
       });
     }
     else if (directive_name === Directives.CONTACT_UPDATE) {
-      console.log("...CONTACT_UPDATE");
+      // console.log("...CONTACT_UPDATE");
       new DirContactUpdate(context).execute(directive, async () => {
         let next_dir = await this.nextDirective(this.directives);
         this.process(next_dir);
       });
     }
+    else if (directive_name === Directives.CLEAR_TRANSCRIPT) {
+      console.log("...CLEAR_TRANSCRIPT");
+      new DirClearTranscript(context).execute(directive, async () => {
+        let next_dir = await this.nextDirective(this.directives);
+        this.process(next_dir);
+      });
+    }
     else {
       //console.log("Unhandled Post-message Directive:", directive_name);
       let next_dir = await this.nextDirective(this.directives);

package/tiledeskChatbotPlugs/directives/DirClearTranscript.js

@@ -0,0 +1,23 @@
+
+const { TiledeskChatbotUtil } = require('../../models/TiledeskChatbotUtil');
+
+class DirClearTranscript {
+
+    constructor(context) {
+        if (!context) {
+            throw new Error('context object is mandatory.');
+        }
+        this.context = context;
+        this.tdclient = context.tdclient;
+        this.requestId = context.requestId;
+    }
+    
+    execute(directive, callback) {
+        TiledeskChatbotUtil.clearConversationTranscript(this.context.chatbot, () => {
+            callback();
+        });
+    }
+
+  }
+  
+  module.exports = { DirClearTranscript };

package/tiledeskChatbotPlugs/directives/DirWait.js

@@ -1,7 +1,18 @@
 
+const { TiledeskChatbot } = require('../../models/TiledeskChatbot');
+
 class DirWait {
 
-  constructor() {
+  constructor(context) {
+    if (!context) {
+      throw new Error('context object is mandatory.');
+    }
+    this.context = context;
+    this.tdclient = context.tdclient;
+    this.chatbot = context.chatbot;
+    this.tdcache = context.tdcache;
+    this.requestId = context.requestId;
+    this.log = context.log;
   }
 
   execute(directive, callback) {
@@ -38,10 +49,17 @@ class DirWait {
     })
   }
 
-  go(action, callback) {
-    // console.log(">>>>__", callback)
+  async go(action, callback) {
+    // reset step?
+    // const step_key = TiledeskChatbot.requestCacheKey(this.requestId) + ":step";
+    // console.log("step_key:", step_key);
+    if (action && action.millis >= 1000) {//2000 * 60) { // at list 2 minutes waiting time to reset the steps counter
+      // await this.tdcache.set(step_key, 0);
+      console.log("resetting steps counter");
+      await TiledeskChatbot.resetStep(this.tdcache, this.requestId);
+      // console.log("step_key after:", await this.tdcache.get( step_key ));
+    }
     setTimeout(() => {
-      // console.log("QUINO....__")
       callback();
     }, action.millis);
   }

package/tiledeskChatbotPlugs/directives/Directives.js

@@ -50,6 +50,7 @@ class Directives {
   static REPLY_V2 = 'replyv2';
   static IF_ONLINE_AGENTS_V2 = "ifonlineagentsv2";
   static CONTACT_UPDATE = "leadupdate";
+  static CLEAR_TRANSCRIPT = "clear_transcript";
 
   // 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