mirror of
https://github.com/lingble/chatwoot.git
synced 2025-12-05 12:25:21 +00:00
7e70f7a68a
The term "sorcerer’s apprentice mode" is defined as a bug in a protocol where, under some circumstances, the receipt of a message causes multiple messages to be sent, each of which, when received, triggers the same bug. - RFC3834 Reference: https://github.com/chatwoot/chatwoot/pull/9606 This PR: - Adds an auto_reply attribute to message. - Adds an auto_reply attribute to conversation. - Disable conversation_created / conversation_opened event if auto_reply is set. - Disable message_created event if auto_reply is set. --------- Co-authored-by: Muhsin Keloth <muhsinkeramam@gmail.com>
240 lines
12 KiB
Ruby
240 lines
12 KiB
Ruby
require 'rails_helper'
|
|
|
|
describe MessageTemplates::HookExecutionService do
|
|
context 'when there is no incoming message in conversation' do
|
|
it 'will not call any hooks' do
|
|
contact = create(:contact, email: nil)
|
|
conversation = create(:conversation, contact: contact)
|
|
# ensure greeting hook is enabled
|
|
conversation.inbox.update(greeting_enabled: true, enable_email_collect: true)
|
|
|
|
email_collect_service = double
|
|
|
|
allow(MessageTemplates::Template::EmailCollect).to receive(:new).and_return(email_collect_service)
|
|
allow(email_collect_service).to receive(:perform).and_return(true)
|
|
allow(MessageTemplates::Template::Greeting).to receive(:new)
|
|
|
|
# described class gets called in message after commit
|
|
create(:message, conversation: conversation, message_type: 'activity', content: 'Conversation marked resolved!!')
|
|
|
|
expect(MessageTemplates::Template::Greeting).not_to have_received(:new)
|
|
expect(MessageTemplates::Template::EmailCollect).not_to have_received(:new)
|
|
end
|
|
end
|
|
|
|
context 'when Greeting Message' do
|
|
it 'doesnot calls ::MessageTemplates::Template::Greeting if greeting_message is empty' do
|
|
contact = create(:contact, email: nil)
|
|
conversation = create(:conversation, contact: contact)
|
|
# ensure greeting hook is enabled
|
|
conversation.inbox.update(greeting_enabled: true, enable_email_collect: true)
|
|
|
|
email_collect_service = double
|
|
|
|
allow(MessageTemplates::Template::EmailCollect).to receive(:new).and_return(email_collect_service)
|
|
allow(email_collect_service).to receive(:perform).and_return(true)
|
|
allow(MessageTemplates::Template::Greeting).to receive(:new)
|
|
|
|
# described class gets called in message after commit
|
|
message = create(:message, conversation: conversation)
|
|
|
|
expect(MessageTemplates::Template::Greeting).not_to have_received(:new)
|
|
expect(MessageTemplates::Template::EmailCollect).to have_received(:new).with(conversation: message.conversation)
|
|
expect(email_collect_service).to have_received(:perform)
|
|
end
|
|
|
|
it 'will not call ::MessageTemplates::Template::Greeting if its a tweet conversation' do
|
|
twitter_channel = create(:channel_twitter_profile)
|
|
twitter_inbox = create(:inbox, channel: twitter_channel)
|
|
# ensure greeting hook is enabled and greeting_message is present
|
|
twitter_inbox.update(greeting_enabled: true, greeting_message: 'Hi, this is a greeting message')
|
|
|
|
conversation = create(:conversation, inbox: twitter_inbox, additional_attributes: { type: 'tweet' })
|
|
greeting_service = double
|
|
allow(MessageTemplates::Template::Greeting).to receive(:new).and_return(greeting_service)
|
|
allow(greeting_service).to receive(:perform).and_return(true)
|
|
|
|
message = create(:message, conversation: conversation)
|
|
expect(MessageTemplates::Template::Greeting).not_to have_received(:new).with(conversation: message.conversation)
|
|
end
|
|
end
|
|
|
|
context 'when it is a first message from web widget' do
|
|
it 'calls ::MessageTemplates::Template::EmailCollect' do
|
|
contact = create(:contact, email: nil)
|
|
conversation = create(:conversation, contact: contact)
|
|
|
|
# ensure greeting hook is enabled and greeting_message is present
|
|
conversation.inbox.update(greeting_enabled: true, enable_email_collect: true, greeting_message: 'Hi, this is a greeting message')
|
|
|
|
email_collect_service = double
|
|
greeting_service = double
|
|
allow(MessageTemplates::Template::EmailCollect).to receive(:new).and_return(email_collect_service)
|
|
allow(email_collect_service).to receive(:perform).and_return(true)
|
|
allow(MessageTemplates::Template::Greeting).to receive(:new).and_return(greeting_service)
|
|
allow(greeting_service).to receive(:perform).and_return(true)
|
|
|
|
# described class gets called in message after commit
|
|
message = create(:message, conversation: conversation)
|
|
|
|
expect(MessageTemplates::Template::Greeting).to have_received(:new).with(conversation: message.conversation)
|
|
expect(greeting_service).to have_received(:perform)
|
|
expect(MessageTemplates::Template::EmailCollect).to have_received(:new).with(conversation: message.conversation)
|
|
expect(email_collect_service).to have_received(:perform)
|
|
end
|
|
|
|
it 'doesnot calls ::MessageTemplates::Template::EmailCollect on campaign conversations' do
|
|
contact = create(:contact, email: nil)
|
|
conversation = create(:conversation, contact: contact, campaign: create(:campaign))
|
|
|
|
allow(MessageTemplates::Template::EmailCollect).to receive(:new).and_return(true)
|
|
|
|
# described class gets called in message after commit
|
|
message = create(:message, conversation: conversation)
|
|
|
|
expect(MessageTemplates::Template::EmailCollect).not_to have_received(:new).with(conversation: message.conversation)
|
|
end
|
|
|
|
it 'doesnot calls ::MessageTemplates::Template::EmailCollect when enable_email_collect form is disabled' do
|
|
contact = create(:contact, email: nil)
|
|
conversation = create(:conversation, contact: contact)
|
|
|
|
conversation.inbox.update(enable_email_collect: false)
|
|
# ensure prechat form is enabled
|
|
conversation.inbox.channel.update(pre_chat_form_enabled: true)
|
|
allow(MessageTemplates::Template::EmailCollect).to receive(:new).and_return(true)
|
|
|
|
# described class gets called in message after commit
|
|
message = create(:message, conversation: conversation)
|
|
|
|
expect(MessageTemplates::Template::EmailCollect).not_to have_received(:new).with(conversation: message.conversation)
|
|
end
|
|
end
|
|
|
|
context 'when message is an auto reply email' do
|
|
it 'does not call any template hooks' do
|
|
contact = create(:contact)
|
|
conversation = create(:conversation, contact: contact)
|
|
conversation.inbox.update(greeting_enabled: true, enable_email_collect: true, greeting_message: 'Hi, this is a greeting message')
|
|
|
|
message = create(:message, conversation: conversation, content_type: :incoming_email)
|
|
message.content_attributes = { email: { auto_reply: true } }
|
|
message.save!
|
|
|
|
greeting_service = double
|
|
email_collect_service = double
|
|
out_of_office_service = double
|
|
|
|
allow(MessageTemplates::Template::Greeting).to receive(:new).and_return(greeting_service)
|
|
allow(greeting_service).to receive(:perform).and_return(true)
|
|
allow(MessageTemplates::Template::EmailCollect).to receive(:new).and_return(email_collect_service)
|
|
allow(email_collect_service).to receive(:perform).and_return(true)
|
|
allow(MessageTemplates::Template::OutOfOffice).to receive(:new).and_return(out_of_office_service)
|
|
allow(out_of_office_service).to receive(:perform).and_return(true)
|
|
|
|
described_class.new(message: message).perform
|
|
|
|
expect(MessageTemplates::Template::Greeting).not_to have_received(:new)
|
|
expect(MessageTemplates::Template::EmailCollect).not_to have_received(:new)
|
|
expect(MessageTemplates::Template::OutOfOffice).not_to have_received(:new)
|
|
end
|
|
end
|
|
|
|
context 'when it is after working hours' do
|
|
it 'calls ::MessageTemplates::Template::OutOfOffice' do
|
|
contact = create(:contact)
|
|
conversation = create(:conversation, contact: contact)
|
|
|
|
conversation.inbox.update(working_hours_enabled: true, out_of_office_message: 'We are out of office')
|
|
conversation.inbox.working_hours.today.update!(closed_all_day: true)
|
|
|
|
out_of_office_service = double
|
|
|
|
allow(MessageTemplates::Template::OutOfOffice).to receive(:new).and_return(out_of_office_service)
|
|
allow(out_of_office_service).to receive(:perform).and_return(true)
|
|
|
|
# described class gets called in message after commit
|
|
message = create(:message, conversation: conversation)
|
|
|
|
expect(MessageTemplates::Template::OutOfOffice).to have_received(:new).with(conversation: message.conversation)
|
|
expect(out_of_office_service).to have_received(:perform)
|
|
end
|
|
|
|
context 'with recent outgoing messages' do
|
|
it 'does not call ::MessageTemplates::Template::OutOfOffice when there are recent outgoing messages' do
|
|
contact = create(:contact)
|
|
conversation = create(:conversation, contact: contact)
|
|
|
|
conversation.inbox.update(working_hours_enabled: true, out_of_office_message: 'We are out of office')
|
|
conversation.inbox.working_hours.today.update!(closed_all_day: true)
|
|
|
|
create(:message, conversation: conversation, message_type: :outgoing, created_at: 2.minutes.ago)
|
|
|
|
out_of_office_service = double
|
|
allow(MessageTemplates::Template::OutOfOffice).to receive(:new).and_return(out_of_office_service)
|
|
allow(out_of_office_service).to receive(:perform).and_return(true)
|
|
|
|
create(:message, conversation: conversation)
|
|
|
|
expect(MessageTemplates::Template::OutOfOffice).not_to have_received(:new)
|
|
expect(out_of_office_service).not_to have_received(:perform)
|
|
end
|
|
|
|
it 'ignores private note and calls ::MessageTemplates::Template::OutOfOffice' do
|
|
contact = create(:contact)
|
|
conversation = create(:conversation, contact: contact)
|
|
|
|
conversation.inbox.update(working_hours_enabled: true, out_of_office_message: 'We are out of office')
|
|
conversation.inbox.working_hours.today.update!(closed_all_day: true)
|
|
|
|
create(:message, conversation: conversation, private: true, message_type: :outgoing, created_at: 2.minutes.ago)
|
|
|
|
out_of_office_service = double
|
|
allow(MessageTemplates::Template::OutOfOffice).to receive(:new).and_return(out_of_office_service)
|
|
allow(out_of_office_service).to receive(:perform).and_return(true)
|
|
|
|
create(:message, conversation: conversation)
|
|
|
|
expect(MessageTemplates::Template::OutOfOffice).to have_received(:new).with(conversation: conversation)
|
|
expect(out_of_office_service).to have_received(:perform)
|
|
end
|
|
end
|
|
|
|
it 'will not calls ::MessageTemplates::Template::OutOfOffice when outgoing message' do
|
|
contact = create(:contact)
|
|
conversation = create(:conversation, contact: contact)
|
|
|
|
conversation.inbox.update(working_hours_enabled: true, out_of_office_message: 'We are out of office')
|
|
conversation.inbox.working_hours.today.update!(closed_all_day: true)
|
|
|
|
out_of_office_service = double
|
|
|
|
allow(MessageTemplates::Template::OutOfOffice).to receive(:new).and_return(out_of_office_service)
|
|
allow(out_of_office_service).to receive(:perform).and_return(true)
|
|
|
|
# described class gets called in message after commit
|
|
message = create(:message, conversation: conversation, message_type: 'outgoing')
|
|
|
|
expect(MessageTemplates::Template::OutOfOffice).not_to have_received(:new).with(conversation: message.conversation)
|
|
expect(out_of_office_service).not_to have_received(:perform)
|
|
end
|
|
|
|
it 'will not call ::MessageTemplates::Template::OutOfOffice if its a tweet conversation' do
|
|
twitter_channel = create(:channel_twitter_profile)
|
|
twitter_inbox = create(:inbox, channel: twitter_channel)
|
|
twitter_inbox.update(working_hours_enabled: true, out_of_office_message: 'We are out of office')
|
|
|
|
conversation = create(:conversation, inbox: twitter_inbox, additional_attributes: { type: 'tweet' })
|
|
|
|
out_of_office_service = double
|
|
|
|
allow(MessageTemplates::Template::OutOfOffice).to receive(:new).and_return(out_of_office_service)
|
|
allow(out_of_office_service).to receive(:perform).and_return(false)
|
|
|
|
message = create(:message, conversation: conversation)
|
|
expect(MessageTemplates::Template::OutOfOffice).not_to have_received(:new).with(conversation: message.conversation)
|
|
expect(out_of_office_service).not_to receive(:perform)
|
|
end
|
|
end
|
|
end
|