[NEW][ENTERPRISE] Auto close abandoned Omnichannel rooms #17055
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
|
|
||
| import { callbacks } from '../../../callbacks'; | ||
| import { LivechatRooms } from '../../../models'; | ||
|
|
||
| callbacks.add('afterSaveMessage', function(message, room) { | ||
| // skips this callback if the message was edited | ||
| if (!message || message.editedAt) { | ||
| return message; | ||
| } | ||
|
|
||
| // if the message has not a token, it was sent by the agent, so ignore it | ||
| if (!message.token) { | ||
| return message; | ||
| } | ||
|
|
||
| // check if room is yet awaiting for response | ||
| if (typeof room.t !== 'undefined' && room.t === 'l' && room.waitingResponse) { | ||
| return message; | ||
| } | ||
|
|
||
| LivechatRooms.setNotResponseByRoomId(room._id); | ||
|
|
||
| return message; | ||
| }, callbacks.priority.LOW, 'markRoomNotResponded'); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| import { callbacks } from '../../../../../app/callbacks/server'; | ||
| import { settings } from '../../../../../app/settings/server'; | ||
| import { setPredictedVisitorAbandonmentTime } from '../lib/Helper'; | ||
|
|
||
| callbacks.add('afterSaveMessage', function(message, room) { | ||
| if (!settings.get('Livechat_auto_close_abandoned_rooms') || settings.get('Livechat_visitor_inactivity_timeout') <= 0) { | ||
| return message; | ||
| } | ||
| // skips this callback if the message was edited | ||
| if (message.editedAt) { | ||
| return false; | ||
| } | ||
| // message valid only if it is a livechat room | ||
| if (!(typeof room.t !== 'undefined' && room.t === 'l' && room.v && room.v.token)) { | ||
| return false; | ||
| } | ||
| // if the message has a type means it is a special message (like the closing comment), so skips | ||
| if (message.t) { | ||
| return false; | ||
| } | ||
| const sentByAgent = !message.token; | ||
| if (sentByAgent) { | ||
| setPredictedVisitorAbandonmentTime(room); | ||
| } | ||
| return message; | ||
| }, callbacks.priority.HIGH, 'save-visitor-inactivity'); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| import { SyncedCron } from 'meteor/littledata:synced-cron'; | ||
| import { TAPi18n } from 'meteor/rocketchat:tap-i18n'; | ||
|
|
||
| import { settings } from '../../../../../app/settings/server'; | ||
| import { LivechatRooms, LivechatDepartment, Users } from '../../../../../app/models/server'; | ||
| import { Livechat } from '../../../../../app/livechat/server/lib/Livechat'; | ||
|
|
||
| export class VisitorInactivityMonitor { | ||
| constructor() { | ||
| this._started = false; | ||
| this._name = 'Omnichannel Visitor Inactivity Monitor'; | ||
| this.messageCache = new Map(); | ||
| this.userToPerformAutomaticClosing; | ||
| } | ||
|
|
||
| start() { | ||
|
MarcosSpessatto marked this conversation as resolved.
|
||
| this._startMonitoring(); | ||
| this._initializeMessageCache(); | ||
| this.userToPerformAutomaticClosing = Users.findOneById('rocket.cat'); | ||
| } | ||
|
|
||
| _startMonitoring() { | ||
| if (this.isRunning()) { | ||
| return; | ||
| } | ||
| const everyMinute = '* * * * *'; | ||
| SyncedCron.add({ | ||
| name: this._name, | ||
| schedule: (parser) => parser.cron(everyMinute), | ||
| job: () => { | ||
| this.handleAbandonedRooms(); | ||
| }, | ||
| }); | ||
| this._started = true; | ||
| } | ||
|
|
||
| stop() { | ||
| if (!this.isRunning()) { | ||
| return; | ||
| } | ||
|
|
||
| SyncedCron.remove(this._name); | ||
|
|
||
| this._started = false; | ||
| } | ||
|
|
||
| isRunning() { | ||
| return this._started; | ||
| } | ||
|
|
||
| _initializeMessageCache() { | ||
| this.messageCache.clear(); | ||
| this.messageCache.set('default', settings.get('Livechat_abandoned_rooms_closed_custom_message') || TAPi18n.__('Closed_automatically')); | ||
| } | ||
|
|
||
| _getDepartmentAbandonedCustomMessage(departmentId) { | ||
| if (this.messageCache.has('departmentId')) { | ||
| return this.messageCache.get('departmentId'); | ||
| } | ||
| const department = LivechatDepartment.findOneById(departmentId); | ||
| if (!department) { | ||
| return; | ||
| } | ||
| this.messageCache.set(department._id, department.abandonedRoomsCloseCustomMessage); | ||
| return department.abandonedRoomsCloseCustomMessage; | ||
| } | ||
|
|
||
| closeRooms(room) { | ||
| let comment = this.messageCache.get('default'); | ||
| if (room.departmentId) { | ||
| comment = this._getDepartmentAbandonedCustomMessage(room.departmentId) || comment; | ||
| } | ||
| Livechat.closeRoom({ | ||
|
Contributor
There was a problem hiding this comment. The user who is closing the chats is required here. So, my suggestion is to use |
||
| comment, | ||
| room, | ||
| user: this.userToPerformAutomaticClosing, | ||
| }); | ||
| } | ||
|
|
||
| handleAbandonedRooms() { | ||
| if (!settings.get('Livechat_auto_close_abandoned_rooms')) { | ||
| return; | ||
| } | ||
| LivechatRooms.findAbandonedOpenRooms(new Date()).forEach((room) => this.closeRooms(room)); | ||
| this._initializeMessageCache(); | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,11 +1,24 @@ | ||
| import { Meteor } from 'meteor/meteor'; | ||
|
|
||
| import { settings } from '../../../../app/settings'; | ||
| import { checkWaitingQueue, updatePredictedVisitorAbandonment } from './lib/Helper'; | ||
| import { VisitorInactivityMonitor } from './lib/VisitorInactivityMonitor'; | ||
| import './lib/query.helper'; | ||
|
|
||
| const visitorActivityMonitor = new VisitorInactivityMonitor(); | ||
|
|
||
| Meteor.startup(function() { | ||
| settings.onload('Livechat_maximum_chats_per_agent', function(/* key, value */) { | ||
| checkWaitingQueue(); | ||
| }); | ||
| settings.onload('Livechat_auto_close_abandoned_rooms', function(_, value) { | ||
| updatePredictedVisitorAbandonment(); | ||
| if (!value) { | ||
| return visitorActivityMonitor.stop(); | ||
| } | ||
| visitorActivityMonitor.start(); | ||
| }); | ||
| settings.onload('Livechat_visitor_inactivity_timeout', function() { | ||
| updatePredictedVisitorAbandonment(); | ||
| }); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This method needs to be renamed on the Model as well.
The old name is still there.