## 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>
165 lines
5.7 KiB
Ruby
165 lines
5.7 KiB
Ruby
require 'rails_helper'
|
|
|
|
RSpec.describe Tiktok::MessageService do
|
|
let(:account) { create(:account) }
|
|
let(:channel) { create(:channel_tiktok, account: account, business_id: 'biz-123') }
|
|
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',
|
|
message_id: 'tt-msg-1',
|
|
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
|
|
|
|
expect do
|
|
service = described_class.new(channel: channel, content: content)
|
|
allow(service).to receive(:create_contact_inbox).and_return(contact_inbox)
|
|
service.perform
|
|
end.to change(Message, :count).by(1)
|
|
|
|
message = Message.last
|
|
expect(message.inbox).to eq(inbox)
|
|
expect(message.message_type).to eq('incoming')
|
|
expect(message.content).to eq('Hello from TikTok')
|
|
expect(message.source_id).to eq('tt-msg-1')
|
|
expect(message.sender).to eq(contact)
|
|
expect(message.content_attributes['is_unsupported']).to be_nil
|
|
end
|
|
|
|
it 'creates an incoming unsupported message for non-supported types' do
|
|
content = {
|
|
type: 'sticker',
|
|
message_id: 'tt-msg-2',
|
|
timestamp: 1_700_000_000_000,
|
|
conversation_id: 'tt-conv-1',
|
|
from: 'Alice',
|
|
from_user: { id: 'user-1' },
|
|
to: 'Biz',
|
|
to_user: { id: 'biz-123' }
|
|
}.deep_symbolize_keys
|
|
|
|
service = described_class.new(channel: channel, content: content)
|
|
allow(service).to receive(:create_contact_inbox).and_return(contact_inbox)
|
|
service.perform
|
|
|
|
message = Message.last
|
|
expect(message.content).to be_nil
|
|
expect(message.content_attributes['is_unsupported']).to be true
|
|
end
|
|
|
|
it 'creates an incoming embed attachment for share_post messages' do
|
|
content = {
|
|
type: 'share_post',
|
|
message_id: 'tt-msg-3',
|
|
timestamp: 1_700_000_000_000,
|
|
conversation_id: 'tt-conv-1',
|
|
share_post: { embed_url: 'https://www.tiktok.com/embed/123' },
|
|
from: 'Alice',
|
|
from_user: { id: 'user-1' },
|
|
to: 'Biz',
|
|
to_user: { id: 'biz-123' }
|
|
}.deep_symbolize_keys
|
|
|
|
service = described_class.new(channel: channel, content: content)
|
|
allow(service).to receive(:create_contact_inbox).and_return(contact_inbox)
|
|
service.perform
|
|
|
|
message = Message.last
|
|
expect(message.attachments.count).to eq(1)
|
|
attachment = message.attachments.last
|
|
expect(attachment.file_type).to eq('embed')
|
|
expect(attachment.external_url).to eq('https://www.tiktok.com/embed/123')
|
|
end
|
|
|
|
it 'creates an incoming image attachment when media is present' do
|
|
content = {
|
|
type: 'image',
|
|
message_id: 'tt-msg-4',
|
|
timestamp: 1_700_000_000_000,
|
|
conversation_id: 'tt-conv-1',
|
|
image: { media_id: 'media-1' },
|
|
from: 'Alice',
|
|
from_user: { id: 'user-1' },
|
|
to: 'Biz',
|
|
to_user: { id: 'biz-123' }
|
|
}.deep_symbolize_keys
|
|
|
|
tempfile = Tempfile.new(['tiktok', '.png'])
|
|
tempfile.write('fake-image')
|
|
tempfile.rewind
|
|
tempfile.define_singleton_method(:original_filename) { 'tiktok.png' }
|
|
tempfile.define_singleton_method(:content_type) { 'image/png' }
|
|
|
|
service = described_class.new(channel: channel, content: content)
|
|
allow(service).to receive(:create_contact_inbox).and_return(contact_inbox)
|
|
allow(service).to receive(:fetch_attachment).and_return(tempfile)
|
|
|
|
service.perform
|
|
|
|
message = Message.last
|
|
expect(message.attachments.count).to eq(1)
|
|
expect(message.attachments.last.file_type).to eq('image')
|
|
expect(message.attachments.last.file).to be_attached
|
|
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
|