karafka 2.5.4 → 2.5.6

data/lib/karafka/processing/strategies/default.rb

@@ -35,8 +35,8 @@ module Karafka
         # @note It runs in the listener loop. Should **not** be used for anything heavy or
         #   with any potential errors. Mostly for initialization of states, etc.
         def handle_initialized
-          monitor.instrument('consumer.initialize', caller: self)
-          monitor.instrument('consumer.initialized', caller: self) do
+          monitor.instrument("consumer.initialize", caller: self)
+          monitor.instrument("consumer.initialized", caller: self) do
             initialized
           end
         end
@@ -120,22 +120,22 @@ module Karafka
         # @param action [Symbol]
         # @param block [Proc]
         def handle_wrap(action, &block)
-          monitor.instrument('consumer.wrap', caller: self)
-          monitor.instrument('consumer.wrapped', caller: self) do
+          monitor.instrument("consumer.wrap", caller: self)
+          monitor.instrument("consumer.wrapped", caller: self) do
             wrap(action, &block)
           end
         end
 
         # Run the user consumption code
         def handle_consume
-          monitor.instrument('consumer.consume', caller: self)
-          monitor.instrument('consumer.consumed', caller: self) do
+          monitor.instrument("consumer.consume", caller: self)
+          monitor.instrument("consumer.consumed", caller: self) do
             consume
           end
 
           # Mark job as successful
           coordinator.success!(self)
-        rescue StandardError => e
+        rescue => e
           coordinator.failure!(self, e)
 
           # Re-raise so reported in the consumer
@@ -175,8 +175,8 @@ module Karafka
 
         # Runs the consumer `#eofed` method with reporting
         def handle_eofed
-          monitor.instrument('consumer.eof', caller: self)
-          monitor.instrument('consumer.eofed', caller: self) do
+          monitor.instrument("consumer.eof", caller: self)
+          monitor.instrument("consumer.eofed", caller: self) do
             eofed
           end
         ensure
@@ -191,8 +191,8 @@ module Karafka
 
           coordinator.revoke
 
-          monitor.instrument('consumer.revoke', caller: self)
-          monitor.instrument('consumer.revoked', caller: self) do
+          monitor.instrument("consumer.revoke", caller: self)
+          monitor.instrument("consumer.revoked", caller: self) do
             revoked
           end
         ensure
@@ -201,8 +201,8 @@ module Karafka
 
         # Runs the shutdown code
         def handle_shutdown
-          monitor.instrument('consumer.shutting_down', caller: self)
-          monitor.instrument('consumer.shutdown', caller: self) do
+          monitor.instrument("consumer.shutting_down", caller: self)
+          monitor.instrument("consumer.shutdown", caller: self) do
             shutdown
           end
         ensure

data/lib/karafka/processing/strategies/dlq.rb

@@ -118,7 +118,7 @@ module Karafka
 
           # Notify about dispatch on the events bus
           monitor.instrument(
-            'dead_letter_queue.dispatched',
+            "dead_letter_queue.dispatched",
             caller: self,
             message: skippable_message
           )

data/lib/karafka/processing/worker.rb

@@ -55,9 +55,9 @@ module Karafka
 
         if job
           job.wrap do
-            monitor.instrument('worker.process', instrument_details)
+            monitor.instrument("worker.process", instrument_details)
 
-            monitor.instrument('worker.processed', instrument_details) do
+            monitor.instrument("worker.processed", instrument_details) do
               job.before_call
 
               # If a job is marked as non blocking, we can run a tick in the job queue and if there
@@ -87,12 +87,12 @@ module Karafka
       rescue Exception => e
         # rubocop:enable Lint/RescueException
         monitor.instrument(
-          'error.occurred',
+          "error.occurred",
           caller: self,
           job: job,
           jobs_queue: @jobs_queue,
           error: e,
-          type: 'worker.process.error'
+          type: "worker.process.error"
         )
       ensure
         # job can be nil when the queue is being closed
@@ -102,7 +102,7 @@ module Karafka
         end
 
         # Always publish info, that we completed all the work despite its result
-        monitor.instrument('worker.completed', instrument_details)
+        monitor.instrument("worker.completed", instrument_details)
       end
     end
   end

data/lib/karafka/railtie.rb

@@ -12,17 +12,17 @@ end
 
 if Karafka.rails?
   # Load ActiveJob adapter
-  require 'active_job/karafka'
+  require "active_job/karafka"
 
   # Setup env if configured (may be configured later by .net, etc)
-  ENV['KARAFKA_ENV'] ||= ENV['RAILS_ENV'] if ENV.key?('RAILS_ENV')
+  ENV["KARAFKA_ENV"] ||= ENV["RAILS_ENV"] if ENV.key?("RAILS_ENV")
 
   module Karafka
     # Railtie for setting up Rails integration
     class Railtie < Rails::Railtie
       railtie_name :karafka
 
-      initializer 'karafka.active_job_integration' do
+      initializer "karafka.active_job_integration" do
         ActiveSupport.on_load(:active_job) do
           # Extend ActiveJob with some Karafka specific ActiveJob magic
           extend ::Karafka::ActiveJob::JobExtensions
@@ -32,12 +32,12 @@ if Karafka.rails?
       # This lines will make Karafka print to stdout like puma or unicorn when we run karafka
       # server + will support code reloading with each fetched loop. We do it only for karafka
       # based commands as Rails processes and console will have it enabled already
-      initializer 'karafka.configure_rails_logger' do
+      initializer "karafka.configure_rails_logger" do
         # Make Karafka uses Rails logger
         ::Karafka::App.config.logger = Rails.logger
 
         next unless Rails.env.development?
-        next unless ENV.key?('KARAFKA_CLI')
+        next unless ENV.key?("KARAFKA_CLI")
         # If we are already publishing to STDOUT, no need to add it again.
         # If added again, would print stuff twice
         next if ActiveSupport::Logger.logger_outputs_to?(Rails.logger, $stdout)
@@ -46,7 +46,7 @@ if Karafka.rails?
         # Inherit the logger level from Rails, otherwise would always run with the debug level
         stdout_logger.level = Rails.logger.level
 
-        rails71plus = Rails.gem_version >= Gem::Version.new('7.1.0')
+        rails71plus = Rails.gem_version >= Gem::Version.new("7.1.0")
 
         # Rails 7.1 replaced the broadcast module with a broadcast logger
         # While 7.1 is EOL, we keep this for users who may still use it without official support
@@ -61,20 +61,20 @@ if Karafka.rails?
         end
       end
 
-      initializer 'karafka.configure_rails_auto_load_paths' do |app|
+      initializer "karafka.configure_rails_auto_load_paths" do |app|
         # Consumers should autoload by default in the Rails app so they are visible
         app.config.autoload_paths += %w[app/consumers]
       end
 
-      initializer 'karafka.require_karafka_boot_file' do |app|
-        rails6plus = Rails.gem_version >= Gem::Version.new('6.0.0')
+      initializer "karafka.require_karafka_boot_file" do |app|
+        rails6plus = Rails.gem_version >= Gem::Version.new("6.0.0")
 
         # If the boot file location is set to "false", we should not raise an exception and we
         # should just not load karafka stuff. Setting this explicitly to false indicates, that
         # karafka is part of the supply chain but it is not a first class citizen of a given
         # system (may be just a dependency of a dependency), thus railtie should not kick in to
         # load the non-existing boot file
-        next if Karafka.boot_file.to_s == 'false'
+        next if Karafka.boot_file.to_s == "false"
 
         karafka_boot_file = Rails.root.join(Karafka.boot_file.to_s).to_s
 
@@ -96,7 +96,7 @@ if Karafka.rails?
         end
       end
 
-      initializer 'karafka.configure_worker_external_executor' do |app|
+      initializer "karafka.configure_worker_external_executor" do |app|
         app.config.after_initialize do
           app_config = Karafka::App.config
 

data/lib/karafka/routing/builder.rb

@@ -60,14 +60,14 @@ module Karafka
             # Validate consumer group settings
             Contracts::ConsumerGroup.new.validate!(
               consumer_group.to_h,
-              scope: ['routes', consumer_group.name]
+              scope: ["routes", consumer_group.name]
             )
 
             # and then its topics settings
             consumer_group.topics.each do |topic|
               Contracts::Topic.new.validate!(
                 topic.to_h,
-                scope: ['routes', consumer_group.name, topic.name]
+                scope: ["routes", consumer_group.name, topic.name]
               )
             end
 
@@ -78,7 +78,7 @@ module Karafka
       end
 
       # Clear out the drawn routes.
-      alias array_clear clear
+      alias_method :array_clear, :clear
       private :array_clear
 
       # Clear routes and draw them again with the given block. Helpful for testing purposes.

data/lib/karafka/routing/contracts/consumer_group.rb

@@ -8,8 +8,8 @@ module Karafka
       class ConsumerGroup < Karafka::Contracts::Base
         configure do |config|
           config.error_messages = YAML.safe_load_file(
-            File.join(Karafka.gem_root, 'config', 'locales', 'errors.yml')
-          ).fetch('en').fetch('validations').fetch('routing').fetch('consumer_group')
+            File.join(Karafka.gem_root, "config", "locales", "errors.yml")
+          ).fetch("en").fetch("validations").fetch("routing").fetch("consumer_group")
         end
 
         required(:id) { |val| val.is_a?(String) && Karafka::Contracts::TOPIC_REGEXP.match?(val) }
@@ -49,18 +49,18 @@ module Karafka
           names = data.fetch(:topics).map { |topic| topic[:name] }
           names_hash = names.each_with_object({}) { |n, h| h[n] = true }
           error_occured = false
-          namespace_chars = ['.', '_'].freeze
+          namespace_chars = [".", "_"].freeze
           names.each do |n|
             # Skip topic names that are not namespaced
             next unless n.chars.find { |c| namespace_chars.include?(c) }
 
-            if n.chars.include?('.')
+            if n.chars.include?(".")
               # Check underscore styled topic
-              underscored_topic = n.tr('.', '_')
+              underscored_topic = n.tr(".", "_")
               error_occured = names_hash[underscored_topic] ? true : false
             else
               # Check dot styled topic
-              dot_topic = n.tr('_', '.')
+              dot_topic = n.tr("_", ".")
               error_occured = names_hash[dot_topic] ? true : false
             end
           end

data/lib/karafka/routing/contracts/routing.rb

@@ -7,8 +7,8 @@ module Karafka
       class Routing < Karafka::Contracts::Base
         configure do |config|
           config.error_messages = YAML.safe_load_file(
-            File.join(Karafka.gem_root, 'config', 'locales', 'errors.yml')
-          ).fetch('en').fetch('validations').fetch('routing')
+            File.join(Karafka.gem_root, "config", "locales", "errors.yml")
+          ).fetch("en").fetch("validations").fetch("routing")
         end
 
         # Ensures, that when declarative topics strict requirement is on, all topics have

data/lib/karafka/routing/contracts/topic.rb

@@ -7,8 +7,8 @@ module Karafka
       class Topic < Karafka::Contracts::Base
         configure do |config|
           config.error_messages = YAML.safe_load_file(
-            File.join(Karafka.gem_root, 'config', 'locales', 'errors.yml')
-          ).fetch('en').fetch('validations').fetch('routing').fetch('topic')
+            File.join(Karafka.gem_root, "config", "locales", "errors.yml")
+          ).fetch("en").fetch("validations").fetch("routing").fetch("topic")
         end
 
         required(:deserializers) { |val| !val.nil? }
@@ -59,7 +59,7 @@ module Karafka
 
           kafka = data.fetch(:kafka)
 
-          next if kafka.key?(:'bootstrap.servers')
+          next if kafka.key?(:"bootstrap.servers")
 
           [[%w[kafka bootstrap.servers], :missing]]
         end
@@ -69,7 +69,7 @@ module Karafka
           next unless Karafka::App.config.strict_topics_namespacing
 
           value = data.fetch(:name)
-          namespace_chars = ['.', '_'].freeze
+          namespace_chars = [".", "_"].freeze
           namespacing_chars_count = value.chars.find_all do |c|
             namespace_chars.include?(c)
           end.uniq.size

data/lib/karafka/routing/features/active_job/contracts/topic.rb

@@ -11,15 +11,15 @@ module Karafka
           class Topic < Karafka::Contracts::Base
             configure do |config|
               config.error_messages = YAML.safe_load_file(
-                File.join(Karafka.gem_root, 'config', 'locales', 'errors.yml')
-              ).fetch('en').fetch('validations').fetch('routing').fetch('topic')
+                File.join(Karafka.gem_root, "config", "locales", "errors.yml")
+              ).fetch("en").fetch("validations").fetch("routing").fetch("topic")
             end
 
             virtual do |data, errors|
               next unless errors.empty?
               next unless data[:active_job][:active]
               # One should not define active job jobs without ActiveJob being available for usage
-              next if Object.const_defined?('ActiveJob::Base')
+              next if Object.const_defined?("ActiveJob::Base")
 
               [[%i[consumer], :active_job_missing]]
             end

data/lib/karafka/routing/features/base/expander.rb

@@ -37,19 +37,19 @@ module Karafka
                 result = super(&block)
 
                 each do |consumer_group|
-                  if scope::Contracts.const_defined?('ConsumerGroup', false)
+                  if scope::Contracts.const_defined?("ConsumerGroup", false)
                     scope::Contracts::ConsumerGroup.new.validate!(
                       consumer_group.to_h,
-                      scope: ['routes', consumer_group.name]
+                      scope: ["routes", consumer_group.name]
                     )
                   end
 
-                  next unless scope::Contracts.const_defined?('Topic', false)
+                  next unless scope::Contracts.const_defined?("Topic", false)
 
                   consumer_group.topics.each do |topic|
                     scope::Contracts::Topic.new.validate!(
                       topic.to_h,
-                      scope: ['routes', consumer_group.name, topic.name]
+                      scope: ["routes", consumer_group.name, topic.name]
                     )
                   end
                 end

data/lib/karafka/routing/features/base.rb

@@ -13,35 +13,35 @@ module Karafka
         class << self
           # Extends topic and builder with given feature API
           def activate
-            if const_defined?('Topic', false)
+            if const_defined?("Topic", false)
               Topic.prepend(self::Topic)
             end
 
-            if const_defined?('Topics', false)
+            if const_defined?("Topics", false)
               Topics.prepend(self::Topics)
             end
 
-            if const_defined?('ConsumerGroup', false)
+            if const_defined?("ConsumerGroup", false)
               ConsumerGroup.prepend(self::ConsumerGroup)
             end
 
-            if const_defined?('Proxy', false)
+            if const_defined?("Proxy", false)
               Proxy.prepend(self::Proxy)
             end
 
-            if const_defined?('Builder', false)
+            if const_defined?("Builder", false)
               Builder.prepend(self::Builder)
             end
 
-            if const_defined?('Contracts', false)
+            if const_defined?("Contracts", false)
               Builder.prepend(Base::Expander.new(self))
             end
 
-            if const_defined?('SubscriptionGroup', false)
+            if const_defined?("SubscriptionGroup", false)
               SubscriptionGroup.prepend(self::SubscriptionGroup)
             end
 
-            if const_defined?('SubscriptionGroupsBuilder', false)
+            if const_defined?("SubscriptionGroupsBuilder", false)
               SubscriptionGroupsBuilder.prepend(self::SubscriptionGroupsBuilder)
             end
           end

data/lib/karafka/routing/features/dead_letter_queue/contracts/topic.rb

@@ -10,8 +10,8 @@ module Karafka
           class Topic < Karafka::Contracts::Base
             configure do |config|
               config.error_messages = YAML.safe_load_file(
-                File.join(Karafka.gem_root, 'config', 'locales', 'errors.yml')
-              ).fetch('en').fetch('validations').fetch('routing').fetch('topic')
+                File.join(Karafka.gem_root, "config", "locales", "errors.yml")
+              ).fetch("en").fetch("validations").fetch("routing").fetch("topic")
             end
 
             nested :dead_letter_queue do

data/lib/karafka/routing/features/declaratives/contracts/topic.rb

