hutch 0.25.0 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6f166e0937fb1f468d18247afad90ff52263de57
-  data.tar.gz: 97b3c87cd087984409fda36f620c180a71df03d8
+SHA256:
+  metadata.gz: eeb0e500b415b5c125335f93c9bdf6d7c44faf8588514cc0d9ff0d11d35e831c
+  data.tar.gz: 4b96383eb819a42a9ce517e05499c85dcdde49602eec5a00dcf40a65b915239d
 SHA512:
-  metadata.gz: 549463d55e4bfa5ee9b112c42a06c98999c25ab14a8562ef41adc75888f8eba30a42ebe39097ec7366939ad0ef44e38d6ffab8103f6f739f7e2aad68e955488c
-  data.tar.gz: 55972b247cb63587772adc3f12d40e852d6332c9991e08ddba7c388a4ab711851d81e3399b8d0c7407c2a16584f20f8c59aaede191f9eb41cd1d46208a0acb29
+  metadata.gz: 4988b67c0057b9bb06273a87bb824741f735c549b39535030d9acbeec246bb9d746a93306291907776c8582eef171a883e162c9dc94488f6360d3333af17051f
+  data.tar.gz: 863ec55200be7dfc18bf5c350f0dbf707e85b74c8397628113779a6c7858911ff9b65cd995e76526452811de32c05be0c94d6cf53d2387525735115faa35c777

data/.travis.yml

@@ -2,15 +2,21 @@ language: ruby
 cache: bundler
 before_install:
   - gem install bundler
+before_script:
+  - "./bin/ci/install_on_debian.sh"
+  - until sudo lsof -i:5672; do echo "Waiting for RabbitMQ to start..."; sleep 1; done
 matrix:
   include:
-    - rvm: 2.4.2
-    - rvm: 2.3.5
-    - rvm: 2.2.8
-    - rvm: jruby-9.1.15.0
-      jdk: oraclejdk8
-      env:
-        - JRUBY_OPTS='--debug'
+    - rvm: "2.6.1"
+    - rvm: "2.5.3"
+    - rvm: "2.4.5"
+    - rvm: "2.3.8"
+    - rvm: "jruby-9.2.6.0"
+    - rvm: "ruby-head"
+  allow_failures:
+    rvm:
+      - "jruby-9.2.6.0"
+      - ruby-head
 
 services:
   - rabbitmq

data/CHANGELOG.md

@@ -1,8 +1,99 @@
-## 0.25.0 — (unreleased)
+## 0.27.0
 
 No changes yet.
 
 
