require 'rails_helper' RSpec.describe 'Conversation Messages API', type: :request do let!(:account) { create(:account) } describe 'POST /api/v1/accounts/{account.id}/conversations//messages' do let!(:inbox) { create(:inbox, account: account) } let!(:conversation) { create(:conversation, inbox: inbox, account: account) } context 'when it is an unauthenticated user' do it 'returns unauthorized' do post api_v1_account_conversation_messages_url(account_id: account.id, conversation_id: conversation.display_id) expect(response).to have_http_status(:unauthorized) end end context 'when it is an authenticated user with access to conversation' do let(:agent) { create(:user, account: account, role: :agent) } before do create(:inbox_member, inbox: conversation.inbox, user: agent) end it 'creates a new outgoing message' do params = { content: 'test-message', private: true } post api_v1_account_conversation_messages_url(account_id: account.id, conversation_id: conversation.display_id), params: params, headers: agent.create_new_auth_token, as: :json expect(response).to have_http_status(:success) expect(conversation.messages.count).to eq(1) expect(conversation.messages.first.content).to eq(params[:content]) end it 'does not create the message' do params = { content: "#{'h' * 150 * 1000}a", private: true } post api_v1_account_conversation_messages_url(account_id: account.id, conversation_id: conversation.display_id), params: params, headers: agent.create_new_auth_token, as: :json expect(response).to have_http_status(:unprocessable_entity) json_response = response.parsed_body expect(json_response['error']).to eq('Validation failed: Content is too long (maximum is 150000 characters)') end it 'creates an outgoing text message with a specific bot sender' do agent_bot = create(:agent_bot) time_stamp = Time.now.utc.to_s params = { content: 'test-message', external_created_at: time_stamp, sender_type: 'AgentBot', sender_id: agent_bot.id } post api_v1_account_conversation_messages_url(account_id: account.id, conversation_id: conversation.display_id), params: params, headers: agent.create_new_auth_token, as: :json expect(response).to have_http_status(:success) response_data = response.parsed_body expect(response_data['content_attributes']['external_created_at']).to eq time_stamp expect(conversation.messages.count).to eq(1) expect(conversation.messages.last.sender_id).to eq(agent_bot.id) expect(conversation.messages.last.content_type).to eq('text') end it 'creates a new outgoing message with attachment' do file = fixture_file_upload(Rails.root.join('spec/assets/avatar.png'), 'image/png') params = { content: 'test-message', attachments: [file] } post api_v1_account_conversation_messages_url(account_id: account.id, conversation_id: conversation.display_id), params: params, headers: agent.create_new_auth_token expect(response).to have_http_status(:success) expect(conversation.messages.last.attachments.first.file.present?).to be(true) expect(conversation.messages.last.attachments.first.file_type).to eq('image') end it 'triggers typing off event for non-private messages' do params = { content: 'test-message', private: false } allow(Rails.configuration.dispatcher).to receive(:dispatch).and_call_original post api_v1_account_conversation_messages_url(account_id: account.id, conversation_id: conversation.display_id), params: params, headers: agent.create_new_auth_token, as: :json expect(response).to have_http_status(:success) expect(Rails.configuration.dispatcher).to have_received(:dispatch) .with('conversation.typing_off', kind_of(Time), hash_including(conversation: conversation, user: agent, is_private: false)) end it 'triggers typing off event for private messages' do params = { content: 'test-message', private: true } allow(Rails.configuration.dispatcher).to receive(:dispatch).and_call_original post api_v1_account_conversation_messages_url(account_id: account.id, conversation_id: conversation.display_id), params: params, headers: agent.create_new_auth_token, as: :json expect(response).to have_http_status(:success) expect(Rails.configuration.dispatcher).to have_received(:dispatch) .with('conversation.typing_off', kind_of(Time), hash_including(conversation: conversation, user: agent, is_private: true)) end context 'when api inbox' do let(:api_channel) { create(:channel_api, account: account) } let(:api_inbox) { create(:inbox, channel: api_channel, account: account) } let(:conversation) { create(:conversation, inbox: api_inbox, account: account) } it 'reopens the conversation with new incoming message' do create(:message, conversation: conversation, account: account) conversation.resolved! params = { content: 'test-message', private: false, message_type: 'incoming' } post api_v1_account_conversation_messages_url(account_id: account.id, conversation_id: conversation.display_id), params: params, headers: agent.create_new_auth_token, as: :json expect(response).to have_http_status(:success) expect(conversation.reload.status).to eq('open') expect(Conversations::ActivityMessageJob) .to(have_been_enqueued.at_least(:once) .with(conversation, { account_id: conversation.account_id, inbox_id: conversation.inbox_id, message_type: :activity, content: 'System reopened the conversation due to a new incoming message.' })) end end end context 'when it is an authenticated agent bot' do let!(:agent_bot) { create(:agent_bot) } it 'creates a new outgoing message' do create(:agent_bot_inbox, inbox: inbox, agent_bot: agent_bot) params = { content: 'test-message' } post api_v1_account_conversation_messages_url(account_id: account.id, conversation_id: conversation.display_id), params: params, headers: { api_access_token: agent_bot.access_token.token }, as: :json expect(response).to have_http_status(:success) expect(conversation.messages.count).to eq(1) expect(conversation.messages.first.content).to eq(params[:content]) end it 'creates a new outgoing input select message' do create(:agent_bot_inbox, inbox: inbox, agent_bot: agent_bot) select_item1 = build(:bot_message_select) select_item2 = build(:bot_message_select) params = { content_type: 'input_select', content_attributes: { items: [select_item1, select_item2] } } post api_v1_account_conversation_messages_url(account_id: account.id, conversation_id: conversation.display_id), params: params, headers: { api_access_token: agent_bot.access_token.token }, as: :json expect(response).to have_http_status(:success) expect(conversation.messages.count).to eq(1) expect(conversation.messages.first.content_type).to eq(params[:content_type]) expect(conversation.messages.first.content).to be_nil end it 'creates a new outgoing cards message' do create(:agent_bot_inbox, inbox: inbox, agent_bot: agent_bot) card = build(:bot_message_card) params = { content_type: 'cards', content_attributes: { items: [card] } } post api_v1_account_conversation_messages_url(account_id: account.id, conversation_id: conversation.display_id), params: params, headers: { api_access_token: agent_bot.access_token.token }, as: :json expect(response).to have_http_status(:success) expect(conversation.messages.count).to eq(1) expect(conversation.messages.first.content_type).to eq(params[:content_type]) end end end describe 'GET /api/v1/accounts/{account.id}/conversations/:id/messages' do let(:conversation) { create(:conversation, account: account) } context 'when it is an unauthenticated user' do it 'returns unauthorized' do get "/api/v1/accounts/#{account.id}/conversations/#{conversation.display_id}/messages" expect(response).to have_http_status(:unauthorized) end end context 'when it is an authenticated user with access to conversation' do let(:agent) { create(:user, account: account, role: :agent) } before do create(:inbox_member, inbox: conversation.inbox, user: agent) end it 'shows the conversation' do get "/api/v1/accounts/#{account.id}/conversations/#{conversation.display_id}/messages", headers: agent.create_new_auth_token, as: :json expect(response).to have_http_status(:success) expect(JSON.parse(response.body, symbolize_names: true)[:meta][:contact][:id]).to eq(conversation.contact_id) end end end describe 'DELETE /api/v1/accounts/{account.id}/conversations/:conversation_id/messages/:id' do let(:message) { create(:message, account: account, content_attributes: { bcc_emails: ['hello@chatwoot.com'] }) } let(:conversation) { message.conversation } context 'when it is an unauthenticated user' do it 'returns unauthorized' do delete "/api/v1/accounts/#{account.id}/conversations/#{conversation.display_id}/messages/#{message.id}" expect(response).to have_http_status(:unauthorized) end end context 'when it is an authenticated user with access to conversation' do let(:agent) { create(:user, account: account, role: :agent) } before do create(:inbox_member, inbox: conversation.inbox, user: agent) end it 'deletes the message' do delete "/api/v1/accounts/#{account.id}/conversations/#{conversation.display_id}/messages/#{message.id}", headers: agent.create_new_auth_token, as: :json expect(response).to have_http_status(:success) expect(message.reload.content).to eq 'This message was deleted' expect(message.reload.deleted).to be true expect(message.reload.content_attributes['bcc_emails']).to be_nil end it 'deletes interactive messages' do interactive_message = create( :message, message_type: :outgoing, content: 'test', content_type: 'input_select', content_attributes: { 'items' => [{ 'title' => 'test', 'value' => 'test' }] }, conversation: conversation ) delete "/api/v1/accounts/#{account.id}/conversations/#{conversation.display_id}/messages/#{interactive_message.id}", headers: agent.create_new_auth_token, as: :json expect(response).to have_http_status(:success) expect(interactive_message.reload.deleted).to be true end end context 'when the message id is invalid' do let(:agent) { create(:user, account: account, role: :agent) } before do create(:inbox_member, inbox: conversation.inbox, user: agent) end it 'returns not found error' do delete "/api/v1/accounts/#{account.id}/conversations/#{conversation.display_id}/messages/99999", headers: agent.create_new_auth_token, as: :json expect(response).to have_http_status(:not_found) end end context 'when channel supports delete_message' do let(:whatsapp_channel) { create(:channel_whatsapp, provider: 'baileys', account: account, validate_provider_config: false) } let(:whatsapp_inbox) { whatsapp_channel.inbox } let(:contact) { create(:contact, account: account, identifier: '+551187654321', phone_number: '+551187654321') } let(:contact_inbox) { create(:contact_inbox, inbox: whatsapp_inbox, contact: contact) } let(:whatsapp_conversation) { create(:conversation, inbox: whatsapp_inbox, account: account, contact: contact, contact_inbox: contact_inbox) } let(:message_with_source) do create(:message, account: account, conversation: whatsapp_conversation, inbox: whatsapp_inbox, source_id: 'msg_123', message_type: :outgoing) end let(:agent) { create(:user, account: account, role: :agent) } let(:delete_request_path) { "#{whatsapp_channel.provider_config['provider_url']}/connections/#{whatsapp_channel.phone_number}/messages" } before do create(:inbox_member, inbox: whatsapp_inbox, user: agent) end it 'calls delete_message on the channel' do delete_stub = stub_request(:delete, delete_request_path) .with( headers: { 'Content-Type' => 'application/json', 'x-api-key' => whatsapp_channel.provider_config['api_key'] }, body: hash_including(jid: "#{contact.identifier.delete('+')}@s.whatsapp.net") ) .to_return(status: 200, body: '{}') delete "/api/v1/accounts/#{account.id}/conversations/#{whatsapp_conversation.display_id}/messages/#{message_with_source.id}", headers: agent.create_new_auth_token, as: :json expect(response).to have_http_status(:success) expect(message_with_source.reload.deleted).to be true expect(delete_stub).to have_been_requested end it 'does not fail when channel delete_message raises an error' do stub_request(:delete, delete_request_path) .to_return(status: 400, body: 'Provider error') stub_request(:post, "#{whatsapp_channel.provider_config['provider_url']}/connections/#{whatsapp_channel.phone_number}") .to_return(status: 200) allow(Rails.logger).to receive(:error) delete "/api/v1/accounts/#{account.id}/conversations/#{whatsapp_conversation.display_id}/messages/#{message_with_source.id}", headers: agent.create_new_auth_token, as: :json expect(response).to have_http_status(:success) expect(message_with_source.reload.deleted).to be true end it 'skips channel deletion when message has no source_id' do message_without_source = create(:message, account: account, conversation: whatsapp_conversation, inbox: whatsapp_inbox, source_id: nil) delete_stub = stub_request(:delete, delete_request_path).to_return(status: 200, body: '{}') delete "/api/v1/accounts/#{account.id}/conversations/#{whatsapp_conversation.display_id}/messages/#{message_without_source.id}", headers: agent.create_new_auth_token, as: :json expect(response).to have_http_status(:success) expect(message_without_source.reload.deleted).to be true expect(delete_stub).not_to have_been_requested end end context 'when channel does not support delete_message' do let(:message_with_source) { create(:message, account: account, conversation: conversation, source_id: 'msg_123') } let(:agent) { create(:user, account: account, role: :agent) } before do create(:inbox_member, inbox: conversation.inbox, user: agent) end it 'skips channel deletion' do delete "/api/v1/accounts/#{account.id}/conversations/#{conversation.display_id}/messages/#{message_with_source.id}", headers: agent.create_new_auth_token, as: :json expect(response).to have_http_status(:success) expect(message_with_source.reload.deleted).to be true end end end describe 'POST /api/v1/accounts/{account.id}/conversations/:conversation_id/messages/:id/retry' do let(:message) { create(:message, account: account, message_type: :outgoing, status: :failed, content_attributes: { external_error: 'error' }) } context 'when it is an unauthenticated user' do it 'returns unauthorized' do post "/api/v1/accounts/#{account.id}/conversations/#{message.conversation.display_id}/messages/#{message.id}/retry" expect(response).to have_http_status(:unauthorized) end end context 'when it is an authenticated user with access to conversation' do let(:agent) { create(:user, account: account, role: :agent) } before do create(:inbox_member, inbox: message.conversation.inbox, user: agent) end it 'retries the message' do post "/api/v1/accounts/#{account.id}/conversations/#{message.conversation.display_id}/messages/#{message.id}/retry", headers: agent.create_new_auth_token, as: :json expect(response).to have_http_status(:success) expect(message.reload.status).to eq('sent') expect(message.reload.content_attributes['external_error']).to be_nil end it 'clears source_id so the send job does not skip the message' do message.update!(source_id: 'wamid.old_message_id') post "/api/v1/accounts/#{account.id}/conversations/#{message.conversation.display_id}/messages/#{message.id}/retry", headers: agent.create_new_auth_token, as: :json expect(response).to have_http_status(:success) expect(message.reload.source_id).to be_nil end end context 'when the message is not failed or not outgoing' do let(:agent) { create(:user, account: account, role: :agent) } let(:sent_message) { create(:message, account: account, message_type: :outgoing, status: :sent) } let(:incoming_failed) { create(:message, account: account, message_type: :incoming, status: :failed) } before do create(:inbox_member, inbox: sent_message.conversation.inbox, user: agent) create(:inbox_member, inbox: incoming_failed.conversation.inbox, user: agent) end it 'returns unprocessable_entity for non-failed messages' do post "/api/v1/accounts/#{account.id}/conversations/#{sent_message.conversation.display_id}/messages/#{sent_message.id}/retry", headers: agent.create_new_auth_token, as: :json expect(response).to have_http_status(:unprocessable_entity) end it 'returns unprocessable_entity for incoming messages' do post "/api/v1/accounts/#{account.id}/conversations/#{incoming_failed.conversation.display_id}/messages/#{incoming_failed.id}/retry", headers: agent.create_new_auth_token, as: :json expect(response).to have_http_status(:unprocessable_entity) end end context 'when the message id is invalid' do let(:agent) { create(:user, account: account, role: :agent) } before do create(:inbox_member, inbox: message.conversation.inbox, user: agent) end it 'returns not found error' do post "/api/v1/accounts/#{account.id}/conversations/#{message.conversation.display_id}/messages/99999/retry", headers: agent.create_new_auth_token, as: :json expect(response).to have_http_status(:unprocessable_entity) end end end describe 'PATCH /api/v1/accounts/{account.id}/conversations/:conversation_id/messages/:id' do let(:api_channel) { create(:channel_api, account: account) } let(:api_inbox) { create(:inbox, channel: api_channel, account: account) } let(:agent) { create(:user, account: account, role: :agent) } let!(:conversation) { create(:conversation, inbox: api_inbox, account: account) } let!(:message) { create(:message, conversation: conversation, account: account, status: :sent) } context 'when unauthenticated' do it 'returns unauthorized' do patch api_v1_account_conversation_message_url(account_id: account.id, conversation_id: conversation.display_id, id: message.id) expect(response).to have_http_status(:unauthorized) end end context 'when authenticated agent' do context 'when agent has non-API inbox' do let(:inbox) { create(:inbox, account: account) } let(:agent) { create(:user, account: account, role: :agent) } let!(:conversation) { create(:conversation, inbox: inbox, account: account) } before { create(:inbox_member, inbox: inbox, user: agent) } it 'returns forbidden' do patch api_v1_account_conversation_message_url( account_id: account.id, conversation_id: conversation.display_id, id: message.id ), params: { status: 'failed', external_error: 'err' }, headers: agent.create_new_auth_token, as: :json expect(response).to have_http_status(:forbidden) end end context 'when agent has API inbox' do before { create(:inbox_member, inbox: api_inbox, user: agent) } it 'uses StatusUpdateService to perform status update' do service = instance_double(Messages::StatusUpdateService) expect(Messages::StatusUpdateService).to receive(:new) .with(message, 'failed', 'err123') .and_return(service) expect(service).to receive(:perform) patch api_v1_account_conversation_message_url( account_id: account.id, conversation_id: conversation.display_id, id: message.id ), params: { status: 'failed', external_error: 'err123' }, headers: agent.create_new_auth_token, as: :json end it 'updates status to failed with external_error' do patch api_v1_account_conversation_message_url( account_id: account.id, conversation_id: conversation.display_id, id: message.id ), params: { status: 'failed', external_error: 'err123' }, headers: agent.create_new_auth_token, as: :json expect(response).to have_http_status(:success) expect(message.reload.status).to eq('failed') expect(message.reload.external_error).to eq('err123') end end end end end