strum-esb 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ce4f150ec3058cd6296aadaba679e410a53b0b0f50843c0ec1d71f0c8ce5134
-  data.tar.gz: cc4a35c95f53aa9fdbc8b7b341aee355c513fab06d4af19240bb454b95d26ad9
+  metadata.gz: 115db6eaed48ee3c437b15fbf8103815214a5cdcc4d0d040960fc6ad73708190
+  data.tar.gz: dd0f567ec63c61781272ea0931a7348be7df38de6661b5d9da77ccf55e17855d
 SHA512:
-  metadata.gz: 804f610986a6b13f1948a3a4fea93fb53733c0693c7301a19fb0eba8ede1ed7d05549f7d3bd4d889264f5346c48bac7299597fd1aab740e3dfe5189750cd741b
-  data.tar.gz: 38cce564ca77e76433efdda7bea1b5566712c87f3d9abfba0debe102fe2933809afd0ecf6e3c71fbe7870d99383f4fc6ca3972234e0522036829a3e20eed827b
+  metadata.gz: 3275b5108de6e8f5ac0bf8413d8fb53e0939855c9621fb1ac054b5ae9ecc693ff368a5d55d5e794956f75f038ba106eb4c3452c377b273eda7e064f713b6b605
+  data.tar.gz: 679fc2e04636143bbfcceb7fba20cb79972475313ed2731977035b1ceb21ca981d77247b03fc668c92d3e809894edeae16e5b74f92afbde55b2d21a77f287c4d

data/.rubocop.yml

@@ -1,5 +1,6 @@
 AllCops:
   TargetRubyVersion: 2.6
+  NewCops: enable
 
 # Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
 Style/HashSyntax:

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.3.0] - 2022-03-14
+### Added
+- `content_type` option to send message by [@valeriia.kolisnyk]
+- serialization/deserialization for protobuf by [@valeriia.kolisnyk]
+- `json` and `protobuf_service` switchers for handler by [@valeriia.kolisnyk]
+
 ## [0.1.1] - 2021-06-01
 ### Added
 - `pre_publish_hooks` to configuration by [@Samuron]

data/Gemfile

@@ -8,7 +8,9 @@ gemspec
 gem "bundler", "~> 2.1.4"
 gem "rspec", "~> 3"
 gem "rubocop", "~> 1.15"
+gem "rubocop-rspec", "~> 2.3.0"
 
 gem "debase", "~> 0.2.4"
 gem "ruby-debug-ide", "~> 0.7.2"
 
+gem "dry-inflector", "~> 0.2.1"

data/Gemfile.lock

@@ -1,10 +1,11 @@
 PATH
   remote: .
   specs:
-    strum-esb (0.1.1)
+    strum-esb (0.3.0)
       bunny (~> 2.15)
       connection_pool (~> 2.2.2)
-      dry-configurable (~> 0.12)
+      dry-configurable (~> 0.12.1)
+      dry-inflector (~> 0.2.1)
       json (~> 2.3)
       sneakers (~> 2.12)
 
@@ -13,10 +14,10 @@ GEM
   specs:
     amq-protocol (2.3.2)
     ast (2.4.2)
-    bunny (2.18.0)
+    bunny (2.19.0)
       amq-protocol (~> 2.3, >= 2.3.1)
       sorted_set (~> 1, >= 1.0.2)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.9)
     connection_pool (2.2.5)
     debase (0.2.4.1)
       debase-ruby_core_source (>= 0.10.2)
@@ -25,15 +26,16 @@ GEM
     dry-configurable (0.12.1)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.5, >= 0.5.0)
-    dry-core (0.5.0)
+    dry-core (0.7.1)
       concurrent-ruby (~> 1.0)
-    json (2.5.1)
+    dry-inflector (0.2.1)
+    json (2.6.1)
     parallel (1.20.1)
     parser (3.0.1.1)
       ast (~> 2.4.1)
     rainbow (3.0.0)
     rake (12.3.3)
-    rbtree (0.4.4)
+    rbtree (0.4.5)
     regexp_parser (2.1.1)
     rexml (3.2.5)
     rspec (3.10.0)
