@tiledesk/tiledesk-tybot-connector 0.1.27 → 0.1.28

package/.env

@@ -0,0 +1,11 @@
+API_ENDPOINT=http://localhost:10002
+mongoUrl=mongodb://tiledesk-user1:YB62b7gQNGg3G9OW@tiledesk-prod-shard-00-00-vmvst.mongodb.net:27017,tiledesk-prod-shard-00-01-vmvst.mongodb.net:27017,tiledesk-prod-shard-00-02-vmvst.mongodb.net:27017/tiledesk-pre?ssl=true&replicaSet=tiledesk-prod-shard-0&authSource=admin&retryWrites=true
+REDIS_HOST=redis-17533.c135.eu-central-1-1.ec2.cloud.redislabs.com
+REDIS_PASSWORD=ZSKKrWfnR6o5Gkt17ZgPkKGu1DcrUTge
+REDIS_PORT=17533
+TYBOT_ENDPOINT=http://localhost:10001
+CHATBOT_TOKEN=JWT eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ3ZWJob29rX2VuYWJsZWQiOmZhbHNlLCJ0eXBlIjoiZXh0ZXJuYWwiLCJsYW5ndWFnZSI6ImVuIiwicHVibGljIjpmYWxzZSwiX2lkIjoiNjM4Yzc5MDQxZGI0NDkwMDM1MTEwMjYwIiwibmFtZSI6IlRoZSBGb3JtIHYyIC0gZXh0IiwidXJsIjoiaHR0cHM6Ly90aWxlYm90LWRldi5oZXJva3VhcHAuY29tL2V4dC82MzhjNzhkNzFkYjQ0OTAwMzUxMTAxYzIiLCJpZF9wcm9qZWN0IjoiNjM4Yzc4YTYxZGI0NDkwMDM1MTBmZjkxIiwidHJhc2hlZCI6ZmFsc2UsImNyZWF0ZWRCeSI6IjVlMDlkMTZkNGQzNjExMDAxNzUwNmQ3ZiIsImNyZWF0ZWRBdCI6IjIwMjItMTItMDRUMTA6NDA6MDQuMjA3WiIsInVwZGF0ZWRBdCI6IjIwMjItMTItMDVUMDc6MjE6MDIuOTIxWiIsIl9fdiI6MCwiZGVzY3JpcHRpb24iOiJPbiBIZXJva3UiLCJpYXQiOjE2NzA2NzE4ODksImF1ZCI6Imh0dHBzOi8vdGlsZWRlc2suY29tL2JvdHMvNjM4Yzc5MDQxZGI0NDkwMDM1MTEwMjYwIiwiaXNzIjoiaHR0cHM6Ly90aWxlZGVzay5jb20iLCJzdWIiOiJib3QiLCJqdGkiOiJmNDVlZGIwYS0zNzVhLTQ0NjMtYjFhZi1jM2ZiZDg4YmE3ZGQifQ.FbW3csHl1sQgSyRz5Jg0qaTvvpXWXgWHlJ1JWoVbv3s
+CHATBOT_ENDPOINT=http://localhost:10001
+_API_LOG=1
+TEST_PROJECT_ID=638c78a61db449003510ff91
+TEST_BOT_ID=638c78d71db44900351101c2

package/CHANGELOG.md

@@ -5,6 +5,11 @@
 available on:
  ▶️ https://www.npmjs.com/package/@tiledesk/tiledesk-tybot-connector
 
+### 0.1.28 - online
+- Added a 'serious' integration test for chatbot
+- Removed reference to requestId and depId from processInlineDirectives()
+- Added id_project to the 'minimum' request object used in directives not accessing Tiledesk APIs
+
 ### 0.1.27 - online
 - log fix
 

package/index.js

@@ -149,26 +149,48 @@ router.post('/ext/:projectId/requests/:requestId/messages', async (req, res) =>
     APIKEY: "___",
     log: false
   });
-  
   let request;
   const request_key = "tilebot:" + requestId;
+  if (log) {console.log("request_key:", request_key);}
   if (tdcache) {
     request = await tdcache.getJSON(request_key)
-    if (log) {console.log("HIT! Request from cache:", request.request_id);}
+    if (log) {console.log("Request from cache:", request);}
     if (!request) {
       if (log) {console.log("!Request from cache", requestId);}
-      request = await tdclient.getRequestById(requestId);
+      try {
+        request = await tdclient.getRequestById(requestId);
+      }
+      catch(err) {
+        console.error("Error getting the request:", err)
+      }
       if (log) {console.log("Got request with APIs (after no cache hit)");}
     }
   }
   else {
     if (log) {console.log("No tdcache. Getting request with APIs", requestId);}
-    request = await tdclient.getRequestById(requestId);
+    try {
+      request = await tdclient.getRequestById(requestId);
+    }
+    catch(err) {
+      console.log("Request not found.");
+    }
     if (log) {console.log("(No tdcache) Got request with APIs");}
   }
