hutch 0.18.0 → 1.1.0

data/spec/hutch/worker_spec.rb

@@ -3,10 +3,23 @@ require 'hutch/worker'
 
 describe Hutch::Worker do
   let(:consumer) { double('Consumer', routing_keys: %w( a b c ),
-                          get_queue_name: 'consumer', get_arguments: {}) }
+                          get_queue_name: 'consumer', get_arguments: {},
+                          get_serializer: nil) }
   let(:consumers) { [consumer, double('Consumer')] }
   let(:broker) { Hutch::Broker.new }
-  subject(:worker) { Hutch::Worker.new(broker, consumers) }
+  let(:setup_procs) { Array.new(2) { Proc.new {} } }
+  subject(:worker) { Hutch::Worker.new(broker, consumers, setup_procs) }
+
+  describe ".#run" do
+    it "calls each setup proc" do
+      setup_procs.each { |prc| expect(prc).to receive(:call) }
+      allow(worker).to receive(:setup_queues)
+      allow(Hutch::Waiter).to receive(:wait_until_signaled)
+      allow(broker).to receive(:stop)
+
+      worker.run
+    end
+  end
 
   describe '#setup_queues' do
     it 'sets up queues for each of the consumers' do
@@ -19,7 +32,6 @@ describe Hutch::Worker do
 
   describe '#setup_queue' do
     let(:queue) { double('Queue', bind: nil, subscribe: nil) }
-    before { allow(worker).to receive_messages(consumer_queue: queue) }
     before { allow(broker).to receive_messages(queue: queue, bind_queue: nil) }
 
     it 'creates a queue' do
@@ -33,9 +45,27 @@ describe Hutch::Worker do
     end
 
     it 'sets up a subscription' do
-      expect(queue).to receive(:subscribe).with(manual_ack: true)
+      expect(queue).to receive(:subscribe).with(consumer_tag: %r(^hutch\-.{36}$), manual_ack: true)
       worker.setup_queue(consumer)
     end
+
+    context 'with a configured consumer tag prefix' do
+      before { Hutch::Config.set(:consumer_tag_prefix, 'appname') }
+
+      it 'sets up a subscription with the configured tag prefix' do
+        expect(queue).to receive(:subscribe).with(consumer_tag: %r(^appname\-.{36}$), manual_ack: true)
+        worker.setup_queue(consumer)
+      end
+    end
+
+    context 'with a configured consumer tag prefix that is too long' do
+      let(:maximum_size) { 255 - SecureRandom.uuid.size - 1 }
+      before { Hutch::Config.set(:consumer_tag_prefix, 'a'.*(maximum_size + 1)) }
+
+      it 'raises an error' do
+        expect { worker.setup_queue(consumer) }.to raise_error(/Tag must be 255 bytes long at most/)
+      end
+    end
   end
 
   describe '#handle_message' do
@@ -43,7 +73,7 @@ describe Hutch::Worker do
     let(:consumer_instance) { double('Consumer instance') }
     let(:delivery_info) { double('Delivery Info', routing_key: '',
                                  delivery_tag: 'dt') }
-    let(:properties) { double('Properties', message_id: nil) }
+    let(:properties) { double('Properties', message_id: nil, content_type: "application/json") }
     before { allow(consumer).to receive_messages(new: consumer_instance) }
     before { allow(broker).to receive(:ack) }
     before { allow(broker).to receive(:nack) }
@@ -62,6 +92,25 @@ describe Hutch::Worker do
       worker.handle_message(consumer, delivery_info, properties, payload)
     end
 
+    context 'when the consumer fails and a requeue is configured' do
+
+      it 'requeues the message' do
+        allow(consumer_instance).to receive(:process).and_raise('failed')
+        requeuer = double
+        allow(requeuer).to receive(:handle) { |delivery_info, properties, broker, e|
+          broker.requeue delivery_info.delivery_tag
+          true
+        }
+        allow(worker).to receive(:error_acknowledgements).and_return([requeuer])
+        expect(broker).to_not receive(:ack)
+        expect(broker).to_not receive(:nack)
+        expect(broker).to receive(:requeue)
+
+        worker.handle_message(consumer, delivery_info, properties, payload)
+      end
+    end
+
+
     context 'when the consumer raises an exception' do
       before { allow(consumer_instance).to receive(:process).and_raise('a consumer error') }
 
@@ -94,5 +143,40 @@ describe Hutch::Worker do
       end
     end
   end
+
+
+  describe '#acknowledge_error' do
+    let(:delivery_info) { double('Delivery Info', routing_key: '',
+                                 delivery_tag: 'dt') }
+    let(:properties) { double('Properties', message_id: 'abc123') }
+
+    subject { worker.acknowledge_error delivery_info, properties, broker, StandardError.new }
+
+    it 'stops when it runs a successful acknowledgement' do
+      skip_ack = double handle: false
+      always_ack = double handle: true
+      never_used = double handle: true
+
+      allow(worker).
+        to receive(:error_acknowledgements).
+        and_return([skip_ack, always_ack, never_used])
+
+      expect(never_used).to_not receive(:handle)
+
+      subject
+    end
+
+    it 'defaults to nacking' do
+      skip_ack = double handle: false
+
+      allow(worker).
+        to receive(:error_acknowledgements).
+        and_return([skip_ack, skip_ack])
+
+      expect(broker).to receive(:nack)
+
+      subject
+    end
+  end
 end
 

