@tiledesk/tiledesk-tybot-connector 0.2.97 → 0.2.99

package/CHANGELOG.md

@@ -17,6 +17,14 @@ available on:
 - Added flowError on JSONCondition when result = null
 - Added fix on Filler -->
 
+# v0.2.99
+- Added "chatbotToken" to RESERVED attributes
+
+# 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

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/TiledeskChatbotUtil.js

@@ -901,7 +901,8 @@ class TiledeskChatbotUtil {
             "userLeadId",
             "lastUserText",
             TiledeskChatbotConst.REQ_REQUESTER_IS_AUTHENTICATED_KEY,
-            TiledeskChatbotConst.USER_INPUT
+            TiledeskChatbotConst.USER_INPUT,
+            TiledeskChatbotConst.REQ_CHATBOT_TOKEN
           ]
           let userParams = {};
           if (flowAttributes) {

package/package.json

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

package/tiledeskChatbotPlugs/DirectivesChatbotPlug.js

@@ -171,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;

package/tiledeskChatbotPlugs/directives/DirWait.js

@@ -9,6 +9,7 @@ class DirWait {
     }
     this.context = context;
     this.tdclient = context.tdclient;
+    this.chatbot = context.chatbot;
     this.tdcache = context.tdcache;
     this.requestId = context.requestId;
     this.log = context.log;
@@ -49,9 +50,15 @@ class DirWait {
   }
 
   async go(action, callback) {
-    // reset step
-    const step_key = TiledeskChatbot.requestCacheKey(this.requestId) + ":step";
-    await this.chatbot.addParameter( step_key, 0 );
+    // 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(() => {
       callback();
     }, action.millis);