istox 0.1.152.1.test15 → 0.1.152.1.test16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e6b7b281f10081914395204d820554eb676d7f7063766a0f45f3d470ad75ee3
-  data.tar.gz: 128fe251d9c3e76627254fa2d343e3295fa073678897626bf4fafdd3b1e35978
+  metadata.gz: 0556d82320982ae7582d13b0a999e8985822eb66d8086e9084866ffe23ea086c
+  data.tar.gz: '0529d8460f758ff329dff82cb49790d3353b6d52f8f9a4a0fe848c70fd0153c7'
 SHA512:
-  metadata.gz: 5072c8a9f84ce0e3239283a3ceebc3d3585fb0ab29b081383333760dc475716533272c33bb41b0edb4ae6eefdb07ab4b350fd50a76509f92d25d9ea04ff5c78e
-  data.tar.gz: 37c17fbb58fb0c07a51e88afdb953d4bab5b3b60911ee5c3a4991a333b40b6fa43109c6ac646bdc76115bbb9975267e854405d1e5e0e741294545560be64a3bb
+  metadata.gz: 5db924c60ebc7e215e7f343f2d34cfdae12016d632857977193742236636e563615260771b5c242ea273f919b12f2b592e9406cb25510a606797c3b51a5dd4e4
+  data.tar.gz: 2b4f17ebfc0dfa40a6a605839ca82b3a2c62667b9efea2875fd739bc5aece73d0315dd0ff11a2e33b6d55fe3ec417daddd45f1d1310ecdd47724d49a5cf969f7

data/lib/istox/helpers/bunny_boot.rb

@@ -5,6 +5,29 @@ require 'istox/helpers/logger'
 module Istox
   class BunnyBoot
     class << self
+      ########################################################
+      ##
+      ##  RABBITMQ interceptors
+      ##
+      ######################################################
+      def add_consumer_interceptor(interceptor)
+        @consumer_interceptors ||= []
+        @consumer_interceptors.push(interceptor)
+      end
+
+      def add_publisher_interceptor(interceptor)
+        @publisher_interceptors ||= []
+        @publisher_interceptors.push(interceptor)
+      end
+
+      def publisher_interceptors
+        @publisher_interceptors || []
+      end
+
+      def consumer_interceptors
+        @consumer_interceptors || []
+      end
+
       # Create physical connection to RabbitMQ
       # During failover of RabbitMQ cluster or temporary failure, there may be error and needs retry in loop
       def connection
@@ -36,16 +59,16 @@ module Istox
       def exchange(eid)
         type = data[:exchanges][eid][:type]
         name = eid
-        settings = { durable: exchange_durable?(eid)  }
+        settings = { durable: exchange_durable?(eid) }
         confirm = data[:exchanges][eid][:confirm] || -1
         [type, name, settings, confirm]
-      rescue
+      rescue StandardError
         nil
       end
 
       def binding_exchange_id(id)
         data[:binding][id][:exchange] || :default
-      rescue
+      rescue StandardError
         nil
       end
 
@@ -56,17 +79,17 @@ module Istox
         else
           data[:queues][queue][:queue_name]
         end
-      rescue
+      rescue StandardError
         nil
       end
 
       def confirm_mode(eid)
         data[:exchanges][eid][:confirm] || -1
-      rescue
+      rescue StandardError
         nil
       end
 
-      def queues_keys_for_subscribe()
+      def queues_keys_for_subscribe
         data['queues'].keys
       end
 
@@ -89,7 +112,7 @@ module Istox
         durable = exchange_config!(exchange_name)['durable']
         durable = true if durable.nil?
         durable
-      rescue => e
+      rescue StandardError => e
         raise e
       end
 
@@ -104,7 +127,7 @@ module Istox
 
       def exchange_name(consumer_key)
         queue_config_from_consumer_key!(consumer_key)['exchange']
-      rescue
+      rescue StandardError
         nil
       end
 
