feat: Ability to lock to single conversation (#5881)

Adds the ability to lock conversation to a single thread for Whatsapp and Sms Inboxes when using outbound messages.

demo: https://www.loom.com/share/c9e1e563c8914837a4139dfdd2503fef

fixes: #4975

Co-authored-by: Nithin David <1277421+nithindavid@users.noreply.github.com>

spec/builders/conversation_builder_spec.rb

@@ -0,0 +1,46 @@
+require 'rails_helper'
+
+describe ::ConversationBuilder do
+  let(:account) { create(:account) }
+  let!(:sms_channel) { create(:channel_sms, account: account) }
+  let!(:sms_inbox) { create(:inbox, channel: sms_channel, account: account) }
+  let(:contact) { create(:contact, account: account) }
+  let(:contact_inbox) { create(:contact_inbox, contact: contact, inbox: sms_inbox) }
+
+  describe '#perform' do
+    it 'creates conversation' do
+      conversation = described_class.new(
+        contact_inbox: contact_inbox,
+        params: {}
+      ).perform
+
+      expect(conversation.contact_inbox_id).to eq(contact_inbox.id)
+    end
+
+    context 'when lock_to_single_conversation is true for inbox' do
+      before do
+        sms_inbox.update!(lock_to_single_conversation: true)
+      end
+
+      it 'creates conversation when existing conversation is not present' do
+        conversation = described_class.new(
+          contact_inbox: contact_inbox,
+          params: {}
+        ).perform
+
+        expect(conversation.contact_inbox_id).to eq(contact_inbox.id)
+      end
+
+      it 'returns last from existing conversations when existing conversation is not present' do
+        create(:conversation, contact_inbox: contact_inbox)
+        existing_conversation = create(:conversation, contact_inbox: contact_inbox)
+        conversation = described_class.new(
+          contact_inbox: contact_inbox,
+          params: {}
+        ).perform
+
+        expect(conversation.id).to eq(existing_conversation.id)
+      end
+    end
+  end
+end

spec/controllers/api/v1/accounts/conversations_controller_spec.rb

@@ -265,17 +265,18 @@ RSpec.describe 'Conversations API', type: :request do
 
         # TODO: remove this spec when we remove the condition check in controller
         # Added for backwards compatibility for bot status
-        it 'creates a conversation as pending if status is specified as bot' do
-          allow(Rails.configuration.dispatcher).to receive(:dispatch)
-          post "/api/v1/accounts/#{account.id}/conversations",
-               headers: agent.create_new_auth_token,
-               params: { source_id: contact_inbox.source_id, status: 'bot' },
-               as: :json
+        # remove this in subsequent release
+        # it 'creates a conversation as pending if status is specified as bot' do
+        #   allow(Rails.configuration.dispatcher).to receive(:dispatch)
+        #   post "/api/v1/accounts/#{account.id}/conversations",
+        #        headers: agent.create_new_auth_token,
+        #        params: { source_id: contact_inbox.source_id, status: 'bot' },
+        #        as: :json
 
-          expect(response).to have_http_status(:success)
-          response_data = JSON.parse(response.body, symbolize_names: true)
-          expect(response_data[:status]).to eq('pending')
-        end
+        #   expect(response).to have_http_status(:success)
+        #   response_data = JSON.parse(response.body, symbolize_names: true)
+        #   expect(response_data[:status]).to eq('pending')
+        # end
 
         it 'creates a new conversation with message when message is passed' do
           allow(Rails.configuration.dispatcher).to receive(:dispatch)
@@ -408,17 +409,18 @@ RSpec.describe 'Conversations API', type: :request do
 
       # TODO: remove this spec when we remove the condition check in controller
       # Added for backwards compatibility for bot status
-      it 'toggles the conversation status to pending status when parameter bot is passed' do
-        expect(conversation.status).to eq('open')
+      # remove in next release
+      # it 'toggles the conversation status to pending status when parameter bot is passed' do
+      #   expect(conversation.status).to eq('open')
 
-        post "/api/v1/accounts/#{account.id}/conversations/#{conversation.display_id}/toggle_status",
-             headers: agent.create_new_auth_token,
-             params: { status: 'bot' },
-             as: :json
+      #   post "/api/v1/accounts/#{account.id}/conversations/#{conversation.display_id}/toggle_status",
+      #        headers: agent.create_new_auth_token,
+      #        params: { status: 'bot' },
+      #        as: :json
 
-        expect(response).to have_http_status(:success)
-        expect(conversation.reload.status).to eq('pending')
-      end
+      #   expect(response).to have_http_status(:success)
+      #   expect(conversation.reload.status).to eq('pending')
+      # end
     end
   end