@@ -60,12 +62,15 @@ GEM
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.6.0)
       parser (>= 3.0.1.1)
+    rubocop-rspec (2.3.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
     ruby-debug-ide (0.7.2)
       rake (>= 0.8.1)
     ruby-progressbar (1.11.0)
     serverengine (2.1.1)
       sigdump (~> 0.2.2)
-    set (1.0.1)
+    set (1.0.2)
     sigdump (0.2.4)
     sneakers (2.12.0)
       bunny (~> 2.14)
@@ -76,7 +81,7 @@ GEM
     sorted_set (1.0.3)
       rbtree
       set (~> 1.0)
-    thor (1.1.0)
+    thor (1.2.1)
     unicode-display_width (2.0.0)
 
 PLATFORMS
@@ -85,8 +90,10 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 2.1.4)
   debase (~> 0.2.4)
+  dry-inflector (~> 0.2.1)
   rspec (~> 3)
   rubocop (~> 1.15)
+  rubocop-rspec (~> 2.3.0)
   ruby-debug-ide (~> 0.7.2)
   strum-esb!
 

data/README.md

@@ -30,11 +30,28 @@ Strum::Esb.config.action_exchange = `demo.actions`
 Strum::Esb.config.notice_exchange = `demo.notice`
 ```
 
-Pre publish hooks allow you to configure custom code that will be able to modify properties of the message that will be published or execute any arbitrary logic
+Before publish hooks allow you to configure custom code that will be able to modify properties of the message that will be published or execute any arbitrary logic
 ```ruby
-Strum::Esb.config.pre_publish_hooks << ->(body, properties) { properties[:correlation_id] = "hello world" }
+Strum::Esb.config.before_publish_hooks << ->(body, properties) { properties[:correlation_id] = "hello world" }
 ```
 
+Before handler hooks allow you to inspect raw data before any processing has strated:
+```ruby
+Strum::Esb.config.before_handler_hooks << ->(deserialized_msg, delivery_info, metadata) do 
+  puts "We don't even know if msg is valid JSON, this is some text from RabbitMQ"
+  puts deserialized_msg
+end
+```
+
+After handler hook allows you to have insight on how handler was executed:
+```ruby
+Strum::Esb.config.after_handler_hooks << ->(deserialized_msg, delivery_info, metadata, payload, error) do 
+  puts "Message was deserialized succesfully" if payload
+  puts "Error occured" if error
+end
+```
+
+
 ### Sending message:
 
 ```ruby
@@ -77,6 +94,45 @@ module Queues
 end
 ```
 
+### Sending protobuf via strum-esb
+1. Encode your protobuf message using `encode` method to send it.
+2. Define `protobuf_service` in your handler, and disable `json`:
+
+```ruby
+require "strum/esb"
+require "contracts/test_pb"
+
+module Queues
+  class Resource
+    include Strum::Esb::Handler
+
+    json false
+    protobuf_service Test::Router::Service
+    from_queue "resource-queue",
+               bindings: {
+                 events: %w[user/create user/update],
+                 
+               }
+
+    def handler(payload)
+      # code here ...
+    end
+  end
+end
+```
+
+Your rpc action must have the same name as your method in queue class, for example: if method is `action_get_user`, rpc action needs to be `ActionGetUser`.
+
+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")
+```
+or add it as before_publish_hook:
+```ruby
+Strum::Esb.config.before_publish_hooks << lambda { |_body, properties|
+  properties[:content_type] = "application/x-protobuf"
+}
+```
 
 ## Development
 

data/lib/strum/esb/handler.rb

@@ -30,10 +30,18 @@ module Strum
         def handlers
           @handlers || {}
         end
+
+        def protobuf_service(service)
+          Strum::Esb.config.protobuf_service = service
+        end
+
+        def json(switcher)
+          Strum::Esb.config.json = switcher
+        end
       end
 
