harmoniser 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b1feaead73df2956797f89d33ed45a3316cf5191852946c1b0d3cbe2e2284f18
-  data.tar.gz: 6ba7ae634d24a012d4243d392d4299a9fd88a35af5df1251efec24bb4817ce9c
+  metadata.gz: 4410b741fa891c42db5f51dc48889768859a9a84a3eed3676fc35f0aaeb8cca1
+  data.tar.gz: c6af823a40e9b007f93a347e84ad44aee26dea0e10464fc608c116db7185ec19
 SHA512:
-  metadata.gz: 9cfcdeec3f6e205c9301d5f2142cd8e7fee0723ed5950fdf1bd12a704f1cc29ecf971e39c75ef7ace071ea577a37f45a874c4016a63c561d25c3e206f1fb0e6f
-  data.tar.gz: 45b409fb2bfa3ec1752101915fad8f52ccf1e5a5ea1402e23ee6fc062e952fbdb78a16015f77bc2ef2ddafda04859eb23d0e9c8c9cef06a9675fe0c44e81f5d5
+  metadata.gz: d843cfe2d70c4ad95cfbe1ce592b7691c057840a191fb7838670eb68205a44549fd7b8e83ff75c2f7888d5c303903f357b93f64c1e37cd5ec342ebb17553051c
+  data.tar.gz: 331c5f2133c0e291581ae3f14be398dac07df8adbc43ad72de798171346380f28a084988ff0215922c12783c6e28ec93640dada3ee9aa096ca63ba43a08d2ee3

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## [0.6.0] - 2023-12-30
+
+### Added
+- Create a channel for each class including Harmoniser::Publisher or Harmoniser::Subscriber. A mutex in the context of the class including Publisher or Subscriber modules control access to the resources created as well as guarantees safe publication under multi-thread process.
+- Introduce broadcast and unicast examples.
+- Amend specs to wipe out RabbitMQ resources created during spec execution.
+
+### Changed
+- Honour verbose option regardless of the environment configuration set. For instance, for non-production environment, verbose is no longer verbose set by default.
+
+## [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
+
 ## [0.4.0] - 2023-12-07
 
 ### Added

data/README.md

@@ -51,7 +51,7 @@ end
 MyPublisher.publish({ salute: "Hello World!" }.to_json, routing_key: "my_resource.foo.bar")
 ```
 
-The code above assumes that the exchange is already defined. We'd like to emphasize that defining RabbitMQ topology (exchanges, queues and binding) should be performed outside of the class whose role is purely focused on publishing. See more details about how to define the topology [here](examples/multicast.rb#L9-L18).
+The code above assumes that the exchange is already defined. We'd like to emphasize that defining RabbitMQ topology (exchanges, queues and binding) should be performed outside of the class whose role is purely focused on publishing. See more details about how to define the topology [here](examples/multicast.rb#L11-L19).
 
 ### RabbitMQ
 
@@ -78,19 +78,10 @@ Harmoniser server is a process specifically dedicated to run Subscribers that ar
 class MySubscriber
   include Harmoniser::Subscriber
   harmoniser_subscriber queue_name: "my_queue"
-
-  class << self
-    def on_delivery(delivery_info, properties, payload)
-      Harmoniser.logger.info({
-        body: "message received",
-        payload: payload
-      }.to_json)
-    end
-  end
 end
 ```
 
