chatwoot/spec/models/concerns/liquidable_shared.rb

require 'rails_helper'

shared_examples_for 'liqudable' do
  context 'when liquid is present in content' do
    let(:contact) { create(:contact, name: 'john', phone_number: '+912883', custom_attributes: { customer_type: 'platinum' }) }
    let(:conversation) { create(:conversation, id: 1, contact: contact, custom_attributes: { priority: 'high' }) }

    context 'when message is incoming' do
      let(:message) { build(:message, conversation: conversation, message_type: 'incoming') }

      it 'will not process liquid in content' do
        message.content = 'hey {{contact.name}} how are you?'
        message.save!
        expect(message.content).to eq 'hey {{contact.name}} how are you?'
      end
    end

    context 'when message is outgoing' do
      let(:message) { build(:message, conversation: conversation, message_type: 'outgoing') }

      it 'set replaces liquid variables in message' do
        message.content = 'hey {{contact.name}} how are you?'
        message.save!
        expect(message.content).to eq 'hey John how are you?'
      end

      it 'set replaces liquid custom attributes in message' do
        message.content = 'Are you a {{contact.custom_attribute.customer_type}} customer,
        If yes then the priority is {{conversation.custom_attribute.priority}}'
        message.save!
        expect(message.content).to eq 'Are you a platinum customer,
        If yes then the priority is high'
      end

      it 'process liquid operators like default value' do
        message.content = 'Can we send you an email at {{ contact.email | default: "default"  }} ?'
        message.save!
        expect(message.content).to eq 'Can we send you an email at default ?'
      end

      it 'return empty string when value is not available' do
        message.content = 'Can we send you an email at {{contact.email}}?'
        message.save!
        expect(message.content).to eq 'Can we send you an email at ?'
      end

      it 'will skip processing broken liquid tags' do
        message.content = 'Can we send you an email at {{contact.email}  {{hi}} ?'
        message.save!
        expect(message.content).to eq 'Can we send you an email at {{contact.email}  {{hi}} ?'
      end

      it 'will not process liquid tags in multiple code blocks' do
        message.content = 'hey {{contact.name}} how are you? ```code: {{contact.name}}``` ``` code: {{contact.name}} ``` test `{{contact.name}}`'
        message.save!
        expect(message.content).to eq 'hey John how are you? ```code: {{contact.name}}``` ``` code: {{contact.name}} ``` test `{{contact.name}}`'
      end

      it 'will not process liquid tags in single ticks' do
        message.content = 'hey {{contact.name}} how are you? ` code: {{contact.name}} ` ` code: {{contact.name}} ` test'
        message.save!
        expect(message.content).to eq 'hey John how are you? ` code: {{contact.name}} ` ` code: {{contact.name}} ` test'
      end

      it 'will not throw error for broken quotes' do
        message.content = 'hey {{contact.name}} how are you? ` code: {{contact.name}} ` ` code: {{contact.name}} test'
        message.save!
        expect(message.content).to eq 'hey John how are you? ` code: {{contact.name}} ` ` code: John test'
      end
    end
  end

  context 'when liquid is present in template_params' do
    let(:contact) do
      create(:contact, name: 'john', email: 'john@example.com', phone_number: '+912883', custom_attributes: { customer_type: 'platinum' })
    end
    let(:conversation) { create(:conversation, id: 1, contact: contact, custom_attributes: { priority: 'high' }) }

    context 'when message is outgoing with template_params' do
      let(:message) { build(:message, conversation: conversation, message_type: 'outgoing') }

      it 'replaces liquid variables in template_params body' do
        message.additional_attributes = {
          'template_params' => {
            'name' => 'greet',
            'category' => 'MARKETING',
            'language' => 'en',
            'processed_params' => {
              'body' => {
                'customer_name' => '{{contact.name}}',
                'customer_email' => '{{contact.email}}'
              }
            }
          }
        }
        message.save!

        body_params = message.additional_attributes['template_params']['processed_params']['body']
        expect(body_params['customer_name']).to eq 'John'
        expect(body_params['customer_email']).to eq 'john@example.com'
      end

      it 'replaces liquid variables in nested template_params' do
        message.additional_attributes = {
          'template_params' => {
            'name' => 'test_template',
            'processed_params' => {
              'header' => {
                'media_url' => 'https://example.com/{{contact.name}}.jpg'
              },
              'body' => {
                'customer_name' => '{{contact.name}}',
                'priority' => '{{conversation.custom_attribute.priority}}'
              },
              'footer' => {
                'company' => '{{account.name}}'
              }
            }
          }
        }
        message.save!

        processed = message.additional_attributes['template_params']['processed_params']
        expect(processed['header']['media_url']).to eq 'https://example.com/John.jpg'
        expect(processed['body']['customer_name']).to eq 'John'
        expect(processed['body']['priority']).to eq 'high'
        expect(processed['footer']['company']).to eq conversation.account.name
      end

      it 'handles arrays in template_params' do
        message.additional_attributes = {
          'template_params' => {
            'name' => 'test_template',
            'processed_params' => {
              'buttons' => [
                { 'type' => 'url', 'parameter' => 'https://example.com/{{contact.name}}' },
                { 'type' => 'text', 'parameter' => 'Hello {{contact.name}}' }
              ]
            }
          }
        }
        message.save!

        buttons = message.additional_attributes['template_params']['processed_params']['buttons']
        expect(buttons[0]['parameter']).to eq 'https://example.com/John'
        expect(buttons[1]['parameter']).to eq 'Hello John'
      end

      it 'handles custom attributes in template_params' do
        message.additional_attributes = {
          'template_params' => {
            'name' => 'test_template',
            'processed_params' => {
              'body' => {
                'customer_type' => '{{contact.custom_attribute.customer_type}}',
                'priority' => '{{conversation.custom_attribute.priority}}'
              }
            }
          }
        }
        message.save!

        body_params = message.additional_attributes['template_params']['processed_params']['body']
        expect(body_params['customer_type']).to eq 'platinum'
        expect(body_params['priority']).to eq 'high'
      end

      it 'handles missing email with default filter in template_params' do
        contact.update!(email: nil)
        message.additional_attributes = {
          'template_params' => {
            'name' => 'test_template',
            'processed_params' => {
              'body' => {
                'customer_email' => '{{ contact.email | default: "no-email@example.com" }}'
              }
            }
          }
        }
        message.save!

        body_params = message.additional_attributes['template_params']['processed_params']['body']
        expect(body_params['customer_email']).to eq 'no-email@example.com'
      end

      it 'handles broken liquid syntax in template_params gracefully' do
        message.additional_attributes = {
          'template_params' => {
            'name' => 'test_template',
            'processed_params' => {
              'body' => {
                'broken_liquid' => '{{contact.name}  {{invalid}}'
              }
            }
          }
        }
        message.save!

        body_params = message.additional_attributes['template_params']['processed_params']['body']
        expect(body_params['broken_liquid']).to eq '{{contact.name}  {{invalid}}'
      end

      it 'does not process template_params when message is incoming' do
        incoming_message = build(:message, conversation: conversation, message_type: 'incoming')
        incoming_message.additional_attributes = {
          'template_params' => {
            'name' => 'test_template',
            'processed_params' => {
              'body' => {
                'customer_name' => '{{contact.name}}'
              }
            }
          }
        }
        incoming_message.save!

        body_params = incoming_message.additional_attributes['template_params']['processed_params']['body']
        expect(body_params['customer_name']).to eq '{{contact.name}}'
      end

      it 'does not process template_params when not present' do
        message.additional_attributes = { 'other_data' => 'test' }
        expect { message.save! }.not_to raise_error
      end
    end
  end
end