diff --git a/Gemfile b/Gemfile index e6c5a5250..0636b7b2b 100644 --- a/Gemfile +++ b/Gemfile @@ -191,7 +191,7 @@ gem 'reverse_markdown' gem 'iso-639' gem 'ruby-openai' -gem 'ai-agents' +gem 'ai-agents', '>= 0.9.1' # TODO: Move this gem as a dependency of ai-agents gem 'ruby_llm', '>= 1.8.2' diff --git a/Gemfile.lock b/Gemfile.lock index aad0438cf..7a7316e3c 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -126,7 +126,7 @@ GEM jbuilder (~> 2) rails (>= 4.2, < 7.2) selectize-rails (~> 0.6) - ai-agents (0.9.0) + ai-agents (0.9.1) ruby_llm (~> 1.9.1) annotaterb (4.20.0) activerecord (>= 6.0.0) @@ -1024,7 +1024,7 @@ DEPENDENCIES administrate (>= 0.20.1) administrate-field-active_storage (>= 1.0.3) administrate-field-belongs_to_search (>= 0.9.0) - ai-agents + ai-agents (>= 0.9.1) annotaterb attr_extras audited (~> 5.4, >= 5.4.1) diff --git a/app/builders/messages/facebook/message_builder.rb b/app/builders/messages/facebook/message_builder.rb index 2c55922f6..1f59deadb 100644 --- a/app/builders/messages/facebook/message_builder.rb +++ b/app/builders/messages/facebook/message_builder.rb @@ -105,15 +105,19 @@ class Messages::Facebook::MessageBuilder < Messages::Messenger::MessageBuilder end def message_params + content_attributes = { + in_reply_to_external_id: response.in_reply_to_external_id + } + content_attributes[:external_echo] = true if @outgoing_echo + { account_id: conversation.account_id, inbox_id: conversation.inbox_id, message_type: @message_type, + status: @outgoing_echo ? :delivered : :sent, content: response.content, source_id: response.identifier, - content_attributes: { - in_reply_to_external_id: response.in_reply_to_external_id - }, + content_attributes: content_attributes, sender: @outgoing_echo ? nil : @contact_inbox.contact } end diff --git a/app/controllers/api/v1/accounts/inbox_csat_templates_controller.rb b/app/controllers/api/v1/accounts/inbox_csat_templates_controller.rb index bb5dab680..d7244616d 100644 --- a/app/controllers/api/v1/accounts/inbox_csat_templates_controller.rb +++ b/app/controllers/api/v1/accounts/inbox_csat_templates_controller.rb @@ -1,6 +1,7 @@ class Api::V1::Accounts::InboxCsatTemplatesController < Api::V1::Accounts::BaseController before_action :fetch_inbox before_action :validate_whatsapp_channel + before_action :validate_captain_enabled, only: [:analyze] def show service = CsatTemplateManagementService.new(@inbox) @@ -24,6 +25,23 @@ class Api::V1::Accounts::InboxCsatTemplatesController < Api::V1::Accounts::BaseC render json: { error: 'Template parameters are required' }, status: :unprocessable_entity end + def analyze + template_params = extract_template_params + return render_missing_message_error if template_params[:message].blank? + + result = CsatTemplateUtilityAnalysisService.new( + account: Current.account, + inbox: @inbox, + message: template_params[:message], + button_text: template_params[:button_text], + language: template_params[:language] + ).perform + + render json: result + rescue ActionController::ParameterMissing + render json: { error: 'Template parameters are required' }, status: :unprocessable_entity + end + private def fetch_inbox @@ -46,6 +64,12 @@ class Api::V1::Accounts::InboxCsatTemplatesController < Api::V1::Accounts::BaseC render json: { error: 'Message is required' }, status: :unprocessable_entity end + def validate_captain_enabled + return if Current.account.feature_enabled?('captain_integration') + + render json: { error: 'Captain is required for template analysis' }, status: :forbidden + end + def render_template_creation_result(result) if result[:success] render_successful_template_creation(result) diff --git a/app/finders/conversation_finder.rb b/app/finders/conversation_finder.rb index 7821bee49..fa437327d 100644 --- a/app/finders/conversation_finder.rb +++ b/app/finders/conversation_finder.rb @@ -11,6 +11,7 @@ class ConversationFinder 'priority_desc' => %w[sort_on_priority desc], 'waiting_since_asc' => %w[sort_on_waiting_since asc], 'waiting_since_desc' => %w[sort_on_waiting_since desc], + 'priority_desc_created_at_asc' => %w[sort_on_priority_created_at desc], # To be removed in v3.5.0 'latest' => %w[sort_on_last_activity_at desc], diff --git a/app/javascript/dashboard/api/inboxes.js b/app/javascript/dashboard/api/inboxes.js index 83ba3e9ba..079f21815 100644 --- a/app/javascript/dashboard/api/inboxes.js +++ b/app/javascript/dashboard/api/inboxes.js @@ -42,6 +42,12 @@ class Inboxes extends CacheEnabledApiClient { getCSATTemplateStatus(inboxId) { return axios.get(`${this.url}/${inboxId}/csat_template`); } + + analyzeCSATTemplateUtility(inboxId, template) { + return axios.post(`${this.url}/${inboxId}/csat_template/analyze`, { + template, + }); + } } export default new Inboxes(); diff --git a/app/javascript/dashboard/components-next/NewConversation/components/ComposeNewConversationForm.vue b/app/javascript/dashboard/components-next/NewConversation/components/ComposeNewConversationForm.vue index 5ba97b779..0ed22ad0c 100644 --- a/app/javascript/dashboard/components-next/NewConversation/components/ComposeNewConversationForm.vue +++ b/app/javascript/dashboard/components-next/NewConversation/components/ComposeNewConversationForm.vue @@ -158,21 +158,7 @@ const isAnyDropdownActive = computed(() => { const handleContactSearch = value => { showContactsDropdown.value = true; - const query = typeof value === 'string' ? value.trim() : ''; - const hasAlphabet = Array.from(query).some(char => { - const lower = char.toLowerCase(); - const upper = char.toUpperCase(); - return lower !== upper; - }); - const isEmailLike = /^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(query); - - const keys = ['email', 'phone_number', 'name'].filter(key => { - if (key === 'phone_number' && hasAlphabet) return false; - if (key === 'name' && isEmailLike) return false; - return true; - }); - - emit('searchContacts', { keys, query: value }); + emit('searchContacts', value); }; const handleDropdownUpdate = (type, value) => { @@ -187,12 +173,12 @@ const handleDropdownUpdate = (type, value) => { const searchCcEmails = value => { showCcEmailsDropdown.value = true; - emit('searchContacts', { keys: ['email'], query: value }); + emit('searchContacts', value); }; const searchBccEmails = value => { showBccEmailsDropdown.value = true; - emit('searchContacts', { keys: ['email'], query: value }); + emit('searchContacts', value); }; const setSelectedContact = async ({ value, action, ...rest }) => { diff --git a/app/javascript/dashboard/components-next/NewConversation/components/EmailOptions.vue b/app/javascript/dashboard/components-next/NewConversation/components/EmailOptions.vue index 4e0c71adb..c6013b093 100644 --- a/app/javascript/dashboard/components-next/NewConversation/components/EmailOptions.vue +++ b/app/javascript/dashboard/components-next/NewConversation/components/EmailOptions.vue @@ -44,14 +44,16 @@ const bccEmailsArray = computed(() => ); const contactEmailsList = computed(() => { - return props.contacts?.map(({ name, id, email }) => ({ - id, - label: email, - email, - thumbnail: { name: name, src: '' }, - value: id, - action: 'email', - })); + return props.contacts + ?.filter(contact => contact.email) + .map(({ name, id, email }) => ({ + id, + label: email, + email, + thumbnail: { name: name, src: '' }, + value: id, + action: 'email', + })); }); // Handle updates from TagInput and convert array back to string diff --git a/app/javascript/dashboard/components-next/NewConversation/helpers/composeConversationHelper.js b/app/javascript/dashboard/components-next/NewConversation/helpers/composeConversationHelper.js index 482988581..2139e8cf8 100644 --- a/app/javascript/dashboard/components-next/NewConversation/helpers/composeConversationHelper.js +++ b/app/javascript/dashboard/components-next/NewConversation/helpers/composeConversationHelper.js @@ -176,32 +176,14 @@ export const prepareWhatsAppMessagePayload = ({ }; }; -export const generateContactQuery = ({ keys = ['email'], query }) => { - return { - payload: keys.map(key => { - const filterPayload = { - attribute_key: key, - filter_operator: 'contains', - values: [query], - attribute_model: 'standard', - }; - if (keys.findIndex(k => k === key) !== keys.length - 1) { - filterPayload.query_operator = 'or'; - } - return filterPayload; - }), - }; -}; - // API Calls -export const searchContacts = async ({ keys, query }) => { +export const searchContacts = async query => { + const trimmed = typeof query === 'string' ? query.trim() : ''; + if (!trimmed) return []; + const { data: { payload }, - } = await ContactAPI.filter( - undefined, - 'name', - generateContactQuery({ keys, query }) - ); + } = await ContactAPI.search(trimmed); const camelCasedPayload = camelcaseKeys(payload, { deep: true }); // Filter contacts that have either phone_number or email const filteredPayload = camelCasedPayload?.filter( diff --git a/app/javascript/dashboard/components-next/NewConversation/helpers/specs/composeConversationHelper.spec.js b/app/javascript/dashboard/components-next/NewConversation/helpers/specs/composeConversationHelper.spec.js index 105fe46a0..985e473b3 100644 --- a/app/javascript/dashboard/components-next/NewConversation/helpers/specs/composeConversationHelper.spec.js +++ b/app/javascript/dashboard/components-next/NewConversation/helpers/specs/composeConversationHelper.spec.js @@ -336,70 +336,6 @@ describe('composeConversationHelper', () => { }); }); - describe('generateContactQuery', () => { - it('generates correct query structure for contact search', () => { - const query = 'test@example.com'; - const expected = { - payload: [ - { - attribute_key: 'email', - filter_operator: 'contains', - values: [query], - attribute_model: 'standard', - }, - ], - }; - - expect(helpers.generateContactQuery({ keys: ['email'], query })).toEqual( - expected - ); - }); - - it('handles empty query', () => { - const expected = { - payload: [ - { - attribute_key: 'email', - filter_operator: 'contains', - values: [''], - attribute_model: 'standard', - }, - ], - }; - - expect( - helpers.generateContactQuery({ keys: ['email'], query: '' }) - ).toEqual(expected); - }); - - it('handles mutliple keys', () => { - const expected = { - payload: [ - { - attribute_key: 'email', - filter_operator: 'contains', - values: ['john'], - attribute_model: 'standard', - query_operator: 'or', - }, - { - attribute_key: 'phone_number', - filter_operator: 'contains', - values: ['john'], - attribute_model: 'standard', - }, - ], - }; - - expect( - helpers.generateContactQuery({ - keys: ['email', 'phone_number'], - query: 'john', - }) - ).toEqual(expected); - }); - }); - describe('API calls', () => { describe('searchContacts', () => { it('searches contacts and returns camelCase results', async () => { @@ -413,14 +349,11 @@ describe('composeConversationHelper', () => { }, ]; - ContactAPI.filter.mockResolvedValue({ + ContactAPI.search.mockResolvedValue({ data: { payload: mockPayload }, }); - const result = await helpers.searchContacts({ - keys: ['email'], - query: 'john', - }); + const result = await helpers.searchContacts('john'); expect(result).toEqual([ { @@ -432,16 +365,7 @@ describe('composeConversationHelper', () => { }, ]); - expect(ContactAPI.filter).toHaveBeenCalledWith(undefined, 'name', { - payload: [ - { - attribute_key: 'email', - filter_operator: 'contains', - values: ['john'], - attribute_model: 'standard', - }, - ], - }); + expect(ContactAPI.search).toHaveBeenCalledWith('john'); }); it('searches contacts and returns only contacts with email or phone number', async () => { @@ -469,14 +393,11 @@ describe('composeConversationHelper', () => { }, ]; - ContactAPI.filter.mockResolvedValue({ + ContactAPI.search.mockResolvedValue({ data: { payload: mockPayload }, }); - const result = await helpers.searchContacts({ - keys: ['email'], - query: 'john', - }); + const result = await helpers.searchContacts('john'); // Should only return contacts with either email or phone number expect(result).toEqual([ @@ -496,20 +417,11 @@ describe('composeConversationHelper', () => { }, ]); - expect(ContactAPI.filter).toHaveBeenCalledWith(undefined, 'name', { - payload: [ - { - attribute_key: 'email', - filter_operator: 'contains', - values: ['john'], - attribute_model: 'standard', - }, - ], - }); + expect(ContactAPI.search).toHaveBeenCalledWith('john'); }); it('handles empty search results', async () => { - ContactAPI.filter.mockResolvedValue({ + ContactAPI.search.mockResolvedValue({ data: { payload: [] }, }); @@ -536,7 +448,7 @@ describe('composeConversationHelper', () => { }, ]; - ContactAPI.filter.mockResolvedValue({ + ContactAPI.search.mockResolvedValue({ data: { payload: mockPayload }, }); diff --git a/app/javascript/dashboard/components-next/message/Message.vue b/app/javascript/dashboard/components-next/message/Message.vue index 66234984c..3de9d2d04 100644 --- a/app/javascript/dashboard/components-next/message/Message.vue +++ b/app/javascript/dashboard/components-next/message/Message.vue @@ -129,6 +129,7 @@ const props = defineProps({ inReplyTo: { type: Object, default: null }, // eslint-disable-line vue/no-unused-properties isEmailInbox: { type: Boolean, default: false }, private: { type: Boolean, default: false }, + additionalAttributes: { type: Object, default: () => ({}) }, // eslint-disable-line vue/no-unused-properties sender: { type: Object, default: null }, senderId: { type: Number, default: null }, senderType: { type: String, default: null }, @@ -172,7 +173,10 @@ const variant = computed(() => { return MESSAGE_VARIANTS.AGENT; } - const isBot = !props.sender || props.sender.type === SENDER_TYPES.AGENT_BOT; + const isBot = + props.sender?.type === SENDER_TYPES.AGENT_BOT || + props.senderType === SENDER_TYPES.AGENT_BOT || + (!props.sender && !props.additionalAttributes?.senderName); if (isBot && props.messageType === MESSAGE_TYPES.OUTGOING) { return MESSAGE_VARIANTS.BOT; } @@ -450,12 +454,13 @@ const avatarInfo = computed(() => { }; } - // If no sender, return bot info + // If no sender, check for Slack (or other integration) sender info if (!props.sender) { - return { - name: t('CONVERSATION.BOT'), - src: '', - }; + const { senderName, senderAvatarUrl } = props.additionalAttributes || {}; + if (senderName) { + return { name: senderName, src: senderAvatarUrl ?? '' }; + } + return { name: t('CONVERSATION.BOT'), src: '' }; } const { sender } = props; diff --git a/app/javascript/dashboard/components-next/AssignmentPolicy/components/story/RadioCard.story.vue b/app/javascript/dashboard/components-next/radioCard/RadioCard.story.vue similarity index 97% rename from app/javascript/dashboard/components-next/AssignmentPolicy/components/story/RadioCard.story.vue rename to app/javascript/dashboard/components-next/radioCard/RadioCard.story.vue index df1f8655c..636ded048 100644 --- a/app/javascript/dashboard/components-next/AssignmentPolicy/components/story/RadioCard.story.vue +++ b/app/javascript/dashboard/components-next/radioCard/RadioCard.story.vue @@ -1,6 +1,6 @@ + + diff --git a/app/javascript/dashboard/routes/dashboard/settings/inbox/components/SenderNameExamplePreview.vue b/app/javascript/dashboard/routes/dashboard/settings/inbox/components/SenderNameExamplePreview.vue index 249c53abb..abd2552bf 100644 --- a/app/javascript/dashboard/routes/dashboard/settings/inbox/components/SenderNameExamplePreview.vue +++ b/app/javascript/dashboard/routes/dashboard/settings/inbox/components/SenderNameExamplePreview.vue @@ -2,7 +2,7 @@ import { computed } from 'vue'; import { useI18n } from 'vue-i18n'; import Avatar from 'next/avatar/Avatar.vue'; -import RadioCard from 'dashboard/components-next/AssignmentPolicy/components/RadioCard.vue'; +import RadioCard from 'dashboard/components-next/radioCard/RadioCard.vue'; const props = defineProps({ senderNameType: { diff --git a/app/javascript/dashboard/routes/dashboard/settings/inbox/settingsPage/CustomerSatisfactionPage.vue b/app/javascript/dashboard/routes/dashboard/settings/inbox/settingsPage/CustomerSatisfactionPage.vue index 03cb6dada..dc247da6f 100644 --- a/app/javascript/dashboard/routes/dashboard/settings/inbox/settingsPage/CustomerSatisfactionPage.vue +++ b/app/javascript/dashboard/routes/dashboard/settings/inbox/settingsPage/CustomerSatisfactionPage.vue @@ -4,6 +4,7 @@ import { useI18n } from 'vue-i18n'; import { useAlert } from 'dashboard/composables'; import { useStore, useMapGetter } from 'dashboard/composables/store'; import { useInbox } from 'dashboard/composables/useInbox'; +import { useCaptain } from 'dashboard/composables/useCaptain'; import { CSAT_DISPLAY_TYPES } from 'shared/constants/messages'; import Icon from 'dashboard/components-next/icon/Icon.vue'; @@ -26,6 +27,7 @@ const props = defineProps({ const { t } = useI18n(); const store = useStore(); const labels = useMapGetter('labels/getLabels'); +const { captainEnabled } = useCaptain(); const { isAWhatsAppChannel, isATwilioWhatsAppChannel } = useInbox( props.inbox?.id @@ -37,6 +39,8 @@ const isAnyWhatsAppChannel = computed( ); const isUpdating = ref(false); +const utilityAnalysisLoading = ref(false); +const utilityAnalysisResult = ref(null); const selectedLabelValues = ref([]); const currentLabel = ref(''); @@ -46,7 +50,7 @@ const state = reactive({ message: '', templateButtonText: 'Please rate us', surveyRuleOperator: 'contains', - templateLanguage: '', + templateLanguage: 'en', }); const templateStatus = ref(null); @@ -89,6 +93,9 @@ const messagePreviewData = computed(() => ({ const shouldShowTemplateStatus = computed( () => templateStatus.value && !templateLoading.value ); +const showUtilityAnalyzer = computed( + () => isAnyWhatsAppChannel.value && captainEnabled.value +); const templateApprovalStatus = computed(() => { const statusMap = { @@ -218,6 +225,85 @@ const updateDisplayType = type => { state.displayType = type; }; +const resetUtilityAnalysis = () => { + utilityAnalysisResult.value = null; +}; + +const analyzeTemplateUtility = async () => { + if (!showUtilityAnalyzer.value || !state.message?.trim()) return; + + utilityAnalysisLoading.value = true; + resetUtilityAnalysis(); + + try { + const response = await store.dispatch( + 'inboxes/analyzeCSATTemplateUtility', + { + inboxId: props.inbox.id, + template: { + message: state.message, + button_text: state.templateButtonText, + language: state.templateLanguage, + }, + } + ); + utilityAnalysisResult.value = response; + } catch (error) { + const errorMessage = + error.response?.data?.error || + t('INBOX_MGMT.CSAT.UTILITY_ANALYZER.ERROR_MESSAGE'); + useAlert(errorMessage); + } finally { + utilityAnalysisLoading.value = false; + } +}; + +const applyUtilitySuggestion = () => { + const suggestion = utilityAnalysisResult.value?.optimized_message; + if (!suggestion) return; + + state.message = suggestion; + resetUtilityAnalysis(); +}; + +watch( + () => [state.message, state.templateButtonText, state.templateLanguage], + (newValues, oldValues) => { + if (!oldValues || !utilityAnalysisResult.value) { + return; + } + + const changed = newValues.some( + (value, index) => value !== oldValues[index] + ); + if (changed) { + resetUtilityAnalysis(); + } + } +); + +const getUtilityClassificationLabel = classification => { + if (classification === 'LIKELY_UTILITY') { + return t('INBOX_MGMT.CSAT.UTILITY_ANALYZER.CLASSIFICATION.LIKELY_UTILITY'); + } + if (classification === 'LIKELY_MARKETING') { + return t( + 'INBOX_MGMT.CSAT.UTILITY_ANALYZER.CLASSIFICATION.LIKELY_MARKETING' + ); + } + return t('INBOX_MGMT.CSAT.UTILITY_ANALYZER.CLASSIFICATION.UNCLEAR'); +}; + +const getUtilityClassificationClass = classification => { + if (classification === 'LIKELY_UTILITY') { + return 'bg-n-teal-3 text-n-teal-11'; + } + if (classification === 'LIKELY_MARKETING') { + return 'bg-n-ruby-3 text-n-ruby-11'; + } + return 'bg-n-amber-3 text-n-amber-11'; +}; + const updateSurveyRuleOperator = operator => { state.surveyRuleOperator = operator; }; @@ -450,6 +536,70 @@ const handleConfirmTemplateUpdate = async () => { class="w-full" /> +
+ +

