@tiledesk/tiledesk-tybot-connector 2.0.10-rc11 → 2.0.10-rc12

package/tiledeskChatbotPlugs/directives/DirCondition.js

@@ -3,6 +3,7 @@ const { TiledeskChatbot } = require('../../engine/TiledeskChatbot');
 const { TiledeskExpression } = require('../../TiledeskExpression');
 const ms = require('minimist-string');
 const winston = require('../../utils/winston');
+const { Logger } = require('../../Logger');
 
 class DirCondition {
 
@@ -11,10 +12,13 @@ class DirCondition {
       throw new Error('context object is mandatory.');
     }
     this.context = context;
+    this.requestId = this.context.requestId;
     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("[Condition] Executing action");
     winston.verbose("Execute Condition directive");
     let action;
     if (directive.action) {
@@ -34,11 +38,13 @@ class DirCondition {
       }
     }
     else {
+      this.logger.error("Incorrect action for ", directive.name, directive)
       winston.warn("DirCondition Incorrect directive: ", directive);
       callback();
       return;
     }
     this.go(action, (stop) => {
+      this.logger.info("[Condition] Action completed");
       callback(stop);
     });
     
@@ -63,21 +69,25 @@ class DirCondition {
     }
     winston.debug("(DirCondition) condition action: ", action);
     if (!trueIntent && !falseIntent) {
+      this.logger.error("[Condition] Invalid condition, no intents specified");
       winston.error("(DirCondition) Invalid condition, no intents specified");
       callback();
       return;
     }
     if (scriptCondition === null && jsonCondition === null) {
+      this.logger.error("[Condition] Invalid condition, scriptCondition & jsonCondition null");
       winston.error("(DirCondition) Invalid condition, scriptCondition & jsonCondition null");
       callback();
       return;
     }
     if (scriptCondition !== null && scriptCondition.trim === "") {
+      this.logger.error("[Condition] Invalid condition, scriptCondition is empty");
       winston.error("(DirCondition) Invalid condition, scriptCondition is empty");
       callback();
       return;
     }
     else if (jsonCondition && jsonCondition.groups === null) {
+      this.logger.error("[Condition] Invalid jsonCondition, no groups");
       winston.error("(DirCondition) Invalid jsonCondition, no groups:", jsonCondition);
       callback();
       return;
@@ -120,6 +130,7 @@ class DirCondition {
         });
       }
       else {
+        this.logger.debug("[Condition] No trueIntentDirective specified");
         winston.debug("(DirCondition) No trueIntentDirective specified");
         callback();
         return;
@@ -132,6 +143,7 @@ class DirCondition {
         });
       }
       else {
+        this.logger.debug("[Condition] No falseIntentDirective specified");
         winston.debug("(DirCondition) No falseIntentDirective specified");
         callback();
         return;

package/tiledeskChatbotPlugs/directives/DirContactUpdate.js

@@ -5,6 +5,7 @@ let axios = require('axios');
 const { TiledeskChatbotConst } = require('../../engine/TiledeskChatbotConst');
 const { TiledeskClient } = require('@tiledesk/tiledesk-client');
 const winston = require('../../utils/winston');
+const { Logger } = require('../../Logger');
 
 class DirContactUpdate {
 
@@ -19,6 +20,7 @@ class DirContactUpdate {
     this.token = context.token;
     this.tdcache = context.tdcache;
     this.API_ENDPOINT = context.API_ENDPOINT;
+    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,
@@ -29,6 +31,7 @@ class DirContactUpdate {
   }
 
   execute(directive, callback) {
+    this.logger.info("[Lead Update] Executing action");
     winston.verbose("Execute ContactUpdate directive")
     let action;
     if (directive.action) {
@@ -39,11 +42,13 @@ class DirContactUpdate {
       action.attributes.fillParams = true;
     }
     else {
+      this.logger.error("Incorrect action for ", directive.name, directive)
       winston.warn("DirContactUpdate Incorrect directive: ", directive);
       callback();
       return;
     }
     this.go(action, () => {
+      this.logger.info("[Lead Update] Action completed");
       callback();
     });
   }

package/tiledeskChatbotPlugs/directives/DirCustomerio.js

@@ -6,6 +6,7 @@ let https = require("https");
 require('dotenv').config();
 const winston = require('../../utils/winston');
 const integrationService = require("../../services/IntegrationService");
+const { Logger } = require("../../Logger");
 
 class DirCustomerio {
 
@@ -20,20 +21,24 @@ class DirCustomerio {
     this.token = this.context.token;
     this.intentDir = new DirIntent(context);
     this.API_ENDPOINT = this.context.API_ENDPOINT;
+    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("[Customer.io] Executing action");
     winston.verbose("Execute Customerio directive");
     let action;
     if (directive.action) {
       action = directive.action;
     }
     else {
+      this.logger.error("Incorrect action for ", directive.name, directive)
       winston.warn("DirCustomerio Incorrect directive: ", directive);
       callback();
       return;
     }
     this.go(action, (stop) => {
+      this.logger.info("[Customer.io] Action completed");
       callback(stop);
     })
   }
@@ -65,6 +70,7 @@ class DirCustomerio {
     winston.debug("(DirCustomerio) bodyParameters: ", bodyParameters);
 
     if (!bodyParameters || bodyParameters === '') {
+      this.logger.error("[Customer.io] bodyParameters is undefined or null or empty string");
       winston.debug("(DirCustomerio) Error: bodyParameters is undefined or null or empty string");
       callback();
       return;
@@ -75,6 +81,7 @@ class DirCustomerio {
 
     let key = await integrationService.getKeyFromIntegrations(this.projectId, 'customerio', this.token);
     if (!key) {
+      this.logger.error("[Customer.io] Key not found in Integrations");
       winston.debug("(DirCustomerio) - Key not found in Integrations.");
       let status = 422;
       let error = 'Missing customerio access token';
@@ -116,6 +123,7 @@ class DirCustomerio {
       CUSTOMERIO_HTTPREQUEST, async (err, resbody) => {
         if (err) {
           if (callback) {
+            this.logger.error("[Customer.io] Error response: ", err.response);
             winston.debug("(DirCustomerio) err response:", err.response)
             winston.debug("(DirCustomerio) err data:", err.response.data)
 
@@ -150,6 +158,7 @@ class DirCustomerio {
 
           let status = 204;
           let error = null;
+          this.logger.error("[Customer.io] Response status: ", status);
           await this.#assignAttributes(action, status, error);
           if (trueIntent) {
             await this.#executeCondition(true, trueIntent, null, falseIntent, null);

package/tiledeskChatbotPlugs/directives/DirDeleteVariable.js

@@ -3,6 +3,7 @@ const ms = require('minimist-string');
 const { TiledeskChatbot } = require('../../engine/TiledeskChatbot');
 const { Filler } = require('../Filler');
 const winston = require('../../utils/winston');
+const { Logger } = require('../../Logger');
 
 class DirDeleteVariable {
 
@@ -11,9 +12,12 @@ class DirDeleteVariable {
       throw new Error('context object is mandatory.');
     }
     this.context = context;
+    this.requestId = this.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 });
   }
 
   async execute(directive, callback) {
+    this.logger.info("[Delete Attribute] Executing action");
     winston.verbose("Execute DeleteVariable directive");
     let action;
     if (directive.action) {
@@ -24,7 +28,14 @@ class DirDeleteVariable {
         variableName: directive.parameter
       }
     }
+    else {
+      this.logger.error("Incorrect action for ", directive.name, directive)
+      winston.warn("(DirDeleteVariable) Incorrect directive: ", directive);
+      callback();
+      return;
+    }
     this.go(action, () => {
+      this.logger.info("[Delete Attribute] Action completed");
       callback();
     });
   }
@@ -34,6 +45,7 @@ class DirDeleteVariable {
 
     let variableName = action.variableName;
     if (!variableName) {
+      this.logger.warn("[Delete Attribute] Missing 'variableName'. Skip")
       winston.error("(DirDeleteVariable) deleting variable. Missing 'variableName' error. Skipping");
       if (callback) {
         callback();
@@ -59,6 +71,7 @@ class DirDeleteVariable {
         }
       }
       catch(err) {
+        this.logger.error("[Delete Attribute] Error deleting attribute");
         winston.error("(DirDeleteVariable)  error: ", err);
         if (completion) {
           completion();

package/tiledeskChatbotPlugs/directives/DirDepartment.js

@@ -1,5 +1,6 @@
 const { TiledeskClient } = require("@tiledesk/tiledesk-client");
 const winston = require('../../utils/winston');
+const { Logger } = require("../../Logger");
 
 class DirDepartment {
 
@@ -10,6 +11,8 @@ class DirDepartment {
     this.context = context;
     this.requestId = 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 });
 
     this.tdClient = new TiledeskClient({
       projectId: this.context.projectId,
@@ -20,6 +23,7 @@ class DirDepartment {
   }
 
   execute(directive, callback) {
+    this.logger.info("[Change Department] Executing action");
     winston.verbose("Execute Department directive");
     let action;
     if (directive.action) {
@@ -35,6 +39,7 @@ class DirDepartment {
       }
     }
     this.go(action, () => {
+      this.logger.info("[Change Department] Action executed");
       callback();
     });
     
@@ -64,6 +69,7 @@ class DirDepartment {
     const depName = action.depName;
     this.moveToDepartment(this.requestId, depName, (deps) => {
       if (!deps) {
+        this.logger.warn("[Change Department] Department not found");
         winston.warn("(DirDepartment) Dep not found");
         callback();
         return
@@ -92,14 +98,19 @@ class DirDepartment {
             this.requestId,
             message, (err) => {
               if (err) {
+                this.logger.error("[Change Department] Unable to trigger bot");
                 winston.error("(DirDepartment) Error sending hidden message: " + err.message)
+              } else {
+                this.logger.verbose("[Change Department] Bot triggered");
+                winston.debug("(DirDepartment) Hidden message sent.");
+
               }
-              winston.debug("(DirDepartment) Hidden message sent.");
               callback();
           });
         }
       }
       else {
+        this.logger.verbose("[Change Department] No triggering bot");
         winston.debug("(DirDepartment) No action.triggerBot");
         callback();
       }

package/tiledeskChatbotPlugs/directives/DirForm.js

@@ -16,6 +16,7 @@ class DirForm {
     this.requestId = context.requestId;
     this.intentDir = new DirIntent(context);
 
+    console.log("\n\n\nDIR FORMmmm")
     this.API_ENDPOINT = context.API_ENDPOINT;
     this.tdClient = new TiledeskClient({
       projectId: this.context.projectId,

package/tiledeskChatbotPlugs/directives/DirGptTask.js

@@ -9,6 +9,7 @@ require('dotenv').config();
 const winston = require('../../utils/winston');
 const httpUtils = require("../../utils/HttpUtils");
 const integrationService = require("../../services/IntegrationService");
+const { Logger } = require("../../Logger");
 
 class DirGptTask {
 
@@ -24,20 +25,24 @@ class DirGptTask {
     this.token = this.context.token;
     this.intentDir = new DirIntent(context);
     this.API_ENDPOINT = this.context.API_ENDPOINT;
+    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("[ChatGPT Task] Executing action");
     winston.verbose("Execute GptTask directive");
     let action;
     if (directive.action) {
       action = directive.action;
     }
     else {
+      this.logger.error("Incorrect action for ", directive.name, directive)
       winston.warn("DirGptTask Incorrect directive: ", directive);
       callback();
       return;
     }
     this.go(action, (stop) => {
+      this.logger.info("[ChatGPT Task] Action completed");
       callback(stop);
     })
   }
@@ -67,6 +72,7 @@ class DirGptTask {
     let model = "gpt-3.5-turbo";
 
     if (!action.question || action.question === '') {
+      this.logger.warn("[ChatGPT Task] question attribute is mandatory");
       winston.debug("(DirGptTask) Error: question attribute is mandatory. Executing condition false...")
       if (falseIntent) {
         await this.chatbot.addParameter("flowError", "GPT Error: question attribute is undefined");
@@ -103,13 +109,13 @@ class DirGptTask {
         this.context.tdcache,
         this.context.requestId,
         TiledeskChatbotConst.REQ_TRANSCRIPT_KEY);
-        winston.debug("(DirGptTask)  transcript string: " + transcript_string)
+        winston.debug("(DirGptTask) transcript string: " + transcript_string)
 
       if (transcript_string) {
         transcript = await TiledeskChatbotUtil.transcriptJSON(transcript_string);
-        winston.debug("(DirGptTask)  transcript: ", transcript)
+        winston.debug("(DirGptTask) transcript: ", transcript)
       } else {
-        winston.debug("(DirGptTask)  transcript_string is undefined. Skip JSON translation for chat history");
+        winston.debug("(DirGptTask) transcript_string is undefined. Skip JSON translation for chat history");
       }
     }
 
@@ -118,17 +124,20 @@ class DirGptTask {
 
     let key = await integrationService.getKeyFromIntegrations(this.projectId, 'openai', this.token);
     if (!key) {
+      this.logger.debug("[ChatGPT Task] Key not found in Integrations.");
       winston.debug("(DirGptTask) - Key not found in Integrations. Searching in kb settings...");
       key = await this.getKeyFromKbSettings();
     }
 
     if (!key) {
-      winston.debug("(DirGptTask)  - Retrieve public gptkey")
+      this.logger.debug("[ChatGPT Task] Retrieve shared gptkey.");
+      winston.debug("(DirGptTask) - Retrieve public gptkey")
       key = process.env.GPTKEY;
       publicKey = true;
     }
 
     if (!key) {
+      this.logger.error("[ChatGPT Task] OpenAI key is mandatory");
       winston.error("(DirGptTask) gptkey is mandatory");
       await this.#assignAttributes(action, answer);
       if (falseIntent) {
@@ -144,7 +153,7 @@ class DirGptTask {
     if (publicKey === true) {
       let keep_going = await this.checkQuoteAvailability();
       if (keep_going === false) {
-
+        this.logger.warn("[ChatGPT Task] OpenAI tokens quota exceeded");
         await this.chatbot.addParameter("flowError", "GPT Error: tokens quota exceeded");
         await this.#executeCondition(false, trueIntent, trueIntentAttributes, falseIntent, falseIntentAttributes);
         callback();
@@ -201,6 +210,7 @@ class DirGptTask {
         if (err) {
           winston.debug("(DirGptTask) openai err: ", err);
           winston.debug("(DirGptTask) openai err: " + err.response?.data?.error?.message);
+          this.logger.error("[ChatGPT Task] Completions error: ", err.response?.data?.error?.message);
           await this.#assignAttributes(action, answer);
           if (falseIntent) {
             await this.chatbot.addParameter("flowError", "GPT Error: " + err.response?.data?.error?.message);
@@ -218,6 +228,8 @@ class DirGptTask {
             answer = await this.convertToJson(answer);
           }
         
+          this.logger.debug("[ChatGPT Task] Completions answer: ", answer);
+          
           await this.#assignAttributes(action, answer);
 
           if (publicKey === true) {

package/tiledeskChatbotPlugs/directives/DirHubspot.js

@@ -6,6 +6,7 @@ let https = require("https");
 require('dotenv').config();
 const winston = require('../../utils/winston');
 const integrationService = require("../../services/IntegrationService");
+const { Logger } = require("../../Logger");
 
 class DirHubspot {
 
@@ -20,20 +21,24 @@ class DirHubspot {
     this.token = this.context.token;
     this.intentDir = new DirIntent(context);
     this.API_ENDPOINT = this.context.API_ENDPOINT;
+    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("[Hubspot] Executing action");
     winston.verbose("Execute Hubspot directive");
     let action;
     if (directive.action) {
       action = directive.action;
     }
     else {
+      this.logger.error("Incorrect action for ", directive.name, directive)
       winston.warn("DirHubspot Incorrect directive: ", directive);
       callback();
       return;
     }
     this.go(action, (stop) => {
+      this.logger.info("[Hubspot] Action completed");
       callback(stop);
     })
   }
@@ -67,6 +72,7 @@ class DirHubspot {
     winston.debug("(DirHubspot) bodyParameters: ", bodyParameters);
 
     if (!bodyParameters || bodyParameters === '') {
+      this.logger.error("[Hubspot] bodyParameters is undefined or null or empty string");
       winston.error("(DirHubspot) Error: bodyParameters is undefined or null or empty string");
       callback();
       return;
@@ -77,7 +83,8 @@ class DirHubspot {
 
     let key = await integrationService.getKeyFromIntegrations(this.projectId, 'hubspot', this.token);
     if (!key) {
-      winston.debug("(DirHubspot)  - Key not found in Integrations.");
+      this.logger.error("[Hubspot] Key not found in Integrations");
+      winston.debug("(DirHubspot) - Key not found in Integrations.");
       if (falseIntent) {
         await this.#executeCondition(false, trueIntent, trueIntentAttributes, falseIntent, falseIntentAttributes);
         callback(true);
@@ -112,6 +119,7 @@ class DirHubspot {
       HUBSPOT_HTTPREQUEST, async (err, resbody) => {
         if (err) {
           if (callback) {
+            this.logger.error("[Hubspot] Error response: ", err.response);
             winston.error("(DirHubspot)  err response: ", err.response.data)
             let result = null;
             let status = null;
@@ -147,6 +155,7 @@ class DirHubspot {
           let status = 201;
           let error = null;
           let result = resbody;
+          this.logger.error("[Hubspot] Result: ", result);
           await this.#assignAttributes(action, status, result, error);
           if (trueIntent) {
             await this.#executeCondition(true, trueIntent, trueIntentAttributes, falseIntent, falseIntentAttributes)

package/tiledeskChatbotPlugs/directives/DirIfOnlineAgentsV2.js

@@ -5,6 +5,7 @@ const { TiledeskChatbot } = require('../../engine/TiledeskChatbot');
 const { TiledeskClient } = require('@tiledesk/tiledesk-client');
 const winston = require('../../utils/winston');
 const httpUtils = require('../../utils/HttpUtils');
+const { Logger } = require('../../Logger');
 
 class DirIfOnlineAgentsV2 {
 
@@ -14,30 +15,35 @@ class DirIfOnlineAgentsV2 {
     }
     this.context = context;
     this.chatbot = context.chatbot;
+    this.requestId = this.context.requestId;
     this.intentDir = new DirIntent(context);
     this.API_ENDPOINT = context.API_ENDPOINT;
+    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: "___",
+      APIKEY: "___"
     });
 
   }
 
   execute(directive, callback) {
+    this.logger.info("[If Online Agents] Executing action");
     winston.verbose("Execute IfOnlineAgentsV2 directive");
     let action;
     if (directive.action) {
       action = directive.action
     }
     else {
+      this.logger.error("Incorrect action for ", directive.name, directive)
       winston.warn("DirIfOnlineAgentsV2 Incorrect directive: ", directive);
       callback();
       return;
     }
     this.go(action, (stop) => {
+      this.logger.info("[If Online Agents] Action completed");
       callback(stop);
     });
   }
@@ -46,6 +52,7 @@ class DirIfOnlineAgentsV2 {
     winston.debug("(DirIfOnlineAgentsV2) Action: ", action);
 
     if (!action.trueIntent && !action.falseIntent) {
+      this.logger.error("[If Online Agents] missing both action.trueIntent & action.falseIntent");
       winston.error("(DirIfOnlineAgentsV2) Error: missing both action.trueIntent & action.falseIntent");
       callback();
       return;
@@ -90,6 +97,7 @@ class DirIfOnlineAgentsV2 {
           if (departmentId) {
             agents = await this.getProjectAvailableAgents(departmentId, true);
           } else {
+            this.logger.error("[If Online Agents] No departmentId found in attributes");
             winston.error("(DirIfOnlineAgentsV2) no departmentId found in attributes");
             await this.chatbot.addParameter("flowError", "(If online Agents) No departmentId found in attributes.");
             if (falseIntent) { // no agents available
@@ -153,6 +161,7 @@ class DirIfOnlineAgentsV2 {
       }
     }
     catch(err) {
+      this.logger.error("[If Online Agents] An error occurred: ", err);
       winston.error("(DirIfOnlineAgentsV2) An error occurred: ", err);
       this.chatbot.addParameter("flowError", "(If online Agents) An error occurred: " + err);
       callback();

package/tiledeskChatbotPlugs/directives/DirIfOpenHours.js

@@ -4,6 +4,7 @@ let https = require("https");
 const ms = require('minimist-string');
 const winston = require('../../utils/winston');
 const httpUtils = require('../../utils/HttpUtils');
+const { Logger } = require('../../Logger');
 
 class DirIfOpenHours {
 
@@ -13,11 +14,14 @@ class DirIfOpenHours {
     }
 
     this.context = context;
+    this.requestId = this.context.requestId;
     this.API_ENDPOINT = context.API_ENDPOINT;
     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("[If Operating Hours] Executing action");
     winston.verbose("Execute IfOpenHours directive");
     let action;
     if (directive.action) {
@@ -37,11 +41,13 @@ class DirIfOpenHours {
       }
     }
     else {
+      this.logger.error("Incorrect action for ", directive.name, directive)
       winston.warn("DirIfOpenHours Incorrect directive: ", directive);
       callback();
       return;
     }
     this.go(action, (stop) => {
+      this.logger.info("[If Operating Hours] Action complteted");
       callback(stop);
     });
   }
@@ -63,6 +69,7 @@ class DirIfOpenHours {
     }
 
     if (!trueIntent && !falseIntent) {
+      this.logger.error("[If Operating Hours] Invalid condition, no intents specified");
       winston.error("(DirIfOpenHours) Invalid condition, no intents specified");
       callback();
       return;
@@ -94,6 +101,7 @@ class DirIfOpenHours {
         winston.debug("(DirIfOpenHours) resbody:", resbody);
         
         if (err) {
+          this.logger.error("[If Operating Hours] Error response: ", err.response);
           winston.debug("(DirIfOpenHours) error: ", err);
           if (callback) {
             if (falseIntent) {
@@ -106,6 +114,7 @@ class DirIfOpenHours {
           }
         } else {
           if (resbody.isopen && resbody.isopen === true) {
+            this.logger.debug("[If Operating Hours] is open: true")
             if (trueIntent) {
               let intentDirective = DirIntent.intentDirectiveFor(trueIntent);
               winston.debug("(DirIfOpenHours) agents (openHours) => trueIntent");
@@ -116,6 +125,7 @@ class DirIfOpenHours {
             callback();
             return;
           } else {
+            this.logger.debug("[If Operating Hours] is open: false")
             if (falseIntent) {
               let intentDirective = DirIntent.intentDirectiveFor(falseIntent);
               winston.debug("(DirIfOpenHours) !agents (openHours) => falseIntent", falseIntent);