@@ -10,8 +10,8 @@ module Karafka
           class Topic < Karafka::Contracts::Base
             configure do |config|
               config.error_messages = YAML.safe_load_file(
-                File.join(Karafka.gem_root, 'config', 'locales', 'errors.yml')
-              ).fetch('en').fetch('validations').fetch('routing').fetch('topic')
+                File.join(Karafka.gem_root, "config", "locales", "errors.yml")
+              ).fetch("en").fetch("validations").fetch("routing").fetch("topic")
             end
 
             nested :declaratives do

data/lib/karafka/routing/features/deserializers/contracts/topic.rb

@@ -10,8 +10,8 @@ module Karafka
           class Topic < Karafka::Contracts::Base
             configure do |config|
               config.error_messages = YAML.safe_load_file(
-                File.join(Karafka.gem_root, 'config', 'locales', 'errors.yml')
-              ).fetch('en').fetch('validations').fetch('routing').fetch('topic')
+                File.join(Karafka.gem_root, "config", "locales", "errors.yml")
+              ).fetch("en").fetch("validations").fetch("routing").fetch("topic")
             end
 
             nested :deserializers do

data/lib/karafka/routing/features/eofed/contracts/topic.rb

@@ -10,8 +10,8 @@ module Karafka
           class Topic < Karafka::Contracts::Base
             configure do |config|
               config.error_messages = YAML.safe_load_file(
-                File.join(Karafka.gem_root, 'config', 'locales', 'errors.yml')
-              ).fetch('en').fetch('validations').fetch('routing').fetch('topic')
+                File.join(Karafka.gem_root, "config", "locales", "errors.yml")
+              ).fetch("en").fetch("validations").fetch("routing").fetch("topic")
             end
 
             nested :eofed do
@@ -25,7 +25,7 @@ module Karafka
 
               next unless eofed[:active]
 
-              next if data[:kafka][:'enable.partition.eof']
+              next if data[:kafka][:"enable.partition.eof"]
 
               [[%i[eofed kafka], :enable]]
             end

data/lib/karafka/routing/features/inline_insights/contracts/topic.rb

@@ -10,8 +10,8 @@ module Karafka
           class Topic < Karafka::Contracts::Base
             configure do |config|
               config.error_messages = YAML.safe_load_file(
-                File.join(Karafka.gem_root, 'config', 'locales', 'errors.yml')
-              ).fetch('en').fetch('validations').fetch('routing').fetch('topic')
+                File.join(Karafka.gem_root, "config", "locales", "errors.yml")
+              ).fetch("en").fetch("validations").fetch("routing").fetch("topic")
             end
 
             nested :inline_insights do

data/lib/karafka/routing/features/inline_insights.rb

@@ -12,17 +12,17 @@ module Karafka
           #
           # @param _config [Karafka::Core::Configurable::Node] app config
           def post_setup(_config)
-            Karafka::App.monitor.subscribe('app.running') do
+            Karafka::App.monitor.subscribe("app.running") do
               # Do not activate tracking of statistics if none of our active topics uses it
               # This prevents us from tracking metrics when user just runs a subset of topics
               # in a given process and none of those actually utilizes this feature
               next unless Karafka::App
-                          .subscription_groups
-                          .values
-                          .flat_map(&:itself)
-                          .flat_map(&:topics)
-                          .flat_map(&:to_a)
-                          .any?(&:inline_insights?)
+                .subscription_groups
+                .values
+                .flat_map(&:itself)
+                .flat_map(&:topics)
+                .flat_map(&:to_a)
+                .any?(&:inline_insights?)
 
               # Initialize the tracker prior to becoming multi-threaded
               Karafka::Processing::InlineInsights::Tracker.instance

data/lib/karafka/routing/features/manual_offset_management/contracts/topic.rb

@@ -10,8 +10,8 @@ module Karafka
           class Topic < Karafka::Contracts::Base
             configure do |config|
               config.error_messages = YAML.safe_load_file(
-                File.join(Karafka.gem_root, 'config', 'locales', 'errors.yml')
-              ).fetch('en').fetch('validations').fetch('routing').fetch('topic')
+                File.join(Karafka.gem_root, "config", "locales", "errors.yml")
+              ).fetch("en").fetch("validations").fetch("routing").fetch("topic")
             end
 
             nested :manual_offset_management do

data/lib/karafka/routing/subscription_group.rb

@@ -58,7 +58,7 @@ module Karafka
 
       # @return [String] consumer group id
       def consumer_group_id
-        kafka[:'group.id']
+        kafka[:"group.id"]
       end
 
       # @return [Integer] max messages fetched in a single go
@@ -107,7 +107,7 @@ module Karafka
       # node identifier. This refreshes this if needed when in swarm.
       def refresh
         return unless node
-        return unless kafka.key?(:'group.instance.id')
+        return unless kafka.key?(:"group.instance.id")
 
         @kafka = build_kafka
       end
@@ -124,11 +124,11 @@ module Karafka
         inject_group_instance_id(kafka)
         inject_client_id(kafka)
 
-        kafka[:'group.id'] ||= @consumer_group.id
-        kafka[:'auto.offset.reset'] ||= @topics.first.initial_offset
+        kafka[:"group.id"] ||= @consumer_group.id
+        kafka[:"auto.offset.reset"] ||= @topics.first.initial_offset
         # Karafka manages the offsets based on the processing state, thus we do not rely on the
         # rdkafka offset auto-storing
-        kafka[:'enable.auto.offset.store'] = false
+        kafka[:"enable.auto.offset.store"] = false
         kafka.freeze
         kafka
       end
@@ -146,9 +146,9 @@ module Karafka
       def inject_client_id(kafka)
         # If client id is set directly on librdkafka level, we do nothing and just go with what
         # end user has configured
-        return if kafka.key?(:'client.id')
+        return if kafka.key?(:"client.id")
 
-        kafka[:'client.id'] = client_id
+        kafka[:"client.id"] = client_id
       end
 
       # If we use static group memberships, there can be a case, where same instance id would
@@ -161,7 +161,7 @@ module Karafka
       # affecting the instance id and causing conflicts
       # @param kafka [Hash] kafka level config
       def inject_group_instance_id(kafka)
-        group_instance_prefix = kafka.fetch(:'group.instance.id', false)
+        group_instance_prefix = kafka.fetch(:"group.instance.id", false)
 
         # If group instance id was not even configured, do nothing
         return unless group_instance_prefix
@@ -170,7 +170,7 @@ module Karafka
         # have different instances ids but they are reproducible
         components = [group_instance_prefix, node ? node.id : nil, @position]
 
-        kafka[:'group.instance.id'] = components.compact.join('_')
+        kafka[:"group.instance.id"] = components.compact.join("_")
       end
     end
   end

data/lib/karafka/runner.rb

@@ -59,12 +59,12 @@ module Karafka
       workers.each(&:join)
     # If anything crashes here, we need to raise the error and crush the runner because it means
     # that something terrible happened
-    rescue StandardError => e
+    rescue => e
       Karafka.monitor.instrument(
-        'error.occurred',
+        "error.occurred",
         caller: self,
         error: e,
-        type: 'runner.call.error'
+        type: "runner.call.error"
       )
       Karafka::App.stop!
       raise e

data/lib/karafka/server.rb

@@ -127,10 +127,10 @@ module Karafka
         raise Errors::ForcefulShutdownError
       rescue Errors::ForcefulShutdownError => e
         Karafka.monitor.instrument(
-          'error.occurred',
+          "error.occurred",
           caller: self,
           error: e,
-          type: 'app.stopping.error'
+          type: "app.stopping.error"
         )
 
         # We're done waiting, lets kill them!
@@ -144,13 +144,13 @@ module Karafka
         # indefinitely even with risk of VM crash as this is a last resort.
         Thread.new do
           listeners.each(&:shutdown)
-        rescue StandardError => e
+        rescue => e
           # If anything wrong happened during shutdown, we also want to record it
           Karafka.monitor.instrument(
-            'error.occurred',
+            "error.occurred",
             caller: self,
             error: e,
-            type: 'app.forceful_stopping.error'
+            type: "app.forceful_stopping.error"
           )
         end.join(forceful_shutdown_wait / 1_000.0)