A platform for community discussion. Free, open, simple.
FIX: Surface actionable errors when chat policy checks fail (#41971)
Régis Hanol270881812699
diff --git a/plugins/chat/app/controllers/chat/api/channel_messages_controller.rb b/plugins/chat/app/controllers/chat/api/channel_messages_controller.rbindex bac168687c0..dfba4b21c39 100644--- a/plugins/chat/app/controllers/chat/api/channel_messages_controller.rb+++ b/plugins/chat/app/controllers/chat/api/channel_messages_controller.rb@@ -38,7 +38,7 @@ class Chat::Api::ChannelMessagesController < Chat::ApiControlleron_success { render(json: success_json) }on_failure { render(json: failed_json, status: :unprocessable_entity) }on_model_not_found(:messages) { raise Discourse::NotFound }- on_failed_policy(:invalid_access) { raise Discourse::InvalidAccess }+ on_failed_policy(:can_delete_all_chat_messages) { raise Discourse::InvalidAccess }on_failed_contract do |contract|render(json: failed_json.merge(errors: contract.errors.full_messages), status: :bad_request)end@@ -62,6 +62,11 @@ class Chat::Api::ChannelMessagesController < Chat::ApiControlleron_success { |message:| render json: success_json.merge(message_id: message.id) }on_failure { render(json: failed_json, status: :unprocessable_entity) }on_model_not_found(:message) { raise Discourse::NotFound }+ on_model_not_found(:membership) { raise Discourse::NotFound }+ on_failed_policy(:can_edit_message) { raise Discourse::InvalidAccess }+ on_failed_policy(:channel_allows_message_modification) do |policy|+ render_json_error(policy.reason)+ endon_model_errors(:message) do |model|render_json_error(model.errors.map(&:full_message).join(", "))end@@ -81,11 +86,10 @@ class Chat::Api::ChannelMessagesController < Chat::ApiControlleron_failure { render(json: failed_json, status: :unprocessable_entity) }on_failed_policy(:no_silenced_user) { raise Discourse::InvalidAccess }on_model_not_found(:channel) { raise Discourse::NotFound }- on_failed_policy(:allowed_to_join_channel) { raise Discourse::InvalidAccess }on_failed_policy(:accept_blocks) { raise Discourse::InvalidAccess }on_model_not_found(:membership) { raise Discourse::NotFound }on_failed_policy(:ensure_reply_consistency) { raise Discourse::NotFound }- on_failed_policy(:allowed_to_create_message_in_channel) do |policy|+ on_failed_policy(:channel_allows_message_creation) do |policy|render_json_error(policy.reason)endon_failed_policy(:ensure_valid_thread_for_channel) dodiff --git a/plugins/chat/app/controllers/chat/api/channels_controller.rb b/plugins/chat/app/controllers/chat/api/channels_controller.rbindex dac5dc2f126..7271f032859 100644--- a/plugins/chat/app/controllers/chat/api/channels_controller.rb+++ b/plugins/chat/app/controllers/chat/api/channels_controller.rb@@ -83,6 +83,9 @@ class Chat::Api::ChannelsController < Chat::ApiControllerendon_model_not_found(:category) { raise ActiveRecord::RecordNotFound }on_failed_policy(:can_create_channel) { raise Discourse::InvalidAccess }+ on_failed_policy(:public_channels_enabled) do+ render_json_error(I18n.t("chat.errors.public_channels_disabled"))+ endon_failed_policy(:can_create_channel_in_category) { raise Discourse::InvalidAccess }on_failed_policy(:category_channel_does_not_exist) doraise Discourse::InvalidParameters.new(I18n.t("chat.errors.channel_exists_for_category"))@@ -128,7 +131,6 @@ class Chat::Api::ChannelsController < Chat::ApiControllerendon_model_not_found(:channel) { raise ActiveRecord::RecordNotFound }on_failed_policy(:check_channel_permission) { raise Discourse::InvalidAccess }- on_failed_policy(:no_direct_message_channel) { raise Discourse::InvalidAccess }endenddiff --git a/plugins/chat/app/controllers/chat/incoming_webhooks_controller.rb b/plugins/chat/app/controllers/chat/incoming_webhooks_controller.rbindex 0f807e1a346..7a77ddc4922 100644--- a/plugins/chat/app/controllers/chat/incoming_webhooks_controller.rb+++ b/plugins/chat/app/controllers/chat/incoming_webhooks_controller.rb@@ -70,10 +70,9 @@ module Chatendon_failed_policy(:no_silenced_user) { raise Discourse::InvalidAccess }on_model_not_found(:channel) { raise Discourse::NotFound }- on_failed_policy(:allowed_to_join_channel) { raise Discourse::InvalidAccess }- on_model_not_found(:channel_membership) { raise Discourse::InvalidAccess }+ on_model_not_found(:membership) { raise Discourse::InvalidAccess }on_failed_policy(:ensure_reply_consistency) { raise Discourse::NotFound }- on_failed_policy(:allowed_to_create_message_in_channel) do |policy|+ on_failed_policy(:channel_allows_message_creation) do |policy|render_json_error(policy.reason)endon_failed_policy(:ensure_valid_thread_for_channel) dodiff --git a/plugins/chat/app/services/chat/channel/policy/message_modification.rb b/plugins/chat/app/services/chat/channel/policy/message_modification.rbnew file mode 100644index 00000000000..b474cd48b63--- /dev/null+++ b/plugins/chat/app/services/chat/channel/policy/message_modification.rb@@ -0,0 +1,13 @@+# frozen_string_literal: true++class Chat::Channel::Policy::MessageModification < Service::PolicyBase+ delegate :message, to: :context++ def call+ guardian.can_modify_channel_message?(message.chat_channel)+ end++ def reason+ I18n.t("chat.errors.channel_modify_message_disallowed.#{message.chat_channel.status}")+ end+enddiff --git a/plugins/chat/app/services/chat/create_category_channel.rb b/plugins/chat/app/services/chat/create_category_channel.rbindex ac4c6a5308c..0c4802beb91 100644--- a/plugins/chat/app/services/chat/create_category_channel.rb+++ b/plugins/chat/app/services/chat/create_category_channel.rb@@ -30,8 +30,8 @@ module Chat# @option params [String] :emoji# @return [Service::Base::Context]- policy :public_channels_enabledpolicy :can_create_channel+ policy :public_channels_enabledparams doattribute :name, :string@@ -65,14 +65,14 @@ module Chatprivate- def public_channels_enabled- SiteSetting.enable_public_channels- end-def can_create_channel(guardian:)guardian.can_create_chat_channel?end+ def public_channels_enabled+ SiteSetting.enable_public_channels+ end+def fetch_category(params:)Category.find_by(id: params.category_id)enddiff --git a/plugins/chat/app/services/chat/create_message.rb b/plugins/chat/app/services/chat/create_message.rbindex 4902b69d882..cf6b07e7134 100644--- a/plugins/chat/app/services/chat/create_message.rb+++ b/plugins/chat/app/services/chat/create_message.rb@@ -66,7 +66,7 @@ module Chatmodel :channelstep :enforce_membershipmodel :membership- policy :allowed_to_create_message_in_channel, class_name: Chat::Channel::Policy::MessageCreation+ policy :channel_allows_message_creation, class_name: Chat::Channel::Policy::MessageCreationmodel :reply, optional: truepolicy :ensure_reply_consistencymodel :thread, optional: truediff --git a/plugins/chat/app/services/chat/update_message.rb b/plugins/chat/app/services/chat/update_message.rbindex d2bdf030057..dbfb94b7eb5 100644--- a/plugins/chat/app/services/chat/update_message.rb+++ b/plugins/chat/app/services/chat/update_message.rb@@ -52,8 +52,9 @@ module Chatmodel :uploads, optional: truestep :enforce_membershipmodel :membership- policy :can_modify_channel_message- policy :can_modify_message+ policy :can_edit_message+ policy :channel_allows_message_modification,+ class_name: Chat::Channel::Policy::MessageModificationtransaction dostep :modify_message@@ -103,11 +104,7 @@ module Chat.where(user_uploads: { user: guardian.user })end- def can_modify_channel_message(guardian:, message:)- guardian.can_modify_channel_message?(message.chat_channel)- end-- def can_modify_message(guardian:, message:)+ def can_edit_message(guardian:, message:)guardian.can_edit_chat?(message)enddiff --git a/plugins/chat/config/locales/server.en.yml b/plugins/chat/config/locales/server.en.ymlindex 5e9e511f8b7..35b37fca969 100644--- a/plugins/chat/config/locales/server.en.yml+++ b/plugins/chat/config/locales/server.en.yml@@ -63,6 +63,7 @@ en:users_cant_be_added_to_channel: "Users can't be added to this channel."user_cant_be_removed_from_channel: "User can't be removed from this channel"channel_exists_for_category: "A channel already exists for this category and name"+ public_channels_disabled: "Unable to create the channel because public channels are disabled. An admin can enable the 'enable public channels' site setting."channel_new_message_disallowed:archived: "The channel is archived, no new messages can be sent"closed: "The channel is closed, no new messages can be sent"diff --git a/plugins/chat/lib/chat_sdk/message.rb b/plugins/chat/lib/chat_sdk/message.rbindex b3adccec021..89f932295be 100644--- a/plugins/chat/lib/chat_sdk/message.rb+++ b/plugins/chat/lib/chat_sdk/message.rb@@ -95,9 +95,6 @@ module ChatSDKon_model_not_found(:membership) doraise "Couldn't find membership for user with id: `#{guardian.user.id}`"end- on_failed_policy(:can_join_channel) do- raise "User with id: `#{guardian.user.id}` can't join this channel"- endon_failed_policy(:can_stop_streaming) doraise "User with id: `#{guardian.user.id}` can't stop streaming this message"end@@ -148,9 +145,6 @@ module ChatSDKraise "Couldn't find thread with id: `#{thread_id}`"endon_failed_policy(:accept_blocks) { raise "Only bots can create messages with blocks" }- on_failed_policy(:allowed_to_join_channel) do- raise "User with id: `#{guardian.user.id}` can't join this channel"- endon_failed_contract { |contract| raise contract.errors.full_messages.join(", ") }on_success { |message_instance:| message_instance }on_failure { raise "Unexpected error" }diff --git a/plugins/chat/lib/chat_sdk/thread.rb b/plugins/chat/lib/chat_sdk/thread.rbindex 30ff2ec8c77..2b0efc8e379 100644--- a/plugins/chat/lib/chat_sdk/thread.rb+++ b/plugins/chat/lib/chat_sdk/thread.rb@@ -97,9 +97,6 @@ module ChatSDKdef update(guardian:, **params)Chat::UpdateThread.call(guardian:, params:) do- on_model_not_found(:channel) do- raise "Couldn’t find channel with id: `#{params[:channel_id]}`"- endon_model_not_found(:thread) doraise "Couldn’t find thread with id: `#{params[:thread_id]}`"enddiff --git a/plugins/chat/spec/requests/chat/api/channel_messages_controller_spec.rb b/plugins/chat/spec/requests/chat/api/channel_messages_controller_spec.rbindex 02f420c43dc..d6e7751e9c0 100644--- a/plugins/chat/spec/requests/chat/api/channel_messages_controller_spec.rb+++ b/plugins/chat/spec/requests/chat/api/channel_messages_controller_spec.rb@@ -275,6 +275,39 @@ RSpec.describe Chat::Api::ChannelMessagesController doendend+ describe "#bulk_destroy" do+ fab!(:other_user, :user)+ fab!(:message_1) { Fabricate(:chat_message, chat_channel: channel, user: other_user) }+ fab!(:message_2) { Fabricate(:chat_message, chat_channel: channel, user: other_user) }++ context "when user is staff" do+ fab!(:current_user, :admin)++ it "deletes the messages" do+ delete "/chat/api/channels/#{channel.id}/messages",+ params: {+ message_ids: [message_1.id, message_2.id],+ }++ expect(response.status).to eq(200)+ expect(Chat::Message.where(id: [message_1.id, message_2.id])).to be_empty+ end+ end++ context "when user can't delete the messages" do+ it "returns a generic permission error" do+ delete "/chat/api/channels/#{channel.id}/messages",+ params: {+ message_ids: [message_1.id, message_2.id],+ }++ expect(response.status).to eq(403)+ expect(response.parsed_body["errors"]).to include(I18n.t("invalid_access"))+ expect(Chat::Message.where(id: [message_1.id, message_2.id]).count).to eq(2)+ end+ end+ end+describe "#update" docontext "when message is updated" dofab!(:message_1) { Fabricate(:chat_message, chat_channel: channel, user: current_user) }@@ -319,35 +352,70 @@ RSpec.describe Chat::Api::ChannelMessagesController dobefore { channel.membership_for(current_user).destroy! }it "returns a 404" do- put "/chat/api/channels/#{channel.id}/messages/#{message_1.id}"+ put "/chat/api/channels/#{channel.id}/messages/#{message_1.id}",+ params: {+ message: "abcdefg",+ }- expect(response.status).to eq(400)+ expect(response.status).to eq(404)endendcontext "when user is not the author" dofab!(:message_1) { Fabricate(:chat_message, chat_channel: channel) }- it "returns a 422" do+ it "returns a 403" doput "/chat/api/channels/#{channel.id}/messages/#{message_1.id}",params: {message: "abcdefg",}- expect(response.status).to eq(422)+ expect(response.status).to eq(403)+ expect(response.parsed_body["errors"]).to include(I18n.t("invalid_access"))endendcontext "when current user is silenced" dobefore { UserSilencer.new(current_user).silence }- it "returns a 422" do+ it "returns a 403" do+ put "/chat/api/channels/#{channel.id}/messages/#{message_1.id}",+ params: {+ message: "abcdefg",+ }++ expect(response.status).to eq(403)+ end+ end++ context "when the channel is closed" do+ before { channel.closed!(Discourse.system_user) }++ it "returns an actionable error message" doput "/chat/api/channels/#{channel.id}/messages/#{message_1.id}",params: {message: "abcdefg",}expect(response.status).to eq(422)+ expect(response.parsed_body["errors"]).to contain_exactly(+ I18n.t("chat.errors.channel_modify_message_disallowed.closed"),+ )+ expect(message_1.reload.message).not_to eq("abcdefg")+ end++ context "when the user is not the author" do+ fab!(:message_1) { Fabricate(:chat_message, chat_channel: channel) }++ it "returns a 403" do+ put "/chat/api/channels/#{channel.id}/messages/#{message_1.id}",+ params: {+ message: "abcdefg",+ }++ expect(response.status).to eq(403)+ expect(response.parsed_body["errors"]).to include(I18n.t("invalid_access"))+ endendend@@ -376,8 +444,8 @@ RSpec.describe Chat::Api::ChannelMessagesController domessage: "edited message",}- expect(response).to have_http_status(:unprocessable_entity)- expect(response.parsed_body["failed"]).to eq("FAILED")+ expect(response).to have_http_status(:forbidden)+ expect(response.parsed_body["errors"]).to include(I18n.t("invalid_access"))expect(message.reload.message).to eq("original message")endenddiff --git a/plugins/chat/spec/requests/chat/api/channels_controller_spec.rb b/plugins/chat/spec/requests/chat/api/channels_controller_spec.rbindex ecbc434dd10..5dec109d989 100644--- a/plugins/chat/spec/requests/chat/api/channels_controller_spec.rb+++ b/plugins/chat/spec/requests/chat/api/channels_controller_spec.rb@@ -391,6 +391,32 @@ RSpec.describe Chat::Api::ChannelsController doendend+ context "when public channels are disabled" do+ before { SiteSetting.enable_public_channels = false }++ it "returns an actionable error message" do+ expect { post "/chat/api/channels", params: }.to not_change { Chat::Channel.count }++ expect(response.status).to eq(422)+ expect(response.parsed_body["errors"]).to contain_exactly(+ I18n.t("chat.errors.public_channels_disabled"),+ )+ end++ context "when the user is not staff" do+ fab!(:user)++ before { sign_in(user) }++ it "returns a generic permission error" do+ post "/chat/api/channels", params: params++ expect(response.status).to eq(403)+ expect(response.parsed_body["errors"]).to include(I18n.t("invalid_access"))+ end+ end+ end+it "creates a channel using the user-provided slug" donew_params = params.dupnew_params[:channel][:slug] = "wow-so-cool"diff --git a/plugins/chat/spec/services/chat/channel/policy/message_modification_spec.rb b/plugins/chat/spec/services/chat/channel/policy/message_modification_spec.rbnew file mode 100644index 00000000000..b61e383a9eb--- /dev/null+++ b/plugins/chat/spec/services/chat/channel/policy/message_modification_spec.rb@@ -0,0 +1,44 @@+# frozen_string_literal: true++RSpec.describe Chat::Channel::Policy::MessageModification do+ subject(:policy) { described_class.new(context) }++ fab!(:user) { Fabricate(:user, refresh_auto_groups: true) }+ fab!(:chat_channel)+ fab!(:message) { Fabricate(:chat_message, chat_channel:, user:) }++ let(:guardian) { user.guardian }+ let(:context) { Service::Base::Context.build(message:, guardian:) }++ describe "#call" do+ subject(:result) { policy.call }++ context "when the channel is open" do+ it "returns true" do+ expect(result).to be_truthy+ end+ end++ context "when the channel is closed" do+ before { chat_channel.update!(status: :closed) }++ it "returns false" do+ expect(result).to be_falsey+ end+ end+ end++ describe "#reason" do+ subject(:reason) { policy.reason }++ %w[closed read_only archived].each do |status|+ context "when the channel is #{status}" do+ before { chat_channel.update!(status:) }++ it "returns the #{status} message" do+ expect(reason).to eq(I18n.t("chat.errors.channel_modify_message_disallowed.#{status}"))+ end+ end+ end+ end+enddiff --git a/plugins/chat/spec/services/chat/create_category_channel_spec.rb b/plugins/chat/spec/services/chat/create_category_channel_spec.rbindex 7d7b3cd933d..fb92b526c0e 100644--- a/plugins/chat/spec/services/chat/create_category_channel_spec.rb+++ b/plugins/chat/spec/services/chat/create_category_channel_spec.rb@@ -18,18 +18,22 @@ RSpec.describe Chat::CreateCategoryChannel dolet(:params) { { category_id:, name: name } }let(:dependencies) { { guardian: } }- context "when public channels are disabled" do+ context "when the current user cannot make a channel" dofab!(:current_user, :user)- before { SiteSetting.enable_public_channels = false }+ it { is_expected.to fail_a_policy(:can_create_channel) }- it { is_expected.to fail_a_policy(:public_channels_enabled) }+ context "when public channels are also disabled" do+ before { SiteSetting.enable_public_channels = false }++ it { is_expected.to fail_a_policy(:can_create_channel) }+ endend- context "when the current user cannot make a channel" do- fab!(:current_user, :user)+ context "when public channels are disabled" do+ before { SiteSetting.enable_public_channels = false }- it { is_expected.to fail_a_policy(:can_create_channel) }+ it { is_expected.to fail_a_policy(:public_channels_enabled) }endcontext "when the current user can make a channel" dodiff --git a/plugins/chat/spec/services/chat/create_message_spec.rb b/plugins/chat/spec/services/chat/create_message_spec.rbindex 1cb9e22d1c9..49b89c03b1a 100644--- a/plugins/chat/spec/services/chat/create_message_spec.rb+++ b/plugins/chat/spec/services/chat/create_message_spec.rb@@ -332,7 +332,7 @@ RSpec.describe Chat::CreateMessage docontext "when user can't create a message in the channel" dobefore { channel.closed!(Discourse.system_user) }- it { is_expected.to fail_a_policy(:allowed_to_create_message_in_channel) }+ it { is_expected.to fail_a_policy(:channel_allows_message_creation) }endcontext "when user can create a message in the channel" dodiff --git a/plugins/chat/spec/services/chat/update_message_spec.rb b/plugins/chat/spec/services/chat/update_message_spec.rbindex 8d45fc6574f..f8fa872b2f4 100644--- a/plugins/chat/spec/services/chat/update_message_spec.rb+++ b/plugins/chat/spec/services/chat/update_message_spec.rb@@ -1050,12 +1050,6 @@ RSpec.describe Chat::UpdateMessage doit { is_expected.to fail_a_contract }end- context "when user can't modify a channel message" do- before { channel_1.update!(status: :read_only) }-- it { is_expected.to fail_a_policy(:can_modify_channel_message) }- end-context "when user is not member of the channel" dofab!(:channel_2, :chat_channel)fab!(:other_message) { Fabricate(:chat_message, chat_channel: channel_2) }@@ -1072,6 +1066,24 @@ RSpec.describe Chat::UpdateMessage doit { is_expected.to fail_to_find_a_model(:membership) }end+ context "when user can't edit the message" do+ fab!(:message_1) { Fabricate(:chat_message, chat_channel: channel_1) }++ it { is_expected.to fail_a_policy(:can_edit_message) }++ context "when the channel is also closed" do+ before { channel_1.update!(status: :closed) }++ it { is_expected.to fail_a_policy(:can_edit_message) }+ end+ end++ context "when the channel doesn't allow modifying messages" do+ before { channel_1.update!(status: :read_only) }++ it { is_expected.to fail_a_policy(:channel_allows_message_modification) }+ end+context "when edit grace period" dolet(:low_trust_char_limit) { SiteSetting.chat_editing_grace_period_max_diff_low_trust }let(:high_trust_char_limit) { SiteSetting.chat_editing_grace_period_max_diff_high_trust }