Open-source live-chat, email support, omni-channel desk. An alternative to Intercom, Zendesk, Salesforce Service Cloud etc. 🔥💬
Ruby actioncablechat-widgetconversationcustomer-supportdashboarddesigndockerdocker-imageherokuintercomjavascriptlivechatopensourcerailsrubysassvuejswhatsappzendesk
import { DashboardAudioNotificationHelper } from '../DashboardAudioNotificationHelper';
import WindowVisibilityHelper from '../WindowVisibilityHelper';
import { showBadgeOnFavicon } from '../faviconHelper';
vi.mock('dashboard/store', () => ({ default: {} }));
vi.mock('../faviconHelper', () => ({
showBadgeOnFavicon: vi.fn(),
initFaviconSwitcher: vi.fn(),
}));
describe('dashboard bot handoff alerts', () => {
let helper;
let conversation;
beforeEach(() => {
vi.useFakeTimers();
helper = new DashboardAudioNotificationHelper({});
helper.currentUser = { id: 7 };
helper.notificationConfig = {
audioAlertType: ['all'],
playAlertOnlyWhenHidden: true,
alertIfUnreadConversationExist: true,
};
conversation = {
id: 12,
meta: { assignee_type: 'User', assignee: { id: 7 } },
};
vi.spyOn(helper, 'playAudioAlert').mockResolvedValue();
vi.spyOn(helper.store, 'hasConversationPermission').mockReturnValue(true);
vi.spyOn(helper.store, 'isMessageFromCurrentConversation').mockReturnValue(
false
);
vi.spyOn(WindowVisibilityHelper, 'isWindowVisible').mockReturnValue(false);
});
afterEach(() => {
vi.clearAllTimers();
vi.useRealTimers();
vi.restoreAllMocks();
vi.clearAllMocks();
});
it('plays sound, badges the tab, and starts recurring alerts without a new message', () => {
helper.onConversationBotHandoff(conversation);
expect(helper.playAudioAlert).toHaveBeenCalledOnce();
expect(showBadgeOnFavicon).toHaveBeenCalledOnce();
expect(vi.getTimerCount()).toBe(1);
});
it.each([
['none', 7, false],
['mine', 7, true],
['mine', 8, false],
['unassigned', null, true],
['unassigned', 7, false],
['notme', 8, true],
['notme', 7, false],
])(
'respects %s alerts for assignee %s',
(filter, assigneeId, shouldAlert) => {
helper.notificationConfig.audioAlertType = [filter];
conversation.meta.assignee = assigneeId ? { id: assigneeId } : null;
helper.onConversationBotHandoff(conversation);
expect(helper.playAudioAlert).toHaveBeenCalledTimes(shouldAlert ? 1 : 0);
expect(showBadgeOnFavicon).toHaveBeenCalledTimes(shouldAlert ? 1 : 0);
expect(vi.getTimerCount()).toBe(shouldAlert ? 1 : 0);
}
);
it.each(['note first', 'handoff first'])('alerts once with %s', order => {
vi.spyOn(helper.store, 'isMessageFromPendingConversation').mockReturnValue(
false
);
const note = {
conversation_id: conversation.id,
message_type: 1,
private: true,
sender: { id: 99, type: 'captain_assistant' },
content_attributes: {},
};
if (order === 'note first') {
helper.onNewMessage(note);
helper.onConversationBotHandoff(conversation);
} else {
helper.onConversationBotHandoff(conversation);
helper.onNewMessage(note);
}
expect(helper.playAudioAlert).toHaveBeenCalledOnce();
expect(showBadgeOnFavicon).toHaveBeenCalledOnce();
expect(vi.getTimerCount()).toBe(1);
});
it('does not treat a bot with the same ID as the current user as a human assignee', () => {
helper.notificationConfig.audioAlertType = ['mine'];
conversation.meta.assignee_type = 'AgentBot';
helper.onConversationBotHandoff(conversation);
expect(helper.playAudioAlert).not.toHaveBeenCalled();
helper.notificationConfig.audioAlertType = ['unassigned'];
helper.onConversationBotHandoff(conversation);
expect(helper.playAudioAlert).toHaveBeenCalledOnce();
});
it.each([
['human note', 1, true, 'user'],
['customer message', 0, false, 'contact'],
])('preserves alerts for %s', (_, messageType, isPrivate, senderType) => {
vi.spyOn(helper.store, 'isMessageFromPendingConversation').mockReturnValue(
false
);
helper.onNewMessage({
conversation_id: conversation.id,
message_type: messageType,
private: isPrivate,
sender: { id: 99, type: senderType },
content_attributes: {},
});
expect(helper.playAudioAlert).toHaveBeenCalledOnce();
expect(showBadgeOnFavicon).toHaveBeenCalledOnce();
});
it('keeps all Captain private notes silent, even without a handoff', () => {
vi.spyOn(helper.store, 'isMessageFromPendingConversation').mockReturnValue(
false
);
helper.onNewMessage({
conversation_id: conversation.id,
message_type: 1,
private: true,
sender: { id: 99, type: 'captain_assistant' },
});
expect(helper.playAudioAlert).not.toHaveBeenCalled();
expect(showBadgeOnFavicon).not.toHaveBeenCalled();
});
it('suppresses alerts without conversation permissions', () => {
helper.store.hasConversationPermission.mockReturnValue(false);
helper.onConversationBotHandoff(conversation);
expect(helper.playAudioAlert).not.toHaveBeenCalled();
expect(showBadgeOnFavicon).not.toHaveBeenCalled();
expect(vi.getTimerCount()).toBe(0);
});
it.each([
[true, false, false],
[false, true, false],
[false, false, true],
])(
'respects active-window preferences (%s, %s)',
(hiddenOnly, isSelected, shouldAlert) => {
WindowVisibilityHelper.isWindowVisible.mockReturnValue(true);
helper.notificationConfig.playAlertOnlyWhenHidden = hiddenOnly;
helper.store.isMessageFromCurrentConversation.mockReturnValue(isSelected);
helper.onConversationBotHandoff(conversation);
expect(helper.playAudioAlert).toHaveBeenCalledTimes(shouldAlert ? 1 : 0);
expect(showBadgeOnFavicon).toHaveBeenCalledTimes(shouldAlert ? 1 : 0);
expect(vi.getTimerCount()).toBe(shouldAlert ? 1 : 0);
}
);
});