hutch 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9c376d628987a9352a8ff9e49cd48ae0c12364cc3f9393185e8c811ff3052213
-  data.tar.gz: 3aa07c8285817c1fefa10b7dc2b65e3fccf0b62ffbaf7a89e4b09f9a6db67035
+  metadata.gz: 6d1384ceb1b05cbdb706ac6e0f4cd4bfbdd86a49cbc2b6f61dabf96c1ca80ab5
+  data.tar.gz: d83a7db8184ed5baa8c00649de3d62a711ee07c04a598802193c1f6d4f7c97c8
 SHA512:
-  metadata.gz: 0c0ba8155050290ebe63628ce10f9fdbd93e4ec483ce8e465564f9635913082d662f2b9f05ca3227f5ad6f5d9c773e9e9653abfbc867f816db0ddf589093d388
-  data.tar.gz: 2ef54abbde9959378b15d1e60062b62ae0b55e8299029fa4fade407f6f9006b6df327f547dc2ba771638fa8d1e512860f0a78f4dc1fe145b337afb4d4000ea64
+  metadata.gz: 703c57b0c1e7ab3774d2fae904b6e7aa84f98b8f512ce8676c8456e63a4da4b97ab8dd77a460353d88c39d95997c70ca19695f6710bbde1674e6a03aa70a222b
+  data.tar.gz: 9fea55e47720b5cf78f834d714a709ada538cb851edcb5f17fc9ad2b587f68dffcc5c5524c2855d9673da322378d4fda19d85554a90c3f1d993726f7790da912

data/.github/workflows/test.yml

@@ -1,13 +1,10 @@
 name: Test
 
-concurrency: 
+concurrency:
   group: ${{ github.ref }}
   cancel-in-progress: true
 
-on:
-  push:
-    branches: [ master ]
-  pull_request:
+on: [push,pull_request,workflow_dispatch]
 
 jobs:
   test:
@@ -25,13 +22,15 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby-version: 
-          - 2.7
-          - 3.0
-          - 3.1
+        ruby-version:
+          - '2.7'
+          - '3.0'
+          - '3.1'
+          - '3.2'
+          - '3.3'
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Ruby
     # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
     # change this to (see https://github.com/ruby/setup-ruby#versioning):

data/CHANGELOG.md

