Merge pull request #31 from Fatsoma/update/hutch_1.3.1

Update to upstream 1.3.1

Author: biinari

.circleci/config.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,16 +22,15 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby-version: 
-          - jruby-9.2.19.0
-          - jruby-9.3.0.0
-          - jruby-head
-          - 2.7
-          - 3.0
-          - 3.1
+        ruby-version:
+          - '2.7'
+          - '3.0'
+          - '3.1'
+          - '3.2'
+          - '3.3'
 
     steps:
-    - uses: actions/checkout@v2
+    - 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):

.github/workflows/test.yml

@@ -1,4 +1,37 @@
+## 1.3.2 (in development)
+
+No changes yet.
+
+## 1.3.1 (Dec 11, 2024)
+
+### Rails 8.x Compatibility
+
+Contributed by @drobny.
+
+GitHub issue: [#404](https://github.com/ruby-amqp/hutch/pull/404)
+
+
+## 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.

CHANGELOG.md

@@ -1,37 +1,35 @@
 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 "rake"
+  gem "guard", "~> 2.14", platform: :mri
+  gem "guard-rspec", "~> 4.7", platform: :mri
 
-  gem 'yard', '~> 0.9'
-  gem 'kramdown', '> 0', platform: :jruby
-  gem 'redcarpet', '> 0', platform: :mri
-  gem 'github-markup', '> 0'
+  gem "yard", "~> 0.9"
+  gem 'kramdown', "> 0", platform: :jruby
+  gem "redcarpet", "> 0", platform: :mri
+  gem "github-markup", "> 0"
 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 'rspec_junit_formatter', '~> 0.3.0'
-  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 'growl', '~> 1.0.3'
+  gem "rb-fsevent", "~> 0.11.2"
+  gem "growl", "~> 1.0.3"
 end

Gemfile

@@ -435,6 +435,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: `{}`)
  * `mq_wait_exchange`: exchange to use for waiting. Leave unset to not use a wait exchange.
  * `mq_wait_queue`: queue to use for waiting (default: `wait-queue`)
  * `heartbeat`: [RabbitMQ heartbeat timeout](http://rabbitmq.com/heartbeats.html) (default: `30`)
@@ -573,6 +574,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>

README.md

@@ -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'
 
   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']

hutch.gemspec

@@ -2,6 +2,7 @@
 
 require 'carrot-top'
 require 'forwardable'
+require 'ostruct'
 require 'hutch/logging'
 require 'hutch/exceptions'
 require 'hutch/publisher'
@@ -59,16 +60,16 @@ def connect(options = {})
       @options = options
       set_up_amqp_connection
       if http_api_use_enabled?
-        logger.info 'HTTP API use is enabled'
+        logger.info "HTTP API use is enabled"
         set_up_api_connection
       else
-        logger.info 'HTTP API use is disabled'
+        logger.info "HTTP API use is disabled"
       end
 
       if tracing_enabled?
         logger.info "tracing is enabled using #{@config[:tracer]}"
       else
-        logger.info 'tracing is disabled'
+        logger.info "tracing is disabled"
       end
 
       return unless block_given?
@@ -284,7 +285,7 @@ def api_config
         config.username = @config[:mq_username]
         config.password = @config[:mq_password]
         config.ssl = @config[:mq_api_ssl]
-        config.protocol = config.ssl ? 'https://' : 'http://'
+        config.protocol = config.ssl ? "https://" : "http://"
         config.sanitized_uri = "#{config.protocol}#{config.username}@#{config.host}:#{config.port}/"
       end
     end
@@ -296,6 +297,7 @@ def connection_params
         params[:host]               = @config[:mq_host]
         params[:port]               = @config[:mq_port]
         params[:vhost]              = @config[:mq_vhost].presence || Hutch::Adapter::DEFAULT_VHOST
+        params[:auth_mechanism]     = @config[:mq_auth_mechanism]
         params[:username]           = @config[:mq_username]
         params[:password]           = @config[:mq_password]
         params[:tls]                = @config[:mq_tls]
@@ -306,10 +308,13 @@ def connection_params
           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]
 
+
         params[:automatically_recover] = @config[:automatically_recover]
         params[:network_recovery_interval] = @config[:network_recovery_interval]
 
@@ -325,7 +330,7 @@ def parse_uri
       @config[:mq_tls]      = u.scheme == 'amqps'
       @config[:mq_host]     = u.host
       @config[:mq_port]     = u.port || default_mq_port
-      @config[:mq_vhost]    = u.path.sub(%r{^/}, '')
+      @config[:mq_vhost]    = u.path.sub(/^\//, "")
       @config[:mq_username] = u.user
       @config[:mq_password] = u.password
     end
@@ -336,9 +341,9 @@ def default_mq_port
 
     def sanitized_uri
       p = connection_params
-      scheme = p[:tls] ? 'amqps' : 'amqp'
+      scheme = p[:tls] ? "amqps" : "amqp"
 
-      "#{scheme}://#{p[:username]}@#{p[:host]}:#{p[:port]}/#{p[:vhost].sub(%r{^/}, '')}"
+      "#{scheme}://#{p[:username]}@#{p[:host]}:#{p[:port]}/#{p[:vhost].sub(/^\//, '')}"
     end
 
     def channel_work_pool

lib/hutch/broker.rb

@@ -63,6 +63,9 @@ def self.boolean_setting(name, default_value)
     # RabbitMQ password
     string_setting :mq_password, 'guest'
 
+    # RabbitMQ Auth Mechanism
+    string_setting :mq_auth_mechanism, 'PLAIN'
+
     # RabbitMQ URI (takes precedence over MQ username, password, host, port and vhost settings)
     string_setting :uri, nil
 
@@ -83,6 +86,9 @@ def self.boolean_setting(name, default_value)
     # 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
 
@@ -168,6 +174,7 @@ def self.initialize(params = {})
     # @return [Hash]
     def self.default_config
       @settings_defaults.merge({
+        mq_client_properties: {},
         mq_exchange_options: {},
         mq_tls_cert: nil,
         mq_tls_key: nil,

lib/hutch/config.rb

@@ -13,13 +13,19 @@ def self.included(base)
     end
 
     def reject!
+      @message_rejected = true
       broker.reject(delivery_info.delivery_tag)
     end
 
     def requeue!
+      @message_rejected = true
       broker.requeue(delivery_info.delivery_tag)
     end
 
+    def message_rejected?
+      !!@message_rejected
+    end
+
     def logger
       Hutch::Logging.logger
     end

lib/hutch/consumer.rb

@@ -1,4 +1,5 @@
 require 'ddtrace'
+require 'ddtrace/auto_instrument'
 
 module Hutch
   module Tracers
@@ -8,7 +9,7 @@ def initialize(klass)
       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