hutch 0.28.0 → 1.1.1

data/lib/hutch/error_handlers/sentry.rb

@@ -1,31 +1,26 @@
 require 'hutch/logging'
-require 'raven'
+require 'sentry-ruby'
 require 'hutch/error_handlers/base'
 
 module Hutch
   module ErrorHandlers
     class Sentry < Base
-
-      def initialize
-        unless Raven.respond_to?(:capture_exception)
-          raise "The Hutch Sentry error handler requires Raven >= 0.4.0"
-        end
-      end
-
       def handle(properties, payload, consumer, ex)
         message_id = properties.message_id
         prefix = "message(#{message_id || '-'}):"
         logger.error "#{prefix} Logging event to Sentry"
         logger.error "#{prefix} #{ex.class} - #{ex.message}"
-        Raven.capture_exception(ex, extra: { payload: payload })
+        ::Sentry.configure_scope do |scope|
+          scope.set_context("payload", payload)
+        end
+        ::Sentry.capture_exception(ex)
       end
 
       def handle_setup_exception(ex)
         logger.error "Logging setup exception to Sentry"
         logger.error "#{ex.class} - #{ex.message}"
-        Raven.capture_exception(ex)
+        ::Sentry.capture_exception(ex)
       end
-
     end
   end
 end

data/lib/hutch/error_handlers/sentry_raven.rb

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

@@ -2,8 +2,10 @@ module Hutch
   module ErrorHandlers
     autoload :Logger,      'hutch/error_handlers/logger'
     autoload :Sentry,      'hutch/error_handlers/sentry'
+    autoload :SentryRaven, 'hutch/error_handlers/sentry_raven'
     autoload :Honeybadger, 'hutch/error_handlers/honeybadger'
     autoload :Airbrake,    'hutch/error_handlers/airbrake'
     autoload :Rollbar,     'hutch/error_handlers/rollbar'
+    autoload :Bugsnag,     'hutch/error_handlers/bugsnag'
   end
 end

data/lib/hutch/serializers/json.rb

@@ -6,7 +6,7 @@ module Hutch
     class JSON
 
       def self.encode(payload)
-        ::JSON.dump(payload)
+        ::MultiJson.dump(payload)
       end
 
       def self.decode(payload)

data/lib/hutch/tracers/datadog.rb

@@ -0,0 +1,17 @@
+require 'ddtrace'
+
+module Hutch
+  module Tracers
+    class Datadog
+      def initialize(klass)
+        @klass = klass
+      end
+
+      def handle(message)
+        ::Datadog.tracer.trace(@klass.class.name, service: 'hutch', span_type: 'rabbitmq') do
+          @klass.process(message)
+        end
+      end
+    end
+  end
+end

data/lib/hutch/tracers.rb

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

data/lib/hutch/version.rb

@@ -1,3 +1,3 @@
 module Hutch
-  VERSION = '0.28.0'.freeze
+  VERSION = '1.1.1'.freeze
 end

data/lib/hutch/worker.rb

@@ -47,7 +47,7 @@ module Hutch
     def setup_queue(consumer)
       logger.info "setting up queue: #{consumer.get_queue_name}"
 
-      queue = @broker.queue(consumer.get_queue_name, consumer.get_arguments)
+      queue = @broker.queue(consumer.get_queue_name, consumer.get_options)
       @broker.bind_queue(queue, consumer.routing_keys)
 
       queue.subscribe(consumer_tag: unique_consumer_tag, manual_ack: true) do |*args|

data/spec/hutch/broker_spec.rb

@@ -262,7 +262,7 @@ describe Hutch::Broker do
         args.first == ''
         args.last == arguments
       end
-      broker.queue('test', arguments)
+      broker.queue('test', arguments: arguments)
     end
   end
 

data/spec/hutch/config_spec.rb

@@ -49,6 +49,44 @@ describe Hutch::Config do
       context 'sets value in user config hash' do
         it { is_expected.to eq(new_value) }
       end
