DEV: Update discourse-presence plugin to use new PresenceChannel system (#14519)

This removes all custom controllers and redis/messagebus logic from discourse-presence, and replaces it with core's new PresenceChannel system.

All functionality should be retained. This implementation should scale much better to large numbers of users, reduce the number of HTTP requests made by clients, and reduce the volume of messages on the MessageBus.

For more information on PresenceChannel, see 31db8352

plugins/discourse-presence/spec/integration/presence_spec.rb

@@ -0,0 +1,193 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+describe "discourse-presence" do
+  describe 'PresenceChannel configuration' do
+    fab!(:user) { Fabricate(:user) }
+    fab!(:user2) { Fabricate(:user) }
+    fab!(:admin) { Fabricate(:admin) }
+
+    fab!(:group) do
+      group = Fabricate(:group)
+      group.add(user)
+      group
+    end
+
+    fab!(:category) { Fabricate(:private_category, group: group) }
+    fab!(:private_topic) { Fabricate(:topic, category: category) }
+    fab!(:public_topic) { Fabricate(:topic, first_post: Fabricate(:post)) }
+
+    fab!(:private_message) do
+      Fabricate(:private_message_topic,
+        allowed_groups: [group]
+      )
+    end
+
+    before { PresenceChannel.clear_all! }
+
+    it 'handles invalid topic IDs' do
+      expect do
+        PresenceChannel.new('/discourse-presence/reply/-999').config
+      end.to raise_error(PresenceChannel::NotFound)
+
+      expect do
+        PresenceChannel.new('/discourse-presence/reply/blah').config
+      end.to raise_error(PresenceChannel::NotFound)
+    end
+
+    it 'handles deleted topics' do
+      public_topic.trash!
+
+      expect do
+        PresenceChannel.new("/discourse-presence/reply/#{public_topic.id}").config
+      end.to raise_error(PresenceChannel::NotFound)
+
+      expect do
+        PresenceChannel.new("/discourse-presence/whisper/#{public_topic.id}").config
+      end.to raise_error(PresenceChannel::NotFound)
+
+      expect do
+        PresenceChannel.new("/discourse-presence/edit/#{public_topic.first_post.id}").config
+      end.to raise_error(PresenceChannel::NotFound)
+    end
+
+    it 'handles secure category permissions for reply' do
+      c = PresenceChannel.new("/discourse-presence/reply/#{private_topic.id}")
+      expect(c.can_view?(user_id: user.id)).to eq(true)
+      expect(c.can_enter?(user_id: user.id)).to eq(true)
+
+      group.remove(user)
+
+      c = PresenceChannel.new("/discourse-presence/reply/#{private_topic.id}", use_cache: false)
+      expect(c.can_view?(user_id: user.id)).to eq(false)
+      expect(c.can_enter?(user_id: user.id)).to eq(false)
+    end
+
+    it 'handles secure category permissions for edit' do
+      p = Fabricate(:post, topic: private_topic, user: private_topic.user)
+      c = PresenceChannel.new("/discourse-presence/edit/#{p.id}")
+      expect(c.can_view?(user_id: user.id)).to eq(false)
+      expect(c.can_view?(user_id: private_topic.user.id)).to eq(true)
+    end
+
+    it 'handles category moderators for edit' do
+      SiteSetting.trusted_users_can_edit_others = false
+      p = Fabricate(:post, topic: private_topic, user: private_topic.user)
+
+      c = PresenceChannel.new("/discourse-presence/edit/#{p.id}")
+      expect(c.config.allowed_group_ids).to contain_exactly(Group::AUTO_GROUPS[:staff])
+
+      SiteSetting.enable_category_group_moderation = true
+      category.update(reviewable_by_group_id: group.id)
+
+      c = PresenceChannel.new("/discourse-presence/edit/#{p.id}", use_cache: false)
+      expect(c.config.allowed_group_ids).to contain_exactly(Group::AUTO_GROUPS[:staff], group.id)
+    end
+
+    it 'handles permissions for a public topic' do
+      c = PresenceChannel.new("/discourse-presence/reply/#{public_topic.id}")
+      expect(c.config.public).to eq(false)
+      expect(c.config.allowed_group_ids).to contain_exactly(::Group::AUTO_GROUPS[:trust_level_0])
+    end
+
+    it 'handles permissions for secure category topics' do
+      c = PresenceChannel.new("/discourse-presence/reply/#{private_topic.id}")
+      expect(c.config.public).to eq(false)
+      expect(c.config.allowed_group_ids).to contain_exactly(group.id)
+      expect(c.config.allowed_user_ids).to eq(nil)
+    end
+
+    it 'handles permissions for private messsages' do
+      c = PresenceChannel.new("/discourse-presence/reply/#{private_message.id}")
+      expect(c.config.public).to eq(false)
+      expect(c.config.allowed_group_ids).to contain_exactly(group.id, Group::AUTO_GROUPS[:staff])
+      expect(c.config.allowed_user_ids).to contain_exactly(
+        *private_message.topic_allowed_users.pluck(:user_id)
+      )
+    end
+
+    it "handles permissions for whispers" do
+      c = PresenceChannel.new("/discourse-presence/whisper/#{public_topic.id}")
+      expect(c.config.public).to eq(false)
+      expect(c.config.allowed_group_ids).to contain_exactly(Group::AUTO_GROUPS[:staff])
+      expect(c.config.allowed_user_ids).to eq(nil)
+    end
+
+    it 'only allows staff when editing whispers' do
+      p = Fabricate(:whisper, topic: public_topic, user: admin)
+      c = PresenceChannel.new("/discourse-presence/edit/#{p.id}")
+      expect(c.config.public).to eq(false)
+      expect(c.config.allowed_group_ids).to contain_exactly(Group::AUTO_GROUPS[:staff])
+      expect(c.config.allowed_user_ids).to eq(nil)
+    end
+
+    it 'only allows staff when editing a locked post' do
+      p = Fabricate(:post, topic: public_topic, user: admin, locked_by_id: Discourse.system_user.id)
+      c = PresenceChannel.new("/discourse-presence/edit/#{p.id}")
+      expect(c.config.public).to eq(false)
+      expect(c.config.allowed_group_ids).to contain_exactly(Group::AUTO_GROUPS[:staff])
+      expect(c.config.allowed_user_ids).to eq(nil)
+    end
+
+    it "allows author, staff, TL4 when editing a public post" do
+      p = Fabricate(:post, topic: public_topic, user: user)
+      c = PresenceChannel.new("/discourse-presence/edit/#{p.id}")
+      expect(c.config.public).to eq(false)
+      expect(c.config.allowed_group_ids).to contain_exactly(
+        Group::AUTO_GROUPS[:trust_level_4],
+        Group::AUTO_GROUPS[:staff]
+      )
+      expect(c.config.allowed_user_ids).to contain_exactly(user.id)
+    end
+
+    it "allows only author and staff when editing a public post with tl4 editing disabled" do
+      SiteSetting.trusted_users_can_edit_others = false
+
+      p = Fabricate(:post, topic: public_topic, user: user)
+      c = PresenceChannel.new("/discourse-presence/edit/#{p.id}")
+      expect(c.config.public).to eq(false)
+      expect(c.config.allowed_group_ids).to contain_exactly(
+        Group::AUTO_GROUPS[:staff]
+      )
+      expect(c.config.allowed_user_ids).to contain_exactly(user.id)
+    end
+
+    it "follows the wiki edit trust level site setting" do
+      p = Fabricate(:post, topic: public_topic, user: user, wiki: true)
+      SiteSetting.min_trust_to_edit_wiki_post = TrustLevel.levels[:basic]
+      SiteSetting.trusted_users_can_edit_others = false
+
+      c = PresenceChannel.new("/discourse-presence/edit/#{p.id}")
+      expect(c.config.public).to eq(false)
+      expect(c.config.allowed_group_ids).to contain_exactly(
+        Group::AUTO_GROUPS[:staff],
+        Group::AUTO_GROUPS[:trust_level_1]
+      )
+      expect(c.config.allowed_user_ids).to contain_exactly(user.id)
+    end
+
+    it "allows author and staff when editing a private message" do
+      post = Fabricate(:post, topic: private_message, user: user)
+
+      c = PresenceChannel.new("/discourse-presence/edit/#{post.id}")
+      expect(c.config.public).to eq(false)
+      expect(c.config.allowed_group_ids).to contain_exactly(
+        Group::AUTO_GROUPS[:staff]
+      )
+      expect(c.config.allowed_user_ids).to contain_exactly(user.id)
+    end
+
+    it "includes all message participants for PM wiki" do
+      post = Fabricate(:post, topic: private_message, user: user, wiki: true)
+
+      c = PresenceChannel.new("/discourse-presence/edit/#{post.id}")
+      expect(c.config.public).to eq(false)
+      expect(c.config.allowed_group_ids).to contain_exactly(
+        Group::AUTO_GROUPS[:staff],
+        *private_message.allowed_groups.pluck(:id)
+      )
+      expect(c.config.allowed_user_ids).to contain_exactly(user.id, *private_message.allowed_users.pluck(:id))
+    end
+  end
+end