karafka 2.5.5 → 2.5.7

data/lib/karafka/cli/topics/plan.rb

@@ -11,7 +11,7 @@ module Karafka
         def call
           # If no changes at all, just print and stop
           if topics_to_create.empty? && topics_to_repartition.empty? && topics_to_alter.empty?
-            puts "Karafka will #{yellow('not')} perform any actions. No changes needed."
+            puts "Karafka will #{yellow("not")} perform any actions. No changes needed."
 
             return false
           end
@@ -20,15 +20,15 @@ module Karafka
 
           unless topics_to_create.empty?
             changes = true
-            puts 'Following topics will be created:'
+            puts "Following topics will be created:"
             puts
 
             topics_to_create.each do |topic|
-              puts "  #{green('+')} #{topic.name}:"
-              puts "    #{green('+')} partitions: \"#{topic.declaratives.partitions}\""
+              puts "  #{green("+")} #{topic.name}:"
+              puts "    #{green("+")} partitions: \"#{topic.declaratives.partitions}\""
 
               topic.declaratives.details.each do |name, value|
-                puts "    #{green('+')} #{name}: \"#{value}\""
+                puts "    #{green("+")} #{name}: \"#{value}\""
               end
 
               puts
@@ -52,22 +52,22 @@ module Karafka
 
             unless upscale.empty?
               changes = true
-              puts 'Following topics will be repartitioned:'
+              puts "Following topics will be repartitioned:"
               puts
 
               upscale.each do |topic, partitions|
                 from = partitions
                 to = topic.declaratives.partitions
-                y = yellow('~')
+                y = yellow("~")
                 puts "  #{y} #{topic.name}:"
-                puts "    #{y} partitions: \"#{red(from)}\" #{grey('=>')} \"#{green(to)}\""
+                puts "    #{y} partitions: \"#{red(from)}\" #{grey("=>")} \"#{green(to)}\""
                 puts
               end
             end
 
             unless downscale.empty?
               puts(
-                'Following topics repartitioning will be ignored as downscaling is not supported:'
+                "Following topics repartitioning will be ignored as downscaling is not supported:"
               )
               puts
 
@@ -75,8 +75,8 @@ module Karafka
                 from = partitions
                 to = topic.declaratives.partitions
 
-                puts "  #{grey('~')} #{topic.name}:"
-                puts "    #{grey('~')} partitions: \"#{grey(from)}\" #{grey('=>')} \"#{grey(to)}\""
+                puts "  #{grey("~")} #{topic.name}:"
+                puts "    #{grey("~")} partitions: \"#{grey(from)}\" #{grey("=>")} \"#{grey(to)}\""
                 puts
               end
             end
@@ -84,18 +84,18 @@ module Karafka
 
           unless topics_to_alter.empty?
             changes = true
-            puts 'Following topics will have configuration changes:'
+            puts "Following topics will have configuration changes:"
             puts
 
             topics_to_alter.each do |topic, configs|
-              puts "  #{yellow('~')} #{topic.name}:"
+              puts "  #{yellow("~")} #{topic.name}:"
 
               configs.each do |name, changes|
                 from = changes.fetch(:from)
                 to = changes.fetch(:to)
                 action = changes.fetch(:action)
-                type = action == :change ? yellow('~') : green('+')
-                puts "    #{type} #{name}: \"#{red(from)}\" #{grey('=>')} \"#{green(to)}\""
+                type = (action == :change) ? yellow("~") : green("+")
+                puts "    #{type} #{name}: \"#{red(from)}\" #{grey("=>")} \"#{green(to)}\""
               end
 
               puts
@@ -174,7 +174,7 @@ module Karafka
               @topics_to_alter[declarative] ||= {}
 
               @topics_to_alter[declarative][declarative_name] ||= {
-                from: '',
+                from: "",
                 to: declarative_value,
                 action: :add
               }

data/lib/karafka/cli/topics/repartition.rb

@@ -26,12 +26,12 @@ module Karafka
               end
 
               change = desired_count - existing_count
-              puts "#{green('Created')} #{change} additional partitions on topic #{name}."
+              puts "#{green("Created")} #{change} additional partitions on topic #{name}."
               any_repartitioned = true
             elsif existing_count
-              puts "#{yellow('Skipping')} because topic #{name} has #{existing_count} partitions."
+              puts "#{yellow("Skipping")} because topic #{name} has #{existing_count} partitions."
             else