+  if (!request) {
+    // chatbot-pure directives still work. Tiledesk specific directives don't
+    request = {
+      request_id: requestId,
+      id_project: projectId
+    }
+  }
+  else {
+    if (log) {console.log("request", request);}
+  }
+  if (log) {console.log("request...", request);}
   let directivesPlug = new DirectivesChatbotPlug({supportRequest: request, TILEDESK_API_ENDPOINT: APIURL, TILEBOT_ENDPOINT:process.env.TYBOT_ENDPOINT, token: token, log: log, HELP_CENTER_API_ENDPOINT: process.env.HELP_CENTER_API_ENDPOINT, cache: tdcache});
   // PIPELINE-EXT
   const bot_answer = await ExtUtil.execPipelineExt(request, answer, directivesPlug, tdcache, log);
+  // console.log("bot_answer", bot_answer)
   //const bot_answer = answer;
   // console.log("bot_answer to send:", bot_answer);
   // empty answer
@@ -193,6 +215,7 @@ router.post('/ext/:projectId/requests/:requestId/messages', async (req, res) =>
   //      triggeredByMessageId: '6392e5e8408e0000437aa383'
   //    }
   if (bot_answer) {
+    bot_answer["_raw_message"] = answer.text;
     tdclient.sendSupportMessage(requestId, bot_answer, (err, response) => {
       if (err) {
         console.error("Error sending message", err);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tiledesk/tiledesk-tybot-connector",
-  "version": "0.1.27",
+  "version": "0.1.28",
   "description": "Tiledesk Tybot connector",
   "main": "index.js",
   "scripts": {
@@ -14,7 +14,7 @@
     "@tiledesk/helpcenter-query-client": "^0.1.8",
     "@tiledesk/tiledesk-chatbot-client": "^0.5.30",
     "@tiledesk/tiledesk-chatbot-util": "^0.8.38",
-    "@tiledesk/tiledesk-client": "^0.8.39",
+    "@tiledesk/tiledesk-client": "^0.8.41",
     "axios": "^0.27.2",
     "body-parser": "^1.19.0",
     "cors": "^2.8.5",
@@ -24,6 +24,7 @@
     "mongoose": "^6.3.5",
     "nanoid": "^3.1.25",
     "redis": "^3.1.2",
-    "uuid": "^3.3.3"
+    "uuid": "^3.3.3",
+    "dotenv": "^16.0.3"
   }
 }

package/test/conversation1-test.js

@@ -0,0 +1,277 @@
+var assert = require('assert');
+let axios = require('axios');
+const tybot = require("../");
+const tybotRoute = tybot.router;
+var express = require('express');
+var app = express();
+app.use("/", tybotRoute);
+require('dotenv').config();
+const bodyParser = require('body-parser');
+
+const REQUEST_ID = "support-group-" + process.env.TEST_PROJECT_ID + "-" + Date.now();
+console.log("REQUEST_ID:", REQUEST_ID);
+let app_listener;
+
+before( () => {
+    return new Promise( async (resolve, reject) => {
+      console.log("Starting tilebot server...");
+      tybot.startApp(
+        {
+          MONGODB_URI: process.env.mongoUrl,
+          API_ENDPOINT: process.env.API_ENDPOINT,
+          REDIS_HOST: process.env.REDIS_HOST,
+          REDIS_PORT: process.env.REDIS_PORT,
+          REDIS_PASSWORD: process.env.REDIS_PASSWORD,
+          log: process.env.API_LOG
+        }, () => {
+          console.log("Tilebot route successfully started.");
+          var port = process.env.PORT || 10001;
+          app_listener = app.listen(port, () => {
+            console.log('Tilebot connector listening on port ', port);
+            resolve();
+          //   var listener = endpointServer.listen(10002, '0.0.0.0', function () {
+          //     console.log('endpointServer started', listener.address());
+          //     resolve();
+          //   });
+          });
+      });
+    })
+});
+
+after(function(done) {
+  app_listener.close( () => {
+    console.log('app_listener closed.');
+    done();
+  });
+});
+
+describe('Conversation1', async() => {
+    
+    it('/start', (done) => {
+      console.log("/start...ing story...");
+      let listener;
+      let endpointServer = express();
+      endpointServer.use(bodyParser.json());
+      endpointServer.post('/:projectId/requests/:requestId/messages', function (req, res) {
+        // console.log("req.body:", JSON.stringify(req.body));
+        res.send({success: true});
+        const message = req.body;
+        assert(message.text === "Hello");
+        assert(message.attributes.commands !== null);
+        assert(message.attributes.commands.length === 3);
+        const command1 = message.attributes.commands[0];
+        const command2 = message.attributes.commands[1];
+        const command3 = message.attributes.commands[2];
+        
+        assert(command1.type === "message");
+        assert(command1.message.text === "");
+        assert(command1.message.type === "image");
+        assert(command1.message.metadata.src !== null);
+        
+        assert(command2.type === "wait");
+        assert(command2.time === 500);
+
+        listener.close( () => {
+          // console.log('closed.');
+          done();
+        });
+        
+      });
+      
+      listener = endpointServer.listen(10002, '0.0.0.0', function () {
+        // console.log('endpointServer started', listener.address());
+      });
+      
+      const botId = process.env.TEST_BOT_ID;
+      // console.log("botId:", botId);
+      let request = {
+        "payload": {
+          "_id": "ID",
+          "senderFullname": "guest#367e",
+          "type": "text",
+          "sender": "A-SENDER",
+          "recipient": REQUEST_ID,
+          "text": "/start",
+          "id_project": process.env.TEST_PROJECT_ID,
+          "metadata": "",
+          "request": {
+            "request_id": REQUEST_ID
+          }
+        },
+        "token": process.env.CHATBOT_TOKEN
+      }
+      sendMessageToBot(request, botId, process.env.CHATBOT_TOKEN, () => {
+        // console.log("Message sent.");
+      });
+    });
+    
+    it('/disable_input', (done) => {
+      console.log("/disable_input...");
+      let listener;
+      let endpointServer = express();
+      endpointServer.use(bodyParser.json());
+      endpointServer.post('/:projectId/requests/:requestId/messages', function (req, res) {
+        // console.log("req.body:", JSON.stringify(req.body));
+        res.send({success: true});
+        const message = req.body;
+
+        assert(message["text"] !== "");
+        assert(message["attributes"] !== "");
+        assert(message["attributes"]["disableInputMessage"] === true);
+        
+        listener.close( () => {
+          // console.log('closed.');
+          done();
+        });
+        
+      });
+      
+      listener = endpointServer.listen(10002, '0.0.0.0', function () {
+        // console.log('endpointServer started', listener.address());
+        const botId = process.env.TEST_BOT_ID;
+        const PROJECT_ID = process.env.TEST_PROJECT_ID;
+        console.log("botId:", botId);
+        console.log("REQUEST_ID:", REQUEST_ID);
+        let request = {
+          "payload": {
+            "_id": "ID",
+            "senderFullname": "guest#367e",
+            "type": "text",
+            "sender": "A-SENDER",
+            "recipient": REQUEST_ID,
+            "text": "/disable_input",
+            "id_project": PROJECT_ID,
+            "metadata": "",
+            "request": {
+              "request_id": REQUEST_ID,
+              "id_project": PROJECT_ID
+            }
+          },
+          "token": process.env.CHATBOT_TOKEN
+        }
+        sendMessageToBot(request, botId, process.env.CHATBOT_TOKEN, () => {
+          // console.log("Message sent.");
+        });
+      });
+    });
+
+});
+
+// function createRequest(projectId, callback) {
+
+//   const tdclient = new TiledeskClient({
+//     APIKEY: "___",
+//     APIURL: "",
+//     projectId: projectId,
+//     token: ANONYM_USER_TOKEN,
+//     log: false
+// });
+// if (tdclient) {
+//     assert(tdclient != null);
+//     const text_value = 'test message';
+//     const request_id = TiledeskClient.newRequestId(PROJECT_ID);
+//     tdclient.sendSupportMessage(request_id, {text: text_value}, function(err, result) {
+//         assert(err === null);
+//         assert(result != null);
+//         assert(result.text === text_value);
+//         done();
+//     });
+// }
+// else {
+//     assert.ok(false);
+// }
+// }
+
+// function createAnonyUser(projecId, callback) {
+//   TiledeskClient.anonymousAuthentication(
+//     projecId,
+//     "_",
+//     {
+//         APIURL: API_ENDPOINT,
+//         log: false
+//     },
+//     function(err, result) {
+//         if (!err && result) {
+//             callback(result.token)
+//         }
+//         else {
+//           callback(null);
+//         }
+//     }
+//   );
+// }
+
+/**
+ * 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(message, botId, token, callback) {
+  // const jwt_token = this.fixToken(token);
+  const url = `${process.env.CHATBOT_ENDPOINT}/ext/${botId}`;
+  // console.log("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);
+        }
+      }
+    }, true
+  );
+}
+
+function myrequest(options, callback, log) {
+  if (this.log) {
+    console.log("API URL:", options.url);
+    console.log("** Options:", options);
+  }
+  axios(
+    {
+      url: options.url,
+      method: options.method,
+      data: options.json,
+      params: options.params,
+      headers: options.headers
+    })
+  .then((res) => {
+    if (this.log) {
+      console.log("Response for url:", options.url);
+      console.log("Response headers:\n", res.headers);
+      //console.log("******** Response for url:", 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) => {
+    console.error("An error occurred:", error);
+    if (callback) {
+      callback(error, null, null);
+    }
+  });
+}

package/test/single_test.sh

@@ -1,4 +1,5 @@
 #npx mocha ./test/*.js --grep "_test 17_" --timeout 10000 --exit
 #npx mocha ./test/mock_query_test.js
 #npx mocha ./test/disable_input_text_directive_test.js
-npx mocha ./test/close_directive_test.js
+#npx mocha ./test/close_directive_test.js
+npx mocha ./test/conversation1-test.js --exit

package/tiledeskChatbotPlugs/DirectivesChatbotPlug.js

@@ -83,8 +83,10 @@ class DirectivesChatbotPlug {
     const TILEBOT_ENDPOINT = this.TILEBOT_ENDPOINT;
 
     const requestId = supportRequest.request_id
-    const depId = supportRequest.department._id;
-    //const depId = supportRequest.attributes.departmentId;
+    let depId;
+    if (supportRequest.department && supportRequest.department._id) {
+      depId = supportRequest.department._id;
+    }
     const projectId = supportRequest.id_project;
     const tdcache = this.tdcache;
     //console.log("TDCACHE:", this.tdcache, tdcache)
@@ -204,11 +206,17 @@ class DirectivesChatbotPlug {
         });
       }
       else if (directive_name === Directives.AGENT) {
-        const agentDir = new DirMoveToAgent(tdclient);
-        directive.whenOnlineOnly = false;
-        agentDir.execute(directive, requestId, depId, () => {
+        if (depId) {
+          const agentDir = new DirMoveToAgent(tdclient);
+          directive.whenOnlineOnly = false;
+          agentDir.execute(directive, requestId, depId, () => {
+            process(nextDirective());
+          });  
+        }
+        else {
+          console.log("Warning. DepId null while calling 'AGENT' directive")
           process(nextDirective());
-        });
+        }
       }
       else if (directive_name === Directives.CLOSE) {
         const closeDir = new DirClose({tdclient: tdclient});
@@ -217,11 +225,17 @@ class DirectivesChatbotPlug {
         });
       }
       else if (directive_name === Directives.WHEN_ONLINE_MOVE_TO_AGENT) {
-        const agentDir = new DirMoveToAgent(tdclient);
-        directive.whenOnlineOnly = true;
-        agentDir.execute(directive, requestId, depId, () => {
+        if (depId) {
+          const agentDir = new DirMoveToAgent(tdclient);
+          directive.whenOnlineOnly = true;
+          agentDir.execute(directive, requestId, depId, () => {
+            process(nextDirective());
+          });
+        }
+        else {
+          console.log("Warning. DepId null while calling 'WHEN_ONLINE_MOVE_TO_AGENT' directive")
           process(nextDirective());
-        });
+        }
       }
       else if (directive_name === Directives.REMOVE_CURRENT_BOT) {
         tdclient.removeCurrentBot(requestId, (err) => {
@@ -276,11 +290,11 @@ class DirectivesChatbotPlug {
     const supportRequest = this.supportRequest;
     const token = this.token;
     const API_URL = this.API_URL;
-
-    //console.log("supportRequest", supportRequest)
-    const requestId = supportRequest.request_id
-    const depId = supportRequest.department._id;
-    //const depId = supportRequest.attributes.departmentId;
+    // const requestId = supportRequest.request_id
+    // let depId;
+    // if (supportRequest.department && supportRequest.department._id) {
+    //   depId = supportRequest.department._id;
+    // }
     const projectId = supportRequest.id_project;
     const tdclient = new TiledeskClient({
       projectId: projectId,
@@ -289,7 +303,6 @@ class DirectivesChatbotPlug {
       APIKEY: "___",
       log: false
     });
-
     let i = -1;
     if (this.log) { console.log("processing Inline directives:", directives); }
     const process = (directive) => {