@@ -119,43 +142,43 @@ module Istox
         name = "#{prefix}#{delimiter}#{name}" unless prefix.nil?
         name = "#{name}#{delimiter}#{suffix}" unless suffix.nil?
         name
-      rescue
+      rescue StandardError
         nil
       end
 
       def queue_priority(consumer_key)
         queue_config_from_consumer_key!(consumer_key)['priority']
-      rescue
+      rescue StandardError
         nil
       end
 
       def queue_worker_param(consumer_key)
         queue_config_from_consumer_key!(consumer_key)['worker_param']
-      rescue
+      rescue StandardError
         nil
       end
 
       def queue_worker_param_format(consumer_key)
         queue_config_from_consumer_key!(consumer_key)['worker_param_format'] || 'open_struct'
-      rescue
+      rescue StandardError
         nil
       end
 
       def queue_routing_key(consumer_key)
         queue_config_from_consumer_key!(consumer_key)['routing_key'] || (queue_name consumer_key)
-      rescue
+      rescue StandardError
         nil
       end
 
       def queue_exclusive(consumer_key)
         queue_config_from_consumer_key!(consumer_key)['exclusive'] || false
-      rescue
+      rescue StandardError
         nil
       end
 
       def ruby_class(consumer_key)
         queue_config_from_consumer_key!(consumer_key)['ruby_class']
-      rescue
+      rescue StandardError
         nil
       end
 
@@ -175,7 +198,7 @@ module Istox
         end
 
         durable
-      rescue
+      rescue StandardError
         nil
       end
 
@@ -230,7 +253,7 @@ module Istox
         persistent = e.durable?
         mandatory = false
         # Set Mandatory & Persistent flag for non-DLX and non-manual msg
-        unless ['dlx', 'manual'].include? options[:type]
+        unless %w[dlx manual].include? options[:type]
           if options[:routing_key].present?
             v1 = data['publish'][eid]
             v1 = v1[options[:routing_key]] unless v1.nil?
@@ -240,10 +263,15 @@ module Istox
         end
         options.merge!(persistent: persistent)
         options.merge!(mandatory: mandatory)
-
         # message.merge!(locale: I18n.locale)
-        message = JSON.dump message
 
+        raise 'Rabbitmq publishing message must be a hash' unless message.is_a? Hash
+
+        publisher_interceptors.each do |interceptor|
+          interceptor.call(message, options)
+        end
+
+        message = JSON.dump message
         log.debug "Publish options are: #{options}"
         log.debug "Publish message payload #{message}"
         e.publish(message, options)
@@ -277,7 +305,7 @@ module Istox
         # combination of channel_id:delivery_tag can uniquely identify a msg
         # For each retry of msg, channel_id and delivery_tag is unchanged
         # But each retry, there is new delivery_tag that should be updated
-        id = "#{channel_id.to_s}:#{delivery_tag.to_s}"
+        id = "#{channel_id}:#{delivery_tag}"
 
         ::Istox::RedisBoot.sets("#{id}:payload", JSON.dump(payload), 4)
         ::Istox::RedisBoot.sets("#{id}:eid", eid.to_s, 4)
@@ -285,7 +313,7 @@ module Istox
       end
 
       def find_tracker_on_channel(channel_id, delivery_tag, key)
-        pattern = "#{channel_id.to_s}:#{delivery_tag.to_s}:#{key}"
+        pattern = "#{channel_id}:#{delivery_tag}:#{key}"
         keys = find_trackers pattern
         get_tracker(keys.first)
       end
@@ -307,9 +335,7 @@ module Istox
 
       def eid(ex)
         eid = ex.name
-        if eid.empty?
-          eid = :default
-        end
+        eid = :default if eid.empty?
 
         eid
       end
