docbrown/spec/models/notification_spec.rb

require "rails_helper"
require "sidekiq/testing"

RSpec.describe Notification do
  let(:user)            { create(:user) }
  let(:user2)           { create(:user) }
  let(:user3)           { create(:user) }
  let(:organization)    { create(:organization) }
  let(:article) do
    create(:article, :with_notification_subscription, user: user, page_views_count: 4000, public_reactions_count: 70)
  end
  let(:user_follows_user2) { user.follow(user2) }
  let(:comment) { create(:comment, user: user2, commentable: article) }
  let(:badge_achievement) { create(:badge_achievement) }

  it "validates a unique user_id according to the correct scope" do
    notification = create(:notification, user: user2, notifiable: article, organization: nil)

    scopes = %i[organization_id notifiable_id notifiable_type action]
    expect(notification).to validate_uniqueness_of(:user_id).scoped_to(scopes)
  end

  describe "when trying to create duplicate notifications" do
    describe "when notifiable is an Article" do
      it "doesn't allow to create duplicated article reaction notifications for a user" do
        reaction = create(:reaction, reactable: article, user: user2)

        described_class.send_reaction_notification_without_delay(reaction, article.user)
        expect(article.user.notifications.count).to eq(1)

        expect do
          described_class.send_reaction_notification_without_delay(reaction, article.user)
        end.not_to change(article.user.notifications, :count)
      end

      it "doesn't allow to create duplicated article reaction notifications for an organization" do
        article = create(:article, organization: organization)
        reaction = create(:reaction, reactable: article, user: user2)

        described_class.send_reaction_notification_without_delay(reaction, article.organization)
        expect(article.organization.notifications.count).to eq(1)

        expect do
          described_class.send_reaction_notification_without_delay(reaction, article.organization)
        end.not_to change(article.organization.notifications, :count)
      end
    end

    describe "when notifiable is a Comment" do
      it "doesn't allow to create duplicated comment reaction notifications for a user" do
        comment = create(:comment, commentable: article)
        reaction = create(:reaction, reactable: comment, user: user2)

        described_class.send_reaction_notification_without_delay(reaction, comment.user)
        expect(comment.user.notifications.count).to eq(1)

        expect do
          described_class.send_reaction_notification_without_delay(reaction, comment.user)
        end.not_to change(comment.user.notifications, :count)
      end

      it "doesn't allow to create duplicated comment reaction notifications for an organization" do
        article = create(:article, organization: organization)
        comment = create(:comment, commentable: article)
        reaction = create(:reaction, reactable: comment, user: user2)

        described_class.send_reaction_notification_without_delay(reaction, article.organization)
        expect(article.organization.notifications.count).to eq(1)

        expect do
          described_class.send_reaction_notification_without_delay(reaction, article.organization)
        end.not_to change(article.organization.notifications, :count)
      end
    end
  end

  context "when callbacks are triggered after create" do
    it "sets the notified_at column" do
      notification = create(:notification, notifiable: article, user: user2)
      expect(notification.notified_at).to be_present
    end
  end

  describe "#send_new_follower_notification" do
    context "when trying to a send notification after following a tag" do
      it "does not enqueue a notification job" do
        sidekiq_assert_no_enqueued_jobs(only: Notifications::NewFollowerWorker) do
          tag_follow = user.follow(create(:tag))
          described_class.send_new_follower_notification(tag_follow)
        end
      end
    end

    context "when trying to send a notification after following a user" do
      it "creates a notification belonging to the person being followed" do
        expect do
          sidekiq_perform_enqueued_jobs do
            described_class.send_new_follower_notification(user_follows_user2)
          end
        end.to change(user2.notifications, :count).by(1)
      end

      it "creates a notification from the follow instance" do
        sidekiq_perform_enqueued_jobs do
          described_class.send_new_follower_notification(user_follows_user2)
        end

        notification = user2.notifications.last
        notifiable_data = { notifiable_id: notification.notifiable_id, notifiable_type: notification.notifiable_type }
        follow_data = { notifiable_id: user_follows_user2.id, notifiable_type: user_follows_user2.class.name }
        expect(notifiable_data).to eq(follow_data)
      end
    end

    context "when a user follows an organization" do
      let(:user_follows_organization) { user.follow(organization) }

      it "creates a notification belonging to the organization" do
        expect do
          sidekiq_perform_enqueued_jobs do
            described_class.send_new_follower_notification(user_follows_organization)
          end
        end.to change(organization.notifications, :count).by(1)
      end

      it "does not create a notification belonging to a user" do
        sidekiq_perform_enqueued_jobs do
          described_class.send_new_follower_notification(user_follows_organization)
        end
        expect(organization.notifications.last&.user_id).to be_nil
      end

      it "creates a notification from the follow instance" do
        sidekiq_perform_enqueued_jobs do
          described_class.send_new_follower_notification(user_follows_organization)
        end

        notification = organization.notifications.last
        notifiable_data = { notifiable_id: notification.notifiable_id, notifiable_type: notification.notifiable_type }
        follow_data = {
          notifiable_id: user_follows_organization.id,
          notifiable_type: user_follows_organization.class.name
        }
        expect(notifiable_data).to eq(follow_data)
      end
    end

    context "when a user unfollows another user" do
      it "destroys the follow notification" do
        # first we follow the user
        sidekiq_perform_enqueued_jobs do
          described_class.send_new_follower_notification(user_follows_user2)
        end

        # then we stop following them
        expect do
          sidekiq_perform_enqueued_jobs do
            user_stops_following_user2 = user.stop_following(user2)
            described_class.send_new_follower_notification(user_stops_following_user2)
          end
        end.to change(user2.notifications, :count).by(-1)
      end
    end
  end

  describe "#send_new_comment_notifications_without_delay" do
    let(:comment) { create(:comment, user: user2, commentable: article) }
    let(:child_comment) { create(:comment, user: user3, commentable: article, parent: comment) }

    context "when all commenters are subscribed" do
      it "sends a notification to the author of the article" do
        expect do
          described_class.send_new_comment_notifications_without_delay(comment)
        end.to change(user.notifications, :count).by(1)
      end

      it "does not send a notification to the author of the article if the commenter is the author" do
        comment = create(:comment, user: user, commentable: article)
        expect do
          described_class.send_new_comment_notifications_without_delay(comment)
        end.not_to change(user.notifications, :count)
      end

      it "does not send a notification to the author of the comment" do
        expect do
          described_class.send_new_comment_notifications_without_delay(comment)
        end.not_to change(user2.notifications, :count)
      end

      it "sends a notification to the author of the article about the child comment" do
        expect do
          described_class.send_new_comment_notifications_without_delay(child_comment)
        end.to change(user.notifications, :count).by(1)
      end

      it "sends a notification to the organization" do
        create(:organization_membership, user: user, organization: organization)
        article.update(organization: organization)
        comment = create(:comment, user: user2, commentable: article)

        expect do
          described_class.send_new_comment_notifications_without_delay(comment)
        end.to change(organization.notifications, :count).by(1)
      end
    end

    context "when the author of the article is not subscribed" do
      before do
        article.update(receive_notifications: false)
        article.notification_subscriptions.delete_all
      end

      it "does not send a notification to the author of the article" do
        expect do
          described_class.send_new_comment_notifications_without_delay(comment)
        end.not_to change(user.notifications, :count)
      end

      it "doesn't send a notification to the author of the article about the child comment" do
        expect do
          described_class.send_new_comment_notifications_without_delay(child_comment)
        end.not_to change(user.notifications, :count)
      end
    end

    context "when the author of a comment is not subscribed" do
      before do
        comment.update(receive_notifications: false)
      end

      it "does not send a notification to the author of the comment" do
        expect do
          described_class.send_new_comment_notifications_without_delay(child_comment)
        end.not_to change(child_comment.user.notifications, :count)
      end

      it "sends a notification to the author of the article" do
        expect do
          described_class.send_new_comment_notifications_without_delay(child_comment)
        end.to change(user.notifications, :count).by(1)
      end
    end
  end

  describe "#send_reaction_notification" do
    before do
      article.update(receive_notifications: true)
      comment.update(receive_notifications: true)
    end

    context "when reactable is receiving notifications" do
      it "sends a notification to the author of a comment" do
        reaction = create(:reaction, reactable: comment, user: user)

        expect do
          sidekiq_perform_enqueued_jobs do
            described_class.send_reaction_notification(reaction, reaction.reactable.user)
          end
        end.to change(comment.user.notifications, :count).by(1)
      end

      it "sends a notification to the author of an article" do
        reaction = create(:reaction, reactable: article, user: user2)

        expect do
          sidekiq_perform_enqueued_jobs do
            described_class.send_reaction_notification(reaction, reaction.reactable.user)
          end
        end.to change(article.user.notifications, :count).by(1)
      end

      it "does not send a notification to the author of an article if the reaction owner is deleted" do
        user4 = create(:user)
        reaction = create(:reaction, reactable: article, user: user4)
        user4.destroy

        expect do
          sidekiq_perform_enqueued_jobs do
            described_class.send_reaction_notification(reaction, reaction.reactable.user)
          end
        end.not_to change(article.user.notifications, :count)
      end
    end

    context "when a reaction is destroyed" do
      let(:comment) { create(:comment, user: user2, commentable: article) }
      let!(:notification) { create(:notification, user: user, notifiable: comment, action: "Reaction") }
      let(:sibling_reaction) { create(:reaction, reactable: comment, user: user3) }

      it "destroys the notification if it exists" do
        reaction = create(:reaction, reactable: comment, user: user)
        reaction.destroy
        described_class.send_reaction_notification_without_delay(reaction, article.user)
        expect(described_class.exists?(id: notification.id)).to be(false)
      end

      it "keeps the notification if siblings exist" do
        reaction = create(:reaction, reactable: comment, user: user)
        sibling_reaction # to create it
        reaction.destroy
        described_class.send_reaction_notification_without_delay(reaction, article.user)
        notification.reload
        expect(notification).to be_persisted
      end

      it "doesn't keep data of the destroyed reaction in the notification" do
        reaction = create(:reaction, reactable: comment, user: user)
        sibling_reaction # to create it
        reaction.destroy
        described_class.send_reaction_notification_without_delay(reaction, article.user)
        notification.reload
        expect(notification.json_data["reaction"]["aggregated_siblings"].map { |s| s["user"]["id"] }).to eq([user3.id])
        # not the user of the destroyed reaction!
        expect(notification.json_data["user"]["id"]).to eq(user3.id)
      end

      it "creates and destroys the notification properly" do
        reaction = create(:reaction, user: user2, reactable: article, category: "like")

        expect do
          sidekiq_perform_enqueued_jobs do
            described_class.send_reaction_notification(reaction, reaction.reactable.user)
          end
        end.to change(user.notifications, :count).by(1)

        reaction.destroy!

        expect do
          sidekiq_perform_enqueued_jobs do
            described_class.send_reaction_notification(reaction, reaction.reactable.user)
          end
        end.to change(user.notifications, :count).by(-1)
      end
    end

    context "when reactable is not receiving notifications" do
      it "does not send a notification to the author of a comment" do
        comment = create(:comment, user: user2, commentable: article)
        comment.update(receive_notifications: false)
        reaction = create(:reaction, reactable: comment, user: user)

        expect do
          described_class.send_reaction_notification_without_delay(reaction, reaction.reactable.user)
        end.not_to change(user.notifications, :count)
      end

      it "does send a notification to the author of an article" do
        article.update(receive_notifications: false)
        reaction = create(:reaction, reactable: article, user: user2)

        expect do
          described_class.send_reaction_notification_without_delay(reaction, reaction.reactable.user)
        end.to change(user.notifications, :count).by(1)
      end
    end

    context "when the reactable is an organization's article" do
      before do
        create(:organization_membership, user: user, organization: organization, type_of_user: "admin")
        article.update(organization: organization)
      end

      it "creates a notification with the organization's ID" do
        reaction = create(:reaction, reactable: article, user: user2)
        expect do
          described_class.send_reaction_notification_without_delay(reaction, reaction.reactable.organization)
        end.to change(organization.notifications, :count).by(1)
      end
    end

    context "when dealing with positive and negative reactions" do
      it "creates a notification for a positive reaction" do
        reaction = create(:reaction, reactable: article, user: user2, category: "like")

        expect do
          sidekiq_perform_enqueued_jobs do
            described_class.send_reaction_notification(reaction, reaction.reactable.user)
          end
        end.to change(article.notifications, :count).by(1)
      end

      it "does not create a notification for a negative reaction" do
        user2.add_role(:trusted)
        reaction = create(:reaction, reactable: article, user: user2, category: "vomit")

        expect do
          sidekiq_perform_enqueued_jobs do
            described_class.send_reaction_notification(reaction, reaction.reactable.user)
          end
        end.not_to change(article.notifications, :count)
      end
    end
  end

  describe "send_to_mentioned_users_and_followers" do
    let!(:mention_markdown) { "Hello there, @#{user2.username}!" }

    context "when the notifiable is an article from a user" do
      before do
        article.update!(body_markdown: mention_markdown)
        user2.follow(user)
      end

      it "sends a single notification to mentioned user", :aggregate_failures do
        expect do
          sidekiq_perform_enqueued_jobs do
            described_class.send_to_mentioned_users_and_followers(article)
          end
        end.to change(user2.notifications, :count).from(0).to(1)
        expect(user2.notifications.first.notifiable_type).to eq("Mention")
      end

      it "sends a notification to the organization's followers (who were not mentioned)", :aggregate_failures do
        user3.follow(user)

        expect do
          sidekiq_perform_enqueued_jobs do
            described_class.send_to_mentioned_users_and_followers(article)
          end
        end.to change(user3.notifications, :count).from(0).to(1)
        expect(user3.notifications.first.notifiable_type).to eq("Article")
      end
    end

    context "when the notifiable is an article from an organization" do
      let(:org_article) { create(:article, organization: organization, user: user) }

      before do
        org_article.update!(body_markdown: mention_markdown)
        user2.follow(user)
      end

      it "sends a single notification to mentioned user", :aggregate_failures do
        expect do
          sidekiq_perform_enqueued_jobs do
            described_class.send_to_mentioned_users_and_followers(org_article)
          end
        end.to change(user2.notifications, :count).from(0).to(1)
        expect(user2.notifications.first.notifiable_type).to eq("Mention")
      end

      it "sends a notification to the organization's followers (who were not mentioned)", :aggregate_failures do
        user3.follow(organization)

        expect do
          sidekiq_perform_enqueued_jobs do
            described_class.send_to_mentioned_users_and_followers(org_article)
          end
        end.to change(user3.notifications, :count).from(0).to(1)
        expect(user3.notifications.first.notifiable_type).to eq("Article")
      end
    end
  end

  describe "#send_to_followers" do
    context "when the notifiable is an article from a user" do
      it "sends a notification to the author's followers" do
        user2.follow(user)

        expect do
          sidekiq_perform_enqueued_jobs do
            described_class.send_to_followers(article, "Published")
          end
        end.to change(user2.notifications, :count).by(1)
      end
    end

    context "when the notifiable is an article from an organization" do
      let(:org_article) { create(:article, organization: organization, user: user) }

      it "sends a notification to author's followers" do
        user2.follow(user)

        expect do
          sidekiq_perform_enqueued_jobs do
            described_class.send_to_followers(org_article, "Published")
          end
        end.to change(user2.notifications, :count).by(1)
      end

      it "sends a notification to the organization's followers" do
        user3.follow(organization)

        expect do
          sidekiq_perform_enqueued_jobs do
            described_class.send_to_followers(org_article, "Published")
          end
        end.to change(user3.notifications, :count).by(1)
      end
    end
  end

  describe "#update_notifications" do
    context "when there are article notifications to update" do
      before do
        user2.follow(user)
        sidekiq_perform_enqueued_jobs { described_class.send_to_followers(article, "Published") }
      end

      it "updates the notification with the new article title" do
        new_title = "hehehe hohoho!"
        new_body_markdown = article.body_markdown.gsub(article.title, new_title)
        article.update(title: new_title, body_markdown: new_body_markdown)
        described_class.update_notifications(article, "Published")

        sidekiq_perform_enqueued_jobs

        expected_notification_article_title = user2.notifications.last.json_data["article"]["title"]
        expect(expected_notification_article_title).to eq(new_title)
      end

      it "adds organization data when the article now belongs to an org" do
        article.update(organization_id: organization.id)
        described_class.update_notifications(article, "Published")

        sidekiq_perform_enqueued_jobs

        expected_notification_organization_id = described_class.last.json_data["organization"]["id"]
        expect(expected_notification_organization_id).to eq(organization.id)
      end
    end
  end

  describe "#aggregated?" do
    let(:notification) { build(:notification) }

    it "returns true if a notification's action is 'Reaction'" do
      notification.action = "Reaction"
      expect(notification.aggregated?).to be(true)
    end

    it "returns true if a notification's action is 'Follow'" do
      notification.action = "Follow"
      expect(notification.aggregated?).to be(true)
    end

    it "returns false if a notification's action is not 'Reaction' or 'Follow'" do
      notification.action = "Published"
      expect(notification.aggregated?).to be(false)
    end
  end

  describe "#send_new_badge_achievement_notification" do
    it "enqueues a new badge achievement job" do
      sidekiq_assert_enqueued_with(job: Notifications::NewBadgeAchievementWorker, args: [badge_achievement.id]) do
        described_class.send_new_badge_achievement_notification(badge_achievement)
      end
    end
  end

  describe "#remove_all" do
    it "removes all mention related notifications" do
      mention = create(:mention, user: user, mentionable: comment)
      create(:notification, user: mention.user, notifiable: mention)

      expect do
        sidekiq_perform_enqueued_jobs do
          described_class.remove_all(notifiable_ids: mention.id, notifiable_type: "Mention")
        end
      end.to change(user.notifications, :count).by(-1)
    end
  end

  describe "#fast_destroy_old_notifications" do
    it "bulk deletes notifications older than given timestamp" do
      allow(BulkSqlDelete).to receive(:delete_in_batches)
      described_class.fast_destroy_old_notifications("a_time")
      expect(BulkSqlDelete).to have_received(:delete_in_batches).with(a_string_including("< 'a_time'"))
    end
  end
end