harmoniser 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f94dc99fc3550a6ad359ffed69a06652849e74317ef607bedbaadad9c09f44fa
-  data.tar.gz: 489bea79098e457c8391f4fe1949b00e1618818b67fbff1fceb40da89ee48da8
+  metadata.gz: a1a7c351ba8ed80091b6e32dbd3cb0486f6b4123b30de12f1406862f3bdedcbb
+  data.tar.gz: f3d68be4e8cc7cb83e5df89bbc20ce4bc905b44711d59a23de50e7ac761bc5ae
 SHA512:
-  metadata.gz: 7b78d93705c81e6dc30ddba7dc02733476a40998568299df5b2742ef80c47f2fba6bfb03e1d272f69472030ab19b40276c23beba88505d40fe86c65685855efd
-  data.tar.gz: d0ac0e8502cc760826e22d446ae914eacdca0f8b01faec19dc52350f994cd5c1fb3d663e4d2465bec6c26c5bdbb22e9f9278d8eff60521c08147f8c6cb743425
+  metadata.gz: 5c6da5317a0ea480766ce716b7710598d6a1720afd8bb24cf82f2aecd3b96e9d41b31b3246d306c525e5ddbb5532f8adb87c7b3188a402ecada8c87a192176fb
+  data.tar.gz: 9a31ed8616f30072245dbc783692cadf871c46f2082f627420fd71a38f6e29b3d9162b6152fdf741173a67e4a16fb5d1c8fbe812eaffb081356f4b83796ad510

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## [0.11.0] - 2024-10-09
+
+### Added
+- Attach callbacks for block/unblock at Connection
+- Introduce Connectable to accommodate Session/Channel management
+- Attach at_exit hook for maybe closing Publisher connection. Only applicable for cases in which harmoniser is not the process running.
+
+### Changed
+- Separate connection for Publisher, Subscriber and Topology as per recommendations from [RabbitMQ official docs](https://www.rabbitmq.com/docs/alarms#effects-on-clusters)
+
 ## [0.10.0] - 2024-09-16
 
 ### Added

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 TODO: Write your name
+Copyright (c) 2021 Jose Lloret Perez
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -111,12 +111,6 @@ To contribute to this codebase, you will need to setup your local development us
 
 You can also access the running container by executing `$ make shell` and then execute any commands related to Harmoniser within its isolated environment.
 
-## Future Improvements
-
-- [ ] Feature: Introduce capability of configuring concurrency for Harmoniser process.
-- [ ] Issue: Reopen Channels anytime an exception occurs that closes them automatically. More info can be found [here](https://www.rabbitmq.com/channels.html#error-handling).
-- [ ] Chore: Introduce simplecov gem for code coverage.
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/harmoniser/configurable.rb

@@ -1,10 +1,7 @@
-require "forwardable"
 require "harmoniser/configuration"
 
 module Harmoniser
   module Configurable
-    extend Forwardable
-
     def configure
       @configuration ||= Configuration.new
       yield(@configuration)
@@ -19,7 +16,5 @@ module Harmoniser
     def default_configuration
       @configuration ||= Configuration.new
     end
-
-    def_delegators :configuration, :connection, :connection?
   end
 end

data/lib/harmoniser/configuration.rb

@@ -1,12 +1,11 @@
 require "forwardable"
-require "harmoniser/connectable"
+require "harmoniser/connection"
 require "harmoniser/topology"
 require "harmoniser/options"
 
 module Harmoniser
   class Configuration
     extend Forwardable
-    include Connectable
 
     attr_reader :logger, :options
     def_delegators :options, :concurrency, :environment, :require, :verbose, :timeout
@@ -18,6 +17,16 @@ module Harmoniser
       @topology = Topology.new
     end
 
+    def connection_opts
+      @connection_opts ||= Connection::DEFAULT_CONNECTION_OPTS
+    end
+
+    def connection_opts=(opts)
+      raise TypeError, "opts must be a Hash object" unless opts.is_a?(Hash)
+
+      @connection_opts = connection_opts.merge(opts)
+    end
+
     def define_topology
       raise LocalJumpError, "A block is required for this method" unless block_given?
 

data/lib/harmoniser/connectable.rb

@@ -4,37 +4,70 @@ module Harmoniser
   module Connectable
     MUTEX = Mutex.new
 
-    def connection_opts
-      @connection_opts ||= Connection::DEFAULT_CONNECTION_OPTS
-        .merge({
-          logger: Harmoniser.logger,
-          recovery_attempt_started: proc {
-            stringified_connection = connection.to_s
-            Harmoniser.logger.info("Recovery attempt started: connection = `#{stringified_connection}`")
-          },
-          recovery_completed: proc {
-            stringified_connection = connection.to_s
-            Harmoniser.logger.info("Recovery completed: connection = `#{stringified_connection}`")
-          }
-        })
-    end
+    module ClassMethods
+      def connection(configuration = Harmoniser.configuration)
+        MUTEX.synchronize do
+          @connection ||= Connection.new(configuration.connection_opts)
+          @connection.start unless @connection.open? || @connection.recovering_from_network_failure?
+          @connection
+        end
+      end
 
-    def connection_opts=(opts)
-      raise TypeError, "opts must be a Hash object" unless opts.is_a?(Hash)
+      def connection?
+        !!defined?(@connection)
+      end
 
-      @connection_opts = connection_opts.merge(opts)
-    end
+      def create_channel(consumer_pool_size: 1, consumer_pool_shutdown_timeout: 60)
+        connection
+          .create_channel(nil, consumer_pool_size, false, consumer_pool_shutdown_timeout)
+          .tap do |channel|
+            attach_callbacks(channel)
+          end
+      end
+
+      private
+
+      def attach_callbacks(channel)
+        channel.on_error(&method(:on_error).to_proc)
+        channel.on_uncaught_exception(&method(:on_uncaught_exception).to_proc)
+      end
+
+      def on_error(channel, amq_method)
+        attributes = {
+          amq_method: amq_method,
+          exchanges: channel.exchanges.keys,
+          queues: channel.consumers.values.map(&:queue)
+        }
 
-    def connection
-      MUTEX.synchronize do
-        @connection ||= Connection.new(connection_opts)
-        @connection.start unless @connection.open? || @connection.recovering_from_network_failure?
-        @connection
+        if amq_method.is_a?(AMQ::Protocol::Channel::Close)
+          attributes[:reply_code] = amq_method.reply_code
+          attributes[:reply_text] = amq_method.reply_text
+        end
+
+        stringified_attributes = attributes.map { |k, v| "#{k} = `#{v}`" }.join(", ")
+        Harmoniser.logger.error("Default on_error handler executed for channel: #{stringified_attributes}")
+        maybe_kill_process(amq_method)
+      end
+
+      def on_uncaught_exception(error, consumer)
+        Harmoniser.logger.error("Default on_uncaught_exception handler executed for channel: error_class = `#{error.class}`, error_message = `#{error.message}`, error_backtrace = `#{error.backtrace&.first(5)}, queue = `#{consumer.queue}`")
+      end
+
+      def maybe_kill_process(amq_method)
+        Process.kill("USR1", Process.pid) if ack_timed_out?(amq_method) && Harmoniser.server?
+      end
+
+      def ack_timed_out?(amq_method)
+        return false unless amq_method.is_a?(AMQ::Protocol::Channel::Close)
+
+        amq_method.reply_text =~ /delivery acknowledgement on channel \d+ timed out/
       end
     end
 
-    def connection?
-      !!defined?(@connection)
+    class << self
+      def included(base)
+        base.extend(ClassMethods)
+      end
     end
   end
 end

data/lib/harmoniser/connection.rb

@@ -21,12 +21,15 @@ module Harmoniser
 
     def_delegators :@bunny, :create_channel, :open?, :recovering_from_network_failure?
 
-    def initialize(opts)
-      @bunny = Bunny.new(opts)
+    def initialize(opts, logger: Harmoniser.logger)
+      @logger = logger
+      @bunny = Bunny.new(maybe_dynamic_opts(opts)).tap do |bunny|
+        attach_callbacks(bunny)
+      end
     end
 
     def to_s
-      "<#{self.class.name}>: #{user}@#{host}:#{port}, connection_name = `#{connection_name}`, vhost = `#{vhost}`"
+      "<#{self.class.name}>:#{object_id} #{user}@#{host}:#{port}, connection_name = `#{connection_name}`, vhost = `#{vhost}`"
     end
 
     # TODO Only perform retries when Harmoniser.server?
@@ -35,7 +38,7 @@ module Harmoniser
       begin
         with_signal_handler { @bunny.start }
       rescue => e
-        Harmoniser.logger.error("Connection attempt failed: retries = `#{retries}`, error_class = `#{e.class}`, error_message = `#{e.message}`")
+        @logger.error("Connection attempt failed: retries = `#{retries}`, error_class = `#{e.class}`, error_message = `#{e.message}`")
         with_signal_handler { sleep(1) }
         retries += 1
         retry
@@ -43,15 +46,26 @@ module Harmoniser
     end
 
     def close
-      @bunny.close
-      true
+      @logger.info("Connection will be closed: connection = `#{self}`")
+      @bunny.close.tap do
+        @logger.info("Connection closed: connection = `#{self}`")
+      end
     rescue => e
-      Harmoniser.logger.error("Connection#close failed: error_class = `#{e.class}`, error_message = `#{e.message}`")
+      @logger.error("Connection#close failed: error_class = `#{e.class}`, error_message = `#{e.message}`")
       false
     end
 
     private
 
+    def attach_callbacks(bunny)
+      bunny.on_blocked do |blocked|
+        @logger.warn("Connection blocked: connection = `#{self}`, reason = `#{blocked.reason}`")
+      end
+      bunny.on_unblocked do |unblocked|
+        @logger.info("Connection unblocked: connection = `#{self}`")
+      end
+    end
+
     def connection_name
       @bunny.connection_name
     end
@@ -60,6 +74,18 @@ module Harmoniser
       @bunny.transport.host
     end
 
+    def maybe_dynamic_opts(opts)
+      opts.merge({
+        logger: opts.fetch(:logger) { @logger },
+        recovery_attempt_started: opts.fetch(:recovery_attempt_started) do
+          proc { @logger.info("Recovery attempt started: connection = `#{self}`") }
+        end,
+        recovery_completed: opts.fetch(:recovery_completed) do
+          proc { @logger.info("Recovery completed: connection = `#{self}`") }
+        end
+      })
+    end
+
     def port
       @bunny.transport.port
     end
@@ -76,7 +102,7 @@ module Harmoniser
     def with_signal_handler
       yield if block_given?
     rescue SignalException => e
-      Harmoniser.logger.info("Signal received: signal = `#{Signal.signame(e.signo)}`")
+      @logger.info("Signal received: signal = `#{Signal.signame(e.signo)}`")
       Harmoniser.server? ? exit(0) : raise
     end
   end

data/lib/harmoniser/launcher/base.rb

@@ -49,16 +49,21 @@ module Harmoniser
       end
 
       def maybe_close
-        return unless @configuration.connection?
-        return unless @configuration.connection.open?
+        maybe_close_subscriber
+        maybe_close_publisher
+      end
+
+      def maybe_close_publisher
+        return unless Publisher.connection?
+        Publisher.connection.close
+      end
+
+      def maybe_close_subscriber
+        return unless Subscriber.connection?
 
         maybe_cancel_subscribers
         report_work_pool
-
-        connection = @configuration.connection
-        @logger.info("Connection will be closed: connection = `#{connection}`")
-        connection.close
-        @logger.info("Connection closed: connection = `#{connection}`")
+        Subscriber.connection.close
       end
 
       def maybe_cancel_subscribers

data/lib/harmoniser/launcher/bounded.rb

@@ -1,11 +1,8 @@
-require "harmoniser/channelable"
 require_relative "base"
 
 module Harmoniser
   module Launcher
     class Bounded < Base
-      include Channelable
-
       private
 
       def start_subscribers
@@ -15,7 +12,7 @@ module Harmoniser
       end
 
       def channel
-        @channel ||= self.class.create_channel(consumer_pool_size: @configuration.concurrency, consumer_pool_shutdown_timeout: @configuration.timeout)
+        @channel ||= Subscriber.create_channel(consumer_pool_size: @configuration.concurrency, consumer_pool_shutdown_timeout: @configuration.timeout)
       end
     end
   end

data/lib/harmoniser/publisher.rb

@@ -1,10 +1,10 @@
-require "harmoniser/channelable"
+require "harmoniser/connectable"
 require "harmoniser/definition"
 
 module Harmoniser
   module Publisher
     class MissingExchangeDefinition < StandardError; end
-    include Channelable
+    include Connectable
 
     module ClassMethods
       def harmoniser_publisher(exchange_name:)
@@ -61,5 +61,11 @@ module Harmoniser
         base.extend(ClassMethods)
       end
     end
+
+    at_exit do
+      next if Harmoniser.server?
+      next unless Publisher.connection?
+      Publisher.connection.close
+    end
   end
 end

data/lib/harmoniser/subscriber.rb

@@ -1,11 +1,11 @@
-require "harmoniser/channelable"
+require "harmoniser/connectable"
 require "harmoniser/definition"
 require "harmoniser/subscriber/registry"
 
 module Harmoniser
   module Subscriber
     class MissingConsumerDefinition < StandardError; end
-    include Channelable
+    include Connectable
 
     module ClassMethods
       def harmoniser_subscriber(queue_name:, consumer_tag: nil, no_ack: true, exclusive: false, arguments: {})

data/lib/harmoniser/topology.rb

@@ -1,9 +1,9 @@
-require "harmoniser/channelable"
+require "harmoniser/connectable"
 require "harmoniser/definition"
 
 module Harmoniser
   class Topology
-    include Channelable
+    include Connectable
 
     attr_reader :bindings, :exchanges, :queues
 
@@ -45,7 +45,7 @@ module Harmoniser
         declare_exchanges(ch)
         declare_queues(ch)
         declare_bindings(ch)
-        ch.close
+        ch.connection.close
       end
     end
 

data/lib/harmoniser/version.rb

@@ -1,3 +1,3 @@
 module Harmoniser
-  VERSION = "0.10.0"
+  VERSION = "0.11.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: harmoniser
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Jose Lloret
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-16 00:00:00.000000000 Z
+date: 2024-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -42,7 +42,6 @@ files:
 - bin/setup
 - harmoniser.gemspec
 - lib/harmoniser.rb
-- lib/harmoniser/channelable.rb
 - lib/harmoniser/cli.rb
 - lib/harmoniser/configurable.rb
 - lib/harmoniser/configuration.rb

data/lib/harmoniser/channelable.rb

@@ -1,70 +0,0 @@
-module Harmoniser
-  module Channelable
-    MUTEX = Mutex.new
-    private_constant :MUTEX
-
-    module ClassMethods
-      def harmoniser_channel
-        MUTEX.synchronize do
-          @harmoniser_channel ||= create_channel
-        end
-      end
-
-      def create_channel(consumer_pool_size: 1, consumer_pool_shutdown_timeout: 60)
-        connection
-          .create_channel(nil, consumer_pool_size, false, consumer_pool_shutdown_timeout)
-          .tap do |channel|
-            attach_callbacks(channel)
-          end
-      end
-
-      private
-
-      def connection
-        Harmoniser.connection
-      end
-
-      def attach_callbacks(channel)
-        channel.on_error(&method(:on_error).to_proc)
-        channel.on_uncaught_exception(&method(:on_uncaught_exception).to_proc)
-      end
-
-      def on_error(channel, amq_method)
-        attributes = {
-          amq_method: amq_method,
-          exchanges: channel.exchanges.keys,
-          queues: channel.consumers.values.map(&:queue)
-        }
-
-        if amq_method.is_a?(AMQ::Protocol::Channel::Close)
-          attributes[:reply_code] = amq_method.reply_code
-          attributes[:reply_text] = amq_method.reply_text
-        end
-
-        stringified_attributes = attributes.map { |k, v| "#{k} = `#{v}`" }.join(", ")
-        Harmoniser.logger.error("Default on_error handler executed for channel: #{stringified_attributes}")
-        maybe_kill_process(amq_method)
-      end
-
-      def on_uncaught_exception(error, consumer)
-        Harmoniser.logger.error("Default on_uncaught_exception handler executed for channel: error_class = `#{error.class}`, error_message = `#{error.message}`, error_backtrace = `#{error.backtrace&.first(5)}, queue = `#{consumer.queue}`")
-      end
-
-      def maybe_kill_process(amq_method)
-        Process.kill("USR1", Process.pid) if ack_timed_out?(amq_method) && Harmoniser.server?
-      end
-
-      def ack_timed_out?(amq_method)
-        return false unless amq_method.is_a?(AMQ::Protocol::Channel::Close)
-
-        amq_method.reply_text =~ /delivery acknowledgement on channel \d+ timed out/
-      end
-    end
-
-    class << self
-      def included(base)
-        base.extend(ClassMethods)
-      end
-    end
-  end
-end