harmoniser 0.3.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05d33501383838004a5dbf7f99fc83f9a28eebdd8a85e54bc738672200cbbf37
-  data.tar.gz: 943cf0cec5a82ee8a05c53c6886df77c1277cfeb3e3f8aa8a8e8cd8358cd2ea2
+  metadata.gz: b56f94d1422e43dd7f7505516400c8f5949998dd8e4a1c8ec36c7c2f5a9ae9f0
+  data.tar.gz: fa96845e13121f315b6af48ef5b765272d00f4ea62ab32a4b3da91ef2eaab712
 SHA512:
-  metadata.gz: b1bfc3d36722722911ad9a7b96765966204b74cdcbfbe9432f58fc1f306097f15810c382c916f6afa53da1244b11ec5b7b0d4d8b1b538e7cb264547081eaacea
-  data.tar.gz: aefd48071e6c2802a5636a94315acd8864282624754b55caedd704270d6c106d9aa1487a2d9597949e64eed44e206701524c593ac62374f6eec18089b5d052ee
+  metadata.gz: 884789f7ccbb0fb23577ed739d352bc332fd9ef8064e9df0c4b355bead5b51b62c563328ac307409fe53481b68990f77f5f7ef34959d6cbc5a00bf364fb9e1ef
+  data.tar.gz: 30c55195bad1e6fe12d213377abeb8c25178e838a7745346e6858ced90efa67eb925a028324cce0361d403aad2c249141cbb0be6376383a4e17a443c8051a542

data/CHANGELOG.md

@@ -1,13 +1,27 @@
 # Changelog
 
-## [0.1.0] - 2023-11-27
+## [0.5.0] - 2023-12-20
 
 ### Added
+- Setup at_exit hook to be executed when Harmoniser exits for an opened RabbitMQ connection
+- Add defaults to Bunny::Session for timeouts and recovery attempts
+- Fix boot up problems for payments application example
+- Perform refactoring of internals such as slimming down Configuration
 
-- Support to express publishing through any kind of exchanges
-- Capability to subscribe to queues
-- Express RabbitMQ topology separated from the responsibility of publishing or subscribing
-- Provide dedicated Ruby process to consume messages through the subscribers defined
+## [0.4.0] - 2023-12-07
+
+### Added
+- Default logger with error severity for when errors occur at channel level
+- Default logger with error severity for when errors occur while processing a message from a queue
+
+### Removed
+- Unused docker image for rabbitMQ (only for development purposes)
+
+## [0.3.0] - 2023-11-29
+
+### Added
+
+- Introduce github action for building, linting and running specs anytime a pull request is opened or push to master happens
 
 ## [0.2.0] - 2023-11-28
 
@@ -15,8 +29,11 @@
 
 - Introduce github action for releasing the gem once is merged into master
 
-## [0.3.0] - 2023-11-29
+## [0.1.0] - 2023-11-27
 
 ### Added
 
-- Introduce github action for building, linting and running specs anytime a pull request is opened or push to master happens
+- Support to express publishing through any kind of exchanges
+- Capability to subscribe to queues
+- Express RabbitMQ topology separated from the responsibility of publishing or subscribing
+- Provide dedicated Ruby process to consume messages through the subscribers defined

data/README.md

@@ -123,9 +123,7 @@ You can also shell into the running container by executing `$ make shell` and fr
 
 - [ ] Issue: Reopen memoized Channel in the context of the class that are included. There are scenarios for which the channel gets closed, for instance Precondition Failed when checking an exchange declaration.
 - [ ] Chore: Introduce simplecov gem for code coverage.
-- [ ] Feature: Add sensible defaults for Session options like heartbeat, timeout, recovery_completed or recovery_attempt_started.
 - [ ] Feature: Add default `on_return` handler as well as permitting the definition of on_return method to be called anytime a published message gets returned.
-- [ ] Feature: Add default `on_error` and `on_uncaught_exception` as well as permitting the definition of them to be called anytime an error in the channel occurs or error in the consumer handler happens.
 - [ ] Feature: Introduce capability of configuring number of threads for queue consuming at the CLI.
 
 ## License

