feat(inbox): Enable conversation continuity for social channels (#11079)
## Summary This PR enables and surfaces **conversation workflow** for social-style channels that should support either: - `Create new conversations` after resolve, or - `Reopen same conversation` ## What is included - Adds the conversation workflow setting UI as card-based options in Inbox Settings. - Expands channel availability in settings to include channels like: - Telegram - TikTok - Instagram - Line - WhatsApp - Facebook - Updates conversation selection behavior for Line incoming messages to respect the workflow (reopen vs create-new-after-resolved). - Updates TikTok conversation selection behavior to respect the workflow (reopen vs create-new-after-resolved). - Keeps email behavior unchanged (always starts a new thread). Fixes: https://github.com/chatwoot/chatwoot/issues/8426 ## Screenshot <img width="1400" height="900" alt="pr11079-workflow-sender-clear-tight" src="https://github.com/user-attachments/assets/9456821f-8d83-4924-8dcf-7503c811a7b1" /> ## How To Reproduce 1. Open `Settings -> Inboxes -> <Telegram/TikTok/Instagram/Line/Facebook/WhatsApp inbox> -> Settings`. 2. Verify **Conversation workflow** is visible with the two card options. 3. Toggle between both options and save. 4. For Line and TikTok, verify resolved-conversation behavior follows the selected workflow. ## Testing - `RAILS_ENV=test bundle exec rspec spec/builders/messages/instagram/message_builder_spec.rb:213 spec/builders/messages/instagram/message_builder_spec.rb:255 spec/builders/messages/instagram/messenger/message_builder_spec.rb:228 spec/builders/messages/instagram/messenger/message_builder_spec.rb:293 spec/services/tiktok/message_service_spec.rb` - Result: `16 examples, 0 failures` ## Follow-up - Migrate Website Live Chat workflow settings into this same conversation-workflow settings model. - Add Voice channel support for this workflow setting. --------- Co-authored-by: Muhsin Keloth <muhsinkeramam@gmail.com> Co-authored-by: Sivin Varghese <64252451+iamsivin@users.noreply.github.com> Co-authored-by: iamsivin <iamsivin@gmail.com>
This commit is contained in:
@@ -405,5 +405,111 @@ describe Line::IncomingMessageService do
|
||||
expect(line_channel.inbox.messages.first.attachments.first.file.blob.filename.to_s).to eq('contacts.csv')
|
||||
end
|
||||
end
|
||||
|
||||
context 'when lock_to_single_conversation is false' do
|
||||
before do
|
||||
line_channel.inbox.update(lock_to_single_conversation: false)
|
||||
end
|
||||
|
||||
it 'creates a new conversation when all previous conversations are resolved' do
|
||||
line_bot = double
|
||||
line_user_profile = double
|
||||
allow(Line::Bot::Client).to receive(:new).and_return(line_bot)
|
||||
allow(line_bot).to receive(:get_profile).and_return(line_user_profile)
|
||||
allow(line_user_profile).to receive(:body).and_return(
|
||||
{
|
||||
'displayName': 'LINE Test',
|
||||
'userId': 'U4af4980629',
|
||||
'pictureUrl': 'https://test.com'
|
||||
}.to_json
|
||||
)
|
||||
|
||||
# Create a contact and a resolved conversation
|
||||
described_class.new(inbox: line_channel.inbox, params: params).perform
|
||||
|
||||
# Mark the conversation as resolved
|
||||
conversation = line_channel.inbox.conversations.last
|
||||
conversation.update(status: :resolved)
|
||||
|
||||
# Send a new message
|
||||
new_params = params.deep_dup
|
||||
new_params[:events][0][:message][:id] = '325709'
|
||||
new_params[:events][0][:message][:text] = 'Second message'
|
||||
|
||||
described_class.new(inbox: line_channel.inbox, params: new_params).perform
|
||||
|
||||
# Should create a new conversation
|
||||
expect(line_channel.inbox.conversations.count).to eq(2)
|
||||
expect(line_channel.inbox.conversations.last.messages.first.content).to eq('Second message')
|
||||
end
|
||||
|
||||
it 'uses the existing conversation when there is an unresolved conversation' do
|
||||
line_bot = double
|
||||
line_user_profile = double
|
||||
allow(Line::Bot::Client).to receive(:new).and_return(line_bot)
|
||||
allow(line_bot).to receive(:get_profile).and_return(line_user_profile)
|
||||
allow(line_user_profile).to receive(:body).and_return(
|
||||
{
|
||||
'displayName': 'LINE Test',
|
||||
'userId': 'U4af4980629',
|
||||
'pictureUrl': 'https://test.com'
|
||||
}.to_json
|
||||
)
|
||||
|
||||
# Create a contact and an unresolved conversation
|
||||
described_class.new(inbox: line_channel.inbox, params: params).perform
|
||||
|
||||
# Send a new message
|
||||
new_params = params.deep_dup
|
||||
new_params[:events][0][:message][:id] = '325709'
|
||||
new_params[:events][0][:message][:text] = 'Second message'
|
||||
|
||||
described_class.new(inbox: line_channel.inbox, params: new_params).perform
|
||||
|
||||
# Should use the same conversation
|
||||
expect(line_channel.inbox.conversations.count).to eq(1)
|
||||
expect(line_channel.inbox.conversations.last.messages.count).to eq(2)
|
||||
expect(line_channel.inbox.conversations.last.messages.last.content).to eq('Second message')
|
||||
end
|
||||
end
|
||||
|
||||
context 'when lock_to_single_conversation is true' do
|
||||
before do
|
||||
line_channel.inbox.update(lock_to_single_conversation: true)
|
||||
end
|
||||
|
||||
it 'uses the existing conversation even when it is resolved' do
|
||||
line_bot = double
|
||||
line_user_profile = double
|
||||
allow(Line::Bot::Client).to receive(:new).and_return(line_bot)
|
||||
allow(line_bot).to receive(:get_profile).and_return(line_user_profile)
|
||||
allow(line_user_profile).to receive(:body).and_return(
|
||||
{
|
||||
'displayName': 'LINE Test',
|
||||
'userId': 'U4af4980629',
|
||||
'pictureUrl': 'https://test.com'
|
||||
}.to_json
|
||||
)
|
||||
|
||||
# Create a contact and a resolved conversation
|
||||
described_class.new(inbox: line_channel.inbox, params: params).perform
|
||||
|
||||
# Mark the conversation as resolved
|
||||
conversation = line_channel.inbox.conversations.last
|
||||
conversation.update(status: :resolved)
|
||||
|
||||
# Send a new message
|
||||
new_params = params.deep_dup
|
||||
new_params[:events][0][:message][:id] = '325709'
|
||||
new_params[:events][0][:message][:text] = 'Second message'
|
||||
|
||||
described_class.new(inbox: line_channel.inbox, params: new_params).perform
|
||||
|
||||
# Should use the same conversation
|
||||
expect(line_channel.inbox.conversations.count).to eq(1)
|
||||
expect(line_channel.inbox.conversations.last.messages.count).to eq(2)
|
||||
expect(line_channel.inbox.conversations.last.messages.last.content).to eq('Second message')
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -410,6 +410,94 @@ describe Telegram::IncomingMessageService do
|
||||
expect(telegram_channel.inbox.messages.first.attachments.first.file_type).to eq('contact')
|
||||
end
|
||||
end
|
||||
|
||||
context 'when lock_to_single_conversation is false' do
|
||||
before do
|
||||
telegram_channel.inbox.update(lock_to_single_conversation: false)
|
||||
end
|
||||
|
||||
it 'creates a new conversation when all previous conversations are resolved' do
|
||||
# Create a contact and a resolved conversation
|
||||
params = {
|
||||
'update_id' => 2_342_342_343_242,
|
||||
'message' => { 'text' => 'first message' }.merge(message_params)
|
||||
}.with_indifferent_access
|
||||
|
||||
described_class.new(inbox: telegram_channel.inbox, params: params).perform
|
||||
|
||||
# Mark the conversation as resolved
|
||||
conversation = telegram_channel.inbox.conversations.last
|
||||
conversation.update(status: :resolved)
|
||||
|
||||
# Send a new message
|
||||
new_params = {
|
||||
'update_id' => 2_342_342_343_243,
|
||||
'message' => { 'text' => 'second message' }.merge(message_params)
|
||||
}.with_indifferent_access
|
||||
|
||||
described_class.new(inbox: telegram_channel.inbox, params: new_params).perform
|
||||
|
||||
# Should create a new conversation
|
||||
expect(telegram_channel.inbox.conversations.count).to eq(2)
|
||||
expect(telegram_channel.inbox.conversations.last.messages.first.content).to eq('second message')
|
||||
end
|
||||
|
||||
it 'uses the existing conversation when there is an unresolved conversation' do
|
||||
# Create a contact and an unresolved conversation
|
||||
params = {
|
||||
'update_id' => 2_342_342_343_242,
|
||||
'message' => { 'text' => 'first message' }.merge(message_params)
|
||||
}.with_indifferent_access
|
||||
|
||||
described_class.new(inbox: telegram_channel.inbox, params: params).perform
|
||||
|
||||
# Send a new message
|
||||
new_params = {
|
||||
'update_id' => 2_342_342_343_243,
|
||||
'message' => { 'text' => 'second message' }.merge(message_params)
|
||||
}.with_indifferent_access
|
||||
|
||||
described_class.new(inbox: telegram_channel.inbox, params: new_params).perform
|
||||
|
||||
# Should use the same conversation
|
||||
expect(telegram_channel.inbox.conversations.count).to eq(1)
|
||||
expect(telegram_channel.inbox.conversations.last.messages.count).to eq(2)
|
||||
expect(telegram_channel.inbox.conversations.last.messages.last.content).to eq('second message')
|
||||
end
|
||||
end
|
||||
|
||||
context 'when lock_to_single_conversation is true' do
|
||||
before do
|
||||
telegram_channel.inbox.update(lock_to_single_conversation: true)
|
||||
end
|
||||
|
||||
it 'uses the existing conversation even when it is resolved' do
|
||||
# Create a contact and a resolved conversation
|
||||
params = {
|
||||
'update_id' => 2_342_342_343_242,
|
||||
'message' => { 'text' => 'first message' }.merge(message_params)
|
||||
}.with_indifferent_access
|
||||
|
||||
described_class.new(inbox: telegram_channel.inbox, params: params).perform
|
||||
|
||||
# Mark the conversation as resolved
|
||||
conversation = telegram_channel.inbox.conversations.last
|
||||
conversation.update(status: :resolved)
|
||||
|
||||
# Send a new message
|
||||
new_params = {
|
||||
'update_id' => 2_342_342_343_243,
|
||||
'message' => { 'text' => 'second message' }.merge(message_params)
|
||||
}.with_indifferent_access
|
||||
|
||||
described_class.new(inbox: telegram_channel.inbox, params: new_params).perform
|
||||
|
||||
# Should use the same conversation
|
||||
expect(telegram_channel.inbox.conversations.count).to eq(1)
|
||||
expect(telegram_channel.inbox.conversations.last.messages.count).to eq(2)
|
||||
expect(telegram_channel.inbox.conversations.last.messages.last.content).to eq('second message')
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
context 'when lock to single conversation is enabled' do
|
||||
|
||||
@@ -6,8 +6,29 @@ RSpec.describe Tiktok::MessageService do
|
||||
let(:inbox) { channel.inbox }
|
||||
let(:contact) { create(:contact, account: account) }
|
||||
let(:contact_inbox) { create(:contact_inbox, inbox: inbox, contact: contact, source_id: 'tt-conv-1') }
|
||||
let(:text_content) do
|
||||
{
|
||||
type: 'text',
|
||||
message_id: 'tt-msg-lock',
|
||||
timestamp: 1_700_000_000_000,
|
||||
conversation_id: 'tt-conv-1',
|
||||
text: { body: 'Hello from TikTok' },
|
||||
from: 'Alice',
|
||||
from_user: { id: 'user-1' },
|
||||
to: 'Biz',
|
||||
to_user: { id: 'biz-123' }
|
||||
}.deep_symbolize_keys
|
||||
end
|
||||
|
||||
describe '#perform' do
|
||||
subject(:perform_text_message) do
|
||||
service = described_class.new(channel: channel, content: current_content)
|
||||
allow(service).to receive(:create_contact_inbox).and_return(contact_inbox)
|
||||
service.perform
|
||||
end
|
||||
|
||||
let(:current_content) { text_content }
|
||||
|
||||
it 'creates an incoming text message' do
|
||||
content = {
|
||||
type: 'text',
|
||||
@@ -113,5 +134,31 @@ RSpec.describe Tiktok::MessageService do
|
||||
ensure
|
||||
tempfile.close!
|
||||
end
|
||||
|
||||
context 'when lock_to_single_conversation is enabled' do
|
||||
it 'reuses the last resolved conversation' do
|
||||
inbox.update!(lock_to_single_conversation: true)
|
||||
resolved_conversation = create(:conversation, inbox: inbox, contact: contact, contact_inbox: contact_inbox, status: :resolved)
|
||||
|
||||
perform_text_message
|
||||
|
||||
expect(inbox.conversations.count).to eq(1)
|
||||
expect(resolved_conversation.reload.messages.last.content).to eq('Hello from TikTok')
|
||||
end
|
||||
end
|
||||
|
||||
context 'when lock_to_single_conversation is disabled' do
|
||||
let(:current_content) { text_content.merge(message_id: 'tt-msg-lock-2') }
|
||||
|
||||
it 'creates a new conversation if the previous one is resolved' do
|
||||
inbox.update!(lock_to_single_conversation: false)
|
||||
create(:conversation, inbox: inbox, contact: contact, contact_inbox: contact_inbox, status: :resolved)
|
||||
|
||||
perform_text_message
|
||||
|
||||
expect(inbox.conversations.count).to eq(2)
|
||||
expect(inbox.conversations.last.messages.last.content).to eq('Hello from TikTok')
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@@ -31,5 +31,31 @@ RSpec.describe Tiktok::ReadStatusService do
|
||||
|
||||
expect(Conversations::UpdateMessageStatusJob).to have_received(:perform_later).with(conversation.id, kind_of(Time))
|
||||
end
|
||||
|
||||
it 'updates the latest active conversation when lock_to_single_conversation is disabled' do
|
||||
allow(Conversations::UpdateMessageStatusJob).to receive(:perform_later)
|
||||
|
||||
inbox.update!(lock_to_single_conversation: false)
|
||||
conversation.update!(status: :resolved)
|
||||
active_conversation = create(
|
||||
:conversation,
|
||||
account: account,
|
||||
inbox: inbox,
|
||||
contact: contact,
|
||||
contact_inbox: contact_inbox,
|
||||
status: :open,
|
||||
additional_attributes: { conversation_id: 'tt-conv-1' }
|
||||
)
|
||||
|
||||
content = {
|
||||
conversation_id: 'tt-conv-1',
|
||||
read: { last_read_timestamp: 1_700_000_000_000 },
|
||||
from_user: { id: 'user-1' }
|
||||
}.deep_symbolize_keys
|
||||
|
||||
described_class.new(channel: channel, content: content).perform
|
||||
|
||||
expect(Conversations::UpdateMessageStatusJob).to have_received(:perform_later).with(active_conversation.id, kind_of(Time))
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
Reference in New Issue
Block a user