hutch 0.25.0.pre.rc1 → 0.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 720fbfbc59995920a3fa51951df1e692af84a36e
-  data.tar.gz: 30fd95c8766d99b42c6a8a45cf3575dce1219e0b
+  metadata.gz: 6f166e0937fb1f468d18247afad90ff52263de57
+  data.tar.gz: 97b3c87cd087984409fda36f620c180a71df03d8
 SHA512:
-  metadata.gz: 99b267d79bc4497f353cb96735058c770d42545ed76eb4f53033a1518fc809e11fd68dd6e14ab1a17ccf96bdc8a816b9aeba1fd4dee5d03231e701a0d98be3c8
-  data.tar.gz: c3a36d75316070a6bcf163d7ac3e2c0e39e179f34f8e8db2d9ae5dc56fd9b666d931e734ac7352cba143c313835eb28d4659d0fe0569450f1c1ab32e02068ffd
+  metadata.gz: 549463d55e4bfa5ee9b112c42a06c98999c25ab14a8562ef41adc75888f8eba30a42ebe39097ec7366939ad0ef44e38d6ffab8103f6f739f7e2aad68e955488c
+  data.tar.gz: 55972b247cb63587772adc3f12d40e852d6332c9991e08ddba7c388a4ab711851d81e3399b8d0c7407c2a16584f20f8c59aaede191f9eb41cd1d46208a0acb29

data/.travis.yml

@@ -1,16 +1,13 @@
 language: ruby
 cache: bundler
 before_install:
-  - gem update --system
   - gem install bundler
 matrix:
   include:
-    - rvm: 2.4.1
-    - rvm: 2.3.4
-    - rvm: 2.2.7
-    - rvm: 2.1
-    - rvm: 2.0
-    - rvm: jruby-9.1.12.0
+    - rvm: 2.4.2
+    - rvm: 2.3.5
+    - rvm: 2.2.8
+    - rvm: jruby-9.1.15.0
       jdk: oraclejdk8
       env:
         - JRUBY_OPTS='--debug'

data/Gemfile

@@ -23,7 +23,7 @@ group :development, :test do
   gem "honeybadger"
   gem "coveralls", "~> 0.8.15", require: false
   gem "newrelic_rpm"
-  gem "airbrake", "~> 5.0"
+  gem "airbrake", "~> 7.0"
   gem "opbeat", "~> 3.0.9"
 end
 

data/hutch.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |gem|
     gem.add_runtime_dependency 'march_hare', '>= 3.0.0'
   else
     gem.platform = Gem::Platform::RUBY
-    gem.add_runtime_dependency 'bunny', '>= 2.7.0'
+    gem.add_runtime_dependency 'bunny', '~> 2.9.0'
   end
   gem.add_runtime_dependency 'carrot-top', '~> 0.0.7'
   gem.add_runtime_dependency 'multi_json', '~> 1.12'
@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
   gem.description = 'Hutch is a Ruby library for enabling asynchronous ' \
                     'inter-service communication using RabbitMQ.'
   gem.version = Hutch::VERSION.dup
-  gem.required_ruby_version = '>= 2.0'
+  gem.required_ruby_version = '>= 2.2'
   gem.authors = ['Harry Marr']
   gem.email = ['developers@gocardless.com']
   gem.homepage = 'https://github.com/gocardless/hutch'

data/lib/hutch/broker.rb

@@ -11,6 +11,24 @@ module Hutch
 
     attr_accessor :connection, :channel, :exchange, :api_client
 
+
+    DEFAULT_AMQP_PORT =
+      case RUBY_ENGINE
+      when "jruby" then
+        com.rabbitmq.client.ConnectionFactory::DEFAULT_AMQP_PORT
+      when "ruby" then
+        AMQ::Protocol::DEFAULT_PORT
+      end
+
+    DEFAULT_AMQPS_PORT =
+      case RUBY_ENGINE
+      when "jruby" then
+        com.rabbitmq.client.ConnectionFactory::DEFAULT_AMQP_OVER_SSL_PORT
+      when "ruby" then
+        AMQ::Protocol::TLS_PORT
+      end
+
+
     # @param config [nil,Hash] Configuration override
     def initialize(config = nil)
       @config = config || Hutch::Config