data/lib/harmoniser/channelable.rb

@@ -11,8 +11,20 @@ module Harmoniser
       end
 
       def create_channel
-        connection = Harmoniser.connection
-        connection.create_channel
+        channel = Harmoniser.connection.create_channel
+        channel.on_error(&method(:on_error).to_proc)
+        channel.on_uncaught_exception(&method(:on_uncaught_exception).to_proc)
+        channel
+      end
+
+      private
+
+      def on_error(channel, amq_method)
+        Harmoniser.logger.error("Default on_error handler executed for channel: method = `#{amq_method}`, exchanges = `#{channel.exchanges.keys}`, queues = `#{channel.queues.keys}`")
+      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
     end
 

data/lib/harmoniser/cli.rb

@@ -46,19 +46,17 @@ module Harmoniser
     end
 
     def run
-      launcher = Launcher.new
-      launcher.start
+      Launcher
+        .new(configuration: configuration, logger: logger)
+        .start
 
       while @read_io.wait_readable
         signal = @read_io.gets.strip
         handle_signal(signal)
       end
     rescue Interrupt
-      logger.info("Shutting down!")
-      launcher.stop
       @write_io.close
       @read_io.close
-      logger.info("Bye!")
       exit(0)
     end
 

data/lib/harmoniser/configurable.rb

@@ -20,6 +20,6 @@ module Harmoniser
       @configuration ||= Configuration.new
     end
 
-    def_delegators :configuration, :logger, :connection
+    def_delegators :configuration, :connection, :connection?
   end
 end

data/lib/harmoniser/configuration.rb

@@ -1,33 +1,20 @@
 require "forwardable"
-require "logger"
-require "harmoniser/connection"
+require "harmoniser/connectable"
 require "harmoniser/topology"
 require "harmoniser/options"
 
 module Harmoniser
   class Configuration
     extend Forwardable
+    include Connectable
 
-    DEFAULT_CONNECTION_OPTS = {
-      connection_name: "harmoniser@#{VERSION}",
-      host: "127.0.0.1",
-      password: "guest",
-      port: 5672,
-      tls_silence_warnings: true,
-      username: "guest",
-      verify_peer: false,
-      vhost: "/"
-    }
-    MUTEX = Mutex.new
-
-    attr_reader :connection_opts, :logger, :options
+    attr_reader :logger, :options
     def_delegators :options, :environment, :require, :verbose
 
     def initialize
-      @logger = Logger.new($stdout, progname: "harmoniser@#{VERSION}")
+      @logger = Harmoniser.logger
       @options = Options.new(**default_options)
       set_logger_severity
-      @connection_opts = DEFAULT_CONNECTION_OPTS.merge({logger: @logger})
       @topology = Topology.new
     end
 
@@ -37,20 +24,6 @@ module Harmoniser
       yield(@topology)
     end
 
-    def connection
-      MUTEX.synchronize do
-        @connection ||= Connection.new(connection_opts)
-        @connection.start unless @connection.open?
-        @connection
-      end
-    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 options_with(**)
       @options = options.with(**)
       set_logger_severity

data/lib/harmoniser/connectable.rb

@@ -0,0 +1,49 @@
+require "harmoniser/connection"
+
+module Harmoniser
+  module Connectable
+    MUTEX = Mutex.new
+
+    def connection_opts
+      @connection_opts ||= Connection::DEFAULT_CONNECTION_OPTS.merge({logger: Harmoniser.logger})
+    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 connection
+      MUTEX.synchronize do
+        @connection ||= create_connection
+        @connection.start unless @connection.open? || @connection.recovering_from_network_failure?
+        @connection
+      end
+    end
+
+    def connection?
+      !!defined?(@connection)
+    end
+
+    private
+
+    def create_connection
+      at_exit(&method(:at_exit_handler).to_proc)
+      Connection.new(connection_opts)
+    end
+
+    def at_exit_handler
+      logger = Harmoniser.logger
+
+      logger.info("Shutting down!")
+      if connection? && connection.open?
+        stringified_connection = connection.to_s
+        logger.info("Connection will be closed: connection = `#{stringified_connection}`")
+        connection.close
+        logger.info("Connection closed: connection = `#{stringified_connection}`")
+      end
+      logger.info("Bye!")
+    end
+  end
+end