@@ -327,9 +353,9 @@ module Istox
       def data
         Hashie.logger.level = 'ERROR'
         @data = Hashie::Mash.new(
-            YAML.safe_load(
-                ERB.new(File.read(ENV['AMQP_CONFIG'] || 'config/amqp.yml')).result
-            )
+          YAML.safe_load(
+            ERB.new(File.read(ENV['AMQP_CONFIG'] || 'config/amqp.yml')).result
+          )
         )
       end
 
@@ -356,11 +382,11 @@ module Istox
       def find_trackers(pattern)
         cursor = 0
         all_keys = []
-        loop {
-          cursor, keys = ::Istox::RedisBoot.scan(cursor, {:match => pattern, :count => 500}, 4)
+        loop do
+          cursor, keys = ::Istox::RedisBoot.scan(cursor, { match: pattern, count: 500 }, 4)
           all_keys += keys
-          break if cursor == "0"
-        }
+          break if cursor == '0'
+        end
         all_keys.uniq
       end
 

data/lib/istox/helpers/subscriber.rb

@@ -4,7 +4,6 @@ module Istox
   # Publisher is relying on BunnyBoot to publish message, please make sure BunnyBoot is initalised properly first during runtime.
   class Subscriber
     class << self
-
       # optionally can pass in consumer_key for single subscription / consumer_keys for multiple subcriptions
       # consumer_key must be defined in amqp.yml
       # if nothing pass in it will auto subscribe to all available consumers defined in amqp.yml queues key
@@ -81,22 +80,22 @@ module Istox
         end
 
         if manual_ack
-          if exchange.nil?
-            letter_exchange = active_channel.default_exchange.name
-          else
-            letter_exchange = exchange.name
-          end
+          letter_exchange = if exchange.nil?
+                              active_channel.default_exchange.name
+                            else
+                              exchange.name
+                            end
           retry_queue = active_channel.queue("#{queue_name}.retry", arguments: {
-              'x-dead-letter-exchange': letter_exchange,
-              'x-dead-letter-routing-key': "#{queue_name}",
-              'x-message-ttl': (::Istox::BunnyBoot.queue_retry_gap consumer_key)
-          })
-          unless exchange_name.nil?
+                                               'x-dead-letter-exchange': letter_exchange,
+                                               'x-dead-letter-routing-key': queue_name.to_s,
+                                               'x-message-ttl': (::Istox::BunnyBoot.queue_retry_gap consumer_key)
+                                             })
+          if exchange_name.nil?
+            exchange_retry = active_channel.default_exchange
+          else
             exchange_retry_name = "#{exchange_name}.retry"
             exchange_retry = active_channel.send exchange_type, exchange_retry_name, durable: exchange_durable
             retry_queue.bind exchange_retry, routing_key: "#{queue_name}.retry" if manual_ack
-          else
-            exchange_retry = active_channel.default_exchange
           end
         end
 
@@ -117,14 +116,14 @@ module Istox
         @workers = {} if @workers.nil?
         unless block || @workers[ruby_class]
           klass = Object.const_get(
-              '::' + (ruby_class).camelize
+            '::' + ruby_class.camelize
           )
           param = ::Istox::BunnyBoot.queue_worker_param consumer_key
-          if param.nil?
-            @workers[ruby_class] = klass.new
-          else
-            @workers[ruby_class] = klass.new param
-          end
+          @workers[ruby_class] = if param.nil?
+                                   klass.new
+                                 else
+                                   klass.new param
+                                 end
         end
         # Subscribe queue
         priority = ::Istox::BunnyBoot.queue_priority consumer_key
@@ -150,16 +149,23 @@ module Istox
 
           if process
             processing_payload = JSON.parse(payload)
-            processing_payload = ::Istox::CommonHelper.to_open_struct(processing_payload) if ::Istox::BunnyBoot.queue_worker_param_format(consumer_key) == 'open_struct'
+            if ::Istox::BunnyBoot.queue_worker_param_format(consumer_key) == 'open_struct'
+              processing_payload = ::Istox::CommonHelper.to_open_struct(processing_payload)
+            end
             log.info "Processing in consumer: #{klass}, payload: #{processing_payload.to_h.inspect}"
