Hanami Architecture

Transcript

1. ❤
 
 Hello Minsk!
 
 ❤
2. Anton Davydov github.com/davydovanton
 twitter.com/anton_davydov davydovanton.com
3. Stickers
6. Architecture
8. Why?
9. Trying to unify architecture ideas for hanami projects
10. Getting feedback
11. Problems
12. Management Performance Maintenance
13. Management Performance Maintenance
14. Clean code Good architecture Maintainable product Pretty code
16. Clean code Good architecture Maintainable product Pretty code
17. What do we really want?
18. To add new features
19. Isolation Sequential logic No global state
20. Delete (refactoring) old code
21. Isolation Test coverage
22. Conclusions
23. Isolation Sequential logic No global state
 Test coverage
24. But we live in a real world
25. class InstitutionsController < ApplicationController load_and_authorize_resource :only => [:destroy,:edit,:new,:create,:update] before_filter :authenticate_user!, :except => [:student_registration, :show, :validate_registration_pin, :result, :admission, :buy_registration_pin,:paygate_callback_failure, :paygate_cancel, :paygate_pending, :paygate_callback_success, :pin_transaction_info_print] before_filter :find_institution, :except => [:show,:index, :new, :create, :semesters_for_institute_type, :start_end_date_for_assessment_period, :courses_for_batch, :paygate_callback_failure, :paygate_cancel, :paygate_pending, :paygate_callback_success, :pin_transaction_info_print] before_filter :add_bread_crumb,:except => [:show] def paygate_callback_success @pay_gate_config = YAML::load(File.open("#{Rails.root}/config/pay_gate_config.yml"))[Rails.env] @payment = TransactionRecord.find_by_order_number(params[:OrderID]) uri = URI("https://fidelitypaygate.fidelitybankplc.com/cipg/MerchantServices/UpayTransactionStatus.ashx") parameters = {:MERCHANT_ID => "#{@pay_gate_config['merchant_id']}", :ORDER_ID => "#{@payment.order_number}"} uri.query = URI.encode_www_form(parameters) result =open(uri).read result_hash = Hash.from_xml(result) record_payment_details(result_hash) if result_hash["CIPG"]["StatusCode"] == PaymentRecord::PAYMENT_SUCCESS_CODE if @payment.transactionable_type.eql?("PaymentRecord") redirect_to institution_fees_path(@payment.transactionable_type.fee.institution), :notice => "Payment transaction has been #{result_hash['CIPG']['Status']}" elsif @payment.transactionable_type.eql?("PinBuyerInfo") unless @payment.transactionable.pin_id.present? @registration = @payment.transactionable.registration @valid_registration_pin_groups = @registration.valid_registration_pin_groups @online_valid_registration_pin_groups = @valid_registration_pin_groups.where(:pin_available_type => 'Online') @offline_valid_registration_pin_groups = @valid_registration_pin_groups.where(:pin_available_type => 'Offline') @available_pin = nil @online_valid_registration_pin_groups.each do |vpg| if vpg.available_pins.present? @available_pin = vpg.available_pins.first break else next end end if !@available_pin.present? @offline_valid_registration_pin_groups.each do |vpg| if vpg.available_pins.present? @available_pin = vpg.available_pins.first break else next end end end if @available_pin.present? @payment.transactionable.pin_id = @available_pin.id @payment.transactionable.save @available_pin.is_available = false @available_pin.save @available_pin.reload if @available_pin.pin_group.pin_available_type == 'Offline' @message = "Your Order Number is #{@payment.order_number}. Please Print Transaction report to claim you PIN from Institution." else @assigned_pin = @available_pin.number @message = "Your PIN is #{@assigned_pin}. Please keep this PIN secret." end else @message = "No pin available for #{@registration.name}. Your order number is #{@payment.order_number}.Please contact with institution to get your money back if you have paid." end else pin = Pin.find @payment.transactionable.pin_id if(pin.present? && pin.pin_group.pin_available_type == 'Offline')
26. How can we improve the situation?
28. Abstraction Actions
29. class InstitutionsController < ApplicationController load_and_authorize_resource :only => [:destroy,:edit,:new,:create,:update] before_filter :authenticate_user!, :except => [:student_registration, :show, :validate_registration_pin, :result, :admission, :buy_registration_pin,:paygate_callback_failure, :paygate_cancel, :paygate_pending, :paygate_callback_success, :pin_transaction_info_print] before_filter :find_institution, :except => [:show,:index, :new, :create, :semesters_for_institute_type, :start_end_date_for_assessment_period, :courses_for_batch, :paygate_callback_failure, :paygate_cancel, :paygate_pending, :paygate_callback_success, :pin_transaction_info_print] before_filter :add_bread_crumb,:except => [:show] def paygate_callback_success @pay_gate_config = YAML::load(File.open("#{Rails.root}/config/pay_gate_config.yml"))[Rails.env] @payment = TransactionRecord.find_by_order_number(params[:OrderID]) uri = URI("https://fidelitypaygate.fidelitybankplc.com/cipg/MerchantServices/UpayTransactionStatus.ashx") parameters = {:MERCHANT_ID => "#{@pay_gate_config['merchant_id']}", :ORDER_ID => "#{@payment.order_number}"} uri.query = URI.encode_www_form(parameters) result =open(uri).read result_hash = Hash.from_xml(result) record_payment_details(result_hash) if result_hash["CIPG"]["StatusCode"] == PaymentRecord::PAYMENT_SUCCESS_CODE if @payment.transactionable_type.eql?("PaymentRecord") redirect_to institution_fees_path(@payment.transactionable_type.fee.institution), :notice => "Payment transaction has been #{result_hash['CIPG']['Status']}" elsif @payment.transactionable_type.eql?("PinBuyerInfo") unless @payment.transactionable.pin_id.present? @registration = @payment.transactionable.registration @valid_registration_pin_groups = @registration.valid_registration_pin_groups @online_valid_registration_pin_groups = @valid_registration_pin_groups.where(:pin_available_type => 'Online') @offline_valid_registration_pin_groups = @valid_registration_pin_groups.where(:pin_available_type => 'Offline') @available_pin = nil @online_valid_registration_pin_groups.each do |vpg| if vpg.available_pins.present? @available_pin = vpg.available_pins.first break else next end end if !@available_pin.present? @offline_valid_registration_pin_groups.each do |vpg| if vpg.available_pins.present? @available_pin = vpg.available_pins.first break else next end end end if @available_pin.present? @payment.transactionable.pin_id = @available_pin.id @payment.transactionable.save @available_pin.is_available = false @available_pin.save @available_pin.reload if @available_pin.pin_group.pin_available_type == 'Offline' @message = "Your Order Number is #{@payment.order_number}. Please Print Transaction report to claim you PIN from Institution." else @assigned_pin = @available_pin.number @message = "Your PIN is #{@assigned_pin}. Please keep this PIN secret." end else @message = "No pin available for #{@registration.name}. Your order number is #{@payment.order_number}.Please contact with institution to get your money back if you have paid." end else pin = Pin.find @payment.transactionable.pin_id if(pin.present? && pin.pin_group.pin_available_type == 'Offline')
30. MVC V and C MVC
31. Solutions?
32. Abstraction Functional (callable) objects
33. Services Interactors dry-transactions Operations Etc.
34. t.me/pepegramming
35. def call(params) result = FuncObject.new.call(params) if result[:successful] flash[:info] = INFO_MESSAGE redirect_to routes.tasks_path else self.body = … end end
36. def call(params) result = FuncObject.new.call(params) if result.successful? flash[:info] = INFO_MESSAGE redirect_to routes.tasks_path else self.body = … end end
37. def call(params) FuncObject.new.call(params) do |m| m.successful? do |value| flash[:info] = INFO_MESSAGE redirect_to routes.tasks_path end m.failed? do |value| self.body = … end end end
38. Isolation
39. def call(params) result = FuncObject.new.call(params) if result.successful? flash[:info] = INFO_MESSAGE redirect_to routes.tasks_path else self.body = … end end
40. def call(params) result = FuncObject.new.call(params) if result.successful? flash[:info] = INFO_MESSAGE redirect_to routes.tasks_path else self.body = … end end
41. def call(params) result = FuncObject.new.call(params) if result.successful? flash[:info] = INFO_MESSAGE redirect_to routes.tasks_path else self.body = … end end
42. Logic sequence
43. class Create include Dry::Transaction include Platform::Matcher Dry::Validation.load_extensions(:monads) VALIDATOR = Platform::Validation.JSON do # ... end step :extract step :validate step :create def extract(attributes) # ... end def validate(attributes) VALIDATOR.call(attributes).to_either end
44. class Create include Dry::Transaction include Platform::Matcher Dry::Validation.load_extensions(:monads) VALIDATOR = Platform::Validation.JSON do # ... end step :extract step :validate step :create def extract(attributes) # ... end def validate(attributes) VALIDATOR.call(attributes).to_either end
45. class Interactor def call(paload) extract! validate! create! end # … end
46. No global state
47. def call(params) result = FuncObject.new.call(params) if result.successful? flash[:info] = INFO_MESSAGE redirect_to routes.tasks_path else self.body = … end end
48. Easy testing
49. def initialize(object: FuncObject.new) @object = object end def call(params) result = @object.call(params) if result.successful? flash[:info] = INFO_MESSAGE redirect_to routes.tasks_path else self.body = … end end
50. def initialize(object: FuncObject.new) @object = object end def call(params) result = @object.call(params) if result.successful? flash[:info] = INFO_MESSAGE redirect_to routes.tasks_path else self.body = … end end Dependency Injection ❤
51. let(:action) { Create.new(object: SuccessObject.new) } it { expect(action.call(params).to eq ... }
 
 let(:action) { Create.new(object: FailedObject.new) } it { expect(action.call(params).to eq ... }
52. let(:other_object) { -> (_) { nil } }
 let(:object) { Create.new(object: other_object) } it { expect(action.call(params).to eq ... }
53. But objects
 can call other objects
54. Actions Interactors Libs Objects (public) (private)
55. Problems
56. So many objects,
 how to manage it?
57. Long names for objects — like: 
 Interactors::CreateUserWithTask
 Interactors::Module::CreateUserWithTask
 Interactors::Module::Module::CreateUserWithTask
58. We have to initialize instances every time
59. Containers!
60. Abstraction Containers
61. Dry-container
62. When someone tries to sell me dry-rb
63. Container = Dry::Container.new Container.register('interactors.create_user', Interactors::CreateUser.new) Container['interactors.create_user'] # => Interactors::CreateUser instance Container['interactors.create_user'].call(...)
64. Container = Dry::Container.new Container.register('interactors.create_user', Interactors::CreateUser.new) Container['interactors.create_user'] # => Interactors::CreateUser instance Container['interactors.create_user'].call(...)
65. Container = Dry::Container.new Container.register('interactors.create_user', Interactors::CreateUser.new) Container['interactors.create_user'] # => Interactors::CreateUser instance Container['interactors.create_user'].call(...)
66. def call(params) result = Container['interactors.create_user'].call(params) if result[:successful] flash[:info] = INFO_MESSAGE redirect_to routes.tasks_path else self.body = … end end
67. Pros Controlled global state
 (in one place) Memorizing instances Mocs for testing Resolving deps on booting project
68. t.me/pepegramming
69. But we can use it better!
70. Abstraction Dry-auto_inject
71. When someone tries to sell me dry-rb
72. Why?
73. Dependency injection on steroids
74. Import = Dry::AutoInject(Container)
75. include Import[‘interactors.create_user']
 
 def call(params) result = create_user.call(params) if result[:successful] flash[:info] = INFO_MESSAGE redirect_to routes.tasks_path else self.body = … end end
76. include Import[‘interactors.create_user']
 
 def call(params) result = create_user.call(params) if result[:successful] flash[:info] = INFO_MESSAGE redirect_to routes.tasks_path else self.body = … end end Dependency Injection ❤
77. include Import[‘interactors.create_user']
 
 def call(params) result = create_user.call(params) if result[:successful] flash[:info] = INFO_MESSAGE redirect_to routes.tasks_path else self.body = … end end
78. let(:action) { Create.new(create_user: MockObject.new) } it { expect(action.call(params).to eq ... }
79. Abstraction Models
80. MVC V and C MVC
81. What can we do with it?
82. No logic
83. No validations
84. Just save and load data
85. Query objects
86. Query objects Repositories
88. Changesets
 or
 Command pattern (?)
89. Drop callbacks
90. Sequential logic
91. Examples
92. class CreateUser include Import['repos.user_repo'] def call(payload) user_repo.create(payload.merge(created_on: Date.today end end CreateUser.new.call(user_data)
94. Abstraction Applications
95. Rails App #1 Model
 Services
96. Rails App #2 Model
 Services Rails App #1 Model
 Services
97. Rails App #1 Rails App #2 Model
 Services
98. Rails App #1 Rails App #2 Model
 Services Rails App #3 Model
 Services
99. Rails App #1 Rails App #3 Rails App #2 Model
 Services
101. App App App lib
102. App App App lib Shared between apps
104. Actions Interactors Libs (public) (private)
105. Apps Interactors Libs (public) (private)
106. web
 admin #1
 admin #2 ==> business
 api logic
 mobile
107. App App App lib One server instance
108. App App App lib One server instance App App App lib App App App lib App App App lib App App App lib App App App lib App App App lib App App App lib
109. Problems?
110. Hard
 not to forgot
 about other apps
111. Sometimes
 you have to use
 another logic
113. Warning: Advanced level You can build projects without it
114. Abstraction Domains
115. DDD
117. Separate domains for different business values
118. Each domain isolated from others
119. pros easy to create separated services: just replace code domains + containers = ❤
120. cons hard to start so much files™
122. http is a small part
 of system
124. websockets rack background processing
 ETL
 …
125. They all use business logic
127. System consists
 of the different events
129. User created Post created User updated
 Payment added Order completed …
130. Abstraction Event Sourcing
135. Events
136. Event
 log
137. Event
 log
138. Event
 log
139. But we need to calculate all events for get current state
140. CQRS
 
 (Command Query Responsibility Segregation)
141. – Martin Fowler “You can use a different model to update information than the model you use to read information”
142. Event log
143. Event log SQL Elastic NoSql
144. Event log SQL Elastic NoSql Current State
145. Event log SQL Elastic NoSql Current State Current State
146. Event log SQL Elastic NoSql Current State Current State App App App lib App App App lib
147. Pros • Each service isolated • All processing is in the background • Easy to add instances for service • Can be written on any language and you can call it from any app • Persistance
148. Cons • Hard to understand the whole chain of events • Complicated • Another architecture type
 with different DB structure • Not popular in ruby
149. How to start to use it
151. github.com/RailsEventStore/rails_event_store
152. hanami-events
153. Proof of concept
154. Just transport layer with event versions and types
155. Conclusions
156. Isolate it
157. Don’t use anything
 having no idea
 why do you need it
158. Maintenance is important
159. github.com/davydovanton/hanami-architecture
160. t.me/pepegramming
161. github.com/davydovanton
 twitter.com/anton_davydov davydovanton.com Thank you ❤