hutch 0.24.0 → 1.0.0

data/lib/hutch/error_handlers/logger.rb

@@ -1,9 +1,9 @@
 require 'hutch/logging'
+require 'hutch/error_handlers/base'
 
 module Hutch
   module ErrorHandlers
-    class Logger
-      include Logging
+    class Logger < ErrorHandlers::Base
 
       def handle(properties, payload, consumer, ex)
         message_id = properties.message_id
@@ -12,6 +12,11 @@ module Hutch
         logger.error "#{prefix} #{ex.class} - #{ex.message}"
         logger.error (['backtrace:'] + ex.backtrace).join("\n")
       end
+
+      def handle_setup_exception(ex)
+        logger.error "#{ex.class} - #{ex.message}"
+        logger.error (['backtrace:'] + ex.backtrace).join("\n")
+      end
     end
   end
 end

data/lib/hutch/error_handlers/rollbar.rb

@@ -0,0 +1,28 @@
+require 'hutch/logging'
+require 'rollbar'
+require 'hutch/error_handlers/base'
+
+module Hutch
+  module ErrorHandlers
+    class Rollbar < Base
+      def handle(properties, payload, consumer, ex)
+        message_id = properties.message_id
+        prefix = "message(#{message_id || '-'}):"
+        logger.error "#{prefix} Logging event to Rollbar"
+        logger.error "#{prefix} #{ex.class} - #{ex.message}"
+
+        ::Rollbar.error(ex,
+          payload: payload,
+          consumer: consumer
+        )
+      end
+
+      def handle_setup_exception(ex)
+        logger.error "Logging setup exception to Rollbar"
+        logger.error "#{ex.class} - #{ex.message}"
+
+        ::Rollbar.error(ex)
+      end
+    end
+  end
+end

data/lib/hutch/error_handlers/sentry.rb

@@ -1,10 +1,10 @@
 require 'hutch/logging'
 require 'raven'
+require 'hutch/error_handlers/base'
 
 module Hutch
   module ErrorHandlers
-    class Sentry
-      include Logging
+    class Sentry < Base
 
       def initialize
         unless Raven.respond_to?(:capture_exception)
@@ -19,6 +19,13 @@ module Hutch
         logger.error "#{prefix} #{ex.class} - #{ex.message}"
         Raven.capture_exception(ex, extra: { payload: payload })
       end
+
+      def handle_setup_exception(ex)
+        logger.error "Logging setup exception to Sentry"
+        logger.error "#{ex.class} - #{ex.message}"
+        Raven.capture_exception(ex)
+      end
+
     end
   end
 end

data/lib/hutch/publisher.rb

@@ -42,7 +42,7 @@ module Hutch
     private
 
     def log_publication(serializer, payload, routing_key)
