fix: Update validations for filter service (#8239)

- Refactor filter service for better readability and maintenance
- Add validations for the following:
   - If an invalid attribute is passed, a custom exception InvalidAttribute will be thrown.
   - If an invalid operator is passed, a custom exception InvalidOperator will be thrown.
   - If an invalid value (currently checking only null check), a custom exception InvalidValue will be thrown.

Fixes: https://linear.app/chatwoot/issue/CW-2702/activerecordstatementinvalid-pginvalidtextrepresentation-error-invalid
Fixes: https://linear.app/chatwoot/issue/CW-2703/activerecordstatementinvalid-pginvaliddatetimeformat-error-invalid
Fixes:  https://linear.app/chatwoot/issue/CW-2700/activerecordstatementinvalid-pgsyntaxerror-error-syntax-error-at-or


Co-authored-by: Sojan <sojan@pepalo.com>

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

@@ -338,14 +338,18 @@ RSpec.describe 'Contacts API', type: :request do
 
     context 'when it is an authenticated user' do
       let(:admin) { create(:user, account: account, role: :administrator) }
-      let!(:contact1) { create(:contact, :with_email, account: account) }
-      let!(:contact2) { create(:contact, :with_email, name: 'testcontact', account: account, email: 'test@test.com') }
+      let!(:contact1) { create(:contact, :with_email, account: account, additional_attributes: { country_code: 'US' }) }
+      let!(:contact2) do
+        create(:contact, :with_email, name: 'testcontact', account: account, email: 'test@test.com', additional_attributes: { country_code: 'US' })
+      end
 
       it 'returns all contacts when query is empty' do
         post "/api/v1/accounts/#{account.id}/contacts/filter",
-             params: {
-               payload: []
-             },
+             params: { payload: [
+               attribute_key: 'country_code',
+               filter_operator: 'equal_to',
+               values: ['US']
+             ] },
              headers: admin.create_new_auth_token,
              as: :json
 
@@ -353,6 +357,34 @@ RSpec.describe 'Contacts API', type: :request do
         expect(response.body).to include(contact2.email)
         expect(response.body).to include(contact1.email)
       end
+
+      it 'returns error the query operator is invalid' do
+        post "/api/v1/accounts/#{account.id}/contacts/filter",
+             params: { payload: [
+               attribute_key: 'country_code',
+               filter_operator: 'eq',
+               values: ['US']
+             ] },
+             headers: admin.create_new_auth_token,
+             as: :json
+
+        expect(response).to have_http_status(:unprocessable_entity)
+        expect(response.body).to include('Invalid operator. The allowed operators for country_code are [equal_to,not_equal_to]')
+      end
+
+      it 'returns error the query value is invalid' do
+        post "/api/v1/accounts/#{account.id}/contacts/filter",
+             params: { payload: [
+               attribute_key: 'country_code',
+               filter_operator: 'equal_to',
+               values: []
+             ] },
+             headers: admin.create_new_auth_token,
+             as: :json
+
+        expect(response).to have_http_status(:unprocessable_entity)
+        expect(response.body).to include('Invalid value. The values provided for country_code are invalid"')
+      end
     end
   end
 

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

@@ -152,17 +152,56 @@ RSpec.describe 'Conversations API', type: :request do
         create(:inbox_member, user: agent, inbox: conversation.inbox)
       end
 
-      it 'returns all conversations with empty query' do
+      it 'returns all conversations matching the query' do
         post "/api/v1/accounts/#{account.id}/conversations/filter",
              headers: agent.create_new_auth_token,
-             params: { payload: [] },
+             params: {
+               payload: [{
+                 attribute_key: 'status',
+                 filter_operator: 'equal_to',
+                 values: ['open']
+               }]
+             },
              as: :json
 
         expect(response).to have_http_status(:success)
         response_data = JSON.parse(response.body, symbolize_names: true)
-
         expect(response_data.count).to eq(2)
       end
+
+      it 'returns error if the filters contain invalid attributes' do
+        post "/api/v1/accounts/#{account.id}/conversations/filter",
+             headers: agent.create_new_auth_token,
+             params: {
+               payload: [{
+                 attribute_key: 'phone_number',
+                 filter_operator: 'equal_to',
+                 values: ['open']
+               }]
+             },
+             as: :json
+
+        expect(response).to have_http_status(:unprocessable_entity)
+        response_data = JSON.parse(response.body, symbolize_names: true)
+        expect(response_data[:error]).to include('Invalid attribute key - [phone_number]')
+      end
+
+      it 'returns error if the filters contain invalid operator' do
+        post "/api/v1/accounts/#{account.id}/conversations/filter",
+             headers: agent.create_new_auth_token,
+             params: {
+               payload: [{
+                 attribute_key: 'status',
+                 filter_operator: 'eq',
+                 values: ['open']
+               }]
+             },
+             as: :json
+
+        expect(response).to have_http_status(:unprocessable_entity)
+        response_data = JSON.parse(response.body, symbolize_names: true)
+        expect(response_data[:error]).to eq('Invalid operator. The allowed operators for status are [equal_to,not_equal_to].')
+      end
     end
   end
 

spec/services/contacts/filter_service_spec.rb

@@ -7,9 +7,9 @@ describe Contacts::FilterService do
   let!(:first_user) { create(:user, account: account) }
   let!(:second_user) { create(:user, account: account) }
   let!(:inbox) { create(:inbox, account: account, enable_auto_assignment: false) }
-  let(:en_contact) { create(:contact, account: account, additional_attributes: { 'browser_language': 'en' }) }
-  let(:el_contact) { create(:contact, account: account, additional_attributes: { 'browser_language': 'el' }) }
-  let(:cs_contact) { create(:contact, account: account, additional_attributes: { 'browser_language': 'cs' }) }
+  let!(:en_contact) { create(:contact, account: account, additional_attributes: { 'country_code': 'uk' }) }
+  let!(:el_contact) { create(:contact, account: account, additional_attributes: { 'country_code': 'gr' }) }
+  let!(:cs_contact) { create(:contact, account: account, additional_attributes: { 'country_code': 'cz' }) }
 
   before do
     create(:inbox_member, user: first_user, inbox: inbox)
@@ -51,9 +51,9 @@ describe Contacts::FilterService do
       let(:payload) do
         [
           {
-            attribute_key: 'browser_language',
+            attribute_key: 'country_code',
             filter_operator: 'equal_to',
-            values: ['en'],
+            values: ['uk'],
             query_operator: nil
           }.with_indifferent_access
         ]
@@ -181,9 +181,9 @@ describe Contacts::FilterService do
             query_operator: 'AND'
           }.with_indifferent_access,
           {
-            attribute_key: 'browser_language',
+            attribute_key: 'country_code',
             filter_operator: 'equal_to',
-            values: ['el'],
+            values: ['GR'],
             query_operator: 'AND'
           }.with_indifferent_access,
           {

spec/services/conversations/filter_service_spec.rb

@@ -55,7 +55,7 @@ describe Conversations::FilterService do
         [
           {
             attribute_key: 'browser_language',
-            filter_operator: 'contains',
+            filter_operator: 'equal_to',
             values: 'en',
             query_operator: 'AND',
             custom_attribute_type: ''
@@ -88,7 +88,7 @@ describe Conversations::FilterService do
       it 'filters items with contains filter_operator with values being an array' do
         params[:payload] = [{
           attribute_key: 'browser_language',
-          filter_operator: 'contains',
+          filter_operator: 'equal_to',
           values: %w[tr fr],
           query_operator: '',
           custom_attribute_type: ''
@@ -106,7 +106,7 @@ describe Conversations::FilterService do
       it 'filters items with does not contain filter operator with values being an array' do
         params[:payload] = [{
           attribute_key: 'browser_language',
-          filter_operator: 'does_not_contain',
+          filter_operator: 'not_equal_to',
           values: %w[tr en],
           query_operator: '',
           custom_attribute_type: ''
@@ -291,6 +291,11 @@ describe Conversations::FilterService do
       end
 
       it 'filter by custom_attributes and additional_attributes' do
+        conversations = user_1.conversations
+        conversations[0].update!(additional_attributes: { 'browser_language': 'en' }, custom_attributes: { conversation_type: 'silver' })
+        conversations[1].update!(additional_attributes: { 'browser_language': 'en' }, custom_attributes: { conversation_type: 'platinum' })
+        conversations[2].update!(additional_attributes: { 'browser_language': 'tr' }, custom_attributes: { conversation_type: 'platinum' })
+
         params[:payload] = [
           {
             attribute_key: 'conversation_type',
@@ -301,7 +306,7 @@ describe Conversations::FilterService do
           }.with_indifferent_access,
           {
             attribute_key: 'browser_language',
-            filter_operator: 'is_equal_to',
+            filter_operator: 'not_equal_to',
             values: 'en',
             query_operator: nil,
             custom_attribute_type: ''