-      def work_with_params(deserialized_msg, _delivery_info, metadata)
-        notice_data = JSON.parse(deserialized_msg)
+      def work_with_params(deserialized_msg, delivery_info, metadata)
+        Strum::Esb.config.before_handler_hooks.each { |hook| hook.call(deserialized_msg, delivery_info, metadata) }
 
         snake_case_modify = ->(string) { string.nil? ? nil : string&.to_s.gsub(/[^a-zA-Z0-9]/, "_")&.downcase }
         parse_header = ->(string) { metadata[:headers] && metadata[:headers][string] }
@@ -63,23 +71,39 @@ module Strum
 
         method_name = ([*methods_names] << "handler").find { |n| respond_to?(n, include_all: true) }
 
+        unless Strum::Esb.config.serializer.enabled?(metadata[:content_type])
+          logger.error "Content type #{metadata[: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, metadata[:content_type], method_name)
+
+        unless valid_payload
+          logger.error "Content type is invalid. Message rejected #{metadata[:headers]} with payload #{payload}"
+          return reject!
+        end
+
         unless method_name
-          logger.error "Handler not found. Message rejected #{metadata[:headers]} with payload #{notice_data}"
+          logger.error "Handler not found. Message rejected #{metadata[:headers]} with payload #{payload}"
           return reject!
         end
 
+        error = nil
         method_params = method(method_name)
                         .parameters
                         .map { |param| _, param_name = param; param_name }
                         .then { |m| m & %I[action resource event state info chain] }
         handler_params = method_params.each_with_object({}) { |i, res| res[i] = eval(i.to_s); }
-        logger.info("Handler #{method_name} found. Payload: #{notice_data}")
-        handler_params.count.positive? ? send(method_name, notice_data, handler_params) : send(method_name, notice_data)
+        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")
         ack!
       rescue StandardError => e
+        error = e
         logger.error e
         reject!
+      ensure
+        Strum::Esb.config.after_handler_hooks.each { |hook| hook.call(deserialized_msg, delivery_info, metadata, payload, error) }
       end
 
       def after_headers_hook; end
@@ -87,7 +111,7 @@ module Strum
       private
 
         def action_handler_methods(action, resource)
