Merge pull request #15 from arikarim/multi-exchange-

fix: Enhance run_task method to handle existing RabbitMQ exchanges by…

.github/workflows/main.yml

@@ -14,7 +14,7 @@ jobs:
     strategy:
       matrix:
         ruby:
-          - '3.1.2'
+          - '4.0.1'
 
     steps:
     - uses: actions/checkout@v3

.github/workflows/release.yml

@@ -14,7 +14,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.1.2
+          ruby-version: 4.0.1
 
       - name: publish gem
         run: |

.rubocop.yml

@@ -1,11 +1,12 @@
-require: rubocop-rails
+plugins:
+  - rubocop-rails
 
 AllCops:
   NewCops: enable
   SuggestExtensions: false
 Layout/SpaceBeforeBrackets: # (new in 1.7)
   Enabled: true
-Layout/LineLength: 
+Layout/LineLength:
   Max: 350
 Lint/AmbiguousAssignment: # (new in 1.7)
   Enabled: true
@@ -110,4 +111,6 @@ Metrics/MethodLength:
 Metrics/CyclomaticComplexity:
   Max: 15
 Metrics/PerceivedComplexity:
-  Max: 15
+  Max: 15
+Metrics/ParameterLists:
+  Max: 6

Gemfile

@@ -5,10 +5,10 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in rabbit_carrots.gemspec
 gemspec
 
-gem 'rake', '~> 13.1'
+gem 'rake', '~> 13.3.1'
 
-gem 'rspec', '~> 3.12'
+gem 'rspec', '~> 3.13.2'
 
-gem 'rubocop', '~> 1.58'
+gem 'rubocop', '~> 1.82.1'
 
-gem 'rubocop-rails', '~> 2.22'
+gem 'rubocop-rails', '~> 2.34.3'

Gemfile.lock

@@ -1,102 +1,112 @@
 PATH
   remote: .
   specs:
-    rabbit_carrots (1.0.2)
+    rabbit_carrots (1.1.1)
       bunny (>= 2.22)
-      connection_pool (~> 2.4)
+      connection_pool (>= 2.4)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.1.2)
+    activesupport (8.1.2)
       base64
       bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+      concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      json
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      mutex_m
+      securerandom (>= 0.3)
-      tzinfo (~> 2.0)
+      tzinfo (~> 2.0, >= 2.0.5)
-    amq-protocol (2.3.2)
+      uri (>= 0.13.1)
-    ast (2.4.2)
+    amq-protocol (2.5.0)
-    base64 (0.2.0)
+    ast (2.4.3)
-    bigdecimal (3.1.4)
+    base64 (0.3.0)
-    bunny (2.22.0)
+    bigdecimal (4.0.1)
-      amq-protocol (~> 2.3, >= 2.3.1)
+    bunny (2.24.0)
+      amq-protocol (~> 2.3)
       sorted_set (~> 1, >= 1.0.2)
-    concurrent-ruby (1.2.2)
+    concurrent-ruby (1.3.6)
-    connection_pool (2.4.1)
+    connection_pool (3.0.2)
-    diff-lcs (1.5.0)
+    diff-lcs (1.6.2)
-    drb (2.2.0)
+    drb (2.2.3)
-      ruby2_keywords
+    i18n (1.14.8)
-    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    json (2.7.1)
+    json (2.18.0)
-    language_server-protocol (3.17.0.3)
+    language_server-protocol (3.17.0.5)
-    minitest (5.20.0)
+    lint_roller (1.1.0)
-    mutex_m (0.2.0)
+    logger (1.7.0)
-    parallel (1.23.0)
+    minitest (6.0.1)
-    parser (3.2.2.4)
+      prism (~> 1.5)
+    parallel (1.27.0)
+    parser (3.3.10.1)
       ast (~> 2.4.1)
       racc
-    racc (1.7.3)
+    prism (1.8.0)
-    rack (3.0.8)
+    racc (1.8.1)
+    rack (3.2.4)
     rainbow (3.1.1)
-    rake (13.1.0)
+    rake (13.3.1)
     rbtree (0.4.6)
-    regexp_parser (2.8.3)
+    regexp_parser (2.11.3)
-    rexml (3.2.6)
+    rspec (3.13.2)
-    rspec (3.12.0)
+      rspec-core (~> 3.13.0)
-      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.13.0)
-      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.13.0)
-      rspec-mocks (~> 3.12.0)
+    rspec-core (3.13.6)
-    rspec-core (3.12.0)
+      rspec-support (~> 3.13.0)
-      rspec-support (~> 3.12.0)
+    rspec-expectations (3.13.5)
-    rspec-expectations (3.12.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
+      rspec-support (~> 3.13.0)
-    rspec-mocks (3.12.0)
+    rspec-mocks (3.13.7)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
+      rspec-support (~> 3.13.0)
-    rspec-support (3.12.0)
+    rspec-support (3.13.6)
-    rubocop (1.58.0)
+    rubocop (1.82.1)
       json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.4)
