feat: Sentiment Analysis (#7475)

spec/enterprise/jobs/enterprise/sentiment_analysis_job_spec.rb

@@ -0,0 +1,82 @@
+require 'rails_helper'
+
+RSpec.describe Enterprise::SentimentAnalysisJob do
+  context 'when account locale set to english language' do
+    let(:account) { create(:account, locale: 'en') }
+    let(:message) { build(:message, content_type: nil, account: account) }
+
+    context 'when update the message sentiments' do
+      let(:model_path) { 'sentiment-analysis.onnx' }
+      let(:model) { double }
+
+      before do
+        allow(Informers::SentimentAnalysis).to receive(:new).with(model_path).and_return(model)
+        allow(model).to receive(:predict).and_return({ label: 'positive', score: '0.6' })
+      end
+
+      it 'with incoming message' do
+        with_modified_env SENTIMENT_FILE_PATH: 'sentiment-analysis.onnx' do
+          message.update(message_type: :incoming)
+
+          described_class.perform_now(message)
+
+          expect(message.sentiment).not_to be_empty
+        end
+      end
+
+      it 'update sentiment label for positive message' do
+        with_modified_env SENTIMENT_FILE_PATH: 'sentiment-analysis.onnx' do
+          message.update(message_type: :incoming, content: 'I like your product')
+
+          described_class.perform_now(message)
+
+          expect(message.sentiment).not_to be_empty
+          expect(message.sentiment['label']).to eq('positive')
+          expect(message.sentiment['value']).to eq(1)
+        end
+      end
+
+      it 'update sentiment label for negative message' do
+        with_modified_env SENTIMENT_FILE_PATH: 'sentiment-analysis.onnx' do
+          message.update(message_type: :incoming, content: 'I did not like your product')
+          allow(model).to receive(:predict).and_return({ label: 'negative', score: '0.6' })
+
+          described_class.perform_now(message)
+
+          expect(message.sentiment).not_to be_empty
+          expect(message.sentiment['label']).to eq('negative')
+          expect(message.sentiment['value']).to eq(-1)
+        end
+      end
+    end
+
+    context 'when does not update the message sentiments' do
+      it 'with outgoing message' do
+        message.update(message_type: :outgoing)
+
+        described_class.perform_now(message)
+
+        expect(message.sentiment).to be_empty
+      end
+
+      it 'with private message' do
+        message.update(private: true)
+
+        described_class.perform_now(message)
+
+        expect(message.sentiment).to be_empty
+      end
+    end
+  end
+
+  context 'when account locale is not set to english language' do
+    let(:account) { create(:account, locale: 'es') }
+    let(:message) { build(:message, content_type: nil, account: account) }
+
+    it 'does not update the message sentiments' do
+      described_class.perform_now(message)
+
+      expect(message.sentiment).to be_empty
+    end
+  end
+end

spec/enterprise/models/conversation_spec.rb

@@ -4,4 +4,34 @@ RSpec.describe Conversation, type: :model do
   describe 'associations' do
     it { is_expected.to belong_to(:sla_policy).optional }
   end
+
+  describe 'conversation sentiments' do
+    include ActiveJob::TestHelper
+
+    let(:conversation) { create(:conversation, additional_attributes: { referer: 'https://www.chatwoot.com/' }) }
+
+    before do
+      10.times do
+        message = create(:message, conversation_id: conversation.id, account_id: conversation.account_id, message_type: 'incoming')
+        message.update(sentiment: { 'label': 'positive', score: '0.4' })
+      end
+    end
+
+    it 'returns opening sentiments' do
+      sentiments = conversation.opening_sentiments
+      expect(sentiments[:label]).to eq('positive')
+    end
+
+    it 'returns closing sentiments if conversation is not resolved' do
+      sentiments = conversation.closing_sentiments
+      expect(sentiments).to be_nil
+    end
+
+    it 'returns closing sentiments if it is resolved' do
+      conversation.resolved!
+
+      sentiments = conversation.closing_sentiments
+      expect(sentiments[:label]).to eq('positive')
+    end
+  end
 end

spec/enterprise/models/message_spec.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+require Rails.root.join 'spec/models/concerns/liquidable_shared.rb'
+
+RSpec.describe Message do
+  context 'with sentiment analysis' do
+    let(:message) { build(:message, message_type: :incoming, content_type: nil, account: create(:account)) }
+
+    it 'calls SentimentAnalysisJob' do
+      allow(Enterprise::SentimentAnalysisJob).to receive(:perform_later).and_return(:perform_later).with(message)
+
+      message.save!
+
+      expect(Enterprise::SentimentAnalysisJob).to have_received(:perform_later)
+    end
+  end
+end