-          if custom_handler = self.class.handlers[["action", action, resource].join("-")]
+          if (custom_handler = self.class.handlers[["action", action, resource].join("-")])
             %W[#{custom_handler} action_#{action}_#{resource} action_handler]
           else
             %W[action_#{action}_#{resource} action_handler]
@@ -105,7 +129,7 @@ module Strum
         end
 
         def info_handler_methods(info)
-          if custom_handler = self.class.handlers[["info", info].join("-")]
+          if (custom_handler = self.class.handlers[["info", info].join("-")])
             %W[#{custom_handler} info_#{info} info_handler]
           else
             %W[info_#{info} info_handler]

data/lib/strum/esb/message.rb

@@ -5,26 +5,30 @@ module Strum
     # Strum Message
     class Message
       class << self
-        def publish(exchange:, headers:, payload:)
+        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 = {
             headers: headers,
-            content_type: "application/json"
+            content_type: content_type
           }
 
-          Strum::Esb.config.pre_publish_hooks.each do |hook| 
-            hook.call(payload, properties)
-          end
+          Strum::Esb.config.before_publish_hooks.each { |hook| hook.call(payload, 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]
-          if chain = Thread.current[:chain]
+          if (chain = Thread.current[:chain])
             payload["chain"] ||= chain
             headers["chain"] ||= chain
           end
-          
-          rabbit_exchange.publish(payload.to_json, **properties)
+
+          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
+
+          rabbit_exchange.publish(payload, **properties)
         end
       end
     end

data/lib/strum/esb/serializer.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Strum
+  module Esb
+    # Payload serializer/deserializer
+    class Serializer
+      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)
+
+          perform_method_name = content_type_method_name(base_method, content_type)
+          payload = send(*[perform_method_name, payload, queue_method_name].compact)
+          [payload, true]
+        rescue StandardError
+          [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)
+          CONTENT_TYPES.include?(content_type)
+        end
+
+        def content_type_method_name(action, content_type)
+          "#{action}_#{data_type(content_type)}"
+        end
+
+        def data_type(content_type)
+          content_type.gsub("-", "/").split("/").last
+        end
+
+        def deserialize_json(payload, _queue_method_name)
+          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)
+        end
+
+        def serialize_json(payload)
+          payload.to_json
+        end
+
+        def serialize_protobuf(payload)
+          payload
+        end
+
+        def inflector
+          Dry::Inflector.new
+        end
+    end
+  end
+end

data/lib/strum/esb/version.rb

@@ -2,6 +2,6 @@
 
 module Strum
   module Esb
-    VERSION = "0.1.1"
+    VERSION = "0.3.0"
   end
 end

data/lib/strum/esb.rb

@@ -15,11 +15,14 @@ require "strum/esb/event"
 require "strum/esb/notice"
 require "strum/esb/info"
 require "dry/configurable"
+require "dry/inflector"
+require "strum/esb/serializer"
 
 module Strum
   module Esb
     extend Dry::Configurable
 
+    setting :sneakers_workers, ENV.fetch("SNEAKERS_WORKERS", 1)
     setting :exchange, "strum.general"
     setting :info_exchange, "strum.info"
     setting :event_exchange, "strum.events"
@@ -34,7 +37,12 @@ module Strum
                                   end
     setting :before_fork_hooks, []
     setting :after_fork_hooks, []
-    setting :pre_publish_hooks, []
+    setting :before_publish_hooks, []
+    setting :before_handler_hooks, []
+    setting :after_handler_hooks, []
+    setting :serializer, Serializer.new
+    setting :protobuf_service, false
+    setting :json, true
 
     Strum::Esb.config.before_fork_hooks << proc { DB.disconnect } if defined?(DB)
 
@@ -44,8 +52,8 @@ module Strum
     class Error < StandardError; end
 
     Sneakers.configure(
-      log: STDOUT,
-      workers: Etc.nprocessors,
+      log: $stdout,
+      workers: Strum::Esb.config.sneakers_workers,
       hooks: {
         before_fork: -> { Strum::Esb.config.before_fork_hooks.each(&:call) },
         after_fork: -> { Strum::Esb.config.after_fork_hooks.each(&:call) }

data/lib/strum/patch/sneakers/queue_patch.rb

@@ -91,8 +91,8 @@ module QueuePatch
   end
 
   def notices_subscribes(notices, **custom_headers)
-    notices.each do |_info|
-      exchange, resource, notice = Strum::Esb::Functions.notice_explain(_info)
+    notices.each do |_notice|
+      exchange, resource, notice = Strum::Esb::Functions.notice_explain(_notice)
       raise StandardError "notice binding format must be a `exchange:resource`" unless resource
 
       @opts[:header_bindings] << {

data/strum-esb.gemspec

@@ -30,7 +30,8 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "bunny", "~> 2.15"
   spec.add_dependency "connection_pool", "~> 2.2.2"
+  spec.add_dependency "dry-configurable", "~> 0.12.1"
+  spec.add_dependency "dry-inflector", "~> 0.2.1"
   spec.add_dependency "json", "~> 2.3"
   spec.add_dependency "sneakers", "~> 2.12"
-  spec.add_dependency "dry-configurable", "~> 0.12"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strum-esb
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Serhiy Nazarov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-06-02 00:00:00.000000000 Z
+date: 2022-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -39,47 +39,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 2.2.2
 - !ruby/object:Gem::Dependency
-  name: json
+  name: dry-configurable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: 0.12.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: 0.12.1
 - !ruby/object:Gem::Dependency
-  name: sneakers
+  name: dry-inflector
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: 0.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: 0.2.1
 - !ruby/object:Gem::Dependency
-  name: dry-configurable
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '2.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.12'
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: sneakers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
 description: Publish and subscribe rabbitMQ messages
 email:
 - sn@nazarov.com.ua
@@ -107,6 +121,7 @@ files:
 - lib/strum/esb/info.rb
 - lib/strum/esb/message.rb
 - lib/strum/esb/notice.rb
+- lib/strum/esb/serializer.rb
 - lib/strum/esb/version.rb
 - lib/strum/patch/sneakers/queue_patch.rb
 - strum-esb.gemspec