+
+      context 'type casting' do
+        context 'number attributes' do
+          before  { Hutch::Config.set(:heartbeat, new_value) }
+          subject(:value) { Hutch::Config.user_config[:heartbeat] }
+
+          let(:new_value) { "0" }
+
+
+          specify 'casts values to integers' do
+            expect(value).to eq 0
+          end
+        end
+      end
+
+      context 'boolean attributes' do
+        before  { Hutch::Config.set(:autoload_rails, new_value) }
+        subject(:value) { Hutch::Config.user_config[:autoload_rails] }
+
+        let(:new_value) { "t" }
+
+
+        specify 'casts values to booleans' do
+          expect(value).to eq true
+        end
+      end
+
+      context 'string attributes' do
+        before  { Hutch::Config.set(:mq_exchange_type, new_value) }
+        subject(:value) { Hutch::Config.user_config[:mq_exchange_type] }
+
+        let(:new_value) { 1 }
+
+
+        specify 'does not perform any typecasting' do
+          expect(value).to eq new_value
+        end
+      end
     end
 
     context 'for invalid attributes' do

data/spec/hutch/consumer_spec.rb

@@ -28,17 +28,30 @@ describe Hutch::Consumer do
     ComplexConsumer
   end
 
-  let(:consumer_with_custom_queue_options) do
-    unless defined? ConsumerWithCustomQueueOptions
-      class ConsumerWithCustomQueueOptions
+  let(:consumer_using_quorum_queue) do
+    unless defined? ConsumerUsingQuorumQueue
+      class ConsumerUsingQuorumQueue
         include Hutch::Consumer
         consume 'hutch.test1'
         arguments foo: :bar
-        lazy_queue
+        
         quorum_queue
       end
     end
-    ConsumerWithCustomQueueOptions
+    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
@@ -84,26 +97,33 @@ describe Hutch::Consumer do
     end
   end
 
-  describe '.lazy_queue' do
-    it 'does not use lazy mode by default' do
-      expect(simple_consumer.queue_mode).to eq('default')
+  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_with_custom_queue_options.queue_mode).to eq('lazy')
+        expect(consumer_using_classic_queue.queue_mode).to eq('lazy')
       end
     end
   end
 
-  describe '.quorum_queue' do
-    it 'does not have quorum type by default' do
-      expect(simple_consumer.queue_type).to eq('classic')
+  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_with_custom_queue_options.queue_type).to eq('quorum')
+        expect(consumer_using_quorum_queue.queue_type).to eq('quorum')
       end
 
       it 'accepts initial group size as an option' do
@@ -125,34 +145,26 @@ describe Hutch::Consumer do
   end
 
   describe '.get_arguments' do
-
     context 'when defined' do
       it { expect(complex_consumer.get_arguments).to include(foo: :bar) }
     end
 
-    context 'when not defined' do
-      it 'has the default values for queue custom options' do
-        expect(simple_consumer.get_arguments).to have_key('x-queue-mode')
-          .and have_key('x-queue-type')
-      end
-    end
-
     context 'when queue is lazy' do
       it 'has the x-queue-mode argument set to lazy' do
-        expect(consumer_with_custom_queue_options.get_arguments['x-queue-mode'])
+        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_with_custom_queue_options.get_arguments }
+      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_with_custom_queue_options.quorum_queue(initial_group_size: 5)
+        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

