karafka 2.5.5 → 2.5.7

data/lib/karafka/base_consumer.rb

@@ -42,12 +42,12 @@ module Karafka
     # @private
     def on_initialized
       handle_initialized
-    rescue StandardError => e
+    rescue => e
       monitor.instrument(
-        'error.occurred',
+        "error.occurred",
         error: e,
         caller: self,
-        type: 'consumer.initialized.error'
+        type: "consumer.initialized.error"
       )
     end
 
@@ -84,12 +84,12 @@ module Karafka
     # @param action [Symbol]
     def on_wrap(action, &)
       handle_wrap(action, &)
-    rescue StandardError => e
+    rescue => e
       monitor.instrument(
-        'error.occurred',
+        "error.occurred",
         error: e,
         caller: self,
-        type: 'consumer.wrap.error'
+        type: "consumer.wrap.error"
       )
     end
 
@@ -104,13 +104,13 @@ module Karafka
     #   message.
     def on_consume
       handle_consume
-    rescue StandardError => e
+    rescue => e
       monitor.instrument(
-        'error.occurred',
+        "error.occurred",
         error: e,
         caller: self,
         seek_offset: seek_offset,
-        type: 'consumer.consume.error'
+        type: "consumer.consume.error"
       )
     end
 
@@ -124,13 +124,13 @@ module Karafka
     #   flows do not interact with external systems and their errors are expected to bubble up
     def on_after_consume
       handle_after_consume
-    rescue StandardError => e
+    rescue => e
       monitor.instrument(
-        'error.occurred',
+        "error.occurred",
         error: e,
         caller: self,
         seek_offset: seek_offset,
-        type: 'consumer.after_consume.error'
+        type: "consumer.after_consume.error"
       )
 
       retry_after_pause
@@ -144,13 +144,13 @@ module Karafka
     # Trigger method for running on eof without messages
     def on_eofed
       handle_eofed
-    rescue StandardError => e
+    rescue => e
       monitor.instrument(
-        'error.occurred',
+        "error.occurred",
         error: e,
         caller: self,
         seek_offset: seek_offset,
-        type: 'consumer.eofed.error'
+        type: "consumer.eofed.error"
       )
     end
 
@@ -180,12 +180,12 @@ module Karafka
     # @private
     def on_revoked
       handle_revoked
-    rescue StandardError => e
+    rescue => e
       monitor.instrument(
-        'error.occurred',
+        "error.occurred",
         error: e,
         caller: self,
-        type: 'consumer.revoked.error'
+        type: "consumer.revoked.error"
       )
     end
 
@@ -201,12 +201,12 @@ module Karafka
     # @private
     def on_shutdown
       handle_shutdown
-    rescue StandardError => e
+    rescue => e
       monitor.instrument(
-        'error.occurred',
+        "error.occurred",
         error: e,
         caller: self,
-        type: 'consumer.shutdown.error'
+        type: "consumer.shutdown.error"
       )
     end
 
@@ -229,7 +229,7 @@ module Karafka
         "revoked=#{coordinator&.revoked?}"
       ]
 
-      "#<#{self.class.name}:#{format('%#x', object_id)} #{parts.join(' ')}>"
+      "#<#{self.class.name}:#{format("%#x", object_id)} #{parts.join(" ")}>"
     end
 
     private
@@ -241,14 +241,15 @@ module Karafka
     #
     # @note Please keep in mind that it will run many times when persistence is off. Basically once
     #   each batch.
-    def initialized; end
+    def initialized
+    end
 
     # Method that will perform business logic and on data received from Kafka (it will consume
     #   the data)
     # @note This method needs to be implemented in a subclass. We stub it here as a failover if
     #   someone forgets about it or makes on with typo
     def consume
-      raise NotImplementedError, 'Implement this in a subclass'
+      raise NotImplementedError, "Implement this in a subclass"
     end
 
     # This method can be redefined to build a wrapping API around user code + karafka flow control