data/lib/harmoniser/connection.rb

@@ -4,18 +4,45 @@ require "bunny"
 module Harmoniser
   class Connection
     extend Forwardable
-    def_delegators :@bunny, :close, :create_channel, :open?, :start
+
+    DEFAULT_CONNECTION_OPTS = {
+      connection_name: "harmoniser@#{VERSION}",
+      connection_timout: 5,
+      host: "127.0.0.1",
+      password: "guest",
+      port: 5672,
+      read_timeout: 5,
+      recovery_attempt_started: proc {
+        stringified_connection = Harmoniser.connection.to_s
+        Harmoniser.logger.info("Recovery attempt started: connection = `#{stringified_connection}`")
+      },
+      recovery_completed: proc {
+        stringified_connection = Harmoniser.connection.to_s
+        Harmoniser.logger.info("Recovery completed: connection = `#{stringified_connection}`")
+      },
+      tls_silence_warnings: true,
+      username: "guest",
+      verify_peer: false,
+      vhost: "/",
+      write_timeout: 5
+    }
+
+    def_delegators :@bunny, :close, :create_channel, :open?, :recovering_from_network_failure?, :start
 
     def initialize(opts)
       @bunny = Bunny.new(opts)
     end
 
     def to_s
-      "<#{self.class.name}>: #{user}@#{host}:#{port}, vhost = #{vhost}"
+      "<#{self.class.name}>: #{user}@#{host}:#{port}, connection_name = `#{connection_name}`, vhost = `#{vhost}`"
     end
 
     private
 
+    def connection_name
+      @bunny.connection_name
+    end
+
     def host
       @bunny.transport.host
     end

data/lib/harmoniser/launcher.rb

@@ -1,6 +1,6 @@
 module Harmoniser
   class Launcher
-    def initialize(configuration: Harmoniser.configuration, logger: Harmoniser.logger)
+    def initialize(configuration:, logger:)
       @configuration = configuration
       @logger = logger
     end
@@ -10,10 +10,6 @@ module Harmoniser
       start_subscribers
     end
 
-    def stop
-      stop_subscribers
-    end
-
     private
 
     def boot_app
@@ -33,11 +29,6 @@ module Harmoniser
       @logger.info("Subscribers registered to consume messages from queues: klasses = `#{klasses}`")
     end
 
-    def stop_subscribers
-      @logger.info("Connection will be closed: connection = `#{@configuration.connection}`")
-      @configuration.connection.close
-    end
-
     private
 
     def load_rails

data/lib/harmoniser/loggable.rb

@@ -0,0 +1,10 @@
+require "logger"
+require "harmoniser/version"
+
+module Harmoniser
+  module Loggable
+    def logger
+      @logger ||= Logger.new($stdout, progname: "harmoniser@#{VERSION}")
+    end
+  end
+end

data/lib/harmoniser/version.rb

@@ -1,3 +1,3 @@
 module Harmoniser
-  VERSION = "0.3.0"
+  VERSION = "0.5.0"
 end

data/lib/harmoniser.rb

@@ -1,8 +1,10 @@
 require "harmoniser/version"
 require "harmoniser/configurable"
+require "harmoniser/loggable"
 require "harmoniser/publisher"
 require "harmoniser/subscriber"
 
 module Harmoniser
   extend Configurable
+  extend Loggable
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: harmoniser
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jose Lloret
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-28 00:00:00.000000000 Z
+date: 2023-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bunny
@@ -89,10 +89,12 @@ files:
 - lib/harmoniser/cli.rb
 - lib/harmoniser/configurable.rb
 - lib/harmoniser/configuration.rb
+- lib/harmoniser/connectable.rb
 - lib/harmoniser/connection.rb
 - lib/harmoniser/definition.rb
 - lib/harmoniser/includable.rb
 - lib/harmoniser/launcher.rb
+- lib/harmoniser/loggable.rb
 - lib/harmoniser/options.rb
 - lib/harmoniser/parser.rb
 - lib/harmoniser/publisher.rb