-      logger.info {
+      logger.debug {
         spec =
           if serializer.binary?
             "#{payload.bytesize} bytes message"

data/lib/hutch/tracers.rb

@@ -2,6 +2,5 @@ module Hutch
   module Tracers
     autoload :NullTracer, 'hutch/tracers/null_tracer'
     autoload :NewRelic,   'hutch/tracers/newrelic'
-    autoload :Opbeat,     'hutch/tracers/opbeat'
   end
 end

data/lib/hutch/version.rb

@@ -1,4 +1,3 @@
 module Hutch
-  VERSION = '0.24.0'.freeze
+  VERSION = '1.0.0'.freeze
 end
-

data/lib/hutch/waiter.rb

@@ -50,7 +50,7 @@ module Hutch
       end
     end
 
-    # @raises ContinueProcessingSignals
+    # @raise ContinueProcessingSignals
     def handle_user_signal(sig)
       case sig
       when 'USR2' then log_thread_backtraces

data/lib/hutch/worker.rb

@@ -36,12 +36,17 @@ module Hutch
     # Set up the queues for each of the worker's consumers.
     def setup_queues
       logger.info 'setting up queues'
-      @consumers.each { |consumer| setup_queue(consumer) }
+      vetted = @consumers.reject { |c| group_configured? && group_restricted?(c) }
+      vetted.each do |c|
+        setup_queue(c)
+      end
     end
 
     # Bind a consumer's routing keys to its queue, and set up a subscription to
     # receive messages sent to the queue.
     def setup_queue(consumer)
+      logger.info "setting up queue: #{consumer.get_queue_name}"
+
       queue = @broker.queue(consumer.get_queue_name, consumer.get_arguments)
       @broker.bind_queue(queue, consumer.routing_keys)
 
@@ -103,6 +108,30 @@ module Hutch
 
     private
 
+    def group_configured?
+      if group.present? && consumer_groups.blank?
+        logger.info 'Consumer groups are blank'
+      end
+      group.present?
+    end
+
+    def group_restricted?(consumer)
+      consumers_to_load = consumer_groups[group]
+      if consumers_to_load
+        !consumers_to_load.include?(consumer.name)
+      else
+        true
+      end
+    end
+
+    def group
+      Hutch::Config[:group]
+    end
+
+    def consumer_groups
+      Hutch::Config[:consumer_groups]
+    end
+
     attr_accessor :setup_procs
 
     def unique_consumer_tag

data/spec/hutch/broker_spec.rb

@@ -92,6 +92,40 @@ describe Hutch::Broker do
 
       connection.close
     end
+
+    context 'when configured with a URI' do
+      context 'which specifies the port' do
+        before { config[:uri] = 'amqp://guest:guest@127.0.0.1:5672/' }
+
+        it 'successfully connects' do
+          c = broker.open_connection
+          expect(c).to be_open
+          c.close
+        end
+      end
+
+      context 'which does not specify port and uses the amqp scheme' do
+        before { config[:uri] = 'amqp://guest:guest@127.0.0.1/' }
+
+        it 'successfully connects' do
+          c = broker.open_connection
+          expect(c).to be_open
+          c.close
+        end
+      end
+
+      context 'which specifies the amqps scheme' do
+        before { config[:uri] = 'amqps://guest:guest@127.0.0.1/' }
+
+        it 'utilises TLS' do
+          expect(Hutch::Adapter).to receive(:new).with(
+            hash_including(tls: true, port: 5671)
+          ).and_return(instance_double('Hutch::Adapter', start: nil))
+
+          broker.open_connection
+        end
+      end
+    end
   end
 
   describe '#open_connection!' do

data/spec/hutch/cli_spec.rb

@@ -4,6 +4,19 @@ require 'tempfile'
 describe Hutch::CLI do
   let(:cli) { Hutch::CLI.new }
 
+  describe "#start_work_loop" do
+    context "connection error during setup" do
+      let(:error) { Hutch::ConnectionError.new }
+      it "gets reported using error handlers" do
+        allow(Hutch).to receive(:connect).and_raise(error)
+        Hutch::Config[:error_handlers].each do |backend|
+          expect(backend).to receive(:handle_setup_exception).with(error)
+        end
+        cli.start_work_loop
+      end
+    end
+  end
+
   describe "#parse_options" do
     context "--config" do
       context "when the config file does not exist" do

data/spec/hutch/consumer_spec.rb

@@ -28,6 +28,32 @@ describe Hutch::Consumer do
     ComplexConsumer
   end
 
+  let(:consumer_using_quorum_queue) do
+    unless defined? ConsumerUsingQuorumQueue
+      class ConsumerUsingQuorumQueue
+        include Hutch::Consumer
+        consume 'hutch.test1'
+        arguments foo: :bar
+        
+        quorum_queue
+      end
+    end
+    ConsumerUsingQuorumQueue
+  end
+
+  let(:consumer_using_classic_queue) do
+    unless defined? ConsumerUsingLazyQueue
+      class ConsumerUsingLazyQueue
+        include Hutch::Consumer
+        consume 'hutch.test1'
+        arguments foo: :bar
+        lazy_queue
+        classic_queue
+      end
+    end
+    ConsumerUsingLazyQueue
+  end
+
   describe 'module inclusion' do
     it 'registers the class as a consumer' do
       expect(Hutch).to receive(:register_consumer) do |klass|
@@ -71,6 +97,43 @@ describe Hutch::Consumer do
     end
   end
 
+  describe 'default queue mode' do
+    it 'does not specify any mode by default' do
+      expect(simple_consumer.queue_mode).to eq(nil)
+      expect(simple_consumer.queue_type).to eq(nil)
+    end
+  end
+
+  describe '.lazy_queue' do
+    context 'when queue mode has been set explicitly to lazy' do
+      it 'sets queue mode to lazy' do
+        expect(consumer_using_classic_queue.queue_mode).to eq('lazy')
+      end
+    end
+  end
+
+  describe '.classic_queue' do
+    context 'when queue type has been set explicitly to classic' do
+      it 'sets queue type to classic' do
+        expect(consumer_using_classic_queue.queue_type).to eq('classic')
+      end
+    end
+  end
+
+  describe '.quorum_queue' do
+    context 'when queue type has been set explicitly to quorum' do
+      it 'sets queue type to quorum' do
+        expect(consumer_using_quorum_queue.queue_type).to eq('quorum')
+      end
+
+      it 'accepts initial group size as an option' do
+        consumer = simple_consumer
+        expect { consumer.quorum_queue(initial_group_size: 3) }
+          .to change { consumer.initial_group_size }.to(3)
+      end
+    end
+  end
+
   describe '.arguments' do
     let(:args) { { foo: :bar} }
 
@@ -82,15 +145,30 @@ describe Hutch::Consumer do
   end
 
   describe '.get_arguments' do
-
     context 'when defined' do
-      it { expect(complex_consumer.get_arguments).to eq(foo: :bar) }
+      it { expect(complex_consumer.get_arguments).to include(foo: :bar) }
     end
 
-    context 'when not defined' do
-      it { expect(simple_consumer.get_arguments).to eq({}) }
+    context 'when queue is lazy' do
+      it 'has the x-queue-mode argument set to lazy' do
+        expect(consumer_using_classic_queue.get_arguments['x-queue-mode'])
+          .to eq('lazy')
+      end
     end
 
+    context "when queue's type is quorum" do
+      let(:arguments) { consumer_using_quorum_queue.get_arguments }
+      it 'has the x-queue-type argument set to quorum' do
+        expect(arguments['x-queue-type']).to eq('quorum')
+        expect(arguments).to_not have_key('x-quorum-initial-group-size')
+      end
+
+      it 'has the x-quorum-initial-group-size argument set to quorum' do
+        consumer_using_quorum_queue.quorum_queue(initial_group_size: 5)
+        expect(arguments['x-queue-type']).to eq('quorum')
+        expect(arguments['x-quorum-initial-group-size']).to eq(5)
+      end
+    end
   end
 
   describe '.get_queue_name' do

data/spec/hutch/error_handlers/airbrake_spec.rb

@@ -27,4 +27,23 @@ describe Hutch::ErrorHandlers::Airbrake do
       error_handler.handle(properties, payload, consumer, ex)
     end
   end
+
+  describe '#handle_setup_exception' do
+    let(:error) do
+      begin
+        raise "Stuff went wrong"
+      rescue RuntimeError => err
+        err
+      end
+    end
+
+    it "logs the error to Airbrake" do
+      ex = error
+      message = {
+        cgi_data: ENV.to_hash,
+      }
+      expect(::Airbrake).to receive(:notify).with(ex, message)
+      error_handler.handle_setup_exception(ex)
+    end
+  end
 end

data/spec/hutch/error_handlers/honeybadger_spec.rb

@@ -30,8 +30,29 @@ describe Hutch::ErrorHandlers::Honeybadger do
             :payload => payload
           }
       }