@@ -292,13 +310,18 @@ module Hutch
 
       u = URI.parse(@config[:uri])
 
+      @config[:mq_tls]      = u.scheme == 'amqps'
       @config[:mq_host]     = u.host
-      @config[:mq_port]     = u.port
+      @config[:mq_port]     = u.port || default_mq_port
       @config[:mq_vhost]    = u.path.sub(/^\//, "")
       @config[:mq_username] = u.user
       @config[:mq_password] = u.password
     end
 
+    def default_mq_port
+      @config[:mq_tls] ? DEFAULT_AMQPS_PORT : DEFAULT_AMQP_PORT
+    end
+
     def sanitized_uri
       p = connection_params
       scheme = p[:tls] ? "amqps" : "amqp"

data/lib/hutch/cli.rb

@@ -90,6 +90,9 @@ module Hutch
       @worker.run
       :success
     rescue ConnectionError, AuthenticationError, WorkerSetupError => ex
+      Hutch::Config[:error_handlers].each do |backend|
+        backend.handle_setup_exception(ex)
+      end
       logger.fatal ex.message
       :error
     end
@@ -189,6 +192,10 @@ module Hutch
           Hutch::Config.pidfile = pidfile
         end
 
+        opts.on('--only-group GROUP', 'Load only consumers in this group') do |group|
+          Hutch::Config.group = group
+        end
+
         opts.on('--version', 'Print the version and exit') do
           puts "hutch v#{VERSION}"
           exit 0

data/lib/hutch/config.rb

@@ -136,6 +136,8 @@ module Hutch
     # Prefix displayed on the consumers tags.
     string_setting :consumer_tag_prefix, 'hutch'
 
+    string_setting :group, ''
+
     # Set of all setting keys
     ALL_KEYS = @boolean_keys + @number_keys + @string_keys
 
@@ -167,6 +169,7 @@ module Hutch
         # that will fall back to "nack unconditionally"
         error_acknowledgements: [],
         setup_procs: [],
+        consumer_groups: {},
         tracer: Hutch::Tracers::NullTracer,
         namespace: nil,
         pidfile: nil,

data/lib/hutch/error_handlers/airbrake.rb

@@ -1,10 +1,10 @@
 require 'hutch/logging'
 require 'airbrake'
+require 'hutch/error_handlers/base'
 
 module Hutch
   module ErrorHandlers
-    class Airbrake
-      include Logging
+    class Airbrake < Base
 
       def handle(properties, payload, consumer, ex)
         message_id = properties.message_id
@@ -31,6 +31,24 @@ module Hutch
           })
         end
       end
+
+      def handle_setup_exception(ex)
+        logger.error "Logging setup exception to Airbrake"
+        logger.error "#{ex.class} - #{ex.message}"
+
+        if ::Airbrake.respond_to?(:notify_or_ignore)
+          ::Airbrake.notify_or_ignore(ex, {
+            error_class: ex.class.name,
+            error_message: "#{ ex.class.name }: #{ ex.message }",
+            backtrace: ex.backtrace,
+            cgi_data: ENV.to_hash,
+          })
+        else
+          ::Airbrake.notify(ex, {
+            cgi_data: ENV.to_hash,
+          })
+        end
+      end
     end
   end
 end

data/lib/hutch/error_handlers/base.rb

@@ -0,0 +1,15 @@
+module Hutch
+  module ErrorHandlers
+    class Base
+      include Logging
+
+      def handle(properties, payload, consumer, ex)
+        raise NotImplementedError.new
+      end
+
+      def handle_setup_exception(ex)
+        raise NotImplementedError.new
+      end
+    end
+  end
+end

data/lib/hutch/error_handlers/honeybadger.rb

@@ -1,11 +1,11 @@
 require 'hutch/logging'
 require 'honeybadger'
+require 'hutch/error_handlers/base'
 
 module Hutch
   module ErrorHandlers
     # Error handler for the Honeybadger.io service
-    class Honeybadger
-      include Logging
+    class Honeybadger < Base
 
       def handle(properties, payload, consumer, ex)
         message_id = properties.message_id
