karafka 2.5.4 → 2.5.6

data/lib/karafka/setup/attributes_map.rb

@@ -334,7 +334,7 @@ module Karafka
       ].freeze
 
       # Location of the file with rdkafka settings list
-      SOURCE = <<~SOURCE.delete("\n").gsub(/\s+/, '/')
+      SOURCE = <<~SOURCE.delete("\n").gsub(/\s+/, "/")
         https://raw.githubusercontent.com
           confluentinc/librdkafka
           v#{Rdkafka::LIBRDKAFKA_VERSION}
@@ -365,21 +365,21 @@ module Karafka
         #   options list in case it would change
         def generate
           # Not used anywhere else, hence required here
-          require 'open-uri'
+          require "open-uri"
 
           attributes = { consumer: Set.new, producer: Set.new }
 
           URI.parse(SOURCE).open.readlines.each do |line|
-            next unless line.include?('|')
+            next unless line.include?("|")
 
-            attribute, attribute_type = line.split('|').map(&:strip)
+            attribute, attribute_type = line.split("|").map(&:strip)
 
             case attribute_type
-            when 'C'
+            when "C"
               attributes[:consumer] << attribute
-            when 'P'
+            when "P"
               attributes[:producer] << attribute
-            when '*'
+            when "*"
               attributes[:consumer] << attribute
               attributes[:producer] << attribute
             else

data/lib/karafka/setup/config.rb

@@ -26,12 +26,12 @@ module Karafka
         #   terms and conditions
         setting :token, default: false
         # option entity [String] for whom we did issue the license
-        setting :entity, default: ''
+        setting :entity, default: ""
       end
 
       # option client_id [String] kafka client_id - used to uniquely identify given client instance
       #   Used only for logging.
-      setting :client_id, default: 'karafka'
+      setting :client_id, default: "karafka"
       # option logger [Instance] logger that we want to use
       setting :logger, default: Karafka::Instrumentation::Logger.new
       # option monitor [Instance] monitor that we will to use (defaults to Karafka::Monitor)
@@ -41,7 +41,7 @@ module Karafka
       setting :consumer_persistence, default: true
       # option [String] should we start with the earliest possible offset or latest
       # This will set the `auto.offset.reset` value unless present in the kafka scope
-      setting :initial_offset, default: 'earliest'
+      setting :initial_offset, default: "earliest"
       # options max_messages [Integer] how many messages do we want to fetch from Kafka in one go
       setting :max_messages, default: 100
       # option [Integer] number of milliseconds we can wait while fetching data
@@ -71,7 +71,7 @@ module Karafka
       # and/or we work with existing systems where we cannot change topics names.
       setting :strict_topics_namespacing, default: true
       # option [String] default consumer group name for implicit routing
-      setting :group_id, default: 'app'
+      setting :group_id, default: "app"
       # option [Boolean] when set to true, it will validate as part of the routing validation, that
       # all topics and DLQ topics (even not active) have the declarative topics definitions.
       # Really useful when you want to ensure that all topics in routing are managed via
@@ -115,22 +115,22 @@ module Karafka
         # option [Hash] extra changes to the default root kafka settings
         setting :kafka, default: {
           # We want to know when there is no more data not to end up with an endless loop
-          'enable.partition.eof': true,
+          "enable.partition.eof": true,
           # Do not publish statistics from admin as they are not relevant
-          'statistics.interval.ms': 0,
+          "statistics.interval.ms": 0,
           # Fetch at most 5 MBs when using admin
-          'fetch.message.max.bytes': 5 * 1_048_576,
+          "fetch.message.max.bytes": 5 * 1_048_576,
           # Do not commit offset automatically, this prevents offset tracking for operations
           # involving a consumer instance
-          'enable.auto.commit': false,
+          "enable.auto.commit": false,
           # Make sure that topic metadata lookups do not create topics accidentally
-          'allow.auto.create.topics': false,
+          "allow.auto.create.topics": false,
           # Do not store offsets automatically in admin in any way
-          'enable.auto.offset.store': false
+          "enable.auto.offset.store": false
         }
 
         # option [String] default name for the admin consumer group.
