a44cb2c738
## 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>
516 lines
18 KiB
Ruby
516 lines
18 KiB
Ruby
require 'rails_helper'
|
|
|
|
describe Line::IncomingMessageService do
|
|
let!(:line_channel) { create(:channel_line) }
|
|
let(:params) do
|
|
{
|
|
'destination': '2342234234',
|
|
'events': [
|
|
{
|
|
'replyToken': '0f3779fba3b349968c5d07db31eab56f',
|
|
'type': 'message',
|
|
'mode': 'active',
|
|
'timestamp': 1_462_629_479_859,
|
|
'source': {
|
|
'type': 'user',
|
|
'userId': 'U4af4980629'
|
|
},
|
|
'message': {
|
|
'id': '325708',
|
|
'type': 'text',
|
|
'text': 'Hello, world'
|
|
}
|
|
},
|
|
{
|
|
'replyToken': '8cf9239d56244f4197887e939187e19e',
|
|
'type': 'follow',
|
|
'mode': 'active',
|
|
'timestamp': 1_462_629_479_859,
|
|
'source': {
|
|
'type': 'user',
|
|
'userId': 'U4af4980629'
|
|
}
|
|
}
|
|
]
|
|
}.with_indifferent_access
|
|
end
|
|
|
|
let(:follow_params) do
|
|
{
|
|
'destination': '2342234234',
|
|
'events': [
|
|
{
|
|
'replyToken': '8cf9239d56244f4197887e939187e19e',
|
|
'type': 'follow',
|
|
'mode': 'active',
|
|
'timestamp': 1_462_629_479_859,
|
|
'source': {
|
|
'type': 'user',
|
|
'userId': 'U4af4980629'
|
|
}
|
|
}
|
|
]
|
|
}.with_indifferent_access
|
|
end
|
|
|
|
let(:multi_user_params) do
|
|
{
|
|
'destination': '2342234234',
|
|
'events': [
|
|
{
|
|
'replyToken': '0f3779fba3b349968c5d07db31eab56f1',
|
|
'type': 'message',
|
|
'mode': 'active',
|
|
'timestamp': 1_462_629_479_859,
|
|
'source': {
|
|
'type': 'user',
|
|
'userId': 'U4af4980629'
|
|
},
|
|
'message': {
|
|
'id': '3257081',
|
|
'type': 'text',
|
|
'text': 'Hello, world 1'
|
|
}
|
|
},
|
|
{
|
|
'replyToken': '0f3779fba3b349968c5d07db31eab56f2',
|
|
'type': 'message',
|
|
'mode': 'active',
|
|
'timestamp': 1_462_629_479_859,
|
|
'source': {
|
|
'type': 'user',
|
|
'userId': 'U4af49806292'
|
|
},
|
|
'message': {
|
|
'id': '3257082',
|
|
'type': 'text',
|
|
'text': 'Hello, world 2'
|
|
}
|
|
}
|
|
]
|
|
}.with_indifferent_access
|
|
end
|
|
|
|
let(:image_params) do
|
|
{
|
|
'destination': '2342234234',
|
|
'events': [
|
|
{
|
|
'replyToken': '0f3779fba3b349968c5d07db31eab56f',
|
|
'type': 'message',
|
|
'mode': 'active',
|
|
'timestamp': 1_462_629_479_859,
|
|
'source': {
|
|
'type': 'user',
|
|
'userId': 'U4af4980629'
|
|
},
|
|
'message': {
|
|
'type': 'image',
|
|
'id': '354718',
|
|
'contentProvider': {
|
|
'type': 'line'
|
|
}
|
|
}
|
|
},
|
|
{
|
|
'replyToken': '8cf9239d56244f4197887e939187e19e',
|
|
'type': 'follow',
|
|
'mode': 'active',
|
|
'timestamp': 1_462_629_479_859,
|
|
'source': {
|
|
'type': 'user',
|
|
'userId': 'U4af4980629'
|
|
}
|
|
}
|
|
]
|
|
}.with_indifferent_access
|
|
end
|
|
|
|
let(:video_params) do
|
|
{
|
|
'destination': '2342234234',
|
|
'events': [
|
|
{
|
|
'replyToken': '0f3779fba3b349968c5d07db31eab56f',
|
|
'type': 'message',
|
|
'mode': 'active',
|
|
'timestamp': 1_462_629_479_859,
|
|
'source': {
|
|
'type': 'user',
|
|
'userId': 'U4af4980629'
|
|
},
|
|
'message': {
|
|
'type': 'video',
|
|
'id': '354718',
|
|
'contentProvider': {
|
|
'type': 'line'
|
|
}
|
|
}
|
|
},
|
|
{
|
|
'replyToken': '8cf9239d56244f4197887e939187e19e',
|
|
'type': 'follow',
|
|
'mode': 'active',
|
|
'timestamp': 1_462_629_479_859,
|
|
'source': {
|
|
'type': 'user',
|
|
'userId': 'U4af4980629'
|
|
}
|
|
}
|
|
]
|
|
}.with_indifferent_access
|
|
end
|
|
|
|
let(:file_params) do
|
|
{
|
|
'destination': '2342234234',
|
|
'events': [
|
|
{
|
|
'replyToken': '0f3779fba3b349968c5d07db31eab56f',
|
|
'type': 'message',
|
|
'mode': 'active',
|
|
'timestamp': 1_462_629_479_859,
|
|
'source': {
|
|
'type': 'user',
|
|
'userId': 'U4af4980629'
|
|
},
|
|
'message': {
|
|
'type': 'file',
|
|
'id': '354718',
|
|
'fileName': 'contacts.csv',
|
|
'fileSize': 2978
|
|
}
|
|
},
|
|
{
|
|
'replyToken': '8cf9239d56244f4197887e939187e19e',
|
|
'type': 'follow',
|
|
'mode': 'active',
|
|
'timestamp': 1_462_629_479_859,
|
|
'source': {
|
|
'type': 'user',
|
|
'userId': 'U4af4980629'
|
|
}
|
|
}
|
|
]
|
|
}.with_indifferent_access
|
|
end
|
|
|
|
let(:sticker_params) do
|
|
{
|
|
'destination': '2342234234',
|
|
'events': [
|
|
{
|
|
'replyToken': '0f3779fba3b349968c5d07db31eab56f',
|
|
'type': 'message',
|
|
'mode': 'active',
|
|
'timestamp': 1_462_629_479_859,
|
|
'source': {
|
|
'type': 'user',
|
|
'userId': 'U4af4980629'
|
|
},
|
|
'message': {
|
|
'type': 'sticker',
|
|
'id': '1501597916',
|
|
'quoteToken': 'q3Plxr4AgKd...',
|
|
'stickerId': '52002738',
|
|
'packageId': '11537'
|
|
}
|
|
},
|
|
{
|
|
'replyToken': '8cf9239d56244f4197887e939187e19e',
|
|
'type': 'follow',
|
|
'mode': 'active',
|
|
'timestamp': 1_462_629_479_859,
|
|
'source': {
|
|
'type': 'user',
|
|
'userId': 'U4af4980629'
|
|
}
|
|
}
|
|
]
|
|
}.with_indifferent_access
|
|
end
|
|
|
|
describe '#perform' do
|
|
context 'when non-text message params' do
|
|
it 'does not create conversations, messages and contacts' 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
|
|
)
|
|
described_class.new(inbox: line_channel.inbox, params: follow_params).perform
|
|
expect(line_channel.inbox.conversations.size).to eq(0)
|
|
expect(Contact.all.size).to eq(0)
|
|
expect(line_channel.inbox.messages.size).to eq(0)
|
|
end
|
|
end
|
|
|
|
context 'when valid text message params' do
|
|
let(:line_bot) { double }
|
|
let(:line_user_profile) { double }
|
|
|
|
before do
|
|
allow(Line::Bot::Client).to receive(:new).and_return(line_bot)
|
|
allow(line_bot).to receive(:get_profile).with('U4af4980629').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
|
|
)
|
|
end
|
|
|
|
it 'creates appropriate conversations, message and contacts' do
|
|
described_class.new(inbox: line_channel.inbox, params: params).perform
|
|
expect(line_channel.inbox.conversations).not_to eq(0)
|
|
expect(Contact.all.first.name).to eq('LINE Test')
|
|
expect(Contact.all.first.additional_attributes['social_line_user_id']).to eq('U4af4980629')
|
|
expect(line_channel.inbox.messages.first.content).to eq('Hello, world')
|
|
end
|
|
|
|
it 'creates appropriate conversations, message and contacts for multi user' do
|
|
line_user_profile2 = double
|
|
allow(line_bot).to receive(:get_profile).with('U4af49806292').and_return(line_user_profile2)
|
|
allow(line_user_profile2).to receive(:body).and_return(
|
|
{
|
|
'displayName': 'LINE Test 2',
|
|
'userId': 'U4af49806292',
|
|
'pictureUrl': 'https://test.com'
|
|
}.to_json
|
|
)
|
|
described_class.new(inbox: line_channel.inbox, params: multi_user_params).perform
|
|
expect(line_channel.inbox.conversations.size).to eq(2)
|
|
expect(Contact.all.first.name).to eq('LINE Test')
|
|
expect(Contact.all.first.additional_attributes['social_line_user_id']).to eq('U4af4980629')
|
|
expect(Contact.all.last.name).to eq('LINE Test 2')
|
|
expect(Contact.all.last.additional_attributes['social_line_user_id']).to eq('U4af49806292')
|
|
expect(line_channel.inbox.messages.first.content).to eq('Hello, world 1')
|
|
expect(line_channel.inbox.messages.last.content).to eq('Hello, world 2')
|
|
end
|
|
end
|
|
|
|
context 'when valid sticker message params' do
|
|
it 'creates appropriate conversations, message and contacts' 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
|
|
)
|
|
described_class.new(inbox: line_channel.inbox, params: sticker_params).perform
|
|
expect(line_channel.inbox.conversations).not_to eq(0)
|
|
expect(Contact.all.first.name).to eq('LINE Test')
|
|
expect(line_channel.inbox.messages.first.content).to eq('')
|
|
end
|
|
end
|
|
|
|
context 'when valid image message params' do
|
|
it 'creates appropriate conversations, message and contacts' 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)
|
|
file = fixture_file_upload(Rails.root.join('spec/assets/avatar.png'), 'image/png')
|
|
allow(line_bot).to receive(:get_message_content).and_return(
|
|
OpenStruct.new({
|
|
body: Base64.encode64(file.read),
|
|
content_type: 'image/png'
|
|
})
|
|
)
|
|
allow(line_user_profile).to receive(:body).and_return(
|
|
{
|
|
'displayName': 'LINE Test',
|
|
'userId': 'U4af4980629',
|
|
'pictureUrl': 'https://test.com'
|
|
}.to_json
|
|
)
|
|
described_class.new(inbox: line_channel.inbox, params: image_params).perform
|
|
expect(line_channel.inbox.conversations).not_to eq(0)
|
|
expect(Contact.all.first.name).to eq('LINE Test')
|
|
expect(Contact.all.first.additional_attributes['social_line_user_id']).to eq('U4af4980629')
|
|
expect(line_channel.inbox.messages.first.content).to be_nil
|
|
expect(line_channel.inbox.messages.first.attachments.first.file_type).to eq('image')
|
|
expect(line_channel.inbox.messages.first.attachments.first.file.blob.filename.to_s).to eq('media-354718.png')
|
|
end
|
|
end
|
|
|
|
context 'when valid video message params' do
|
|
it 'creates appropriate conversations, message and contacts' 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)
|
|
file = fixture_file_upload(Rails.root.join('spec/assets/sample.mp4'), 'video/mp4')
|
|
allow(line_bot).to receive(:get_message_content).and_return(
|
|
OpenStruct.new({
|
|
body: Base64.encode64(file.read),
|
|
content_type: 'video/mp4'
|
|
})
|
|
)
|
|
allow(line_user_profile).to receive(:body).and_return(
|
|
{
|
|
'displayName': 'LINE Test',
|
|
'userId': 'U4af4980629',
|
|
'pictureUrl': 'https://test.com'
|
|
}.to_json
|
|
)
|
|
described_class.new(inbox: line_channel.inbox, params: video_params).perform
|
|
expect(line_channel.inbox.conversations).not_to eq(0)
|
|
expect(Contact.all.first.name).to eq('LINE Test')
|
|
expect(Contact.all.first.additional_attributes['social_line_user_id']).to eq('U4af4980629')
|
|
expect(line_channel.inbox.messages.first.content).to be_nil
|
|
expect(line_channel.inbox.messages.first.attachments.first.file_type).to eq('video')
|
|
expect(line_channel.inbox.messages.first.attachments.first.file.blob.filename.to_s).to eq('media-354718.mp4')
|
|
end
|
|
end
|
|
|
|
context 'when valid file message params' do
|
|
it 'creates appropriate conversations, message and contacts' 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)
|
|
file = fixture_file_upload(Rails.root.join('spec/assets/contacts.csv'), 'text/csv')
|
|
allow(line_bot).to receive(:get_message_content).and_return(
|
|
OpenStruct.new({
|
|
body: Base64.encode64(file.read),
|
|
content_type: 'text/csv'
|
|
})
|
|
)
|
|
allow(line_user_profile).to receive(:body).and_return(
|
|
{
|
|
'displayName': 'LINE Test',
|
|
'userId': 'U4af4980629',
|
|
'pictureUrl': 'https://test.com'
|
|
}.to_json
|
|
)
|
|
described_class.new(inbox: line_channel.inbox, params: file_params).perform
|
|
expect(line_channel.inbox.conversations).not_to eq(0)
|
|
expect(Contact.all.first.name).to eq('LINE Test')
|
|
expect(Contact.all.first.additional_attributes['social_line_user_id']).to eq('U4af4980629')
|
|
expect(line_channel.inbox.messages.first.content).to be_nil
|
|
expect(line_channel.inbox.messages.first.attachments.first.file_type).to eq('file')
|
|
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
|