DEV: UserCommScreener fine-grained actor improvements (#17737)

This commit introduces several fine-grained methods
to UserCommScreener which can be used to show the actor
who they are ignoring/muting/blocking DMs from in order
to prevent them initiating conversation with those users
or to display relevant information in the UI to the
actor.

This will be used in a companion PR in discourse-chat,
and is a follow up to 74584ff3ca

Co-authored-by: Alan Guo Xiang Tan <gxtan1990@gmail.com>
Co-authored-by: Osama Sayegh <asooomaasoooma90@gmail.com>

spec/lib/user_comm_screener_spec.rb

@@ -10,6 +10,7 @@ RSpec.describe UserCommScreener do
   end
   fab!(:target_user4) { Fabricate(:user, username: "janescreen") }
   fab!(:target_user5) { Fabricate(:user, username: "maryscreen") }
+  fab!(:other_user) { Fabricate(:user) }
 
   subject do
     described_class.new(
@@ -70,6 +71,10 @@ RSpec.describe UserCommScreener do
       it "returns false for a user neither ignoring or muting the actor" do
         expect(subject.ignoring_or_muting_actor?(target_user3.id)).to eq(false)
       end
+
+      it "raises a NotFound error if the user_id passed in is not part of the target users" do
+        expect { subject.ignoring_or_muting_actor?(other_user.id) }.to raise_error(Discourse::NotFound)
+      end
     end
 
     describe "#disallowing_pms_from_actor?" do
@@ -99,6 +104,10 @@ RSpec.describe UserCommScreener do
       it "returns true for a user not disallowing PMs but still muting" do
         expect(subject.disallowing_pms_from_actor?(target_user2.id)).to eq(true)
       end
+
+      it "raises a NotFound error if the user_id passed in is not part of the target users" do
+        expect { subject.disallowing_pms_from_actor?(other_user.id) }.to raise_error(Discourse::NotFound)
+      end
     end
   end
 
@@ -137,6 +146,10 @@ RSpec.describe UserCommScreener do
       it "returns false for a user neither ignoring or muting the actor" do
         expect(subject.ignoring_or_muting_actor?(target_user3.id)).to eq(false)
       end
+
+      it "raises a NotFound error if the user_id passed in is not part of the target users" do
+        expect { subject.ignoring_or_muting_actor?(other_user.id) }.to raise_error(Discourse::NotFound)
+      end
     end
 
     describe "#disallowing_pms_from_actor?" do
@@ -160,6 +173,77 @@ RSpec.describe UserCommScreener do
       it "returns false for a user not disallowing PMs but still muting" do
         expect(subject.disallowing_pms_from_actor?(target_user2.id)).to eq(false)
       end
+
+      it "raises a NotFound error if the user_id passed in is not part of the target users" do
+        expect { subject.disallowing_pms_from_actor?(other_user.id) }.to raise_error(Discourse::NotFound)
+      end
+    end
+  end
+
+  describe "actor preferences" do
+    fab!(:acting_user) { Fabricate(:user) }
+    fab!(:muted_user) { Fabricate(:muted_user, user: acting_user, muted_user: target_user1) }
+    fab!(:ignored_user) { Fabricate(:ignored_user, user: acting_user, ignored_user: target_user2, expiring_at: 2.days.from_now) }
+    fab!(:allowed_pm_user1) { AllowedPmUser.create!(user: acting_user, allowed_pm_user: target_user1) }
+    fab!(:allowed_pm_user2) { AllowedPmUser.create!(user: acting_user, allowed_pm_user: target_user2) }
+    fab!(:allowed_pm_user3) { AllowedPmUser.create!(user: acting_user, allowed_pm_user: target_user4) }
+
+    describe "#actor_preventing_communication" do
+      it "returns the user_ids of the users the actor is ignoring, muting, or disallowing PMs from" do
+        acting_user.user_option.update!(enable_allowed_pm_users: true)
+        expect(subject.actor_preventing_communication).to match_array([
+          target_user1.id, target_user2.id, target_user3.id, target_user5.id
+        ])
+      end
+    end
+
+    describe "#actor_allowing_communication" do
+      it "returns the user_ids of the users who the actor is not ignoring, muting, or disallowing PMs from" do
+        acting_user.user_option.update!(enable_allowed_pm_users: true)
+        expect(subject.actor_allowing_communication).to match_array([target_user4.id])
+      end
+    end
+
+    describe "#actor_ignoring?" do
+      it "returns true for user ids that the actor is ignoring" do
+        expect(subject.actor_ignoring?(target_user2.id)).to eq(true)
+        expect(subject.actor_ignoring?(target_user4.id)).to eq(false)
+      end
+
+      it "raises a NotFound error if the user_id passed in is not part of the target users" do
+        expect { subject.actor_ignoring?(other_user.id) }.to raise_error(Discourse::NotFound)
+      end
+    end
+
+    describe "#actor_muting?" do
+      it "returns true for user ids that the actor is muting" do
+        expect(subject.actor_muting?(target_user1.id)).to eq(true)
+        expect(subject.actor_muting?(target_user2.id)).to eq(false)
+      end
+
+      it "raises a NotFound error if the user_id passed in is not part of the target users" do
+        expect { subject.actor_muting?(other_user.id) }.to raise_error(Discourse::NotFound)
+      end
+    end
+
+    describe "#actor_disallowing_pms?" do
+      it "returns true for user ids that the actor is not explicitly allowing PMs from" do
+        acting_user.user_option.update!(enable_allowed_pm_users: true)
+        expect(subject.actor_disallowing_pms?(target_user3.id)).to eq(true)
+        expect(subject.actor_disallowing_pms?(target_user1.id)).to eq(false)
+      end
+
+      it "raises a NotFound error if the user_id passed in is not part of the target users" do
+        expect { subject.actor_disallowing_pms?(other_user.id) }.to raise_error(Discourse::NotFound)
+      end
+    end
+
+    describe "#actor_disallowing_all_pms?" do
+      it "returns true if the acting user has disabled private messages altogether" do
+        expect(subject.actor_disallowing_all_pms?).to eq(false)
+        acting_user.user_option.update!(allow_private_messages: false)
+        expect(subject.actor_disallowing_all_pms?).to eq(true)
+      end
     end
   end
 end