-              puts "#{yellow('Skipping')} because topic #{name} does not exist."
+              puts "#{yellow("Skipping")} because topic #{name} does not exist."
             end
           end
 

data/lib/karafka/cli/topics.rb

@@ -9,11 +9,11 @@ module Karafka
         kafka_config: %i[kafka]
       )
 
-      desc 'Allows for the topics management'
+      desc "Allows for the topics management"
 
       option(
         :detailed_exitcode,
-        'Exists with 0 when no changes, 1 when error and 2 when changes present or applied',
+        "Exists with 0 when no changes, 1 when error and 2 when changes present or applied",
         TrueClass,
         %w[
           --detailed_exitcode
@@ -33,29 +33,29 @@ module Karafka
       private_constant :NO_CHANGES_EXIT_CODE, :CHANGES_EXIT_CODE, :ERROR_EXIT_CODE
 
       # @param action [String] action we want to take
-      def call(action = 'help')
+      def call(action = "help")
         detailed_exit_code = options.fetch(:detailed_exitcode, false)
 
         command = case action
-                  when 'create'
-                    Topics::Create
-                  when 'delete'
-                    Topics::Delete
-                  when 'reset'
-                    Topics::Reset
-                  when 'repartition'
-                    Topics::Repartition
-                  when 'migrate'
-                    Topics::Migrate
-                  when 'align'
-                    Topics::Align
-                  when 'plan'
-                    Topics::Plan
-                  when 'help'
-                    Topics::Help
-                  else
-                    raise Errors::UnrecognizedCommandError, "Unrecognized topics action: #{action}"
-                  end
+        when "create"
+          Topics::Create
+        when "delete"
+          Topics::Delete
+        when "reset"
+          Topics::Reset
+        when "repartition"
+          Topics::Repartition
+        when "migrate"
+          Topics::Migrate
+        when "align"
+          Topics::Align
+        when "plan"
+          Topics::Plan
+        when "help"
+          Topics::Help
+        else
+          raise Errors::UnrecognizedCommandError, "Unrecognized topics action: #{action}"
+        end
 
         changes = command.new.call
 

data/lib/karafka/cli.rb

@@ -12,7 +12,7 @@ module Karafka
         # Command we want to run, like install, server, etc
         command_name = ARGV[0]
         # Action for action-based commands like topics migrate
-        action = ARGV[1].to_s.start_with?('-') ? false : ARGV[1]
+        action = ARGV[1].to_s.start_with?("-") ? false : ARGV[1]
 
         command = commands.find { |cmd| cmd.names.include?(command_name) }
 
@@ -51,7 +51,7 @@ end
 #
 # We skip this because this should exist and be only valid in the console
 # :nocov:
-if ENV['KARAFKA_CONSOLE']
+if ENV["KARAFKA_CONSOLE"]
   # Reloads Karafka irb console session
   def reload!
     Karafka.logger.info "Reloading...\n"

data/lib/karafka/connection/client.rb

@@ -66,7 +66,7 @@ module Karafka
       def initialize(subscription_group, batch_poll_breaker)
         @id = SecureRandom.hex(6)
         # Name is set when we build consumer
-        @name = ''
+        @name = ""
         @closed = false
         @subscription_group = subscription_group
         @buffer = RawMessagesBuffer.new
@@ -247,7 +247,7 @@ module Karafka
           return unless tpl
 
           Karafka.monitor.instrument(
-            'client.pause',
+            "client.pause",
             caller: self,
             subscription_group: @subscription_group,
             topic: topic,
@@ -292,7 +292,7 @@ module Karafka
           return unless @paused_tpls[topic].delete(partition)
 
           Karafka.monitor.instrument(
-            'client.resume',
+            "client.resume",
             caller: self,
             subscription_group: @subscription_group,
             topic: topic,
@@ -370,7 +370,7 @@ module Karafka
       # Closes and resets the client completely.
       def reset
         Karafka.monitor.instrument(
-          'client.reset',
+          "client.reset",
           caller: self,
           subscription_group: @subscription_group
         ) do
@@ -410,7 +410,7 @@ module Karafka
         # Emit event for monitoring - happens once per tick_interval (default 5s)
         # Listeners can check assignment_lost?, track polling health, etc.
         Karafka.monitor.instrument(
-          'client.events_poll',
+          "client.events_poll",
           caller: self,
           subscription_group: @subscription_group
         )
@@ -448,7 +448,7 @@ module Karafka
       # @return [String] safe inspection string that is causing circular dependencies and other
       #   issues
       def inspect
-        state = @closed ? 'closed' : 'open'
+        state = @closed ? "closed" : "open"
         "#<#{self.class.name} id=#{@id.inspect} name=#{@name.inspect} state=#{state}>"
       end
 
@@ -507,8 +507,8 @@ module Karafka
         end
 
         # Those two are librdkafka hardcoded values
-        message.offset = -1 if message.offset.to_s == 'latest'
-        message.offset = -2 if message.offset.to_s == 'earliest'
+        message.offset = -1 if message.offset.to_s == "latest"
+        message.offset = -2 if message.offset.to_s == "earliest"
 
         # Never seek if we would get the same location as we would get without seeking
         # This prevents us from the expensive buffer purges that can lead to increased network
@@ -563,10 +563,10 @@ module Karafka
         kafka.unsubscribe
       rescue Rdkafka::RdkafkaError => e
         Karafka.monitor.instrument(
-          'error.occurred',
+          "error.occurred",
           caller: self,
           error: e,
-          type: 'connection.client.unsubscribe.error'
+          type: "connection.client.unsubscribe.error"
         )
       end
 
@@ -575,9 +575,9 @@ module Karafka
       # @return [Rdkafka::Consumer::TopicPartitionList]
       def topic_partition_list(topic, partition)
         rdkafka_partition = kafka
-                            .assignment
-                            .to_h[topic]
-                            &.detect { |part| part.partition == partition }
+          .assignment
+          .to_h[topic]
+          &.detect { |part| part.partition == partition }
 
         return unless rdkafka_partition
 
@@ -661,7 +661,7 @@ module Karafka
         # This will be raised each time poll detects a non-existing topic. When auto creation is
         # on, we can safely ignore it
         when :unknown_topic_or_part # 3
-          return nil if @subscription_group.kafka[:'allow.auto.create.topics']
+          return nil if @subscription_group.kafka[:"allow.auto.create.topics"]
 
           early_report = true
 
@@ -681,10 +681,10 @@ module Karafka
 
         if early_report || !retryable
           Karafka.monitor.instrument(
-            'error.occurred',
+            "error.occurred",
             caller: self,
             error: e,
-            type: 'connection.client.poll.error'
+            type: "connection.client.poll.error"
           )
         end
 
@@ -790,7 +790,7 @@ module Karafka
       # @return [Boolean] should we unsubscribe prior to shutdown
       def unsubscribe?
         return false if @unsubscribing
-        return false if @subscription_group.kafka.key?(:'group.instance.id')
+        return false if @subscription_group.kafka.key?(:"group.instance.id")
         return false unless @mode.subscribe?
         return false if assignment.empty?
 

data/lib/karafka/connection/listener.rb

@@ -75,7 +75,7 @@ module Karafka
       #   start consuming data
       def call
         Karafka.monitor.instrument(
-          'connection.listener.before_fetch_loop',
+          "connection.listener.before_fetch_loop",
           caller: self,
           client: @client,
           subscription_group: @subscription_group
@@ -84,7 +84,7 @@ module Karafka
         fetch_loop
 
         Karafka.monitor.instrument(
-          'connection.listener.after_fetch_loop',
+          "connection.listener.after_fetch_loop",
           caller: self,
           client: @client,
           subscription_group: @subscription_group
@@ -174,7 +174,7 @@ module Karafka
         # Run the main loop as long as we are not stopping or moving into quiet mode
         while running?
           Karafka.monitor.instrument(
-            'connection.listener.fetch_loop',
+            "connection.listener.fetch_loop",
             caller: self,
             client: @client,
             subscription_group: @subscription_group
@@ -183,7 +183,7 @@ module Karafka
           resume_paused_partitions
 
           Karafka.monitor.instrument(
-            'connection.listener.fetch_loop.received',
+            "connection.listener.fetch_loop.received",
             caller: self,
             client: @client,
             subscription_group: @subscription_group,
@@ -260,10 +260,10 @@ module Karafka
       rescue Exception => e
         # rubocop:enable Lint/RescueException
         Karafka.monitor.instrument(
-          'error.occurred',
+          "error.occurred",
           caller: self,
           error: e,
-          type: 'connection.listener.fetch_loop.error'
+          type: "connection.listener.fetch_loop.error"
         )
 
         reset

data/lib/karafka/connection/mode.rb

@@ -66,7 +66,7 @@ module Karafka
         else
           raise(
             ArgumentError,
-            "Invalid connection mode: #{new_mode}. Valid modes: #{MODES.join(', ')}"
+            "Invalid connection mode: #{new_mode}. Valid modes: #{MODES.join(", ")}"
           )
         end
       end

data/lib/karafka/connection/proxy.rb

@@ -32,7 +32,7 @@ module Karafka
 
       attr_accessor :wrapped
 
-      alias __getobj__ wrapped
+      alias_method :__getobj__, :wrapped
 
       # @param obj [Rdkafka::Consumer, Proxy] rdkafka consumer or consumer wrapped with proxy
       def initialize(obj)

data/lib/karafka/connection/status.rb

@@ -59,7 +59,7 @@ module Karafka
         if pending?
           @status = :stopping
           conductor.signal
-          monitor.instrument('connection.listener.stopping', caller: self)
+          monitor.instrument("connection.listener.stopping", caller: self)
 
           stopped!
         elsif stopped?
@@ -69,7 +69,7 @@ module Karafka
         else
           @status = :stopping
           conductor.signal
-          monitor.instrument('connection.listener.stopping', caller: self)
+          monitor.instrument("connection.listener.stopping", caller: self)
         end
       end
 

data/lib/karafka/constraints.rb

@@ -13,15 +13,15 @@ module Karafka
       # Verifies that optional requirements are met.
       def verify!
         # Skip verification if web is not used at all
-        return unless require_version('karafka/web')
+        return unless require_version("karafka/web")
 
         # All good if version higher than 0.10.0 because we expect 0.10.0 or higher
-        return if version(Karafka::Web::VERSION) >= version('0.10.0')
+        return if version(Karafka::Web::VERSION) >= version("0.10.0")
 
         # If older web-ui used, we cannot allow it
         raise(
           Errors::DependencyConstraintsError,
-          'karafka-web < 0.10.0 is not compatible with this karafka version'
+          "karafka-web < 0.10.0 is not compatible with this karafka version"
         )
       end
 

data/lib/karafka/embedded.rb

@@ -25,9 +25,9 @@ module Karafka
         end
 
         Thread.new do
-          Thread.current.name = 'karafka.embedded'
+          Thread.current.name = "karafka.embedded"
 
-          Karafka::Process.tags.add(:execution_mode, 'mode:embedded')
+          Karafka::Process.tags.add(:execution_mode, "mode:embedded")
           Karafka::Server.execution_mode.embedded!
           Karafka::Server.start
         end
@@ -43,7 +43,7 @@ module Karafka
         # Prevent from double stopping
         unless @stopping
           Thread.new do
-            Thread.current.name = 'karafka.embedded.stopping'
+            Thread.current.name = "karafka.embedded.stopping"
 
             stop = false
 

data/lib/karafka/env.rb

@@ -11,14 +11,14 @@ module Karafka
     ].freeze
 
     # Default fallback env
-    DEFAULT_ENV = 'development'
+    DEFAULT_ENV = "development"
 
     private_constant :LOOKUP_ENV_KEYS, :DEFAULT_ENV
 
     # @return [Karafka::Env] env object
     # @note Will load appropriate environment automatically
     def initialize
-      super('')
+      super("")
 
       LOOKUP_ENV_KEYS
         .filter_map { |key| ENV.fetch(key, nil) }
@@ -31,7 +31,7 @@ module Karafka
     # @param include_private [Boolean] should we include private methods as well
     # @return [Boolean] true if we respond to a given missing method, otherwise false
     def respond_to_missing?(method_name, include_private = false)
-      (method_name[-1] == '?') || super
+      (method_name[-1] == "?") || super
     end
 
     # Reacts to missing methods, from which some might be the env checks.
@@ -39,7 +39,7 @@ module Karafka
     # @param method_name [String] method name for missing or env name with question mark
     # @param arguments [Array] any arguments that we pass to the method
     def method_missing(method_name, *arguments)
-      method_name[-1] == '?' ? self == method_name[0..-2] : super
+      (method_name[-1] == "?") ? self == method_name[0..-2] : super
     end
   end
 end

data/lib/karafka/errors.rb

@@ -51,7 +51,9 @@ module Karafka
       end
     end
 
-    # Raised when we've waited enough for shutting down a non-responsive process
+    # Raised when the graceful shutdown timeout has been exceeded and Karafka must forcefully
+    # terminate remaining listeners and workers. This typically happens when consumer processing
+    # or shutdown jobs take longer than the configured `shutdown_timeout`.
     ForcefulShutdownError = Class.new(BaseError)
 
     # Raised when the jobs queue receives a job that should not be received as it would cause
@@ -71,6 +73,9 @@ module Karafka
     # Raised when the license token is not valid
     InvalidLicenseTokenError = Class.new(BaseError)
 
+    # Raised when the license token has expired or been revoked
+    ExpiredLicenseTokenError = Class.new(BaseError)
+
     # Raised on attempt to deserializer a cleared message
     MessageClearedError = Class.new(BaseError)
 

data/lib/karafka/execution_mode.rb

@@ -95,7 +95,7 @@ module Karafka
       else
         raise(
           ArgumentError,
-          "Invalid execution mode: #{new_mode}. Valid modes: #{MODES.join(', ')}"
+          "Invalid execution mode: #{new_mode}. Valid modes: #{MODES.join(", ")}"
         )
       end
     end

data/lib/karafka/helpers/config_importer.rb

@@ -20,7 +20,7 @@ module Karafka
         @attributes.each do |name, path|
           model.class_eval <<~RUBY, __FILE__, __LINE__ + 1
             def #{name}
-              @#{name} ||= Karafka::App.config.#{path.join('.')}
+              @#{name} ||= Karafka::App.config.#{path.join(".")}
             end
           RUBY
         end
@@ -33,7 +33,7 @@ module Karafka
         @attributes.each do |name, path|
           model.class_eval <<~RUBY, __FILE__, __LINE__ + 1
             def self.#{name}
-              @#{name} ||= Karafka::App.config.#{path.join('.')}
+              @#{name} ||= Karafka::App.config.#{path.join(".")}
             end
           RUBY
         end

data/lib/karafka/helpers/interval_runner.rb

@@ -26,9 +26,11 @@ module Karafka
 
       # Runs the requested code if it was not executed previously recently
       def call
-        return if monotonic_now - @last_called_at < @interval
+        now = monotonic_now
 
-        @last_called_at = monotonic_now
+        return if now - @last_called_at < @interval
+
+        @last_called_at = now
 
         @block.call
       end

data/lib/karafka/helpers/multi_delegator.rb

@@ -28,7 +28,7 @@ module Karafka
         # Creates an alias `to` for the `new` method to enable nice chaining API
         # @return [MultiDelegator] new instance of the multi delegator
         # @see #delegate
-        alias to new
+        alias_method :to, :new
       end
     end
   end

data/lib/karafka/instrumentation/assignments_tracker.rb

@@ -54,15 +54,15 @@ module Karafka
       # @return [String] thread-safe and lock-safe inspect implementation
       def inspect
         info = if @mutex.try_lock
-                 begin
-                   assignments = @assignments.dup.transform_keys(&:name).inspect
-                   "assignments=#{assignments}"
-                 ensure
-                   @mutex.unlock
-                 end
-               else
-                 'busy'
-               end
+          begin
+            assignments = @assignments.dup.transform_keys(&:name).inspect
+            "assignments=#{assignments}"
+          ensure
+            @mutex.unlock
+          end
+        else
+          "busy"
+        end
 
         "#<#{self.class.name} #{info}>"
       end

data/lib/karafka/instrumentation/callbacks/error.rb

@@ -29,20 +29,20 @@ module Karafka
           return unless @client_name == client_name
 
           monitor.instrument(
-            'error.occurred',
+            "error.occurred",
             caller: self,
             subscription_group_id: @subscription_group_id,
             consumer_group_id: @consumer_group_id,
-            type: 'librdkafka.error',
+            type: "librdkafka.error",
             error: error
           )
-        rescue StandardError => e
+        rescue => e
           monitor.instrument(
-            'error.occurred',
+            "error.occurred",
             caller: self,
             subscription_group_id: @subscription_group_id,
             consumer_group_id: @consumer_group_id,
-            type: 'callbacks.error.error',
+            type: "callbacks.error.error",
             error: e
           )
         end

data/lib/karafka/instrumentation/callbacks/oauthbearer_token_refresh.rb

@@ -22,15 +22,15 @@ module Karafka
           return unless @bearer.name == bearer_name
 
           monitor.instrument(
-            'oauthbearer.token_refresh',
+            "oauthbearer.token_refresh",
             bearer: @bearer,
             caller: self
           )
-        rescue StandardError => e
+        rescue => e
           monitor.instrument(
-            'error.occurred',
+            "error.occurred",
             caller: self,
-            type: 'callbacks.oauthbearer_token_refresh.error',
+            type: "callbacks.oauthbearer_token_refresh.error",
             error: e
           )
         end