-The code above assumes that the queue and its binding to an exchange are already defined. You can see more details about how this is specified [here](examples/multicast.rb#L9-L18).
+The code above assumes that the queue and its binding to an exchange are already defined. You can see more details about how this is specified [here](examples/multicast.rb#L11-L19).
 
 In order for the subscribers to receive messages from a queue, you should spin up a dedicated Ruby process like following:
 
@@ -123,7 +114,6 @@ 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: Introduce capability of configuring number of threads for queue consuming at the CLI.
 

data/docs/cli.md

@@ -17,4 +17,4 @@ The `environment` is automatically inferred from the environment variables `RAIL
 
 The `require` is by default pointing at `.`, which means that this option when configured under a Rails application, might be ignored. Since Ruby is not Rails only, you can certainly specify the location path of your Ruby file that will be used to load the classes including Harmoniser::Subscriber. In contrast, if a path to a directory is passed, Harmoniser assumes that `./config/environment.rb` lives within the folder passed as option.
 
-The `verbose` option, when passed, sets the severity of Harmoniser logs to `debug` being able to see fine-grained details of things like RabbitMQ interactions happening or messages published into exchanges. By default, the verbosity is disabled to prevent your production environment to be flooded with unnecessary logs, however if the environment is not set to `production`, the severity of the logs is `debug` mode too.
+The `verbose` option, when passed, sets the severity of Harmoniser logs to `debug` being able to see fine-grained details of things like RabbitMQ interactions happening or messages published into exchanges. By default, the verbosity is disabled to prevent your environment to be flooded with unnecessary logs.

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
@@ -67,11 +40,7 @@ module Harmoniser
     end
 
     def set_logger_severity
-      @logger.level = if @options.production?
-        @options.verbose? ? Logger::DEBUG : Logger::INFO
-      else
-        Logger::DEBUG
-      end
+      @logger.level = @options.verbose? ? Logger::DEBUG : Logger::INFO
     end
   end
 end

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/publisher.rb

@@ -5,8 +5,6 @@ module Harmoniser
   module Publisher
     class MissingExchangeDefinition < StandardError; end
     include Channelable
-    MUTEX = Mutex.new
-    private_constant :MUTEX
 
     module ClassMethods
       def harmoniser_publisher(exchange_name:)
@@ -20,7 +18,7 @@ module Harmoniser
       def publish(payload, opts = {})
         raise_missing_exchange_definition unless @harmoniser_exchange_definition
 
-        MUTEX.synchronize do
+        const_get(:HARMONISER_PUBLISHER_MUTEX).synchronize do
           harmoniser_exchange.publish(payload, opts)
         end
         Harmoniser.logger.debug { "Message published: payload = `#{payload}`, opts = `#{opts}`" }
@@ -31,10 +29,8 @@ module Harmoniser
       private
 
       def harmoniser_exchange
-        return @harmoniser_exchange if @harmoniser_exchange
-
         @harmoniser_exchange ||= Bunny::Exchange.new(
-          Publisher.harmoniser_channel,
+          Publisher.create_channel,
           @harmoniser_exchange_definition.type,
           @harmoniser_exchange_definition.name,
           @harmoniser_exchange_definition.opts
@@ -48,6 +44,7 @@ module Harmoniser
 
     class << self
       def included(base)
+        base.const_set(:HARMONISER_PUBLISHER_MUTEX, Mutex.new)
         base.extend(ClassMethods)
       end
     end

data/lib/harmoniser/subscriber.rb

@@ -7,8 +7,6 @@ module Harmoniser
     class MissingConsumerDefinition < StandardError; end
     include Channelable
     include Includable
-    MUTEX = Mutex.new
-    private_constant :MUTEX
 
     module ClassMethods
       def harmoniser_subscriber(queue_name:, consumer_tag: nil, no_ack: true, exclusive: false, arguments: {})
@@ -22,7 +20,7 @@ module Harmoniser
       end
 
       def harmoniser_subscriber_start
-        MUTEX.synchronize do
+        const_get(:HARMONISER_SUBSCRIBER_MUTEX).synchronize do
           @harmoniser_consumer ||= create_consumer
         end
       end
@@ -32,10 +30,11 @@ module Harmoniser
       def create_consumer
         raise_missing_consumer_definition unless @harmoniser_consumer_definition
 
+        channel = Subscriber.create_channel
         consumer = Bunny::Consumer.new(
-          Subscriber.harmoniser_channel,
+          channel,
           @harmoniser_consumer_definition.queue_name,
-          @harmoniser_consumer_definition.consumer_tag || Subscriber.harmoniser_channel.generate_consumer_tag,
+          @harmoniser_consumer_definition.consumer_tag || channel.generate_consumer_tag,
           @harmoniser_consumer_definition.no_ack,
           @harmoniser_consumer_definition.exclusive,
           @harmoniser_consumer_definition.arguments
@@ -77,6 +76,7 @@ module Harmoniser
 
     class << self
       def included(base)
+        base.const_set(:HARMONISER_SUBSCRIBER_MUTEX, Mutex.new)
         base.extend(ClassMethods)
         harmoniser_register_included(base)
       end

data/lib/harmoniser/version.rb

@@ -1,3 +1,3 @@
 module Harmoniser
-  VERSION = "0.4.0"
+  VERSION = "0.6.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.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Jose Lloret
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-12-07 00:00:00.000000000 Z
+date: 2023-12-30 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