data/spec/spec_helper.rb

@@ -13,8 +13,10 @@ require 'raven'
 require 'hutch'
 require 'logger'
 
+# set logger to be a null logger
+Hutch::Logging.logger = Logger.new(File::NULL)
+
 RSpec.configure do |config|
-  config.before(:all) { Hutch::Config.log_level = Logger::FATAL }
   config.raise_errors_for_deprecations!
 
   if defined?(JRUBY_VERSION)
@@ -22,6 +24,10 @@ RSpec.configure do |config|
   else
     config.filter_run_excluding adapter: :march_hare
   end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
 end
 
 # Constants (classes, etc) defined within a block passed to this method
@@ -34,7 +40,3 @@ ensure
     Object.send(:remove_const, constant)
   end
 end
-
-def deep_copy(obj)
-  Marshal.load(Marshal.dump(obj))
-end

data/templates/default/class/setup.rb

@@ -0,0 +1,4 @@
+def init
+  super
+  sections.push :settings
+end

data/templates/default/fulldoc/html/css/hutch.css

@@ -0,0 +1,13 @@
+.settings {
+  border-spacing: 2.5rem;
+  border-collapse: collapse;
+}
+
+.settings thead th {
+  text-align: left;
+}
+
+.settings thead th,
+.settings tbody td {
+  padding: .5em 1em;
+}

data/templates/default/layout/html/setup.rb

@@ -0,0 +1,7 @@
+def init
+  super
+end
+
+def stylesheets
+  super + %w(css/hutch.css)
+end

data/templates/default/method_details/html/settings.erb

@@ -0,0 +1,5 @@
+<% if object['custom_field'] %>
+<p>
+  <%= object['custom_field'] %>
+</p>
+<% end %>

data/templates/default/method_details/setup.rb

@@ -0,0 +1,4 @@
+def init
+  super
+  sections.last.place(:settings).after(:source)
+end

data/templates/default/module/html/settings.erb

@@ -0,0 +1,40 @@
+<% if object['setting_rows'] %>
+  <h2>
+    Configuration
+  </h2>
+
+  <div class="tags">
+    <table border="1" class="settings">
+      <thead>
+        <tr>
+          <th>
+            Setting name
+          </th>
+          <th>
+            Default value
+          </th>
+          <th>
+            Type
+          </th>
+          <th>
+            ENV variable
+          </th>
+          <th>
+            Description
+          </th>
+        </tr>
+      </thead>
+      <tbody>
+      <% for setting in object['setting_rows'] %>
+        <tr>
+          <td><tt><%= resolve_links "{Hutch::Config##{setting[:name]} #{setting[:name]}}" %></tt></td>
+          <td><%= setting[:default_value] %></td>
+          <td><%= setting[:type] %></td>
+          <td><tt>HUTCH_<%= setting[:name].upcase %></tt></td>
+          <td><%= html_markup_markdown setting[:first_line_of_description] %></td>
+        </tr>
+      <% end %>
+      </tbody>
+    </table>
+  </div>
+<% end %>

data/templates/default/module/setup.rb

@@ -0,0 +1,4 @@
+def init
+  super
+  sections.place(:settings).before(:children)
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hutch
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Harry Marr
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-08-16 00:00:00.000000000 Z
+date: 2021-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -16,14 +16,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: '2.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: '2.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: carrot-top
   requirement: !ruby/object:Gem::Requirement
@@ -44,56 +50,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.14'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '1.14'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+        version: '4.2'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.7.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: '7'
 description: Hutch is a Ruby library for enabling asynchronous inter-service communication
   using RabbitMQ.
 email:
@@ -104,19 +88,24 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".travis.yml"
+- ".yardopts"
 - CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE
 - README.md
 - Rakefile
+- bin/ci/before_build.sh
+- bin/ci/install_on_debian.sh
 - bin/hutch
-- circle.yml
 - examples/consumer.rb
 - examples/producer.rb
 - hutch.gemspec
 - lib/hutch.rb
+- lib/hutch/acknowledgements/base.rb
+- lib/hutch/acknowledgements/nack_on_all_failures.rb
 - lib/hutch/adapter.rb
 - lib/hutch/adapters/bunny.rb
 - lib/hutch/adapters/march_hare.rb
@@ -126,35 +115,61 @@ 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/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
+- lib/hutch/publisher.rb
+- 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
+- lib/hutch/waiter.rb
 - lib/hutch/worker.rb
+- lib/yard-settings/handler.rb
+- lib/yard-settings/yard-settings.rb
 - 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
 - spec/spec_helper.rb
+- templates/default/class/html/settings.erb
+- templates/default/class/setup.rb
+- templates/default/fulldoc/html/css/hutch.css
+- templates/default/layout/html/setup.rb
+- templates/default/method_details/html/settings.erb
+- templates/default/method_details/setup.rb
+- templates/default/method_details/text/settings.erb
+- templates/default/module/html/settings.erb
+- templates/default/module/setup.rb
 homepage: https://github.com/gocardless/hutch
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -162,16 +177,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Easy inter-service communication using RabbitMQ.
 test_files:
@@ -180,12 +194,17 @@ test_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
 - spec/spec_helper.rb
-has_rdoc: 

data/circle.yml

@@ -1,3 +0,0 @@
-machine:
-  services:
-    - rabbitmq-server