mirror of
https://github.com/discourse/discourse.git
synced 2024-12-12 18:43:43 +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>' ```
151 lines
4.7 KiB
Ruby
151 lines
4.7 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
CHANNEL_EDITABLE_PARAMS = %i[name description slug]
|
|
CATEGORY_CHANNEL_EDITABLE_PARAMS = %i[auto_join_users allow_channel_wide_mentions]
|
|
|
|
class Chat::Api::ChatChannelsController < Chat::Api
|
|
def index
|
|
permitted = params.permit(:filter, :limit, :offset, :status)
|
|
|
|
options = { filter: permitted[:filter], limit: (permitted[:limit] || 25).to_i }
|
|
options[:offset] = permitted[:offset].to_i
|
|
options[:status] = ChatChannel.statuses[permitted[:status]] ? permitted[:status] : nil
|
|
|
|
memberships = Chat::ChatChannelMembershipManager.all_for_user(current_user)
|
|
channels = Chat::ChatChannelFetcher.secured_public_channels(guardian, memberships, options)
|
|
serialized_channels =
|
|
channels.map do |channel|
|
|
ChatChannelSerializer.new(
|
|
channel,
|
|
scope: Guardian.new(current_user),
|
|
membership: memberships.find { |membership| membership.chat_channel_id == channel.id },
|
|
)
|
|
end
|
|
|
|
load_more_params = options.merge(offset: options[:offset] + options[:limit]).to_query
|
|
load_more_url = URI::HTTP.build(path: "/chat/api/channels", query: load_more_params).request_uri
|
|
|
|
render json: serialized_channels, root: "channels", meta: { load_more_url: load_more_url }
|
|
end
|
|
|
|
def destroy
|
|
with_service Chat::Service::TrashChannel do
|
|
on_model_not_found(:channel) { raise ActiveRecord::RecordNotFound }
|
|
end
|
|
end
|
|
|
|
def create
|
|
channel_params =
|
|
params.require(:channel).permit(:chatable_id, :name, :slug, :description, :auto_join_users)
|
|
|
|
guardian.ensure_can_create_chat_channel!
|
|
if channel_params[:name].length > SiteSetting.max_topic_title_length
|
|
raise Discourse::InvalidParameters.new(:name)
|
|
end
|
|
|
|
if ChatChannel.exists?(
|
|
chatable_type: "Category",
|
|
chatable_id: channel_params[:chatable_id],
|
|
name: channel_params[:name],
|
|
)
|
|
raise Discourse::InvalidParameters.new(I18n.t("chat.errors.channel_exists_for_category"))
|
|
end
|
|
|
|
chatable = Category.find_by(id: channel_params[:chatable_id])
|
|
raise Discourse::NotFound unless chatable
|
|
|
|
auto_join_users =
|
|
ActiveRecord::Type::Boolean.new.deserialize(channel_params[:auto_join_users]) || false
|
|
|
|
channel =
|
|
chatable.create_chat_channel!(
|
|
name: channel_params[:name],
|
|
slug: channel_params[:slug],
|
|
description: channel_params[:description],
|
|
user_count: 1,
|
|
auto_join_users: auto_join_users,
|
|
)
|
|
|
|
channel.user_chat_channel_memberships.create!(user: current_user, following: true)
|
|
|
|
if channel.auto_join_users
|
|
Chat::ChatChannelMembershipManager.new(channel).enforce_automatic_channel_memberships
|
|
end
|
|
|
|
render_serialized(
|
|
channel,
|
|
ChatChannelSerializer,
|
|
membership: channel.membership_for(current_user),
|
|
root: "channel",
|
|
)
|
|
end
|
|
|
|
def show
|
|
render_serialized(
|
|
channel_from_params,
|
|
ChatChannelSerializer,
|
|
membership: channel_from_params.membership_for(current_user),
|
|
root: "channel",
|
|
)
|
|
end
|
|
|
|
def update
|
|
params_to_edit = editable_params(params, channel_from_params)
|
|
params_to_edit.each { |k, v| params_to_edit[k] = nil if params_to_edit[k].blank? }
|
|
if ActiveRecord::Type::Boolean.new.deserialize(params_to_edit[:auto_join_users])
|
|
auto_join_limiter(channel_from_params).performed!
|
|
end
|
|
|
|
with_service(Chat::Service::UpdateChannel, **params_to_edit) do
|
|
on_success do
|
|
render_serialized(
|
|
result.channel,
|
|
ChatChannelSerializer,
|
|
root: "channel",
|
|
membership: result.channel.membership_for(current_user),
|
|
)
|
|
end
|
|
on_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 }
|
|
end
|
|
end
|
|
|
|
private
|
|
|
|
def channel_from_params
|
|
@channel ||=
|
|
begin
|
|
channel = ChatChannel.find(params.require(:channel_id))
|
|
guardian.ensure_can_preview_chat_channel!(channel)
|
|
channel
|
|
end
|
|
end
|
|
|
|
def membership_from_params
|
|
@membership ||=
|
|
begin
|
|
membership =
|
|
Chat::ChatChannelMembershipManager.new(channel_from_params).find_for_user(current_user)
|
|
raise Discourse::NotFound if membership.blank?
|
|
membership
|
|
end
|
|
end
|
|
|
|
def auto_join_limiter(channel)
|
|
RateLimiter.new(
|
|
current_user,
|
|
"auto_join_users_channel_#{channel.id}",
|
|
1,
|
|
3.minutes,
|
|
apply_limit_to_staff: true,
|
|
)
|
|
end
|
|
|
|
def editable_params(params, channel)
|
|
permitted_params = CHANNEL_EDITABLE_PARAMS
|
|
permitted_params += CATEGORY_CHANNEL_EDITABLE_PARAMS if channel.category_channel?
|
|
params.require(:channel).permit(*permitted_params)
|
|
end
|
|
end
|