-        setting :group_id, default: 'karafka_admin'
+        setting :group_id, default: "karafka_admin"
 
         # option max_wait_time [Integer] We wait only for this amount of time before raising error
         # as we intercept this error and retry after checking that the operation was finished or

data/lib/karafka/setup/contracts/config.rb

@@ -13,8 +13,8 @@ module Karafka
       class Config < 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('setup').fetch('config')
+            File.join(Karafka.gem_root, "config", "locales", "errors.yml")
+          ).fetch("en").fetch("validations").fetch("setup").fetch("config")
         end
 
         # Topics regexp constant reference for easier usage

data/lib/karafka/setup/defaults_injector.rb

@@ -10,18 +10,18 @@ module Karafka
       CONSUMER_KAFKA_DEFAULTS = {
         # We emit the statistics by default, so all the instrumentation and web-ui work out of
         # the box, without requiring users to take any extra actions aside from enabling.
-        'statistics.interval.ms': 5_000,
-        'client.software.name': 'karafka',
+        "statistics.interval.ms": 5_000,
+        "client.software.name": "karafka",
         # Same as librdkafka default, we inject it nonetheless to have it always available as
         # some features may use this value for computation and it is better to ensure, we do
         # always have it
-        'max.poll.interval.ms': 300_000,
-        'socket.nagle.disable': true,
-        'client.software.version': [
+        "max.poll.interval.ms": 300_000,
+        "socket.nagle.disable": true,
+        "client.software.version": [
           "v#{Karafka::VERSION}",
           "rdkafka-ruby-v#{Rdkafka::VERSION}",
           "librdkafka-v#{Rdkafka::LIBRDKAFKA_VERSION}"
-        ].join('-')
+        ].join("-")
       }.freeze
 
       # Contains settings that should not be used in production but make life easier in dev
@@ -29,12 +29,12 @@ module Karafka
         # Will create non-existing topics automatically.
         # Note that the broker needs to be configured with `auto.create.topics.enable=true`
         # While it is not recommended in prod, it simplifies work in dev
-        'allow.auto.create.topics': 'true',
+        "allow.auto.create.topics": "true",
         # We refresh the cluster state often as newly created topics in dev may not be detected
         # fast enough. Fast enough means within reasonable time to provide decent user experience
         # While it's only a one time thing for new topics, it can still be irritating to have to
         # restart the process.
-        'topic.metadata.refresh.interval.ms': 5_000
+        "topic.metadata.refresh.interval.ms": 5_000
       }.freeze
 
       # Contains settings that should not be used in production but make life easier in dev
