Skip to content

Open-source live-chat, email support, omni-channel desk. An alternative to Intercom, Zendesk, Salesforce Service Cloud etc. 🔥💬

11.4 KB
Raw Blame
require 'rails_helper'
RSpec.describe MailPresenter do
  include ActionMailbox::TestHelper

  describe 'parsed mail decorator' do
    let(:mail) { create_inbound_email_from_fixture('welcome.eml').mail }
    let(:multiple_in_reply_to_mail) { create_inbound_email_from_fixture('multiple_in_reply_to.eml').mail }
    let(:mail_without_in_reply_to) { create_inbound_email_from_fixture('reply_cc.eml').mail }
    let(:html_mail) { create_inbound_email_from_fixture('welcome_html.eml').mail }
    let(:ascii_mail) { create_inbound_email_from_fixture('non_utf_encoded_mail.eml').mail }
    let(:decorated_mail) { described_class.new(mail) }

    let(:mail_with_no_subject) { create_inbound_email_from_fixture('mail_with_no_subject.eml').mail }
    let(:decorated_mail_with_no_subject) { described_class.new(mail_with_no_subject) }

    it 'give default subject line if mail subject is empty' do
      expect(decorated_mail_with_no_subject.subject).to eq('')
    end

    it 'give utf8 encoded content' do
      expect(decorated_mail.subject).to eq("Discussion: Let's debate these attachments")
      expect(decorated_mail.text_content[:full]).to eq("Let's talk about these images:\n\n")
    end

    it 'give decoded blob attachments' do
      decorated_mail.attachments.each do |attachment|
        expect(attachment.keys).to eq([:original, :blob])
        expect(attachment[:blob].class.name).to eq('ActiveStorage::Blob')
      end
    end

    it 'give number of attachments of the mail' do
      expect(decorated_mail.number_of_attachments).to eq(2)
    end

    it 'give the serialized data of the email to be stored in the message' do
      data = decorated_mail.serialized_data
      expect(data.keys).to eq([
                                :bcc,
                                :cc,
                                :content_type,
                                :date,
                                :from,
                                :headers,
                                :html_content,
                                :in_reply_to,
                                :message_id,
                                :multipart,
                                :number_of_attachments,
                                :references,
                                :subject,
                                :text_content,
                                :to,
                                :auto_reply
                              ])
      expect(data[:content_type]).to include('multipart/alternative')
      expect(data[:date].to_s).to eq('2020-04-20T04:20:20-04:00')
      expect(data[:message_id]).to eq(mail.message_id)
      expect(data[:multipart]).to be(true)
      expect(data[:subject]).to eq(decorated_mail.subject)
      expect(data[:auto_reply]).to eq(decorated_mail.auto_reply?)
    end

    it 'includes forwarded headers in serialized_data' do
      mail_with_headers = Mail.new do
        from 'Sender <[email protected]>'
        to 'Inbox <[email protected]>'
        subject :header
        body 'Hi'
        header['X-Original-From'] = 'Original <[email protected]>'
        header['X-Original-Sender'] = '[email protected]'
        header['X-Forwarded-For'] = '[email protected]'
      end

      data = described_class.new(mail_with_headers).serialized_data

      expect(data[:headers]).to eq(
        'x-original-from' => 'Original <[email protected]>',
        'x-original-sender' => '[email protected]',
        'x-forwarded-for' => '[email protected]'
      )
    end

    it 'returns nil headers when forwarding headers are missing' do
      mail_without_headers = Mail.new do
        from 'Sender <[email protected]>'
        to 'Inbox <[email protected]>'
        subject :header
        body 'Hi'
      end

      data = described_class.new(mail_without_headers).serialized_data

      expect(data[:headers]).to be_nil
    end

    it 'give email from in downcased format' do
      expect(decorated_mail.from.first.eql?(mail.from.first.downcase)).to be true
    end

    describe '#from' do
      let(:mail_with_sender) { Mail.new { from 'Sender <[email protected]>' } }

      it 'drops blank reply-to entries and keeps valid reply-to addresses' do
        allow(mail_with_sender).to receive(:reply_to).and_return([nil, '', '[email protected]'])

        expect(described_class.new(mail_with_sender).from).to eq(['[email protected]'])
      end

      it 'falls back to from when reply-to has no usable addresses' do
        allow(mail_with_sender).to receive(:reply_to).and_return([nil, ''])

        expect(described_class.new(mail_with_sender).from).to eq(['[email protected]'])
      end

      it 'drops blank entries from the from list' do
        allow(mail_with_sender).to receive(:reply_to).and_return(nil)
        allow(mail_with_sender).to receive(:from).and_return([nil, '', '[email protected]'])

        expect(described_class.new(mail_with_sender).from).to eq(['[email protected]'])
      end

      it 'returns no addresses when both lists lack a sender' do
        empty_mail = Mail.new
        allow(empty_mail).to receive(:reply_to).and_return([nil, ''])
        allow(empty_mail).to receive(:from).and_return([nil, ''])

        expect(described_class.new(empty_mail).from).to eq([])
      end
    end

    it 'parse html content in the mail' do
      decorated_html_mail = described_class.new(html_mail)
      expect(decorated_html_mail.subject).to eq('Fwd: How good are you in English? How did you improve your English?')
      expect(decorated_html_mail.text_content[:reply][0..70]).to eq(
        "I'm learning English as a first language for the past 13 years, but to "
      )
    end

    it 'encodes email to UTF-8' do
      decorated_html_mail = described_class.new(ascii_mail)
      expect(decorated_html_mail.subject).to eq('أهلين عميلنا الكريم ')
      expect(decorated_html_mail.text_content[:reply][0..70]).to eq(
        'أنظروا، أنا أحتاجها فقط لتقوم بالتدقيق في مقالتي الشخصية'
      )
    end

    describe '#in_reply_to' do
      context 'when "in_reply_to" is an array' do
        it 'returns the first value from the array' do
          mail_presenter = described_class.new(multiple_in_reply_to_mail)
          expect(mail_presenter.in_reply_to).to eq('[email protected]')
        end
      end

      context 'when "in_reply_to" is not an array' do
        it 'returns the value as is' do
          mail_presenter = described_class.new(mail)
          expect(mail_presenter.in_reply_to).to eq('[email protected]')
        end
      end

      context 'when "in_reply_to" is blank' do
        it 'returns nil' do
          mail_presenter = described_class.new(mail_without_in_reply_to)
          expect(mail_presenter.in_reply_to).to be_nil
        end
      end
    end

    describe '#references' do
      let(:references_mail) { create_inbound_email_from_fixture('references.eml').mail }
      let(:mail_presenter_with_references) { described_class.new(references_mail) }

      context 'when mail has references' do
        it 'returns an array of reference IDs' do
          expect(mail_presenter_with_references.references).to eq(['[email protected]', 'test-reference-id'])
        end
      end

      context 'when mail has no references' do
        it 'returns an empty array' do
          mail_presenter = described_class.new(mail_without_in_reply_to)
          expect(mail_presenter.references).to eq([])
        end
      end

      context 'when references are included in serialized_data' do
        it 'includes references in the serialized data' do
          data = mail_presenter_with_references.serialized_data
          expect(data[:references]).to eq(['[email protected]', 'test-reference-id'])
        end
      end
    end

    describe 'auto_reply?' do
      let(:auto_reply_mail) { create_inbound_email_from_fixture('auto_reply.eml').mail }
      let(:auto_reply_with_auto_submitted_mail) { create_inbound_email_from_fixture('auto_reply_with_auto_submitted.eml').mail }
      let(:decorated_auto_reply_mail) { described_class.new(auto_reply_mail) }
      let(:decorated_auto_reply_with_auto_submitted_mail) { described_class.new(auto_reply_with_auto_submitted_mail) }

      it 'returns true for auto-reply emails' do
        expect(decorated_auto_reply_mail.auto_reply?).to be true
        expect(decorated_auto_reply_with_auto_submitted_mail.auto_reply?).to be true
      end

      it 'includes auto_reply status in serialized_data' do
        expect(decorated_auto_reply_mail.serialized_data[:auto_reply]).to be true
        expect(decorated_mail.serialized_data[:auto_reply]).to be_falsey
      end
    end

    describe 'malformed sender headers' do
      let(:mail_with_malformed_from) do
        Mail.new do
          header['From'] = 'Kevin McDonald <[email protected]'
          to 'Inbox <[email protected]>'
          subject :header
          body 'Hi'
        end
      end

      let(:mail_with_malformed_reply_to) do
        Mail.new do
          from 'Sender <[email protected]>'
          to 'Inbox <[email protected]>'
          subject :header
          body 'Hi'
          header['Reply-To'] = 'Reply User <[email protected]'
        end
      end

      let(:mail_with_original_sender_header) do
        Mail.new do
          from 'Sender <[email protected]>'
          to 'Inbox <[email protected]>'
          subject :header
          body 'Hi'
          header['Reply-To'] = 'Reply User <[email protected]'
          header['X-Original-Sender'] = 'Forwarded Sender <[email protected]>'
        end
      end

      let(:mail_with_invalid_original_sender_header) do
        Mail.new do
          from 'Sender <[email protected]>'
          to 'Inbox <[email protected]>'
          subject :header
          body 'Hi'
          header['Reply-To'] = 'Reply User <[email protected]'
          header['X-Original-Sender'] = 'not an email address'
        end
      end

      it 'returns nil sender values when from header is malformed' do
        presenter = described_class.new(mail_with_malformed_from)

        expect(presenter.original_sender).to be_nil
        expect(presenter.sender_name).to be_nil
        expect(presenter.notification_email_from_chatwoot?).to be(false)
      end

      it 'falls back to from header when reply_to is malformed' do
        presenter = described_class.new(mail_with_malformed_reply_to)
        expect(presenter.original_sender).to eq('[email protected]')
      end

      it 'uses parsed X-Original-Sender value when available' do
        presenter = described_class.new(mail_with_original_sender_header)
        expect(presenter.original_sender).to eq('[email protected]')
      end

      it 'falls back to from when X-Original-Sender is invalid' do
        presenter = described_class.new(mail_with_invalid_original_sender_header)
        expect(presenter.original_sender).to eq('[email protected]')
      end

      it 'matches notification sender emails case-insensitively' do
        mail_with_uppercase_sender = Mail.new do
          from 'Chatwoot <[email protected]>'
          to 'Inbox <[email protected]>'
          subject :header
          body 'Hi'
        end

        with_modified_env MAILER_SENDER_EMAIL: 'Chatwoot <[email protected]>' do
          presenter = described_class.new(mail_with_uppercase_sender)
          expect(presenter.notification_email_from_chatwoot?).to be(true)
        end
      end
    end
  end
end