amqp-boilerplate 0.0.5 → 0.0.6

data/CHANGELOG

@@ -1,3 +1,13 @@
+= version 0.0.6
+
+  * [FEATURE] Do not abort consumer thread when a StandardError-like exception
+  is raised, but log this instead
+
+= version 0.0.5
+
+  * [FEATURE] Allow additional options to be passed when binding to an
+  exchange
+
 = version 0.0.4
 
   * [ENHANCEMENT] Documentation

data/lib/amqp/boilerplate/consumer.rb

@@ -49,7 +49,7 @@ module AMQP
         end
 
         # Macro that subscribes to asynchronous message delivery.
-        # 
+        #
         # @param [Hash] options Options that will be passed as options to {http://rdoc.info/github/ruby-amqp/amqp/master/AMQP/Queue#subscribe-instance_method AMQP::Queue#subscribe}
         def amqp_subscription(options={})
           @subscription_options = options
@@ -64,18 +64,38 @@ module AMQP
           queue = channel.queue(@queue_name, @queue_options)
           # Binding a queue to a exchange by passing a string (instead of a AMQP::Exchange instance)
           queue.bind(@exchange_name, @exchange_options) if @exchange_name
-          queue.subscribe(@subscription_options, &consumer.method(:handle_message))
+          queue.subscribe(@subscription_options, &consumer.method(:handle_message_wrapper))
 
           AMQP::Boilerplate.logger.info("[#{self.name}.start] Started consumer '#{self.name}'")
         end
       end
 
+      def handle_channel_error(channel, channel_close)
+        AMQP::Boilerplate.logger.error("[#{self.class}#handle_channel_error] Code = #{channel_close.reply_code}, message = #{channel_close.reply_text}")
+      end
+
       def handle_message(metadata, payload)
         raise NotImplementedError, "The time has come to implement your own consumer class. Good luck!"
       end
 
-      def handle_channel_error(channel, channel_close)
-        AMQP::Boilerplate.logger.error("[#{self.class}#handle_channel_error] Code = #{channel_close.reply_code}, message = #{channel_close.reply_text}")
+      # Wrapper around message handling routine to prevent the consumer from
+      # being killed when an exception occurs
+      #
+      # Catches anything that quacks like a +StandardError+. +SystemExit+s,
+      # +SyntaxError+s and the like will still cause the consumer to be
+      # aborted. See Ruby's exception inheritance hierarchy for a complete
+      # list of what is and what is not handled by this wrapper.
+      def handle_message_wrapper(metadata, payload)
+        handle_message(metadata, payload)
+      rescue StandardError => e
+        message = <<-MSG
+[#{self.class}] An exception occurred while processing a message
+  Payload: #{payload}
+  Exception: #{e.message}
+  Backtrace: #{e.backtrace.join("\n")}
+        MSG
+
+        AMQP::Boilerplate.logger.error(message)
       end
     end
   end

data/lib/amqp/boilerplate/version.rb

@@ -1,5 +1,5 @@
 module AMQP
   module Boilerplate
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
   end
 end

data/lib/amqp/boilerplate.rb

@@ -17,10 +17,9 @@ module AMQP
       if defined?(PhusionPassenger)
         PhusionPassenger.on_event(:starting_worker_process) do |forked|
           if forked
-            amqp_thread = Thread.new {
+            Thread.new do
               AMQP::Boilerplate.start
-            }
-            amqp_thread.abort_on_exception = true
+            end
           end
         end
       else

data/spec/amqp/boilerplate/consumer_spec.rb

@@ -105,7 +105,7 @@ describe AMQP::Boilerplate::Consumer do
         @queue.should_receive(:bind).with(@exchange_name, anything)
         BarConsumer.start
       end
-      
+
       it "should pass an empty hash when no amqp_exchange options are defined" do
         BarConsumer.amqp_exchange(@exchange_name)
         @queue.should_receive(:bind).with(anything, {})
@@ -130,4 +130,47 @@ describe AMQP::Boilerplate::Consumer do
       end
     end
   end
+
+  describe "#handle_message_wrapper" do
+    before(:each) do
+      @consumer = BarConsumer.new
+
+      @metadata = mock("metadata")
+      @payload = "payload"
+    end
+
+    it "should let handle_message do the heavy lifting" do
+      @consumer.should_receive(:handle_message).with(@metadata, @payload)
+      @consumer.handle_message_wrapper(@metadata, @payload)
+    end
+
+    describe "when a StandardError-like error is raised" do
+      before(:each) do
+        @consumer.stub(:handle_message).and_raise(StandardError)
+      end
+
+      it "should be caught" do
+        expect {
+          @consumer.handle_message_wrapper(@metadata, @payload)
+        }.to_not raise_error
+      end
+
+      it "should log" do
+        AMQP::Boilerplate.logger.should_receive(:error)
+        @consumer.handle_message_wrapper(@metadata, @payload)
+      end
+    end
+
+    describe "when a NotImplementedError is raised" do
+      before(:each) do
+        @consumer.stub(:handle_message).and_raise(NotImplementedError)
+      end
+
+      it "should not be caught" do
+        expect {
+          @consumer.handle_message_wrapper(@metadata, @payload)
+        }.to raise_error(NotImplementedError)
+      end
+    end
+  end
 end

data/spec/amqp/boilerplate_spec.rb

@@ -49,7 +49,7 @@ describe AMQP::Boilerplate do
         PhusionPassenger = Class.new
         PhusionPassenger.stub(:on_event).and_yield(true)
 
-        @thread = mock(Thread, :abort_on_exception= => nil)
+        @thread = mock(Thread)
         Thread.stub(:new).and_yield.and_return(@thread)
       end
 
@@ -67,11 +67,6 @@ describe AMQP::Boilerplate do
         Thread.should_receive(:new)
         AMQP::Boilerplate.boot
       end
-
-      it "should abort thread on exception" do
-        @thread.should_receive(:abort_on_exception=).with(true)
-        AMQP::Boilerplate.boot
-      end
     end
   end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: amqp-boilerplate
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Patrick Baselier
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-20 00:00:00 +02:00
+date: 2011-09-21 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency