@tiledesk/tiledesk-server 2.15.3 → 2.15.5

package/CHANGELOG.md

@@ -5,6 +5,13 @@
 🚀        IN PRODUCTION                        🚀
 (https://www.npmjs.com/package/@tiledesk/tiledesk-server/v/2.3.77) 
 
+# 2.15.5
+- Fixed email flooding when smart assignment is active and there are no operators available
+
+# 2.15.4
+- Updated endpoint to get project users adding the query parameter "trashed" in order to obtain also the trashed users.
+- Added endpoint /restore to restore a deleted project user
+
 # 2.15.3
 - Updated whatsapp-connector to 1.0.25
 - Updated sms-connector to 0.1.13

package/app.js

@@ -200,7 +200,7 @@ var faqBotHandler = require('./services/faqBotHandler');
 faqBotHandler.listen();
 
 var pubModulesManager = require('./pubmodules/pubModulesManager');
-pubModulesManager.init({express:express, mongoose:mongoose, passport:passport, databaseUri:databaseUri, routes:{}, jobsManager:jobsManager});
+pubModulesManager.init({express:express, mongoose:mongoose, passport:passport, databaseUri:databaseUri, routes:{}, jobsManager:jobsManager, tdCache:tdCache});
   
 jobsManager.listen(); //listen after pubmodules to enabled queued *.queueEnabled events
 

package/channels/chat21/chat21WebHook.js

@@ -798,7 +798,7 @@ else if (req.body.event_type == "presence-change") {
           
                     // urgente Cannot read property '_id' of null at /usr/src/app/channels/chat21/chat21WebHook.js:663:68 a
                     if (!updatedProject_userPopulated.id_project) {
-                      winston.warn('Error updatedProject_userPopulated.id_project not found.',{updatedProject_userPopulated:updatedProject_userPopulated, savedProjectUser:savedProjectUser,project_user:project_user});
+                      winston.debug('Error updatedProject_userPopulated.id_project not found.',{updatedProject_userPopulated:updatedProject_userPopulated, savedProjectUser:savedProjectUser,project_user:project_user});
                       // return res.status(404).send({ success: false, msg: 'Error updatedProject_userPopulated.id_project not found.' });
                       // continue;
                     } else {

package/migrations/1771844588961-phone-channels-migration.js

@@ -2,9 +2,17 @@ var winston = require('../config/winston');
 const Request = require('../models/request');
 const phoneUtil = require('../utils/phoneUtil');
 
-const VOICE_CHANNEL_NAMES = ['voice_twilio', 'voice-twilio', 'voice-vxml', 'voice-vxml-enghouse'];
+const VOICE_TWILIO_CHANNEL_NAMES = ['voice_twilio', 'voice-twilio'];
+const VOICE_VXML_CHANNEL_NAMES = ['voice-vxml', 'voice-vxml-enghouse'];
 const BATCH_SIZE = 100;
 
+function getPhoneFromVoiceTwilioCreatedBy(createdBy) {
+  if (!createdBy || typeof createdBy !== 'string') return null;
+  if (createdBy.startsWith('voice-twilio-')) return createdBy.replace(/^voice-twilio-/, '');
+  if (createdBy.startsWith('voice_twilio-')) return createdBy.replace(/^voice_twilio-/, '');
+  return null;
+}
+
 async function updateManyWithNormalizedPhone(filter, getPhoneFromDoc) {
   let matched = 0;
   let modified = 0;
@@ -38,39 +46,48 @@ async function updateManyWithNormalizedPhone(filter, getPhoneFromDoc) {
 
 async function up() {
   try {
-    // Voice channels
+    // Voice Twilio (voice-twilio / voice_twilio: phone from createdBy as "voice-twilio-{phone}" or "voice_twilio-{phone}")
     const voiceFilter = {
-      'channel.name': { $in: VOICE_CHANNEL_NAMES },
-      'attributes.caller_phone': { $exists: true, $nin: [null, ''] }
+      'channel.name': { $in: VOICE_TWILIO_CHANNEL_NAMES },
+      createdBy: { $regex: /^(voice-twilio-|voice_twilio-)/ }
     };
-    const voiceResult = await updateManyWithNormalizedPhone(voiceFilter, (doc) => doc.attributes?.caller_phone);
-    winston.info(
-      `[phone-channels-migration] Voice channels: matched ${voiceResult.matched}, modified ${voiceResult.modified}`
+    winston.info(`[phone-channels-migration] Voice Twilio Starting...`);
+    const voiceResult = await updateManyWithNormalizedPhone(voiceFilter, (doc) =>
+      getPhoneFromVoiceTwilioCreatedBy(doc.createdBy)
     );
+    winston.info(`[phone-channels-migration] Voice Twilio: matched ${voiceResult.matched}, modified ${voiceResult.modified}`);
+
+    // Voice VXML (voice-vxml / voice-vxml-enghouse: phone from attributes.caller_phone)
+    const voiceVxmlFilter = {
+      'channel.name': { $in: VOICE_VXML_CHANNEL_NAMES },
+      'attributes.caller_phone': { $exists: true, $nin: [null, ''] }
+    };
+    winston.info(`[phone-channels-migration] Voice VXML Starting...`);
+    const voiceVxmlResult = await updateManyWithNormalizedPhone(voiceVxmlFilter, (doc) => doc.attributes?.caller_phone);
+    winston.info(`[phone-channels-migration] Voice VXML: matched ${voiceVxmlResult.matched}, modified ${voiceVxmlResult.modified}`);
 
     // WhatsApp
     const wabFilter = {
       'channel.name': 'whatsapp',
       createdBy: { $regex: /^wab-/ }
     };
+    winston.info(`[phone-channels-migration] WhatsApp Starting...`);
     const wabResult = await updateManyWithNormalizedPhone(wabFilter, (doc) =>
       doc.createdBy && doc.createdBy.startsWith('wab-') ? doc.createdBy.replace(/^wab-/, '') : null
     );
-    winston.info(
-      `[phone-channels-migration] WhatsApp: matched ${wabResult.matched}, modified ${wabResult.modified}`
-    );
+    winston.info(`[phone-channels-migration] WhatsApp: matched ${wabResult.matched}, modified ${wabResult.modified}`);
 
     // SMS-Twilio
     const smsFilter = {
       'channel.name': 'sms-twilio',
       createdBy: { $regex: /^sms-twilio-/ }
     };
+    winston.info(`[phone-channels-migration] SMS-Twilio Starting...`);
     const smsResult = await updateManyWithNormalizedPhone(smsFilter, (doc) =>
       doc.createdBy && doc.createdBy.startsWith('sms-twilio-') ? doc.createdBy.replace(/^sms-twilio-/, '') : null
     );
-    winston.info(
-      `[phone-channels-migration] SMS-Twilio: matched ${smsResult.matched}, modified ${smsResult.modified}`
-    );
+    winston.info(`[phone-channels-migration] SMS-Twilio: matched ${smsResult.matched}, modified ${smsResult.modified}`);
+
   } catch (err) {
     winston.error('[phone-channels-migration] Error:', err);
     throw err;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tiledesk/tiledesk-server",
   "description": "The Tiledesk server module",
-  "version": "2.15.3",
+  "version": "2.15.5",
   "scripts": {
     "start": "node ./bin/www",
     "pretest": "mongodb-runner start",

package/pubmodules/emailNotification/requestNotification.js

@@ -14,6 +14,7 @@ var winston = require('../../config/winston');
 var RoleConstants = require("../../models/roleConstants");
 var ChannelConstants = require("../../models/channelConstants");
 var cacheUtil = require('../../utils/cacheUtil');
+const { TdCache } = require('../../utils/TdCache');
 
 const messageEvent = require('../../event/messageEvent');
 var mongoose = require('mongoose');
@@ -40,6 +41,23 @@ if (pKey) {
 let apiUrl = process.env.API_URL || configGlobal.apiUrl;
 winston.debug('********* RequestNotification apiUrl: ' + apiUrl);
 
+/** Redis cache for throttling pooled-request email. Injected by app (shared TdCache) or lazy-created fallback. */
+let _pooledEmailTdCache = null;
+function getPooledEmailCache() {
+  if (_pooledEmailTdCache) return _pooledEmailTdCache;
+  const fallback = new TdCache({
+    host: process.env.CACHE_REDIS_HOST,
+    port: process.env.CACHE_REDIS_PORT,
+    password: process.env.CACHE_REDIS_PASSWORD
+  });
+  fallback.connect();
+  _pooledEmailTdCache = fallback;
+  return _pooledEmailTdCache;
+}
+
+/** TTL in seconds: do not send pooled email again for the same request within this window (avoids flooding when smart assignment retries) */
+const POOLED_EMAIL_THROTTLE_TTL = Number(process.env.POOLED_EMAIL_THROTTLE_TTL) || cacheUtil.defaultTTL;
+
 class RequestNotification {
 
   constructor() {
@@ -48,7 +66,18 @@ class RequestNotification {
         this.enabled = false;
     }
     winston.debug("RequestNotification this.enabled: "+ this.enabled);
-}
+  }
+
+  /**
+   * Reuse app's TdCache instance instead of opening a new Redis connection (optional, called by PubModulesManager).
+   * @param {TdCache} tdCache - shared Redis cache from app.get('redis_client')
+   */
+  setTdCache(tdCache) {
+    if (tdCache && typeof tdCache.setNX === 'function') {
+      _pooledEmailTdCache = tdCache;
+      winston.debug("RequestNotification using shared TdCache for pooled email throttle");
+    }
+  }
 
 listen() {
 
@@ -892,6 +921,18 @@ sendAgentEmail(projectid, savedRequest) {
                     return winston.warn("RequestNotification savedRequest.snapshot is null :(. You are closing an old request?");
                   }
 
+                  // Throttle: send pooled email only once per request within TTL (avoids flooding when smart assignment keeps retrying)
+                  const requestId = (savedRequest._id || savedRequest.id).toString();
+                  const pooledEmailKey = 'pooled_request_email:' + requestId;
+                  try {
+                    const shouldSend = await getPooledEmailCache().setNX(pooledEmailKey, '1', POOLED_EMAIL_THROTTLE_TTL);
+                    if (!shouldSend) {
+                      return winston.debug("RequestNotification pooled email already sent for request " + requestId + " (Redis throttle, TTL " + POOLED_EMAIL_THROTTLE_TTL + "s)");
+                    }
+                  } catch (redisErr) {
+                    winston.warn("RequestNotification Redis setNX for pooled email throttle failed, skipping send", { error: redisErr, requestId });
+                    return;
+                  }
 
                  
                   var snapshotAgents = savedRequest; //riassegno varibile cosi nn cambio righe successive

package/pubmodules/pubModulesManager.js

@@ -175,6 +175,7 @@ class PubModulesManager {
         winston.debug("PubModulesManager init");
 
         this.jobsManager = config.jobsManager;
+        this.tdCache = config.tdCache;
 
         try {
             this.appRules = require('./rules/appRules');
@@ -631,6 +632,9 @@ class PubModulesManager {
         // job_here
         if (this.emailNotification) {
             try {
+                if (this.tdCache) {
+                    this.emailNotification.requestNotification.setTdCache(this.tdCache);
+                }
                 // this.emailNotification.requestNotification.listen();
                 this.jobsManager.listenEmailNotification(this.emailNotification);
                 winston.info("PubModulesManager emailNotification started.");   

package/routes/project_user.js

@@ -344,11 +344,49 @@ router.delete('/:project_userid', [passport.authenticate(['basic', 'jwt'], { ses
 
         // Event 'project_user.delete' not working - Check it and improve it to manage disable project user
         return res.status(200).send(project_user);
-      }
-    );
+      });
   }
 });
 
+// Restore a soft-deleted (trashed) project user. Fails if not found or not trashed.
+router.put('/:project_userid/restore', [passport.authenticate(['basic', 'jwt'], { session: false }), validtoken, roleChecker.hasRole('admin')], function (req, res) {
+  const pu_id = req.params.project_userid;
+
+  Project_user.findOne({ _id: pu_id, id_project: req.projectid }, function (err, project_user) {
+    if (err) {
+      winston.error("Error finding project_user for restore", err);
+      return res.status(500).send({ success: false, msg: 'Error restoring Project User with id ' + pu_id });
+    }
+    if (!project_user) {
+      winston.warn("Project user not found for restore with id " + pu_id);
+      return res.status(404).send({ success: false, error: 'Project user not found with id ' + pu_id });
+    }
+    if (project_user.trashed !== true) {
+      winston.warn("Project user is not trashed, cannot restore id " + pu_id);
+      return res.status(400).send({ success: false, error: 'Project user is not trashed, cannot restore' });
+    }
+
+    Project_user.findByIdAndUpdate(pu_id, { trashed: false, status: 'active' }, { new: true }, function (err, updatedProject_user) {
+      if (err) {
+        winston.error("Error restoring project_user", err);
+        return res.status(500).send({ success: false, msg: 'Error restoring Project User with id ' + pu_id });
+      }
+
+      winston.debug("Restored project_user", updatedProject_user);
+      updatedProject_user.populate({ path: 'id_user', select: { 'firstname': 1, 'lastname': 1 } }, function (err, updatedProject_userPopulated) {
+        if (err) {
+          winston.error("Error populating restored project_user", err);
+        } else {
+          var pu = updatedProject_userPopulated.toJSON();
+          pu.isBusy = ProjectUserUtil.isBusy(updatedProject_user, req.project && req.project.settings && req.project.settings.max_agent_assigned_chat);
+          authEvent.emit('project_user.update', { updatedProject_userPopulated: pu, req: req });
+        }
+      });
+      return res.status(200).send(updatedProject_user);
+    });
+  });
+});
+
 router.get('/:project_userid', [passport.authenticate(['basic', 'jwt'], { session: false }), validtoken, roleChecker.hasRoleOrTypes('agent', ['subscription'])], function (req, res) {
   // router.get('/details/:project_userid', function (req, res) {
   // winston.debug("PROJECT USER ROUTES - req projectid", req.projectid);
@@ -482,7 +520,10 @@ router.get('/', [passport.authenticate(['basic', 'jwt'], { session: false }), va
   }
   winston.debug("role", role);
 
-  var query = { id_project: req.projectid, role: { $in : role }, trashed: { $ne: true } };
+  var query = { id_project: req.projectid, role: { $in : role } };
+  if (!req.query.trashed || req.query.trashed === 'false' || req.query.trashed === false) {
+    query.trashed = { $ne: true };
+  }
 
   if (req.query.presencestatus) {
     query["presence.status"] = req.query.presencestatus;

package/services/schemaMigrationService.js

@@ -1,5 +1,7 @@
 'use strict';
 
+var path = require('path');
+var fs = require('fs');
 var winston = require('../config/winston');
 var config = require('../config/database');
 var migrateMongoose = require('migrate-mongoose');
@@ -29,12 +31,13 @@ class SchamaMigrationService {
       var 
       //  migrationsDir = '/path/to/migrations/',
       // templatePath,
+      migrationsPath = path.resolve(process.cwd(), 'migrations'),
       dbUrl = process.env.DATABASE_URI || process.env.MONGODB_URI || config.database,
       collectionName = 'schemaMigrations',
       autosync = true;
       
       let migrator = new migrateMongoose({
-          // migrationsPath:  migrationsDir, // Path to migrations directory
+          migrationsPath: migrationsPath,
           // templatePath: templatePath, // The template to use when creating migrations needs up and down functions exposed
           dbConnectionUri: dbUrl, // mongo url
           collectionName:  collectionName, // collection name to use for migrations (defaults to 'migrations')
@@ -44,13 +47,18 @@ class SchamaMigrationService {
       var list = await migrator.list();
       winston.debug("SchemaMigration script list", list);
 
-      list.forEach(async(script)=> { 
+      for (const script of list) {
         winston.debug("script", script);
+        const migrationFilePath = path.join(migrationsPath, script.filename);
+        if (!fs.existsSync(migrationFilePath)) {
+          winston.warn("SchemaMigration skipping migration (file not present): " + script.filename + " — remove the record from DB collection 'schemaMigrations' if not needed.");
+          continue;
+        }
         var runScript = await migrator.run('up', script.name);
         if (runScript && !this.isEmptyObject(runScript)) {
           winston.info("SchemaMigration script " + script.name + " executed.");
         }
-      }); 
+      } 
     // // Create a new migration
     // migrator.create(migrationName).then(()=> {
     //   console.log(`Migration created. Run `+ `mongoose-migrate up ${migrationName}`.cyan + ` to apply the migration.`);

package/utils/TdCache.js

@@ -76,7 +76,18 @@ class TdCache {
       });
     }
 
-
+    /**
+     * Set key only if it does not exist, with TTL (seconds). Returns true if key was set, false if key already existed.
+     * Uses Redis SET key value EX ttl NX to avoid email/notification flooding.
+     */
+    async setNX(key, value, ttlSeconds) {
+      return new Promise((resolve, reject) => {
+        this.client.set(key, value, 'EX', ttlSeconds, 'NX', (err, reply) => {
+          if (err) return reject(err);
+          resolve(reply === 'OK');
+        });
+      });
+    }