@tiledesk/tiledesk-tybot-connector 0.5.0 → 2.0.0

package/tiledeskChatbotPlugs/FillParamsChatbotPlug.js

@@ -1,6 +1,7 @@
 const { TiledeskChatbotUtil } = require('@tiledesk/tiledesk-chatbot-util');
-const { TiledeskChatbot } = require('../models/TiledeskChatbot.js');
+const { TiledeskChatbot } = require('../engine/TiledeskChatbot.js');
 const { Filler } = require('./Filler');
+const winston = require('../utils/winston.js');
 
 class FillParamsChatbotPlug {
 
@@ -20,17 +21,16 @@ class FillParamsChatbotPlug {
     let message = pipeline.message;
     if (message) {
       if (message.attributes && (message.attributes.fillParams == undefined || message.attributes.fillParams == false)) { // defaults to disabled
-        if (this.log) {console.log("fillParams disabled.");}
+        winston.verbose("(FillParamsChatbotPlug) fillParams disabled.");
         pipeline.nextplug();
         return;
       }
-      if (this.log) {
-        console.log("fillParams: true");
-      }
+      
+      winston.verbose("(FillParamsChatbotPlug) fillParams: true");
       const requestId = this.request.request_id;
-      if (this.log) {console.log("all_parameters of requestId:", requestId)}
+      winston.debug("(FillParamsChatbotPlug) all_parameters of requestId: " + requestId)
       const all_parameters = await TiledeskChatbot.allParametersStatic(this.tdcache, requestId);
-      if (this.log) {console.log("--got parameters", JSON.stringify(all_parameters));}
+      winston.debug("(FillParamsChatbotPlug) Got parameters: " + all_parameters);
       if (!all_parameters) {
         pipeline.nextplug();
         return;
@@ -40,7 +40,6 @@ class FillParamsChatbotPlug {
       const filled_message_text = filler.fill(message.text, all_parameters);
       // const filled_message_text = this.fillWithRequestParams(message.text, all_parameters);
       message.text = filled_message_text;
-      //console.log("message filled_message_text:", message)
       if (!message.attributes) {
         message.attributes = {}
       }
@@ -54,7 +53,6 @@ class FillParamsChatbotPlug {
   
       if (message.attributes && message.attributes.commands) {
         let commands = message.attributes.commands;
-        // if (this.log) {console.log("commands for fillMessage:", JSON.stringify(commands));}
         if (commands.length > 1) {
           for (let i = 0; i < commands.length; i++) {
             if (commands[i].type === 'message' && commands[i].message && commands[i].message.text) {
@@ -68,26 +66,22 @@ class FillParamsChatbotPlug {
       pipeline.nextplug();
     }
     else {
-      if (this.log) {console.log("Fillparams. No message.");}
+      winston.debug("(FillParamsChatbotPlug) Fillparams. No message.");
       pipeline.nextplug();
     }
     
   }
 
   // fillWithRequestParams(message_text, all_parameters) {
-  //   if (this.log) {console.log("collected parameters:", JSON.stringify(all_parameters));}
   //   if (!message_text) {
-  //     if (this.log) {console.log("fillWithRequestParams() Can't fill. message_text is null");}
   //     return;
   //   }
   //   if (all_parameters) {
   //     for (const [key, value] of Object.entries(all_parameters)) {
   //       // const value = all_parameters[key];
   //       const value_type = typeof value;
-  //       if (this.log) {console.log("checking parameter:", key, "value:", value, "type:", value_type)}
   //       message_text = message_text.replace(new RegExp("(\\$\\{" + key + "\\})", 'i'), value);
   //     }
-  //     if (this.log) {console.log("final:", message_text);}
   //   }
   //   return message_text;
   // }

package/tiledeskChatbotPlugs/Filler.js

@@ -17,7 +17,6 @@ class Filler {
 
     // legacy parser first
     if (text == null || text == undefined || typeof text !== 'string') {
-      // console.log("Skip filling. 'text' is null or not a string");
       return text;
     }
     if (parameters) {

package/tiledeskChatbotPlugs/MarkbotChatbotPlug.js

@@ -1,4 +1,5 @@
 const { TiledeskChatbotUtil } = require('@tiledesk/tiledesk-chatbot-util');
+const winston = require('../utils/winston');
 
 class MarkbotChatbotPlug {
 
@@ -15,16 +16,14 @@ class MarkbotChatbotPlug {
 
   exec(pipeline) {
     let message = pipeline.message;
-    // console.log("markbot on message", message)
     if (message.attributes && (message.attributes.markbot == undefined || message.attributes.markbot == false)) { // defaults to disabled
-      if (this.log) {console.log("markbot disabled")}
+      winston.verbose("(MarkbotChatbotPlug) Markbot disabled")
       pipeline.nextplug();
       return;
     }
 
-    // console.log("message.text", message.text)
     if (!message.text) {
-      if (this.log) {console.log("No message.text (no content). Skipping markbot");}
+      winston.verbose("(MarkbotChatbotPlug) No message.text (no content). Skipping markbot");
       pipeline.message = null;
       pipeline.nextplug();
       return;
@@ -34,11 +33,9 @@ class MarkbotChatbotPlug {
     if (message.attributes && message.attributes.commands) {
       commands = message.attributes.commands;
     }
-    // console.log("before taking decision:");
-    // console.log("message.text:", incoming_message_text);
-    // console.log("message commands:", commands)
+    
     if (incoming_message_text === "" && !commands) {
-      console.log("message with no content. Ignoring");
+      winston.verbose("(MarkbotChatbotPlug) Message with no content. Ignoring");
       pipeline.message = null;
       pipeline.nextplug();
       return;
@@ -48,9 +45,9 @@ class MarkbotChatbotPlug {
       message.attributes = {}
     }
     if (incoming_message_text !== "") {
-      if (this.log) {console.log("markbotting main message...");}
+      winston.verbose("(MarkbotChatbotPlug) markbotting main message...");
       let parsed_reply = TiledeskChatbotUtil.parseReply(incoming_message_text);
-      if (this.log) {console.log("parsed", JSON.stringify(parsed_reply));}
+      winston.debug("(MarkbotChatbotPlug) parsed_reply", parsed_reply);
       if (parsed_reply) {
         message.text = parsed_reply.message.text;
         if (!message.type || message.type === "text") {
@@ -61,7 +58,7 @@ class MarkbotChatbotPlug {
           // if already present, do not modify metadata
           message.metadata = parsed_reply.message.metadata;
         }
-        if (this.log) {console.log("parsed_reply.message.attributes", JSON.stringify(parsed_reply.message.attributes));}
+        winston.debug("(MarkbotChatbotPlug) parsed_reply.message.attributes", parsed_reply.message.attributes);
         //this.mergeCurrentMessageButtons(message, parsed_reply);
         if (parsed_reply.message.attributes) {
           for(const [key, value] of Object.entries(parsed_reply.message.attributes)) {
@@ -71,30 +68,25 @@ class MarkbotChatbotPlug {
       }
     }
     else {
-      console.log("no message text:", message.text);
+      winston.verbose("(MarkbotChatbotPlug) no message text: " + message.text);
     }
     
     // let commands = null;
     // if (message.attributes && message.attributes.commands) {
     //   commands = message.attributes.commands;
     if (commands) {
-      if (this.log) {console.log("commands for markbot:", commands);}
+      winston.debug("(MarkbotChatbotPlug) commands for markbot:", commands);
       if (commands.length > 1) {
         for (let i = 0; i < commands.length; i++) {
           if (commands[i].type === 'message' && commands[i].message && commands[i].message.text) {
             let parsed_reply = TiledeskChatbotUtil.parseReply(commands[i].message.text);
-            //console.log("PARSED***", parsed_reply);
             commands[i].message = parsed_reply.message;
           }
         }
       }
     }
-    // else if (message.attributes && !message.attributes.commands) {
-    //   console.log("no message commands.");
-    // }
-    // if (this.log) {console.log("Message out of Markbot:", JSON.stringify(message));}
-    pipeline.nextplug();
-    
+
+    pipeline.nextplug();    
   }
 
   /*mergeCurrentMessageButtons(message, parsed_reply) {

package/tiledeskChatbotPlugs/MessagePipeline.js

@@ -1,3 +1,5 @@
+const winston = require('../utils/winston');
+
 class MessagePipeline {
 
   /**
@@ -29,24 +31,18 @@ class MessagePipeline {
   /*
 exec(completionCallback) {
     this.completionPromise = new Promise((resolve, reject) => {
-      console.log("The context", context)
       const plug = this.nextplug();
       if (!plug) {
-        console.log("NO PLUGS!");
         if (completionCallback) {
-            console.log("completionCallback found.");
             completionCallback();
           }
-          console.log("Resolving...", this.message);
           return resolve();
       }
       else {
         plug.exec(this, () => {
           if (completionCallback) {
-            console.log("completionCallback found.");
             completionCallback();
           }
-          console.log("Resolving...", this.message);
           return resolve();
         });
       }
@@ -58,14 +54,10 @@ exec(completionCallback) {
   /*execOn(message, context, completionCallback) {
     return new Promise((resolve, reject) => {
       this.message = message;
-      console.log("The context", context)
       this.process(this.nextplug(), context, (message) => {
-        console.log("All plugs processed.", message)
         if (completionCallback) {
-          console.log("completionCallback found.")
           completionCallback(message);
         }
-        console.log("Resolving...", message)
         return resolve(message);
       });
     });
@@ -84,27 +76,25 @@ exec(completionCallback) {
 
   nextplug() {
     this.counter += 1;
-    if (this.log) {console.log(`processing plug[${this.counter}]`);}
+    winston.verbose("(MessagePipeline) processing plug: " + this.coounter);
     if (this.counter < this.plugs.length) {
-      if (this.log) {console.log("Still plugs...")}
+      winston.verbose("(MessagePipeline) Still plugs...")
       let nextp = this.plugs[this.counter];
       nextp.exec(this);
     }
     else {
-      if (this.log) {console.log("no more plugs");}
+      winston.verbose("(MessagePipeline) no more plugs");
       this.resolve(this.message);
     }
   }
   /*
   nextplug() {
     this.counter += 1;
-    console.log(`processing plug[${this.counter}]`);
     if (this.counter < this.plugs.length) {
       let nextp = this.plugs[this.counter];
       return nextp;
     }
     else {
-      console.log("no more plugs");
       return null;
     }
   }

package/tiledeskChatbotPlugs/SplitsChatbotPlug.js

@@ -1,4 +1,5 @@
 const { TiledeskChatbotUtil } = require('@tiledesk/tiledesk-chatbot-util');
+const winston = require('../utils/winston')
 
 class SplitsChatbotPlug {
 
@@ -15,11 +16,8 @@ class SplitsChatbotPlug {
 
   exec(pipeline) {
     let message = pipeline.message;
-    // console.log("Splits disabled on message?", message);
     if (message.attributes && (message.attributes.splits == undefined || message.attributes.splits == false)) { // defaults to disabled
-      if (this.log) {
-        console.log("Splits disabled.");
-      }
+      winston.verbose("(SplitsChatbotPlug) Splits disabled.");
       pipeline.nextplug();
       return;
     }
@@ -27,24 +25,17 @@ class SplitsChatbotPlug {
       pipeline.nextplug();
       return;
     }
-    if (this.log) {
-      console.log("Splitting...");
-    }
+    winston.verbose("(SplitsChatbotPlug) Splitting...");
     // if splits found just a attributs.commands payload is attached
     // to the original json message with split commands
     let commands = TiledeskChatbotUtil.splitPars(message.text);
-    if (this.log) {
-      console.log("commands", JSON.stringify(commands))
-    }
+    winston.debug("(SplitsChatbotPlug) commands", commands)
     if (commands && commands.length > 1) {
       if (!message.attributes) {
         message.attributes = {}
       }
       message.attributes.commands = commands;
     }
-    if (this.log) {
-      // console.log("Message out of Splits plugin:", JSON.stringify(message));
-    }
     pipeline.nextplug();
   }
 }

package/tiledeskChatbotPlugs/TiledeskRequestVariables.js

@@ -1,4 +1,4 @@
-const { TiledeskChatbot } = require('../models/TiledeskChatbot');
+const { TiledeskChatbot } = require('../engine/TiledeskChatbot');
 
 class TiledeskRequestVariables {
     

package/tiledeskChatbotPlugs/WebhookChatbotPlug.js

@@ -1,4 +1,5 @@
 let axios = require('axios');
+const winston = require('../utils/winston');
 
 class WebhookChatbotPlug {
 
@@ -12,32 +13,32 @@ class WebhookChatbotPlug {
   exec(pipeline) {
     let answer = pipeline.message;
     let context = pipeline.context;
-    if (this.log) {console.log("WEBHOOK?", answer.attributes.webhook);}
+    winston.verbose("(WebhookChatbotPlug) webhook" + answer.attributes.webhook);
     if (answer.attributes && answer.attributes.webhook && answer.attributes.webhook === true) {
-      if (this.log) {console.log("EXECUTING WEBHOOK URL!", this.webhookurl);}
-      if (this.log) {console.log("EXECUTING WEBHOOK ON CONTEXT:", JSON.stringify(context));}
+      winston.debug("(WebhookChatbotPlug) Executing webhook url " + this.webhookurl);
+      winston.debug("(WebhookChatbotPlug) Executing webhook on context: ", context);
       if (!this.validWebhookURL(this.webhookurl)) {
-        if (this.log) {console.error("(WebhookChatbotPlug) Error. Invalid webhook URL:", this.webhookurl, "on context:", JSON.stringify(context));}
+        winston.error("(WebhookChatbotPlug) Error. Invalid webhook URL: " + this.webhookurl + " on context: " + JSON.stringify(context));
         pipeline.nextplug();
         return;
       }
       this.execWebhook(answer, context, this.webhookurl, (err, message_from_webhook) => {
-        if (this.log) {console.log("message_from_webhook:", message_from_webhook);}
+        winston.debug("(WebhookChatbotPlug) message_from_webhook:", message_from_webhook);
         if (err) {
-          console.error("Error calling webhook:", this.webhookurl)
+          winston.error("(WebhookChatbotPlug) Error calling webhook:", this.webhookurl)
           pipeline.nextplug();
         }
         else {
-          if (this.log) {console.log("Webhook successfully end:", message_from_webhook);}
+          winston.debug("(WebhookChatbotPlug) Webhook successfully end:", message_from_webhook);
           const pipeline_original_message = pipeline.message
-          if (this.log) {console.log("pipeline.message before webhook", JSON.stringify(pipeline.message));}
+          winston.debug("(WebhookChatbotPlug) pipeline.message before webhook", pipeline.message);
 
           // **** setting message from webhook,
           // **** MERGING with original not overwritten data, manually
           pipeline.message = message_from_webhook;
           // restore on message the original intent_info, necessary FOR further processING the message in the plugs pipeline
           if (pipeline.message && !pipeline.message.attributes) {
-            if (this.log) {console.log("!pipeline.message.attributes", pipeline.message.attributes);}
+            winston.debug("(WebhookChatbotPlug) !pipeline.message.attributes", pipeline.message.attributes);
             pipeline.message.attributes = {};
           }
           pipeline.message.attributes.intent_info = pipeline_original_message.attributes.intent_info;
@@ -59,11 +60,11 @@ class WebhookChatbotPlug {
       });
     }
     else {
-      if (this.log) {console.log("NO WEBHOOK!");}
+      winston.verbose("(WebhookChatbotPlug) No Webhook!");
       pipeline.nextplug();
       return;
     }
-    if (this.log) {console.log("Start processing webhook...");}
+    winston.verbose("(WebhookChatbotPlug) Start processing webhook...");
   }
   
   validWebhookURL(webhookurl) {
@@ -74,10 +75,8 @@ class WebhookChatbotPlug {
   }
 
   execWebhook(reply_message, context, webhookurl, callback) {
-    if (this.log) {
-      console.log("WEBHOOK. on context", JSON.stringify(context));
-      console.log("WEBHOOK. on message", JSON.stringify(reply_message));
-    }
+    winston.debug("(WebhookChatbotPlug) Webhook on context ", context);
+    winston.debug("(WebhookChatbotPlug) WEBHOOK on message ", reply_message);
     const HTTPREQUEST = {
       url: webhookurl,
       headers: {
@@ -92,7 +91,7 @@ class WebhookChatbotPlug {
       HTTPREQUEST,
       function(err, res) {
         if (err || (res && res.status >= 400) || (res && !res.data)) {
-          console.error("An error occurred calling intent's webhook url:", webhookurl);
+          winston.error("(WebhookChatbotPlug) An error occurred calling intent's webhook url: " + webhookurl);
           if (callback) {
             callback(reply_message);
           }
@@ -104,72 +103,6 @@ class WebhookChatbotPlug {
         }
       }, this.log
     );
-
-    /*
-    return request({                    
-                    uri :  webhookurl,
-                    headers: {
-                        'Content-Type' : 'application/json', 
-                        'User-Agent': 'tiledesk-bot',
-                        'Origin': webhook_origin
-                         //'x-hook-secret': s.secret
-                       },
-                    method: 'POST',
-                    json: true,
-                    body: {payload:{text: text, bot: bot, message: message, intent: faq}, token: token},
-                    // }).then(response => {
-                    }, function(err, response, json){
-                        if (err) {
-                            winston.error("Error from webhook reply of getParsedMessage. Return standard reply", err);
-
-                            return resolve(messageReply);
-
-                            // return error
-                            
-                        }
-                         if (response.statusCode >= 400) {      
-                            winston.verbose("The ChatBot webhook return error http status code. Return standard reply", response);            
-                            return resolve(messageReply);
-                        }
-
-                        if (!json) { //the webhook return empty body
-                            winston.verbose("The ChatBot webhook return no json. Return standard reply", response);
-                            return resolve(messageReply);
-                        }
-                       
-                        winston.debug("webhookurl repl_message ", response);
-
-                        var text = undefined;
-                        if(json && json.text===undefined) {
-                            winston.verbose("webhookurl json is defined but text not. return standard reply",{json:json, response:response});
-                            // text = 'Field text is not defined in the webhook respose of the faq with id: '+ faq._id+ ". Error: " + JSON.stringify(response);
-                            return resolve(messageReply);
-                        }else {
-                            text = json.text;
-                        }
-                        winston.debug("webhookurl text:  "+ text);
-
-                        // // let cloned_message = Object.assign({}, messageReply);
-                        // let cloned_message =  message;
-                        // winston.debug("cloned_message :  ",cloned_message);
-
-                        // if (json.attributes) {
-                        //     if (!cloned_message.attributes) {
-                        //         cloned_message.attributes = {}
-                        //     }
-                        //     winston.debug("ChatBot webhook json.attributes: ",json.attributes);
-                        //     for(const [key, value] of Object.entries(json.attributes)) {
-                        //         cloned_message.attributes[key] = value
-                        //     }
-                        // }
-
-                        // winston.debug("cloned_message after attributes:  ",cloned_message);
-
-                        that.parseMicrolanguage(text, message, bot, faq, true, json).then(function(bot_answer) {
-                            return resolve(bot_answer);
-                        });
-                    });
-    */
   }
 
   // ************************************************
@@ -178,8 +111,8 @@ class WebhookChatbotPlug {
 
   static myrequest(options, callback, log) {
     if (log) {
-      console.log("API URL:", options.url);
-      console.log("** Options:", JSON.stringify(options));
+      winston.debug("(WebhookChatbotPlug) myrequest API URL:" + options.url);
+      winston.debug("(WebhookChatbotPlug) myrequest Options:", options);
     }
     axios(
       {
@@ -190,17 +123,16 @@ class WebhookChatbotPlug {
       })
     .then(function (res) {
       if (log) {
-        console.log("Response for url:", options.url);
-        console.log("Response headers:\n", JSON.stringify(res.headers));
-        // console.log("******** Response for url:", JSON.stringify(res));
-        console.log("Response body:\n", JSON.stringify(res.data));
+        winston.debug("(WebhookChatbotPlug) myrequest Response for url:", options.url);
+        winston.debug("(WebhookChatbotPlug) myrequest Response headers:\n", res.headers);
+        winston.debug("(WebhookChatbotPlug) myrequest Response body:\n", res.data);
       }
       if (callback) {
         callback(null, res);
       }
     })
     .catch(function (error) {
-      console.error("(WebhookChatbotPlug) Axios error: ", JSON.stringify(error));
+      winston.debug("(WebhookChatbotPlug) Axios error: ", error.response.data);
       if (callback) {
         callback(error, null, null);
       }

package/tiledeskChatbotPlugs/directives/DEPRECATED_DirSetAttribute.js

@@ -1,4 +1,4 @@
-const { TiledeskChatbot } = require('../../models/TiledeskChatbot');
+const { TiledeskChatbot } = require('../../engine/TiledeskChatbot');
 const { Filler } = require('../Filler');
 
 class DirSetAttribute {