@tiledesk/tiledesk-server 2.3.23 → 2.3.24

package/CHANGELOG.md

@@ -1,6 +1,25 @@
 
 
+💥 TILEDESK SERVER v2.3.23 💥
+🚀        TAGGED AND PUBLISHED ON NPM           🚀
+🚀        IN PRODUCTION                        🚀
+(https://www.npmjs.com/package/@tiledesk/tiledesk-server/v/2.3.17) 
+
+# 2.3.23 -> PROD
+- cacheEnabler + trigger cache + subscription cache
+- project cache with cacheEnabler
+- request cache with cacheEnabler
+- Updated dependency @tiledesk/tiledesk-tybot-connector to 0.1.10
+- Added trigger and subscription cache invalidation rules
+
+# 2.3.22
+- added cacheoose dep package.json
+- Updated dependency @tiledesk/tiledesk-tybot-connector to 0.1.8
+
 # 2.3.21
+- log fix
+- Updated dependency @tiledesk/tiledesk-tybot-connector to 0.1.7
+- Moved cache module to public module
 - filter request by smartAssignment
 
 # 2.3.20
@@ -11,14 +30,13 @@
 - Moved route-queue to public module
 - Disable queue module if JOB_WORKER_ENABLED is true
 
+# 2.3.18.2
+- logfix
 
+# 2.3.18.1 
+- Updated dependency @tiledesk/tiledesk-tybot-connector to 0.1.10
 
-💥 TILEDESK SERVER v2.3.18 💥
-🚀        TAGGED AND PUBLISHED ON NPM           🚀
-🚀        IN PRODUCTION                        🚀
-(https://www.npmjs.com/package/@tiledesk/tiledesk-server/v/2.3.17) 
-
-# 2.3.18 -> PROD
+# 2.3.18
 - Added profileStatus field to the project_user model
 - Added smartAssignment field to the request model                      
 - Canned responses default limit value increased from 40 to 1000

package/app.js

@@ -142,8 +142,7 @@ botSubscriptionNotifier.start();
 
 
 var geoService = require('./services/geoService');
-geoService.listen();
-
+ geoService.listen();
 
 
 
@@ -323,7 +322,7 @@ var projectSetter = function (req, res, next) {
   if (projectid) {
     
     let q =  Project.findOne({_id: projectid, status: 100});
-    if (cacheEnabler.trigger) {
+    if (cacheEnabler.project) {
       q.cache(cacheUtil.defaultTTL, "projects:id:"+projectid)  //project_cache
       winston.debug('project cache enabled');
     }

package/channels/chat21/chat21WebHook.js

@@ -9,6 +9,8 @@ var Project_user = require("../../models/project_user");
 var RequestConstants = require("../../models/requestConstants");
 
 var cacheUtil = require('../../utils/cacheUtil');
+var cacheEnabler = require("../../services/cacheEnabler");
+
 
 var mongoose = require('mongoose');
 var winston = require('../../config/winston');
@@ -73,11 +75,17 @@ router.post('/', function (req, res) {
     winston.debug("Chat21 message", message);
 
         // requestcachefarequi nocachepopulatereqired        
-        return Request.findOne({request_id: message.recipient}) 
+        let q = Request.findOne({request_id: message.recipient}) 
+
+        if (cacheEnabler.request) {
+          q.cache(cacheUtil.defaultTTL, "requests:request_id:"+message.recipient+":simple"); //request_cache
+                                                                                            // project_id not available
+          winston.debug('request cache enabled');
+        }
+        return q.exec(function(err, request) {
+
         // before request_id id_project unique - commented
-        // return Request.findOne({request_id: message.recipient, id_project: projectid})      
-          // .cache(cacheUtil.defaultTTL, req.projectid+":requests:request_id:"+requestid) project_id not available
-          .exec(function(err, request) {
+               
 
           if (err) {
             return res.status(500).send({success: false, msg: 'Error getting the request.', err:err});
@@ -202,7 +210,7 @@ router.post('/', function (req, res) {
                       }
 
 
-                     
+                    
 
                       
                       var new_request = {
@@ -210,7 +218,7 @@ router.post('/', function (req, res) {
                         departmentid:departmentid, sourcePage:sourcePage, language:language, userAgent:client, status:requestStatus, createdBy: undefined,
                         attributes:rAttributes, subject:undefined, preflight:false, channel:undefined, location:undefined,
                         lead:createdLead, requester:project_user
-                       
+                        
                       };
     
                       winston.debug("new_request", new_request);
@@ -379,10 +387,10 @@ router.post('/', function (req, res) {
               winston.debug('query:'+ projectId);
               
               let q = Request.findOne(query);
-              if (cacheEnabler.trigger) {
-                q.cache(cacheUtil.defaultTTL, projectId+":requests:request_id:"+recipient_id); //request_cache
-                winston.debug('project cache enabled');
-              }
+              // if (cacheEnabler.request) {
+              //   q.cache(cacheUtil.defaultTTL, projectId+":requests:request_id:"+recipient_id+":simple"); //request_cache NOT IMPORTANT HERE
+              //   winston.debug('project cache enabled');
+              // }
               return q.exec(function(err, request) {
 
                 if (err) {
@@ -465,7 +473,7 @@ router.post('/', function (req, res) {
       
       // requestcachefarequi populaterequired
       return Request.findOne({request_id: request_id, id_project: id_project})
-          .populate('lead') //TODO posso prenderlo da snapshot senza populate
+          .populate('lead') //TODO posso prenderlo da snapshot senza populate cache_attention
           .exec(function(err, request) {
         if (err){
           winston.error(err);
@@ -632,7 +640,7 @@ else if (req.body.event_type == "typing-start") {
   // requestcachefarequi nocachepopulatereqired
   return Request.findOne({request_id: recipient_id})
                              //TOD  errore cache sistemare e riabbilitare->
-  // .cache(cacheUtil.defaultTTL, req.projectid+":requests:request_id:"+recipient_id)
+  // .cache(cacheUtil.defaultTTL, req.projectid+":requests:request_id:"+recipient_id)   cache_attention
   .exec(function(err, request) {
   if (err){
     winston.error(err);

package/event/messageEvent.js

@@ -34,14 +34,18 @@ function emitCompleteMessage(message) {
 }
 
 messageEvent.on('message.create', emitCompleteMessage);
-messageEvent.on('message.update', emitCompleteMessage);
+
+// messageEvent.on('message.update.simple', emitCompleteMessage);     //if populateMessageUpdate is disabled then you must forward message.update event from message.update.simple
+messageEvent.on('message.update', emitCompleteMessage);         // i must restore populateMessageWithRequest. see below
 
 function populateMessageCreate(message) {
   return populateMessageWithRequest(message, 'message.create');
 }
 function populateMessageUpdate(message) {
-  // return populateMessageWithRequest(message, 'message.update');
-  return; // do not populate message.update it's not used by anyone. Not used by webhook. populate for message.update is slow.
+  return populateMessageWithRequest(message, 'message.update');
+  // return; // do not populate message.update it's not used by anyone. 
+        ///it is used by \agent interceptor. Without populateMessageWithRequest \agent sent by bot doesn't work. i must restore populateMessageWithRequest
+          //  Not used by webhook. populate for message.update is slow.
 }
 
 
@@ -70,8 +74,7 @@ function populateMessageWithRequest(message, eventPrefix) {
   // request.department._id DA CORREGGERE ANCHE PER REQUEST.CREATE
   // request.department.hasBot 
   // request.isOpen
-
-
+  winston.info('message Event populate');
   if (cacheEnabler.request) {
     q.cache(cacheUtil.defaultTTL, message.id_project+":requests:request_id:"+message.recipient) //request_cache ma con lean????attento metti a parte
     winston.debug('request cache enabled');
@@ -83,6 +86,9 @@ function populateMessageWithRequest(message, eventPrefix) {
       return messageEvent.emit(eventPrefix, message);
     }
 
+    winston.debug('message Event populate after query');
+
+
   if (request) {
       winston.debug("request is defined in messageEvent",request );
       
@@ -91,9 +97,14 @@ function populateMessageWithRequest(message, eventPrefix) {
     
       if (request.department && request.department.id_bot) {
         // if (request.department) {
-        Faq_kb.findById(request.department.id_bot)
-        //@DISABLED_CACHE .cache(cacheUtil.defaultTTL, message.id_project+":faq_kbs:id:"+request.department.id_bot)
-        .exec(function(err, bot) {
+        let qbot = Faq_kb.findById(request.department.id_bot)
+
+        if (cacheEnabler.faq_kb) {
+          qbot.cache(cacheUtil.defaultTTL, message.id_project+":faq_kbs:id:"+request.department.id_bot)
+          winston.debug('faq_kb cache enabled');
+        }
+
+        qbot.exec(function(err, bot) {
           winston.debug('bot', bot);
           requestJson.department.bot = bot
           
@@ -169,10 +180,12 @@ messageEvent.on('message.update.simple', populateMessageUpdate);
 
 
 
-// riattiva commentato per performance
+// // riattiva commentato per performance
+
 // // spostare su classe
 
 
+
 // var messageCreateKey = 'message.create';
 // if (messageEvent.queueEnabled) {
 //   messageCreateKey = 'message.create.queue';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tiledesk/tiledesk-server",
   "description": "The Tiledesk server module",
-  "version": "2.3.23",
+  "version": "2.3.24",
   "scripts": {
     "start": "node ./bin/www",
     "pretest": "mongodb-runner start",
@@ -41,7 +41,7 @@
     "@tiledesk/tiledesk-chatbot-util": "^0.8.33",
     "@tiledesk/tiledesk-json-rules-engine": "^4.0.3",
     "@tiledesk/tiledesk-rasa-connector": "^1.0.10",
-    "@tiledesk/tiledesk-tybot-connector": "^0.1.10",
+    "@tiledesk/tiledesk-tybot-connector": "^0.1.14",
     "app-root-path": "^3.0.0",
     "bcrypt-nodejs": "0.0.3",
     "body-parser": "^1.20.0",

package/pubmodules/cache/mongoose-cachegoose-fn.js

@@ -203,6 +203,35 @@
 
 
 
+    requestEvent.on("request.create.simple", function(request) {
+        setImmediate(() => {
+            var key = request.id_project+":requests:id:"+request.id+":simple";
+            winston.verbose("Creating cache for request.create.simple with key: " + key);
+
+            client.set(key, request, defaultTTL, (err, reply) => {
+                winston.debug("Created cache for request.create.simple",reply);
+                winston.verbose("Created cache for request.create.simple",{err:err});
+            });
+
+
+            var key = "requests:id:"+request.request_id+":simple";  //without project for chat21 webhook
+            winston.verbose("Creating cache for request.create.simple with key: " + key);
+
+            client.set(key, request, defaultTTL, (err, reply) => {
+                winston.debug("Created cache for request.create.simple",reply);
+                winston.verbose("Created cache for request.create.simple",{err:err});
+            });
+
+            var key = request.id_project+":requests:request_id:"+request.request_id+":simple";
+            winston.verbose("Creating cache for request.create.simple with key: " + key);
+            client.set(key, request, defaultTTL, (err, reply) => {
+                winston.debug("Created cache for request.create.simple",reply);
+                winston.verbose("Created cache for request.create.simple",{err:err});
+            });
+
+        })
+    });
+
     requestEvent.on("request.create", function(request) {
         setImmediate(() => {
             var key = request.id_project+":requests:id:"+request.id;

package/pubmodules/messageTransformer/messageTransformerInterceptor.js

@@ -45,7 +45,7 @@ class MessageTransformerInterceptor {
                     // populate({path:'requester',populate:{path:'id_user'}}).
                     
                 if (cacheEnabler.request) {
-                    q.cache(cacheUtil.defaultTTL, message.id_project+":requests:request_id:"+message.recipient) //request_cache nocachepopulatereqired
+                    q.cache(cacheUtil.defaultTTL, message.id_project+":requests:request_id:"+message.recipient+":simple") //request_cache nocachepopulatereqired
                     winston.debug('request cache enabled');
                 }
 

package/routes/message.js

@@ -53,7 +53,7 @@ async (req, res)  => {
     return res.status(422).json({ errors: errors.array() });
   }
   
-  
+
   var project_user = req.projectuser;
   var sender = req.body.sender;
   var fullname = req.body.senderFullname || req.user.fullName;
@@ -64,7 +64,7 @@ async (req, res)  => {
 
       let q = Request.findOne({request_id: req.params.request_id, id_project: req.projectid}); 
       if (cacheEnabler.request) {
-        q.cache(cacheUtil.defaultTTL, req.projectid+":requests:request_id:"+req.params.request_id) //request_cache
+        q.cache(cacheUtil.defaultTTL, req.projectid+":requests:request_id:"+req.params.request_id+":simple") //request_cache
         winston.debug('request cache enabled');
       }
       // cacherequest       // requestcachefarequi nocachepopulatereqired
@@ -295,6 +295,9 @@ async (req, res)  => {
 });
 
 
+
+
+
 // router.put('/:messageid', function(req, res) {
   
 //     console.log(req.body);

package/routes/project.js

@@ -451,7 +451,7 @@ Project.findByIdAndUpdate(req.params.projectid, { $pull: { bannedUsers: { "_id":
 router.get('/:projectid', [passport.authenticate(['basic', 'jwt'], { session: false }), validtoken, roleChecker.hasRoleOrTypes('agent', ['subscription'])], function (req, res) {
   winston.debug(req.body);
   let q = Project.findOne({_id: req.params.projectid, status:100});
-  if (cacheEnabler.trigger) {
+  if (cacheEnabler.project) {
     q.cache(cacheUtil.defaultTTL, "projects:id:"+req.params.projectid)  //project_cache
     winston.debug('project cache enabled');
   }

package/routes/request.js

@@ -1266,10 +1266,10 @@ router.get('/:requestid', function (req, res) {
   .populate('participatingAgents')  
   .populate({path:'requester',populate:{path:'id_user'}});
 
-  if (cacheEnabler.request) {
-    q.cache(cacheUtil.defaultTTL, "/"+req.projectid+"/requests/request_id/"+requestid) //request_cache
-    winston.debug('request cache enabled');
-  }
+  // if (cacheEnabler.request) {  cache disabled beacuse cacheoose don't support .populate without lean. here cache is not important
+  //   q.cache(cacheUtil.defaultTTL, req.projectid+":requests:request_id:"+requestid) //request_cache
+  //   winston.debug('request cache enabled');
+  // }
   // 
   //  .populate({path:'requester',populate:{path:'id_user', select:{'firstname':1, 'lastname':1}}})
   q.exec(function(err, request) {  

package/services/cacheEnabler.js

@@ -21,20 +21,26 @@ class CacheEnabler {
             this.request = false;
         }
 
-        this.project_user = true;
-        if (process.env.CACHE_PROJECT_USER_ENABLED=="false" || process.env.CACHE_PROJECT_USER_ENABLED==false) {
-            this.project_user = false;
+        this.faq_kb = true;
+        if (process.env.CACHE_FAQ_KB_ENABLED=="false" || process.env.CACHE_FAQ_KB_ENABLED==false) {
+            this.faq_kb = false;
         }
 
-        this.user = true;
-        if (process.env.CACHE_USER_ENABLED=="false" || process.env.CACHE_USER_ENABLED==false) {
-            this.user = false;
-        }
-
-        this.message = true;
-        if (process.env.CACHE_MESSAGE_ENABLED=="false" || process.env.CACHE_MESSAGE_ENABLED==false) {
-            this.message = false;
-        }
+        
+        // this.project_user = true;
+        // if (process.env.CACHE_PROJECT_USER_ENABLED=="false" || process.env.CACHE_PROJECT_USER_ENABLED==false) {
+        //     this.project_user = false;
+        // }
+
+        // this.user = true;
+        // if (process.env.CACHE_USER_ENABLED=="false" || process.env.CACHE_USER_ENABLED==false) {
+        //     this.user = false;
+        // }
+
+        // this.message = true;
+        // if (process.env.CACHE_MESSAGE_ENABLED=="false" || process.env.CACHE_MESSAGE_ENABLED==false) {
+        //     this.message = false;
+        // }
     }
 }
 

package/services/departmentService.js

@@ -8,6 +8,8 @@ var winston = require('../config/winston');
 const departmentEvent = require('../event/departmentEvent');
 const Request = require('../models/request');
 const RoleConstants = require ('../models/roleConstants')
+var cacheEnabler = require("../services/cacheEnabler");
+var cacheUtil = require("../utils/cacheUtil");
 
 class DepartmentService {
 
@@ -86,7 +88,7 @@ roundRobin(operatorSelectedEvent) {
 
       // let lastRequests = await 
       // requestcachefarequi nocachepopulatereqired
-      Request.find(query).sort({_id:-1}).limit(1).exec(function (err, lastRequests) {
+      Request.find(query).sort({_id:-1}).limit(1).exec(function (err, lastRequests) {  // cache_attention
           if (err) {
               winston.error('Error getting request for RoundRobinOperator', err); 
               return reject(err);
@@ -190,7 +192,12 @@ getOperators(departmentid, projectid, nobot, disableWebHookCall, context) {
        // console.log("»»» »»» --> DEPT ID ", departmentid);
 
 
-    return Project.findOne({_id: projectid, status: 100}, function(err, project) {
+    let q = Project.findOne({_id: projectid, status: 100})
+    if (cacheEnabler.project) {
+      q.cache(cacheUtil.defaultTTL, "projects:id:"+projectid)  //project_cache
+      winston.debug('project cache enabled');
+    }
+    return q.exec(function(err, project){
       if (err) {
         winston.error('Project findById ', err);
         return reject(err);
@@ -205,6 +212,7 @@ getOperators(departmentid, projectid, nobot, disableWebHookCall, context) {
       // TODO questo lo abiliterei solo esplicitamete se si flagga opzione su progetto per performance
       if (disableWebHookCall==undefined) {
               //if pro enabled disableWebHookCall = false
+                              //secondo me qui manca un parentesi tonda per gli or
         if (project.profile && (project.profile.type === 'free' && project.trialExpired === false) || (project.profile.type === 'payment' && project.isActiveSubscription === true)) {
           // winston.info('disableWebHookCall pro');
           disableWebHookCall = false;
@@ -389,6 +397,7 @@ getOperators(departmentid, projectid, nobot, disableWebHookCall, context) {
 
               let objectToReturn = { available_agents: _available_agents, agents: project_users, operators: selectedoperator, department: department, group: group, id_project: projectid, project: project,  context: context };
 
+              // var objectToReturnRoundRobin = objectToReturn;
               that.roundRobin(objectToReturn).then(function(objectToReturnRoundRobin){
 
                 winston.debug("context2",context);
@@ -450,6 +459,8 @@ getOperators(departmentid, projectid, nobot, disableWebHookCall, context) {
 
           let objectToReturn = { available_agents: _available_agents, agents: project_users, operators: selectedoperator, department: department, id_project: projectid, project: project, context: context };
 
+          // var objectToReturnRoundRobin = objectToReturn;
+
           that.roundRobin(objectToReturn).then(function(objectToReturnRoundRobin) {
             winston.debug("context2",context);
             departmentEvent.emit('operator.select.base1', {result:objectToReturnRoundRobin,  disableWebHookCall: disableWebHookCall, resolve: resolve, reject: reject, context: context});
@@ -543,8 +554,19 @@ getOperators(departmentid, projectid, nobot, disableWebHookCall, context) {
 
   // console.log('-- > OPERATORS [ getRandomAvailableOperator ] - PROJECT USER AVAILABLE LENGHT ', project_users_available.length);
   if (project_users_available.length > 0) {
+
+
+    // new
+                                  // num between 0 and 1 * es 3 -> 
+    // let randomIndex =  Math.round(Math.random() * project_users_available.length);
+    // // let randomIndex =  Math.floor(Math.random() * project_users_available.length);
+    
+    // console.log("randomIndex",randomIndex);
+    // var operator = project_users_available[randomIndex];
+    // // console.log('OPERATORS - SELECTED MEMBER ID', operator.id_user);
+
     var operator = project_users_available[Math.floor(Math.random() * project_users_available.length)];
-    // console.log('OPERATORS - SELECTED MEMBER ID', operator.id_user);
+
 
     return [{ id_user: operator.id_user }];
     // return [operator];

package/services/operatingHoursService.js

@@ -12,7 +12,7 @@ class OperatingHoursService {
 
     // winston.debug('O ---> [ OHS ] -> PROJECT ID ', projectId)
     let q = Project.findOne({_id: projectId, status: 100});
-    if (cacheEnabler.trigger) {
+    if (cacheEnabler.project) {
       q.cache(cacheUtil.defaultTTL, "projects:id:"+projectId)  //project_cache
       winston.debug('project cache enabled');
     }
@@ -40,6 +40,7 @@ class OperatingHoursService {
         // IF THE TRIAL IS EXPIRED OR IF THE SUBSCIPTION IS NOT ACTIVE THE PROJECT IS ALWAYS OPEN EVEN IF activeOperatingHours IS SETTED TO true AND, FOR EXAMPLE,
         // THE USER HAS SETTED ALL DAYS TO CLOSED
 
+                              //secondo me qui manca un parentesi tonda per gli or
         if (project.profile && (project.profile.type === 'free' && project.trialExpired === true) || (project.profile.type === 'payment' && project.isActiveSubscription === false)) {
           winston.debug('O ---> [ OHS ] -> trial Expired OR Subscription NOT Active - PROJECT ALWAYS OPEN') 
           callback(true, null) ;

package/services/requestService.js

@@ -231,7 +231,7 @@ class RequestService {
         .findOne({request_id: request_id, id_project: id_project});
 
         if (cacheEnabler.request) {
-          q.cache(cacheUtil.defaultTTL, id_project+":requests:request_id:"+request_id)      //request_cache
+          q.cache(cacheUtil.defaultTTL, id_project+":requests:request_id:"+request_id+":simple")      //request_cache
           winston.debug('request cache enabled');
         }
         return q.exec( function(err, request) {
@@ -387,7 +387,7 @@ class RequestService {
          .findOne({request_id: request_id, id_project: id_project});
 
          if (cacheEnabler.request) {
-          q.cache(cacheUtil.defaultTTL, id_project+":requests:request_id:"+request_id)      //request_cache
+          q.cache(cacheUtil.defaultTTL, id_project+":requests:request_id:"+request_id+":simple")      //request_cache
           winston.debug('request cache enabled');
         }
 
@@ -981,10 +981,10 @@ class RequestService {
       .populate('participatingAgents')  
       .populate({path:'requester',populate:{path:'id_user'}});
 
-      if (cacheEnabler.request) {
-        q.cache(cacheUtil.defaultTTL, id_project+":requests:request_id:"+request_id)           //request_cache
-        winston.debug('request cache enabled');
-      }
+      // if (cacheEnabler.request) {  //attention this cache is not usable bacause cacheoose don't support populate without .lean.. so if cached populated field is not returned with cacheoose, updateWaitingTime is only used in chat21webhook but i thik it is important for messages route
+      //   q.cache(cacheUtil.defaultTTL, id_project+":requests:request_id:"+request_id)           //request_cache
+      //   winston.debug('request cache enabled');
+      // }
       q.exec(function(err, request) {
         if (err) {
           winston.error(err);

package/websocket/webSocketServer.js

@@ -93,7 +93,7 @@ class WebSocketServer {
                           // winston.debug('ok websocket');
 
                           User.findOne({_id: identifier, status: 100}, 'email firstname lastname emailverified id')
-                            //@DISABLED_CACHE .cache(cacheUtil.defaultTTL, "users:id:"+identifier)
+                            //@DISABLED_CACHE .cache(cacheUtil.defaultTTL, "users:id:"+identifier)    //user_cache
                             .exec(function (err, user) {
                            
                     
@@ -187,7 +187,7 @@ class WebSocketServer {
 
             let q = Project.findOne({ _id: projectId, status: 100})
 
-            if (cacheEnabler.trigger) {
+            if (cacheEnabler.project) {
               q.cache(cacheUtil.defaultTTL, "projects:id:"+projectId) //project_cache
               winston.debug('project cache enabled');
             }