beetle 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a90e706d339d2a9e458c0b82113b58d5be98243fa9c9adbeaafb12fadeeb3d1
-  data.tar.gz: d89db5e989cfa51558ebda9db9c6acd10170c27fda0135378157e252570be626
+  metadata.gz: 81efac323bc4a748a3e15d4ca496fa826cc75338b6841d28d22970cd38bf7a4d
+  data.tar.gz: f34c106da764a475f0396b225482a16083b00b659270d58b7b04c6887b59c6fd
 SHA512:
-  metadata.gz: ee25e895ba9f3f38afe6d4985297435d93cab432b0dd8d483b8890a25b58f89d9993fac429c0d710bfeed49568dd1a28c948a0241297c1352ad2200987e0aebc
-  data.tar.gz: d1dff384a6bd1da983b2c400e524970d086759ae7c24106089ef0e36a167b7cb9b8769f6938b96b9a5b78435abb945cddba432b14755716f67c96e508783ef51
+  metadata.gz: 933a4abbd1748fca969f40bd1c2cd304302ce70ec52251c0e1af66b491878644bb6be881686d9899718836f709caeba036bab2a0e0df5f4d9824233af7082dd7
+  data.tar.gz: 4b215e85dd35302221e1d7366f7fbc271025b032fddc9e9a7cf6fa60f37fd8502bcb22605785969cb9607229e74708df97af7d78f51b659159a98ce53c876ec4

data/README.rdoc

@@ -13,6 +13,10 @@ infrastructure. It offers the following features:
 
 More information can be found on the {project website}[http://xing.github.com/beetle].
 
+== Release notes
+
+See {RELEASE_NOTES.rdoc}[https://github.com/xing/beetle/blob/master/RELEASE_NOTES.rdoc]
+
 == Usage
 
 === Configuration

data/RELEASE_NOTES.rdoc

@@ -1,5 +1,13 @@
 = Release Notes
 
+== Version 3.1.0
+* added more debug log statements
+* added new callbacks on class Beetle::Handler:
+  * pre_process is called before any message processing commences
+  * post_process is called after all processing has been completed
+  these handlers can be used for logging purposes (such as logjam
+  integration)
+
 == Version 3.0.0
 
 * provide client method to setup queues and queue policies.

data/beetle.gemspec

@@ -30,7 +30,6 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "amqp",                    "= 1.8.0"
   s.add_runtime_dependency "activesupport",           ">= 2.3.4"
 
-  s.add_development_dependency "uuid4r",              ">= 0.1.2"
   s.add_development_dependency "activerecord",        "~> 5.0"
   s.add_development_dependency "cucumber",            "~> 2.4.0"
   s.add_development_dependency "daemon_controller",   "~> 1.2.0"

data/lib/beetle/handler.rb

@@ -48,12 +48,20 @@ module Beetle
       @__handler_called__ = true
     end
 
+    # called before message processing starts
+    def pre_process
+    end
+
     # called for message processing if no processor was specfied when the handler instance
     # was created
     def process
       logger.info "Beetle: received message #{message.inspect}"
     end
 
+    # called after message processing finishes
+    def post_process
+    end
+
     # should not be overriden in subclasses
     def process_exception(exception) #:nodoc:
       if @error_callback

data/lib/beetle/message.rb

@@ -1,4 +1,5 @@
 require "timeout"
+require "securerandom"
 
 module Beetle
   # Instances of class Message are created when a subscription callback fires. Class
@@ -146,16 +147,8 @@ module Beetle
     end
 
     # generate uuid for publishing
-    begin
-      require "uuid4r"
-      def self.generate_uuid
-        UUID4R::uuid(4)
-      end
-    rescue LoadError
-      require "securerandom"
-      def self.generate_uuid
-        SecureRandom.uuid
-      end
+    def self.generate_uuid
+      SecureRandom.uuid
     end
 
     # whether the publisher has tried sending this message to two servers
@@ -264,7 +257,7 @@ module Beetle
 
     # process this message and do not allow any exception to escape to the caller
     def process(handler)
-      logger.debug "Beetle: processing message #{msg_id}"
+      logger.debug "Beetle: processing message #{msg_id}(#{timestamp})"
       result = nil
       begin
         result = process_internal(handler)

data/lib/beetle/r_c.rb

@@ -3,6 +3,8 @@ module Beetle
 
     # message processing result return codes
     class ReturnCode
+      attr_reader :name
+
       def initialize(*args)
         @reject = args.delete :reject
         @failure = args.delete :failure

data/lib/beetle/subscriber.rb

@@ -168,13 +168,15 @@ module Beetle
     def create_subscription_callback(queue_name, amqp_queue_name, handler, opts)
       server = @server
       lambda do |header, data|
+        msg_id = header.attributes[:message_id]
         if channel(server).closing?
-          logger.info "Beetle: ignoring message since channel to server #{server} already closed"
+          timestamp = header.attributes[:timestamp]
+          logger.info "Beetle: ignored message #{msg_id}(#{timestamp}) since channel to server #{server} was already closed"
           return
         end
         begin
-          # logger.debug "Beetle: received message"
           processor = Handler.create(handler, opts)
+          processor.pre_process
           message_options = opts.merge(:server => server, :store => @client.deduplication_store)
           m = Message.new(amqp_queue_name, header, data, message_options)
           result = m.process(processor)
@@ -185,23 +187,25 @@ module Beetle
               sleep 1
               header.reject(:requeue => true)
             end
+            logger.debug "Beetle: rejected #{msg_id} RC: #{result.name}"
           elsif reply_to = header.attributes[:reply_to]
-            # logger.info "Beetle: sending reply to queue #{reply_to}"
-            # require 'ruby-debug'
-            # Debugger.start
-            # debugger
+            logger.debug "Beetle: sending reply to queue #{reply_to} for #{msg_id}"
             status = result == Beetle::RC::OK ? "OK" : "FAILED"
             exchange = AMQP::Exchange.new(channel(server), :direct, "")
             exchange.publish(m.handler_result.to_s, :routing_key => reply_to, :persistent => false, :headers => {:status => status})
           end
-          # logger.debug "Beetle: processed message"
         rescue Exception
           Beetle::reraise_expectation_errors!
-          # swallow all exceptions
-          logger.error "Beetle: internal error during message processing: #{$!}: #{$!.backtrace.join("\n")}"
+          logger.debug "Beetle: internal error on #{msg_id}: #{$!}: #{$!.backtrace.join("\n")}"
         ensure
           # processing_completed swallows all exceptions, so we don't need to protect this call
           processor.processing_completed
+          logger.debug "Beetle: completed #{msg_id}"
+          begin
+            processor.post_process
+          rescue Exception
+            Beetle::reraise_expectation_errors!
+          end
         end
       end
     end

data/lib/beetle/version.rb

@@ -1,3 +1,3 @@
 module Beetle
-  VERSION = "3.0.0"
+  VERSION = "3.1.0"
 end

data/test/beetle/subscriber_test.rb

@@ -266,6 +266,7 @@ module Beetle
       @sub = client.send(:subscriber)
       @exception = Exception.new "murks"
       @handler = Handler.create(lambda{|*args| raise @exception})
+      @handler.instance_eval { def post_process; raise "shoot"; end }
       @callback = @sub.send(:create_subscription_callback, "my myessage", @queue, @handler, :exceptions => 1)
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: beetle
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Stefan Kaes
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-27 00:00:00.000000000 Z
+date: 2019-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -98,20 +98,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.3.4
-- !ruby/object:Gem::Dependency
-  name: uuid4r
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.1.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement