Discource-C
/
discourse
mirror of https://github.com/discourse/discourse.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
discourse/documentation/assets/logo.svg

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

13 lines
7.2 KiB
XML
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
<svg width="148" height="40" viewBox="0 0 148 40" fill="none" xmlns="http://www.w3.org/2000/svg">
<g id="logo-large">
<g id="Group">
<path id="Vector" d="M45.1304 8.54615C45.7644 8.53758 46.3733 8.79409 46.8103 9.25385C47.2687 9.70709 47.5215 10.3284 47.5099 10.9731C47.5214 11.6106 47.2713 12.225 46.818 12.6731C46.3877 13.1282 45.7873 13.3833 45.1611 13.3769C44.5221 13.3858 43.9086 13.1263 43.4697 12.6615C43.0103 12.2011 42.7577 11.5736 42.7701 10.9231C42.7701 9.61546 43.8273 8.55424 45.1342 8.55L45.1304 8.54615V8.54615ZM43.2698 16.6423H46.991V32.1654H43.2698V16.6423V16.6423ZM59.4537 19.1L57.1472 21.4077C56.2092 20.4692 55.3558 20 54.587 20C54.2401 19.9798 53.8961 20.073 53.6067 20.2654C53.3864 20.4135 53.2539 20.6613 53.2531 20.9269C53.2544 21.1332 53.3341 21.3312 53.476 21.4808C53.8073 21.7711 54.1822 22.0073 54.587 22.1808L55.9517 22.8615C57.3868 23.5718 58.3735 24.2949 58.9117 25.0308C60.1954 26.8811 59.9199 29.3951 58.2659 30.9231C57.2971 31.8051 55.9991 32.2462 54.3717 32.2462C52.3378 32.3023 50.4063 31.3547 49.2052 29.7115L51.5117 27.2154C51.9426 27.7195 52.4641 28.1383 53.0493 28.45C53.5167 28.7286 54.044 28.8908 54.587 28.9231C55.0117 28.9444 55.431 28.8195 55.7749 28.5692C56.0475 28.3842 56.2148 28.0795 56.2246 27.75C56.2246 27.1756 55.6839 26.6167 54.6024 26.0731L53.3492 25.4462C50.9504 24.2359 49.7511 22.7218 49.7511 20.9038C49.7421 19.751 50.2379 18.652 51.108 17.8962C52.0566 17.048 53.2965 16.6 54.5678 16.6462C56.4938 16.6356 58.3085 17.5478 59.4499 19.1H59.4537V19.1ZM76.7909 20.0269L73.6925 21.7308C73.2102 21.1938 72.6227 20.7618 71.9664 20.4615C71.3299 20.2132 70.6506 20.0929 69.9675 20.1077C68.7197 20.0532 67.5023 20.5021 66.5885 21.3538C65.7249 22.1865 65.2554 23.3469 65.2968 24.5462C65.2593 25.7009 65.7101 26.818 66.5385 27.6231C67.4181 28.4527 68.5943 28.8934 69.8022 28.8462C71.468 28.8462 72.7647 28.2782 73.6925 27.1423L76.6294 29.1538C75.0379 31.2231 72.7929 32.2577 69.8944 32.2577C67.2855 32.2577 65.243 31.4885 63.7669 29.95C62.0433 28.2166 61.2434 25.7682 61.6111 23.351C61.9788 20.9338 63.4704 18.8342 65.6313 17.6923C66.9642 16.9834 68.4542 16.6223 69.9636 16.6423C71.3368 16.6202 72.6959 16.9219 73.9308 17.5231C75.0824 18.0993 76.0671 18.9614 76.7909 20.0269V20.0269ZM85.9592 16.6423C87.3446 16.6383 88.7065 17.0005 89.9071 17.6923C92.3394 19.0602 93.8401 21.6392 93.8282 24.4308C93.8343 25.8089 93.4748 27.164 92.7864 28.3577C92.1192 29.5512 91.1398 30.5404 89.9532 31.2192C88.7454 31.9081 87.3763 32.2638 85.9861 32.25C83.9339 32.2809 81.961 31.4576 80.5389 29.9769C79.0605 28.5257 78.2444 26.5295 78.2824 24.4577C78.2631 20.1813 81.6968 16.6909 85.9707 16.6423H85.9592ZM86.0207 20.15C84.9307 20.1248 83.8813 20.5637 83.1337 21.3577C82.3562 22.1894 81.9413 23.2965 81.9805 24.4346C81.9329 25.5925 82.3478 26.7218 83.1337 27.5731C83.8801 28.3679 84.9311 28.8047 86.0207 28.7731C87.1198 28.803 88.179 28.3606 88.9307 27.5577C89.7153 26.7118 90.1304 25.5877 90.0839 24.4346C90.1286 23.2875 89.7135 22.1701 88.9307 21.3308C88.1729 20.5407 87.1145 20.1112 86.0207 20.15V20.15ZM96.1039 17.0269H99.8673V24.1731C99.8192 25.1485 99.915 26.1257 100.152 27.0731C100.319 27.5805 100.642 28.022 101.074 28.3346C101.535 28.6459 102.083 28.8035 102.639 28.7846C103.199 28.803 103.75 28.6486 104.219 28.3423C104.671 28.0218 105.009 27.5649 105.184 27.0385C105.338 26.6103 105.414 25.6962 105.414 24.2962V17.0269H109.136V23.3154C109.136 25.9077 108.931 27.6808 108.521 28.6346C108.076 29.7372 107.305 30.677 106.31 31.3269C105.189 31.989 103.901 32.3135 102.601 32.2615C100.973 32.2615 99.6572 31.8974 98.6526 31.1692C97.6312 30.4159 96.8867 29.3466 96.5344 28.1269C96.2474 27.2192 96.1039 25.5782 96.1039 23.2038V17.0269V17.0269ZM111.6 17.0269H114.79V18.8962C115.085 18.2207 115.562 17.6402 116.167 17.2192C116.721 16.8431 117.376 16.6433 118.046 16.6462C118.574 16.6571 119.092 16.7887 119.561 17.0308L118.408 20.2385C118.078 20.051 117.71 19.9393 117.331 19.9115C116.757 19.9115 116.273 20.2667 115.878 20.9769C115.484 21.6872 115.286 23.0782 115.286 25.15V31.8692H111.592L111.6 17.0269V17.0269ZM130.098 19.1L127.791 21.4077C126.856 20.4692 126.006 20 125.243 20C124.896 19.9798 124.552 20.073 124.262 20.2654C124.042 20.4135 123.909 20.6613 123.909 20.9269C123.91 21.1332 123.9
<path id="Vector_2" d="M20.1318 7.59232C15.8502 7.59484 11.8857 9.851 9.69513 13.5317C7.50455 17.2125 7.41103 21.7748 9.44893 25.5423L7.25008 32.6192L15.146 30.8346C19.6675 32.8728 24.9732 31.9574 28.5513 28.5218C32.1293 25.0861 33.2617 19.8198 31.4122 15.216C29.5627 10.6121 25.1026 7.59474 20.1434 7.59232H20.1318Z" fill="#FFF9AE"/>
<path id="Vector_3" d="M29.6336 27.2746C26.1821 31.631 20.2162 33.089 15.146 30.8154L7.25008 32.6231L15.2882 31.6731C20.6169 34.7962 27.4397 33.4221 31.1455 28.4793C34.8514 23.5366 34.2609 16.5985 29.773 12.3539C33.1425 16.774 33.0852 22.9182 29.6336 27.2746Z" fill="#00AEEF"/>
<path id="Vector_4" d="M28.9538 24.9649C25.9759 29.6579 20.195 31.7313 14.9153 30L7.25008 32.6231L15.146 30.8346C20.7694 33.3761 27.4038 31.2957 30.5714 25.9975C33.7391 20.6993 32.4334 13.8669 27.5357 10.1115C31.3478 14.1556 31.9318 20.2719 28.9538 24.9649Z" fill="#00A94F"/>
<path id="Vector_5" d="M10.1755 25.8115C7.97481 20.5042 9.78838 14.38 14.5236 11.1286C19.2587 7.87732 25.6224 8.38675 29.7807 12.35C25.9295 7.29344 18.8349 6.05917 13.5038 9.51827C8.17273 12.9774 6.40532 19.9618 9.44893 25.5423L7.25008 32.6192L10.1755 25.8115Z" fill="#F15D22"/>
<path id="Vector_6" d="M9.44893 25.5423C6.71832 20.496 7.88621 14.2264 12.2504 10.5031C16.6147 6.77973 22.9867 6.61651 27.5357 10.1115C23.1721 5.51444 16.0102 5.04399 11.0833 9.03082C6.15639 13.0176 5.11863 20.1232 8.69932 25.3539L7.25392 32.6231L9.44893 25.5423Z" fill="#D0232B"/>
</g>
</g>
</svg>