feat: [#43] Improve O11y

* Bump ruby docker image to 3.3
* Remove warnings from docker-compose
* Add debug log when a message is received by a subscriber
* Amend debug log when a message is published so that exchange name is
  included
* Improve message for MissingExchangeDefinition and
  MissingConsumerDefinition
* Use Gemfile for development dependencies of the gem
* Add error_class, error_message and error_backtrace for `--require`
  file/folder from cli
* Return self for Topology methods such as add_exchange, add_queue and
  add_binding

Author: jollopre

CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## [0.9.0] - 2024-08-09
+
+### Added
+- Add debug log when a message is received by a subscriber
+- Add error_class, error_message and error_backtrace for `--require` option from cli
+
+### Changed
+- Amend debug log when a message is published so that exchange name is included
+- Improve error message for MissingExchangeDefinition and
+  MissingConsumerDefinition
+- Define dev dependencies through Gemfile instead of gemspec
+- Changed Topology methods to return self so that Topology definition becomes chainable
+
 ## [0.8.1] - 2024-04-08
 
 ### Fixed

Dockerfile

@@ -1,4 +1,4 @@
-FROM ruby:3.2.2-alpine3.18 as base
+FROM ruby:3.3.4-alpine3.20 as base
 ENV APP /opt
 WORKDIR $APP
 COPY Gemfile Gemfile.lock harmoniser.gemspec Rakefile $APP/

Gemfile

@@ -4,3 +4,9 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in harmoniser.gemspec
 gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13'
+  gem 'rspec', '~> 3'
+  gem 'standardrb', '~> 1'
+end

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    harmoniser (0.8.1)
+    harmoniser (0.9.0)
       bunny (~> 2.22)
 
 GEM
@@ -12,78 +12,80 @@ GEM
     bunny (2.22.0)
       amq-protocol (~> 2.3, >= 2.3.1)
       sorted_set (~> 1, >= 1.0.2)
-    diff-lcs (1.5.0)
-    json (2.6.3)
+    diff-lcs (1.5.1)
+    json (2.7.2)
     language_server-protocol (3.17.0.3)
     lint_roller (1.1.0)
-    parallel (1.23.0)
-    parser (3.2.2.4)
+    parallel (1.25.1)
+    parser (3.3.4.0)
       ast (~> 2.4.1)
       racc
-    racc (1.7.3)
+    racc (1.8.0)
     rainbow (3.1.1)
-    rake (13.1.0)
+    rake (13.2.1)
     rbtree (0.4.6)
-    regexp_parser (2.8.2)
-    rexml (3.2.6)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.2)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.3)
+    regexp_parser (2.9.2)
+    rexml (3.3.2)
+      strscan
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.6)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.1)
-    rubocop (1.57.2)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (1.64.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.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)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.28.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.30.0)
-      parser (>= 3.2.1.0)
-    rubocop-performance (1.19.1)
-      rubocop (>= 1.7.0, < 2.0)
-      rubocop-ast (>= 0.4.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-performance (1.21.1)
+      rubocop (>= 1.48.1, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
     ruby-progressbar (1.13.0)
     set (1.0.3)
     sorted_set (1.0.3)
       rbtree
       set (~> 1.0)
-    standard (1.32.0)
+    standard (1.39.2)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
-      rubocop (~> 1.57.2)
+      rubocop (~> 1.64.0)
       standard-custom (~> 1.0.0)
-      standard-performance (~> 1.2)
+      standard-performance (~> 1.4)
     standard-custom (1.0.2)
       lint_roller (~> 1.0)
       rubocop (~> 1.50)
-    standard-performance (1.2.1)
+    standard-performance (1.4.0)
       lint_roller (~> 1.1)
-      rubocop-performance (~> 1.19.1)
+      rubocop-performance (~> 1.21.0)
     standardrb (1.0.1)
       standard
+    strscan (3.1.0)
     unicode-display_width (2.5.0)
 
 PLATFORMS
   aarch64-linux-musl
 
 DEPENDENCIES
   harmoniser!
-  rake (~> 13.0)
+  rake (~> 13)
   rspec (~> 3)
-  standardrb (~> 1.0)
+  standardrb (~> 1)
 
 BUNDLED WITH
    2.4.10

docker-compose.yml

@@ -1,4 +1,3 @@
-version: "3.7"
 services:
   gem:
     build:

harmoniser.gemspec

@@ -25,7 +25,4 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_runtime_dependency "bunny", "~> 2.22"
-  spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3"
-  spec.add_development_dependency "standardrb", "~> 1.0"
 end

lib/harmoniser/launcher.rb

@@ -34,14 +34,14 @@ def start_subscribers
     def load_rails
       filepath = File.expand_path("#{@configuration.require}/config/environment.rb")
       require filepath
-    rescue LoadError
-      @logger.warn("Error while requiring file within directory. No subscribers will run for this process: require = `#{@configuration.require}`, filepath = `#{filepath}`")
+    rescue LoadError => e
+      @logger.warn("Error while requiring file within directory. No subscribers will run for this process: require = `#{@configuration.require}`, filepath = `#{filepath}`, error_class = `#{e.class}`, error_message = `#{e.message}`, error_backtrace = `#{e.backtrace&.first(5)}`")
     end
 
     def load_file
       require @configuration.require
-    rescue LoadError
-      @logger.warn("Error while requiring file. No subscribers will run for this process: require = `#{@configuration.require}`")
+    rescue LoadError => e
+      @logger.warn("Error while requiring file. No subscribers will run for this process: require = `#{@configuration.require}`, error_class = `#{e.class}`, error_message = `#{e.message}`, error_backtrace = `#{e.backtrace&.first(5)}`")
     end
   end
 end

lib/harmoniser/publisher.rb

@@ -21,7 +21,7 @@ def publish(payload, opts = {})
         const_get(:HARMONISER_PUBLISHER_MUTEX).synchronize do
           harmoniser_exchange.publish(payload, opts)
         end
-        Harmoniser.logger.debug { "Message published: payload = `#{payload}`, opts = `#{opts}`" }
+        Harmoniser.logger.debug { "Message published: exchange = `#{@harmoniser_exchange_definition.name}`, payload = `#{payload}`, opts = `#{opts}`" }
 
         harmoniser_exchange
       end
@@ -44,7 +44,7 @@ def create_exchange
       end
 
       def raise_missing_exchange_definition
-        raise MissingExchangeDefinition, "Please, call harmoniser_publisher class method first with the exchange_name that will be used for publications"
+        raise MissingExchangeDefinition, "Please call the harmoniser_publisher class method at `#{const_get(:HARMONISER_PUBLISHER_CLASS)}` with the exchange_name that will be used for publishing"
       end
 
       def handle_return(exchange)
@@ -57,6 +57,7 @@ def handle_return(exchange)
     class << self
       def included(base)
         base.const_set(:HARMONISER_PUBLISHER_MUTEX, Mutex.new)
+        base.const_set(:HARMONISER_PUBLISHER_CLASS, base)
         base.extend(ClassMethods)
       end
     end

lib/harmoniser/subscriber.rb

@@ -57,6 +57,7 @@ def handle_cancellation(consumer)
 
       def handle_delivery(consumer)
         consumer.on_delivery do |delivery_info, properties, payload|
+          Harmoniser.logger.debug { "Message received by a consumer: consumer_tag = `#{consumer.consumer_tag}, `payload = `#{payload}`, queue = `#{consumer.queue}`" }
           if respond_to?(:on_delivery)
             on_delivery(delivery_info, properties, payload)
           else
@@ -70,13 +71,14 @@ def register_consumer(consumer)
       end
 
       def raise_missing_consumer_definition
-        raise MissingConsumerDefinition, "Please, call harmoniser_subscriber class method first with the queue_name that will be used for subscribing"
+        raise MissingConsumerDefinition, "Please call the harmoniser_subscriber class method at `#{const_get(:HARMONISER_SUBSCRIBER_CLASS)}` with the queue_name that will be used for subscribing"
       end
     end
 
     class << self
       def included(base)
         base.const_set(:HARMONISER_SUBSCRIBER_MUTEX, Mutex.new)
+        base.const_set(:HARMONISER_SUBSCRIBER_CLASS, base)
         base.extend(ClassMethods)
         harmoniser_register_included(base)
       end

lib/harmoniser/topology.rb

@@ -19,13 +19,15 @@ def add_exchange(type, name, **opts)
         name: name,
         opts: opts
       )
+      self
     end
 
     def add_queue(name, **opts)
       @queues << Definition::Queue.new(
         name: name,
         opts: opts
       )
+      self
     end
 
     def add_binding(exchange_name, destination_name, destination_type = :queue, **opts)
@@ -35,6 +37,7 @@ def add_binding(exchange_name, destination_name, destination_type = :queue, **op
         destination_type: destination_type,
         opts: opts
       )
+      self
     end
 
     def declare