right_amqp 0.3.3 → 0.5.2

data/lib/right_amqp/ha_client/ha_broker_client.rb

@@ -136,6 +136,7 @@ module RightAMQP
     def initialize(serializer, options = {})
       @options = options.dup
       @options[:update_status_callback] = lambda { |b, c| update_status(b, c) }
+      @options[:return_message_callback] = lambda { |i, t, r, m| handle_return(i, t, r, m) }
       @options[:reconnect_interval] ||= RECONNECT_INTERVAL
       @connection_status = {}
       unless serializer.nil? || [:dump, :load].all? { |m| serializer.respond_to?(m) }
@@ -149,7 +150,6 @@ module RightAMQP
       @closed = false
       @brokers_hash = {}
       @brokers.each { |b| @brokers_hash[b.identity] = b }
-      return_message { |i, r, m, t, c| handle_return(i, r, m, t, c) }
     end
 
     # Parse agent user data to extract broker host and port configuration
@@ -360,7 +360,7 @@ module RightAMQP
     # === Return
     # (Array):: Serialized identity of unusable brokers
     def unusable
-      @brokers.map { |b| b.identity } - each_usable.map { |b| b.identity }
+      all - usable
     end
 
     # Get serialized identity of all brokers
@@ -430,7 +430,7 @@ module RightAMQP
         end unless existing
 
         address = {:host => host, :port => port, :index => index}
-        broker = BrokerClient.new(identity, address, @serializer, @exceptions, @options, existing)
+        broker = BrokerClient.new(identity, address, @serializer, @exception_stats, @non_delivery_stats, @options, existing)
         p = priority(old_identity)
         if priority && priority < p
           @brokers.insert(priority, broker)
@@ -466,7 +466,8 @@ module RightAMQP
     #       to cause its creation; for use when client does not have create permission or
     #       knows the exchange already exists and wants to avoid declare overhead
     # options(Hash):: Subscribe options:
-    #   :ack(Boolean):: Explicitly acknowledge received messages to AMQP
+    #   :ack(Boolean):: Whether client takes responsibility for explicitly acknowledging each
+    #     message received, defaults to implicit acknowledgement in AMQP as part of message receipt
     #   :no_unserialize(Boolean):: Do not unserialize message, this is an escape for special
     #     situations like enrollment, also implicitly disables receive filtering and logging;
     #     this option is implicitly invoked if initialize without a serializer
@@ -553,6 +554,10 @@ module RightAMQP
     #       to force it to be declared on the broker and thus be created if it does not exist
     # packet(Packet):: Message to serialize and publish
     # options(Hash):: Publish options -- standard AMQP ones plus
+    #   :mandatory(Boolean):: Return message if the exchange does not have any associated queues
+    #     or if all the associated queues do not have any consumers
+    #   :immediate(Boolean):: Return message for the same reasons as :mandatory plus if all
+    #     of the queues associated with the exchange are not immediately ready to consume the message
     #   :fanout(Boolean):: true means publish to all connected brokers
     #   :brokers(Array):: Identity of brokers selected for use, defaults to all home brokers
     #     if nil or empty
@@ -593,38 +598,6 @@ module RightAMQP
       identities
     end
 
-    # Register callback to be activated when a broker returns a message that could not be delivered
-    # A message published with :mandatory => true is returned if the exchange does not have any associated queues
-    # or if all the associated queues do not have any consumers
-    # A message published with :immediate => true is returned for the same reasons as :mandatory plus if all
-    # of the queues associated with the exchange are not immediately ready to consume the message
-    # Remove any previously registered callback
-    #
-    # === Block
-    # Required block to be called when a message is returned with parameters
-    #   identity(String):: Broker serialized identity
-    #   reason(String):: Reason for return
-    #     "NO_ROUTE" - queue does not exist
-    #     "NO_CONSUMERS" - queue exists but it has no consumers, or if :immediate was specified,
-    #       all consumers are not immediately ready to consume
-    #     "ACCESS_REFUSED" - queue not usable because broker is in the process of stopping service
-    #   message(String):: Returned serialized message
-    #   to(String):: Queue to which message was published
-    #   context(Context|nil):: Message publishing context, or nil if not available
-    #
-    # === Return
-    # true:: Always return true
-    def return_message(&blk)
-      each_usable do |b|
-        b.return_message do |to, reason, message|
-          context = @published.fetch(message)
-          context.record_failure(b.identity) if context
-          blk.call(b.identity, reason, message, to, context)
-        end
-      end
-      true
-    end
-
     # Provide callback to be activated when a message cannot be delivered
     #
     # === Block
@@ -748,7 +721,7 @@ module RightAMQP
           rescue Exception => e
             handler.completed_one
             logger.exception("Failed to close broker #{b.alias}", e, :trace)
-            @exceptions.track("close", e)
+            @exception_stats.track("close", e)
           end
         end
       end
@@ -838,14 +811,17 @@ module RightAMQP
     #     "total"(Integer):: Total exceptions for this category
     #     "recent"(Array):: Most recent as a hash of "count", "type", "message", "when", and "where"
     #   "heartbeat"(Integer|nil):: Number of seconds between AMQP heartbeats, or nil if heartbeat disabled
