hutch 0.18.0 → 1.1.0

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

@@ -14,21 +14,36 @@ describe Hutch::ErrorHandlers::Airbrake do
 
     it "logs the error to Airbrake" do
       message_id = "1"
+      properties = OpenStruct.new(message_id: message_id)
       payload = "{}"
       consumer = double
       ex = error
       message = {
-        :error_class => ex.class.name,
-        :error_message => "#{ ex.class.name }: #{ ex.message }",
-        :backtrace => ex.backtrace,
-        :parameters => {
-          :payload => payload,
-          :consumer => consumer,
-        },
-        :cgi_data => ENV.to_hash,
+        payload: payload,
+        consumer: consumer,
+        cgi_data: ENV.to_hash,
       }
-      expect(::Airbrake).to receive(:notify_or_ignore).with(ex, message)
-      error_handler.handle(message_id, payload, consumer, ex)
+      expect(::Airbrake).to receive(:notify).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 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/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/honeybadger_spec.rb

@@ -14,6 +14,7 @@ describe Hutch::ErrorHandlers::Honeybadger do
 
     it "logs the error to Honeybadger" do
       message_id = "1"
+      properties = OpenStruct.new(message_id: message_id)
       payload = "{}"
       consumer = double
       ex = error
@@ -29,8 +30,29 @@ describe Hutch::ErrorHandlers::Honeybadger do
             :payload => payload
           }
       }
-      expect(::Honeybadger).to receive(:notify_or_ignore).with(message)
-      error_handler.handle(message_id, payload, consumer, ex)
+      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

@@ -4,12 +4,25 @@ describe Hutch::ErrorHandlers::Logger do
   let(:error_handler) { Hutch::ErrorHandlers::Logger.new }
 
   describe '#handle' do
+    let(:properties) { OpenStruct.new(message_id: "1") }
+    let(:payload) { "{}" }
     let(:error) { double(message: "Stuff went wrong", class: "RuntimeError",
                        backtrace: ["line 1", "line 2"]) }
 
     it "logs three separate lines" do
       expect(Hutch::Logging.logger).to receive(:error).exactly(3).times
-      error_handler.handle("1", "{}", double, error)
+      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

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

@@ -4,6 +4,8 @@ describe Hutch::ErrorHandlers::Sentry do
   let(:error_handler) { Hutch::ErrorHandlers::Sentry.new }
 
   describe '#handle' do
+    let(:properties) { OpenStruct.new(message_id: "1") }
+    let(:payload) { "{}" }
     let(:error) do
       begin
         raise "Stuff went wrong"
@@ -13,8 +15,25 @@ describe Hutch::ErrorHandlers::Sentry do
     end
 
     it "logs the error to Sentry" do
-      expect(Raven).to receive(:capture_exception).with(error)
-      error_handler.handle("1", "{}", double, error)
+      expect(::Sentry).to receive(:capture_exception).with(error).and_call_original
+
+      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(::Sentry).to receive(:capture_exception).with(error).and_call_original
+
+      error_handler.handle_setup_exception(error)
     end
   end
 end

data/spec/hutch/logger_spec.rb

@@ -3,24 +3,30 @@ require 'spec_helper'
 describe Hutch::Logging do
   let(:dummy_object) do
     class DummyObject
-      include Hutch::Logging
+      include described_class
     end
   end
 
   describe '#logger' do
+    around do |example|
+      old_logger = described_class.logger
+      described_class.setup_logger
+      example.run
+      described_class.logger = old_logger
+    end
+
     context 'with the default logger' do
-      subject { Hutch::Logging.logger }
+      subject { described_class.logger }
 
       it { is_expected.to be_instance_of(Logger) }
     end
 
     context 'with a custom logger' do
-      let(:dummy_logger) { double("Dummy logger", warn: true, info: true) }
-      after { Hutch::Logging.setup_logger }
+      let(:dummy_logger) { double("Dummy logger") }
 
       it "users the custom logger" do
-        Hutch::Logging.logger = dummy_logger
-        expect(Hutch::Logging.logger).to eq(dummy_logger)
+        described_class.logger = dummy_logger
+        expect(described_class.logger).to eq(dummy_logger)
       end
     end
   end

data/spec/hutch/message_spec.rb

@@ -2,10 +2,10 @@ require 'hutch/message'
 
 describe Hutch::Message do
   let(:delivery_info) { double('Delivery Info') }
-  let(:props) { double('Properties') }
+  let(:props) { double('Properties', content_type: "application/json") }
   let(:body) {{ foo: 'bar' }.with_indifferent_access}
   let(:json_body) { MultiJson.dump(body) }
-  subject(:message) { Hutch::Message.new(delivery_info, props, json_body) }
+  subject(:message) { Hutch::Message.new(delivery_info, props, json_body, Hutch::Config[:serializer]) }
 
   describe '#body' do
     subject { super().body }

data/spec/hutch/serializers/json_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Hutch::Serializers::JSON do
+  let(:subject) { described_class }
+
+  it "encode/decode" do
+    payload = { a: 1, b: 2 }
+    encoded = subject.encode(payload)
+    decoded = subject.decode(encoded)
+
+    expect(encoded).to eq "{\"a\":1,\"b\":2}"
+    expect(decoded).to eq("a" => 1, "b" => 2)
+    expect(decoded[:a]).to eq 1
+    expect(decoded[:b]).to eq 2
+  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/waiter_spec.rb

@@ -0,0 +1,51 @@
+require 'hutch/waiter'
+
+RSpec.describe Hutch::Waiter do
+  describe '.wait_until_signaled' do
+    let(:pid) { Process.pid }
+    def start_kill_thread(signal)
+      Thread.new do
+        # sleep allows the worker time to set up the signal handling
+        # before the kill signal is sent.
+        sleep 0.001
+        Process.kill signal, pid
+      end
+    end
+
+    context 'a QUIT signal is received', if: RSpec::Support::Ruby.mri? do
+      it 'logs that hutch is stopping' do
+        expect(Hutch::Logging.logger).to receive(:info)
+          .with('caught SIGQUIT, stopping hutch...')
+
+        start_kill_thread('QUIT')
+        described_class.wait_until_signaled
+      end
+    end
+
+    context 'a TERM signal is received', if: !defined?(JRUBY_VERSION) do
+      it 'logs that hutch is stopping' do
+        expect(Hutch::Logging.logger).to receive(:info)
+          .with('caught SIGTERM, stopping hutch...')
+
+        start_kill_thread('TERM')
+        described_class.wait_until_signaled
+      end
+    end
+
+    context 'a INT signal is received', if: !defined?(JRUBY_VERSION) do
+      it 'logs that hutch is stopping' do
+        expect(Hutch::Logging.logger).to receive(:info)
+          .with('caught SIGINT, stopping hutch...')
+
+        start_kill_thread('INT')
+        described_class.wait_until_signaled
+      end
+    end
+  end
+
+  describe described_class::SHUTDOWN_SIGNALS do
+    it 'includes only things in Signal.list.keys' do
+      expect(described_class).to eq(described_class & Signal.list.keys)
+    end
+  end
+end