@tiledesk/tiledesk-tybot-connector 0.5.0 → 2.0.0

package/{models → engine}/IntentForm.js

@@ -1,5 +1,6 @@
 //const CURRENT_FIELD_K = "tilebot:requests:forms:currentField"; // form field index
 const CURRENT_FORM_K = "CURRENT_FORM"; // form json
+const winston = require('../utils/winston');
 
 class IntentForm {
 
@@ -18,10 +19,8 @@ class IntentForm {
     if (!this.requestParameters) {
       return null;
     }
-    if (this.log) {
-      console.log("this.requestParameters:", JSON.stringify(this.requestParameters));
-      console.log("this.requestParameters[" + paramKey + "]:", this.requestParameters[paramKey]);
-    }
+    winston.debug("(IntentForm) requestParameters: ", this.requestParameters);
+    winston.debug("(IntentForm) requestParameters[" + paramKey + "]:" + this.requestParameters[paramKey]);
     return this.requestParameters[paramKey];
   }
 
@@ -61,13 +60,11 @@ class IntentForm {
     }
   */
   async getMessage(user_text) {
-    //console.log("get message:", user_text)
     let current_form = null;
     const _current_form = await this.getValue(this.CURRENT_FORM_KEY);
     if (_current_form) {
       current_form = JSON.parse(_current_form);
     }
-    //console.log("CURRENT FORM IS", current_form);
     if (
     current_form &&
     this.form &&
@@ -90,7 +87,7 @@ class IntentForm {
     }
     
     if (current_field == null) {
-      if (this.log) {console.log("current_field is undefined")}
+      winston.debug("(IntentForm) current_field is undefined");
       current_field = 0;
       
       // first "freeze" the currente form, so that eventual form modifications
@@ -105,58 +102,48 @@ class IntentForm {
       // set the first field under the "await the response-value" state (=0)
       await this.setValue(this.CURRENT_FIELD_INDEX_KEY, current_field);
       // now look for an already set value for this field in request parameters
-      if (this.log) {console.log("IntentForm parameters", JSON.stringify(this.requestParameters));}
-      if (this.log) {console.log("checking field:", this.form.fields[current_field].name);}
+      winston.debug("(IntentForm) parameters ", this.requestParameters);
+      winston.debug("(IntentForm) checking field: " + this.form.fields[current_field].name);
       const is_current_value = this.getParam(this.form.fields[current_field].name);
       if (is_current_value) {
-        if (this.log) {console.log("is_current_value!", is_current_value);}
+        winston.debug("(IntentForm) is_current_value: " + is_current_value);
         return await this.getMessage(is_current_value);
       }
-      if (this.log) {console.log("Form asking fist value. No 'is_current_value' for first form field", is_current_value);}
-      // if (this.log) {console.log("INTENT_FORM:", this.form);}
-      if (this.log) {console.log("CURRENT FIELD:", current_field);}
+      winston.debug("(IntentForm) asking fist value. No 'is_current_value' for first form field" + is_current_value);
+      winston.debug("(IntentForm) current_field: " + current_field);
       let message = {
         text: this.form.fields[current_field].label
       }
-      if (this.log) {console.log("form reply message:", message);}
+      winston.debug("(IntentForm)form reply message: ", message);
       return {
         message: message
       }
     }
     else {
-        // = 0
-        // current++ (1) y? => 
-        // 
-        //inc(current_field)=1 getMessage(null)
-        // == 1?
-        // n => continue => 
-        // param[1] n? => continue
-        // == 2? => set fields[2].name => user_text
-      //console.log("current_form:", current_form);
-      if (this.log) {console.log("current_field:", current_field);}
-      
+
+      winston.debug("(IntentForm) current_field: " + current_field);
       
       if (current_form.fields[current_field].regex) {
         if (!this.validate(user_text, current_form.fields[current_field].regex)) {
-          if (this.log) {console.log("text is invalid");}
+          winston.verbose("(IntentForm) text is invalid");
           // send error message
           let error_reply_text = this.form.fields[current_field].label;
-          if (this.log) {console.log("text is invalid label", error_reply_text);}
+          winston.debug("(IntentForm) text is invalid label: " + error_reply_text);
           if (current_form.fields[current_field].errorLabel) {
-            if (this.log) {console.log("text is invalid errorLabel", current_form.fields[current_field].errorLabel);}
+            winston.debug("(IntentForm) text is invalid errorLabel: " + current_form.fields[current_field].errorLabel);
             error_reply_text = current_form.fields[current_field].errorLabel;
           }
           let message = {
             text: error_reply_text // Error
           }
-          if (this.log) {console.log("IntentForm error message:", message);}
+          winston.debug("(IntentForm) error message: ", message);
           return {
             message: message
           };
         }
       }
       else {
-        if (this.log) {console.log("no regex validation requested. next field...")}
+        winston.verbose("(IntentForm) no regex validation requested. next field...")
       }
       
       // text ok?
@@ -169,12 +156,12 @@ class IntentForm {
       // persist parameter
       const parameter_name = current_form.fields[current_field].name;
       const parameter_value = user_text;
-      if (this.log) {console.log("adding parameters, name:", parameter_name, "value:", parameter_value)}
+      winston.debug("(IntentForm) adding parameters, name: " + parameter_name + " value: " + parameter_value)
       await this.chatbot.addParameter(parameter_name, parameter_value);
       if (current_form.fields[current_field].type) { // adding type
         await this.chatbot.addParameter("_tdTypeOf:" + parameter_name, current_form.fields[current_field].type);
       }
-      if (this.log) {console.log("next field...");}
+      winston.verbose("(IntentForm) next field...");
 
       current_field += 1;
       if (current_field === current_form.fields.length) {
@@ -186,23 +173,22 @@ class IntentForm {
         };
       }
       else {
-        if (this.log) {console.log("Processing next field:", current_field)}
+        winston.debug("(IntentForm) Processing next field: " + current_field);
         await this.setValue(this.CURRENT_FIELD_INDEX_KEY, current_field);
 
-        // if (this.log) {console.log("params", this.requestParameters);}
-        if (this.log) {console.log("checking field:", this.form.fields[current_field].name);}
+        winston.debug("(IntentForm)checking field:", this.form.fields[current_field].name);
         
         const is_current_value = this.getParam(this.form.fields[current_field].name);
         if (is_current_value) {
-          if (this.log) {console.log("is_current_value!", is_current_value);}
-            return await this.getMessage(is_current_value);
+          winston.debug("(IntentForm) is_current_value! " + is_current_value);
+          return await this.getMessage(is_current_value);
         }
         else {
-            return {
-              message: {
-                text: current_form.fields[current_field].label
-              }
-            };
+          return {
+            message: {
+              text: current_form.fields[current_field].label
+            }
+          };
         }
         
       }
@@ -215,13 +201,13 @@ class IntentForm {
       // removing leading and trailing / if regex is sorrounded by (legacy support, to be removed)
       _regex = regex.substring(1, regex.length-1);
     }
-    if (this.log) {console.log("Validating using regex:", _regex);}
+    winston.debug("(IntentForm)Validating using regex: " + _regex);
     try {
       const rg = new RegExp(_regex, "g");
       return rg.test(text);
     }
     catch(error) {
-      console.error("Error, invalid regex:", _regex);
+      winston.error("(IntentForm) Error, invalid regex: " + _regex);
       return true;
     }
     

package/{models → engine}/IntentsMachineFactory.js

@@ -1,30 +1,31 @@
 const { MongodbIntentsMachine } = require('./MongodbIntentsMachine.js');
 const { TiledeskIntentsMachine } = require("./TiledeskIntentsMachine.js");
+const winston = require('../utils/winston.js')
 
 class IntentsMachineFactory {
 
     static getMachine(bot, botId, projectId, log) {
       let machine;
       if (bot && bot.intentsEngine === "tiledesk-ai") {
-        console.log("bot.intentsEngine is tiledesk-ai");
+        winston.verbose("(IntentsMachineFactory) bot.intentsEngine is tiledesk-ai");
         machine = new TiledeskIntentsMachine(
           {
             botId: botId
           });
       }
       else if (bot) {
-        if (log) {console.log("Setting MongodbIntentsMachine with bot:", JSON.stringify(bot));}
+        winston.verbose("(IntentsMachineFactory) Setting MongodbIntentsMachine with bot:", JSON.stringify(bot));
         machine = new MongodbIntentsMachine({projectId: projectId, language: bot.language, log});
       }
       else {
-        console.error("bot is null for:", botId, "on projectId:", projectId);
+        winston.error("bot is null for: " + botId + " on projectId: " + projectId);
       }
       return machine;
     }
 
     static getBackupMachine(bot, botId, projectId, log) {
       let machine;
-      if (log) {console.log("Setting MongodbIntentsMachine as Backup Intents Machine on bot:", JSON.stringify(bot));}
+      winston.verbose("(IntentsMachineFactory) Setting MongodbIntentsMachine as Backup Intents Machine on bot:", JSON.stringify(bot));
       machine = new MongodbIntentsMachine({projectId: projectId, language: bot.language, log});
       return machine;
     }

package/{models → engine}/MongodbBotsDataSource.js

@@ -1,5 +1,6 @@
-let Faq = require('./faq');
-let Faq_kb = require('./faq_kb');
+let Faq = require('../models/faq');
+let Faq_kb = require('../models/faq_kb');
+const winston = require('../utils/winston');
 
 class MongodbBotsDataSource {
 
@@ -22,51 +23,33 @@ class MongodbBotsDataSource {
   async getBotByIdCache(botId, tdcache) {
     let bot = null;
     if (tdcache) {
-      // console.log("getBotByIdCache cache ok");
       let botCacheKey = "cacheman:cachegoose-cache:faq_kbs:id:" + botId;
       try {
         let _bot_as_string = await tdcache.get(botCacheKey);
         const value_type = typeof _bot_as_string;
-        // console.log("__bot_as_string found in chache:", _bot_as_string);
-        if (this.log) {
-          console.log("__bot_as_string found in chache:", _bot_as_string);
-          console.log("value_type:", value_type);
-        }
+        winston.debug("(MongodbBotsDataSource) _bot_as_string found in chache: " + _bot_as_string);
+        winston.debug("(MongodbBotsDataSource) value_type: " + value_type);
         if (_bot_as_string) {
           bot = JSON.parse(_bot_as_string);
-          // console.log("got bot from cache:", JSON.stringify(bot));
-          if (this.log) {
-            console.log("got bot from cache:", JSON.stringify(bot));
-          }
+          winston.debug("(MongodbBotsDataSource) got bot from cache: ", bot);
         }
         else {
-          // console.log("bot not found, getting from datasource...");
-          if (this.log) {
-            console.log("bot not found, getting from datasource...");
-          }
+          winston.debug("(MongodbBotsDataSource) bot not found, getting from datasource...");
           bot = await this.getBotById(botId);
-          // console.log("bot found in datasource:", JSON.stringify(bot));
-          if (this.log) {
-            console.log("bot found in datasource:", JSON.stringify(bot));
-          }
+          winston.debug("(MongodbBotsDataSource) bot found in datasource: ", bot);
           await tdcache.set(botCacheKey, JSON.stringify(bot));
           // DEBUG CODE REMOVE
           // let bot_ = await tdcache.get(botCacheKey);
-          // console.log("_bot_as_string from cache debug:", bot_)
         }
       }
       catch(err) {
-        console.error("error getting bot by id:", err);
+        winston.error("(MongodbBotsDataSource) Error getting bot by id: ", err);
       }
     }
     else {
-      // if (this.log) {
-        console.log("no chache. getting bot from datasource...");
-      // }
+      winston.verbose("(MongodbBotsDataSource) No chache. getting bot from datasource...");
       bot = await this.getBotById(botId);
-      // if (this.log) {
-        console.log("bot found in datasource:", JSON.stringify(bot));
-      // }
+      winston.debug("(MongodbBotsDataSource) bot found in datasource: ", bot);
     }
     return bot;
   }
@@ -83,11 +66,11 @@ class MongodbBotsDataSource {
       let query = { "id_faq_kb": botId, "question": text };
       Faq.find(query).lean().exec(async (err, faqs) => {
         if (err) {
-          console.error("Error getting faq object.", err);
+          winston.error("(MongodbBotsDataSource) Error getting faq object: ", err);
           reject(err);
         }
         else if (faqs && faqs.length > 0 && faqs[0].answer) {
-          if (this.log) {console.log("EXACT MATCH OR ACTION FAQ:", faqs);}
+          winston.debug("(MongodbBotsDataSource) Exact match or action Faq: ", faqs);
           resolve(faqs);
         }
         else {
@@ -103,34 +86,34 @@ class MongodbBotsDataSource {
    * @returns a single Intent
    */
   async getByIntentDisplayName(botId, key) {
-    if (this.log) {console.log("Quering intent by botId:", botId, "key:", key );}
+    winston.debug("(MongodbBotsDataSource) Quering intent by botId: " + botId + " key: " + key );
     return new Promise((resolve, reject) => {
       // var query = { "id_project": this.projectId, "id_faq_kb": botId, "intent_display_name": name};
       let query = null;
       key = key.trim();
       if (key.startsWith("#")) {
         let intent_id = key.substring(key.indexOf("#") + 1);
-        if (this.log) {console.log("Query by intent_id:", intent_id );}
+        winston.debug("(MongodbBotsDataSource)Query by intent_id: " + intent_id );
         query = { "id_faq_kb": botId, "intent_id": intent_id };
       }
       else {
-        if (this.log) {console.log("Query by intent name:", key);}
+        winston.debug("(MongodbBotsDataSource) Query by intent name: " + key);
         query = { "id_faq_kb": botId, "intent_display_name": key };
       }      
-      if (this.log) {console.debug('query', query);}
+      winston.debug("(MongodbBotsDataSource) query", query);
       Faq.find(query).lean().exec( (err, faqs) => {
         if (err) {
-          console.error("error getting faqs", err);
+          winston.error("(MongodbBotsDataSource) Error getting faqs ", err);
           return reject(err);
         }
-        if (this.log) {console.debug("getByIntentDisplayName faqs", JSON.stringify(faqs));}
+        winston.debug("(MongodbBotsDataSource) getByIntentDisplayName faqs ", faqs);
         if (faqs && faqs.length > 0) {
           const intent = faqs[0];
-          if (this.log) {console.debug("intent found:", JSON.stringify(intent));}
+          winston.debug("(MongodbBotsDataSource) intent found: ", intent);
           return resolve(intent);
         }
         else {
-          if (this.log) {console.debug("No intent found");}
+          winston.verbose("(MongodbBotsDataSource) No intent found");
           return resolve(null);
         }
       });
@@ -139,29 +122,23 @@ class MongodbBotsDataSource {
 
   async getByIntentDisplayNameCache(botId, key, tdcache) {
     let faq = null;
-    if (this.log) {
-      console.log("botID: -" + botId + "-");
-      console.log("key: -" + key + "-");
-    }
+    winston.verbose("(MongodbBotsDataSource) botID: -" + botId + "-");
+    winston.verbose("(MongodbBotsDataSource) key: -" + key + "-");
     if (tdcache) {
-      if (this.log) {console.log("in tdcache");}
       let faqCacheKey = "cacheman:cachegoose-cache:faqs:botid:"+ botId + ":faq:id:" + key;
-      if (this.log) {console.log("Looking in cache for: -" + faqCacheKey + "-");}
+      winston.debug("(MongodbBotsDataSource) Looking in cache for: -" + faqCacheKey + "-");
       try {
         let _faq_as_string = await tdcache.get(faqCacheKey);
         const value_type = typeof _faq_as_string;
-        if (this.log) {
-          console.log("_faq_as_string found in chache:", _faq_as_string);
-          console.log("value_type:", value_type);
-        }
+        winston.debug("(MongodbBotsDataSource)_faq_as_string found in chache: " + _faq_as_string);
+        winston.debug("(MongodbBotsDataSource)value_type: " + value_type);
         if (_faq_as_string) {
           faq = JSON.parse(_faq_as_string);
-          if (this.log) {console.log("got faq from cache:", JSON.stringify(faq));}
+          winston.debug("(MongodbBotsDataSource) Got faq from cache: ", faq);
         }
         else {
-          //console.log("faq not found, getting from datasource...");
           faq = await this.getByIntentDisplayName(botId, key);
-          if (this.log) {console.log(".faq found in datasource:", JSON.stringify(faq));}
+          winston.debug("(MongodbBotsDataSource) faq found in datasource:", faq);
           await tdcache.set(
             faqCacheKey,
             JSON.stringify(faq),
@@ -169,17 +146,16 @@ class MongodbBotsDataSource {
           );
           // DEBUG CODE REMOVE
           // let faq_ = await tdcache.get(faqCacheKey);
-          // console.log("_faq_as_string from cache debug:", faq_)
         }
       }
       catch(err) {
-        console.error("error getting faq by id:", err);
+        winston.error("(MongodbBotsDataSource) Error getting faq by id: ", err);
       }
     }
     else {
-      if (this.log) {console.log("no chache. getting faq from datasource...");}
+      winston.debug("(MongodbBotsDataSource) No chache. Getting faq from datasource...");
       faq = await this.getByIntentDisplayName(botId, key);
-      if (this.log) {console.log("faq found in datasource (no-cache):", JSON.stringify(faq));}
+      winston.debug("(MongodbBotsDataSource) Faq found in datasource (no-cache): ", faq);
     }
     return faq;
   }

package/{models → engine}/MongodbIntentsMachine.js

@@ -1,5 +1,6 @@
 let mongoose = require('mongoose');
-let Faq = require('./faq');
+let Faq = require('../models/faq');
+const winston = require('../utils/winston');
 
 class MongodbIntentsMachine {
 
@@ -19,14 +20,14 @@ class MongodbIntentsMachine {
    */
   async decode(botId, text) {
     return new Promise( (resolve, reject) => {
-      if (this.log) {console.log("Mongodb NLP decode intent...");}
+      winston.debug("(MongodbIntentsMachine) Mongodb NLP decode intent...");
       // let query = { "id_project": this.projectId, "id_faq_kb": botId };
       let query = { "id_faq_kb": botId };
       var mongoproject = undefined;
       var sort = undefined;
       var search_obj = { "$search": text };
   
-      if (this.log) {console.log("chatbot lang:", this.language);}
+      winston.debug("(MongodbIntentsMachine) chatbot lang: " + this.language);
       if (this.language) {
           search_obj["$language"] = this.language;
       }
@@ -35,9 +36,9 @@ class MongodbIntentsMachine {
       sort = { score: { $meta: "textScore" } } 
       // DA QUI RECUPERO LA RISPOSTA DATO (ID: SE EXT_AI) (QUERY FULLTEXT SE NATIVE-BASIC-AI)
       Faq.find(query, mongoproject).sort(sort).lean().exec( (err, faqs) => {
-        if (this.log) {console.log("Found:", faqs);}
+        winston.debug("(MongodbIntentsMachine) Found: ", faqs);
         if (err) {
-          console.error("Error:", err);
+          winston.error("(MongodbIntentsMachine) Error:", err);
         }
         if (faqs && faqs.length > 0) {
           resolve(faqs);