strum-esb 0.3.3 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5eed53438b480b0f9f2faae4b2662dfb7005441bd74f62b15986d4eefeefbe7e
-  data.tar.gz: c8f52bbfc3955ca0735d1536e99fc07238ef6a823b84e602a242fad9b690646c
+  metadata.gz: 71859024cac83efb0fe65d36972bc59e3a36aa909b8dd01c3a048e1c302c6af2
+  data.tar.gz: 3c85a148cdd144bd1f7dab17cece39d33f2dea8ea17813a77353cf4cadbe2ecc
 SHA512:
-  metadata.gz: c4eb4852df47c231e43218243178582e860f3dc553b06f5f8f32165b27c4a7d2448f01ac690b59617b4e724927db4224b9311791df77a8aff3a70ada43b3f9a0
-  data.tar.gz: c0a6ce6875f528459031905df09bdcccc1cc1fa34e6ed6eecfa5863647b8d711b38879f8c13afb1ff915c7ce642a92637bfc7bc559df40921cd30761baab2c53
+  metadata.gz: d94e6c04dc46f018558bb04b1edc16108cab4199e15eaebef3c3520d3e334828150dd524c02ce8005cc8f503207af7ff19c1f6d09ca98462ca0d4889cc4897e9
+  data.tar.gz: '09c5454b9283ce7b6c4be64d804bfe8b42894fb52afae00c3296107172cbe3be1841caaed160888b9ba5c3b12d41493b76b4a9fe451d714eaf05f7f7a63fdb47'

data/.gitignore

@@ -10,6 +10,9 @@
 # rspec failure tracking
 .rspec_status
 
+.ruby-gemset
+.ruby-version
+
 # Editor directories and files
 .idea
 .vscode

data/.rubocop.yml

@@ -23,4 +23,14 @@ Style/StringLiterals:
 
 Metrics/LineLength:
   Max: 120
-  IgnoredPatterns: ['\A#']
+  AllowedPatterns: ['\A[^#].*']
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'

data/Gemfile

@@ -6,9 +6,10 @@ source "https://rubygems.org"
 gemspec
 
 gem "bundler", "~> 2.1.4"
-gem "rspec", "~> 3"
-gem "rubocop", "~> 1.15"
-gem "rubocop-rspec", "~> 2.3.0"
+gem "rspec", "~> 3.12.0"
+gem "rubocop", "~> 1.49.0"
+gem "rubocop-rspec", "~> 2.19"
+gem "simplecov", "~> 0.22.0"
 
 gem "debase", "~> 0.2.5.beta2"
 gem "ruby-debug-ide", "~> 0.7.2"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    strum-esb (0.3.3)
+    strum-esb (0.4.1)
       bunny (~> 2.15)
       connection_pool (~> 2.2.2)
       dry-configurable (~> 0.12.1)
@@ -14,64 +14,75 @@ GEM
   specs:
     amq-protocol (2.3.2)
     ast (2.4.2)
-    bunny (2.19.0)
+    bunny (2.20.3)
       amq-protocol (~> 2.3, >= 2.3.1)
       sorted_set (~> 1, >= 1.0.2)
-    concurrent-ruby (1.1.10)
+    concurrent-ruby (1.2.2)
     connection_pool (2.2.5)
     debase (0.2.5.beta2)
       debase-ruby_core_source (>= 0.10.12)
     debase-ruby_core_source (0.10.14)
     diff-lcs (1.5.0)
+    docile (1.4.0)
     dry-configurable (0.12.1)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.5, >= 0.5.0)
-    dry-core (0.7.1)
+    dry-core (0.9.1)
       concurrent-ruby (~> 1.0)
+      zeitwerk (~> 2.6)
     dry-inflector (0.2.1)
     json (2.6.2)
     parallel (1.22.1)
-    parser (3.1.1.0)
+    parser (3.2.2.0)
       ast (~> 2.4.1)
     rainbow (3.1.1)
     rake (12.3.3)
