Discource-C
/
discourse
mirror of https://github.com/discourse/discourse.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
discourse/documentation/chat/backend/method_list.html

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

164 lines
5.0 KiB
HTML
Raw Normal View History

DEV: Chat service object initial implementation (#19814) 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>' ```
2023-02-13 07:09:57 -05:00
<!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>Method List</title>
<base id="base_target" target="_parent" />
</head>
<body>
<div id="content">
<div class="fixed_header">
<h1 id="full_list_header">Method 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="method">
<li class="odd ">
<div class="item">
<span class='object_link'><a href="Chat/Service/Base.html#contract-class_method" title="Chat::Service::Base.contract (method)">contract</a></span>
<small>Chat::Service::Base</small>
</div>
</li>
<li class="even ">
<div class="item">
<span class='object_link'><a href="Chat/Service/Base.html#model-class_method" title="Chat::Service::Base.model (method)">model</a></span>
<small>Chat::Service::Base</small>
</div>
</li>
<li class="odd ">
<div class="item">
<span class='object_link'><a href="Chat/Service/Base.html#policy-class_method" title="Chat::Service::Base.policy (method)">policy</a></span>
<small>Chat::Service::Base</small>
</div>
</li>
<li class="even ">
<div class="item">
<span class='object_link'><a href="Chat/Service/Base.html#step-class_method" title="Chat::Service::Base.step (method)">step</a></span>
<small>Chat::Service::Base</small>
</div>
</li>
<li class="odd ">
<div class="item">
<span class='object_link'><a href="Chat/Service/Base.html#transaction-class_method" title="Chat::Service::Base.transaction (method)">transaction</a></span>
<small>Chat::Service::Base</small>
</div>
</li>
<li class="even ">
<div class="item">
<span class='object_link'><a href="Chat/Service/Base/Context.html#fail-instance_method" title="Chat::Service::Base::Context#fail (method)">#fail</a></span>
<small>Chat::Service::Base::Context</small>
</div>
</li>
<li class="odd ">
<div class="item">
<span class='object_link'><a href="Chat/Service/Base/Context.html#fail!-instance_method" title="Chat::Service::Base::Context#fail! (method)">#fail!</a></span>
<small>Chat::Service::Base::Context</small>
</div>
</li>
<li class="even ">
<div class="item">
<span class='object_link'><a href="Chat/Service/Base/Context.html#failure%3F-instance_method" title="Chat::Service::Base::Context#failure? (method)">#failure?</a></span>
<small>Chat::Service::Base::Context</small>
</div>
</li>
<li class="odd ">
<div class="item">
<span class='object_link'><a href="Chat/Service/Base/Context.html#success%3F-instance_method" title="Chat::Service::Base::Context#success? (method)">#success?</a></span>
<small>Chat::Service::Base::Context</small>
</div>
</li>
<li class="even ">
<div class="item">
<span class='object_link'><a href="Chat/Service/Base/Failure.html#context-instance_method" title="Chat::Service::Base::Failure#context (method)">#context</a></span>
<small>Chat::Service::Base::Failure</small>
</div>
</li>
<li class="odd ">
<div class="item">
<span class='object_link'><a href="Chat/Service/TrashChannel.html#call-instance_method" title="Chat::Service::TrashChannel#call (method)">#call</a></span>
<small>Chat::Service::TrashChannel</small>
</div>
</li>
<li class="even ">
<div class="item">
<span class='object_link'><a href="Chat/Service/UpdateChannel.html#call-instance_method" title="Chat::Service::UpdateChannel#call (method)">#call</a></span>
<small>Chat::Service::UpdateChannel</small>
</div>
</li>
<li class="odd ">
<div class="item">
<span class='object_link'><a href="Chat/Service/UpdateChannelStatus.html#call-instance_method" title="Chat::Service::UpdateChannelStatus#call (method)">#call</a></span>
<small>Chat::Service::UpdateChannelStatus</small>
</div>
</li>
<li class="even ">
<div class="item">
<span class='object_link'><a href="Chat/Service/UpdateUserLastRead.html#call-instance_method" title="Chat::Service::UpdateUserLastRead#call (method)">#call</a></span>
<small>Chat::Service::UpdateUserLastRead</small>
</div>
</li>
</ul>
</div>
</body>
</html>