mirror of
https://github.com/discourse/discourse.git
synced 2024-12-17 18:05:58 +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>' ```
108 lines
2.9 KiB
Ruby
108 lines
2.9 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
RSpec.describe Chat::Service::UpdateChannel do
|
|
subject(:result) { described_class.call(guardian: guardian, channel_id: channel.id, **params) }
|
|
|
|
fab!(:channel) { Fabricate(:chat_channel) }
|
|
fab!(:current_user) { Fabricate(:admin) }
|
|
|
|
let(:guardian) { Guardian.new(current_user) }
|
|
let(:params) do
|
|
{
|
|
name: "cool channel",
|
|
description: "a channel description",
|
|
slug: "snail",
|
|
allow_channel_wide_mentions: true,
|
|
auto_join_users: false,
|
|
}
|
|
end
|
|
|
|
context "when the user cannot edit the channel" do
|
|
fab!(:current_user) { Fabricate(:user) }
|
|
|
|
it { is_expected.to fail_a_policy(:check_channel_permission) }
|
|
end
|
|
|
|
context "when the user tries to edit a DM channel" do
|
|
fab!(:channel) { Fabricate(:direct_message_channel, users: [current_user, Fabricate(:user)]) }
|
|
|
|
it { is_expected.to fail_a_policy(:no_direct_message_channel) }
|
|
end
|
|
|
|
context "when channel is a category one" do
|
|
context "when a valid user provides valid params" do
|
|
let(:message) do
|
|
MessageBus.track_publish(ChatPublisher::CHANNEL_EDITS_MESSAGE_BUS_CHANNEL) { result }.first
|
|
end
|
|
|
|
it "sets the service result as successful" do
|
|
expect(result).to be_a_success
|
|
end
|
|
|
|
it "updates the channel accordingly" do
|
|
result
|
|
expect(channel.reload).to have_attributes(
|
|
name: "cool channel",
|
|
slug: "snail",
|
|
description: "a channel description",
|
|
allow_channel_wide_mentions: true,
|
|
auto_join_users: false,
|
|
)
|
|
end
|
|
|
|
it "publishes a MessageBus message" do
|
|
expect(message.data).to eq(
|
|
{
|
|
chat_channel_id: channel.id,
|
|
name: "cool channel",
|
|
description: "a channel description",
|
|
slug: "snail",
|
|
},
|
|
)
|
|
end
|
|
|
|
context "when the name is blank" do
|
|
before { params[:name] = "" }
|
|
|
|
it "nils out the name" do
|
|
result
|
|
expect(channel.reload.name).to be_nil
|
|
end
|
|
end
|
|
|
|
context "when the description is blank" do
|
|
before do
|
|
channel.update!(description: "something")
|
|
params[:description] = ""
|
|
end
|
|
|
|
it "nils out the description" do
|
|
result
|
|
expect(channel.reload.description).to be_nil
|
|
end
|
|
end
|
|
|
|
context "when auto_join_users is set to 'true'" do
|
|
before do
|
|
channel.update!(auto_join_users: false)
|
|
params[:auto_join_users] = true
|
|
end
|
|
|
|
it "updates the model accordingly" do
|
|
result
|
|
expect(channel.reload).to have_attributes(auto_join_users: true)
|
|
end
|
|
|
|
it "auto joins users" do
|
|
expect_enqueued_with(
|
|
job: :auto_manage_channel_memberships,
|
|
args: {
|
|
chat_channel_id: channel.id,
|
|
},
|
|
) { result }
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|