-    rbtree (0.4.5)
-    regexp_parser (2.2.1)
+    rbtree (0.4.6)
+    regexp_parser (2.7.0)
     rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.26.1)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.49.0)
+      json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.0.0)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.16.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.16.0)
-      parser (>= 3.1.1.0)
-    rubocop-rspec (2.3.0)
-      rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.17.1)
+      rubocop (~> 1.41)
+    rubocop-rspec (2.19.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
     ruby-debug-ide (0.7.3)
       rake (>= 0.8.1)
-    ruby-progressbar (1.11.0)
+    ruby-progressbar (1.13.0)
     serverengine (2.1.1)
       sigdump (~> 0.2.2)
-    set (1.0.2)
+    set (1.0.3)
     sigdump (0.2.4)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
     sneakers (2.12.0)
       bunny (~> 2.14)
       concurrent-ruby (~> 1.0)
@@ -82,7 +93,8 @@ GEM
       rbtree
       set (~> 1.0)
     thor (1.2.1)
-    unicode-display_width (2.1.0)
+    unicode-display_width (2.4.2)
+    zeitwerk (2.6.7)
 
 PLATFORMS
   ruby
@@ -91,10 +103,11 @@ DEPENDENCIES
   bundler (~> 2.1.4)
   debase (~> 0.2.5.beta2)
   dry-inflector (~> 0.2.1)
-  rspec (~> 3)
-  rubocop (~> 1.15)
-  rubocop-rspec (~> 2.3.0)
+  rspec (~> 3.12.0)
+  rubocop (~> 1.49.0)
+  rubocop-rspec (~> 2.19)
   ruby-debug-ide (~> 0.7.2)
+  simplecov (~> 0.22.0)
   strum-esb!
 
 BUNDLED WITH

data/README.md

@@ -106,8 +106,9 @@ module Queues
   class Resource
     include Strum::Esb::Handler
 
-    json false
-    protobuf_service Test::Router::Service
+    enable_json          false
+    enable_protobuf      true
+    use_protobuf_service Test::Router::Service
     from_queue "resource-queue",
                bindings: {
                  events: %w[user/create user/update],
@@ -125,12 +126,24 @@ Your rpc action must have the same name as your method in queue class, for examp
 
 3. Pass content type as additional param when you send Strum::Esb message:
 ```ruby
-Strum::Esb::Action.call("payload", "action", "resource", content_type: "application/x-protobuf")
+message = { id: 10 }
+args = {
+  content_type: "application/x-protobuf",
+  message_class: Messages::ActionGetUser
+}
+Strum::Esb::Action.call(message, "action", "resource", **args)
 ```
-or add it as before_publish_hook:
+
+4. Configure proto serialization/deserialization:
 ```ruby
-Strum::Esb.config.before_publish_hooks << lambda { |_body, properties|
-  properties[:content_type] = "application/x-protobuf"
+Strum::Esb.config.serializer_conf = {
+  to_proto: proc do |message_class, payload|
+              ::CustomSerializer.to_protobuf(message_class, payload).to_proto
+            end,
+  from_proto: proc do |message_class, encoded_payload|
+                rpc_instance = message_class.decode(encoded_payload)
+                ::CustomSerializer.from_protobuf(rpc_instance)
+              end
 }
 ```
 

data/lib/strum/esb/functions.rb

@@ -18,7 +18,7 @@ module Strum
 
         def notice_explain(source)
           exchange, resource_notice = source.include?(":") ? source.split(":") : [Strum::Esb.config.notice_exchange, source]
-          resource, notice  = resource_notice.split("/")
+          resource, notice = resource_notice.split("/")
           [exchange, resource, notice]
         end
 

data/lib/strum/esb/handler.rb

@@ -12,6 +12,7 @@ module Strum
           include Sneakers::Worker
         end
         base.extend ClassMethods
+        base.use_application_config
       end
 
       module ClassMethods
@@ -22,16 +23,16 @@ module Strum
             yield(bindings)
           else
             bindings[message_type] ||= []
-            bindings[message_type] << message_binding  
+            bindings[message_type] << message_binding
           end
 
           from_queue queue, bindings: bindings
-          handlers[handler_key(message_type, message_binding)] = handler.to_s if handler          
+          handlers[handler_key(message_type, message_binding)] = handler.to_s if handler
         end
 
         def handler_key(message_type, message_binding)
           _, *msg = Strum::Esb::Functions.public_send("#{message_type}_explain", message_binding)
-          params = msg.map{ |param| param&.to_s.gsub(/[^a-zA-Z0-9]/, "_")&.downcase }
+          params = msg.map { |param| param&.to_s&.gsub(/[^a-zA-Z0-9]/, "_")&.downcase }
           ([message_type] + params).join("-")
         end
 
@@ -39,12 +40,47 @@ module Strum
           @handlers ||= {}
         end
 
-        def protobuf_service(service)
-          Strum::Esb.config.protobuf_service = service
+        def enable_json(switcher)
+          @json_mode = switcher
         end
 
-        def json(switcher)
-          Strum::Esb.config.json = switcher
+        def json_enabled?
+          @json_mode
+        end
+
+        def enable_protobuf(switcher)
+          @protobuf_mode = switcher
+        end
+
+        def protobuf_enabled?
+          @protobuf_mode
+        end
+
+        def content_type_enabled?(content_type)
+          case content_type
+          when "application/json"
+            json_enabled?
+          when "application/x-protobuf"
+            protobuf_enabled?
+          else
+            false
+          end
+        end
+
+        def use_protobuf_service(service)
+          raise ArgumentError, "#{service} must be a grpc service" unless service.respond_to?(:rpc_descs)
+
+          @protobuf_service = service
+          enable_protobuf(true)
+        end
+
+        def protobuf_service
+          @protobuf_service
+        end
+
+        def use_application_config
+          enable_json(Strum::Esb.config.enable_json)
+          enable_protobuf(Strum::Esb.config.enable_protobuf)
         end
       end
 
@@ -85,12 +121,14 @@ module Strum
 
         content_type = metadata[:content_type] || "application/json"
 
-        unless Strum::Esb.config.serializer.enabled?(content_type)
+        unless self.class.content_type_enabled?(content_type)
           logger.error "Content type #{content_type} is disabled by handler. Message rejected #{metadata[:headers]} with payload #{deserialized_msg}"
           return reject!
         end
 
-        payload, valid_payload = Strum::Esb.config.serializer.deserialize(deserialized_msg, content_type, method_name)
+        args = { queue_method_name: method_name, grpc_service: self.class.protobuf_service, content_type: content_type }
+
+        payload, valid_payload = Strum::Esb.config.serializer.deserialize(deserialized_msg, args: args)
 
         unless valid_payload
           logger.error "Payload was unable to be parsed with #{content_type} content type. Message rejected #{metadata[:headers]} with payload #{payload}"
@@ -100,9 +138,12 @@ module Strum
         error = nil
         method_params = method(method_name)
                         .parameters
-                        .map { |param| _, param_name = param; param_name }
+                        .map do |param|
+                          _, param_name = param
+                          param_name
+                        end
                         .then { |m| m & %I[action resource event state info pipeline pipeline_id] }
-        handler_params = method_params.each_with_object({}) { |i, res| res[i] = eval(i.to_s); }
+        handler_params = method_params.each_with_object({}) { |i, res| res[i] = eval(i.to_s) }
         logger.info("Handler #{method_name} found. Payload: #{payload}")
         handler_params.count.positive? ? send(method_name, payload, handler_params) : send(method_name, payload)
         logger.info("Handler #{method_name} executed")
@@ -153,7 +194,7 @@ module Strum
           result << "notice_#{notice}"
           result << "notice_handler"
           result
-        end        
+        end
     end
   end
 end

data/lib/strum/esb/message.rb

@@ -4,28 +4,60 @@ module Strum
   module Esb
     # Strum Message
     class Message
+      FROZEN_EXCHANGE_OPTIONS = { durable: true }.freeze
+
       class << self
-        def publish(exchange:, headers:, payload:, content_type: "application/json")
-          rabbit_exchange ||= Strum::Esb.config.rabbit_channel_pool.with { |rabbit_channel| rabbit_channel.headers(exchange, durable: true) }
-          properties = {
+        def publish(exchange:, headers:, payload:, exchange_options: {}, **args)
+          new(
+            exchange: exchange,
             headers: headers,
-            content_type: content_type
-          }
+            payload: payload,
+            exchange_options: exchange_options,
+            **args
+          ).publish
+        end
+      end
 
-          Strum::Esb.config.before_publish_hooks.each { |hook| hook.call(payload, properties) }
+      attr_reader :exchange,
+                  :headers,
+                  :payload,
+                  :args,
+                  :exchange_options,
+                  :rabbit_channel
 
-          properties[:headers] = {} unless properties[:headers].is_a?(Hash)
-          properties[:headers]["pipeline"] ||= Thread.current[:pipeline] if Thread.current[:pipeline]
-          properties[:headers]["pipeline-id"] ||= Thread.current[:pipeline_id] if Thread.current[:pipeline_id]
+      def initialize(exchange:, headers:, payload:, exchange_options: {}, **args)
+        @exchange         = exchange
+        @headers          = headers
+        @payload          = payload
+        @args             = args # { content_type: "application/x-protobuf", message_class: Messages::ActionGetUser }
+        # Sneakers::CONFIG[:exchange_options] = { type: "headers", durable: true, auto_delete: false, arguments: {} }
+        @exchange_options = Sneakers::CONFIG[:exchange_options].merge(exchange_options).merge(FROZEN_EXCHANGE_OPTIONS)
+        @rabbit_channel   = Strum::Esb.config.rabbit_channel_pool
+      end
 
-          payload, valid_payload = Strum::Esb.config.serializer.serialize(payload, properties[:content_type])
-          unless valid_payload
-            Sneakers.logger.error "Content type is invalid. Message rejected #{properties[:headers]} with payload #{payload}"
-            return
-          end
+      def publish
+        rabbit_exchange = rabbit_channel.with { |rabbit_channel| rabbit_channel.headers(exchange, exchange_options) }
+        payload, valid_payload, properties = prepare_publication_options
+        return unless valid_payload
 
-          rabbit_exchange.publish(payload, **properties)
-        end
+        rabbit_exchange.publish(payload, **properties)
+      end
+
+      def prepare_publication_options
+        properties = { headers: headers, content_type: args.fetch(:content_type, "application/json") }
+
+        Strum::Esb.config.before_publish_hooks.each { |hook| hook.call(payload, properties) }
+        extend_headers(properties)
+        args.merge!(properties)
+
+        # [serialized_payload, valid, properties]
+        [*Strum::Esb.config.serializer.serialize(payload, args: args), properties]
+      end
+
+      def extend_headers(properties)
+        properties[:headers] = {} unless properties[:headers].is_a?(Hash)
+        properties[:headers]["pipeline"] ||= Thread.current[:pipeline] if Thread.current[:pipeline]
+        properties[:headers]["pipeline-id"] ||= Thread.current[:pipeline_id] if Thread.current[:pipeline_id]
       end
     end
   end

data/lib/strum/esb/serializer.rb

@@ -7,28 +7,20 @@ module Strum
       CONTENT_TYPES = %w[application/json application/x-protobuf].freeze
 
       %i[serialize deserialize].each do |base_method|
-        define_method base_method do |payload, content_type, queue_method_name = nil|
-          return [payload, false] unless valid_content_type?(content_type)
+        define_method base_method do |payload, args: {}|
+          content_type = args.fetch(:content_type)
+          raise ArgumentError, "invalid content_type" unless valid_content_type?(content_type)
 
           perform_method_name = content_type_method_name(base_method, content_type)
-          payload = send(*[perform_method_name, payload, queue_method_name].compact)
+          payload = send(perform_method_name, payload, args: args)
           [payload, true]
-        rescue StandardError
+        rescue StandardError => e
+          Sneakers.logger.error(e.inspect)
+          Sneakers.logger.error "Content type is invalid. Message rejected #{args[:headers]} with payload #{payload}"
           [payload, false]
         end
       end
 
-      def enabled?(content_type)
-        case data_type(content_type)
-        when "json"
-          Strum::Esb.config.json
-        when "protobuf"
-          Strum::Esb.config.protobuf_service
-        else
-          false
-        end
-      end
-
       private
 
         def valid_content_type?(content_type)
@@ -43,22 +35,26 @@ module Strum
           content_type.gsub("-", "/").split("/").last
         end
 
-        def deserialize_json(payload, _queue_method_name)
+        def deserialize_json(payload, args: {}) # rubocop:disable Lint/UnusedMethodArgument
           JSON.parse(payload)
         end
 
-        def deserialize_protobuf(payload, queue_method_name)
-          action_name = inflector.camelize(queue_method_name)
-          rpc_struct = Strum::Esb.config.protobuf_service.rpc_descs[action_name.to_sym]
-          rpc_struct.input.decode(payload)
+        def deserialize_protobuf(payload, args: {})
+          action_name = inflector.camelize(args.fetch(:queue_method_name))
+          message_class = args.fetch(:grpc_service).rpc_descs[action_name.to_sym].input
+
+          Strum::Esb.config.serializer_conf[:from_proto].call(message_class, payload)
         end
 
-        def serialize_json(payload)
+        def serialize_json(payload, args: {}) # rubocop:disable Lint/UnusedMethodArgument
           payload.to_json
         end
 
-        def serialize_protobuf(payload)
-          payload
+        def serialize_protobuf(payload, args: {})
+          return payload unless args.key?(:message_class)
+
+          message_class = args.fetch(:message_class)
+          Strum::Esb.config.serializer_conf[:to_proto].call(message_class, payload)
         end
 
         def inflector

data/lib/strum/esb/version.rb

@@ -2,6 +2,6 @@
 
 module Strum
   module Esb
-    VERSION = "0.3.3"
+    VERSION = "0.4.1"
   end
 end

data/lib/strum/esb.rb

@@ -29,20 +29,29 @@ module Strum
     setting :action_exchange, "strum.actions"
     setting :notice_exchange, "strum.notice"
     setting :rabbit_channel_pool, begin
-                                    ConnectionPool.new(size: 5, timeout: 5) do
-                                      rabbit_connection = Bunny.new
-                                      rabbit_connection.start
-                                      rabbit_connection.create_channel
-                                    end
-                                  end
+      ConnectionPool.new(size: 5, timeout: 5) do
+        rabbit_connection = Bunny.new
+        rabbit_connection.start
+        rabbit_connection.create_channel
+      end
+    end
     setting :before_fork_hooks, []
     setting :after_fork_hooks, []
     setting :before_publish_hooks, []
     setting :before_handler_hooks, []
     setting :after_handler_hooks, []
+
     setting :serializer, Serializer.new
-    setting :protobuf_service, false
-    setting :json, true
+    setting :enable_json, true
+    setting :enable_protobuf, false
+    setting :serializer_conf, {
+      to_proto: proc do |message_class, payload|
+                  message_class.new(payload).to_proto
+                end,
+      from_proto: proc do |message_class, encoded_payload|
+                    message_class.decode(encoded_payload)
+                  end
+    }
 
     Strum::Esb.config.before_fork_hooks << proc { DB.disconnect } if defined?(DB)
 
@@ -56,12 +65,12 @@ module Strum
         @app = app
         @args = args
       end
-    
+
       def call(deserialized_msg, delivery_info, metadata, handler)
-        Thread.current.keys.each{ |key| Thread.current[key] = nil }
+        Thread.current.keys.each { |key| Thread.current[key] = nil }
         @app.call(deserialized_msg, delivery_info, metadata, handler)
       end
-    end    
+    end
 
     Sneakers.configure(
       log: $stdout,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strum-esb
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.1
 platform: ruby
 authors:
 - Serhiy Nazarov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-18 00:00:00.000000000 Z
+date: 2023-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny