phobos 2.1.0 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec66514784d6b38c90a4ca0aaf063e001536d2680732c4afa535b49c2a55cb9c
-  data.tar.gz: 1d988dd76e39305cfb30d3dd8e8fd926065631e391ed077d7c0459e6760587b4
+  metadata.gz: '0956b5ef7d6d1cdd48c4f8fd36a8236d192450eda009f5313ec81d628784ce0b'
+  data.tar.gz: 17e608663beea493f386290bb8781f5c540baee9ba00e0fde47fce2504ee9f7d
 SHA512:
-  metadata.gz: 07a92fdf61d970a61f98cfb8615568fa48af0550fb473458b6dce67b479b684ce8e280dbd97b20b5c16f84bf14fa18eea47f8bae490c6ac5712b8d21d2c4d037
-  data.tar.gz: 59bb2c58cfd017b8f9462eb431d2bb62322bdc817a1260816648481abff4ff0a5d6f1df5430f3888a0bad3cb92eeb11ee2ace3ced62df1e8ee02756bb1e8a795
+  metadata.gz: 7df8dbd47d916c8d344badce4039598188c5ce53b3d595c9baa5e6d0fa5467482ca5ebdeddb972fcf9aded6f4ac8905add780bc8104b6d7cccdbb71d21c86c23
+  data.tar.gz: 6db4a6e57804d373eb055b6ab88cd709b8260e141a5853f4826f927c50912d2224f206c9751bd5186f87bf99aa3463ff3df6e65a536a17ec7f7aee58cffe89a5

data/CHANGELOG.md

@@ -6,6 +6,18 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ``
 ## UNRELEASED
 
+## [2.1.3] - 2022-05-13
+
+- Rescue and log Kafka::HeartbeatError in batch processing
+
+## [2.1.2] - 2022-01-27
+
+- Fix packaging error.
+
+## [2.1.1] - 2022-01-26
+
+- Fix crash on Ruby 3.1 involving a change to the Psych gem.
+
 ## [2.1.0] - 2021-05-27
 
 - Modify config to allow specifying kafka connection information separately for consumers and producers

data/lib/phobos/actions/process_batch.rb

@@ -4,6 +4,7 @@ module Phobos
   module Actions
     class ProcessBatch
       include Phobos::Instrumentation
+      include Phobos::Log
 
       attr_reader :metadata
 
@@ -26,7 +27,11 @@ module Phobos
               message: message,
               listener_metadata: @listener_metadata
             ).execute
-            @listener.consumer.trigger_heartbeat
+            begin
+              @listener.consumer.trigger_heartbeat
+            rescue Kafka::HeartbeatError => e
+              log_warn("Error sending Heartbeat #{e.class.name}-#{e}")
+            end
           end
         end
       end

data/lib/phobos/configuration.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require 'phobos/deep_struct'
+
+module Phobos
+  module Configuration
+    def configure(configuration)
+      @config = fetch_configuration(configuration)
+      @config.class.send(:define_method, :producer_hash) do
+        Phobos.config.producer&.to_hash&.except(:kafka)
+      end
+      @config.class.send(:define_method, :consumer_hash) do
+        Phobos.config.consumer&.to_hash&.except(:kafka)
+      end
+      @config.listeners ||= []
+      configure_logger
+    end
+
+    # :nodoc:
+    def configure_logger
+      Logging.backtrace(true)
+      Logging.logger.root.level = silence_log ? :fatal : config.logger.level
+
+      configure_ruby_kafka_logger
+      configure_phobos_logger
+
+      logger.info do
+        Hash(message: 'Phobos configured', env: ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'N/A')
+      end
+    end
+
+    private
+
+    def fetch_configuration(configuration)
+      DeepStruct.new(read_configuration(configuration))
+    end
+
+    def read_configuration(configuration)
+      return configuration.to_h if configuration.respond_to?(:to_h)
+
+      config_erb = ERB.new(File.read(File.expand_path(configuration))).result
+
+      YAML.safe_load(
+        config_erb,
+        permitted_classes: [Symbol],
+        permitted_symbols: [],
+        aliases: true
+      )
+    rescue ArgumentError
+      YAML.safe_load(config_erb, [Symbol], [], true)
+    end
+
+    def configure_phobos_logger
+      if config.custom_logger
+        @logger = config.custom_logger
+      else
+        @logger = Logging.logger[self]
+        @logger.appenders = logger_appenders
+      end
+    end
+
+    def configure_ruby_kafka_logger
+      if config.custom_kafka_logger
+        @ruby_kafka_logger = config.custom_kafka_logger
+      elsif config.logger.ruby_kafka
+        @ruby_kafka_logger = Logging.logger['RubyKafka']
+        @ruby_kafka_logger.appenders = logger_appenders
+        @ruby_kafka_logger.level = silence_log ? :fatal : config.logger.ruby_kafka.level
+      else
+        @ruby_kafka_logger = nil
+      end
+    end
+
+    def logger_appenders
+      appenders = [Logging.appenders.stdout(layout: stdout_layout)]
+
+      if log_file
+        FileUtils.mkdir_p(File.dirname(log_file))
+        appenders << Logging.appenders.file(log_file, layout: json_layout)
+      end
+
+      appenders
+    end
+
+    def log_file
+      config.logger.file
+    end
+
+    def json_layout
+      Logging.layouts.json(date_pattern: Constants::LOG_DATE_PATTERN)
+    end
+
+    def stdout_layout
+      if config.logger.stdout_json == true
+        json_layout
+      else
+        Logging.layouts.pattern(date_pattern: Constants::LOG_DATE_PATTERN)
+      end
+    end
+  end
+end

data/lib/phobos/log.rb

@@ -13,6 +13,10 @@ module Phobos
     def log_error(msg, metadata)
       LoggerHelper.log(:error, msg, metadata)
     end
+
+    def log_warn(msg, metadata = {})
+      LoggerHelper.log(:warn, msg, metadata)
+    end
   end
 
   module LoggerHelper

data/lib/phobos/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Phobos
-  VERSION = '2.1.0'
+  VERSION = '2.1.3'
 end

data/lib/phobos.rb

@@ -13,7 +13,7 @@ require 'kafka'
 require 'logging'
 require 'erb'
 
-require 'phobos/deep_struct'
+require 'phobos/configuration'
 require 'phobos/version'
 require 'phobos/constants'
 require 'phobos/log'
@@ -49,22 +49,11 @@ module Logging
 end
 
 module Phobos
+  extend Configuration
   class << self
     attr_reader :config, :logger
     attr_accessor :silence_log
 
-    def configure(configuration)
-      @config = fetch_configuration(configuration)
-      @config.class.send(:define_method, :producer_hash) do
-        Phobos.config.producer&.to_hash&.except(:kafka)
-      end
-      @config.class.send(:define_method, :consumer_hash) do
-        Phobos.config.consumer&.to_hash&.except(:kafka)
-      end
-      @config.listeners ||= []
-      configure_logger
-    end
-
     def add_listeners(configuration)
       listeners_config = fetch_configuration(configuration)
       @config.listeners += listeners_config.listeners
@@ -91,85 +80,5 @@ module Phobos
       location = caller.find { |line| line !~ %r{/phobos/} }
       warn "DEPRECATION WARNING: #{message}: #{location}"
     end
-
-    # :nodoc:
-    def configure_logger
-      Logging.backtrace(true)
-      Logging.logger.root.level = silence_log ? :fatal : config.logger.level
-
-      configure_ruby_kafka_logger
-      configure_phobos_logger
-
-      logger.info do
-        Hash(message: 'Phobos configured', env: ENV['RAILS_ENV'] || ENV['RACK_ENV'] || 'N/A')
-      end
-    end
-
-    private
-
-    def fetch_configuration(configuration)
-      DeepStruct.new(read_configuration(configuration))
-    end
-
-    def read_configuration(configuration)
-      return configuration.to_h if configuration.respond_to?(:to_h)
-
-      YAML.safe_load(
-        ERB.new(
-          File.read(File.expand_path(configuration))
-        ).result,
-        [Symbol],
-        [],
-        true
-      )
-    end
-
-    def configure_phobos_logger
-      if config.custom_logger
-        @logger = config.custom_logger
-      else
-        @logger = Logging.logger[self]
-        @logger.appenders = logger_appenders
-      end
-    end
-
-    def configure_ruby_kafka_logger
-      if config.custom_kafka_logger
-        @ruby_kafka_logger = config.custom_kafka_logger
-      elsif config.logger.ruby_kafka
-        @ruby_kafka_logger = Logging.logger['RubyKafka']
-        @ruby_kafka_logger.appenders = logger_appenders
-        @ruby_kafka_logger.level = silence_log ? :fatal : config.logger.ruby_kafka.level
-      else
-        @ruby_kafka_logger = nil
-      end
-    end
-
-    def logger_appenders
-      appenders = [Logging.appenders.stdout(layout: stdout_layout)]
-
-      if log_file
-        FileUtils.mkdir_p(File.dirname(log_file))
-        appenders << Logging.appenders.file(log_file, layout: json_layout)
-      end
-
-      appenders
-    end
-
-    def log_file
-      config.logger.file
-    end
-
-    def json_layout
-      Logging.layouts.json(date_pattern: Constants::LOG_DATE_PATTERN)
-    end
-
-    def stdout_layout
-      if config.logger.stdout_json == true
-        json_layout
-      else
-        Logging.layouts.pattern(date_pattern: Constants::LOG_DATE_PATTERN)
-      end
-    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phobos
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.3
 platform: ruby
 authors:
 - Túlio Ornelas
@@ -15,7 +15,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-27 00:00:00.000000000 Z
+date: 2022-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -277,6 +277,7 @@ files:
 - lib/phobos/cli.rb
 - lib/phobos/cli/runner.rb
 - lib/phobos/cli/start.rb
+- lib/phobos/configuration.rb
 - lib/phobos/constants.rb
 - lib/phobos/deep_struct.rb
 - lib/phobos/echo_handler.rb
@@ -314,7 +315,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.16
+rubygems_version: 3.3.5
 signing_key:
 specification_version: 4
 summary: Simplifying Kafka for ruby apps