mirror of
https://github.com/discourse/discourse.git
synced 2024-11-26 11:43:44 +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>' ```
52 lines
4.2 KiB
HTML
52 lines
4.2 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
<meta charset="utf-8" />
|
|
|
|
<link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" />
|
|
|
|
<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" />
|
|
|
|
|
|
|
|
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
|
|
|
|
<script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
|
|
|
|
|
|
<title>Class List</title>
|
|
<base id="base_target" target="_parent" />
|
|
</head>
|
|
<body>
|
|
<div id="content">
|
|
<div class="fixed_header">
|
|
<h1 id="full_list_header">Class List</h1>
|
|
<div id="full_list_nav">
|
|
|
|
<span><a target="_self" href="class_list.html">
|
|
Classes
|
|
</a></span>
|
|
|
|
<span><a target="_self" href="method_list.html">
|
|
Methods
|
|
</a></span>
|
|
|
|
<span><a target="_self" href="file_list.html">
|
|
Files
|
|
</a></span>
|
|
|
|
</div>
|
|
|
|
<div id="search">Search: <input type="text" /></div>
|
|
</div>
|
|
|
|
<ul id="full_list" class="class">
|
|
<li id="object_" class="odd"><div class="item" style="padding-left:30px"><span class='object_link'><a href="top-level-namespace.html" title="Top Level Namespace (root)">Top Level Namespace</a></span></div></li>
|
|
<li id='object_Chat' class='even'><div class='item' style='padding-left:30px'><a class='toggle'></a> <span class='object_link'><a href="Chat.html" title="Chat (module)">Chat</a></span><small class='search_info'>Top Level Namespace</small></div><ul><li id='object_Chat::Service' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="Chat/Service.html" title="Chat::Service (module)">Service</a></span><small class='search_info'>Chat</small></div><ul><li id='object_Chat::Service::Base' class='collapsed'><div class='item' style='padding-left:60px'><a class='toggle'></a> <span class='object_link'><a href="Chat/Service/Base.html" title="Chat::Service::Base (module)">Base</a></span><small class='search_info'>Chat::Service</small></div><ul><li id='object_Chat::Service::Base::Context' class='collapsed'><div class='item' style='padding-left:75px'><span class='object_link'><a href="Chat/Service/Base/Context.html" title="Chat::Service::Base::Context (class)">Context</a></span> < OpenStruct<small class='search_info'>Chat::Service::Base</small></div></li><li id='object_Chat::Service::Base::Failure' class='collapsed'><div class='item' style='padding-left:75px'><span class='object_link'><a href="Chat/Service/Base/Failure.html" title="Chat::Service::Base::Failure (class)">Failure</a></span> < StandardError<small class='search_info'>Chat::Service::Base</small></div></li></ul></li><li id='object_Chat::Service::TrashChannel' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Chat/Service/TrashChannel.html" title="Chat::Service::TrashChannel (class)">TrashChannel</a></span> < Object<small class='search_info'>Chat::Service</small></div></li><li id='object_Chat::Service::UpdateChannel' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Chat/Service/UpdateChannel.html" title="Chat::Service::UpdateChannel (class)">UpdateChannel</a></span> < Object<small class='search_info'>Chat::Service</small></div></li><li id='object_Chat::Service::UpdateChannelStatus' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Chat/Service/UpdateChannelStatus.html" title="Chat::Service::UpdateChannelStatus (class)">UpdateChannelStatus</a></span> < Object<small class='search_info'>Chat::Service</small></div></li><li id='object_Chat::Service::UpdateUserLastRead' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="Chat/Service/UpdateUserLastRead.html" title="Chat::Service::UpdateUserLastRead (class)">UpdateUserLastRead</a></span> < Object<small class='search_info'>Chat::Service</small></div></li></ul></li></ul></li>
|
|
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|