+ {{ $t('INBOX_MGMT.CSAT.UTILITY_ANALYZER.HELPER_NOTE') }} +

+
+ +
+
+ + {{ $t('INBOX_MGMT.CSAT.UTILITY_ANALYZER.RESULT_LABEL') }} + + + {{ + getUtilityClassificationLabel( + utilityAnalysisResult.classification + ) + }} + +
+

+ {{ $t('INBOX_MGMT.CSAT.UTILITY_ANALYZER.GUIDANCE_NOTE') }} +

+
+

+ {{ + $t('INBOX_MGMT.CSAT.UTILITY_ANALYZER.SUGGESTION_LABEL') + }} +

+

+ {{ utilityAnalysisResult.optimized_message }} +

+ +
+
+ diff --git a/app/javascript/dashboard/routes/dashboard/settings/integrations/Webhooks/WebhookForm.vue b/app/javascript/dashboard/routes/dashboard/settings/integrations/Webhooks/WebhookForm.vue index 3f4b31299..3bcef1ca2 100644 --- a/app/javascript/dashboard/routes/dashboard/settings/integrations/Webhooks/WebhookForm.vue +++ b/app/javascript/dashboard/routes/dashboard/settings/integrations/Webhooks/WebhookForm.vue @@ -3,6 +3,8 @@ import { useVuelidate } from '@vuelidate/core'; import { required, url, minLength } from '@vuelidate/validators'; import wootConstants from 'dashboard/constants/globals'; import { getI18nKey } from 'dashboard/routes/dashboard/settings/helper/settingsHelper'; +import { copyTextToClipboard } from 'shared/helpers/clipboard'; +import { useAlert } from 'dashboard/composables'; import NextButton from 'dashboard/components-next/button/Button.vue'; const { EXAMPLE_WEBHOOK_URL } = wootConstants; @@ -57,10 +59,14 @@ export default { url: this.value.url || '', name: this.value.name || '', subscriptions: this.value.subscriptions || [], + secretVisible: false, supportedWebhookEvents: SUPPORTED_WEBHOOK_EVENTS, }; }, computed: { + hasSecret() { + return !!this.value.secret; + }, webhookURLInputPlaceholder() { return this.$t( 'INTEGRATION_SETTINGS.WEBHOOK.FORM.END_POINT.PLACEHOLDER', @@ -81,6 +87,10 @@ export default { subscriptions: this.subscriptions, }); }, + async copySecret() { + await copyTextToClipboard(this.value.secret); + useAlert(this.$t('INTEGRATION_SETTINGS.WEBHOOK.SECRET.COPY_SUCCESS')); + }, getI18nKey, }, }; @@ -111,6 +121,35 @@ export default { :placeholder="webhookNameInputPlaceholder" /> + diff --git a/app/javascript/dashboard/routes/dashboard/settings/labels/Index.vue b/app/javascript/dashboard/routes/dashboard/settings/labels/Index.vue index c15f7df28..9b81f30cf 100644 --- a/app/javascript/dashboard/routes/dashboard/settings/labels/Index.vue +++ b/app/javascript/dashboard/routes/dashboard/settings/labels/Index.vue @@ -32,7 +32,10 @@ const records = computed(() => getters['labels/getLabels'].value); const filteredRecords = computed(() => { const query = searchQuery.value.trim(); if (!query) return records.value; - return picoSearch(records.value, query, ['title', 'description']); + return picoSearch(records.value, query, [ + { name: 'title', weight: 4 }, + 'description', + ]); }); const uiFlags = computed(() => getters['labels/getUIFlags'].value); diff --git a/app/javascript/dashboard/store/modules/conversations/actions.js b/app/javascript/dashboard/store/modules/conversations/actions.js index 0c4c084e0..c6a197d85 100644 --- a/app/javascript/dashboard/store/modules/conversations/actions.js +++ b/app/javascript/dashboard/store/modules/conversations/actions.js @@ -457,11 +457,7 @@ const actions = { }, sendEmailTranscript: async (_, { conversationId, email }) => { - try { - await ConversationApi.sendEmailTranscript({ conversationId, email }); - } catch (error) { - throw new Error(error); - } + await ConversationApi.sendEmailTranscript({ conversationId, email }); }, updateCustomAttributes: async ( diff --git a/app/javascript/dashboard/store/modules/conversations/helpers.js b/app/javascript/dashboard/store/modules/conversations/helpers.js index ebbdcbe64..af6b16023 100644 --- a/app/javascript/dashboard/store/modules/conversations/helpers.js +++ b/app/javascript/dashboard/store/modules/conversations/helpers.js @@ -116,6 +116,7 @@ const SORT_OPTIONS = { priority_desc: ['sortOnPriority', 'desc'], waiting_since_asc: ['sortOnWaitingSince', 'asc'], waiting_since_desc: ['sortOnWaitingSince', 'desc'], + priority_desc_created_at_asc: ['sortOnPriorityCreatedAt', 'desc'], }; const sortAscending = (valueA, valueB) => valueA - valueB; const sortDescending = (valueA, valueB) => valueB - valueA; @@ -139,6 +140,14 @@ const sortConfig = { return getSortOrderFunction(sortDirection)(p1, p2); }, + sortOnPriorityCreatedAt: (a, b) => { + const DEFAULT_FOR_NULL = 0; + const p1 = CONVERSATION_PRIORITY_ORDER[a.priority] || DEFAULT_FOR_NULL; + const p2 = CONVERSATION_PRIORITY_ORDER[b.priority] || DEFAULT_FOR_NULL; + if (p1 !== p2) return p2 - p1; + return a.created_at - b.created_at; + }, + sortOnWaitingSince: (a, b, sortDirection) => { const sortFunc = getSortOrderFunction(sortDirection); if (!a.waiting_since || !b.waiting_since) { diff --git a/app/javascript/dashboard/store/modules/inboxes.js b/app/javascript/dashboard/store/modules/inboxes.js index c24a90599..49926f378 100644 --- a/app/javascript/dashboard/store/modules/inboxes.js +++ b/app/javascript/dashboard/store/modules/inboxes.js @@ -360,6 +360,13 @@ export const actions = { const response = await InboxesAPI.getCSATTemplateStatus(inboxId); return response.data; }, + analyzeCSATTemplateUtility: async (_, { inboxId, template }) => { + const response = await InboxesAPI.analyzeCSATTemplateUtility( + inboxId, + template + ); + return response.data; + }, }; export const mutations = { diff --git a/app/javascript/dashboard/store/modules/webhooks.js b/app/javascript/dashboard/store/modules/webhooks.js index eb096468e..774c173d3 100644 --- a/app/javascript/dashboard/store/modules/webhooks.js +++ b/app/javascript/dashboard/store/modules/webhooks.js @@ -42,6 +42,7 @@ export const actions = { } = response.data; commit(types.default.ADD_WEBHOOK, webhook); commit(types.default.SET_WEBHOOK_UI_FLAG, { creatingItem: false }); + return webhook; } catch (error) { commit(types.default.SET_WEBHOOK_UI_FLAG, { creatingItem: false }); throw error; diff --git a/app/javascript/shared/components/ui/label/LabelDropdown.vue b/app/javascript/shared/components/ui/label/LabelDropdown.vue index a1216acd8..71da844e0 100644 --- a/app/javascript/shared/components/ui/label/LabelDropdown.vue +++ b/app/javascript/shared/components/ui/label/LabelDropdown.vue @@ -46,9 +46,7 @@ export default { filteredActiveLabels() { if (!this.search) return this.accountLabels; - return picoSearch(this.accountLabels, this.search, ['title'], { - threshold: 0.9, - }); + return picoSearch(this.accountLabels, this.search, ['title']); }, noResult() { diff --git a/app/javascript/widget/components/AgentMessage.vue b/app/javascript/widget/components/AgentMessage.vue index e8d245ddb..a13f7bf65 100755 --- a/app/javascript/widget/components/AgentMessage.vue +++ b/app/javascript/widget/components/AgentMessage.vue @@ -72,6 +72,10 @@ export default { return this.message.sender.available_name || this.message.sender.name; } + if (this.message.additional_attributes?.sender_name) { + return this.message.additional_attributes.sender_name; + } + if (this.useInboxAvatarForBot) { return this.channelConfig.websiteName; } @@ -87,9 +91,13 @@ export default { return displayImage; } - return this.message.sender - ? this.message.sender.avatar_url - : displayImage; + if (this.message.sender) { + return this.message.sender.avatar_url; + } + + return ( + this.message.additional_attributes?.sender_avatar_url || displayImage + ); }, hasRecordedResponse() { return ( diff --git a/app/jobs/webhook_job.rb b/app/jobs/webhook_job.rb index 57d3739b7..54eac45e3 100644 --- a/app/jobs/webhook_job.rb +++ b/app/jobs/webhook_job.rb @@ -1,7 +1,7 @@ class WebhookJob < ApplicationJob queue_as :medium # There are 3 types of webhooks, account, inbox and agent_bot - def perform(url, payload, webhook_type = :account_webhook) - Webhooks::Trigger.execute(url, payload, webhook_type) + def perform(url, payload, webhook_type = :account_webhook, secret: nil, delivery_id: nil) + Webhooks::Trigger.execute(url, payload, webhook_type, secret: secret, delivery_id: delivery_id) end end diff --git a/app/listeners/webhook_listener.rb b/app/listeners/webhook_listener.rb index 82a9fc711..762eaa6ee 100644 --- a/app/listeners/webhook_listener.rb +++ b/app/listeners/webhook_listener.rb @@ -111,7 +111,9 @@ class WebhookListener < BaseListener account.webhooks.account_type.each do |webhook| next unless webhook.subscriptions.include?(payload[:event]) - WebhookJob.perform_later(webhook.url, payload) + WebhookJob.perform_later(webhook.url, payload, :account_webhook, + secret: webhook.secret, + delivery_id: SecureRandom.uuid) end end @@ -119,7 +121,8 @@ class WebhookListener < BaseListener return unless inbox.channel_type == 'Channel::Api' return if inbox.channel.webhook_url.blank? - WebhookJob.perform_later(inbox.channel.webhook_url, payload, :api_inbox_webhook) + WebhookJob.perform_later(inbox.channel.webhook_url, payload, :api_inbox_webhook, + delivery_id: SecureRandom.uuid) end def deliver_webhook_payloads(payload, inbox) diff --git a/app/models/account.rb b/app/models/account.rb index 4816494fb..eabaa5c26 100644 --- a/app/models/account.rb +++ b/app/models/account.rb @@ -41,6 +41,7 @@ class Account < ApplicationRecord 'audio_transcriptions': { 'type': %w[boolean null] }, 'auto_resolve_label': { 'type': %w[string null] }, 'keep_pending_on_bot_failure': { 'type': %w[boolean null] }, + 'captain_disable_auto_resolve': { 'type': %w[boolean null] }, 'conversation_required_attributes': { 'type': %w[array null], 'items': { 'type': 'string' } @@ -90,6 +91,7 @@ class Account < ApplicationRecord store_accessor :settings, :audio_transcriptions, :auto_resolve_label store_accessor :settings, :captain_models, :captain_features store_accessor :settings, :keep_pending_on_bot_failure + store_accessor :settings, :captain_disable_auto_resolve has_many :account_users, dependent: :destroy_async has_many :agent_bot_inboxes, dependent: :destroy_async diff --git a/app/models/concerns/sort_handler.rb b/app/models/concerns/sort_handler.rb index 00eb73717..065fa7fea 100644 --- a/app/models/concerns/sort_handler.rb +++ b/app/models/concerns/sort_handler.rb @@ -14,6 +14,10 @@ module SortHandler order(generate_sql_query("priority #{sort_direction.to_s.upcase} NULLS LAST, last_activity_at DESC")) end + def sort_on_priority_created_at(sort_direction = :desc) + order(generate_sql_query("priority #{sort_direction.to_s.upcase} NULLS LAST, created_at ASC")) + end + def sort_on_waiting_since(sort_direction = :asc) order(generate_sql_query("waiting_since #{sort_direction.to_s.upcase} NULLS LAST, created_at ASC")) end diff --git a/app/models/conversation.rb b/app/models/conversation.rb index ca53238e8..6dd0e9df5 100644 --- a/app/models/conversation.rb +++ b/app/models/conversation.rb @@ -159,6 +159,7 @@ class Conversation < ApplicationRecord end def bot_handoff! + update(waiting_since: Time.current) if waiting_since.blank? open! dispatcher_dispatch(CONVERSATION_BOT_HANDOFF) end diff --git a/app/models/webhook.rb b/app/models/webhook.rb index 1d61c1614..6b36c4bbd 100644 --- a/app/models/webhook.rb +++ b/app/models/webhook.rb @@ -21,6 +21,9 @@ class Webhook < ApplicationRecord belongs_to :account belongs_to :inbox, optional: true + has_secure_token :secret + encrypts :secret if Chatwoot.encryption_configured? + validates :account_id, presence: true validates :url, uniqueness: { scope: [:account_id] }, format: URI::DEFAULT_PARSER.make_regexp(%w[http https]) validate :validate_webhook_subscriptions diff --git a/app/services/csat_template_management_service.rb b/app/services/csat_template_management_service.rb index 064804082..e83b3413a 100644 --- a/app/services/csat_template_management_service.rb +++ b/app/services/csat_template_management_service.rb @@ -110,6 +110,7 @@ class CsatTemplateManagementService template_service = Twilio::CsatTemplateService.new(@inbox.channel) status_result = template_service.get_template_status(content_sid) + return { template_exists: false, error: 'Template not found' } unless status_result.is_a?(Hash) if status_result[:success] { @@ -130,6 +131,7 @@ class CsatTemplateManagementService def get_whatsapp_template_status(template) template_name = template['name'] || CsatTemplateNameService.csat_template_name(@inbox.id) status_result = Whatsapp::CsatTemplateService.new(@inbox.channel).get_template_status(template_name) + return { template_exists: false, error: 'Template not found' } unless status_result.is_a?(Hash) if status_result[:success] { diff --git a/app/services/csat_template_utility_analysis_service.rb b/app/services/csat_template_utility_analysis_service.rb new file mode 100644 index 000000000..b1b089b53 --- /dev/null +++ b/app/services/csat_template_utility_analysis_service.rb @@ -0,0 +1,86 @@ +class CsatTemplateUtilityAnalysisService + include CsatTemplateUtilityRubric + + pattr_initialize [:account!, :inbox!, :message!, { button_text: nil, language: 'en' }] + + def perform + baseline = rule_based_result + return baseline if baseline[:classification] == 'LIKELY_MARKETING' + + llm_result = llm_result_or_nil(baseline) + llm_result || baseline + end + + private + + def llm_result_or_nil(baseline) + llm_output = Captain::CsatUtilityAnalysisService.new( + account: account, + message: message, + button_text: button_text, + language: language, + baseline: baseline + ).perform + + return nil if llm_output[:error] + + normalize_llm_result(llm_output, baseline: baseline) + rescue StandardError => e + Rails.logger.error("CSAT utility LLM analysis failed for inbox #{inbox.id}: #{e.message}") + nil + end + + def normalize_llm_result(result, baseline:) + classification = normalized_classification(result[:classification], baseline: baseline) + optimized_message = result[:optimized_message].presence || baseline[:optimized_message] + optimized_message = baseline[:optimized_message] if baseline[:classification] == 'LIKELY_MARKETING' + + { + classification: classification, + optimized_message: optimized_message + } + end + + def normalized_classification(value, baseline:) + raw = value.to_s + return 'LIKELY_MARKETING' if baseline[:classification] == 'LIKELY_MARKETING' + + raw + end + + def rule_based_result + text = sanitized_message + marketing_hits_count = MARKETING_PATTERNS.count { |pattern| pattern.match?(text) } + utility_hits_count = UTILITY_PATTERNS.count { |pattern| pattern.match?(text) } + criteria = evaluate_criteria(text: text, marketing_hits_count: marketing_hits_count) + classification = classify(criteria: criteria, utility_hits_count: utility_hits_count) + build_rule_payload( + classification: classification + ) + end + + def build_rule_payload(payload) + { + classification: payload[:classification], + optimized_message: optimized_message_for(payload[:classification]) + } + end + + def sanitized_message + message.to_s.squish + end + + def classify(criteria:, utility_hits_count:) + return 'LIKELY_MARKETING' unless criteria[:marketing_prohibition] + return 'LIKELY_MARKETING' unless criteria[:prohibited_content] + return 'LIKELY_UTILITY' if criteria.values.all? && utility_hits_count >= 2 + + 'UNCLEAR' + end + + def optimized_message_for(classification) + return sanitized_message if classification == 'LIKELY_UTILITY' + + build_input_aware_utility_message + end +end diff --git a/app/services/csat_template_utility_rubric.rb b/app/services/csat_template_utility_rubric.rb new file mode 100644 index 000000000..0253a003a --- /dev/null +++ b/app/services/csat_template_utility_rubric.rb @@ -0,0 +1,125 @@ +# rubocop:disable Metrics/ModuleLength +module CsatTemplateUtilityRubric + LANGUAGE_FALLBACKS = { + 'en' => { + support_request: 'support request', + support_ticket: 'support ticket', + support_conversation: 'support conversation', + status_closed: 'closed', + status_resolved: 'resolved', + status_completed: 'completed', + line_status: 'Your %s has been %s.', + line_help: 'If you still need help, simply reply to this message.', + line_rate: 'To rate this support interaction, please use the button below.' + } + }.freeze + + MARKETING_PATTERNS = [ + /\b(discounts?|offers?|promos?|promotions?|deals?|sales?|buy|shop|subscribe)\b/i, + /\b(limited\s*time|don't\s*miss|exclusive|special\s*offer)\b/i, + /\b(click\s*(here|below)\s*to\s*(buy|get|shop))\b/i, + /\b(new\s*(plans?|products?|services?))\b/i + ].freeze + + TRANSACTION_TRIGGER_PATTERNS = [ + /\b(closed|closing|resolved|completed)\b/i, + /\b(ticket|request|case|conversation|support)\b/i + ].freeze + + TRANSACTIONAL_CONTENT_PATTERNS = [ + /\b(ticket|request|case|conversation)\b/i, + /\b(reply\s+to\s+this\s+message|if\s+you\s+still\s+need\s+help)\b/i, + /\b(rate|califica|calificar)\b/i + ].freeze + + PROHIBITED_CONTENT_PATTERNS = [ + /\b(contest|sweepstake|lottery|quiz)\b/i, + /\b(password|otp|pin|cvv|credit\s*card)\b/i, + /\b(weapon|drugs|gambling)\b/i + ].freeze + + STATUS_PATTERNS = { + 'closed' => /\b(closed|closing)\b/i, + 'resolved' => /\b(resolved|resolve[sd]?)\b/i, + 'completed' => /\b(completed|complete[sd]?)\b/i + }.freeze + + SUBJECT_PATTERNS = { + 'support ticket' => /\b(ticket)\b/i, + 'support conversation' => /\b(conversation|chat)\b/i, + 'support request' => /\b(request|case|support)\b/i + }.freeze + + UTILITY_PATTERNS = [ + /\b(support|ticket|request|conversation|case)\b/i, + /\b(closed|resolved|completed)\b/i, + /\b(reply\s+to\s+this\s+message\b)/i, + /\b(if\s+you\s+still\s+need\s+help)\b/i, + /\b(rate\s+this\s+(support|interaction|conversation))\b/i + ].freeze + + private + + def build_input_aware_utility_message + text = translation_pack + subject = detected_subject + status = detected_status + intro = extracted_intro_sentence + + parts = [] + parts << intro if intro.present? + parts << format(text[:line_status], subject: subject, status: status) + parts << text[:line_help] + parts << text[:line_rate] + parts.join(' ') + end + + def detected_status + matched = STATUS_PATTERNS.find { |_key, pattern| pattern.match?(sanitized_message) } + status_key = matched&.first || 'closed' + translation_pack[:"status_#{status_key}"] + end + + def detected_subject + matched = SUBJECT_PATTERNS.find { |_key, pattern| pattern.match?(sanitized_message) } + subject_key = matched&.first&.tr(' ', '_') || 'support_request' + translation_pack[subject_key.to_sym] + end + + def extracted_intro_sentence + first_sentence = sanitized_message.split(/(?<=[.!?])\s+/).first.to_s + return nil if first_sentence.blank? + return nil if MARKETING_PATTERNS.any? { |pattern| pattern.match?(first_sentence) } + return nil unless first_sentence.match?(/\b(thanks|thank you|hello|hi)\b/i) + + normalized = first_sentence.gsub(/\s+/, ' ').strip + normalized.ends_with?('.', '!', '?') ? normalized : "#{normalized}." + end + + def translation_pack + LANGUAGE_FALLBACKS.fetch(primary_language_code, LANGUAGE_FALLBACKS['en']) + end + + def primary_language_code + language.to_s.downcase.split(/[-_]/).first + end + + def evaluate_criteria(text:, marketing_hits_count:) + { + trigger: TRANSACTION_TRIGGER_PATTERNS.any? { |pattern| pattern.match?(text) }, + transactional_content: TRANSACTIONAL_CONTENT_PATTERNS.count { |pattern| pattern.match?(text) } >= 2, + marketing_prohibition: marketing_hits_count.zero?, + prohibited_content: PROHIBITED_CONTENT_PATTERNS.none? { |pattern| pattern.match?(text) }, + clarity_and_utility: clear_utility_intent?(text) + } + end + + def clear_utility_intent?(text) + has_support_context = text.match?(/\b(support|ticket|request|case|conversation)\b/i) + has_actionable_next_step = text.match?(/\b(reply\s+to\s+this\s+message)\b/i) || + text.match?(/\b(if\s+you\s+still\s+need\s+help)\b/i) || + text.match?(/\b(rate\s+this\s+(support|interaction|conversation))\b/i) + has_support_context && has_actionable_next_step + end +end +# rubocop:enable Metrics/ModuleLength diff --git a/app/services/line/incoming_message_service.rb b/app/services/line/incoming_message_service.rb index 6a1192d02..b30eacd7b 100644 --- a/app/services/line/incoming_message_service.rb +++ b/app/services/line/incoming_message_service.rb @@ -145,7 +145,12 @@ class Line::IncomingMessageService end def set_conversation - @conversation = @contact_inbox.conversations.first + # if lock to single conversation is disabled, we will create a new conversation if previous conversation is resolved + @conversation = if @inbox.lock_to_single_conversation + @contact_inbox.conversations.last + else + @contact_inbox.conversations.where.not(status: :resolved).last + end return if @conversation @conversation = ::Conversation.create!(conversation_params) diff --git a/app/services/tiktok/message_service.rb b/app/services/tiktok/message_service.rb index fcd613ec2..7acbb9486 100644 --- a/app/services/tiktok/message_service.rb +++ b/app/services/tiktok/message_service.rb @@ -23,7 +23,12 @@ class Tiktok::MessageService end def conversation - @conversation ||= contact_inbox.conversations.first || create_conversation(channel, contact_inbox, tt_conversation_id) + @conversation ||= if channel.inbox.lock_to_single_conversation + contact_inbox.conversations.order(created_at: :desc).first + else + contact_inbox.conversations.where.not(status: :resolved).order(created_at: :desc).first + end + @conversation ||= create_conversation(channel, contact_inbox, tt_conversation_id) end def create_message diff --git a/app/services/tiktok/messaging_helpers.rb b/app/services/tiktok/messaging_helpers.rb index 71c417cd7..0f9d9e0b3 100644 --- a/app/services/tiktok/messaging_helpers.rb +++ b/app/services/tiktok/messaging_helpers.rb @@ -27,7 +27,15 @@ module Tiktok::MessagingHelpers end def find_conversation(channel, tt_conversation_id) - channel.inbox.contact_inboxes.find_by(source_id: tt_conversation_id)&.conversations&.first + contact_inbox = channel.inbox.contact_inboxes.find_by(source_id: tt_conversation_id) + return if contact_inbox.blank? + + if channel.inbox.lock_to_single_conversation + contact_inbox.conversations.order(created_at: :desc).first + else + contact_inbox.conversations.where.not(status: :resolved).order(created_at: :desc).first || + contact_inbox.conversations.order(created_at: :desc).first + end end def create_conversation(channel, contact_inbox, tt_conversation_id) diff --git a/app/services/whatsapp/csat_template_service.rb b/app/services/whatsapp/csat_template_service.rb index 9bdbef8ca..9dc057a10 100644 --- a/app/services/whatsapp/csat_template_service.rb +++ b/app/services/whatsapp/csat_template_service.rb @@ -2,7 +2,7 @@ class Whatsapp::CsatTemplateService DEFAULT_BUTTON_TEXT = 'Please rate us'.freeze DEFAULT_LANGUAGE = 'en'.freeze WHATSAPP_API_VERSION = 'v14.0'.freeze - TEMPLATE_CATEGORY = 'MARKETING'.freeze + TEMPLATE_CATEGORY = 'UTILITY'.freeze TEMPLATE_STATUS_PENDING = 'PENDING'.freeze def initialize(whatsapp_channel) diff --git a/app/views/api/v1/accounts/webhooks/_webhook.json.jbuilder b/app/views/api/v1/accounts/webhooks/_webhook.json.jbuilder index 5406cf183..7b1943c5d 100644 --- a/app/views/api/v1/accounts/webhooks/_webhook.json.jbuilder +++ b/app/views/api/v1/accounts/webhooks/_webhook.json.jbuilder @@ -3,6 +3,7 @@ json.name webhook.name json.url webhook.url json.account_id webhook.account_id json.subscriptions webhook.subscriptions +json.secret webhook.secret if webhook.inbox json.inbox do json.id webhook.inbox.id diff --git a/config/features.yml b/config/features.yml index d8378d61c..65b3c6194 100644 --- a/config/features.yml +++ b/config/features.yml @@ -108,12 +108,10 @@ - name: response_bot display_name: Response Bot enabled: false - premium: true deprecated: true - name: message_reply_to display_name: Message Reply To enabled: false - help_url: https://chwt.app/hc/reply-to deprecated: true - name: insert_article_in_reply display_name: Insert Article in Reply @@ -149,7 +147,7 @@ enabled: true - name: report_v4 display_name: Report V4 - enabled: true + enabled: false deprecated: true - name: contact_chatwoot_support_team display_name: Contact Chatwoot Support Team diff --git a/config/routes.rb b/config/routes.rb index a01ef0049..23df894e8 100644 --- a/config/routes.rb +++ b/config/routes.rb @@ -224,7 +224,9 @@ Rails.application.routes.draw do end end - resource :csat_template, only: [:show, :create], controller: 'inbox_csat_templates' + resource :csat_template, only: [:show, :create], controller: 'inbox_csat_templates' do + post :analyze, on: :collection + end end resources :inbox_members, only: [:create, :show], param: :inbox_id do diff --git a/db/migrate/20260218075101_add_secret_to_webhooks.rb b/db/migrate/20260218075101_add_secret_to_webhooks.rb new file mode 100644 index 000000000..ff6c40c4c --- /dev/null +++ b/db/migrate/20260218075101_add_secret_to_webhooks.rb @@ -0,0 +1,5 @@ +class AddSecretToWebhooks < ActiveRecord::Migration[7.1] + def change + add_column :webhooks, :secret, :string + end +end diff --git a/db/migrate/20260226084618_backfill_webhook_secrets.rb b/db/migrate/20260226084618_backfill_webhook_secrets.rb new file mode 100644 index 000000000..aec6cfde7 --- /dev/null +++ b/db/migrate/20260226084618_backfill_webhook_secrets.rb @@ -0,0 +1,11 @@ +class BackfillWebhookSecrets < ActiveRecord::Migration[7.1] + def up + Webhook.find_each do |webhook| + webhook.update!(secret: SecureRandom.urlsafe_base64(24)) + end + end + + def down + # no-op: removing the column in the previous migration handles cleanup + end +end diff --git a/db/schema.rb b/db/schema.rb index fd4d18cb1..8a450e734 100644 --- a/db/schema.rb +++ b/db/schema.rb @@ -10,7 +10,7 @@ # # It's strongly recommended that you check this file into your version control system. -ActiveRecord::Schema[7.1].define(version: 2026_01_30_061021) do +ActiveRecord::Schema[7.1].define(version: 2026_02_26_084618) do # These extensions should be enabled to support this database enable_extension "pg_stat_statements" enable_extension "pg_trgm" @@ -1250,6 +1250,7 @@ ActiveRecord::Schema[7.1].define(version: 2026_01_30_061021) do t.integer "webhook_type", default: 0 t.jsonb "subscriptions", default: ["conversation_status_changed", "conversation_updated", "conversation_created", "contact_created", "contact_updated", "message_created", "message_updated", "webwidget_triggered"] t.string "name" + t.string "secret" t.index ["account_id", "url"], name: "index_webhooks_on_account_id_and_url", unique: true end diff --git a/enterprise/app/jobs/captain/conversation/response_builder_job.rb b/enterprise/app/jobs/captain/conversation/response_builder_job.rb index 698ec56e7..c4723f6b9 100644 --- a/enterprise/app/jobs/captain/conversation/response_builder_job.rb +++ b/enterprise/app/jobs/captain/conversation/response_builder_job.rb @@ -42,10 +42,10 @@ class Captain::Conversation::ResponseBuilderJob < ApplicationJob end def process_response - ActiveRecord::Base.transaction do - if handoff_requested? - process_action('handoff') - else + if handoff_requested? + process_action('handoff') + else + ActiveRecord::Base.transaction do create_messages Rails.logger.info("[CAPTAIN][ResponseBuilderJob] Incrementing response usage for #{account.id}") account.increment_response_usage diff --git a/enterprise/app/jobs/captain/inbox_pending_conversations_resolution_job.rb b/enterprise/app/jobs/captain/inbox_pending_conversations_resolution_job.rb index d3f1f5d96..ab9ca2ab1 100644 --- a/enterprise/app/jobs/captain/inbox_pending_conversations_resolution_job.rb +++ b/enterprise/app/jobs/captain/inbox_pending_conversations_resolution_job.rb @@ -2,6 +2,8 @@ class Captain::InboxPendingConversationsResolutionJob < ApplicationJob queue_as :low def perform(inbox) + return if inbox.account.captain_disable_auto_resolve + Current.executed_by = inbox.captain_assistant resolvable_conversations = inbox.conversations.pending.where('last_activity_at < ? ', Time.now.utc - 1.hour).limit(Limits::BULK_ACTIONS_LIMIT) diff --git a/enterprise/app/jobs/enterprise/account/conversations_resolution_scheduler_job.rb b/enterprise/app/jobs/enterprise/account/conversations_resolution_scheduler_job.rb index 599dee96a..8b6527c93 100644 --- a/enterprise/app/jobs/enterprise/account/conversations_resolution_scheduler_job.rb +++ b/enterprise/app/jobs/enterprise/account/conversations_resolution_scheduler_job.rb @@ -12,6 +12,7 @@ module Enterprise::Account::ConversationsResolutionSchedulerJob inbox = captain_inbox.inbox next if inbox.email? + next if inbox.account.captain_disable_auto_resolve Captain::InboxPendingConversationsResolutionJob.perform_later( inbox diff --git a/enterprise/app/models/concerns/agentable.rb b/enterprise/app/models/concerns/agentable.rb index e5b0b8eef..ed8e0a89f 100644 --- a/enterprise/app/models/concerns/agentable.rb +++ b/enterprise/app/models/concerns/agentable.rb @@ -19,9 +19,11 @@ module Concerns::Agentable state = context.context[:state] || {} conversation_data = state[:conversation] || {} contact_data = state[:contact] || {} + campaign_data = state[:campaign] || {} enhanced_context = enhanced_context.merge( conversation: conversation_data, - contact: contact_data + contact: contact_data, + campaign: campaign_data ) end diff --git a/enterprise/app/models/concerns/toolable.rb b/enterprise/app/models/concerns/toolable.rb index 51ec1be3e..f40ac4a65 100644 --- a/enterprise/app/models/concerns/toolable.rb +++ b/enterprise/app/models/concerns/toolable.rb @@ -71,6 +71,7 @@ module Concerns::Toolable add_base_headers(headers, state) add_conversation_headers(headers, state[:conversation]) if state[:conversation] add_contact_headers(headers, state[:contact]) if state[:contact] + add_contact_inbox_headers(headers, state[:contact_inbox]) end end @@ -91,6 +92,11 @@ module Concerns::Toolable headers['X-Chatwoot-Contact-Phone'] = contact[:phone_number].to_s if contact[:phone_number].present? end + def add_contact_inbox_headers(headers, contact_inbox) + headers['X-Chatwoot-Contact-Inbox-Id'] = contact_inbox[:id].to_s if contact_inbox&.[](:id) + headers['X-Chatwoot-Contact-Inbox-Verified'] = (contact_inbox&.[](:hmac_verified) || false).to_s + end + def format_response(raw_response_body) return raw_response_body if response_template.blank? diff --git a/enterprise/app/models/enterprise/audit/webhook.rb b/enterprise/app/models/enterprise/audit/webhook.rb index 34e0bcc1b..303141ce2 100644 --- a/enterprise/app/models/enterprise/audit/webhook.rb +++ b/enterprise/app/models/enterprise/audit/webhook.rb @@ -2,6 +2,6 @@ module Enterprise::Audit::Webhook extend ActiveSupport::Concern included do - audited associated_with: :account + audited associated_with: :account, except: [:secret] end end diff --git a/enterprise/app/services/captain/assistant/agent_runner_service.rb b/enterprise/app/services/captain/assistant/agent_runner_service.rb index 9aeee605f..bdf35e98e 100644 --- a/enterprise/app/services/captain/assistant/agent_runner_service.rb +++ b/enterprise/app/services/captain/assistant/agent_runner_service.rb @@ -3,6 +3,8 @@ require 'agents/instrumentation' class Captain::Assistant::AgentRunnerService include Integrations::LlmInstrumentationConstants + include Captain::Assistant::RunnerCallbacksHelper + include Captain::Assistant::TracePayloadHelper CONVERSATION_STATE_ATTRIBUTES = %i[ id display_id inbox_id contact_id status priority @@ -14,6 +16,10 @@ class Captain::Assistant::AgentRunnerService custom_attributes additional_attributes ].freeze + CONTACT_INBOX_STATE_ATTRIBUTES = %i[id hmac_verified].freeze + + CAMPAIGN_STATE_ATTRIBUTES = %i[id title message campaign_type description].freeze + def initialize(assistant:, conversation: nil, callbacks: {}) @assistant = assistant @conversation = conversation @@ -21,13 +27,7 @@ class Captain::Assistant::AgentRunnerService end def generate_response(message_history: []) - agents = build_and_wire_agents - context = build_context(message_history) - message_to_process = extract_last_user_message(message_history) - runner = Agents::Runner.with_agents(*agents) - runner = add_usage_metadata_callback(runner) - runner = add_callbacks_to_runner(runner) if @callbacks.any? - install_instrumentation(runner) + message_to_process, context = run_payload(message_history) result = runner.run(message_to_process, context: context, max_turns: 100) process_agent_result(result) @@ -45,7 +45,10 @@ class Captain::Assistant::AgentRunnerService def build_context(message_history) conversation_history = message_history.map do |msg| - content = extract_text_from_content(msg[:content]) + content = msg[:content] + # Preserve multimodal arrays (with image_url entries) as-is for the runner to restore with attachments. + # Only extract text from non-array formats (hashes from agent structured output, plain strings). + content = extract_text_from_content(content) unless content.is_a?(Array) { role: msg[:role].to_sym, @@ -63,8 +66,22 @@ class Captain::Assistant::AgentRunnerService def extract_last_user_message(message_history) last_user_msg = message_history.reverse.find { |msg| msg[:role] == 'user' } + return '' if last_user_msg.blank? - extract_text_from_content(last_user_msg[:content]) + content = last_user_msg[:content] + return extract_text_from_content(content) unless content.is_a?(Array) + + text, attachments = Captain::OpenAiMessageBuilderService.extract_text_and_attachments(content) + return text if attachments.blank? + + RubyLLM::Content.new(text, attachments) + end + + def message_history_without_last_user_message(message_history) + last_user_index = message_history.rindex { |msg| msg[:role] == 'user' } + return message_history if last_user_index.nil? + + message_history.reject.with_index { |_msg, index| index == last_user_index } end def extract_text_from_content(content) @@ -112,15 +129,21 @@ class Captain::Assistant::AgentRunnerService assistant_config: @assistant.config } - if @conversation - state[:conversation] = @conversation.attributes.symbolize_keys.slice(*CONVERSATION_STATE_ATTRIBUTES) - state[:channel_type] = @conversation.inbox&.channel_type - state[:contact] = @conversation.contact.attributes.symbolize_keys.slice(*CONTACT_STATE_ATTRIBUTES) if @conversation.contact - end - + build_conversation_state(state) if @conversation state end + def build_conversation_state(state) + state[:conversation] = @conversation.attributes.symbolize_keys.slice(*CONVERSATION_STATE_ATTRIBUTES) + state[:channel_type] = @conversation.inbox&.channel_type + state[:contact] = @conversation.contact.attributes.symbolize_keys.slice(*CONTACT_STATE_ATTRIBUTES) if @conversation.contact + state[:campaign] = @conversation.campaign.attributes.symbolize_keys.slice(*CAMPAIGN_STATE_ATTRIBUTES) if @conversation.campaign + return unless @conversation.contact_inbox + + state[:contact_inbox] = + @conversation.contact_inbox.attributes.symbolize_keys.slice(*CONTACT_INBOX_STATE_ATTRIBUTES) + end + def build_and_wire_agents assistant_agent = @assistant.agent scenario_agents = @assistant.scenarios.enabled.map(&:agent) @@ -143,28 +166,25 @@ class Captain::Assistant::AgentRunnerService }, attribute_provider: ->(context_wrapper) { dynamic_trace_attributes(context_wrapper) } ) + register_trace_input_callback(runner) end def dynamic_trace_attributes(context_wrapper) state = context_wrapper&.context&.dig(:state) || {} conversation = state[:conversation] || {} + trace_input = context_wrapper&.context&.dig(:captain_v2_trace_input) + { ATTR_LANGFUSE_USER_ID => state[:account_id], format(ATTR_LANGFUSE_METADATA, 'assistant_id') => state[:assistant_id], format(ATTR_LANGFUSE_METADATA, 'conversation_id') => conversation[:id], format(ATTR_LANGFUSE_METADATA, 'conversation_display_id') => conversation[:display_id], - format(ATTR_LANGFUSE_METADATA, 'channel_type') => state[:channel_type] + format(ATTR_LANGFUSE_METADATA, 'channel_type') => state[:channel_type], + ATTR_LANGFUSE_TRACE_INPUT => trace_input, + ATTR_LANGFUSE_OBSERVATION_INPUT => trace_input }.compact.transform_values(&:to_s) end - def add_callbacks_to_runner(runner) - runner = add_agent_thinking_callback(runner) if @callbacks[:on_agent_thinking] - runner = add_tool_start_callback(runner) if @callbacks[:on_tool_start] - runner = add_tool_complete_callback(runner) if @callbacks[:on_tool_complete] - runner = add_agent_handoff_callback(runner) if @callbacks[:on_agent_handoff] - runner - end - def add_usage_metadata_callback(runner) return runner unless ChatwootApp.otel_enabled? @@ -195,35 +215,20 @@ class Captain::Assistant::AgentRunnerService root_span.set_attribute(format(ATTR_LANGFUSE_METADATA, 'credit_used'), credit_used.to_s) end - def add_agent_thinking_callback(runner) - runner.on_agent_thinking do |*args| - @callbacks[:on_agent_thinking].call(*args) - rescue StandardError => e - Rails.logger.warn "[Captain] Callback error for agent_thinking: #{e.message}" + def runner + @runner ||= begin + configured_runner = Agents::Runner.with_agents(*build_and_wire_agents) + configured_runner = add_usage_metadata_callback(configured_runner) + configured_runner = add_callbacks_to_runner(configured_runner) if @callbacks.any? + install_instrumentation(configured_runner) + configured_runner end end - def add_tool_start_callback(runner) - runner.on_tool_start do |*args| - @callbacks[:on_tool_start].call(*args) - rescue StandardError => e - Rails.logger.warn "[Captain] Callback error for tool_start: #{e.message}" - end - end - - def add_tool_complete_callback(runner) - runner.on_tool_complete do |*args| - @callbacks[:on_tool_complete].call(*args) - rescue StandardError => e - Rails.logger.warn "[Captain] Callback error for tool_complete: #{e.message}" - end - end - - def add_agent_handoff_callback(runner) - runner.on_agent_handoff do |*args| - @callbacks[:on_agent_handoff].call(*args) - rescue StandardError => e - Rails.logger.warn "[Captain] Callback error for agent_handoff: #{e.message}" - end + def run_payload(message_history) + message_to_process = extract_last_user_message(message_history) + context = build_context(message_history_without_last_user_message(message_history)) + enrich_context_with_trace_payload!(context, message_history, message_to_process) + [message_to_process, context] end end diff --git a/enterprise/app/services/captain/assistant/runner_callbacks_helper.rb b/enterprise/app/services/captain/assistant/runner_callbacks_helper.rb new file mode 100644 index 000000000..58fa0ca33 --- /dev/null +++ b/enterprise/app/services/captain/assistant/runner_callbacks_helper.rb @@ -0,0 +1,53 @@ +module Captain::Assistant::RunnerCallbacksHelper + private + + def add_callbacks_to_runner(runner) + runner = add_agent_thinking_callback(runner) if @callbacks[:on_agent_thinking] + runner = add_tool_start_callback(runner) if @callbacks[:on_tool_start] + runner = add_tool_complete_callback(runner) if @callbacks[:on_tool_complete] + runner = add_agent_handoff_callback(runner) if @callbacks[:on_agent_handoff] + runner + end + + def register_trace_input_callback(runner) + runner.on_agent_thinking do |_agent_name, _input, context_wrapper| + tracing = context_wrapper&.context&.dig(:__otel_tracing) + next unless tracing + + trace_input = context_wrapper.context[:captain_v2_trace_current_input] + tracing[:pending_llm_input] = trace_input if trace_input.present? + end + end + + def add_agent_thinking_callback(runner) + runner.on_agent_thinking do |*args| + @callbacks[:on_agent_thinking].call(*args) + rescue StandardError => e + Rails.logger.warn "[Captain] Callback error for agent_thinking: #{e.message}" + end + end + + def add_tool_start_callback(runner) + runner.on_tool_start do |*args| + @callbacks[:on_tool_start].call(*args) + rescue StandardError => e + Rails.logger.warn "[Captain] Callback error for tool_start: #{e.message}" + end + end + + def add_tool_complete_callback(runner) + runner.on_tool_complete do |*args| + @callbacks[:on_tool_complete].call(*args) + rescue StandardError => e + Rails.logger.warn "[Captain] Callback error for tool_complete: #{e.message}" + end + end + + def add_agent_handoff_callback(runner) + runner.on_agent_handoff do |*args| + @callbacks[:on_agent_handoff].call(*args) + rescue StandardError => e + Rails.logger.warn "[Captain] Callback error for agent_handoff: #{e.message}" + end + end +end diff --git a/enterprise/app/services/captain/assistant/trace_payload_helper.rb b/enterprise/app/services/captain/assistant/trace_payload_helper.rb new file mode 100644 index 000000000..3b6546c12 --- /dev/null +++ b/enterprise/app/services/captain/assistant/trace_payload_helper.rb @@ -0,0 +1,51 @@ +module Captain::Assistant::TracePayloadHelper + private + + def enrich_context_with_trace_payload!(context, message_history, message_to_process) + context[:captain_v2_trace_input] = serialize_trace_messages(message_history) + context[:captain_v2_trace_current_input] = serialize_trace_content(message_to_process) + end + + def serialize_trace_messages(message_history) + message_history.map do |message| + { + role: message[:role].to_s, + content: trace_content_payload(message[:content]) + } + end.to_json + end + + def serialize_trace_content(content) + payload = trace_content_payload(content) + return '' if payload.blank? + + payload.is_a?(String) ? payload : payload.to_json + end + + def trace_content_payload(content) + case content + when RubyLLM::Content + trace_parts_from_ruby_llm_content(content) + when Array, Hash + content + when NilClass + '' + else + content.to_s + end + end + + def trace_parts_from_ruby_llm_content(content) + parts = [] + parts << { type: 'text', text: content.text } if content.text.present? + + content.attachments.each do |attachment| + parts << { type: 'image_url', image_url: { url: attachment.source.to_s } } + end + + return '' if parts.blank? + return parts.first[:text] if parts.one? && parts.first[:type] == 'text' + + parts + end +end diff --git a/enterprise/app/services/enterprise/billing/handle_stripe_event_service.rb b/enterprise/app/services/enterprise/billing/handle_stripe_event_service.rb index 52a28844f..d3c5b15db 100644 --- a/enterprise/app/services/enterprise/billing/handle_stripe_event_service.rb +++ b/enterprise/app/services/enterprise/billing/handle_stripe_event_service.rb @@ -11,7 +11,6 @@ class Enterprise::Billing::HandleStripeEventService help_center campaigns team_management - channel_twitter channel_facebook channel_email channel_instagram diff --git a/enterprise/app/services/messages/audio_transcription_service.rb b/enterprise/app/services/messages/audio_transcription_service.rb index 4aa156f47..0e574cb03 100644 --- a/enterprise/app/services/messages/audio_transcription_service.rb +++ b/enterprise/app/services/messages/audio_transcription_service.rb @@ -19,6 +19,9 @@ class Messages::AudioTranscriptionService< Llm::LegacyBaseOpenAiService transcriptions = transcribe_audio Rails.logger.info "Audio transcription successful: #{transcriptions}" { success: true, transcriptions: transcriptions } + rescue Faraday::UnauthorizedError + Rails.logger.warn('Skipping audio transcription: OpenAI configuration is invalid or disabled (401 Unauthorized).') + { error: 'OpenAI configuration is invalid or disabled (401)' } end private diff --git a/enterprise/config/premium_features.yml b/enterprise/config/premium_features.yml index 64275503d..0cb89df01 100644 --- a/enterprise/config/premium_features.yml +++ b/enterprise/config/premium_features.yml @@ -1,7 +1,6 @@ # List of the premium features in EE edition - disable_branding - audit_logs -- response_bot - sla - custom_roles - captain_integration diff --git a/enterprise/lib/captain/prompt_renderer.rb b/enterprise/lib/captain/prompt_renderer.rb index 1a73ddd15..276856417 100644 --- a/enterprise/lib/captain/prompt_renderer.rb +++ b/enterprise/lib/captain/prompt_renderer.rb @@ -5,7 +5,7 @@ class Captain::PromptRenderer def render(template_name, context = {}) template = load_template(template_name) liquid_template = Liquid::Template.parse(template) - liquid_template.render(stringify_keys(context)) + liquid_template.render(stringify_keys(context), registers: { file_system: snippet_file_system }) end private @@ -18,6 +18,13 @@ class Captain::PromptRenderer File.read(template_path) end + def snippet_file_system + @snippet_file_system ||= Liquid::LocalFileSystem.new( + Rails.root.join('enterprise/lib/captain/prompts/snippets'), + '%s.liquid' + ) + end + def stringify_keys(hash) hash.deep_stringify_keys end diff --git a/enterprise/lib/captain/prompts/assistant.liquid b/enterprise/lib/captain/prompts/assistant.liquid index 0dc7d8577..aa94ae1d4 100644 --- a/enterprise/lib/captain/prompts/assistant.liquid +++ b/enterprise/lib/captain/prompts/assistant.liquid @@ -8,17 +8,21 @@ You are {{name}}, a helpful and knowledgeable assistant. Your role is to primari Don't digress away from your instructions, and use all the available tools at your disposal for solving customer issues. If you are to state something factual about {{product_name}} ensure you source that information from the FAQs only. Use the `captain--tools--faq_lookup` tool for this. -{% if conversation || contact -%} +{% if conversation || contact || campaign.id -%} # Current Context Here's the metadata we have about the current conversation and the contact associated with it: {% if conversation -%} -{% render 'conversation' %} +{% render 'conversation', conversation: conversation %} {% endif -%} {% if contact -%} -{% render 'contact' %} +{% render 'contact', contact: contact %} +{% endif -%} + +{% if campaign.id -%} +{% render 'campaign', campaign: campaign %} {% endif -%} {% endif -%} diff --git a/enterprise/lib/captain/prompts/scenario.liquid b/enterprise/lib/captain/prompts/scenario.liquid index 1148a7c3a..6d0f11821 100644 --- a/enterprise/lib/captain/prompts/scenario.liquid +++ b/enterprise/lib/captain/prompts/scenario.liquid @@ -8,17 +8,21 @@ You are a specialized agent called "{{ title }}", your task is to handle the fol If you believe the user's request is not within the scope of your role, you can assign this conversation back to the orchestrator agent using the `handoff_to_{{ assistant_name }}` tool -{% if conversation || contact %} +{% if conversation || contact || campaign.id %} # Current Context Here's the metadata we have about the current conversation and the contact associated with it: {% if conversation -%} -{% render 'conversation' %} +{% render 'conversation', conversation: conversation %} {% endif -%} {% if contact -%} -{% render 'contact' %} +{% render 'contact', contact: contact %} +{% endif -%} + +{% if campaign.id -%} +{% render 'campaign', campaign: campaign %} {% endif -%} {% endif -%} diff --git a/enterprise/lib/captain/prompts/snippets/campaign.liquid b/enterprise/lib/captain/prompts/snippets/campaign.liquid new file mode 100644 index 000000000..db2ac0e8e --- /dev/null +++ b/enterprise/lib/captain/prompts/snippets/campaign.liquid @@ -0,0 +1,8 @@ +# Campaign Context +This conversation was initiated in response to a campaign message. +- Campaign: {{ campaign.title }} +- Type: {{ campaign.campaign_type }} +{% if campaign.description -%} +- Description: {{ campaign.description }} +{% endif -%} +- Original Message Sent: {{ campaign.message }} diff --git a/enterprise/lib/captain/tools/resolve_conversation_tool.rb b/enterprise/lib/captain/tools/resolve_conversation_tool.rb index 0d2563a8b..5d96d3af1 100644 --- a/enterprise/lib/captain/tools/resolve_conversation_tool.rb +++ b/enterprise/lib/captain/tools/resolve_conversation_tool.rb @@ -6,6 +6,7 @@ class Captain::Tools::ResolveConversationTool < Captain::Tools::BasePublicTool conversation = find_conversation(tool_context.state) return 'Conversation not found' unless conversation return "Conversation ##{conversation.display_id} is already resolved" if conversation.resolved? + return 'Auto-resolve is disabled for this account' if conversation.account.captain_disable_auto_resolve log_tool_usage('resolve_conversation', { conversation_id: conversation.id, reason: reason }) diff --git a/enterprise/lib/enterprise/chatwoot_hub.rb b/enterprise/lib/enterprise/chatwoot_hub.rb new file mode 100644 index 000000000..a9d572d2d --- /dev/null +++ b/enterprise/lib/enterprise/chatwoot_hub.rb @@ -0,0 +1,9 @@ +module Enterprise::ChatwootHub + ENTERPRISE_BASE_URL = 'https://hub.2.chatwoot.com'.freeze + + def base_url + return ENV.fetch('CHATWOOT_HUB_URL', ENTERPRISE_BASE_URL) if Rails.env.development? + + ENTERPRISE_BASE_URL + end +end diff --git a/lib/captain/csat_utility_analysis_service.rb b/lib/captain/csat_utility_analysis_service.rb new file mode 100644 index 000000000..e04a98a7f --- /dev/null +++ b/lib/captain/csat_utility_analysis_service.rb @@ -0,0 +1,66 @@ +class Captain::CsatUtilityAnalysisService < Captain::BaseTaskService + pattr_initialize [:account!, :message!, { button_text: nil, language: 'en', baseline: {} }] + + def perform + api_response = make_api_call( + model: GPT_MODEL, + messages: [ + { role: 'system', content: system_prompt }, + { role: 'user', content: message } + ] + ) + + return api_response if api_response[:error] + + build_result(api_response[:message]) + end + + private + + def build_result(response_message) + parsed = parse_json_response(response_message) + return { error: 'Invalid LLM response format' } if parsed.blank? + + core_result(parsed).merge(message: response_message) + end + + def core_result(parsed) + { + classification: normalize_classification(parsed['classification']), + optimized_message: parsed['optimized_message'].presence || baseline[:optimized_message] + } + end + + def system_prompt + template = prompt_from_file('csat_utility_analysis') + Liquid::Template.parse(template).render(prompt_variables) + end + + def prompt_variables + { + 'message' => message.to_s, + 'button_text' => button_text.to_s, + 'language' => language.to_s, + 'baseline_classification' => baseline[:classification].to_s + } + end + + def parse_json_response(content) + raw = content.to_s.strip + json = raw.match(/```json\s*(.*?)\s*```/m)&.captures&.first || raw + JSON.parse(json) + rescue JSON::ParserError + nil + end + + def normalize_classification(value) + normalized = value.to_s.upcase + return normalized if %w[LIKELY_UTILITY LIKELY_MARKETING UNCLEAR].include?(normalized) + + baseline[:classification].presence || 'UNCLEAR' + end + + def event_name + 'csat_utility_analysis' + end +end diff --git a/lib/chatwoot_hub.rb b/lib/chatwoot_hub.rb index c18fb299b..be5a07e05 100644 --- a/lib/chatwoot_hub.rb +++ b/lib/chatwoot_hub.rb @@ -1,12 +1,30 @@ # TODO: lets use HTTParty instead of RestClient class ChatwootHub - BASE_URL = ENV.fetch('CHATWOOT_HUB_URL', 'https://hub.2.chatwoot.com') - PING_URL = "#{BASE_URL}/ping".freeze - REGISTRATION_URL = "#{BASE_URL}/instances".freeze - PUSH_NOTIFICATION_URL = "#{BASE_URL}/send_push".freeze - EVENTS_URL = "#{BASE_URL}/events".freeze - BILLING_URL = "#{BASE_URL}/billing".freeze - CAPTAIN_ACCOUNTS_URL = "#{BASE_URL}/instance_captain_accounts".freeze + DEFAULT_BASE_URL = 'https://hub.2.chatwoot.com'.freeze + + def self.base_url + DEFAULT_BASE_URL + end + + def self.ping_url + "#{base_url}/ping" + end + + def self.registration_url + "#{base_url}/instances" + end + + def self.push_notification_url + "#{base_url}/send_push" + end + + def self.events_url + "#{base_url}/events" + end + + def self.billing_base_url + "#{base_url}/billing" + end def self.installation_identifier identifier = InstallationConfig.find_by(name: 'INSTALLATION_IDENTIFIER')&.value @@ -15,7 +33,7 @@ class ChatwootHub end def self.billing_url - "#{BILLING_URL}?installation_identifier=#{installation_identifier}" + "#{billing_base_url}?installation_identifier=#{installation_identifier}" end def self.pricing_plan @@ -68,7 +86,7 @@ class ChatwootHub begin info = instance_config info = info.merge(instance_metrics) unless ENV['DISABLE_TELEMETRY'] - response = RestClient.post(PING_URL, info.to_json, { content_type: :json, accept: :json }) + response = RestClient.post(ping_url, info.to_json, { content_type: :json, accept: :json }) parsed_response = JSON.parse(response) rescue *ExceptionList::REST_CLIENT_EXCEPTIONS => e Rails.logger.error "Exception: #{e.message}" @@ -80,7 +98,7 @@ class ChatwootHub def self.register_instance(company_name, owner_name, owner_email) info = { company_name: company_name, owner_name: owner_name, owner_email: owner_email, subscribed_to_mailers: true } - RestClient.post(REGISTRATION_URL, info.merge(instance_config).to_json, { content_type: :json, accept: :json }) + RestClient.post(registration_url, info.merge(instance_config).to_json, { content_type: :json, accept: :json }) rescue *ExceptionList::REST_CLIENT_EXCEPTIONS => e Rails.logger.error "Exception: #{e.message}" rescue StandardError => e @@ -89,32 +107,23 @@ class ChatwootHub def self.send_push(fcm_options) info = { fcm_options: fcm_options } - RestClient.post(PUSH_NOTIFICATION_URL, info.merge(instance_config).to_json, { content_type: :json, accept: :json }) + RestClient.post(push_notification_url, info.merge(instance_config).to_json, { content_type: :json, accept: :json }) rescue *ExceptionList::REST_CLIENT_EXCEPTIONS => e Rails.logger.error "Exception: #{e.message}" rescue StandardError => e ChatwootExceptionTracker.new(e).capture_exception end - def self.get_captain_settings(account) - info = { - installation_identifier: installation_identifier, - chatwoot_account_id: account.id, - account_name: account.name - } - HTTParty.post(CAPTAIN_ACCOUNTS_URL, - body: info.to_json, - headers: { 'Content-Type' => 'application/json', 'Accept' => 'application/json' }) - end - def self.emit_event(event_name, event_data) return if ENV['DISABLE_TELEMETRY'] info = { event_name: event_name, event_data: event_data } - RestClient.post(EVENTS_URL, info.merge(instance_config).to_json, { content_type: :json, accept: :json }) + RestClient.post(events_url, info.merge(instance_config).to_json, { content_type: :json, accept: :json }) rescue *ExceptionList::REST_CLIENT_EXCEPTIONS => e Rails.logger.error "Exception: #{e.message}" rescue StandardError => e ChatwootExceptionTracker.new(e).capture_exception end end + +ChatwootHub.singleton_class.prepend_mod_with('ChatwootHub') diff --git a/lib/integrations/openai/openai_prompts/csat_utility_analysis.liquid b/lib/integrations/openai/openai_prompts/csat_utility_analysis.liquid new file mode 100644 index 000000000..a4638241e --- /dev/null +++ b/lib/integrations/openai/openai_prompts/csat_utility_analysis.liquid @@ -0,0 +1,27 @@ +You are a WhatsApp template compliance assistant. +Your task is to evaluate whether a CSAT template message is likely to be approved as UTILITY vs MARKETING under Meta policy. + +Rules: +1. Prefer UTILITY only when the message is tied to an existing support or transactional event. +2. Avoid promotional language, upsell, cross-sell, offers, discounts, or purchase intent. +3. Keep the rewritten message concise, explicit, and purely transactional. +4. Do not invent product offers or marketing phrases. + +Input: +- Message: {{ message }} +- Button text: {{ button_text }} +- Language code: {{ language }} + +Baseline heuristic: +- Classification: {{ baseline_classification }} + +Return ONLY valid JSON with this shape (example): +{ + "classification": "LIKELY_UTILITY", + "optimized_message": "rewritten utility-safe message" +} + +Allowed values for "classification": "LIKELY_UTILITY", "LIKELY_MARKETING", or "UNCLEAR". + +Important: +- Write `optimized_message` in the same language as `Language code`. diff --git a/lib/integrations/slack/slack_message_helper.rb b/lib/integrations/slack/slack_message_helper.rb index 0ee328fb3..3af57a4c3 100644 --- a/lib/integrations/slack/slack_message_helper.rb +++ b/lib/integrations/slack/slack_message_helper.rb @@ -27,6 +27,10 @@ module Integrations::Slack::SlackMessageHelper end def create_message + resolved_sender, sender_name, sender_avatar_url = resolve_slack_sender + slack_sender_attrs = {} + slack_sender_attrs[:sender_name] = sender_name if sender_name + slack_sender_attrs[:sender_avatar_url] = sender_avatar_url if sender_avatar_url @message = conversation.messages.build( message_type: :outgoing, account_id: conversation.account_id, @@ -34,7 +38,8 @@ module Integrations::Slack::SlackMessageHelper content: Slack::Messages::Formatting.unescape(params[:event][:text] || ''), external_source_id_slack: params[:event][:ts], private: private_note?, - sender: sender + sender: resolved_sender, + additional_attributes: slack_sender_attrs ) process_attachments(params[:event][:files]) if attachments_present? @message.save! @@ -81,9 +86,22 @@ module Integrations::Slack::SlackMessageHelper @conversation ||= Conversation.where(identifier: params[:event][:thread_ts]).first end - def sender - user_email = slack_client.users_info(user: params[:event][:user])[:user][:profile][:email] - conversation.account.users.from_email(user_email) + def resolve_slack_sender + return [nil, nil, nil] unless params[:event][:user] + + slack_user = slack_client.users_info(user: params[:event][:user])[:user] + chatwoot_user = conversation.account.users.from_email(slack_user[:profile][:email]) + return [chatwoot_user, nil, nil] if chatwoot_user + + sender_name = slack_user.dig(:profile, :display_name).presence || + slack_user[:real_name].presence || + slack_user[:name] + sender_avatar_url = slack_user.dig(:profile, :image_192).presence + [nil, sender_name, sender_avatar_url] + rescue Slack::Web::Api::Errors::MissingScope + raise + rescue StandardError + [nil, nil, nil] end def private_note? diff --git a/lib/webhooks/trigger.rb b/lib/webhooks/trigger.rb index ef3410b78..456e186ca 100644 --- a/lib/webhooks/trigger.rb +++ b/lib/webhooks/trigger.rb @@ -1,14 +1,16 @@ class Webhooks::Trigger SUPPORTED_ERROR_HANDLE_EVENTS = %w[message_created message_updated].freeze - def initialize(url, payload, webhook_type) + def initialize(url, payload, webhook_type, secret: nil, delivery_id: nil) @url = url @payload = payload @webhook_type = webhook_type + @secret = secret + @delivery_id = delivery_id end - def self.execute(url, payload, webhook_type) - new(url, payload, webhook_type).execute + def self.execute(url, payload, webhook_type, secret: nil, delivery_id: nil) + new(url, payload, webhook_type, secret: secret, delivery_id: delivery_id).execute end def execute @@ -21,15 +23,27 @@ class Webhooks::Trigger private def perform_request + body = @payload.to_json RestClient::Request.execute( method: :post, url: @url, - payload: @payload.to_json, - headers: { content_type: :json, accept: :json }, + payload: body, + headers: request_headers(body), timeout: webhook_timeout ) end + def request_headers(body) + headers = { content_type: :json, accept: :json } + headers['X-Chatwoot-Delivery'] = @delivery_id if @delivery_id.present? + if @secret.present? + ts = Time.now.to_i.to_s + headers['X-Chatwoot-Timestamp'] = ts + headers['X-Chatwoot-Signature'] = "sha256=#{OpenSSL::HMAC.hexdigest('SHA256', @secret, "#{ts}.#{body}")}" + end + headers + end + def handle_error(error) return unless SUPPORTED_ERROR_HANDLE_EVENTS.include?(@payload[:event]) return unless message @@ -72,7 +86,11 @@ class Webhooks::Trigger def message return if message_id.blank? - @message ||= Message.find_by(id: message_id) + if defined?(@message) + @message + else + @message = Message.find_by(id: message_id) + end end def message_id diff --git a/package.json b/package.json index 37b1307cd..b1aa60f00 100644 --- a/package.json +++ b/package.json @@ -35,7 +35,7 @@ "@breezystack/lamejs": "^1.2.7", "@chatwoot/ninja-keys": "1.2.3", "@chatwoot/prosemirror-schema": "1.3.6", - "@chatwoot/utils": "^0.0.51", + "@chatwoot/utils": "^0.0.52", "@formkit/core": "^1.6.7", "@formkit/vue": "^1.6.7", "@hcaptcha/vue3-hcaptcha": "^1.3.0", @@ -46,7 +46,7 @@ "@radix-ui/colors": "^3.0.0", "@rails/actioncable": "6.1.3", "@rails/ujs": "^7.1.400", - "@scmmishra/pico-search": "0.5.4", + "@scmmishra/pico-search": "0.6.0", "@sentry/vue": "^8.55.0", "@sindresorhus/slugify": "2.2.1", "@tailwindcss/typography": "^0.5.15", @@ -95,6 +95,7 @@ "video.js": "7.18.1", "videojs-record": "4.5.0", "videojs-wavesurfer": "3.8.0", + "virtua": "^0.48.6", "vue": "^3.5.12", "vue-chartjs": "5.3.1", "vue-datepicker-next": "^1.0.3", @@ -103,7 +104,6 @@ "vue-letter": "^0.2.1", "vue-router": "~4.4.5", "vue-upload-component": "^3.1.17", - "vue-virtual-scroller": "^2.0.0-beta.8", "vue3-click-away": "^1.2.4", "vuedraggable": "^4.1.0", "vuex": "~4.1.0", diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index e880b4aaf..539a99b21 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -26,8 +26,8 @@ importers: specifier: 1.3.6 version: 1.3.6 '@chatwoot/utils': - specifier: ^0.0.51 - version: 0.0.51 + specifier: ^0.0.52 + version: 0.0.52 '@formkit/core': specifier: ^1.6.7 version: 1.6.7 @@ -59,8 +59,8 @@ importers: specifier: ^7.1.400 version: 7.1.400 '@scmmishra/pico-search': - specifier: 0.5.4 - version: 0.5.4 + specifier: 0.6.0 + version: 0.6.0 '@sentry/vue': specifier: ^8.55.0 version: 8.55.0(pinia@3.0.4(typescript@5.6.2)(vue@3.5.12(typescript@5.6.2)))(vue@3.5.12(typescript@5.6.2)) @@ -205,6 +205,9 @@ importers: videojs-wavesurfer: specifier: 3.8.0 version: 3.8.0 + virtua: + specifier: ^0.48.6 + version: 0.48.6(vue@3.5.12(typescript@5.6.2)) vue: specifier: ^3.5.12 version: 3.5.12(typescript@5.6.2) @@ -229,9 +232,6 @@ importers: vue-upload-component: specifier: ^3.1.17 version: 3.1.17 - vue-virtual-scroller: - specifier: ^2.0.0-beta.8 - version: 2.0.0-beta.8(vue@3.5.12(typescript@5.6.2)) vue3-click-away: specifier: ^1.2.4 version: 1.2.4 @@ -457,8 +457,8 @@ packages: '@chatwoot/prosemirror-schema@1.3.6': resolution: {integrity: sha512-sHRtWqbtiow9mVF1ixim0eGUXfhGK5tuLOdF9Vf53aepjJ+ngEiNVkxQT6FohlEOd886ZsdQxMvmI92IDaUXAQ==} - '@chatwoot/utils@0.0.51': - resolution: {integrity: sha512-WlEmWfOTzR7YZRUWzn5Wpm15/BRudpwqoNckph8TohyDbiim1CP4UZGa+qjajxTbNGLLhtKlm0Xl+X16+5Wceg==} + '@chatwoot/utils@0.0.52': + resolution: {integrity: sha512-e57uVqyVW4tj1gql4YJPNMykqMJPkETn5Y9AmHdhc6Y7oxDXfRXBq27fZrrDadLkZdn5RYVCZjfIhXOumyYv2Q==} engines: {node: '>=10'} '@codemirror/commands@6.7.0': @@ -1240,8 +1240,8 @@ packages: '@rtsao/scc@1.1.0': resolution: {integrity: sha512-zt6OdqaDoOnJ1ZYsCYGt9YmWzDXl4vQdKTyJev62gFhRGKdx7mcT54V9KIjg+d2wi9EXsPvAPKe7i7WjfVWB8g==} - '@scmmishra/pico-search@0.5.4': - resolution: {integrity: sha512-JdV8KumQ+pE5tqgQ71xUT9biE/qV//tx3NCqTLkW9Z4tsjKGN0B6kVowmtaZBAtErqir9XiMxsKXRTMF/MpUww==} + '@scmmishra/pico-search@0.6.0': + resolution: {integrity: sha512-1zC2cAwPWuv38VEh0It90fdUWkvX75OwBUjgTj+d5LTltARnf3ydbpcN2Ucl0aATBMmaNqPMcVvT25IOCAqCEA==} '@sentry-internal/browser-utils@8.55.0': resolution: {integrity: sha512-ROgqtQfpH/82AQIpESPqPQe0UyWywKJsmVIqi3c5Fh+zkds5LUxnssTj3yNd1x+kxaPDVB023jAP+3ibNgeNDw==} @@ -3305,9 +3305,6 @@ packages: resolution: {integrity: sha512-qOOzS1cBTWYF4BH8fVePDBOO9iptMnGUEZwNc/cMWnTV2nVLZ7VoNWEPHkYczZA0pdoA7dl6e7FL659nX9S2aw==} engines: {node: '>=16 || 14 >=14.17'} - mitt@2.1.0: - resolution: {integrity: sha512-ILj2TpLiysu2wkBbWjAmww7TkZb65aiQO+DkVdUTBpBXq+MHYiETENkKFMtsJZX1Lf4pe4QOrTSjIfUwN5lRdg==} - mitt@3.0.1: resolution: {integrity: sha512-vKivATfr97l2/QBCYAkXYDbrIWPM2IIKEl7YPhjCvKlG3kE2gm+uBo6nEXK3M5/Ffh/FLpKExzOQ3JJoJGFKBw==} @@ -4511,6 +4508,26 @@ packages: videojs-wavesurfer@3.8.0: resolution: {integrity: sha512-qHucCBiEW+4dZ0Zp1k4R1elprUOV+QDw87UDA9QRXtO7GK/MrSdoe/TMFxP9SLnJCiX9xnYdf4OQgrmvJ9UVVw==} + virtua@0.48.6: + resolution: {integrity: sha512-Cl4uMvMV5c9RuOy9zhkFMYwx/V4YLBMYLRSWkO8J46opQZ3P7KMq0CqCVOOAKUckjl/r//D2jWTBGYWzmgtzrQ==} + peerDependencies: + react: '>=16.14.0' + react-dom: '>=16.14.0' + solid-js: '>=1.0' + svelte: '>=5.0' + vue: '>=3.2' + peerDependenciesMeta: + react: + optional: true + react-dom: + optional: true + solid-js: + optional: true + svelte: + optional: true + vue: + optional: true + vite-node@2.0.1: resolution: {integrity: sha512-nVd6kyhPAql0s+xIVJzuF+RSRH8ZimNrm6U8ZvTA4MXv8CHI17TFaQwRaFiK75YX6XeFqZD4IoAaAfi9OR1XvQ==} engines: {node: ^18.0.0 || >=20.0.0} @@ -4625,11 +4642,6 @@ packages: vue-letter@0.2.1: resolution: {integrity: sha512-IYWp47XUikjKfEniWYlFxeJFKABZwAE5IEjz866qCBytBr2dzqVDdjoMDpBP//krxkzN/QZYyHe6C09y/IODYg==} - vue-observe-visibility@2.0.0-alpha.1: - resolution: {integrity: sha512-flFbp/gs9pZniXR6fans8smv1kDScJ8RS7rEpMjhVabiKeq7Qz3D9+eGsypncjfIyyU84saU88XZ0zjbD6Gq/g==} - peerDependencies: - vue: ^3.0.0 - vue-resize@2.0.0-alpha.1: resolution: {integrity: sha512-7+iqOueLU7uc9NrMfrzbG8hwMqchfVfSzpVlCMeJQe4pyibqyoifDNbKTZvwxZKDvGkB+PdFeKvnGZMoEb8esg==} peerDependencies: @@ -4643,11 +4655,6 @@ packages: vue-upload-component@3.1.17: resolution: {integrity: sha512-1orTC5apoFzBz4ku2HAydpviaAOck+ABc83rGypIK/Bgl+TqhtoWsQOhXqbb7vDv7pKlvRVWwml9PM224HyhkA==} - vue-virtual-scroller@2.0.0-beta.8: - resolution: {integrity: sha512-b8/f5NQ5nIEBRTNi6GcPItE4s7kxNHw2AIHLtDp+2QvqdTjVN0FgONwX9cr53jWRgnu+HRLPaWDOR2JPI5MTfQ==} - peerDependencies: - vue: ^3.2.0 - vue3-click-away@1.2.4: resolution: {integrity: sha512-O9Z2KlvIhJT8OxaFy04eiZE9rc1Mk/bp+70dLok68ko3Kr8AW5dU+j8avSk4GDQu94FllSr4m5ul4BpzlKOw1A==} @@ -5010,7 +5017,7 @@ snapshots: prosemirror-utils: 1.2.2(prosemirror-model@1.22.3)(prosemirror-state@1.4.3) prosemirror-view: 1.34.1 - '@chatwoot/utils@0.0.51': + '@chatwoot/utils@0.0.52': dependencies: date-fns: 2.30.0 @@ -5788,7 +5795,7 @@ snapshots: '@rtsao/scc@1.1.0': {} - '@scmmishra/pico-search@0.5.4': {} + '@scmmishra/pico-search@0.6.0': {} '@sentry-internal/browser-utils@8.55.0': dependencies: @@ -8226,8 +8233,6 @@ snapshots: minipass@7.1.2: {} - mitt@2.1.0: {} - mitt@3.0.1: {} mlly@1.8.0: @@ -9574,6 +9579,10 @@ snapshots: video.js: 7.18.1 wavesurfer.js: 7.8.6 + virtua@0.48.6(vue@3.5.12(typescript@5.6.2)): + optionalDependencies: + vue: 3.5.12(typescript@5.6.2) + vite-node@2.0.1(@types/node@22.7.0)(sass@1.79.3)(terser@5.33.0): dependencies: cac: 6.7.14 @@ -9692,10 +9701,6 @@ snapshots: dependencies: lettersanitizer: 1.0.6 - vue-observe-visibility@2.0.0-alpha.1(vue@3.5.12(typescript@5.6.2)): - dependencies: - vue: 3.5.12(typescript@5.6.2) - vue-resize@2.0.0-alpha.1(vue@3.5.12(typescript@5.6.2)): dependencies: vue: 3.5.12(typescript@5.6.2) @@ -9707,13 +9712,6 @@ snapshots: vue-upload-component@3.1.17: {} - vue-virtual-scroller@2.0.0-beta.8(vue@3.5.12(typescript@5.6.2)): - dependencies: - mitt: 2.1.0 - vue: 3.5.12(typescript@5.6.2) - vue-observe-visibility: 2.0.0-alpha.1(vue@3.5.12(typescript@5.6.2)) - vue-resize: 2.0.0-alpha.1(vue@3.5.12(typescript@5.6.2)) - vue3-click-away@1.2.4: {} vue@3.5.12(typescript@5.6.2): diff --git a/spec/builders/messages/facebook/message_builder_spec.rb b/spec/builders/messages/facebook/message_builder_spec.rb index 4b94c9be4..525ad7736 100644 --- a/spec/builders/messages/facebook/message_builder_spec.rb +++ b/spec/builders/messages/facebook/message_builder_spec.rb @@ -59,6 +59,36 @@ describe Messages::Facebook::MessageBuilder do expect(contact.name).to eq(default_name) end + it 'marks echo messages as external echo messages' do + allow(Koala::Facebook::API).to receive(:new).and_return(fb_object) + allow(fb_object).to receive(:get_object).and_return( + { + first_name: 'Jane', + last_name: 'Dae', + account_id: facebook_channel.inbox.account_id, + profile_pic: 'https://chatwoot-assets.local/sample.png' + }.with_indifferent_access + ) + + echo_message_object = { + messaging: { + sender: { id: facebook_channel.page_id }, + recipient: { id: '3383290475046708' }, + message: { mid: 'm_echo_1', text: 'Echo testing', is_echo: true, app_id: '263902037430900' } + } + }.to_json + echo_message = Integrations::Facebook::MessageParser.new(echo_message_object) + + described_class.new(echo_message, facebook_channel.inbox, outgoing_echo: true).perform + + message = facebook_channel.inbox.messages.find_by(source_id: 'm_echo_1') + expect(message).to be_present + expect(message.message_type).to eq('outgoing') + expect(message.sender).to be_nil + expect(message.status).to eq('delivered') + expect(message.content_attributes['external_echo']).to be true + end + context 'when lock to single conversation' do subject(:mocked_message_builder) do described_class.new(mocked_incoming_fb_text_message, facebook_channel.inbox).perform diff --git a/spec/controllers/api/v1/accounts/inbox_csat_templates_controller_spec.rb b/spec/controllers/api/v1/accounts/inbox_csat_templates_controller_spec.rb index d577c1b5d..ea23319fe 100644 --- a/spec/controllers/api/v1/accounts/inbox_csat_templates_controller_spec.rb +++ b/spec/controllers/api/v1/accounts/inbox_csat_templates_controller_spec.rb @@ -10,10 +10,12 @@ RSpec.describe Api::V1::Accounts::InboxCsatTemplatesController, type: :request d let(:whatsapp_inbox) { create(:inbox, channel: whatsapp_channel, account: account) } let(:web_widget_inbox) { create(:inbox, account: account) } let(:mock_service) { instance_double(Whatsapp::CsatTemplateService) } + let(:analysis_service) { instance_double(CsatTemplateUtilityAnalysisService) } before do create(:inbox_member, user: agent, inbox: whatsapp_inbox) allow(Whatsapp::CsatTemplateService).to receive(:new).and_return(mock_service) + allow(CsatTemplateUtilityAnalysisService).to receive(:new).and_return(analysis_service) end describe 'GET /api/v1/accounts/{account.id}/inboxes/{inbox.id}/csat_template' do @@ -380,4 +382,93 @@ RSpec.describe Api::V1::Accounts::InboxCsatTemplatesController, type: :request d end end end + + describe 'POST /api/v1/accounts/{account.id}/inboxes/{inbox.id}/csat_template/analyze' do + let(:valid_template_params) do + { + template: { + message: 'How would you rate your experience?', + button_text: 'Rate Us', + language: 'en' + } + } + end + + context 'when captain_integration feature is disabled' do + before do + account.disable_features!('captain_integration') + end + + it 'returns forbidden' do + post "/api/v1/accounts/#{account.id}/inboxes/#{whatsapp_inbox.id}/csat_template/analyze", + headers: admin.create_new_auth_token, + params: valid_template_params, + as: :json + + expect(response).to have_http_status(:forbidden) + expect(response.parsed_body['error']).to eq('Captain is required for template analysis') + end + end + + context 'when captain_integration feature is enabled' do + before do + account.enable_features!('captain_integration') + account.reload + end + + it 'returns analysis response' do + allow(analysis_service).to receive(:perform).and_return({ + classification: 'LIKELY_UTILITY', + optimized_message: 'Your support request has been closed.' + }) + + post "/api/v1/accounts/#{account.id}/inboxes/#{whatsapp_inbox.id}/csat_template/analyze", + headers: admin.create_new_auth_token, + params: valid_template_params, + as: :json + + expect(response).to have_http_status(:success) + response_data = response.parsed_body + expect(response_data['classification']).to eq('LIKELY_UTILITY') + expect(response_data['optimized_message']).to eq('Your support request has been closed.') + end + + it 'returns error when message is missing' do + invalid_params = { template: { button_text: 'Rate Us', language: 'en' } } + + post "/api/v1/accounts/#{account.id}/inboxes/#{whatsapp_inbox.id}/csat_template/analyze", + headers: admin.create_new_auth_token, + params: invalid_params, + as: :json + + expect(response).to have_http_status(:unprocessable_entity) + expect(response.parsed_body['error']).to eq('Message is required') + end + + it 'returns unauthorized when agent is not assigned to inbox' do + other_agent = create(:user, account: account, role: :agent) + + post "/api/v1/accounts/#{account.id}/inboxes/#{whatsapp_inbox.id}/csat_template/analyze", + headers: other_agent.create_new_auth_token, + params: valid_template_params, + as: :json + + expect(response).to have_http_status(:unauthorized) + end + + it 'allows access when agent is assigned to inbox' do + allow(analysis_service).to receive(:perform).and_return({ + classification: 'LIKELY_UTILITY', + optimized_message: 'Your support request has been closed.' + }) + + post "/api/v1/accounts/#{account.id}/inboxes/#{whatsapp_inbox.id}/csat_template/analyze", + headers: agent.create_new_auth_token, + params: valid_template_params, + as: :json + + expect(response).to have_http_status(:success) + end + end + end end diff --git a/spec/controllers/api/v1/accounts/tiktok/authorizations_controller_spec.rb b/spec/controllers/api/v1/accounts/tiktok/authorizations_controller_spec.rb index 54724aba0..dab4dfad3 100644 --- a/spec/controllers/api/v1/accounts/tiktok/authorizations_controller_spec.rb +++ b/spec/controllers/api/v1/accounts/tiktok/authorizations_controller_spec.rb @@ -32,23 +32,25 @@ RSpec.describe 'TikTok Authorization API', type: :request do end it 'creates a new authorization and returns the redirect url' do - with_modified_env TIKTOK_APP_ID: 'tiktok-app-id', TIKTOK_APP_SECRET: 'tiktok-app-secret' do - post "/api/v1/accounts/#{account.id}/tiktok/authorization", - headers: administrator.create_new_auth_token, - as: :json + travel_to Time.zone.parse('2025-01-01 00:00:00 UTC') do + with_modified_env TIKTOK_APP_ID: 'tiktok-app-id', TIKTOK_APP_SECRET: 'tiktok-app-secret' do + post "/api/v1/accounts/#{account.id}/tiktok/authorization", + headers: administrator.create_new_auth_token, + as: :json + end + + expect(response).to have_http_status(:success) + expect(response.parsed_body['success']).to be true + + helper = Class.new do + include Tiktok::IntegrationHelper + end.new + + expected_state = helper.generate_tiktok_token(account.id) + expected_url = Tiktok::AuthClient.authorize_url(state: expected_state) + + expect(response.parsed_body['url']).to eq(expected_url) end - - expect(response).to have_http_status(:success) - expect(response.parsed_body['success']).to be true - - helper = Class.new do - include Tiktok::IntegrationHelper - end.new - - expected_state = helper.generate_tiktok_token(account.id) - expected_url = Tiktok::AuthClient.authorize_url(state: expected_state) - - expect(response.parsed_body['url']).to eq(expected_url) end end end diff --git a/spec/enterprise/jobs/captain/conversation/response_builder_job_spec.rb b/spec/enterprise/jobs/captain/conversation/response_builder_job_spec.rb index 777086613..4e48eb355 100644 --- a/spec/enterprise/jobs/captain/conversation/response_builder_job_spec.rb +++ b/spec/enterprise/jobs/captain/conversation/response_builder_job_spec.rb @@ -92,6 +92,44 @@ RSpec.describe Captain::Conversation::ResponseBuilderJob, type: :job do end end + # Regression (PR #13417): wrapping create_handoff_message and bot_handoff! in the + # same transaction defers the message's after_create_commit until commit, at which + # point it clears waiting_since (bot_response). The handoff path must stay outside + # the transaction so the callback fires before bot_handoff! sets waiting_since. + context 'when handoff is requested' do + let(:conversation) { create(:conversation, inbox: inbox, account: account, status: :pending) } + let(:agent) { create(:user, account: account, role: :agent) } + + before do + allow(account).to receive(:feature_enabled?).and_return(false) + allow(account).to receive(:feature_enabled?).with('captain_integration_v2').and_return(false) + allow(mock_llm_chat_service).to receive(:generate_response).and_return({ 'response' => 'conversation_handoff' }) + end + + it 'sets waiting_since to approximately the handoff time' do + freeze_time do + described_class.perform_now(conversation, assistant) + + conversation.reload + expect(conversation.status).to eq('open') + expect(conversation.waiting_since).to be_within(1.second).of(Time.current) + end + end + + it 'preserves waiting_since so a human reply consumes it for reply_time tracking' do + described_class.perform_now(conversation, assistant) + + conversation.reload + expect(conversation.waiting_since).to be_present + + # A human reply clears waiting_since (consumed by dispatch_create_events + # to emit FIRST_REPLY_CREATED or REPLY_CREATED for reply_time tracking). + create(:message, conversation: conversation, message_type: :outgoing, + sender: agent, account: account, inbox: inbox) + expect(conversation.reload.waiting_since).to be_nil + end + end + context 'when message contains an image' do let(:message_with_image) { create(:message, conversation: conversation, message_type: :incoming, content: 'Can you help with this error?') } let(:image_attachment) { message_with_image.attachments.create!(account: account, file_type: :image, external_url: 'https://example.com/error.jpg') } diff --git a/spec/enterprise/jobs/captain/inbox_pending_conversations_resolution_job_spec.rb b/spec/enterprise/jobs/captain/inbox_pending_conversations_resolution_job_spec.rb index 1a8a5a342..ab8f0296c 100644 --- a/spec/enterprise/jobs/captain/inbox_pending_conversations_resolution_job_spec.rb +++ b/spec/enterprise/jobs/captain/inbox_pending_conversations_resolution_job_spec.rb @@ -64,4 +64,15 @@ RSpec.describe Captain::InboxPendingConversationsResolutionJob, type: :job do } ) end + + it 'does not resolve conversations when auto-resolve is disabled at execution time' do + inbox.account.update!(captain_disable_auto_resolve: true) + + expect do + described_class.perform_now(inbox) + end.not_to(change { resolvable_pending_conversation.reload.status }) + + expect(resolvable_pending_conversation.reload.status).to eq('pending') + expect(resolvable_pending_conversation.messages.outgoing).to be_empty + end end diff --git a/spec/enterprise/jobs/enterprise/account/conversations_resolution_scheduler_job_spec.rb b/spec/enterprise/jobs/enterprise/account/conversations_resolution_scheduler_job_spec.rb index b67877412..343100a50 100644 --- a/spec/enterprise/jobs/enterprise/account/conversations_resolution_scheduler_job_spec.rb +++ b/spec/enterprise/jobs/enterprise/account/conversations_resolution_scheduler_job_spec.rb @@ -30,6 +30,22 @@ RSpec.describe Account::ConversationsResolutionSchedulerJob, type: :job do end end + context 'when account has captain_disable_auto_resolve enabled' do + let!(:regular_inbox) { create(:inbox, account: account) } + + before do + create(:captain_inbox, captain_assistant: assistant, inbox: regular_inbox) + account.update!(captain_disable_auto_resolve: true) + end + + it 'does not enqueue resolution jobs' do + expect do + described_class.perform_now + end.not_to have_enqueued_job(Captain::InboxPendingConversationsResolutionJob) + .with(regular_inbox) + end + end + context 'when inbox has no captain enabled' do let!(:inbox_without_captain) { create(:inbox, account: create(:account)) } diff --git a/spec/enterprise/lib/captain/prompt_renderer_spec.rb b/spec/enterprise/lib/captain/prompt_renderer_spec.rb index 761d55f99..910319253 100644 --- a/spec/enterprise/lib/captain/prompt_renderer_spec.rb +++ b/spec/enterprise/lib/captain/prompt_renderer_spec.rb @@ -58,7 +58,7 @@ RSpec.describe Captain::PromptRenderer do it 'loads and parses liquid template' do liquid_template_double = instance_double(Liquid::Template) allow(Liquid::Template).to receive(:parse).with(template_content).and_return(liquid_template_double) - allow(liquid_template_double).to receive(:render).with(hash_including('name', 'balance')).and_return('rendered') + allow(liquid_template_double).to receive(:render).with(hash_including('name', 'balance'), anything).and_return('rendered') result = described_class.render(template_name, context) @@ -67,6 +67,36 @@ RSpec.describe Captain::PromptRenderer do end end + describe 'snippet rendering' do + let(:snippets_dir) { Rails.root.join('enterprise/lib/captain/prompts/snippets') } + let(:snippet_path) { snippets_dir.join('greeting.liquid') } + + before do + allow(File).to receive(:exist?).and_call_original + allow(File).to receive(:read).and_call_original + allow(File).to receive(:exist?).with(template_path).and_return(true) + # Create a controlled snippet to decouple from real snippet content + allow(File).to receive(:exist?).with(snippet_path.to_s).and_return(true) + allow(File).to receive(:read).with(snippet_path.to_s).and_return('Hello {{ name }}') + end + + it 'resolves render tags from the snippets directory' do + allow(File).to receive(:read).with(template_path).and_return("{% render 'greeting', name: name %}") + + result = described_class.render(template_name, { name: 'World' }) + + expect(result).to eq('Hello World') + end + + it 'outputs a liquid error for missing snippets' do + allow(File).to receive(:read).with(template_path).and_return("{% render 'nonexistent' %}") + + result = described_class.render(template_name, {}) + + expect(result).to include('Liquid error') + end + end + describe '.load_template' do it 'reads template file from correct path' do described_class.send(:load_template, template_name) diff --git a/spec/enterprise/lib/captain/tools/http_tool_spec.rb b/spec/enterprise/lib/captain/tools/http_tool_spec.rb index 967a10574..e05308a7d 100644 --- a/spec/enterprise/lib/captain/tools/http_tool_spec.rb +++ b/spec/enterprise/lib/captain/tools/http_tool_spec.rb @@ -249,6 +249,10 @@ RSpec.describe Captain::Tools::HttpTool, type: :model do id: conversation.id, display_id: conversation.display_id }, + contact_inbox: { + id: conversation.contact_inbox.id, + hmac_verified: conversation.contact_inbox.hmac_verified + }, contact: { id: contact.id, email: contact.email, @@ -272,6 +276,8 @@ RSpec.describe Captain::Tools::HttpTool, type: :model do 'X-Chatwoot-Tool-Slug' => custom_tool.slug, 'X-Chatwoot-Conversation-Id' => conversation.id.to_s, 'X-Chatwoot-Conversation-Display-Id' => conversation.display_id.to_s, + 'X-Chatwoot-Contact-Inbox-Id' => conversation.contact_inbox.id.to_s, + 'X-Chatwoot-Contact-Inbox-Verified' => conversation.contact_inbox.hmac_verified.to_s, 'X-Chatwoot-Contact-Id' => contact.id.to_s, 'X-Chatwoot-Contact-Email' => contact.email }) @@ -282,6 +288,7 @@ RSpec.describe Captain::Tools::HttpTool, type: :model do expect(WebMock).to have_requested(:get, 'https://example.com/api/data') .with(headers: { 'X-Chatwoot-Account-Id' => account.id.to_s, + 'X-Chatwoot-Contact-Inbox-Verified' => conversation.contact_inbox.hmac_verified.to_s, 'X-Chatwoot-Contact-Email' => contact.email }) end @@ -296,6 +303,7 @@ RSpec.describe Captain::Tools::HttpTool, type: :model do 'Content-Type' => 'application/json', 'X-Chatwoot-Account-Id' => account.id.to_s, 'X-Chatwoot-Tool-Slug' => custom_tool.slug, + 'X-Chatwoot-Contact-Inbox-Verified' => conversation.contact_inbox.hmac_verified.to_s, 'X-Chatwoot-Contact-Email' => contact.email } ) @@ -316,6 +324,7 @@ RSpec.describe Captain::Tools::HttpTool, type: :model do .with(headers: { 'Authorization' => 'Bearer test_token', 'X-Chatwoot-Account-Id' => account.id.to_s, + 'X-Chatwoot-Contact-Inbox-Verified' => conversation.contact_inbox.hmac_verified.to_s, 'X-Chatwoot-Contact-Id' => contact.id.to_s }) .to_return(status: 200, body: '{"success": true}') @@ -336,13 +345,18 @@ RSpec.describe Captain::Tools::HttpTool, type: :model do conversation: { id: conversation.id, display_id: conversation.display_id + }, + contact_inbox: { + id: conversation.contact_inbox.id, + hmac_verified: conversation.contact_inbox.hmac_verified } }) stub_request(:get, 'https://example.com/api/data') .with(headers: { 'X-Chatwoot-Account-Id' => account.id.to_s, - 'X-Chatwoot-Conversation-Id' => conversation.id.to_s + 'X-Chatwoot-Conversation-Id' => conversation.id.to_s, + 'X-Chatwoot-Contact-Inbox-Verified' => conversation.contact_inbox.hmac_verified.to_s }) .to_return(status: 200, body: '{"success": true}') @@ -351,6 +365,32 @@ RSpec.describe Captain::Tools::HttpTool, type: :model do expect(WebMock).to have_requested(:get, 'https://example.com/api/data') end + it 'defaults contact inbox verified header to false when contact inbox is missing' do + tool_context_without_contact_inbox = Struct.new(:state).new({ + account_id: account.id, + assistant_id: assistant.id, + conversation: { + id: conversation.id, + display_id: conversation.display_id + }, + contact: { + id: contact.id, + email: contact.email + } + }) + + stub_request(:get, 'https://example.com/api/data') + .with(headers: { + 'X-Chatwoot-Contact-Inbox-Verified' => 'false' + }) + .to_return(status: 200, body: '{"success": true}') + + tool.perform(tool_context_without_contact_inbox) + + expect(WebMock).to have_requested(:get, 'https://example.com/api/data') + .with(headers: { 'X-Chatwoot-Contact-Inbox-Verified' => 'false' }) + end + it 'includes contact phone when present' do contact.update!(phone_number: '+1234567890') tool_context_with_state.state[:contact][:phone_number] = '+1234567890' @@ -366,6 +406,22 @@ RSpec.describe Captain::Tools::HttpTool, type: :model do expect(WebMock).to have_requested(:get, 'https://example.com/api/data') .with(headers: { 'X-Chatwoot-Contact-Phone' => '+1234567890' }) end + + it 'includes unverified contact inbox status explicitly as false' do + conversation.contact_inbox.update!(hmac_verified: false) + tool_context_with_state.state[:contact_inbox][:hmac_verified] = false + + stub_request(:get, 'https://example.com/api/data') + .with(headers: { + 'X-Chatwoot-Contact-Inbox-Verified' => 'false' + }) + .to_return(status: 200, body: '{"success": true}') + + tool.perform(tool_context_with_state) + + expect(WebMock).to have_requested(:get, 'https://example.com/api/data') + .with(headers: { 'X-Chatwoot-Contact-Inbox-Verified' => 'false' }) + end end end end diff --git a/spec/enterprise/lib/captain/tools/resolve_conversation_tool_spec.rb b/spec/enterprise/lib/captain/tools/resolve_conversation_tool_spec.rb index f91f430e8..d5792cf78 100644 --- a/spec/enterprise/lib/captain/tools/resolve_conversation_tool_spec.rb +++ b/spec/enterprise/lib/captain/tools/resolve_conversation_tool_spec.rb @@ -36,6 +36,17 @@ RSpec.describe Captain::Tools::ResolveConversationTool do end end + describe 'when auto-resolve is disabled for the account' do + before { account.update!(captain_disable_auto_resolve: true) } + + it 'does not resolve and returns a disabled message' do + result = tool.perform(tool_context, reason: 'Possible spam') + + expect(result).to eq('Auto-resolve is disabled for this account') + expect(conversation.reload).not_to be_resolved + end + end + describe 'resolving an already resolved conversation' do let(:conversation) { create(:conversation, account: account, inbox: inbox, status: :resolved) } diff --git a/spec/enterprise/lib/chatwoot_hub_spec.rb b/spec/enterprise/lib/chatwoot_hub_spec.rb new file mode 100644 index 000000000..24d78d028 --- /dev/null +++ b/spec/enterprise/lib/chatwoot_hub_spec.rb @@ -0,0 +1,21 @@ +require 'rails_helper' + +RSpec.describe ChatwootHub do + describe '.base_url' do + it 'uses the static hub url outside development for enterprise edition' do + with_modified_env CHATWOOT_HUB_URL: 'https://custom.example.com' do + allow(Rails).to receive(:env).and_return(ActiveSupport::StringInquirer.new('production')) + + expect(described_class.base_url).to eq('https://hub.2.chatwoot.com') + end + end + + it 'uses CHATWOOT_HUB_URL in development for enterprise edition' do + with_modified_env CHATWOOT_HUB_URL: 'https://custom.example.com' do + allow(Rails).to receive(:env).and_return(ActiveSupport::StringInquirer.new('development')) + + expect(described_class.base_url).to eq('https://custom.example.com') + end + end + end +end diff --git a/spec/enterprise/models/captain/custom_tool_spec.rb b/spec/enterprise/models/captain/custom_tool_spec.rb index 0ead8fb1f..60b66778f 100644 --- a/spec/enterprise/models/captain/custom_tool_spec.rb +++ b/spec/enterprise/models/captain/custom_tool_spec.rb @@ -341,6 +341,10 @@ RSpec.describe Captain::CustomTool, type: :model do id: conversation.id, display_id: conversation.display_id }, + contact_inbox: { + id: conversation.contact_inbox.id, + hmac_verified: conversation.contact_inbox.hmac_verified + }, contact: { id: contact.id, email: contact.email, @@ -376,6 +380,13 @@ RSpec.describe Captain::CustomTool, type: :model do expect(headers['X-Chatwoot-Contact-Email']).to eq(contact.email) end + it 'includes contact inbox verification metadata when present' do + headers = tool.build_metadata_headers(state) + + expect(headers['X-Chatwoot-Contact-Inbox-Id']).to eq(conversation.contact_inbox.id.to_s) + expect(headers['X-Chatwoot-Contact-Inbox-Verified']).to eq(conversation.contact_inbox.hmac_verified.to_s) + end + it 'handles missing conversation gracefully' do state[:conversation] = nil @@ -396,11 +407,21 @@ RSpec.describe Captain::CustomTool, type: :model do expect(headers['X-Chatwoot-Account-Id']).to eq(account.id.to_s) end + it 'handles missing contact inbox gracefully' do + state[:contact_inbox] = nil + + headers = tool.build_metadata_headers(state) + + expect(headers['X-Chatwoot-Contact-Inbox-Id']).to be_nil + expect(headers['X-Chatwoot-Contact-Inbox-Verified']).to eq('false') + end + it 'handles empty state' do headers = tool.build_metadata_headers({}) expect(headers).to be_a(Hash) expect(headers['X-Chatwoot-Tool-Slug']).to eq('custom_test_tool') + expect(headers['X-Chatwoot-Contact-Inbox-Verified']).to eq('false') end it 'omits contact email header when email is blank' do @@ -418,6 +439,22 @@ RSpec.describe Captain::CustomTool, type: :model do expect(headers).not_to have_key('X-Chatwoot-Contact-Phone') end + + it 'includes contact inbox verified header when false' do + state[:contact_inbox][:hmac_verified] = false + + headers = tool.build_metadata_headers(state) + + expect(headers['X-Chatwoot-Contact-Inbox-Verified']).to eq('false') + end + + it 'defaults contact inbox verified header to false when value is nil' do + state[:contact_inbox][:hmac_verified] = nil + + headers = tool.build_metadata_headers(state) + + expect(headers['X-Chatwoot-Contact-Inbox-Verified']).to eq('false') + end end describe '#to_tool_metadata' do diff --git a/spec/enterprise/models/concerns/agentable_spec.rb b/spec/enterprise/models/concerns/agentable_spec.rb index 6b170e8d7..fbf6a58dc 100644 --- a/spec/enterprise/models/concerns/agentable_spec.rb +++ b/spec/enterprise/models/concerns/agentable_spec.rb @@ -97,7 +97,8 @@ RSpec.describe Concerns::Agentable do expected_context = { base_key: 'base_value', conversation: { id: 123 }, - contact: { name: 'John' } + contact: { name: 'John' }, + campaign: {} } expect(Captain::PromptRenderer).to receive(:render).with( @@ -108,6 +109,26 @@ RSpec.describe Concerns::Agentable do dummy_instance.agent_instructions(context_double) end + it 'merges campaign data from context state' do + context_double = instance_double(Agents::RunContext, + context: { + state: { + conversation: { id: 123 }, + contact: { name: 'John' }, + campaign: { id: 10, title: 'Summer Sale', message: 'Check it out' } + } + }) + + expect(Captain::PromptRenderer).to receive(:render).with( + 'dummy_class', + hash_including( + campaign: { id: 10, title: 'Summer Sale', message: 'Check it out' } + ) + ) + + dummy_instance.agent_instructions(context_double) + end + it 'handles context without state' do context_double = instance_double(Agents::RunContext, context: {}) @@ -116,7 +137,8 @@ RSpec.describe Concerns::Agentable do hash_including( base_key: 'base_value', conversation: {}, - contact: {} + contact: {}, + campaign: {} ) ) diff --git a/spec/enterprise/services/captain/assistant/agent_runner_service_spec.rb b/spec/enterprise/services/captain/assistant/agent_runner_service_spec.rb index c3019b82c..2ac3c6589 100644 --- a/spec/enterprise/services/captain/assistant/agent_runner_service_spec.rb +++ b/spec/enterprise/services/captain/assistant/agent_runner_service_spec.rb @@ -74,12 +74,11 @@ RSpec.describe Captain::Assistant::AgentRunnerService do end it 'runs agent with extracted user message and context' do - expected_context = { + expected_context = hash_including( session_id: "#{account.id}_#{conversation.display_id}", conversation_history: [ { role: :user, content: 'Hello there', agent_name: nil }, - { role: :assistant, content: 'Hi! How can I help you?', agent_name: 'Assistant' }, - { role: :user, content: 'I need help with my account', agent_name: nil } + { role: :assistant, content: 'Hi! How can I help you?', agent_name: 'Assistant' } ], state: hash_including( account_id: account.id, @@ -87,7 +86,7 @@ RSpec.describe Captain::Assistant::AgentRunnerService do conversation: hash_including(id: conversation.id), contact: hash_including(id: contact.id) ) - } + ) expect(mock_runner).to receive(:run).with( 'I need help with my account', @@ -98,6 +97,71 @@ RSpec.describe Captain::Assistant::AgentRunnerService do service.generate_response(message_history: message_history) end + context 'when the latest user message is multimodal' do + let(:multimodal_message_history) do + [ + { role: 'assistant', content: 'Please share a screenshot' }, + { + role: 'user', + content: [ + { type: 'text', text: 'What does this error mean?' }, + { type: 'image_url', image_url: { url: 'https://example.com/error.png' } } + ] + } + ] + end + + it 'passes image attachments to the runner input' do + expect(mock_runner).to receive(:run) do |input, context:, max_turns:| + expect(input).to be_a(RubyLLM::Content) + expect(input.text).to eq('What does this error mean?') + expect(input.attachments.first.source.to_s).to eq('https://example.com/error.png') + expect(context[:conversation_history]).to eq([{ role: :assistant, content: 'Please share a screenshot', agent_name: nil }]) + expect(max_turns).to eq(100) + end + + service.generate_response(message_history: multimodal_message_history) + end + + it 'preserves multimodal content in earlier history messages' do + history_with_prior_image = [ + { + role: 'user', + content: [ + { type: 'text', text: 'Here is my error screenshot' }, + { type: 'image_url', image_url: { url: 'https://example.com/error.png' } } + ] + }, + { role: 'assistant', content: 'I see the error. Try restarting.' }, + { role: 'user', content: 'It still does not work' } + ] + + expect(mock_runner).to receive(:run) do |input, context:, max_turns:| + expect(input).to eq('It still does not work') + # The earlier user message with the image should preserve the multimodal array + first_history_msg = context[:conversation_history].first + expect(first_history_msg[:content]).to be_a(Array) + expect(first_history_msg[:content]).to include( + { type: 'text', text: 'Here is my error screenshot' }, + { type: 'image_url', image_url: { url: 'https://example.com/error.png' } } + ) + expect(max_turns).to eq(100) + end + + service.generate_response(message_history: history_with_prior_image) + end + + it 'stores multimodal trace payloads in runner context' do + expect(mock_runner).to receive(:run) do |_input, context:, max_turns:| + expect(context[:captain_v2_trace_input]).to include('image_url') + expect(context[:captain_v2_trace_current_input]).to include('image_url') + expect(max_turns).to eq(100) + end + + service.generate_response(message_history: multimodal_message_history) + end + end + it 'processes and formats agent result' do result = service.generate_response(message_history: message_history) @@ -197,22 +261,21 @@ RSpec.describe Captain::Assistant::AgentRunnerService do end context 'with multimodal content' do - let(:multimodal_message_history) do + let(:multimodal_content) do [ - { - role: 'user', - content: [ - { type: 'text', text: 'Can you help with this image?' }, - { type: 'image_url', image_url: { url: 'https://example.com/image.jpg' } } - ] - } + { type: 'text', text: 'Can you help with this image?' }, + { type: 'image_url', image_url: { url: 'https://example.com/image.jpg' } } ] end - it 'extracts text content from multimodal messages' do + let(:multimodal_message_history) do + [{ role: 'user', content: multimodal_content }] + end + + it 'preserves multimodal arrays in conversation history for image context retention' do context = service.send(:build_context, multimodal_message_history) - expect(context[:conversation_history].first[:content]).to eq('Can you help with this image?') + expect(context[:conversation_history].first[:content]).to eq(multimodal_content) end end end @@ -225,6 +288,24 @@ RSpec.describe Captain::Assistant::AgentRunnerService do expect(result).to eq('I need help with my account') end + + it 'returns multimodal content with image attachments for the runner input' do + multimodal_message_history = [ + { + role: 'user', + content: [ + { type: 'text', text: 'Can you check this screenshot?' }, + { type: 'image_url', image_url: { url: 'https://example.com/image.jpg' } } + ] + } + ] + + result = service.send(:extract_last_user_message, multimodal_message_history) + + expect(result).to be_a(RubyLLM::Content) + expect(result.text).to eq('Can you check this screenshot?') + expect(result.attachments.first.source.to_s).to eq('https://example.com/image.jpg') + end end describe '#extract_text_from_content' do @@ -256,6 +337,28 @@ RSpec.describe Captain::Assistant::AgentRunnerService do end end + describe '#dynamic_trace_attributes' do + subject(:service) { described_class.new(assistant: assistant, conversation: conversation) } + + it 'adds serialized trace input attributes when present in context' do + context = { + state: { + account_id: account.id, + assistant_id: assistant.id, + conversation: { id: conversation.id, display_id: conversation.display_id } + }, + captain_v2_trace_input: '[{"role":"user","content":[{"type":"image_url","image_url":{"url":"https://example.com/image.jpg"}}]}]' + } + context_wrapper = Struct.new(:context).new(context) + + attributes = service.send(:dynamic_trace_attributes, context_wrapper) + + expect(attributes['langfuse.trace.input']).to include('image_url') + expect(attributes['langfuse.observation.input']).to include('image_url') + expect(attributes['langfuse.user.id']).to eq(account.id.to_s) + end + end + describe '#build_state' do subject(:service) { described_class.new(assistant: assistant, conversation: conversation) } @@ -281,6 +384,15 @@ RSpec.describe Captain::Assistant::AgentRunnerService do expect(state[:channel_type]).to eq(inbox.channel_type) end + it 'includes contact inbox attributes when conversation is present' do + state = service.send(:build_state) + + expect(state[:contact_inbox]).to include( + id: conversation.contact_inbox.id, + hmac_verified: conversation.contact_inbox.hmac_verified + ) + end + it 'includes contact attributes when contact is present' do state = service.send(:build_state) @@ -291,6 +403,34 @@ RSpec.describe Captain::Assistant::AgentRunnerService do ) end + it 'does not include campaign when conversation has no campaign' do + state = service.send(:build_state) + + expect(state).not_to have_key(:campaign) + end + + context 'when conversation has a campaign' do + let(:campaign) { create(:campaign, account: account, title: 'Summer Sale', message: 'Check out our deals!', description: 'Seasonal promo') } + let(:conversation) { create(:conversation, account: account, inbox: inbox, contact: contact, campaign: campaign) } + + it 'includes campaign attributes in state' do + state = service.send(:build_state) + + expect(state[:campaign]).to include( + id: campaign.id, + title: 'Summer Sale', + message: 'Check out our deals!', + description: 'Seasonal promo' + ) + end + + it 'only includes attributes defined in CAMPAIGN_STATE_ATTRIBUTES' do + state = service.send(:build_state) + + expect(state[:campaign].keys).to match_array(described_class::CAMPAIGN_STATE_ATTRIBUTES) + end + end + context 'when conversation is nil' do subject(:service) { described_class.new(assistant: assistant, conversation: nil) } @@ -304,6 +444,7 @@ RSpec.describe Captain::Assistant::AgentRunnerService do ) expect(state).not_to have_key(:conversation) expect(state).not_to have_key(:contact) + expect(state).not_to have_key(:campaign) end end end @@ -374,5 +515,11 @@ RSpec.describe Captain::Assistant::AgentRunnerService do :id, :name, :email, :phone_number, :identifier, :contact_type ) end + + it 'defines campaign state attributes' do + expect(described_class::CAMPAIGN_STATE_ATTRIBUTES).to include( + :id, :title, :message, :campaign_type, :description + ) + end end end diff --git a/spec/jobs/agent_bots/webhook_job_spec.rb b/spec/jobs/agent_bots/webhook_job_spec.rb index a8117d84e..346d85e83 100644 --- a/spec/jobs/agent_bots/webhook_job_spec.rb +++ b/spec/jobs/agent_bots/webhook_job_spec.rb @@ -16,7 +16,7 @@ RSpec.describe AgentBots::WebhookJob do end it 'executes perform' do - expect(Webhooks::Trigger).to receive(:execute).with(url, payload, webhook_type) + expect(Webhooks::Trigger).to receive(:execute).with(url, payload, webhook_type, secret: nil, delivery_id: nil) perform_enqueued_jobs { job } end end diff --git a/spec/jobs/webhook_job_spec.rb b/spec/jobs/webhook_job_spec.rb index 81802a3c0..c74c1d8a8 100644 --- a/spec/jobs/webhook_job_spec.rb +++ b/spec/jobs/webhook_job_spec.rb @@ -16,7 +16,7 @@ RSpec.describe WebhookJob do end it 'executes perform with default webhook type' do - expect(Webhooks::Trigger).to receive(:execute).with(url, payload, webhook_type) + expect(Webhooks::Trigger).to receive(:execute).with(url, payload, webhook_type, secret: nil, delivery_id: nil) perform_enqueued_jobs { job } end @@ -24,7 +24,7 @@ RSpec.describe WebhookJob do let(:webhook_type) { :api_inbox_webhook } it 'executes perform with inbox webhook type' do - expect(Webhooks::Trigger).to receive(:execute).with(url, payload, webhook_type) + expect(Webhooks::Trigger).to receive(:execute).with(url, payload, webhook_type, secret: nil, delivery_id: nil) perform_enqueued_jobs { job } end end diff --git a/spec/lib/captain/csat_utility_analysis_service_spec.rb b/spec/lib/captain/csat_utility_analysis_service_spec.rb new file mode 100644 index 000000000..e4e980e01 --- /dev/null +++ b/spec/lib/captain/csat_utility_analysis_service_spec.rb @@ -0,0 +1,24 @@ +require 'rails_helper' + +RSpec.describe Captain::CsatUtilityAnalysisService do + let(:account) { create(:account) } + let(:service) { described_class.new(account: account, message: 'Test message', language: 'en', baseline: {}) } + + describe '#perform' do + before do + allow(account).to receive(:feature_enabled?).and_call_original + allow(account).to receive(:feature_enabled?).with('captain_tasks').and_return(true) + allow(service).to receive(:make_api_call).and_return({ + message: '{"classification":"LIKELY_UTILITY","optimized_message":"Utility-safe message"}' + }) + end + + it 'returns parsed payload and preserves raw message for usage metering' do + result = service.perform + + expect(result[:classification]).to eq('LIKELY_UTILITY') + expect(result[:optimized_message]).to eq('Utility-safe message') + expect(result[:message]).to eq('{"classification":"LIKELY_UTILITY","optimized_message":"Utility-safe message"}') + end + end +end diff --git a/spec/lib/chatwoot_hub_spec.rb b/spec/lib/chatwoot_hub_spec.rb index 0f53971af..a1051e619 100644 --- a/spec/lib/chatwoot_hub_spec.rb +++ b/spec/lib/chatwoot_hub_spec.rb @@ -1,6 +1,13 @@ require 'rails_helper' describe ChatwootHub do + describe '.base_url' do + it 'uses the static hub url' do + expect(described_class::DEFAULT_BASE_URL).to eq('https://hub.2.chatwoot.com') + expect(described_class.base_url).to eq('https://hub.2.chatwoot.com') + end + end + it 'generates installation identifier' do installation_identifier = described_class.installation_identifier expect(installation_identifier).not_to be_nil @@ -12,7 +19,7 @@ describe ChatwootHub do version = '1.1.1' allow(RestClient).to receive(:post).and_return({ version: version }.to_json) expect(described_class.sync_with_hub['version']).to eq version - expect(RestClient).to have_received(:post).with(described_class::PING_URL, described_class.instance_config + expect(RestClient).to have_received(:post).with(described_class.ping_url, described_class.instance_config .merge(described_class.instance_metrics).to_json, { content_type: :json, accept: :json }) end @@ -21,7 +28,7 @@ describe ChatwootHub do with_modified_env DISABLE_TELEMETRY: 'true' do allow(RestClient).to receive(:post).and_return({ version: version }.to_json) expect(described_class.sync_with_hub['version']).to eq version - expect(RestClient).to have_received(:post).with(described_class::PING_URL, + expect(RestClient).to have_received(:post).with(described_class.ping_url, described_class.instance_config.to_json, { content_type: :json, accept: :json }) end end @@ -41,7 +48,7 @@ describe ChatwootHub do info = { company_name: company_name, owner_name: owner_name, owner_email: owner_email, subscribed_to_mailers: true } allow(RestClient).to receive(:post) described_class.register_instance(company_name, owner_name, owner_email) - expect(RestClient).to have_received(:post).with(described_class::REGISTRATION_URL, + expect(RestClient).to have_received(:post).with(described_class.registration_url, info.merge(described_class.instance_config).to_json, { content_type: :json, accept: :json }) end end @@ -54,7 +61,7 @@ describe ChatwootHub do info = { event_name: event_name, event_data: event_data } allow(RestClient).to receive(:post) described_class.emit_event(event_name, event_data) - expect(RestClient).to have_received(:post).with(described_class::EVENTS_URL, + expect(RestClient).to have_received(:post).with(described_class.events_url, info.merge(described_class.instance_config).to_json, { content_type: :json, accept: :json }) end @@ -64,29 +71,9 @@ describe ChatwootHub do allow(RestClient).to receive(:post) described_class.emit_event(event_name, event_data) expect(RestClient).not_to have_received(:post) - .with(described_class::EVENTS_URL, + .with(described_class.events_url, info.merge(described_class.instance_config).to_json, { content_type: :json, accept: :json }) end end end - - context 'when fetching captain settings' do - it 'returns the captain settings' do - account = create(:account) - stub_request(:post, ChatwootHub::CAPTAIN_ACCOUNTS_URL).with( - body: { installation_identifier: described_class.installation_identifier, chatwoot_account_id: account.id, account_name: account.name } - ).to_return( - body: { account_email: 'test@test.com', account_id: '123', access_token: '123', assistant_id: '123' }.to_json - ) - - expect(described_class.get_captain_settings(account).body).to eq( - { - account_email: 'test@test.com', - account_id: '123', - access_token: '123', - assistant_id: '123' - }.to_json - ) - end - end end diff --git a/spec/lib/integrations/slack/incoming_message_builder_spec.rb b/spec/lib/integrations/slack/incoming_message_builder_spec.rb index 2ce206489..65234767e 100644 --- a/spec/lib/integrations/slack/incoming_message_builder_spec.rb +++ b/spec/lib/integrations/slack/incoming_message_builder_spec.rb @@ -69,7 +69,7 @@ describe Integrations::Slack::IncomingMessageBuilder do expect(hook).not_to be_nil messages_count = conversation.messages.count builder = described_class.new(message_params) - allow(builder).to receive(:sender).and_return(nil) + allow(builder).to receive(:resolve_slack_sender).and_return([nil, nil, nil]) 2.times.each { builder.perform } expect(conversation.messages.count).to eql(messages_count + 1) expect(conversation.messages.last.content).to eql('this is test https://chatwoot.com Hey @Sojan Test again') @@ -79,7 +79,7 @@ describe Integrations::Slack::IncomingMessageBuilder do expect(hook).not_to be_nil messages_count = conversation.messages.count builder = described_class.new(message_params) - allow(builder).to receive(:sender).and_return(nil) + allow(builder).to receive(:resolve_slack_sender).and_return([nil, nil, nil]) builder.perform expect(conversation.messages.count).to eql(messages_count + 1) expect(conversation.messages.last.content).to eql('this is test https://chatwoot.com Hey @Sojan Test again') @@ -89,7 +89,7 @@ describe Integrations::Slack::IncomingMessageBuilder do expect(hook).not_to be_nil messages_count = conversation.messages.count builder = described_class.new(private_message_params) - allow(builder).to receive(:sender).and_return(nil) + allow(builder).to receive(:resolve_slack_sender).and_return([nil, nil, nil]) builder.perform expect(conversation.messages.count).to eql(messages_count + 1) expect(conversation.messages.last.content).to eql('pRivate: A private note message') @@ -130,7 +130,7 @@ describe Integrations::Slack::IncomingMessageBuilder do messages_count = conversation.messages.count message_with_attachments[:event][:files] = nil builder = described_class.new(message_with_attachments) - allow(builder).to receive(:sender).and_return(nil) + allow(builder).to receive(:resolve_slack_sender).and_return([nil, nil, nil]) builder.perform expect(conversation.messages.count).to eql(messages_count) end @@ -139,7 +139,7 @@ describe Integrations::Slack::IncomingMessageBuilder do expect(hook).not_to be_nil messages_count = conversation.messages.count builder = described_class.new(message_with_attachments) - allow(builder).to receive(:sender).and_return(nil) + allow(builder).to receive(:resolve_slack_sender).and_return([nil, nil, nil]) builder.perform expect(conversation.messages.count).to eql(messages_count + 1) expect(conversation.messages.last.content).to eql('this is test https://chatwoot.com Hey @Sojan Test again') @@ -152,7 +152,7 @@ describe Integrations::Slack::IncomingMessageBuilder do message_with_attachments[:event][:text] = 'Attached File!' builder = described_class.new(message_with_attachments) - allow(builder).to receive(:sender).and_return(nil) + allow(builder).to receive(:resolve_slack_sender).and_return([nil, nil, nil]) builder.perform expect(conversation.messages.count).to eql(messages_count) @@ -165,13 +165,113 @@ describe Integrations::Slack::IncomingMessageBuilder do video_attachment_params[:event][:files][0][:mimetype] = 'video/mp4' builder = described_class.new(video_attachment_params) - allow(builder).to receive(:sender).and_return(nil) + allow(builder).to receive(:resolve_slack_sender).and_return([nil, nil, nil]) expect { builder.perform }.not_to raise_error expect(conversation.messages.last.attachments).to be_any end end + context 'when resolving slack sender' do + let(:builder) { described_class.new(message_params) } + + before do + allow(builder).to receive(:slack_client).and_return(slack_client) + end + + context 'when slack user email matches a chatwoot agent' do + before do + create(:user, account: conversation.account, email: 'agent@example.com') + slack_response = { + user: { + profile: { email: 'agent@example.com', display_name: 'Muhsin K', image_192: 'https://avatars.slack-edge.com/avatar.png' }, + real_name: 'Muhsin K', + name: 'muhsink' + } + } + allow(slack_client).to receive(:users_info) + .with(user: message_params[:event][:user]) + .and_return(slack_response) + end + + it 'sets the matched agent as message sender' do + builder.perform + expect(conversation.messages.last.sender).to eq(conversation.account.users.from_email('agent@example.com')) + end + + it 'does not store sender_name in additional_attributes' do + builder.perform + expect(conversation.messages.last.additional_attributes).not_to have_key('sender_name') + end + end + + context 'when slack user email does not match any chatwoot agent' do + before do + slack_response = { + user: { + profile: { email: 'unknown@example.com', display_name: 'Muhsin K', image_192: 'https://avatars.slack-edge.com/avatar.png' }, + real_name: 'Muhsin K', + name: 'muhsink' + } + } + allow(slack_client).to receive(:users_info) + .with(user: message_params[:event][:user]) + .and_return(slack_response) + end + + it 'saves sender_name from slack display_name in additional_attributes' do + builder.perform + expect(conversation.messages.last.sender).to be_nil + expect(conversation.messages.last.additional_attributes['sender_name']).to eq('Muhsin K') + end + + it 'saves sender_avatar_url from slack profile image in additional_attributes' do + builder.perform + expect(conversation.messages.last.additional_attributes['sender_avatar_url']) + .to eq('https://avatars.slack-edge.com/avatar.png') + end + + it 'falls back to real_name when display_name is blank' do + allow(slack_client).to receive(:users_info).and_return({ + user: { + profile: { email: 'unknown@example.com', display_name: '', + image_192: nil }, real_name: 'Muhsin K', name: 'muhsink' + } + }) + builder.perform + expect(conversation.messages.last.additional_attributes['sender_name']).to eq('Muhsin K') + end + + it 'falls back to slack username when display_name and real_name are both blank' do + allow(slack_client).to receive(:users_info).and_return({ + user: { + profile: { email: 'unknown@example.com', display_name: '', + image_192: nil }, real_name: '', name: 'muhsink' + } + }) + builder.perform + expect(conversation.messages.last.additional_attributes['sender_name']).to eq('muhsink') + end + end + + context 'when the slack API call raises an error' do + before do + allow(slack_client).to receive(:users_info).and_raise(StandardError, 'API error') + end + + it 'creates the message with nil sender' do + expect { builder.perform }.not_to raise_error + expect(conversation.messages.last.sender).to be_nil + end + + it 'does not store sender info in additional_attributes' do + builder.perform + expect(conversation.messages.last.additional_attributes).not_to have_key('sender_name') + expect(conversation.messages.last.additional_attributes).not_to have_key('sender_avatar_url') + end + end + end + context 'when link shared' do let(:link_shared) do { diff --git a/spec/lib/webhooks/trigger_spec.rb b/spec/lib/webhooks/trigger_spec.rb index 79cf92150..1e047b557 100644 --- a/spec/lib/webhooks/trigger_spec.rb +++ b/spec/lib/webhooks/trigger_spec.rb @@ -168,6 +168,71 @@ describe Webhooks::Trigger do end end + describe 'request headers' do + let(:payload) { { event: 'message_created' } } + let(:body) { payload.to_json } + + context 'without secret or delivery_id' do + it 'sends only content-type and accept headers' do + expect(RestClient::Request).to receive(:execute).with( + hash_including(headers: { content_type: :json, accept: :json }) + ) + trigger.execute(url, payload, webhook_type) + end + end + + context 'with delivery_id' do + it 'adds X-Chatwoot-Delivery header' do + expect(RestClient::Request).to receive(:execute) do |args| + expect(args[:headers]['X-Chatwoot-Delivery']).to eq('test-uuid') + expect(args[:headers]).not_to have_key('X-Chatwoot-Signature') + expect(args[:headers]).not_to have_key('X-Chatwoot-Timestamp') + end + trigger.execute(url, payload, webhook_type, delivery_id: 'test-uuid') + end + end + + context 'with secret' do + let(:secret) { 'test-secret' } + + it 'adds X-Chatwoot-Timestamp header' do + expect(RestClient::Request).to receive(:execute) do |args| + expect(args[:headers]['X-Chatwoot-Timestamp']).to match(/\A\d+\z/) + end + trigger.execute(url, payload, webhook_type, secret: secret) + end + + it 'adds X-Chatwoot-Signature header with correct HMAC' do + expect(RestClient::Request).to receive(:execute) do |args| + ts = args[:headers]['X-Chatwoot-Timestamp'] + expected_sig = "sha256=#{OpenSSL::HMAC.hexdigest('SHA256', secret, "#{ts}.#{body}")}" + expect(args[:headers]['X-Chatwoot-Signature']).to eq(expected_sig) + end + trigger.execute(url, payload, webhook_type, secret: secret) + end + + it 'signs timestamp.body not just body' do + expect(RestClient::Request).to receive(:execute) do |args| + args[:headers]['X-Chatwoot-Timestamp'] + wrong_sig = "sha256=#{OpenSSL::HMAC.hexdigest('SHA256', secret, body)}" + expect(args[:headers]['X-Chatwoot-Signature']).not_to eq(wrong_sig) + end + trigger.execute(url, payload, webhook_type, secret: secret) + end + end + + context 'with both secret and delivery_id' do + it 'includes all three security headers' do + expect(RestClient::Request).to receive(:execute) do |args| + expect(args[:headers]['X-Chatwoot-Delivery']).to eq('abc-123') + expect(args[:headers]['X-Chatwoot-Timestamp']).to be_present + expect(args[:headers]['X-Chatwoot-Signature']).to start_with('sha256=') + end + trigger.execute(url, payload, webhook_type, secret: 'mysecret', delivery_id: 'abc-123') + end + end + end + it 'does not update message status if webhook fails for other events' do payload = { event: 'conversation_created', conversation: { id: conversation.id }, id: message.id } diff --git a/spec/listeners/webhook_listener_spec.rb b/spec/listeners/webhook_listener_spec.rb index 5062b11bc..51dae239b 100644 --- a/spec/listeners/webhook_listener_spec.rb +++ b/spec/listeners/webhook_listener_spec.rb @@ -28,7 +28,10 @@ describe WebhookListener do context 'when webhook is configured and event is subscribed' do it 'triggers the webhook event' do webhook = create(:webhook, inbox: inbox, account: account) - expect(WebhookJob).to receive(:perform_later).with(webhook.url, message.webhook_data.merge(event: 'message_created')).once + expect(WebhookJob).to receive(:perform_later).with( + webhook.url, message.webhook_data.merge(event: 'message_created'), :account_webhook, + secret: webhook.secret, delivery_id: instance_of(String) + ).once listener.message_created(message_created_event) end end @@ -54,8 +57,10 @@ describe WebhookListener do conversation: api_conversation ) api_event = Events::Base.new(event_name, Time.zone.now, message: api_message) - expect(WebhookJob).to receive(:perform_later).with(channel_api.webhook_url, api_message.webhook_data.merge(event: 'message_created'), - :api_inbox_webhook).once + expect(WebhookJob).to receive(:perform_later).with( + channel_api.webhook_url, api_message.webhook_data.merge(event: 'message_created'), + :api_inbox_webhook, delivery_id: instance_of(String) + ).once listener.message_created(api_event) end @@ -90,7 +95,10 @@ describe WebhookListener do context 'when webhook is configured' do it 'triggers webhook' do webhook = create(:webhook, inbox: inbox, account: account) - expect(WebhookJob).to receive(:perform_later).with(webhook.url, conversation.webhook_data.merge(event: 'conversation_created')).once + expect(WebhookJob).to receive(:perform_later).with( + webhook.url, conversation.webhook_data.merge(event: 'conversation_created'), :account_webhook, + secret: webhook.secret, delivery_id: instance_of(String) + ).once listener.conversation_created(conversation_created_event) end end @@ -101,9 +109,11 @@ describe WebhookListener do api_inbox = channel_api.inbox api_conversation = create(:conversation, account: account, inbox: api_inbox, assignee: user) api_event = Events::Base.new(event_name, Time.zone.now, conversation: api_conversation) - expect(WebhookJob).to receive(:perform_later).with(channel_api.webhook_url, - api_conversation.webhook_data.merge(event: 'conversation_created'), - :api_inbox_webhook).once + expect(WebhookJob).to receive(:perform_later).with( + channel_api.webhook_url, + api_conversation.webhook_data.merge(event: 'conversation_created'), + :api_inbox_webhook, delivery_id: instance_of(String) + ).once listener.conversation_created(api_event) end @@ -156,7 +166,9 @@ describe WebhookListener do } } ] - ) + ), + :account_webhook, + secret: webhook.secret, delivery_id: instance_of(String) ).once listener.conversation_updated(conversation_updated_event) @@ -177,7 +189,10 @@ describe WebhookListener do context 'when webhook is configured' do it 'triggers webhook' do webhook = create(:webhook, account: account) - expect(WebhookJob).to receive(:perform_later).with(webhook.url, contact.webhook_data.merge(event: 'contact_created')).once + expect(WebhookJob).to receive(:perform_later).with( + webhook.url, contact.webhook_data.merge(event: 'contact_created'), :account_webhook, + secret: webhook.secret, delivery_id: instance_of(String) + ).once listener.contact_created(contact_event) end end @@ -213,7 +228,9 @@ describe WebhookListener do contact.webhook_data.merge( event: 'contact_updated', changed_attributes: [{ 'name' => { :current_value => 'Jane Doe', :previous_value => 'Jane' } }] - ) + ), + :account_webhook, + secret: webhook.secret, delivery_id: instance_of(String) ).once listener.contact_updated(contact_updated_event) end @@ -235,7 +252,10 @@ describe WebhookListener do it 'triggers webhook' do inbox_data = Inbox::EventDataPresenter.new(inbox).push_data webhook = create(:webhook, account: account, subscriptions: ['inbox_created']) - expect(WebhookJob).to receive(:perform_later).with(webhook.url, inbox_data.merge(event: 'inbox_created')).once + expect(WebhookJob).to receive(:perform_later).with( + webhook.url, inbox_data.merge(event: 'inbox_created'), :account_webhook, + secret: webhook.secret, delivery_id: instance_of(String) + ).once listener.inbox_created(inbox_created_event) end end @@ -272,7 +292,9 @@ describe WebhookListener do expect(WebhookJob).to receive(:perform_later).with( webhook.url, - inbox_data.merge(event: 'inbox_updated', changed_attributes: changed_attributes_data) + inbox_data.merge(event: 'inbox_updated', changed_attributes: changed_attributes_data), + :account_webhook, + secret: webhook.secret, delivery_id: instance_of(String) ).once listener.inbox_updated(inbox_updated_event) @@ -302,7 +324,10 @@ describe WebhookListener do is_private: false } - expect(WebhookJob).to receive(:perform_later).with(webhook.url, payload).once + expect(WebhookJob).to receive(:perform_later).with( + webhook.url, payload, :account_webhook, + secret: webhook.secret, delivery_id: instance_of(String) + ).once listener.conversation_typing_on(typing_event) end end @@ -321,7 +346,10 @@ describe WebhookListener do is_private: false } - expect(WebhookJob).to receive(:perform_later).with(channel_api.webhook_url, payload, :api_inbox_webhook).once + expect(WebhookJob).to receive(:perform_later).with( + channel_api.webhook_url, payload, :api_inbox_webhook, + delivery_id: instance_of(String) + ).once listener.conversation_typing_on(api_event) end end @@ -349,7 +377,10 @@ describe WebhookListener do is_private: false } - expect(WebhookJob).to receive(:perform_later).with(webhook.url, payload).once + expect(WebhookJob).to receive(:perform_later).with( + webhook.url, payload, :account_webhook, + secret: webhook.secret, delivery_id: instance_of(String) + ).once listener.conversation_typing_off(typing_event) end end diff --git a/spec/models/conversation_spec.rb b/spec/models/conversation_spec.rb index e1883b54d..89c090207 100644 --- a/spec/models/conversation_spec.rb +++ b/spec/models/conversation_spec.rb @@ -313,6 +313,47 @@ RSpec.describe Conversation do end end + describe '#bot_handoff!' do + let(:conversation) { create(:conversation, status: :pending) } + + before do + allow(Rails.configuration.dispatcher).to receive(:dispatch) + end + + context 'when waiting_since is blank' do + before { conversation.update(waiting_since: nil) } + + it 'sets waiting_since to current time' do + freeze_time do + conversation.bot_handoff! + expect(conversation.reload.waiting_since).to eq(Time.current) + end + end + end + + context 'when waiting_since is already set' do + let(:original_time) { 1.hour.ago } + + before { conversation.update(waiting_since: original_time) } + + it 'preserves existing waiting_since' do + conversation.bot_handoff! + expect(conversation.reload.waiting_since).to be_within(1.second).of(original_time) + end + end + + it 'changes status to open' do + conversation.bot_handoff! + expect(conversation.reload.status).to eq('open') + end + + it 'dispatches CONVERSATION_BOT_HANDOFF event' do + expect(Rails.configuration.dispatcher).to receive(:dispatch) + .with(described_class::CONVERSATION_BOT_HANDOFF, anything, hash_including(conversation: conversation)) + conversation.bot_handoff! + end + end + describe '#toggle_priority' do it 'defaults priority to nil when created' do conversation = create(:conversation, status: 'open') diff --git a/spec/models/webhook_spec.rb b/spec/models/webhook_spec.rb index 81e6d9551..b8570de59 100644 --- a/spec/models/webhook_spec.rb +++ b/spec/models/webhook_spec.rb @@ -8,4 +8,20 @@ RSpec.describe Webhook do describe 'associations' do it { is_expected.to belong_to(:account) } end + + describe 'secret token' do + let!(:account) { create(:account) } + + it 'auto-generates a secret on create' do + webhook = create(:webhook, account: account) + expect(webhook.secret).to be_present + end + + it 'does not regenerate the secret on update' do + webhook = create(:webhook, account: account) + original_secret = webhook.secret + webhook.update!(url: "#{webhook.url}?updated=1") + expect(webhook.reload.secret).to eq(original_secret) + end + end end diff --git a/spec/services/csat_template_utility_analysis_service_spec.rb b/spec/services/csat_template_utility_analysis_service_spec.rb new file mode 100644 index 000000000..7f5521d4a --- /dev/null +++ b/spec/services/csat_template_utility_analysis_service_spec.rb @@ -0,0 +1,81 @@ +require 'rails_helper' + +RSpec.describe CsatTemplateUtilityAnalysisService do + let(:account) { build_stubbed(:account) } + let(:inbox) { build_stubbed(:inbox) } + let(:llm_service) { instance_double(Captain::CsatUtilityAnalysisService) } + + before do + allow(Captain::CsatUtilityAnalysisService).to receive(:new).and_return(llm_service) + allow(llm_service).to receive(:perform).and_return({ error: 'LLM unavailable' }) + end + + describe '#perform' do + context 'when message is utility-compatible' do + it 'returns likely utility classification and keeps original message' do + message = 'Your support request has been closed. If you still need help, reply to this message.' + result = described_class.new(account: account, inbox: inbox, message: message, language: 'en').perform + + expect(result[:classification]).to eq('LIKELY_UTILITY') + expect(result[:optimized_message]).to eq(message) + expect(result.keys).to contain_exactly(:classification, :optimized_message) + end + end + + context 'when message contains marketing intent' do + it 'returns likely marketing classification with utility-safe rewrite' do + message = 'Please rate us and check out our special offer with a discount.' + result = described_class.new(account: account, inbox: inbox, message: message, language: 'en').perform + + expect(result[:classification]).to eq('LIKELY_MARKETING') + expect(result[:optimized_message]).to include('support request') + expect(result[:optimized_message]).to include('reply to this message') + expect(result.keys).to contain_exactly(:classification, :optimized_message) + end + end + + context 'when language is non-English and fallback rewrite is used' do + it 'returns English rewrite content' do + message = 'Tu caso está cerrado. Califícanos y no te pierdas nuestra oferta.' + result = described_class.new(account: account, inbox: inbox, message: message, language: 'es').perform + + expect(result[:optimized_message]).to include('Your support request has been closed.') + expect(result[:optimized_message]).to include('If you still need help') + end + end + + context 'when llm returns inconsistent marketing classification' do + it 'keeps likely marketing classification' do + allow(llm_service).to receive(:perform).and_return({ + classification: 'LIKELY_MARKETING', + optimized_message: 'Your support request has been closed.' + }) + + message = "Your case is closed. Don't miss our limited-time premium offer. Rate us below." + result = described_class.new(account: account, inbox: inbox, message: message, language: 'en').perform + + expect(result[:classification]).to eq('LIKELY_MARKETING') + end + end + + context 'when rules classify as marketing' do + it 'short-circuits without calling llm' do + expect(llm_service).not_to receive(:perform) + + message = 'Your request is closed. Special offer: subscribe now and save.' + result = described_class.new(account: account, inbox: inbox, message: message, language: 'en').perform + + expect(result[:classification]).to eq('LIKELY_MARKETING') + end + end + + context 'when rules classify as marketing for plural promo terms' do + it 'keeps likely marketing classification from baseline rules' do + message = 'Thanks for contacting us. Rate us and check out our new plans with special discounts.' + result = described_class.new(account: account, inbox: inbox, message: message, language: 'en').perform + + expect(result[:classification]).to eq('LIKELY_MARKETING') + end + end + end +end diff --git a/spec/services/line/incoming_message_service_spec.rb b/spec/services/line/incoming_message_service_spec.rb index a7805ce9b..997777a43 100644 --- a/spec/services/line/incoming_message_service_spec.rb +++ b/spec/services/line/incoming_message_service_spec.rb @@ -405,5 +405,111 @@ describe Line::IncomingMessageService do expect(line_channel.inbox.messages.first.attachments.first.file.blob.filename.to_s).to eq('contacts.csv') end end + + context 'when lock_to_single_conversation is false' do + before do + line_channel.inbox.update(lock_to_single_conversation: false) + end + + it 'creates a new conversation when all previous conversations are resolved' do + line_bot = double + line_user_profile = double + allow(Line::Bot::Client).to receive(:new).and_return(line_bot) + allow(line_bot).to receive(:get_profile).and_return(line_user_profile) + allow(line_user_profile).to receive(:body).and_return( + { + 'displayName': 'LINE Test', + 'userId': 'U4af4980629', + 'pictureUrl': 'https://test.com' + }.to_json + ) + + # Create a contact and a resolved conversation + described_class.new(inbox: line_channel.inbox, params: params).perform + + # Mark the conversation as resolved + conversation = line_channel.inbox.conversations.last + conversation.update(status: :resolved) + + # Send a new message + new_params = params.deep_dup + new_params[:events][0][:message][:id] = '325709' + new_params[:events][0][:message][:text] = 'Second message' + + described_class.new(inbox: line_channel.inbox, params: new_params).perform + + # Should create a new conversation + expect(line_channel.inbox.conversations.count).to eq(2) + expect(line_channel.inbox.conversations.last.messages.first.content).to eq('Second message') + end + + it 'uses the existing conversation when there is an unresolved conversation' do + line_bot = double + line_user_profile = double + allow(Line::Bot::Client).to receive(:new).and_return(line_bot) + allow(line_bot).to receive(:get_profile).and_return(line_user_profile) + allow(line_user_profile).to receive(:body).and_return( + { + 'displayName': 'LINE Test', + 'userId': 'U4af4980629', + 'pictureUrl': 'https://test.com' + }.to_json + ) + + # Create a contact and an unresolved conversation + described_class.new(inbox: line_channel.inbox, params: params).perform + + # Send a new message + new_params = params.deep_dup + new_params[:events][0][:message][:id] = '325709' + new_params[:events][0][:message][:text] = 'Second message' + + described_class.new(inbox: line_channel.inbox, params: new_params).perform + + # Should use the same conversation + expect(line_channel.inbox.conversations.count).to eq(1) + expect(line_channel.inbox.conversations.last.messages.count).to eq(2) + expect(line_channel.inbox.conversations.last.messages.last.content).to eq('Second message') + end + end + + context 'when lock_to_single_conversation is true' do + before do + line_channel.inbox.update(lock_to_single_conversation: true) + end + + it 'uses the existing conversation even when it is resolved' do + line_bot = double + line_user_profile = double + allow(Line::Bot::Client).to receive(:new).and_return(line_bot) + allow(line_bot).to receive(:get_profile).and_return(line_user_profile) + allow(line_user_profile).to receive(:body).and_return( + { + 'displayName': 'LINE Test', + 'userId': 'U4af4980629', + 'pictureUrl': 'https://test.com' + }.to_json + ) + + # Create a contact and a resolved conversation + described_class.new(inbox: line_channel.inbox, params: params).perform + + # Mark the conversation as resolved + conversation = line_channel.inbox.conversations.last + conversation.update(status: :resolved) + + # Send a new message + new_params = params.deep_dup + new_params[:events][0][:message][:id] = '325709' + new_params[:events][0][:message][:text] = 'Second message' + + described_class.new(inbox: line_channel.inbox, params: new_params).perform + + # Should use the same conversation + expect(line_channel.inbox.conversations.count).to eq(1) + expect(line_channel.inbox.conversations.last.messages.count).to eq(2) + expect(line_channel.inbox.conversations.last.messages.last.content).to eq('Second message') + end + end end end diff --git a/spec/services/telegram/incoming_message_service_spec.rb b/spec/services/telegram/incoming_message_service_spec.rb index 528161afe..b81b18756 100644 --- a/spec/services/telegram/incoming_message_service_spec.rb +++ b/spec/services/telegram/incoming_message_service_spec.rb @@ -410,6 +410,94 @@ describe Telegram::IncomingMessageService do expect(telegram_channel.inbox.messages.first.attachments.first.file_type).to eq('contact') end end + + context 'when lock_to_single_conversation is false' do + before do + telegram_channel.inbox.update(lock_to_single_conversation: false) + end + + it 'creates a new conversation when all previous conversations are resolved' do + # Create a contact and a resolved conversation + params = { + 'update_id' => 2_342_342_343_242, + 'message' => { 'text' => 'first message' }.merge(message_params) + }.with_indifferent_access + + described_class.new(inbox: telegram_channel.inbox, params: params).perform + + # Mark the conversation as resolved + conversation = telegram_channel.inbox.conversations.last + conversation.update(status: :resolved) + + # Send a new message + new_params = { + 'update_id' => 2_342_342_343_243, + 'message' => { 'text' => 'second message' }.merge(message_params) + }.with_indifferent_access + + described_class.new(inbox: telegram_channel.inbox, params: new_params).perform + + # Should create a new conversation + expect(telegram_channel.inbox.conversations.count).to eq(2) + expect(telegram_channel.inbox.conversations.last.messages.first.content).to eq('second message') + end + + it 'uses the existing conversation when there is an unresolved conversation' do + # Create a contact and an unresolved conversation + params = { + 'update_id' => 2_342_342_343_242, + 'message' => { 'text' => 'first message' }.merge(message_params) + }.with_indifferent_access + + described_class.new(inbox: telegram_channel.inbox, params: params).perform + + # Send a new message + new_params = { + 'update_id' => 2_342_342_343_243, + 'message' => { 'text' => 'second message' }.merge(message_params) + }.with_indifferent_access + + described_class.new(inbox: telegram_channel.inbox, params: new_params).perform + + # Should use the same conversation + expect(telegram_channel.inbox.conversations.count).to eq(1) + expect(telegram_channel.inbox.conversations.last.messages.count).to eq(2) + expect(telegram_channel.inbox.conversations.last.messages.last.content).to eq('second message') + end + end + + context 'when lock_to_single_conversation is true' do + before do + telegram_channel.inbox.update(lock_to_single_conversation: true) + end + + it 'uses the existing conversation even when it is resolved' do + # Create a contact and a resolved conversation + params = { + 'update_id' => 2_342_342_343_242, + 'message' => { 'text' => 'first message' }.merge(message_params) + }.with_indifferent_access + + described_class.new(inbox: telegram_channel.inbox, params: params).perform + + # Mark the conversation as resolved + conversation = telegram_channel.inbox.conversations.last + conversation.update(status: :resolved) + + # Send a new message + new_params = { + 'update_id' => 2_342_342_343_243, + 'message' => { 'text' => 'second message' }.merge(message_params) + }.with_indifferent_access + + described_class.new(inbox: telegram_channel.inbox, params: new_params).perform + + # Should use the same conversation + expect(telegram_channel.inbox.conversations.count).to eq(1) + expect(telegram_channel.inbox.conversations.last.messages.count).to eq(2) + expect(telegram_channel.inbox.conversations.last.messages.last.content).to eq('second message') + end + end end context 'when lock to single conversation is enabled' do diff --git a/spec/services/tiktok/message_service_spec.rb b/spec/services/tiktok/message_service_spec.rb index fbef64336..ee7b113ac 100644 --- a/spec/services/tiktok/message_service_spec.rb +++ b/spec/services/tiktok/message_service_spec.rb @@ -6,8 +6,29 @@ RSpec.describe Tiktok::MessageService do 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', @@ -113,5 +134,31 @@ RSpec.describe Tiktok::MessageService do 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 diff --git a/spec/services/tiktok/read_status_service_spec.rb b/spec/services/tiktok/read_status_service_spec.rb index f0ec116ff..3c44cc738 100644 --- a/spec/services/tiktok/read_status_service_spec.rb +++ b/spec/services/tiktok/read_status_service_spec.rb @@ -31,5 +31,31 @@ RSpec.describe Tiktok::ReadStatusService do expect(Conversations::UpdateMessageStatusJob).to have_received(:perform_later).with(conversation.id, kind_of(Time)) end + + it 'updates the latest active conversation when lock_to_single_conversation is disabled' do + allow(Conversations::UpdateMessageStatusJob).to receive(:perform_later) + + inbox.update!(lock_to_single_conversation: false) + conversation.update!(status: :resolved) + active_conversation = create( + :conversation, + account: account, + inbox: inbox, + contact: contact, + contact_inbox: contact_inbox, + status: :open, + additional_attributes: { conversation_id: 'tt-conv-1' } + ) + + content = { + conversation_id: 'tt-conv-1', + read: { last_read_timestamp: 1_700_000_000_000 }, + from_user: { id: 'user-1' } + }.deep_symbolize_keys + + described_class.new(channel: channel, content: content).perform + + expect(Conversations::UpdateMessageStatusJob).to have_received(:perform_later).with(active_conversation.id, kind_of(Time)) + end end end diff --git a/spec/services/whatsapp/csat_template_service_spec.rb b/spec/services/whatsapp/csat_template_service_spec.rb index f21d87227..d7124529d 100644 --- a/spec/services/whatsapp/csat_template_service_spec.rb +++ b/spec/services/whatsapp/csat_template_service_spec.rb @@ -119,7 +119,7 @@ RSpec.describe Whatsapp::CsatTemplateService do expect(result).to eq({ name: expected_template_name, language: 'en', - category: 'MARKETING', + category: 'UTILITY', components: [ { type: 'BODY', @@ -169,7 +169,7 @@ RSpec.describe Whatsapp::CsatTemplateService do expected_body = { name: expected_template_name, language: 'en', - category: 'MARKETING', + category: 'UTILITY', components: [ { type: 'BODY',