+    #   "non_deliveries"(Hash|nil):: Non-delivery activity stats with keys "total", "percent", "last", and "rate"
+    #     with percentage breakdown per non-delivery reason, or nil if none
     #   "returns"(Hash|nil):: Message return activity stats with keys "total", "percent", "last", and "rate"
     #     with percentage breakdown per return reason, or nil if none
     def stats(reset = false)
       stats = {
-        "brokers"    => @brokers.map { |b| b.stats },
-        "exceptions" => @exceptions.stats,
-        "heartbeat"  => @options[:heartbeat],
-        "returns"    => @returns.all
+        "brokers"        => @brokers.map { |b| b.stats },
+        "exceptions"     => @exception_stats.stats,
+        "heartbeat"      => @options[:heartbeat],
+        "non-deliveries" => @non_delivery_stats.all,
+        "returns"        => @return_stats.all
       }
       reset_stats if reset
       stats
@@ -858,8 +834,9 @@ module RightAMQP
     # === Return
     # true:: Always return true
     def reset_stats
-      @returns = RightSupport::Stats::Activity.new
-      @exceptions = RightSupport::Stats::Exceptions.new(self, @options[:exception_callback])
+      @return_stats = RightSupport::Stats::Activity.new
+      @non_delivery_stats = RightSupport::Stats::Activity.new
+      @exception_stats = RightSupport::Stats::Exceptions.new(self, @options[:exception_callback])
       true
     end
 
@@ -872,7 +849,7 @@ module RightAMQP
     def connect_all
       self.class.addresses(@options[:host], @options[:port]).map do |a|
         identity = self.class.identity(a[:host], a[:port])
-        BrokerClient.new(identity, a, @serializer, @exceptions, @options, nil)
+        BrokerClient.new(identity, a, @serializer, @exception_stats, @non_delivery_stats, @options, nil)
       end
     end
 
@@ -1029,22 +1006,22 @@ module RightAMQP
     #
     # === Parameters
     # identity(String):: Identity of broker that could not deliver message
+    # to(String):: Queue to which message was published
     # reason(String):: Reason for return
     #   "NO_ROUTE" - queue does not exist
     #   "NO_CONSUMERS" - queue exists but it has no consumers, or if :immediate was specified,
     #     all consumers are not immediately ready to consume
     #   "ACCESS_REFUSED" - queue not usable because broker is in the process of stopping service
     # message(String):: Returned message in serialized packet format
-    # to(String):: Queue to which message was published
-    # context(Context):: Message publishing context
     #
     # === Return
     # true:: Always return true
-    def handle_return(identity, reason, message, to, context)
+    def handle_return(identity, to, reason, message)
       @brokers_hash[identity].update_status(:stopping) if reason == "ACCESS_REFUSED"
 
-      if context
-        @returns.update("#{alias_(identity)} (#{reason.to_s.downcase})")
+      if context = @published.fetch(message)
+        @return_stats.update("#{alias_(identity)} (#{reason.to_s.downcase})")
+        context.record_failure(identity)
         name = context.name
         options = context.options || {}
         token = context.token
@@ -1064,6 +1041,7 @@ module RightAMQP
             t = token ? " <#{token}>" : ""
             logger.info("NO ROUTE #{aliases(context.brokers).join(", ")} [#{name}]#{t} to #{to}")
             @non_delivery.call(reason, context.type, token, context.from, to) if @non_delivery
+            @non_delivery_stats.update("no route")
           end
         end
 
@@ -1077,14 +1055,14 @@ module RightAMQP
                                                    :persistent => persistent, :mandatory => mandatory))
         end
       else
-        @returns.update("#{alias_(identity)} (#{reason.to_s.downcase} - missing context)")
+        @return_stats.update("#{alias_(identity)} (#{reason.to_s.downcase} - missing context)")
         logger.info("Dropping message returned from broker #{identity} for reason #{reason} " +
                     "because no message context available for re-routing it to #{to}")
       end
       true
     rescue Exception => e
       logger.exception("Failed to handle #{reason} return from #{identity} for message being routed to #{to}", e, :trace)
-      @exceptions.track("return", e)
+      @exception_stats.track("return", e)
     end
 
     # Helper for deferring block execution until specified number of actions have completed

data/right_amqp.gemspec

@@ -24,8 +24,8 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name      = 'right_amqp'
-  spec.version   = '0.3.3'
-  spec.date      = '2012-10-30'
+  spec.version   = '0.5.2'
+  spec.date      = '2012-09-27'
   spec.authors   = ['Lee Kirchhoff']
   spec.email     = 'lee@rightscale.com'
   spec.homepage  = 'https://github.com/rightscale/right_amqp'

data/spec/amqp/client_extensions_spec.rb

@@ -33,7 +33,7 @@ describe AMQP::Client do
     class SUT
       include AMQP::Client
 
-      attr_accessor :reconnecting, :settings, :channels, :has_failed
+      attr_accessor :reconnecting, :settings, :channels
     end
 
     before(:each) do
@@ -88,7 +88,7 @@ describe AMQP::Client do
       end
     end
 
-    context 'with a :reconnect_interval of 5 seconds' do
+    context 'with a :reconnect_interval of 5 seconds'  do
       it 'should schedule reconnect attempts on a 5s interval' do
         @sut.reconnecting = true
         @sut.settings[:reconnect_delay] = 15
@@ -101,17 +101,6 @@ describe AMQP::Client do
       end
     end
 
-    context 'with a reconnect failure' do
-      it 'should fail the connection' do
-        @logger.should_receive(:error).with(/Failed to reconnect/).once
-        flexmock(EM).should_receive(:reconnect).and_raise(Exception).once
-        flexmock(@sut).should_receive(:close_connection).once
-
-        @sut.reconnect()
-        @sut.has_failed.should be_true
-      end
-    end
-
   end
 
   context "heartbeat" do