mirror of
https://github.com/discourse/discourse.git
synced 2024-12-12 00:15:48 +08:00
60ad836313
This is a combined work of Martin Brennan, Loïc Guitaut, and Joffrey Jaffeux. --- This commit implements a base service object when working in chat. The documentation is available at https://discourse.github.io/discourse/chat/backend/Chat/Service.html Generating documentation has been made as part of this commit with a bigger goal in mind of generally making it easier to dive into the chat project. Working with services generally involves 3 parts: - The service object itself, which is a series of steps where few of them are specialized (model, transaction, policy) ```ruby class UpdateAge include Chat::Service::Base model :user, :fetch_user policy :can_see_user contract step :update_age class Contract attribute :age, :integer end def fetch_user(user_id:, **) User.find_by(id: user_id) end def can_see_user(guardian:, **) guardian.can_see_user(user) end def update_age(age:, **) user.update!(age: age) end end ``` - The `with_service` controller helper, handling success and failure of the service within a service and making easy to return proper response to it from the controller ```ruby def update with_service(UpdateAge) do on_success { render_serialized(result.user, BasicUserSerializer, root: "user") } end end ``` - Rspec matchers and steps inspector, improving the dev experience while creating specs for a service ```ruby RSpec.describe(UpdateAge) do subject(:result) do described_class.call(guardian: guardian, user_id: user.id, age: age) end fab!(:user) { Fabricate(:user) } fab!(:current_user) { Fabricate(:admin) } let(:guardian) { Guardian.new(current_user) } let(:age) { 1 } it { expect(user.reload.age).to eq(age) } end ``` Note in case of unexpected failure in your spec, the output will give all the relevant information: ``` 1) UpdateAge when no channel_id is given is expected to fail to find a model named 'user' Failure/Error: it { is_expected.to fail_to_find_a_model(:user) } Expected model 'foo' (key: 'result.model.user') was not found in the result object. [1/4] [model] 'user' ❌ [2/4] [policy] 'can_see_user' [3/4] [contract] 'default' [4/4] [step] 'update_age' /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/update_age.rb:32:in `fetch_user': missing keyword: :user_id (ArgumentError) from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:202:in `instance_exec' from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:202:in `call' from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:219:in `call' from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:417:in `block in run!' from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:417:in `each' from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:417:in `run!' from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:411:in `run' from <internal:kernel>:90:in `tap' from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/app/services/base.rb:302:in `call' from /Users/joffreyjaffeux/Code/pr-discourse/plugins/chat/spec/services/update_age_spec.rb:15:in `block (3 levels) in <main>' ```
190 lines
4.8 KiB
Ruby
190 lines
4.8 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
module Chat::GuardianExtensions
|
|
def can_moderate_chat?(chatable)
|
|
case chatable.class.name
|
|
when "Category"
|
|
is_staff? || is_category_group_moderator?(chatable)
|
|
else
|
|
is_staff?
|
|
end
|
|
end
|
|
|
|
def can_chat?
|
|
return false if anonymous?
|
|
@user.staff? || @user.in_any_groups?(Chat.allowed_group_ids)
|
|
end
|
|
|
|
def can_create_chat_message?
|
|
!SpamRule::AutoSilence.prevent_posting?(@user)
|
|
end
|
|
|
|
def can_create_direct_message?
|
|
is_staff? || @user.in_any_groups?(SiteSetting.direct_message_enabled_groups_map)
|
|
end
|
|
|
|
def hidden_tag_names
|
|
@hidden_tag_names ||= DiscourseTagging.hidden_tag_names(self)
|
|
end
|
|
|
|
def can_create_chat_channel?
|
|
is_staff?
|
|
end
|
|
|
|
def can_delete_chat_channel?
|
|
is_staff?
|
|
end
|
|
|
|
# Channel status intentionally has no bearing on whether the channel
|
|
# name and description can be edited.
|
|
def can_edit_chat_channel?
|
|
is_staff?
|
|
end
|
|
|
|
def can_move_chat_messages?(channel)
|
|
can_moderate_chat?(channel.chatable)
|
|
end
|
|
|
|
def can_create_channel_message?(chat_channel)
|
|
valid_statuses = is_staff? ? %w[open closed] : ["open"]
|
|
valid_statuses.include?(chat_channel.status)
|
|
end
|
|
|
|
# This is intentionally identical to can_create_channel_message, we
|
|
# may want to have different conditions here in future.
|
|
def can_modify_channel_message?(chat_channel)
|
|
return chat_channel.open? || chat_channel.closed? if is_staff?
|
|
chat_channel.open?
|
|
end
|
|
|
|
def can_change_channel_status?(chat_channel, target_status)
|
|
return false if chat_channel.status.to_sym == target_status.to_sym
|
|
return false if !is_staff?
|
|
|
|
# FIXME: This logic shouldn't be handled in guardian
|
|
case target_status
|
|
when :closed
|
|
chat_channel.open?
|
|
when :open
|
|
chat_channel.closed?
|
|
when :archived
|
|
chat_channel.read_only?
|
|
when :read_only
|
|
chat_channel.closed? || chat_channel.open?
|
|
else
|
|
false
|
|
end
|
|
end
|
|
|
|
def can_rebake_chat_message?(message)
|
|
return false if !can_modify_channel_message?(message.chat_channel)
|
|
is_staff? || @user.has_trust_level?(TrustLevel[4])
|
|
end
|
|
|
|
def can_preview_chat_channel?(chat_channel)
|
|
return false unless chat_channel.chatable
|
|
|
|
if chat_channel.direct_message_channel?
|
|
chat_channel.chatable.user_can_access?(@user)
|
|
elsif chat_channel.category_channel?
|
|
can_see_category?(chat_channel.chatable)
|
|
else
|
|
true
|
|
end
|
|
end
|
|
|
|
def can_join_chat_channel?(chat_channel)
|
|
return false if anonymous?
|
|
can_preview_chat_channel?(chat_channel) &&
|
|
(chat_channel.direct_message_channel? || can_post_in_category?(chat_channel.chatable))
|
|
end
|
|
|
|
def can_flag_chat_messages?
|
|
return false if @user.silenced?
|
|
return true if @user.staff?
|
|
|
|
@user.in_any_groups?(SiteSetting.chat_message_flag_allowed_groups_map)
|
|
end
|
|
|
|
def can_flag_in_chat_channel?(chat_channel)
|
|
return false if !can_modify_channel_message?(chat_channel)
|
|
|
|
can_join_chat_channel?(chat_channel)
|
|
end
|
|
|
|
def can_flag_chat_message?(chat_message)
|
|
return false if !authenticated? || !chat_message || chat_message.trashed? || !chat_message.user
|
|
return false if chat_message.user.staff? && !SiteSetting.allow_flagging_staff
|
|
return false if chat_message.user_id == @user.id
|
|
|
|
can_flag_chat_messages? && can_flag_in_chat_channel?(chat_message.chat_channel)
|
|
end
|
|
|
|
def can_flag_message_as?(chat_message, flag_type_id, opts)
|
|
return false if !is_staff? && (opts[:take_action] || opts[:queue_for_review])
|
|
|
|
if flag_type_id == ReviewableScore.types[:notify_user]
|
|
is_warning = ActiveRecord::Type::Boolean.new.deserialize(opts[:is_warning])
|
|
|
|
return false if is_warning && !is_staff?
|
|
end
|
|
|
|
true
|
|
end
|
|
|
|
def can_delete_chat?(message, chatable)
|
|
return false if @user.silenced?
|
|
return false if !can_modify_channel_message?(message.chat_channel)
|
|
|
|
if message.user_id == current_user.id
|
|
can_delete_own_chats?(chatable)
|
|
else
|
|
can_delete_other_chats?(chatable)
|
|
end
|
|
end
|
|
|
|
def can_delete_own_chats?(chatable)
|
|
return false if (SiteSetting.max_post_deletions_per_day < 1)
|
|
return true if can_moderate_chat?(chatable)
|
|
|
|
true
|
|
end
|
|
|
|
def can_delete_other_chats?(chatable)
|
|
return true if can_moderate_chat?(chatable)
|
|
|
|
false
|
|
end
|
|
|
|
def can_restore_chat?(message, chatable)
|
|
return false if !can_modify_channel_message?(message.chat_channel)
|
|
|
|
if message.user_id == current_user.id
|
|
case chatable
|
|
when Category
|
|
return can_see_category?(chatable)
|
|
when DirectMessage
|
|
return true
|
|
end
|
|
end
|
|
|
|
can_delete_other_chats?(chatable)
|
|
end
|
|
|
|
def can_restore_other_chats?(chatable)
|
|
can_moderate_chat?(chatable)
|
|
end
|
|
|
|
def can_edit_chat?(message)
|
|
message.user_id == @user.id && !@user.silenced?
|
|
end
|
|
|
|
def can_react?
|
|
can_create_chat_message?
|
|
end
|
|
|
|
def can_delete_category?(category)
|
|
super && category.deletable_for_chat?
|
|
end
|
|
end
|