@@ -1,4 +1,24 @@
+## 1.3.0 (Nov 11, 2024)
+
+### Ruby 3.2 Compatibility
+
+GitHub issue: [#392](https://github.com/ruby-amqp/hutch/pull/392)
+
+### Relaxed ActiveSupport Dependency Constraints
+
+Contributed by drobny.
+
+GitHub issue: [#402](https://github.com/ruby-amqp/hutch/pull/402)
+
+### Client-Provided Connection Name
+
+Contributed by @sharshenov.
+
+GitHub issue: [#399](https://github.com/ruby-amqp/hutch/pull/399)
+
+
 ## 1.1.1 (March 18th, 2022)
+
 ### Dependency Bump
 
 Hutch now allows ActiveSupport 7.x.

data/Gemfile

@@ -1,13 +1,13 @@
 source 'https://rubygems.org'
 
-ruby '>= 2.3.0'
+ruby '>= 2.7.0'
 
 gemspec
 
 group :development do
   gem "rake"
-  gem "guard", "~> 2.14", platform: :mri_23
-  gem "guard-rspec", "~> 4.7", platform: :mri_23
+  gem "guard", "~> 2.14", platform: :mri
+  gem "guard-rspec", "~> 4.7", platform: :mri
 
   gem "yard", "~> 0.9"
   gem 'kramdown', "> 0", platform: :jruby
@@ -16,21 +16,20 @@ group :development do
 end
 
 group :development, :test do
-  gem "rspec", "~> 3.5"
-  gem "simplecov", "~> 0.12"
+  gem "rspec", "~> 3.12"
+  gem "simplecov", "~> 0.21"
 
   gem "sentry-raven"
   gem "sentry-ruby"
   gem "honeybadger"
-  gem "coveralls", "~> 0.8.15", require: false
   gem "newrelic_rpm"
-  gem "ddtrace", "~> 0.54.2"
-  gem "airbrake", "~> 10.0"
+  gem "ddtrace", "~> 1.8"
+  gem "airbrake", "~> 13.0"
   gem "rollbar"
   gem "bugsnag"
 end
 
 group :development, :darwin do
-  gem "rb-fsevent", "~> 0.9"
+  gem "rb-fsevent", "~> 0.11.2"
   gem "growl", "~> 1.0.3"
 end

data/README.md

@@ -406,6 +406,7 @@ Known configuration parameters are:
  * `error_acknowledgements`: a chain of responsibility of objects that acknowledge/reject/requeue messages when an
     exception happens, see classes in `Hutch::Acknowledgements`.
  * `mq_exchange`: exchange to use for publishing (default: `hutch`)
+ * `mq_client_properties`: Bunny's [client properties](https://www.rabbitmq.com/docs/connections#capabilities) (default: `{}`)
  * `heartbeat`: [RabbitMQ heartbeat timeout](http://rabbitmq.com/heartbeats.html) (default: `30`)
  * `connection_timeout`: Bunny's socket open timeout (default: `11`)
  * `read_timeout`: Bunny's socket read timeout (default: `11`)
@@ -542,6 +543,13 @@ Generate with
       <td><tt>HUTCH_CHANNEL_PREFETCH</tt></td>
       <td><p>The <tt>basic.qos</tt> prefetch value to use.</p></td>
     </tr>
+    <tr>
+      <td><tt>connection_name</tt></td>
+      <td>nil</td>
+      <td>String</td>
+      <td><tt>HUTCH_CONNECTION_NAME</tt></td>
+      <td><p><a href="https://www.rabbitmq.com/docs/connections#client-provided-names">Client-Provided Connection Name</a></p></td>
+    </tr>
     <tr>
       <td><tt>connection_timeout</tt></td>
       <td>11</td>

data/hutch.gemspec

@@ -3,20 +3,20 @@ require File.expand_path('../lib/hutch/version', __FILE__)
 Gem::Specification.new do |gem|
   if defined?(JRUBY_VERSION)
     gem.platform = 'java'
-    gem.add_runtime_dependency 'march_hare', '>= 3.0.0'
+    gem.add_runtime_dependency 'march_hare', '>= 4.5.0'
   else
     gem.platform = Gem::Platform::RUBY
-    gem.add_runtime_dependency 'bunny', '>= 2.19', '< 3.0'
+    gem.add_runtime_dependency 'bunny', '>= 2.23', '< 3.0'
   end
   gem.add_runtime_dependency 'carrot-top', '~> 0.0.7'
   gem.add_runtime_dependency 'multi_json', '~> 1.15'
-  gem.add_runtime_dependency 'activesupport', '>= 4.2', '< 8'
+  gem.add_runtime_dependency 'activesupport', '>= 4.2', '<= 8'
 
   gem.name = 'hutch'
   gem.summary = 'Opinionated asynchronous inter-service communication using RabbitMQ'
   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.2'
+  gem.required_ruby_version = '>= 2.6'
   gem.authors = ['Harry Marr', 'Michael Klishin']
   gem.homepage = 'https://github.com/ruby-amqp/hutch'
   gem.require_paths = ['lib']

data/lib/hutch/broker.rb

@@ -1,6 +1,7 @@
 require 'active_support/core_ext/object/blank'
 
 require 'carrot-top'
+require 'ostruct'
 require 'hutch/logging'
 require 'hutch/exceptions'
 require 'hutch/publisher'
@@ -298,6 +299,8 @@ module Hutch
           params[:tls_ca_certificates] = @config[:mq_tls_ca_certificates]
         end
         params[:heartbeat]          = @config[:heartbeat]
+        params[:client_properties]  = @config[:mq_client_properties]
+        params[:connection_name]    = @config[:connection_name]
         params[:connection_timeout] = @config[:connection_timeout]
         params[:read_timeout]       = @config[:read_timeout]
         params[:write_timeout]      = @config[:write_timeout]

data/lib/hutch/cli.rb

@@ -234,7 +234,7 @@ module Hutch
     end
 
     def abort_without_file(file, file_description, &block)
-      abort_with_message("#{file_description} '#{file}' not found") unless File.exists?(file)
+      abort_with_message("#{file_description} '#{file}' not found") unless File.exist?(file)
 
       yield
     end

data/lib/hutch/config.rb

@@ -86,6 +86,9 @@ module Hutch
     # Default: `0`, no limit. See Bunny and RabbitMQ documentation.
     number_setting :channel_prefetch, 0
 
+    # [Client-Provided Connection Name](https://www.rabbitmq.com/docs/connections#client-provided-names)
+    string_setting :connection_name, nil
+
     # Bunny's socket open timeout
     number_setting :connection_timeout, 11
 
@@ -171,6 +174,7 @@ module Hutch
     # @return [Hash]
     def self.default_config
       @settings_defaults.merge({
+        mq_client_properties: {},
         mq_exchange_options: {},
         mq_tls_cert: nil,
         mq_tls_key: nil,

data/lib/hutch/tracers/datadog.rb

@@ -1,4 +1,5 @@
 require 'ddtrace'
+require 'ddtrace/auto_instrument'
 
 module Hutch
   module Tracers
@@ -8,7 +9,7 @@ module Hutch
       end
 
       def handle(message)
-        ::Datadog.tracer.trace(@klass.class.name, service: 'hutch', span_type: 'rabbitmq') do
+        ::Datadog::Tracing.trace(@klass.class.name, continue_from: nil, service: 'hutch', type: 'rabbitmq') do
           @klass.process(message)
         end
       end

data/lib/hutch/version.rb

@@ -1,3 +1,3 @@
 module Hutch
-  VERSION = '1.2.0'.freeze
+  VERSION = '1.3.0'.freeze
 end

data/lib/hutch/worker.rb

@@ -74,7 +74,7 @@ module Hutch
       @broker.ack(delivery_info.delivery_tag) unless consumer_instance.message_rejected?
     rescue => ex
       acknowledge_error(delivery_info, properties, @broker, ex)
-      handle_error(properties, payload, consumer, ex)
+      handle_error(properties, payload, consumer, ex, delivery_info)
     end
 
     def with_tracing(klass)
@@ -83,7 +83,7 @@ module Hutch
 
     def handle_error(*args)
       Hutch::Config[:error_handlers].each do |backend|
-        backend.handle(*args)
+        backend.handle *args.first(backend.method(:handle).arity)
       end
     end
 

data/spec/hutch/error_handlers/bugsnag_spec.rb

@@ -8,6 +8,7 @@ describe Hutch::ErrorHandlers::Bugsnag do
   before do
     Bugsnag.configure do |bugsnag|
       bugsnag.api_key = "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
+      bugsnag.logger = Logger.new(File::NULL) # suppress logging
     end
   end
 

data/spec/hutch/error_handlers/sentry_raven_spec.rb

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

data/spec/hutch/tracers/datadog_spec.rb

@@ -1,6 +1,8 @@
 require 'spec_helper'
 
 RSpec.describe Hutch::Tracers::Datadog do
+  ::Datadog.logger.level = Logger::FATAL # suppress logging
+  
   describe "#handle" do
     subject(:handle) { tracer.handle(message) }
 
@@ -25,14 +27,14 @@ RSpec.describe Hutch::Tracers::Datadog do
     let(:message) { double(:message) }
 
     before do
-      allow(Datadog.tracer).to receive(:trace).and_call_original
+      allow(::Datadog::Tracing).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'))
+      expect(::Datadog::Tracing).to have_received(:trace).with('ClassName',
+        hash_including(service: 'hutch', type: 'rabbitmq'))
     end
 
     it 'processes the message' do

data/spec/hutch/worker_spec.rb

@@ -69,29 +69,32 @@ describe Hutch::Worker do
   end
 
   describe '#handle_message' do
+    subject { worker.handle_message(consumer, delivery_info, properties, payload) }
     let(:payload) { '{}' }
     let(:consumer_instance) { double('Consumer instance') }
     let(:delivery_info) { double('Delivery Info', routing_key: '',
                                  delivery_tag: 'dt') }
     let(:properties) { double('Properties', message_id: nil, content_type: "application/json") }
+    let(:log) { StringIO.new }
     before { allow(consumer).to receive_messages(new: consumer_instance) }
     before { allow(broker).to receive(:ack) }
     before { allow(broker).to receive(:nack) }
     before { allow(consumer_instance).to receive(:broker=) }
     before { allow(consumer_instance).to receive(:delivery_info=) }
+    before { allow(Hutch::Logging).to receive(:logger).and_return(Logger.new(log)) }
 
     it 'passes the message to the consumer' do
       expect(consumer_instance).to receive(:process).
                         with(an_instance_of(Hutch::Message))
       expect(consumer_instance).to receive(:message_rejected?).and_return(false)
-      worker.handle_message(consumer, delivery_info, properties, payload)
+      subject
     end
 
     it 'acknowledges the message' do
       allow(consumer_instance).to receive(:process)
       expect(broker).to receive(:ack).with(delivery_info.delivery_tag)
       expect(consumer_instance).to receive(:message_rejected?).and_return(false)
-      worker.handle_message(consumer, delivery_info, properties, payload)
+      subject
     end
 
     context 'when the consumer fails and a requeue is configured' do
@@ -108,40 +111,79 @@ describe Hutch::Worker do
         expect(broker).to_not receive(:nack)
         expect(broker).to receive(:requeue)
 
-        worker.handle_message(consumer, delivery_info, properties, payload)
+        subject
       end
     end
 
 
     context 'when the consumer raises an exception' do
+      let(:expected_log) { /ERROR .+ error in consumer .+ RuntimeError .+ backtrace:/m }
       before { allow(consumer_instance).to receive(:process).and_raise('a consumer error') }
 
       it 'logs the error' do
-        Hutch::Config[:error_handlers].each do |backend|
-          expect(backend).to receive(:handle)
-        end
-        worker.handle_message(consumer, delivery_info, properties, payload)
+        expect { subject }.to change { log.tap(&:rewind).read }.from("").to(expected_log)
       end
 
       it 'rejects the message' do
         expect(broker).to receive(:nack).with(delivery_info.delivery_tag)
-        worker.handle_message(consumer, delivery_info, properties, payload)
+        subject
+      end
+
+      context 'when a custom error handler supports delivery info' do
+        let(:error_handler) do
+          Class.new(Hutch::ErrorHandlers::Base) do
+            def handle(_properties, _payload, _consumer, _ex, delivery_info)
+              raise unless delivery_info.delivery_tag == 'dt'
+              puts 'handled!'
+            end
+          end
+        end
+
+        around do |example|
+          original = Hutch::Config[:error_handlers]
+          Hutch::Config[:error_handlers] = [error_handler.new]
+          example.run
+          Hutch::Config[:error_handlers] = original
+        end
+
+        it 'calls the custom handler with delivery info' do
+          expect { subject }.to output("handled!\n").to_stdout
+        end
+      end
+
+      context 'when a custom error handler does not support delivery info' do
+        let(:error_handler) do
+          Class.new(Hutch::ErrorHandlers::Base) do
+            def handle(_properties, _payload, _consumer, _ex)
+              puts 'handled!'
+            end
+          end
+        end
+
+        around do |example|
+          original = Hutch::Config[:error_handlers]
+          Hutch::Config[:error_handlers] = [error_handler.new]
+          example.run
+          Hutch::Config[:error_handlers] = original
+        end
+
+        it 'calls the custom handler with delivery info' do
+          expect { subject }.to output("handled!\n").to_stdout
+        end
       end
     end
 
     context "when the payload is not valid json" do
       let(:payload) { "Not Valid JSON" }
+      let(:expected_log) { /ERROR .+ error in consumer .+ MultiJson::ParseError .+ backtrace:/m }
 
       it 'logs the error' do
-        Hutch::Config[:error_handlers].each do |backend|
-          expect(backend).to receive(:handle)
-        end
-        worker.handle_message(consumer, delivery_info, properties, payload)
+        expect { subject }.to change { log.tap(&:rewind).read }.from("").to(expected_log)
       end
 
       it 'rejects the message' do
         expect(broker).to receive(:nack).with(delivery_info.delivery_tag)
-        worker.handle_message(consumer, delivery_info, properties, payload)
+        subject
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hutch
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Harry Marr
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-20 00:00:00.000000000 Z
+date: 2024-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -17,7 +17,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.19'
+        version: '2.23'
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
@@ -27,7 +27,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '2.19'
+        version: '2.23'
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
@@ -66,7 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
-    - - "<"
+    - - "<="
       - !ruby/object:Gem::Version
         version: '8'
   type: :runtime
@@ -76,7 +76,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
-    - - "<"
+    - - "<="
       - !ruby/object:Gem::Version
         version: '8'
 description: Hutch is a Ruby library for enabling asynchronous inter-service communication
@@ -178,14 +178,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Opinionated asynchronous inter-service communication using RabbitMQ