+## 0.26.0 (February 13th, 2019)
+
+### Dependency Bumps
+
+Bunny and other dependencies were updated to their latest release
+series.
+
+### Synchronized Connection Code
+
+The methods that connect to RabbitMQ are now synchronized which makes
+them safer to use in concurrent settings. Note that Hutch still
+uses a single Bunny channel which is not meant to be shared
+between threads without application-level synchronization for publishing.
+
+Contributed by Chris Barton.
+
+GitHub issue: [#308](https://github.com/gocardless/hutch/pull/308).
+
+### More Bunny Options Propagated
+
+Contributed by Damian Le Nouaille.
+
+GitHub issue: [#322](https://github.com/gocardless/hutch/pull/322).
+
+### Removed Opbeat Integration
+
+The service is no longer generally available.
+
+Contributed by Olle Jonsson.
+
+GitHub issue: [#313](https://github.com/gocardless/hutch/pull/313)
+
+
+## 0.25.0 - January 17th, 2018
+
+### Consumer groups
+
+Consumer groups allow you to run groups of consumers together, rather than running them
+all at once in a single process. You define groups in your config file, and then specify
+a `--only-group` option when starting up Hutch with `hutch`.
+
+Contributed by Nickolai Smirnov.
+
+GitHub pull request: [#296](https://github.com/gocardless/hutch/pull/296)
+
+### Fix configuring Hutch with a URI
+
+When Hutch is configured to connect to RabbitMQ with a URI, we should respect the
+`amqps` specification, defaulting to the standard protocol ports when not specified.
+
+This means, for example, that `amqp://guest:guest@127.0.0.1/` connects to the server on
+port 5672 and does not use TLS, whereas `amqps://guest:guest@127.0.0.1/` connects to the
+server on port 5671 and uses TLS.
+
+This behaviour was introduced in [#159](https://github.com/gocardless/hutch/pull/159) but
+broken since then. This fixes it, and includes tests.
+
+Contributed by Michael Canden-Lennox.
+
+GitHub pull request: [#305](https://github.com/gocardless/hutch/pull/305)
+
+### Pass exceptions when setting up the client to configured error handlers
+
+When an error occurs during Hutch's startup, it is currently not passed to the configured
+error handlers. This starts handling those exceptions.
+
+Contributed by Valentin Krasontovitsch.
+
+GitHub issue: [#288](https://github.com/gocardless/hutch/issues/288)
+GitHub pull request: [#301](https://github.com/gocardless/hutch/pull/301)
+
+### Log the Rails environment when running Hutch in verbose mode
+
+When starting up Hutch in verbose mode with `hutch -v`, the Rails environment is now
+logged.
+
+Contributed by [@wppurking](https://github.com/wppurking).
+
+GitHub pull request: [#282](https://github.com/gocardless/hutch/pull/282)
+
+### Make the Honeybadger error handler compatible with new versions of `honeybadger-ruby`
+
+[`honeybadger-ruby`](https://github.com/honeybadger-io/honeybadger-ruby/)
+[changed](https://github.com/honeybadger-io/honeybadger-ruby/blob/master/CHANGELOG.md#300---2017-02-06)
+its API in v3.0.0. This updates our error handler to work with that, whilst still
+maintaining our existing behaviour.
+
+Contributed by Olle Jonsson and Bill Ruddock.
+
+GitHub pull requests: [#274](https://github.com/gocardless/hutch/pull/274),
+[#290](https://github.com/gocardless/hutch/pull/290)
 
 ## 0.24.0 — February 1st, 2017
 
@@ -20,7 +111,7 @@ Hutch will now handle several OS signals:
 
  * `USR2` will log stack traces of all alive VM threads
  * `QUIT` (except on JRuby), `INT`, `TERM` will cause Hutch daemon to shut down
- 
+
  Contributed by Olle Jonsson.
 
 GitHub issues: [#263](https://github.com/gocardless/hutch/pull/263), [#271](https://github.com/gocardless/hutch/pull/271)
@@ -104,7 +195,7 @@ Contributed by Seamus Abshere.
 
 ### Worker: Log received messages using level DEBUG instead of INFO
 
-Received messages used to be logged using severity level INFO. 
+Received messages used to be logged using severity level INFO.
 This has been lowered to DEBUG.
 
 Contributed by Jesper Josefsson.
@@ -636,4 +727,3 @@ Hutch.global_properties = proc {
 ## 0.1.0 - September 9, 2013
 
 - Initial release
-

data/Gemfile

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-ruby RUBY_VERSION
+ruby '>= 2.3.0'
 
 gemspec
 
@@ -23,8 +23,7 @@ group :development, :test do
   gem "honeybadger"
   gem "coveralls", "~> 0.8.15", require: false
   gem "newrelic_rpm"
-  gem "airbrake", "~> 7.0"
-  gem "opbeat", "~> 3.0.9"
+  gem "airbrake", "~> 8.0"
 end
 
 group :development, :darwin do

data/README.md

@@ -2,7 +2,6 @@
 
 [![Gem Version](https://badge.fury.io/rb/hutch.svg)](http://badge.fury.io/rb/hutch)
 [![Build Status](https://travis-ci.org/gocardless/hutch.svg?branch=master)](https://travis-ci.org/gocardless/hutch)
-[![Dependency Status](https://gemnasium.com/gocardless/hutch.svg)](https://gemnasium.com/gocardless/hutch)
 [![Code Climate](https://codeclimate.com/github/gocardless/hutch.svg)](https://codeclimate.com/github/gocardless/hutch)
 
 Hutch is a Ruby library for enabling asynchronous inter-service communication
@@ -40,7 +39,7 @@ gem install hutch
 
 ## Requirements
 
-- Hutch requires Ruby 2.0+ or JRuby 9K.
+- Hutch requires Ruby 2.2+ or JRuby 9K.
 - Hutch requires RabbitMQ 3.3 or later.
 
 ## Overview
@@ -59,8 +58,9 @@ Hutch uses [Bunny](http://rubybunny.info) or [March Hare](http://rubymarchhare.i
 
 ### Project Maturity
 
-Hutch is a moderately mature project (started in early 2013)
-that was extracted from production systems.
+Hutch is a mature project that was originally extracted from production systems
+at [GoCardless](https://gocardless.com) in 2013 and is now maintained by a large
+group of contributors.
 
 ## Consumers
 
@@ -122,7 +122,7 @@ end
 
 This sets the `x-max-length` header. For more details, see the [RabbitMQ
 documentation on Queue Length Limit](https://www.rabbitmq.com/maxlength.html). To find out more
-about custom queue arguments, consult the [RabbitMQ documentation on AMQP Protocol Extensions](https://www.rabbitmq.com/extensions.html). 
+about custom queue arguments, consult the [RabbitMQ documentation on AMQP Protocol Extensions](https://www.rabbitmq.com/extensions.html).
 
 Consumers can write to Hutch's log by calling the logger method. The logger method returns
 a [Logger object](http://ruby-doc.org/stdlib-2.1.2/libdoc/logger/rdoc/Logger.html).
@@ -166,7 +166,7 @@ This will enable NewRelic custom instrumentation:
 Hutch::Config.set(:tracer, Hutch::Tracers::NewRelic)
 ```
 
-Batteries included! 
+Batteries included!
 
 ## Running Hutch
 
@@ -341,6 +341,8 @@ Known configuration parameters are:
  * `connection_timeout`: Bunny's socket open timeout (default: `11`)
  * `read_timeout`: Bunny's socket read timeout (default: `11`)
  * `write_timeout`: Bunny's socket write timeout (default: `11`)
+ * `automatically_recover`: Bunny's enable/disable network recovery (default: `true`)
+ * `network_recovery_interval`: Bunny's reconnect interval (default: `1`)
  * `tracer`: tracer to use to track message processing
 
 ### Environment variables
@@ -484,6 +486,20 @@ Generate with
       <td><tt>HUTCH_WRITE_TIMEOUT</tt></td>
       <td><p>Bunny's socket write timeout</p></td>
     </tr>
+    <tr>
+      <td><tt>automatically_recover</tt></td>
+      <td>true</td>
+      <td>Boolean</td>
+      <td><tt>HUTCH_AUTOMATICALLY_RECOVER</tt></td>
+      <td><p>Bunny's enable/disable network recovery</p></td>
+    </tr>
+    <tr>
+      <td><tt>network_recovery_interval</tt></td>
+      <td>1</td>
+      <td>Number</td>
+      <td><tt>HUTCH_NETWORK_RECOVERY_INTERVAL</tt></td>
+      <td><p>Bunny's reconnect interval</p></td>
+    </tr>
     <tr>
       <td><tt>graceful_exit_timeout</tt></td>
       <td>11</td>
@@ -570,8 +586,3 @@ Generate with
     </tr>
   </tbody>
 </table>
-
-
----
-
-GoCardless ♥ open source. If you do too, come [join us](https://gocardless.com/jobs/backend_developer).

data/bin/ci/install_on_debian.sh

@@ -0,0 +1,17 @@
+#!/bin/sh
+
+sudo apt-get install -y wget
+wget -O - "https://github.com/rabbitmq/signing-keys/releases/download/2.0/rabbitmq-release-signing-key.asc" | sudo apt-key add -
+
+sudo tee /etc/apt/sources.list.d/bintray.rabbitmq.list <<EOF
+deb https://dl.bintray.com/rabbitmq-erlang/debian xenial erlang
+deb https://dl.bintray.com/rabbitmq/debian xenial main
+EOF
+
+sudo apt-get update -y
+sudo apt-get upgrade -y
+sudo apt-get install -y rabbitmq-server
+
+sudo service rabbitmq-server start
+
+until sudo lsof -i:5672; do echo "Waiting for RabbitMQ to start..."; sleep 1; done

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.9.0'
+    gem.add_runtime_dependency 'bunny', '>= 2.12', '< 2.15'
   end
   gem.add_runtime_dependency 'carrot-top', '~> 0.0.7'
   gem.add_runtime_dependency 'multi_json', '~> 1.12'

data/lib/hutch.rb

@@ -14,6 +14,8 @@ require 'hutch/exceptions'
 require 'hutch/tracers'
 
 module Hutch
+  @@connection_mutex = Mutex.new
+
   def self.register_consumer(consumer)
     self.consumers << consumer
   end
@@ -40,10 +42,12 @@ module Hutch
   # @param config [Hash] Configuration
   # @option options [Boolean] :enable_http_api_use
   def self.connect(options = {}, config = Hutch::Config)
-    return if connected?
-
-    @broker = Hutch::Broker.new(config)
-    @broker.connect(options)
+    @@connection_mutex.synchronize do
+      unless connected?
+        @broker = Hutch::Broker.new(config)
+        @broker.connect(options)
+      end
+    end
   end
 
   def self.disconnect

data/lib/hutch/broker.rb

@@ -298,8 +298,8 @@ module Hutch
         params[:write_timeout]      = @config[:write_timeout]
 
 
-        params[:automatically_recover] = true
-        params[:network_recovery_interval] = 1
+        params[:automatically_recover] = @config[:automatically_recover]
+        params[:network_recovery_interval] = @config[:network_recovery_interval]
 
         params[:logger] = @config[:client_logger] if @config[:client_logger]
       end

data/lib/hutch/config.rb

@@ -89,6 +89,12 @@ module Hutch
     # Bunny's socket write timeout
     number_setting :write_timeout, 11
 
+    # Bunny's enable/disable network recovery
+    boolean_setting :automatically_recover, true
+
+    # Bunny's reconnect interval
+    number_setting :network_recovery_interval, 1
+
     # FIXME: DOCUMENT THIS
     number_setting :graceful_exit_timeout, 11
 

data/lib/hutch/error_handlers.rb

@@ -4,6 +4,5 @@ module Hutch
     autoload :Sentry,      'hutch/error_handlers/sentry'
     autoload :Honeybadger, 'hutch/error_handlers/honeybadger'
     autoload :Airbrake,    'hutch/error_handlers/airbrake'
-    autoload :Opbeat,      'hutch/error_handlers/opbeat'
   end
 end

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.25.0'.freeze
+  VERSION = '0.26.0'.freeze
 end
-

data/lib/hutch/worker.rb

@@ -118,7 +118,7 @@ module Hutch
     def group_restricted?(consumer)
       consumers_to_load = consumer_groups[group]
       if consumers_to_load
-        !allowed_consumers.include?(consumer.name)
+        !consumers_to_load.include?(consumer.name)
       else
         true
       end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: hutch
 version: !ruby/object:Gem::Version
-  version: 0.25.0
+  version: 0.26.0
 platform: ruby
 authors:
 - Harry Marr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-17 00:00:00.000000000 Z
+date: 2019-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.12'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.9.0
+        version: '2.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.12'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.9.0
+        version: '2.15'
 - !ruby/object:Gem::Dependency
   name: carrot-top
   requirement: !ruby/object:Gem::Requirement
@@ -91,6 +97,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/ci/install_on_debian.sh
 - bin/hutch
 - examples/consumer.rb
 - examples/producer.rb
@@ -110,7 +117,6 @@ files:
 - lib/hutch/error_handlers/base.rb
 - lib/hutch/error_handlers/honeybadger.rb
 - lib/hutch/error_handlers/logger.rb
-- lib/hutch/error_handlers/opbeat.rb
 - lib/hutch/error_handlers/sentry.rb
 - lib/hutch/exceptions.rb
 - lib/hutch/logging.rb
@@ -121,7 +127,6 @@ files:
 - lib/hutch/tracers.rb
 - lib/hutch/tracers/newrelic.rb
 - lib/hutch/tracers/null_tracer.rb
-- lib/hutch/tracers/opbeat.rb
 - lib/hutch/version.rb
 - lib/hutch/waiter.rb
 - lib/hutch/worker.rb
@@ -134,7 +139,6 @@ files:
 - spec/hutch/error_handlers/airbrake_spec.rb
 - spec/hutch/error_handlers/honeybadger_spec.rb
 - spec/hutch/error_handlers/logger_spec.rb
-- spec/hutch/error_handlers/opbeat_spec.rb
 - spec/hutch/error_handlers/sentry_spec.rb
 - spec/hutch/logger_spec.rb
 - spec/hutch/message_spec.rb
@@ -143,7 +147,6 @@ files:
 - spec/hutch/worker_spec.rb
 - spec/hutch_spec.rb
 - spec/spec_helper.rb
-- spec/tracers/opbeat_spec.rb
 - templates/default/class/html/settings.erb
 - templates/default/class/setup.rb
 - templates/default/fulldoc/html/css/hutch.css
@@ -172,8 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Easy inter-service communication using RabbitMQ.
@@ -185,7 +187,6 @@ test_files:
 - spec/hutch/error_handlers/airbrake_spec.rb
 - spec/hutch/error_handlers/honeybadger_spec.rb
 - spec/hutch/error_handlers/logger_spec.rb
-- spec/hutch/error_handlers/opbeat_spec.rb
 - spec/hutch/error_handlers/sentry_spec.rb
 - spec/hutch/logger_spec.rb
 - spec/hutch/message_spec.rb
@@ -194,4 +195,3 @@ test_files:
 - spec/hutch/worker_spec.rb
 - spec/hutch_spec.rb
 - spec/spec_helper.rb
-- spec/tracers/opbeat_spec.rb

data/lib/hutch/error_handlers/opbeat.rb

@@ -1,30 +0,0 @@
-require 'hutch/logging'
-require 'opbeat'
-require 'hutch/error_handlers/base'
-
-module Hutch
-  module ErrorHandlers
-    class Opbeat < Base
-
-      def initialize
-        unless ::Opbeat.respond_to?(:report)
-          raise "The Opbeat error handler requires Opbeat >= 3.0"
-        end
-      end
-
-      def handle(properties, payload, consumer, ex)
-        message_id = properties.message_id
-        prefix = "message(#{message_id || '-'}):"
-        logger.error "#{prefix} Logging event to Opbeat"
-        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/tracers/opbeat.rb

@@ -1,37 +0,0 @@
-require 'opbeat'
-
-module Hutch
-  module Tracers
-    # Tracer for Opbeat, which traces each message processed.
-    class Opbeat
-      KIND = 'messaging.hutch'.freeze
-
-      # @param klass [Consumer] Consumer instance (!)
-      def initialize(klass)
-        @klass = klass
-      end
-
-      # @param message [Message]
-      def handle(message)
-        ::Opbeat.transaction(sig, KIND, extra: extra_from(message)) do
-          @klass.process(message)
-        end.done(true)
-      end
-
-      private
-
-      def sig
-        @klass.class.name
-      end
-
-      def extra_from(message)
-        {
-          body: message.body.to_s,
-          message_id: message.message_id,
-          timestamp: message.timestamp,
-          routing_key: message.routing_key
-        }
-      end
-    end
-  end
-end

data/spec/hutch/error_handlers/opbeat_spec.rb

@@ -1,37 +0,0 @@
-require 'spec_helper'
-
-describe Hutch::ErrorHandlers::Opbeat do
-  let(:error_handler) { Hutch::ErrorHandlers::Opbeat.new }
-
-  describe '#handle' do
-    let(:properties) { OpenStruct.new(message_id: "1") }
-    let(:payload) { "{}" }
-    let(:error) do
-      begin
-        raise "Stuff went wrong"
-      rescue RuntimeError => err
-        err
-      end
-    end
-
-    it "logs the error to Opbeat" do
-      expect(Opbeat).to receive(:report).with(error, extra: { payload: payload })
-      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/tracers/opbeat_spec.rb

@@ -1,44 +0,0 @@
-require 'hutch/message'
-require 'hutch/serializers/identity'
-require 'hutch/tracers'
-
-RSpec.describe Hutch::Tracers::Opbeat do
-  let(:consumer) { double('the-consumer') }
-
-  subject(:tracer) { described_class.new(consumer) }
-
-  let(:message) do
-    Hutch::Message.new(double('the-delivery-info', routing_key: 'foo.bar',
-                                                   exchange: 'foo'),
-                       double('the-properties', message_id: 'the-id',
-                                                timestamp: 'the-time'),
-                       double('the-payload', to_s: 'the-body'),
-                       Hutch::Serializers::Identity)
-  end
-
-  it 'formats messages as extra information' do
-    expected_extra = {
-      body: 'the-body',
-      message_id: 'the-id',
-      timestamp: 'the-time',
-      routing_key: 'foo.bar'
-    }
-    expect(Opbeat).to receive(:transaction).with(anything,
-                                           'messaging.hutch',
-                                           extra: expected_extra) {
-                                             double('done-callback', done: true)
-                                           }
-
-    tracer.handle(message)
-  end
-
-  it 'presents consumer class name as Opbeat tracing signature' do
-    expect(Opbeat).to receive(:transaction).with(consumer.class.name,
-                                           'messaging.hutch',
-                                           anything) {
-                                             double('done-callback', done: true)
-                                           }
-
-    tracer.handle(message)
-  end
-end