@tiledesk/tiledesk-tybot-connector 0.5.0-rc2 → 0.5.1-rc1

package/CHANGELOG.md

@@ -5,6 +5,13 @@
 available on:
  ▶️ https://www.npmjs.com/package/@tiledesk/tiledesk-tybot-connector
 
+# 0.5.1-rc1
+- added json_buttons 
+- added winston log with code refactoring
+
+# v0.5.0
+- added: AI_ENDPOINT env var
+
 # v0.5.0-rc1
 - added: ability to get 'none' as bodytype in webresponse
 

package/ExtApi.js

@@ -1,6 +1,7 @@
 let axios = require('axios');
 let https = require("https");
 const winston = require('./utils/winston');
+const httpUtils = require('./utils/HttpUtils');
 
 class ExtApi {
 
@@ -49,7 +50,7 @@ class ExtApi {
       json: message,
       method: 'POST'
     };
-    this.myrequest(
+    httpUtils.request(
       HTTPREQUEST,
       function(err, resbody) {
         if (err) {
@@ -66,76 +67,6 @@ class ExtApi {
     );
   }
 
-  /**
-   * A stub to send message to the "ext/botId" endpoint, hosted by tilebot on:
-   * /${TILEBOT_ROUTE}/ext/${botId}
-   *
-   * @param {Object} message. The message to send
-   * @param {string} botId. Tiledesk botId
-   * @param {string} token. User token
-   */
-  // sendMessageToBot(message, botId, token, callback) {
-  //   const url = `${this.ENDPOINT}/ext/${botId}`;
-  //   const HTTPREQUEST = {
-  //     url: url,
-  //     headers: {
-  //       'Content-Type' : 'application/json',
-  //       'Authorization': jwt_token
-  //     },
-  //     json: message,
-  //     method: 'POST'
-  //   };
-  //   this.myrequest(
-  //     HTTPREQUEST,
-  //     function(err, resbody) {
-  //       if (err) {
-  //         if (callback) {
-  //           callback(err);
-  //         }
-  //       }
-  //       else {
-  //         if (callback) {
-  //           callback(null, resbody);
-  //         }
-  //       }
-  //     }, this.log
-  //   );
-  // }
-
-  myrequest(options, callback, log) {
-    let axios_options = {
-      url: options.url,
-      method: options.method,
-      data: options.json,
-      params: options.params,
-      headers: options.headers
-    }
-    if (options.url.startsWith("https:")) {
-      const httpsAgent = new https.Agent({
-        rejectUnauthorized: false,
-      });
-      axios_options.httpsAgent = httpsAgent;
-    }
-    axios(axios_options)
-    .then((res) => {
-      if (res && res.status == 200 && res.data) {
-        if (callback) {
-          callback(null, res.data);
-        }
-      }
-      else {
-        if (callback) {
-          callback(TiledeskClient.getErr({message: "Response status not 200"}, options, res), null, null);
-        }
-      }
-    })
-    .catch( (error) => {
-      winston.error("(ExtApi) An error occurred:", JSON.stringify(error));
-      if (callback) {
-        callback(error, null, null);
-      }
-    });
-  }
 }
 
 module.exports = { ExtApi };

package/Logger.js

@@ -1,5 +1,6 @@
 let { Publisher } = require("@tiledesk/tiledesk-multi-worker");
 
+const FLOW_LOGS_ENABLED = process.env.FLOW_LOGS_ENABLED;
 const AMQP_MANAGER_URL = process.env.AMQP_MANAGER_URL;
 let publisher = new Publisher(AMQP_MANAGER_URL, {
     debug: false,
@@ -8,6 +9,8 @@ let publisher = new Publisher(AMQP_MANAGER_URL, {
     topic: "logs",
 })
 
+const levels = { error: 0, warn: 1, info: 2, debug: 3 };
+
 class Logger {
 
     constructor(config) {
@@ -21,17 +24,27 @@ class Logger {
             //throw new Error('config.request_id is mandatory');
         }
 
+        if (!FLOW_LOGS_ENABLED || FLOW_LOGS_ENABLED === false || FLOW_LOGS_ENABLED === 'false') {
+            console.warn("(Logger) Flow logs disabled");
+            this._disableMethods();
+        }
+
+        if (!AMQP_MANAGER_URL) {
+            console.warn("(Logger) No AQMP Manager url provided. Flow logs disabled");
+            this._disableMethods();
+        }
+
         this.request_id = config.request_id;
         this.dev = false;
         if (config.dev && config.dev === true) {
             this.dev = true;
         }
 
-        if (!AMQP_MANAGER_URL) {
-            console.error('AMQP_MANAGER_URL is undefined. Logger not available...');
-            return;
-            //throw new Error("Error starting logger: AMQP_MANAGER_URL is undefined.")
-        }
+        // if (!AMQP_MANAGER_URL) {
+        //     console.error('AMQP_MANAGER_URL is undefined. Logger not available...');
+        //     return;
+        //     //throw new Error("Error starting logger: AMQP_MANAGER_URL is undefined.")
+        // }
 
     }
 
@@ -65,6 +78,7 @@ class Logger {
             request_id: this.request_id,
             text: text,
             level: level,
+            nlevel: levels[level],
             timestamp: new Date(),
             dev: this.dev
         }
@@ -81,6 +95,19 @@ class Logger {
             .join(" ")
     }
 
+    // Substitute methods with empty function if flow flogs are disabled
+    _disableMethods() {
+        const methods = ['error', 'warn', 'info', 'debug'];
+        methods.forEach(method => {
+          this[method] = () => {};
+        });
+    }
+
+    _disableDebugMethod() {
+        const method = 'debug';
+        this[method] = () => {};
+    }
+
 }
 
 module.exports = { Logger }

package/{models → engine}/IntentsMachineFactory.js

@@ -18,7 +18,7 @@ class IntentsMachineFactory {
         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;
     }

package/{models → engine}/MongodbBotsDataSource.js

@@ -1,5 +1,5 @@
-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 {

package/{models → engine}/MongodbIntentsMachine.js

@@ -1,5 +1,5 @@
 let mongoose = require('mongoose');
-let Faq = require('./faq');
+let Faq = require('../models/faq');
 const winston = require('../utils/winston');
 
 class MongodbIntentsMachine {

package/{models → engine}/TiledeskChatbot.js

@@ -5,7 +5,7 @@ const { MessagePipeline } = require('../tiledeskChatbotPlugs/MessagePipeline');
 const { WebhookChatbotPlug } = require('../tiledeskChatbotPlugs/WebhookChatbotPlug');
 const { TiledeskClient } = require('@tiledesk/tiledesk-client');
 const { IntentForm } = require('./IntentForm.js');
-const { TiledeskChatbotUtil } = require('./TiledeskChatbotUtil.js');
+const { TiledeskChatbotUtil } = require('../utils/TiledeskChatbotUtil.js');
 const { DirLockIntent } = require('../tiledeskChatbotPlugs/directives/DirLockIntent');
 const { DirUnlockIntent } = require('../tiledeskChatbotPlugs/directives/DirUnlockIntent');
 const winston = require('../utils/winston');
@@ -146,6 +146,7 @@ class TiledeskChatbot {
         let reply;
         if (!intent || (intent && !intent.name)) {
           winston.verbose("(TiledeskChatbot) Invalid intent:", explicit_intent_name)
+          reply = { "text": "Invalid intent: *" + explicit_intent_name + "*" }
           resolve();
         }
         else {
@@ -171,6 +172,7 @@ class TiledeskChatbot {
           }
           else {
             winston.verbose("(TiledeskChatbot) Intent not found: " + explicit_intent_name);
+            reply = { "text": "Intent not found: " + explicit_intent_name }
             resolve()
           }
         }

package/{models → engine}/TiledeskIntentsMachine.js

@@ -40,11 +40,10 @@ class TiledeskIntentsMachine {
         HTTPREQUEST,
         (err, resbody) => {
           if (err) {
-            // console.error("An error occurred on /model/parse:", err)
             reject(err);
           }
           else {
-            winston.verbose("(TiledeskIntentsMachine)  Tiledesk AI replied:", resbody)
+            winston.debug("(TiledeskIntentsMachine) Tiledesk AI replied: ", resbody)
             resolve(this.translateForTiledesk(resbody));
           }
         }, false

package/{models → engine/mock}/MockBotsDataSource.js

@@ -24,7 +24,6 @@ class MockBotsDataSource {
       }catch(err){
         reject(err);
       }
-      
     })
   }
   
@@ -64,7 +63,7 @@ class MockBotsDataSource {
       }
     }
     catch(err) {
-      console.error("Error is:", err);
+      winston.error("(MockBotsDataSource) Error getByIntentDisplayName: ", err);
     }
     return intent;
   }

package/index.js

@@ -6,13 +6,11 @@ const { TiledeskClient } = require('@tiledesk/tiledesk-client');
 const { ExtApi } = require('./ExtApi.js');
 const { ExtUtil } = require('./ExtUtil.js');
 const { TdCache } = require('./TdCache.js');
-const { TiledeskChatbot } = require('./models/TiledeskChatbot.js');
-const { MongodbBotsDataSource } = require('./models/MongodbBotsDataSource.js');
-// const { MongodbIntentsMachine } = require('./models/MongodbIntentsMachine.js');
-// const { TiledeskIntentsMachine } = require('./models/TiledeskIntentsMachine.js');
-const { MockBotsDataSource } = require('./models/MockBotsDataSource.js');
-const { TiledeskChatbotConst } = require('./models/TiledeskChatbotConst');
-const { IntentsMachineFactory } = require('./models/IntentsMachineFactory');
+const { TiledeskChatbot } = require('./engine/TiledeskChatbot.js');
+const { MongodbBotsDataSource } = require('./engine/MongodbBotsDataSource.js');
+const { MockBotsDataSource } = require('./engine/mock/MockBotsDataSource.js');
+const { TiledeskChatbotConst } = require('./engine/TiledeskChatbotConst.js');
+const { IntentsMachineFactory } = require('./engine/IntentsMachineFactory.js');
 const { v4: uuidv4 } = require('uuid');
 let axios = require('axios');
 // let parser = require('accept-language-parser');
@@ -33,8 +31,11 @@ const { DirectivesChatbotPlug } = require('./tiledeskChatbotPlugs/DirectivesChat
 // THE IMPORT
 let mongoose = require('mongoose');
 // const { Directives } = require('./tiledeskChatbotPlugs/directives/Directives.js');
-const { TiledeskChatbotUtil } = require('./models/TiledeskChatbotUtil.js'); //require('@tiledesk/tiledesk-chatbot-util');
-const AiService = require('./TiledeskServices/AIService.js');
+const { TiledeskChatbotUtil } = require('./utils/TiledeskChatbotUtil.js'); //require('@tiledesk/tiledesk-chatbot-util');
+
+const AiService = require('./services/AIService.js');
+const tilebotService = require('./services/TilebotService.js');
+
 let API_ENDPOINT = null;
 let TILEBOT_ENDPOINT = null;
 let staticBots;
@@ -51,7 +52,6 @@ router.post('/ext/:botid', async (req, res) => {
   }
   winston.verbose("(tybotRoute) Request Body: ", req.body);
 
-  
   const message = req.body.payload;
   const messageId = message._id;
   //const faq_kb = req.body.hook; now it is "bot"
@@ -75,7 +75,7 @@ router.post('/ext/:botid', async (req, res) => {
   let isAudio = TiledeskChatbotUtil.isAudioMessage(message)
   if(isAudio){
     let responseText = await aiService.speechToText(message.metadata.src).catch(err => {
-      if(log) console.log('(index.js) aiService.speechToText error: ', err)
+      winston.error('(index.js) aiService.speechToText error: ', err)
     })
     if(responseText && responseText.text)
       message.text = responseText.text
@@ -113,20 +113,8 @@ router.post('/ext/:botid', async (req, res) => {
     return;
   });
 
-  winston.debug("(tybotRoute) Bot found:" + bot)
-  // let bot = null;
-  // try {
-  //   // bot = await botsDS.getBotById(botId);
-  //   // bot = await botById(botId, projectId, tdcache, botsDS);
-  //   bot = await botsDS.getBotByIdCache(botId, tdcache);
-  //   // console.log("getBotByIdCache ---> bot: ", JSON.stringify(bot, null, 2))
-  // }
-  // catch(error) {
-  //   console.error("Error getting botId:", botId);
-  //   console.error("Error getting bot was:", error);
-  //   return;
-  // }
-  // if (log) {console.log("bot found:", JSON.stringify(bot));}
+  winston.debug("(tybotRoute) Bot found: ", bot)
+  
   
   let intentsMachine;
   let backupMachine;
@@ -171,7 +159,7 @@ router.post('/ext/:botid', async (req, res) => {
     return;
   }
   if (!reply) {
-    if (log) { console.log("(tybotRoute) No reply. Stop flow.") }
+    winston.verbose("(tybotRoute) No reply. Stop flow.")
     return;
   }
   
@@ -449,84 +437,45 @@ router.post('/block/:project_id/:bot_id/:block_id', async (req, res) => {
   }
 
   if (async) {
-    console.log("Async webhook");
-    sendMessageToBot(TILEBOT_ENDPOINT, message, bot_id, (err, resbody) => {
+    winston.verbose("Async webhook");
+    tilebotService.sendMessageToBot(message, bot_id, (err, resbody) => {
       if (err) {
-        console.error("Async err:\n", err);
+        winston.error("Async webhook err:\n", err);
         return res.status(500).send({ success: false, error: err });
       }
       return res.status(200).send({ success: true });
     })
   } else {
     
-    console.log("Sync webhook. Subscribe and await for reply...")
+    winston.verbose("Sync webhook. Subscribe and await for reply...")
     const topic = `/webhooks/${request_id}`;
     
     try {
 
       const listener = async (message, topic) => {
-        console.log("Web response is: ", message, "for topic", topic);
+        winston.debug("Web response is: " + JSON.stringify(message) + " for topic " + topic);
         await tdcache.unsubscribe(topic, listener);
 
         let json = JSON.parse(message);
         let status = json.status ? json.status : 200;
-        console.log("Web response status: ", status);
+        winston.debug("Web response status: " + status);
 
         return res.status(status).send(json.payload);
       }
       await tdcache.subscribe(topic, listener);
 
     } catch(err) {
-      console.error("Error cache subscribe ", err);
+      winston.error("Error cache subscribe ", err);
       return res.status(500).send({ success: false, error: "Error during cache subscription"})
     }
 
-    sendMessageToBot(TILEBOT_ENDPOINT, message, bot_id, () => {
-      console.log("Sync webhook message sent: ", message);
+    tilebotService.sendMessageToBot(message, bot_id, () => {
+      winston.debug("Sync webhook message sent: ", message);
     })
   }
 
 });
 
-// draft webhook
-// router.post('/block/:project_id/:bot_id/:block_id', async (req, res) => {
-//   const project_id = req.params['project_id'];
-//   const bot_id = req.params['bot_id'];
-//   const block_id = req.params['block_id'];
-//   const body = req.body;
-//   if (this.log) {
-//     console.log("/block/ .heders:", JSON.stringify(req.headers));
-//     console.log("/block/ .body:", JSON.stringify(body));
-//   }
-  
-//   // console.log('/block/:project_id/:bot_id/:block_id:', project_id, "/", bot_id, "/", block_id);
-//   // console.log('/block/:project_id/:bot_id/:block_id.body', body);
-  
-//   // invoke block
-//   // unique ID for each execution
-//   const execution_id = uuidv4().replace(/-/g, '');
-//   const request_id = "automation-request-" + project_id + "-" + execution_id;
-//   const command = "/" + block_id;
-//   let request = {
-//     "payload": {
-//       "recipient": request_id,
-//       "text": command,
-//       "id_project": project_id,
-//       "request": {
-//         "request_id": request_id
-//       },
-//       "attributes": {
-//         "payload": body
-//       }
-//     },
-//     "token": "NO-TOKEN"
-//   }
-//   if (this.log) {console.log("sendMessageToBot()...", JSON.stringify(request));}
-//   sendMessageToBot(TILEBOT_ENDPOINT, request, bot_id, async () => {
-//     res.status(200).send({"success":true});
-//     return;
-//   });
-// });
 
 async function startApp(settings, completionCallback) {
   winston.info("(Tilebot) Starting Tilebot..")
@@ -649,43 +598,6 @@ async function checkRequest(request_id, id_project) {
   // WARNING! Move this function in models/TiledeskChatbotUtil.js
 }
 
-/**
- * A stub to send message to the "ext/botId" endpoint, hosted by tilebot on:
- * /${TILEBOT_ROUTE}/ext/${botId}
- *
- * @param {Object} message. The message to send
- * @param {string} botId. Tiledesk botId
- * @param {string} token. User token
- */
-function sendMessageToBot(TILEBOT_ENDPOINT, message, botId, callback) {
-   
-  const url = `${TILEBOT_ENDPOINT}/ext/${botId}`;
-  winston.verbose("sendMessageToBot URL" + url);
-  const HTTPREQUEST = {
-    url: url,
-    headers: {
-      'Content-Type': 'application/json'
-    },
-    json: message,
-    method: 'POST'
-  };
-  myrequest(
-    HTTPREQUEST,
-    function (err, resbody) {
-      if (err) {
-        if (callback) {
-          callback(err);
-        }
-      }
-      else {
-        if (callback) {
-          callback(null, resbody);
-        }
-      }
-    }, false
-  );
-}
-
 function myrequest(options, callback, log) {
   winston.verbose("(tybotRoute) myrequest API URL:" + options.url);
   winston.debug("(tybotRoute) myrequest Options:", options);