data/spec/hutch/error_handlers/bugsnag_spec.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe Hutch::ErrorHandlers::Bugsnag do
+  let(:error_handler) { described_class.new }
+
+  before do
+    Bugsnag.configure do |bugsnag|
+      bugsnag.api_key = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+    end
+  end
+
+  describe "#handle" do
+    let(:error) do
+      begin
+        raise "Stuff went wrong"
+      rescue RuntimeError => err
+        err
+      end
+    end
+
+    it "logs the error to Bugsnag" do
+      message_id = "1"
+      properties = OpenStruct.new(message_id: message_id)
+      payload = "{}"
+      consumer = double
+      ex = error
+      message = {
+        payload: payload,
+        consumer: consumer
+      }
+
+      expect(::Bugsnag).to receive(:notify).with(ex).and_call_original
+      expect_any_instance_of(::Bugsnag::Report).to receive(:add_tab).with(:hutch, 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 Bugsnag" do
+      ex = error
+      expect(::Bugsnag).to receive(:notify).with(ex)
+      error_handler.handle_setup_exception(ex)
+    end
+  end
+end

data/spec/hutch/error_handlers/sentry_raven_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Hutch::ErrorHandlers::SentryRaven do
+  let(:error_handler) { Hutch::ErrorHandlers::SentryRaven.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 Sentry" do
+      expect(Raven).to receive(:capture_exception).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 Sentry" do
+      expect(Raven).to receive(:capture_exception).with(error)
+      error_handler.handle_setup_exception(error)
+    end
+  end
+end

data/spec/hutch/error_handlers/sentry_spec.rb

@@ -15,7 +15,8 @@ describe Hutch::ErrorHandlers::Sentry do
     end
 
     it "logs the error to Sentry" do
-      expect(Raven).to receive(:capture_exception).with(error, extra: { payload: payload })
+      expect(::Sentry).to receive(:capture_exception).with(error).and_call_original
+
       error_handler.handle(properties, payload, double, error)
     end
   end
@@ -30,7 +31,8 @@ describe Hutch::ErrorHandlers::Sentry do
     end
 
     it "logs the error to Sentry" do
-      expect(Raven).to receive(:capture_exception).with(error)
+      expect(::Sentry).to receive(:capture_exception).with(error).and_call_original
+
       error_handler.handle_setup_exception(error)
     end
   end

data/spec/hutch/tracers/datadog_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+RSpec.describe Hutch::Tracers::Datadog do
+  describe "#handle" do
+    subject(:handle) { tracer.handle(message) }
+
+    let(:tracer) { described_class.new(klass) }
+    let(:klass)  do
+      Class.new do
+        attr_reader :message
+
+        def initialize
+          @message = nil
+        end
+
+        def class
+          OpenStruct.new(name: 'ClassName')
+        end
+
+        def process(message)
+          @message = message
+        end
+      end.new
+    end
+    let(:message) { double(:message) }
+
+    before do
+      allow(Datadog.tracer).to receive(:trace).and_call_original
+    end
+
+    it 'uses Datadog tracer' do
+      handle
+
+      expect(Datadog.tracer).to have_received(:trace).with('ClassName',
+        hash_including(service: 'hutch', span_type: 'rabbitmq'))
+    end
+
+    it 'processes the message' do
+      expect {
+        handle
+      }.to change { klass.message }.from(nil).to(message)
+    end
+  end
+end

data/spec/hutch/worker_spec.rb

@@ -4,7 +4,7 @@ require 'hutch/worker'
 describe Hutch::Worker do
   let(:consumer) { double('Consumer', routing_keys: %w( a b c ),
                           get_queue_name: 'consumer', get_arguments: {},
-                          get_serializer: nil) }
+                          get_options: {}, get_serializer: nil) }
   let(:consumers) { [consumer, double('Consumer')] }
   let(:broker) { Hutch::Broker.new }
   let(:setup_procs) { Array.new(2) { Proc.new {} } }
@@ -35,7 +35,7 @@ describe Hutch::Worker do
     before { allow(broker).to receive_messages(queue: queue, bind_queue: nil) }
 
     it 'creates a queue' do
-      expect(broker).to receive(:queue).with(consumer.get_queue_name, consumer.get_arguments).and_return(queue)
+      expect(broker).to receive(:queue).with(consumer.get_queue_name, consumer.get_options).and_return(queue)
       worker.setup_queue(consumer)
     end
 

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: hutch
 version: !ruby/object:Gem::Version
-  version: 0.28.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Harry Marr
-autorequire: 
+- Michael Klishin
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-17 00:00:00.000000000 Z
+date: 2022-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -16,20 +17,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '2.19'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.16'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '2.19'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.16'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: carrot-top
   requirement: !ruby/object:Gem::Requirement