+      parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
+      regexp_parser (>= 2.9.3, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.48.0, < 2.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
+      unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.30.0)
+    rubocop-ast (1.49.0)
-      parser (>= 3.2.1.0)
+      parser (>= 3.3.7.2)
-    rubocop-rails (2.22.2)
+      prism (~> 1.7)
+    rubocop-rails (2.34.3)
       activesupport (>= 4.2.0)
+      lint_roller (~> 1.1)
       rack (>= 1.1)
-      rubocop (>= 1.33.0, < 2.0)
+      rubocop (>= 1.75.0, < 2.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
+      rubocop-ast (>= 1.44.0, < 2.0)
     ruby-progressbar (1.13.0)
-    ruby2_keywords (0.0.5)
+    securerandom (0.4.1)
-    set (1.1.0)
+    set (1.1.2)
     sorted_set (1.0.3)
       rbtree
       set (~> 1.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.5.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
+    uri (1.1.1)
 
 PLATFORMS
+  arm64-darwin-25
   x86_64-linux
 
 DEPENDENCIES
   rabbit_carrots!
-  rake (~> 13.1)
+  rake (~> 13.3.1)
-  rspec (~> 3.12)
+  rspec (~> 3.13.2)
-  rubocop (~> 1.58)
+  rubocop (~> 1.82.1)
-  rubocop-rails (~> 2.22)
+  rubocop-rails (~> 2.34.3)
 
 BUNDLED WITH
    2.3.26

lib/puma/plugin/rabbit_carrots.rb

@@ -1,5 +1,5 @@
 # rabbit_carrots.rb
-
+require 'English'
 require 'puma/plugin'
 require 'rabbit_carrots'
 
@@ -8,7 +8,7 @@ Puma::Plugin.create do
 
   def start(launcher)
     @log_writer = launcher.log_writer
-    @puma_pid = $$
+    @puma_pid = $PROCESS_ID
 
     @core_service = RabbitCarrots::Core.new(logger: log_writer)
 
@@ -43,6 +43,7 @@ Puma::Plugin.create do
     Process.kill('TERM', rabbit_carrots_pid)
     Process.wait(rabbit_carrots_pid)
   rescue Errno::ECHILD, Errno::ESRCH
+    log 'Rabbit Carrots already stopped'
   end
 
   def monitor_puma
@@ -57,7 +58,7 @@ Puma::Plugin.create do
     loop do
       if send(process_dead)
         log message
-        Process.kill('TERM', $$)
+        Process.kill('TERM', $PROCESS_ID)
         break
       end
       sleep 2

lib/rabbit_carrots/configuration.rb

@@ -18,10 +18,12 @@ module RabbitCarrots
                   :rabbitmq_exchange_name,
                   :automatically_recover,
                   :network_recovery_interval,
-                  :recovery_attempts,
+                  :recovery_attempts
-                  :orm
+
     def orm
       @orm ||= :activerecord
     end
+
+    attr_writer :orm
   end
 end

lib/rabbit_carrots/connection.rb

@@ -3,6 +3,7 @@ require 'singleton'
 module RabbitCarrots
   class Connection
     include ::Singleton
+
     attr_reader :connection
 
     def initialize

lib/rabbit_carrots/core.rb

@@ -1,5 +1,5 @@
 module RabbitCarrots
-  class Core
+  class Core # rubocop:disable Metrics/ClassLength
     attr_reader :logger
 
     @database_agnostic_not_null_violation = nil
@@ -11,7 +11,7 @@ module RabbitCarrots
     end
 
     def initialize(logger: nil)
-      @logger = logger || Logger.new(Rails.env.production? ? '/proc/self/fd/1' : $stdout)
+      @logger = create_logger_adapter(logger || Logger.new(Rails.env.production? ? '/proc/self/fd/1' : $stdout))
       @threads = []
       @running = true
       @shutdown_requested = false
@@ -36,6 +36,7 @@ module RabbitCarrots
             handler_class:,
             routing_keys: channel[:routing_keys],
             queue_arguments: channel[:arguments],
+            exchange_name: channel[:exchange_name],
             kill_to_restart_on_standard_error:
           )
         end
@@ -61,7 +62,7 @@ module RabbitCarrots
     def request_shutdown
       # Workaround to a known issue with Signal Traps and logs
       Thread.start do
-        logger.log 'Shutting down Rabbit Carrots service...'
+        logger.error 'Shutting down Rabbit Carrots service...'
       end
       @shutdown_requested = true
       @threads.each(&:kill)
@@ -71,16 +72,24 @@ module RabbitCarrots
     def stop
       # Workaround to a known issue with Signal Traps and logs
       Thread.start do
-        logger.log 'Stoppig the Rabbit Carrots service...'
+        logger.error 'Stoppig the Rabbit Carrots service...'
       end
       @running = false
     end
 
-    def run_task(queue_name:, handler_class:, routing_keys:, queue_arguments: {}, kill_to_restart_on_standard_error: false)
+    def run_task(queue_name:, handler_class:, routing_keys:, queue_arguments: {}, exchange_name: nil, kill_to_restart_on_standard_error: false)
       RabbitCarrots::Connection.instance.channel.with do |channel|
-        exchange = channel.topic(RabbitCarrots.configuration.rabbitmq_exchange_name, durable: true)
+        exchange_name ||= RabbitCarrots.configuration.rabbitmq_exchange_name
 
-        logger.log "Listening on QUEUE: #{queue_name} for ROUTING KEYS: #{routing_keys}"
+        begin
+          # Try to passively read an existing exchange without declaring it
+          exchange = channel.topic(exchange_name, passive: true)
+        rescue Bunny::NotFound
+          # If the exchange does not exist, declare it
+          exchange = channel.topic(exchange_name, durable: true)
+        end
+
+        logger.info "Listening on QUEUE: #{queue_name} for ROUTING KEYS: #{routing_keys}"
         queue = channel.queue(queue_name, durable: true, arguments: queue_arguments)
 
         routing_keys.map(&:strip).each { |k| queue.bind(exchange, routing_key: k) }
@@ -88,24 +97,29 @@ module RabbitCarrots
         queue.subscribe(block: false, manual_ack: true, prefetch: 10) do |delivery_info, properties, payload|
           break if @shutdown_requested
 
-          logger.log "Received from queue: #{queue_name}, Routing Keys: #{routing_keys}"
+          logger.info "Received from queue: #{queue_name}, Routing Keys: #{routing_keys}"
           handler_class.handle!(channel, delivery_info, properties, payload)
           channel.ack(delivery_info.delivery_tag, false)
         rescue RabbitCarrots::EventHandlers::Errors::NackMessage, JSON::ParserError => _e
-          logger.log "Nacked message: #{payload}"
+          payload = encode_payload(payload)
+          logger.warn "Nacked message: #{payload}"
           channel.nack(delivery_info.delivery_tag, false, false)
         rescue RabbitCarrots::EventHandlers::Errors::NackAndRequeueMessage => _e
-          logger.log "Nacked and Requeued message: #{payload}"
+          payload = encode_payload(payload)
+          logger.warn "Nacked and Requeued message: #{payload}"
           channel.nack(delivery_info.delivery_tag, false, true)
         rescue self.class.database_agnostic_not_null_violation, self.class.database_agnostic_record_invalid => e
-          logger.log "Null constraint or Invalid violation: #{payload}. Error: #{e.message}"
+          payload = encode_payload(payload)
+          logger.warn "Null constraint or Invalid violation: #{payload}. Error: #{e.message}"
           channel.ack(delivery_info.delivery_tag, false)
         rescue self.class.database_agnostic_connection_not_established => e
-          logger.log "Error connection not established to the database: #{payload}. Error: #{e.message}"
+          payload = encode_payload(payload)
+          logger.warn "Error connection not established to the database: #{payload}. Error: #{e.message}"
           sleep 3
           channel.nack(delivery_info.delivery_tag, false, true)
         rescue StandardError => e
-          logger.log "Error handling message: #{payload}. Error: #{e.message}"
+          payload = encode_payload(payload)
+          logger.error "Error handling message: #{payload}. Error: #{e.message}"
           sleep 3
           channel.nack(delivery_info.delivery_tag, false, true)
           Process.kill('SIGTERM', Process.pid) if kill_to_restart_on_standard_error
@@ -115,5 +129,36 @@ module RabbitCarrots
       logger.error "Bunny session error: #{e.message}"
       request_shutdown
     end
+
+    private
+
+    def create_logger_adapter(logger)
+      return logger if logger.respond_to?(:info) && logger.respond_to?(:error) && logger.respond_to?(:warn)
+
+      adapter = Object.new
+      def adapter.info(msg)
+        @logger.write("[INFO] #{msg}\n")
+      end
+
+      def adapter.error(msg)
+        @logger.write("[ERROR] #{msg}\n")
+      end
+
+      def adapter.warn(msg)
+        @logger.write("[WARN] #{msg}\n")
+      end
+
+      adapter.instance_variable_set(:@logger, logger)
+      adapter
+    end
+
+    def encode_payload(payload)
+      payload.encode(
+        'UTF-8',
+        invalid: :replace,
+        undef: :replace,
+        replace: ''
+      )
+    end
   end
 end

lib/rabbit_carrots/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RabbitCarrots
-  VERSION = '1.0.2'
+  VERSION = '1.1.1'
 end

rabbit_carrots.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
 
   # Uncomment to register a new dependency of your gem
   spec.add_dependency 'bunny', '>= 2.22'
-  spec.add_dependency 'connection_pool', '~> 2.4'
+  spec.add_dependency 'connection_pool', '>= 2.4'
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html