@@ -20,6 +20,14 @@ module Hutch
                            parameters: { payload: payload })
       end
 
+      def handle_setup_exception(ex)
+        logger.error "Logging setup exception to Honeybadger"
+        logger.error "#{ex.class} - #{ex.message}"
+        notify_honeybadger(error_class: ex.class.name,
+                           error_message: "#{ex.class.name}: #{ex.message}",
+                           backtrace: ex.backtrace)
+      end
+
       # Wrap API to support 3.0.0+
       #
       # @see https://github.com/honeybadger-io/honeybadger-ruby/blob/master/CHANGELOG.md#300---2017-02-06
@@ -27,7 +35,7 @@ module Hutch
         if ::Honeybadger.respond_to?(:notify_or_ignore)
           ::Honeybadger.notify_or_ignore(message)
         else
-          ::Honeybadger.notify(message.merge(force: true))
+          ::Honeybadger.notify(message)
         end
       end
     end

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/opbeat.rb

@@ -1,10 +1,10 @@
 require 'hutch/logging'
 require 'opbeat'
+require 'hutch/error_handlers/base'
 
 module Hutch
   module ErrorHandlers
-    class Opbeat
-      include Logging
+    class Opbeat < Base
 
       def initialize
         unless ::Opbeat.respond_to?(:report)
@@ -19,6 +19,12 @@ module Hutch
         logger.error "#{prefix} #{ex.class} - #{ex.message}"
         ::Opbeat.report(ex, extra: { payload: payload })
       end
+
+      def handle_setup_exception(ex)
+        logger.error "Logging setup exception to Opbeat"
+        logger.error "#{ex.class} - #{ex.message}"
+        ::Opbeat.report(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/version.rb

@@ -1,4 +1,4 @@
 module Hutch
-  VERSION = '0.25.0-rc1'.freeze
+  VERSION = '0.25.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
+        !allowed_consumers.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/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

@@ -34,4 +34,25 @@ describe Hutch::ErrorHandlers::Honeybadger do
       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/opbeat_spec.rb

@@ -19,4 +19,19 @@ describe Hutch::ErrorHandlers::Opbeat do
       error_handler.handle(properties, payload, double, error)
     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 Opbeat" do
+      expect(Opbeat).to receive(:report).with(error)
+      error_handler.handle_setup_exception(error)
+    end
+  end
 end

data/spec/hutch/error_handlers/sentry_spec.rb

@@ -19,4 +19,19 @@ describe Hutch::ErrorHandlers::Sentry do
       error_handler.handle(properties, payload, double, error)
     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 Sentry" do
+      expect(Raven).to receive(:capture_exception).with(error)
+      error_handler.handle_setup_exception(error)
+    end
+  end
 end

data/spec/hutch/worker_spec.rb

@@ -97,7 +97,7 @@ describe Hutch::Worker do
       it 'requeues the message' do
         allow(consumer_instance).to receive(:process).and_raise('failed')
         requeuer = double
-        allow(requeuer).to receive(:handle).ordered { |delivery_info, properties, broker, e|
+        allow(requeuer).to receive(:handle) { |delivery_info, properties, broker, e|
           broker.requeue delivery_info.delivery_tag
           true
         }

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: hutch
 version: !ruby/object:Gem::Version
-  version: 0.25.0.pre.rc1
+  version: 0.25.0
 platform: ruby
 authors:
 - Harry Marr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-27 00:00:00.000000000 Z
+date: 2018-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: 2.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: 2.9.0
 - !ruby/object:Gem::Dependency
   name: carrot-top
   requirement: !ruby/object:Gem::Requirement
@@ -107,6 +107,7 @@ files:
 - lib/hutch/consumer.rb
 - lib/hutch/error_handlers.rb
 - lib/hutch/error_handlers/airbrake.rb
+- lib/hutch/error_handlers/base.rb
 - lib/hutch/error_handlers/honeybadger.rb
 - lib/hutch/error_handlers/logger.rb
 - lib/hutch/error_handlers/opbeat.rb
@@ -164,15 +165,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Easy inter-service communication using RabbitMQ.