discourse/spec/models/email_log_spec.rb

require 'rails_helper'

describe EmailLog do

  it { is_expected.to belong_to :user }
  it { is_expected.to validate_presence_of :to_address }
  it { is_expected.to validate_presence_of :email_type }

  let(:user) { Fabricate(:user) }

  context 'unique email per post' do
    it 'only allows through one email per post' do
      post = Fabricate(:post)
      user = post.user

      # skipped emails do not matter
      Fabricate(:email_log, user: user, email_type: 'blah', post_id: post.id, to_address: user.email, user_id: user.id, skipped: true)

      ran = EmailLog.unique_email_per_post(post, user) do
        true
      end

      expect(ran).to eq(true)

      Fabricate(:email_log, user: user, email_type: 'blah', post_id: post.id, to_address: user.email, user_id: user.id)

      ran = EmailLog.unique_email_per_post(post, user) do
        true
      end

      expect(ran).to be_falsy

    end
  end

  context 'after_create' do
    context 'with user' do
      it 'updates the last_emailed_at value for the user' do
        expect {
          user.email_logs.create(email_type: 'blah', to_address: user.email)
          user.reload
        }.to change(user, :last_emailed_at)
      end

      it "doesn't update last_emailed_at if skipped is true" do
        expect {
          Fabricate(:email_log, user: user, email_type: 'blah', to_address: user.email, skipped: true)
          user.reload
        }.to_not change { user.last_emailed_at }
      end
    end
  end

  describe '#reached_max_emails?' do
    before do
      SiteSetting.max_emails_per_day_per_user = 2
      Fabricate(:email_log, user: user, email_type: 'blah', to_address: user.email, user_id: user.id, skipped: true)
      Fabricate(:email_log, user: user, email_type: 'blah', to_address: user.email, user_id: user.id)
      Fabricate(:email_log, user: user, email_type: 'blah', to_address: user.email, user_id: user.id, created_at: 3.days.ago)
    end

    it "tracks when max emails are reached" do
      expect(EmailLog.reached_max_emails?(user)).to eq(false)

      Fabricate(:email_log, user: user, email_type: 'blah', to_address: user.email, user_id: user.id)
      expect(EmailLog.reached_max_emails?(user)).to eq(true)
    end

    it "returns false for critical email" do
      Fabricate(:email_log, user: user, email_type: 'blah', to_address: user.email, user_id: user.id)
      expect(EmailLog.reached_max_emails?(user, 'forgot_password')).to eq(false)
      expect(EmailLog.reached_max_emails?(user, 'confirm_new_email')).to eq(false)
    end
  end

  describe '#count_per_day' do
    it "counts sent emails" do
      Fabricate(:email_log, user: user, email_type: 'blah', to_address: user.email)
      Fabricate(:email_log, user: user, email_type: 'blah', to_address: user.email, skipped: true)
      expect(described_class.count_per_day(1.day.ago, Time.now).first[1]).to eq 1
    end
  end

  describe ".last_sent_email_address" do
    context "when user's email exist in the logs" do
      before do
        user.email_logs.create(email_type: 'signup', to_address: user.email)
        user.email_logs.create(email_type: 'blah', to_address: user.email)
        user.reload
      end

      it "the user's last email from the log" do
        expect(user.email_logs.last_sent_email_address).to eq(user.email)
      end
    end

    context "when user's email does not exist email logs" do
      it "returns nil" do
        expect(user.email_logs.last_sent_email_address).to be_nil
      end
    end
  end

  %w{reply_key bounce_key}.each do |key|
    describe "##{key}" do
      it "should format the #{key} correctly" do
        hex = SecureRandom.hex
        email_log = Fabricate(:email_log, user: user, "#{key}": hex)

        raw_key = EmailLog.where(id: email_log.id)
          .pluck("#{key}::text")
          .first

        expect(raw_key).to_not eq(hex)
        expect(raw_key.delete('-')).to eq(hex)
        expect(EmailLog.find(email_log.id).send(key)).to eq(hex)
      end
    end
  end
end