@@ -287,15 +288,18 @@ module Karafka
 
     # Method that will be executed when a given topic partition reaches eof without any new
     # incoming messages alongside
-    def eofed; end
+    def eofed
+    end
 
     # Method that will be executed when a given topic partition is revoked. You can use it for
     # some teardown procedures (closing file handler, etc).
-    def revoked; end
+    def revoked
+    end
 
     # Method that will be executed when the process is shutting down. You can use it for
     # some teardown procedures (closing file handler, etc).
-    def shutdown; end
+    def shutdown
+    end
 
     # @return [Boolean] was this consumer in active use. Active use means running `#consume` at
     #   least once. Consumer may have to run `#revoked` or `#shutdown` despite not running
@@ -337,7 +341,7 @@ module Karafka
       coordinator.manual_pause if manual_pause
 
       monitor.instrument(
-        'consumer.consuming.pause',
+        "consumer.consuming.pause",
         caller: self,
         manual: manual_pause,
         topic: topic.name,
@@ -385,7 +389,7 @@ module Karafka
       )
 
       monitor.instrument(
-        'consumer.consuming.seek',
+        "consumer.consuming.seek",
         caller: self,
         topic: topic.name,
         partition: partition,
@@ -433,7 +437,7 @@ module Karafka
       # Instrumentation needs to run **after** `#pause` invocation because we rely on the states
       # set by `#pause`
       monitor.instrument(
-        'consumer.consuming.retry',
+        "consumer.consuming.retry",
         caller: self,
         topic: topic.name,
         partition: partition,

data/lib/karafka/cli/base.rb

@@ -18,7 +18,7 @@ module Karafka
 
       # This method should implement proper cli action
       def call
-        raise NotImplementedError, 'Implement this in a subclass'
+        raise NotImplementedError, "Implement this in a subclass"
       end
 
       private
@@ -29,11 +29,11 @@ module Karafka
 
         if Karafka.pro?
           Karafka.logger.info(
-            green('Thank you for using Karafka Pro!')
+            green("Thank you for using Karafka Pro!")
           )
         else
           Karafka.logger.info(
-            red('Upgrade to Karafka Pro for more features and support: https://karafka.io')
+            red("Upgrade to Karafka Pro for more features and support: https://karafka.io")
           )
         end
       end
@@ -41,14 +41,14 @@ module Karafka
       class << self
         # Loads proper environment with what is needed to run the CLI
         def load
-          rails_env_rb = File.join(Dir.pwd, 'config/environment.rb')
+          rails_env_rb = File.join(Dir.pwd, "config/environment.rb")
           is_rails = Kernel.const_defined?(:Rails) && File.exist?(rails_env_rb)
 
           # If the boot file is disabled and this is a Rails app, we assume that user moved the
           # karafka app configuration to initializers or other Rails loading related place.
           # It is not recommended but some users tend to do this. In such cases we just try to load
           # the Rails stuff hoping that it will also load Karafka stuff
-          if Karafka.boot_file.to_s == 'false' && is_rails
+          if Karafka.boot_file.to_s == "false" && is_rails
             require rails_env_rb
 
             return
@@ -104,7 +104,7 @@ module Karafka
           OptionParser.new do |opts|
             (@options || []).each do |option|
               # Creates aliases for backwards compatibility
-              names = option[3].flat_map { |name| [name, name.tr('_', '-')] }
+              names = option[3].flat_map { |name| [name, name.tr("_", "-")] }
               names.map! { |name| "#{name} value1,value2,valueN" } if option[2] == Array
               names.uniq!
 
@@ -122,7 +122,7 @@ module Karafka
           ObjectSpace
             .each_object(Class)
             .select { |klass| klass.superclass == Karafka::Cli::Base }
-            .reject { |klass| klass.to_s.end_with?('::Base') }
+            .reject { |klass| klass.to_s.end_with?("::Base") }
             .sort_by(&:name)
         end
 
@@ -134,7 +134,7 @@ module Karafka
         #   name => 'test_me'
         def name
           to_s
-            .split('::')
+            .split("::")
             .last
             .gsub(/([a-z\d])([A-Z])/, '\1_\2')
             .downcase

data/lib/karafka/cli/console.rb

@@ -20,7 +20,7 @@ module Karafka
         # @return [String] Console executing command for Rails setup
         # @note In case of Rails, it has its own console, hence we can just defer to it
         def rails_console
-          'bundle exec rails console'
+          "bundle exec rails console"
         end
       end
 

data/lib/karafka/cli/contracts/server.rb

@@ -8,8 +8,8 @@ module Karafka
       class Server < 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('cli').fetch('server')
+            File.join(Karafka.gem_root, "config", "locales", "errors.yml")
+          ).fetch("en").fetch("validations").fetch("cli").fetch("server")
         end
 
         %i[
@@ -44,10 +44,10 @@ module Karafka
             next if value.empty?
 
             subscription_groups = Karafka::App
-                                  .consumer_groups
-                                  .map(&:subscription_groups)
-                                  .flatten
-                                  .map(&:name)
+              .consumer_groups
+              .map(&:subscription_groups)
+              .flatten
+              .map(&:name)
 
             next if (value - subscription_groups).empty?
 
@@ -65,12 +65,12 @@ module Karafka
             next if value.empty?
 
             topics = Karafka::App
-                     .consumer_groups
-                     .map(&:subscription_groups)
-                     .flatten
-                     .map(&:topics)
-                     .map { |gtopics| gtopics.map(&:name) }
-                     .flatten
+              .consumer_groups
+              .map(&:subscription_groups)
+              .flatten
+              .map(&:topics)
+              .map { |gtopics| gtopics.map(&:name) }
+              .flatten
 
             next if (value - topics).empty?
 

data/lib/karafka/cli/help.rb

@@ -5,14 +5,14 @@ module Karafka
   class Cli
     # Prints info with list of commands available
     class Help < Base
-      desc 'Describes available commands'
+      desc "Describes available commands"
 
       # Print available commands
       def call
         # Find the longest command for alignment purposes
         max_command_length = self.class.commands.map { |command| command.name.size }.max
 
-        puts 'Karafka commands:'
+        puts "Karafka commands:"
 
         # Print each command formatted with its description
         self.class.commands.each do |command|

data/lib/karafka/cli/info.rb

@@ -11,7 +11,7 @@ module Karafka
         client_id: %i[client_id]
       )
 
-      desc 'Prints configuration details and other options of your application'
+      desc "Prints configuration details and other options of your application"
 
       # Nice karafka banner
       BANNER = <<~BANNER
@@ -35,7 +35,7 @@ module Karafka
 
       # @return [Array<String>] core framework related info
       def core_info
-        postfix = Karafka.pro? ? ' + Pro' : ''
+        postfix = Karafka.pro? ? " + Pro" : ""
 
         [
           "Karafka version: #{Karafka::VERSION}#{postfix}",
@@ -54,12 +54,12 @@ module Karafka
       def license_info
         if Karafka.pro?
           [
-            'License: Commercial',
+            "License: Commercial",
             "License entity: #{license.entity}"
           ]
         else
           [
-            'License: LGPL-3.0'
+            "License: LGPL-3.0"
           ]
         end
       end

data/lib/karafka/cli/install.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'erb'
+require "erb"
 
 module Karafka
   # Karafka framework Cli
@@ -9,7 +9,7 @@ module Karafka
     class Install < Base
       include Helpers::Colorize
 
-      desc 'Installs all required things for Karafka application in current directory'
+      desc "Installs all required things for Karafka application in current directory"
 
       # Directories created by default
       INSTALL_DIRS = %w[
@@ -19,9 +19,9 @@ module Karafka
 
       # Where should we map proper files from templates
       INSTALL_FILES_MAP = {
-        'karafka.rb.erb' => Karafka.boot_file,
-        'application_consumer.rb.erb' => 'app/consumers/application_consumer.rb',
-        'example_consumer.rb.erb' => 'app/consumers/example_consumer.rb'
+        "karafka.rb.erb" => Karafka.boot_file,
+        "application_consumer.rb.erb" => "app/consumers/application_consumer.rb",
+        "example_consumer.rb.erb" => "app/consumers/example_consumer.rb"
       }.freeze
 
       # Initializes the install command
@@ -34,7 +34,7 @@ module Karafka
           )
         ).dependencies
 
-        @rails = dependencies.key?('railties') || dependencies.key?('rails')
+        @rails = dependencies.key?("railties") || dependencies.key?("rails")
       end
 
       # Install all required things for Karafka application in current directory
@@ -44,8 +44,8 @@ module Karafka
         end
 
         puts
-        puts 'Installing Karafka framework...'
-        puts 'Ruby on Rails detected...' if rails?
+        puts "Installing Karafka framework..."
+        puts "Ruby on Rails detected..." if rails?
         puts
 
         INSTALL_FILES_MAP.each do |source, target|
@@ -53,15 +53,15 @@ module Karafka
           FileUtils.mkdir_p File.dirname(pathed_target)
 
           template = File.read(Karafka.core_root.join("templates/#{source}"))
-          render = ERB.new(template, trim_mode: '-').result(binding)
+          render = ERB.new(template, trim_mode: "-").result(binding)
 
           File.write(pathed_target, render)
 
-          puts "#{green('Created')} #{target}"
+          puts "#{green("Created")} #{target}"
         end
 
         puts
-        puts("Installation #{green('completed')}. Have fun!")
+        puts("Installation #{green("completed")}. Have fun!")
         puts
       end
 

data/lib/karafka/cli/server.rb

@@ -22,7 +22,7 @@ module Karafka
       OPTIONS_BUILDER = lambda do
         option(
           :consumer_groups,
-          'Runs server only with specified consumer groups',
+          "Runs server only with specified consumer groups",
           Array,
           %w[
             -g
@@ -33,7 +33,7 @@ module Karafka
 
         option(
           :subscription_groups,
-          'Runs server only with specified subscription groups',
+          "Runs server only with specified subscription groups",
           Array,
           %w[
             --subscription_groups
@@ -43,7 +43,7 @@ module Karafka
 
         option(
           :topics,
-          'Runs server only with specified topics',
+          "Runs server only with specified topics",
           Array,
           %w[
             --topics
@@ -53,7 +53,7 @@ module Karafka
 
         option(
           :exclude_consumer_groups,
-          'Runs server without specified consumer groups',
+          "Runs server without specified consumer groups",
           Array,
           %w[
             --exclude_consumer_groups
@@ -62,7 +62,7 @@ module Karafka
 
         option(
           :exclude_subscription_groups,
-          'Runs server without specified subscription groups',
+          "Runs server without specified subscription groups",
           Array,
           %w[
             --exclude_subscription_groups
@@ -71,7 +71,7 @@ module Karafka
 
         option(
           :exclude_topics,
-          'Runs server without specified topics',
+          "Runs server without specified topics",
           Array,
           %w[
             --exclude_topics

data/lib/karafka/cli/swarm.rb

@@ -5,7 +5,7 @@ module Karafka
   class Cli
     # Starts swarm of consumers forked from the supervisor
     class Swarm < Base
-      desc 'Starts swarm of Karafka consumers with a supervisor'
+      desc "Starts swarm of Karafka consumers with a supervisor"
 
       aliases :swarm
 

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

@@ -17,7 +17,7 @@ module Karafka
         # @return [Boolean] true if there were any changes applied, otherwise false
         def call
           if candidate_topics.empty?
-            puts "#{yellow('Skipping')} because no declarative topics exist."
+            puts "#{yellow("Skipping")} because no declarative topics exist."
 
             return false
           end
@@ -25,7 +25,7 @@ module Karafka
           resources_to_migrate = build_resources_to_migrate
 
           if resources_to_migrate.empty?
-            puts "#{yellow('Skipping')} because there are no configurations to align."
+            puts "#{yellow("Skipping")} because there are no configurations to align."
 
             return false
           end
@@ -35,7 +35,7 @@ module Karafka
               Karafka::Admin::Configs.alter(resource)
             end
 
-            puts "#{green('Updated')} topic #{resource.name} configuration."
+            puts "#{green("Updated")} topic #{resource.name} configuration."
           end
 
           true
@@ -54,7 +54,7 @@ module Karafka
           # First lets only operate on topics that do exist
           declaratives_routing_topics.each do |topic|
             unless existing_topics_names.include?(topic.name)
-              puts "#{yellow('Skipping')} because topic #{topic.name} does not exist."
+              puts "#{yellow("Skipping")} because topic #{topic.name} does not exist."
               next
             end
 

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

@@ -23,7 +23,7 @@ module Karafka
 
           yield
         rescue Rdkafka::RdkafkaError => e
-          puts "#{operation_message} #{red('failed')}:"
+          puts "#{operation_message} #{red("failed")}:"
           puts e
 
           raise Errors::CommandValidationError, cause: e
@@ -37,14 +37,14 @@ module Karafka
           return @declaratives_routing_topics if @declaratives_routing_topics
 
           collected_topics = {}
-          default_servers = kafka_config[:'bootstrap.servers']
+          default_servers = kafka_config[:"bootstrap.servers"]
 
           App.consumer_groups.each do |consumer_group|
             consumer_group.topics.each do |topic|
               # Skip topics that were explicitly disabled from management
               next unless topic.declaratives.active?
               # If bootstrap servers are different, consider this a different cluster
-              next unless default_servers == topic.kafka[:'bootstrap.servers']
+              next unless default_servers == topic.kafka[:"bootstrap.servers"]
 
               collected_topics[topic.name] ||= topic
             end
@@ -68,11 +68,11 @@ module Karafka
         # for Kafka to actually propagate new topics knowledge across the cluster. We give it that
         # bit of time just in case.
         def wait
-          print 'Waiting for the topics to synchronize in the cluster'
+          print "Waiting for the topics to synchronize in the cluster"
 
           5.times do
             sleep(1)
-            print '.'
+            print "."
           end
 
           puts

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

@@ -13,7 +13,7 @@ module Karafka
             name = topic.name
 
             if existing_topics_names.include?(name)
-              puts "#{yellow('Skipping')} because topic #{name} already exists."
+              puts "#{yellow("Skipping")} because topic #{name} already exists."
             else
               supervised("Creating topic #{name}") do
                 Admin.create_topic(
@@ -24,7 +24,7 @@ module Karafka
                 )
               end
 
-              puts "#{green('Created')} topic #{name}."
+              puts "#{green("Created")} topic #{name}."
               any_created = true
             end
           end

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

@@ -17,10 +17,10 @@ module Karafka
                 Admin.delete_topic(name)
               end
 
-              puts "#{green('Deleted')} topic #{name}."
+              puts "#{green("Deleted")} topic #{name}."
               any_deleted = true
             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/help.rb

@@ -7,11 +7,12 @@ module Karafka
       class Help < Base
         # Displays help information for all available topics management commands
         def call
-          puts <<~HELP
+          help_text = <<~HELP
             Karafka topics commands:
               align        # Aligns configuration of all declarative topics based on definitions
               create       # Creates topics with appropriate settings
               delete       # Deletes all topics defined in the routes
+              health       # Checks topics health and replication settings (Pro only)
               help         # Describes available topics management commands
               migrate      # Creates missing topics, repartitions existing and aligns configuration
               plan         # Plans migration process and prints changes to be applied
@@ -26,10 +27,13 @@ module Karafka
               karafka topics plan --detailed-exitcode
               karafka topics migrate
               karafka topics align
+              karafka topics health
 
             Note: All admin operations run on the default cluster only.
           HELP
 
+          puts help_text
+
           # We return false to indicate with exit code 0 that no changes were applied
           false
         end