@@ -50,14 +51,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1.15'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +68,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -77,19 +78,18 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
 description: Hutch is a Ruby library for enabling asynchronous inter-service communication
-  using RabbitMQ.
+  using RabbitMQ
 email:
-- developers@gocardless.com
 executables:
 - hutch
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
 - Gemfile
@@ -98,6 +98,7 @@ files:
 - README.md
 - Rakefile
 - bin/ci/before_build.sh
+- bin/ci/before_build_docker.sh
 - bin/ci/install_on_debian.sh
 - bin/hutch
 - examples/consumer.rb
@@ -116,10 +117,12 @@ files:
 - lib/hutch/error_handlers.rb
 - lib/hutch/error_handlers/airbrake.rb
 - lib/hutch/error_handlers/base.rb
+- lib/hutch/error_handlers/bugsnag.rb
 - lib/hutch/error_handlers/honeybadger.rb
 - lib/hutch/error_handlers/logger.rb
 - lib/hutch/error_handlers/rollbar.rb
 - lib/hutch/error_handlers/sentry.rb
+- lib/hutch/error_handlers/sentry_raven.rb
 - lib/hutch/exceptions.rb
 - lib/hutch/logging.rb
 - lib/hutch/message.rb
@@ -127,6 +130,7 @@ files:
 - lib/hutch/serializers/identity.rb
 - lib/hutch/serializers/json.rb
 - lib/hutch/tracers.rb
+- lib/hutch/tracers/datadog.rb
 - lib/hutch/tracers/newrelic.rb
 - lib/hutch/tracers/null_tracer.rb
 - lib/hutch/version.rb
@@ -139,13 +143,16 @@ files:
 - spec/hutch/config_spec.rb
 - spec/hutch/consumer_spec.rb
 - spec/hutch/error_handlers/airbrake_spec.rb
+- spec/hutch/error_handlers/bugsnag_spec.rb
 - spec/hutch/error_handlers/honeybadger_spec.rb
 - spec/hutch/error_handlers/logger_spec.rb
 - spec/hutch/error_handlers/rollbar_spec.rb
+- spec/hutch/error_handlers/sentry_raven_spec.rb
 - spec/hutch/error_handlers/sentry_spec.rb
 - spec/hutch/logger_spec.rb
 - spec/hutch/message_spec.rb
 - spec/hutch/serializers/json_spec.rb
+- spec/hutch/tracers/datadog_spec.rb
 - spec/hutch/waiter_spec.rb
 - spec/hutch/worker_spec.rb
 - spec/hutch_spec.rb
@@ -159,11 +166,11 @@ files:
 - templates/default/method_details/text/settings.erb
 - templates/default/module/html/settings.erb
 - templates/default/module/setup.rb
-homepage: https://github.com/gocardless/hutch
+homepage: https://github.com/ruby-amqp/hutch
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -178,23 +185,26 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
-summary: Easy inter-service communication using RabbitMQ.
+summary: Opinionated asynchronous inter-service communication using RabbitMQ
 test_files:
 - spec/hutch/broker_spec.rb
 - spec/hutch/cli_spec.rb
 - spec/hutch/config_spec.rb
 - spec/hutch/consumer_spec.rb
 - spec/hutch/error_handlers/airbrake_spec.rb
+- spec/hutch/error_handlers/bugsnag_spec.rb
 - spec/hutch/error_handlers/honeybadger_spec.rb
 - spec/hutch/error_handlers/logger_spec.rb
 - spec/hutch/error_handlers/rollbar_spec.rb
+- spec/hutch/error_handlers/sentry_raven_spec.rb
 - spec/hutch/error_handlers/sentry_spec.rb
 - spec/hutch/logger_spec.rb
 - spec/hutch/message_spec.rb
 - spec/hutch/serializers/json_spec.rb
+- spec/hutch/tracers/datadog_spec.rb
 - spec/hutch/waiter_spec.rb
 - spec/hutch/worker_spec.rb
 - spec/hutch_spec.rb