-            if @workers[ruby_class].nil?
-              result = block.call(processing_payload, metadata, delivery_info) unless block.nil?
-            else
-              result = @workers[ruby_class].process(processing_payload, metadata, delivery_info)
+
+            interceptors = ::Istox::BunnyBoot.consumer_interceptors.dup
+
+            intercept(interceptors, processing_payload, metadata, delivery_info) do
+              if @workers[ruby_class].nil?
+                block&.call(processing_payload, metadata, delivery_info)
+              else
+                @workers[ruby_class].process(processing_payload, metadata, delivery_info)
+              end
             end
           else
             # Instead of cache msg, print log
-            log.fatal "Drop msg at #{Time.now.to_s} for queue #{queue.name}, payload is #{JSON.dump(payload)}" if store
+            log.fatal "Drop msg at #{Time.now} for queue #{queue.name}, payload is #{JSON.dump(payload)}" if store
           end
           # active_channel.ack(delivery_info.delivery_tag) if manual_ack
         rescue StandardError => e
@@ -175,29 +181,44 @@ module Istox
             # here we adopt the unused priority as remaining retry_count
             if process
               processing_payload = JSON.parse(payload)
-              processing_payload = ::Istox::CommonHelper.to_open_struct(processing_payload) if ::Istox::BunnyBoot.queue_worker_param_format(consumer_key) == 'open_struct'
+              if ::Istox::BunnyBoot.queue_worker_param_format(consumer_key) == 'open_struct'
+                processing_payload = ::Istox::CommonHelper.to_open_struct(processing_payload)
+              end
               ::Istox::BunnyBoot.publish(exchange_retry, processing_payload, routing_key: "#{queue_name}.retry", priority: retry_count, type: 'dlx')
             end
           end
-=begin
-          # For redelivered message, call 'reject' not 'nack' in order to reschedule message to tail not head of queue
-          if delivery_info.redelivered
-            active_channel.reject(delivery_info.delivery_tag, true)
-          else
-            active_channel.nack(delivery_info.delivery_tag, false, true)
-          end
-=end
+        #           # For redelivered message, call 'reject' not 'nack' in order to reschedule message to tail not head of queue
+        #           if delivery_info.redelivered
+        #             active_channel.reject(delivery_info.delivery_tag, true)
+        #           else
+        #             active_channel.nack(delivery_info.delivery_tag, false, true)
+        #           end
         ensure
           if manual_ack
-            if !multiple.nil? && !result && result == multiple
-              multiple = true
-            else
-              multiple = false
-            end
+            multiple = if !multiple.nil? && !result && result == multiple
+                         true
+                       else
+                         false
+                       end
             active_channel.ack(delivery_info.delivery_tag, multiple)
           end
         end
       end
+
+      def intercept(interceptors, payload, metadata, delivery_info)
+        return yield if interceptors.none?
+
+        i = interceptors.pop
+        return yield unless i
+
+        i.call(payload, metadata, delivery_info) do
+          if interceptors.any?
+            intercept(interceptors, payload, metadata, delivery_info) { yield }
+          else
+            yield
+          end
+        end
+      end
     end
   end
 end

data/lib/istox/helpers/xray/grpc_client_xray_interceptor.rb

@@ -8,7 +8,7 @@ module Istox
         no_segment = false
 
         begin
-          XRay.recorder.current_segment
+          no_segment = XRay.recorder.current_segment.blank?
         rescue XRay::ContextMissingError
           no_segment = true
         end

data/lib/istox/helpers/xray/rabbitmq_consumer_interceptor.rb