-      expect(::Honeybadger).to receive(:notify_or_ignore).with(message)
+      expect(error_handler).to receive(:notify_honeybadger).with(message)
       error_handler.handle(properties, payload, consumer, ex)
     end
   end
+
+  describe '#handle_setup_exception' do
+    let(:error) do
+      begin
+        raise "Stuff went wrong during setup"
+      rescue RuntimeError => err
+        err
+      end
+    end
+
+    it "logs the error to Honeybadger" do
+      ex = error
+      message = {
+        :error_class => ex.class.name,
+          :error_message => "#{ ex.class.name }: #{ ex.message }",
+          :backtrace => ex.backtrace,
+      }
+      expect(error_handler).to receive(:notify_honeybadger).with(message)
+      error_handler.handle_setup_exception(ex)
+    end
+  end
 end

data/spec/hutch/error_handlers/logger_spec.rb

@@ -14,4 +14,15 @@ describe Hutch::ErrorHandlers::Logger do
       error_handler.handle(properties, payload, double, error)
     end
   end
+
+  describe '#handle_setup_exception' do
+    let(:error) { double(message: "Stuff went wrong during setup",
+                       class: "RuntimeError",
+                       backtrace: ["line 1", "line 2"]) }
+
+    it "logs two separate lines" do
+      expect(Hutch::Logging.logger).to receive(:error).exactly(2).times
+      error_handler.handle_setup_exception(error)
+    end
+  end
 end

data/spec/hutch/error_handlers/rollbar_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+describe Hutch::ErrorHandlers::Rollbar do
+  let(:error_handler) { Hutch::ErrorHandlers::Rollbar.new }
+
+  describe '#handle' do
+    let(:error) do
+      begin
+        raise "Stuff went wrong"
+      rescue RuntimeError => err
+        err
+      end
+    end
+
+    it "logs the error to Rollbar" do
+      message_id = "1"
+      properties = OpenStruct.new(message_id: message_id)
+      payload = "{}"
+      consumer = double
+      ex = error
+      message = {
+        payload: payload,
+        consumer: consumer
+      }
+      expect(::Rollbar).to receive(:error).with(ex, message)
+      error_handler.handle(properties, payload, consumer, ex)
+    end
+  end
+
+  describe '#handle_setup_exception' do
+    let(:error) do
+      begin
+        raise "Stuff went wrong"
+      rescue RuntimeError => err
+        err
+      end
+    end
+
+    it "logs the error to Rollbar" do
+      ex = error
+      expect(::Rollbar).to receive(:error).with(ex)
+      error_handler.handle_setup_exception(ex)
+    end
+  end
+end