@@ -42,9 +42,9 @@ module Karafka
       # they have to set this by themselves.
       PRODUCER_KAFKA_DEV_DEFAULTS = {
         # For all of those same reasoning as for the consumer
-        'allow.auto.create.topics': 'true',
-        'topic.metadata.refresh.interval.ms': 5_000,
-        'socket.nagle.disable': true
+        "allow.auto.create.topics": "true",
+        "topic.metadata.refresh.interval.ms": 5_000,
+        "socket.nagle.disable": true
       }.freeze
 
       private_constant(

data/lib/karafka/swarm/manager.rb

@@ -77,7 +77,7 @@ module Karafka
 
       # Checks on nodes if they are ok one after another
       def control
-        monitor.instrument('swarm.manager.control', caller: self) do
+        monitor.instrument("swarm.manager.control", caller: self) do
           @nodes.each do |node|
             statuses = @statuses[node]
 
@@ -107,7 +107,7 @@ module Karafka
         # Do not run any other checks on this node if it is during stopping but still has time
         return true unless over?(statuses[:stop], shutdown_timeout)
 
-        monitor.instrument('swarm.manager.terminating', caller: self, node: node) do
+        monitor.instrument("swarm.manager.terminating", caller: self, node: node) do
           node.terminate
           statuses[:terminate] = monotonic_now
         end
@@ -135,7 +135,7 @@ module Karafka
         else
           # A single invalid report will cause it to stop. We do not support intermediate failures
           # that would recover. Such states should be implemented in the listener.
-          monitor.instrument('swarm.manager.stopping', caller: self, node: node, status: status) do
+          monitor.instrument("swarm.manager.stopping", caller: self, node: node, status: status) do
             node.stop
             statuses[:stop] = monotonic_now
           end
@@ -157,7 +157,7 @@ module Karafka
 
         # Start the stopping procedure if the node stopped reporting frequently enough
         monitor.instrument(
-          'swarm.manager.stopping',
+          "swarm.manager.stopping",
           caller: self,
           node: node,
           status: NOT_RESPONDING_SHUTDOWN_STATUS
@@ -210,9 +210,9 @@ module Karafka
         statuses.clear
         statuses[:control] = monotonic_now
 
-        monitor.instrument('swarm.manager.before_fork', instr_args)
+        monitor.instrument("swarm.manager.before_fork", instr_args)
         node.start
-        monitor.instrument('swarm.manager.after_fork', instr_args)
+        monitor.instrument("swarm.manager.after_fork", instr_args)
 
         node
       end

data/lib/karafka/swarm/node.rb

@@ -100,9 +100,9 @@ module Karafka
 
           swarm.node = self
           monitor.subscribe(liveness_listener)
-          monitor.instrument('swarm.node.after_fork', caller: self)
+          monitor.instrument("swarm.node.after_fork", caller: self)
 
-          Karafka::Process.tags.add(:execution_mode, 'mode:swarm')
+          Karafka::Process.tags.add(:execution_mode, "mode:swarm")
           Karafka::Process.tags.add(:swarm_nodeid, "node:#{@id}")
 
           Server.execution_mode.swarm!
@@ -118,7 +118,7 @@ module Karafka
       # Indicates that this node is doing well
       # @note Child API
       def healthy
-        write('0')
+        write("0")
       end
 
       # Indicates, that this node has failed
@@ -127,7 +127,7 @@ module Karafka
       #   have complex health-checking with reporting.
       # @note Child API
       # @note We convert this to string to normalize the API
-      def unhealthy(reason_code = '1')
+      def unhealthy(reason_code = "1")
         write(reason_code.to_s)
       end
 
@@ -192,19 +192,19 @@ module Karafka
       # Sends sigterm to the node
       # @note Parent API
       def stop
-        signal('TERM')
+        signal("TERM")
       end
 
       # Sends sigtstp to the node
       # @note Parent API
       def quiet
-        signal('TSTP')
+        signal("TSTP")
       end
 
       # Terminates node
       # @note Parent API
       def terminate
-        signal('KILL')
+        signal("KILL")
       end
 
       # Sends provided signal to the node

data/lib/karafka/swarm/supervisor.rb

@@ -66,7 +66,7 @@ module Karafka
         process.on_sigquit { stop }
         process.on_sigterm { stop }
         process.on_sigtstp { quiet }
-        process.on_sigttin { signal('TTIN') }
+        process.on_sigttin { signal("TTIN") }
         # Needed to be registered as we want to unlock on child changes
         process.on_sigchld { nil }
         process.on_any_active { unlock }
@@ -87,13 +87,13 @@ module Karafka
       # If anything went wrong during supervision, signal this and die
       # Supervisor is meant to be thin and not cause any issues. If you encounter this case
       # please report it as it should be considered critical
-      rescue StandardError => e
+      rescue => e
         monitor.instrument(
-          'error.occurred',
+          "error.occurred",
           caller: self,
           error: e,
           manager: manager,
-          type: 'swarm.supervisor.error'
+          type: "swarm.supervisor.error"
         )
 
         manager.terminate
@@ -148,11 +148,11 @@ module Karafka
         raise Errors::ForcefulShutdownError
       rescue Errors::ForcefulShutdownError => e
         monitor.instrument(
-          'error.occurred',
+          "error.occurred",
           caller: self,
           error: e,
           manager: manager,
-          type: 'app.stopping.error'
+          type: "app.stopping.error"
         )
 
         # Run forceful kill

data/lib/karafka/swarm.rb

@@ -14,7 +14,7 @@ module Karafka
 
         raise(
           Errors::UnsupportedOptionError,
-          'Swarm mode not supported on this platform'
+          "Swarm mode not supported on this platform"
         )
       end
 

data/lib/karafka/time_trackers/pause.rb

@@ -115,7 +115,7 @@ module Karafka
 
         timeout = backoff_factor * @timeout
 
-        @max_timeout && timeout > @max_timeout ? @max_timeout : timeout
+        (@max_timeout && timeout > @max_timeout) ? @max_timeout : timeout
       end
     end
   end

data/lib/karafka/version.rb

@@ -3,5 +3,5 @@
 # Main module namespace
 module Karafka
   # Current Karafka version
-  VERSION = '2.5.4'
+  VERSION = "2.5.6"
 end

data/lib/karafka.rb

@@ -1,21 +1,21 @@
 # frozen_string_literal: true
 
-require 'karafka-core'
-require 'delegate'
-require 'English'
-require 'rdkafka'
-require 'waterdrop'
-require 'json'
-require 'forwardable'
-require 'fileutils'
-require 'openssl'
-require 'optparse'
-require 'socket'
-require 'date'
-require 'singleton'
-require 'digest'
-require 'zeitwerk'
-require 'logger'
+require "karafka-core"
+require "delegate"
+require "English"
+require "rdkafka"
+require "waterdrop"
+require "json"
+require "forwardable"
+require "fileutils"
+require "openssl"
+require "optparse"
+require "socket"
+require "date"
+require "singleton"
+require "digest"
+require "zeitwerk"
+require "logger"
 
 # Karafka framework main namespace
 module Karafka
@@ -50,7 +50,7 @@ module Karafka
 
     # @return [Pathname] root path of this gem
     def gem_root
-      Pathname.new(File.expand_path('..', __dir__))
+      Pathname.new(File.expand_path("..", __dir__))
     end
 
     # @return [Pathname] Karafka app root path (user application path)
@@ -58,26 +58,26 @@ module Karafka
       return @root if @root
 
       # If user points to a different root explicitly, use it
-      if ENV['KARAFKA_ROOT_DIR']
-        @root = Pathname.new(ENV['KARAFKA_ROOT_DIR'])
+      if ENV["KARAFKA_ROOT_DIR"]
+        @root = Pathname.new(ENV["KARAFKA_ROOT_DIR"])
 
         return @root
       end
 
-      if defined?(::Bundler)
+      @root = if defined?(::Bundler)
         # By default we infer the project root from bundler.
         # We cannot use the BUNDLE_GEMFILE env directly because it may be altered by things like
         # ruby-lsp. Instead we always fallback to the most outer Gemfile. In most of the cases, it
         # won't matter but in case of some automatic setup alterations like ruby-lsp, the location
         # from which the project starts may not match the original Gemfile.
-        @root = Pathname.new(
+        Pathname.new(
           File.dirname(
             Bundler.with_unbundled_env { Bundler.default_gemfile }
           )
         )
       else
         # Fallback when Bundler is not available: use current directory
-        @root = Pathname.new(Dir.pwd)
+        Pathname.new(Dir.pwd)
       end
 
       @root
@@ -85,7 +85,7 @@ module Karafka
 
     # @return [Pathname] path to Karafka gem root core
     def core_root
-      Pathname.new(File.expand_path('karafka', __dir__))
+      Pathname.new(File.expand_path("karafka", __dir__))
     end
 
     # @return [Boolean] true if there is a valid pro token present
@@ -102,16 +102,16 @@ module Karafka
     def rails?
       return @rails if instance_variable_defined?(:@rails)
 
-      @rails = Object.const_defined?('Rails::Railtie')
+      @rails = Object.const_defined?("Rails::Railtie")
 
       # If Rails exists we set it immediately based on its presence and return
       return @rails if @rails
 
       # If rails is not present and user wants us not to force-load it, we return
-      return @rails if ENV['KARAFKA_REQUIRE_RAILS'] == 'false'
+      return @rails if ENV["KARAFKA_REQUIRE_RAILS"] == "false"
 
       # If we should try to require it, we try and if no error, it means its there
-      require('rails')
+      require("rails")
 
       @rails = true
     rescue LoadError
@@ -128,10 +128,10 @@ module Karafka
     #   KARAFKA_BOOT_FILE='/home/app_path/app.rb'
     #   Karafka.boot_file #=> '/home/app_path/app.rb'
     def boot_file
-      boot_file = Pathname.new(ENV['KARAFKA_BOOT_FILE'] || File.join(Karafka.root, 'karafka.rb'))
+      boot_file = Pathname.new(ENV["KARAFKA_BOOT_FILE"] || File.join(Karafka.root, "karafka.rb"))
 
       return boot_file if boot_file.absolute?
-      return boot_file if boot_file.to_s == 'false'
+      return boot_file if boot_file.to_s == "false"
 
       Pathname.new(
         File.expand_path(
@@ -158,19 +158,19 @@ end
 
 loader = Zeitwerk::Loader.for_gem
 # Do not load Rails extensions by default, this will be handled by Railtie if they are needed
-loader.ignore(Karafka.gem_root.join('lib/active_job'))
+loader.ignore(Karafka.gem_root.join("lib/active_job"))
 # Do not load CurrentAttributes components as they will be loaded if needed
 # @note We have to exclude both the .rb file as well as the whole directory so users can require
 # current attributes only when needed
-loader.ignore(Karafka.gem_root.join('lib/karafka/active_job/current_attributes'))
-loader.ignore(Karafka.gem_root.join('lib/karafka/active_job/current_attributes.rb'))
+loader.ignore(Karafka.gem_root.join("lib/karafka/active_job/current_attributes"))
+loader.ignore(Karafka.gem_root.join("lib/karafka/active_job/current_attributes.rb"))
 # Do not load Railtie. It will load if after everything is ready, so we don't have to load any
 # Karafka components when we require this railtie. Railtie needs to be loaded last.
-loader.ignore(Karafka.gem_root.join('lib/karafka/railtie'))
+loader.ignore(Karafka.gem_root.join("lib/karafka/railtie"))
 # Do not load pro components as they will be loaded if needed and allowed
-loader.ignore(Karafka.core_root.join('pro/'))
+loader.ignore(Karafka.core_root.join("pro/"))
 # Do not load vendors instrumentation components. Those need to be required manually if needed
-loader.ignore(Karafka.core_root.join('instrumentation/vendors'))
+loader.ignore(Karafka.core_root.join("instrumentation/vendors"))
 loader.setup
 loader.eager_load
 
@@ -182,12 +182,12 @@ Karafka::Routing::Features::Base.load_all
 # to make pro components available in case anyone wants to use them as a base to their own
 # custom components. Otherwise inheritance would not work.
 Karafka::Licenser.detect do
-  require 'karafka/pro/loader'
+  require "karafka/pro/loader"
 
   Karafka::Pro::Loader.require_all
 end
 
 # Load railtie after everything else is ready so we know we can rely on it.
-require 'karafka/railtie'
+require "karafka/railtie"
 
 Karafka::Constraints.verify!

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karafka
 version: !ruby/object:Gem::Version
-  version: 2.5.4
+  version: 2.5.6
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -35,14 +35,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.23.1
+        version: 0.24.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.23.1
+        version: 0.24.0
 - !ruby/object:Gem::Dependency
   name: waterdrop
   requirement: !ruby/object:Gem::Requirement
@@ -95,6 +95,7 @@ files:
 - LICENSE-LGPL
 - README.md
 - bin/karafka
+- certs/expired.txt
 - certs/karafka-pro.pem
 - config/locales/errors.yml
 - config/locales/pro_errors.yml
@@ -216,6 +217,8 @@ files:
 - lib/karafka/pro/cli/parallel_segments/base.rb
 - lib/karafka/pro/cli/parallel_segments/collapse.rb
 - lib/karafka/pro/cli/parallel_segments/distribute.rb
+- lib/karafka/pro/cli/topics.rb
+- lib/karafka/pro/cli/topics/health.rb
 - lib/karafka/pro/connection/manager.rb
 - lib/karafka/pro/connection/multiplexing/listener.rb
 - lib/karafka/pro/contracts/base.rb
@@ -573,7 +576,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.3
 specification_version: 4
 summary: Karafka is Ruby and Rails efficient Kafka processing framework.
 test_files: []