@@ -0,0 +1,29 @@
+require 'istox/helpers/logger'
+require 'aws-xray-sdk'
+
+module Istox
+  module Xray
+    class RabbitmqConsumerInterceptor
+      def call(payload, _metadata, delivery_info)
+        payload_hash = payload.to_h
+
+        trace_id = (payload_hash[:xray_trace_id] if meta.key?(:xray_trace_id))
+        parent_id = (payload_hash[:xray_parent_id] if meta.key?(:xray_parent_id))
+
+        arr = [delivery_info[:exchange], delivery_info[:routing_key], payload_hash[:type]].compact
+
+        XRay.recorder.begin_segment("#{::Istox::Xray::XrayInitializer.service_name}.rabbitmq.#{arr.join('.')}",
+                                    trace_id: trace_id, parent_id: parent_id)
+
+        result = yield # this returns consumer handler message
+
+        XRay.recorder.end_segment
+
+        result
+      rescue StandardError => e
+        log.error e
+        raise e
+      end
+    end
+  end
+end

data/lib/istox/helpers/xray/rabbitmq_publisher_interceptor.rb

@@ -4,7 +4,33 @@ require 'aws-xray-sdk'
 module Istox
   module Xray
     class RabbitmqPublisherInterceptor
-      def call; end
+      def call(message, options)
+        no_segment = false
+
+        begin
+          no_segment = XRay.recorder.current_segment.blank?
+        rescue XRay::ContextMissingError
+          no_segment = true
+        end
+
+        ## usually we have active segment for client interceptor
+        ## but in some special case we might not have segment initiated
+        ## eg. when running from rails console,
+        ## in those case we will initiate the segment here manully
+        XRay.recorder.begin_segment('rabbitmq_publish') if no_segment
+
+        XRay.recorder.begin_subsegment("rabbitmq_publish.#{options[:routing_key]}")
+
+        message[:xray_trace_id] = XRay.recorder.current_segment.trace_id
+        message[:xray_parent_id] = XRay.recorder.current_segment.id
+
+        XRay.recorder.end_subsegment
+
+        XRay.recorder.end_segment if no_segment
+      rescue StandardError => e
+        log.error e
+        raise e
+      end
     end
   end
 end

data/lib/istox/helpers/xray/xray_initializer.rb

@@ -33,6 +33,9 @@ module Istox
           end
 
           return unless enable_rabbitmq_trace == true
+
+          ::Istox::BunnyBoot.add_publisher_interceptor(::Istox::Xray::RabbitmqPublisherInterceptor.new)
+          ::Istox::BunnyBoot.add_consumer_interceptor(::Istox::Xray::RabbitmqConsumerInterceptor.new)
         end
       end
     end

data/lib/istox/version.rb

@@ -1,3 +1,3 @@
 module Istox
-  VERSION = '0.1.152.1.test15'.freeze
+  VERSION = '0.1.152.1.test16'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: istox
 version: !ruby/object:Gem::Version
-  version: 0.1.152.1.test15
+  version: 0.1.152.1.test16
 platform: ruby
 authors:
 - Siong Leng
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-21 00:00:00.000000000 Z
+date: 2020-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -468,8 +468,8 @@ files:
 - lib/istox/helpers/vault.rb
 - lib/istox/helpers/xray/grpc_client_xray_interceptor.rb
 - lib/istox/helpers/xray/grpc_server_xray_interceptor.rb
+- lib/istox/helpers/xray/rabbitmq_consumer_interceptor.rb
 - lib/istox/helpers/xray/rabbitmq_publisher_interceptor.rb
-- lib/istox/helpers/xray/rabbitmq_subscriber_interceptor.rb
 - lib/istox/helpers/xray/xray_initializer.rb
 - lib/istox/interfaces/chainhub/transaction.rb
 - lib/istox/models/blockchain_receipt.rb

data/lib/istox/helpers/xray/rabbitmq_subscriber_interceptor.rb

@@ -1,10 +0,0 @@
-require 'istox/helpers/logger'
-require 'aws-xray-sdk'
-
-module Istox
-  module Xray
-    class RabbitmqSubscriberInterceptor
-      def call; end
-    end
-  end
-end