mirror of
https://github.com/lingble/chatwoot.git
synced 2025-11-03 20:48:07 +00:00
# Replace the deprecated `eventBus` with mitt.js ## Description Since eventBus and it's respective methods are deprecated and removed from all future releases of vue, this was blocking us from migrating. This PR replaces eventBus with [mitt](https://github.com/developit/mitt). I have created a wrapper mitt.js to simulate the same old event names so it's backwards compatible, without making a lot of changes. Fixes # (issue) ## Type of change Please delete options that are not relevant. - [x] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality not to work as expected) - [ ] This change requires a documentation update ## How Has This Been Tested? 1. Made sure all the places we're listening to bus events are working as expected. 2. Respective specsf or the events from mitt. ## Checklist: - [x] My code follows the style guidelines of this project - [x] I have performed a self-review of my code - [x] I have commented on my code, particularly in hard-to-understand areas - [x] I have made corresponding changes to the documentation - [x] My changes generate no new warnings - [x] I have added tests that prove my fix is effective or that my feature works - [x] New and existing unit tests pass locally with my changes - [x] Any dependent changes have been merged and published in downstream modules
143 lines
4.0 KiB
JavaScript
143 lines
4.0 KiB
JavaScript
import BaseActionCableConnector from '../../shared/helpers/BaseActionCableConnector';
|
|
import { playNewMessageNotificationInWidget } from 'widget/helpers/WidgetAudioNotificationHelper';
|
|
import { ON_AGENT_MESSAGE_RECEIVED } from '../constants/widgetBusEvents';
|
|
import { IFrameHelper } from 'widget/helpers/utils';
|
|
import { shouldTriggerMessageUpdateEvent } from './IframeEventHelper';
|
|
import { CHATWOOT_ON_MESSAGE } from '../constants/sdkEvents';
|
|
import { emitter } from '../../shared/helpers/mitt';
|
|
|
|
const isMessageInActiveConversation = (getters, message) => {
|
|
const { conversation_id: conversationId } = message;
|
|
const activeConversationId =
|
|
getters['conversationAttributes/getConversationParams'].id;
|
|
return activeConversationId && conversationId !== activeConversationId;
|
|
};
|
|
|
|
class ActionCableConnector extends BaseActionCableConnector {
|
|
constructor(app, pubsubToken) {
|
|
super(app, pubsubToken);
|
|
this.events = {
|
|
'message.created': this.onMessageCreated,
|
|
'message.updated': this.onMessageUpdated,
|
|
'conversation.typing_on': this.onTypingOn,
|
|
'conversation.typing_off': this.onTypingOff,
|
|
'conversation.status_changed': this.onStatusChange,
|
|
'conversation.created': this.onConversationCreated,
|
|
'presence.update': this.onPresenceUpdate,
|
|
'contact.merged': this.onContactMerge,
|
|
};
|
|
}
|
|
|
|
onDisconnected = () => {
|
|
this.setLastMessageId();
|
|
};
|
|
|
|
onReconnect = () => {
|
|
this.syncLatestMessages();
|
|
};
|
|
|
|
setLastMessageId = () => {
|
|
this.app.$store.dispatch('conversation/setLastMessageId');
|
|
};
|
|
|
|
syncLatestMessages = () => {
|
|
this.app.$store.dispatch('conversation/syncLatestMessages');
|
|
};
|
|
|
|
onStatusChange = data => {
|
|
if (data.status === 'resolved') {
|
|
this.app.$store.dispatch('campaign/resetCampaign');
|
|
}
|
|
this.app.$store.dispatch('conversationAttributes/update', data);
|
|
};
|
|
|
|
onMessageCreated = data => {
|
|
if (isMessageInActiveConversation(this.app.$store.getters, data)) {
|
|
return;
|
|
}
|
|
|
|
this.app.$store
|
|
.dispatch('conversation/addOrUpdateMessage', data)
|
|
.then(() => emitter.emit(ON_AGENT_MESSAGE_RECEIVED));
|
|
|
|
IFrameHelper.sendMessage({
|
|
event: 'onEvent',
|
|
eventIdentifier: CHATWOOT_ON_MESSAGE,
|
|
data,
|
|
});
|
|
if (data.sender_type === 'User') {
|
|
playNewMessageNotificationInWidget();
|
|
}
|
|
};
|
|
|
|
onMessageUpdated = data => {
|
|
if (isMessageInActiveConversation(this.app.$store.getters, data)) {
|
|
return;
|
|
}
|
|
|
|
if (shouldTriggerMessageUpdateEvent(data)) {
|
|
IFrameHelper.sendMessage({
|
|
event: 'onEvent',
|
|
eventIdentifier: CHATWOOT_ON_MESSAGE,
|
|
data,
|
|
});
|
|
}
|
|
|
|
this.app.$store.dispatch('conversation/addOrUpdateMessage', data);
|
|
};
|
|
|
|
onConversationCreated = () => {
|
|
this.app.$store.dispatch('conversationAttributes/getAttributes');
|
|
};
|
|
|
|
onPresenceUpdate = data => {
|
|
this.app.$store.dispatch('agent/updatePresence', data.users);
|
|
};
|
|
|
|
// eslint-disable-next-line class-methods-use-this
|
|
onContactMerge = data => {
|
|
const { pubsub_token: pubsubToken } = data;
|
|
ActionCableConnector.refreshConnector(pubsubToken);
|
|
};
|
|
|
|
onTypingOn = data => {
|
|
const activeConversationId =
|
|
this.app.$store.getters['conversationAttributes/getConversationParams']
|
|
.id;
|
|
const isUserTypingOnAnotherConversation =
|
|
data.conversation && data.conversation.id !== activeConversationId;
|
|
|
|
if (isUserTypingOnAnotherConversation || data.is_private) {
|
|
return;
|
|
}
|
|
this.clearTimer();
|
|
this.app.$store.dispatch('conversation/toggleAgentTyping', {
|
|
status: 'on',
|
|
});
|
|
this.initTimer();
|
|
};
|
|
|
|
onTypingOff = () => {
|
|
this.clearTimer();
|
|
this.app.$store.dispatch('conversation/toggleAgentTyping', {
|
|
status: 'off',
|
|
});
|
|
};
|
|
|
|
clearTimer = () => {
|
|
if (this.CancelTyping) {
|
|
clearTimeout(this.CancelTyping);
|
|
this.CancelTyping = null;
|
|
}
|
|
};
|
|
|
|
initTimer = () => {
|
|
// Turn off typing automatically after 30 seconds
|
|
this.CancelTyping = setTimeout(() => {
|
|
this.onTypingOff();
|
|
}, 30000);
|
|
};
|
|
}
|
|
|
|
export default ActionCableConnector;
|