karafka 2.1.13 → 2.2.0

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karafka
 version: !ruby/object:Gem::Version
-  version: 2.1.13
+  version: 2.2.0
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -35,7 +35,7 @@ cert_chain:
   AnG1dJU+yL2BK7vaVytLTstJME5mepSZ46qqIJXMuWob/YPDmVaBF39TDSG9e34s
   msG3BiCqgOgHAnL23+CN3Rt8MsuRfEtoTKpJVcCfoEoNHOkc
   -----END CERTIFICATE-----
-date: 2023-08-28 00:00:00.000000000 Z
+date: 2023-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: karafka-core
@@ -224,6 +224,8 @@ files:
 - lib/karafka/pro/cleaner/errors.rb
 - lib/karafka/pro/cleaner/messages/message.rb
 - lib/karafka/pro/cleaner/messages/messages.rb
+- lib/karafka/pro/contracts/base.rb
+- lib/karafka/pro/contracts/server_cli_options.rb
 - lib/karafka/pro/encryption.rb
 - lib/karafka/pro/encryption/cipher.rb
 - lib/karafka/pro/encryption/contracts/config.rb
@@ -301,35 +303,49 @@ files:
 - lib/karafka/pro/processing/strategies/vp/default.rb
 - lib/karafka/pro/processing/strategy_selector.rb
 - lib/karafka/pro/processing/virtual_offset_manager.rb
+- lib/karafka/pro/routing/features/active_job.rb
+- lib/karafka/pro/routing/features/active_job/builder.rb
 - lib/karafka/pro/routing/features/base.rb
 - lib/karafka/pro/routing/features/dead_letter_queue.rb
-- lib/karafka/pro/routing/features/dead_letter_queue/contract.rb
+- lib/karafka/pro/routing/features/dead_letter_queue/contracts/topic.rb
 - lib/karafka/pro/routing/features/delaying.rb
 - lib/karafka/pro/routing/features/delaying/config.rb
-- lib/karafka/pro/routing/features/delaying/contract.rb
+- lib/karafka/pro/routing/features/delaying/contracts/topic.rb
 - lib/karafka/pro/routing/features/delaying/topic.rb
 - lib/karafka/pro/routing/features/expiring.rb
 - lib/karafka/pro/routing/features/expiring/config.rb
-- lib/karafka/pro/routing/features/expiring/contract.rb
+- lib/karafka/pro/routing/features/expiring/contracts/topic.rb
 - lib/karafka/pro/routing/features/expiring/topic.rb
 - lib/karafka/pro/routing/features/filtering.rb
 - lib/karafka/pro/routing/features/filtering/config.rb
-- lib/karafka/pro/routing/features/filtering/contract.rb
+- lib/karafka/pro/routing/features/filtering/contracts/topic.rb
 - lib/karafka/pro/routing/features/filtering/topic.rb
 - lib/karafka/pro/routing/features/long_running_job.rb
 - lib/karafka/pro/routing/features/long_running_job/config.rb
-- lib/karafka/pro/routing/features/long_running_job/contract.rb
+- lib/karafka/pro/routing/features/long_running_job/contracts/topic.rb
 - lib/karafka/pro/routing/features/long_running_job/topic.rb
+- lib/karafka/pro/routing/features/patterns.rb
+- lib/karafka/pro/routing/features/patterns/builder.rb
+- lib/karafka/pro/routing/features/patterns/config.rb
+- lib/karafka/pro/routing/features/patterns/consumer_group.rb
+- lib/karafka/pro/routing/features/patterns/contracts/consumer_group.rb
+- lib/karafka/pro/routing/features/patterns/contracts/pattern.rb
+- lib/karafka/pro/routing/features/patterns/contracts/topic.rb
+- lib/karafka/pro/routing/features/patterns/detector.rb
+- lib/karafka/pro/routing/features/patterns/pattern.rb
+- lib/karafka/pro/routing/features/patterns/patterns.rb
+- lib/karafka/pro/routing/features/patterns/topic.rb
+- lib/karafka/pro/routing/features/patterns/topics.rb
 - lib/karafka/pro/routing/features/pausing.rb
-- lib/karafka/pro/routing/features/pausing/contract.rb
+- lib/karafka/pro/routing/features/pausing/contracts/topic.rb
 - lib/karafka/pro/routing/features/pausing/topic.rb
 - lib/karafka/pro/routing/features/throttling.rb
 - lib/karafka/pro/routing/features/throttling/config.rb
-- lib/karafka/pro/routing/features/throttling/contract.rb
+- lib/karafka/pro/routing/features/throttling/contracts/topic.rb
 - lib/karafka/pro/routing/features/throttling/topic.rb
 - lib/karafka/pro/routing/features/virtual_partitions.rb
 - lib/karafka/pro/routing/features/virtual_partitions/config.rb
-- lib/karafka/pro/routing/features/virtual_partitions/contract.rb
+- lib/karafka/pro/routing/features/virtual_partitions/contracts/topic.rb
 - lib/karafka/pro/routing/features/virtual_partitions/topic.rb
 - lib/karafka/process.rb
 - lib/karafka/processing/coordinator.rb
@@ -364,21 +380,22 @@ files:
 - lib/karafka/routing/features/active_job.rb
 - lib/karafka/routing/features/active_job/builder.rb
 - lib/karafka/routing/features/active_job/config.rb
-- lib/karafka/routing/features/active_job/contract.rb
+- lib/karafka/routing/features/active_job/contracts/topic.rb
+- lib/karafka/routing/features/active_job/proxy.rb
 - lib/karafka/routing/features/active_job/topic.rb
 - lib/karafka/routing/features/base.rb
 - lib/karafka/routing/features/base/expander.rb
 - lib/karafka/routing/features/dead_letter_queue.rb
 - lib/karafka/routing/features/dead_letter_queue/config.rb
-- lib/karafka/routing/features/dead_letter_queue/contract.rb
+- lib/karafka/routing/features/dead_letter_queue/contracts/topic.rb
 - lib/karafka/routing/features/dead_letter_queue/topic.rb
 - lib/karafka/routing/features/declaratives.rb
 - lib/karafka/routing/features/declaratives/config.rb
-- lib/karafka/routing/features/declaratives/contract.rb
+- lib/karafka/routing/features/declaratives/contracts/topic.rb
 - lib/karafka/routing/features/declaratives/topic.rb
 - lib/karafka/routing/features/manual_offset_management.rb
 - lib/karafka/routing/features/manual_offset_management/config.rb
-- lib/karafka/routing/features/manual_offset_management/contract.rb
+- lib/karafka/routing/features/manual_offset_management/contracts/topic.rb
 - lib/karafka/routing/features/manual_offset_management/topic.rb
 - lib/karafka/routing/proxy.rb
 - lib/karafka/routing/router.rb
@@ -429,7 +446,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.4.19
 signing_key: 
 specification_version: 4
 summary: Karafka is Ruby and Rails efficient Kafka processing framework.

data/lib/karafka/pro/routing/features/dead_letter_queue/contract.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-# This Karafka component is a Pro component under a commercial license.
-# This Karafka component is NOT licensed under LGPL.
-#
-# All of the commercial components are present in the lib/karafka/pro directory of this
-# repository and their usage requires commercial license agreement.
-#
-# Karafka has also commercial-friendly license, commercial support and commercial components.
-#
-# By sending a pull request to the pro components, you are agreeing to transfer the copyright of
-# your code to Maciej Mensfeld.
-
-module Karafka
-  module Pro
-    module Routing
-      module Features
-        class DeadLetterQueue < Base
-          # Extended rules for dead letter queue settings
-          class Contract < Contracts::Base
-            configure do |config|
-              config.error_messages = YAML.safe_load(
-                File.read(
-                  File.join(Karafka.gem_root, 'config', 'locales', 'pro_errors.yml')
-                )
-              ).fetch('en').fetch('validations').fetch('topic')
-            end
-
-            # Make sure that when we use virtual partitions with DLQ, at least one retry is set
-            # We cannot use VP with DLQ without retries as we in order to provide ordering
-            # warranties on errors with VP, we need to collapse the VPs concurrency and retry
-            # without any indeterministic work
-            virtual do |data, errors|
-              next unless errors.empty?
-
-              dead_letter_queue = data[:dead_letter_queue]
-              virtual_partitions = data[:virtual_partitions]
-
-              next unless dead_letter_queue[:active]
-              next unless virtual_partitions[:active]
-              next if dead_letter_queue[:max_retries].positive?
-
-              [[%i[dead_letter_queue], :with_virtual_partitions]]
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/karafka/pro/routing/features/expiring/contract.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-# This Karafka component is a Pro component under a commercial license.
-# This Karafka component is NOT licensed under LGPL.
-#
-# All of the commercial components are present in the lib/karafka/pro directory of this
-# repository and their usage requires commercial license agreement.
-#
-# Karafka has also commercial-friendly license, commercial support and commercial components.
-#
-# By sending a pull request to the pro components, you are agreeing to transfer the copyright of
-# your code to Maciej Mensfeld.
-
-module Karafka
-  module Pro
-    module Routing
-      module Features
-        class Expiring < Base
-          # Contract to validate configuration of the expiring feature
-          class Contract < Contracts::Base
-            configure do |config|
-              config.error_messages = YAML.safe_load(
-                File.read(
-                  File.join(Karafka.gem_root, 'config', 'locales', 'pro_errors.yml')
-                )
-              ).fetch('en').fetch('validations').fetch('topic')
-            end
-
-            nested(:expiring) do
-              required(:active) { |val| [true, false].include?(val) }
-              required(:ttl) { |val| val.nil? || (val.is_a?(Integer) && val.positive?) }
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/karafka/pro/routing/features/pausing/contract.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-# This Karafka component is a Pro component under a commercial license.
-# This Karafka component is NOT licensed under LGPL.
-#
-# All of the commercial components are present in the lib/karafka/pro directory of this
-# repository and their usage requires commercial license agreement.
-#
-# Karafka has also commercial-friendly license, commercial support and commercial components.
-#
-# By sending a pull request to the pro components, you are agreeing to transfer the copyright of
-# your code to Maciej Mensfeld.
-
-module Karafka
-  module Pro
-    module Routing
-      module Features
-        class Pausing < Base
-          # Contract to make sure, that the pause settings on a per topic basis are as expected
-          class Contract < Contracts::Base
-            configure do |config|
-              config.error_messages = YAML.safe_load(
-                File.read(
-                  File.join(Karafka.gem_root, 'config', 'locales', 'pro_errors.yml')
-                )
-              ).fetch('en').fetch('validations').fetch('topic')
-
-              required(:pause_timeout) { |val| val.is_a?(Integer) && val.positive? }
-              required(:pause_max_timeout) { |val| val.is_a?(Integer) && val.positive? }
-              required(:pause_with_exponential_backoff) { |val| [true, false].include?(val) }
-
-              virtual do |data, errors|
-                next unless errors.empty?
-
-                pause_timeout = data.fetch(:pause_timeout)
-                pause_max_timeout = data.fetch(:pause_max_timeout)
-
-                next if pause_timeout <= pause_max_timeout
-
-                [[%i[pause_timeout], :max_timeout_vs_pause_max_timeout]]
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/karafka/pro/routing/features/throttling/contract.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-# This Karafka component is a Pro component under a commercial license.
-# This Karafka component is NOT licensed under LGPL.
-#
-# All of the commercial components are present in the lib/karafka/pro directory of this
-# repository and their usage requires commercial license agreement.
-#
-# Karafka has also commercial-friendly license, commercial support and commercial components.
-#
-# By sending a pull request to the pro components, you are agreeing to transfer the copyright of
-# your code to Maciej Mensfeld.
-
-module Karafka
-  module Pro
-    module Routing
-      module Features
-        class Throttling < Base
-          # Rules around throttling settings
-          class Contract < Contracts::Base
-            configure do |config|
-              config.error_messages = YAML.safe_load(
-                File.read(
-                  File.join(Karafka.gem_root, 'config', 'locales', 'pro_errors.yml')
-                )
-              ).fetch('en').fetch('validations').fetch('topic')
-            end
-
-            nested(:throttling) do
-              required(:active) { |val| [true, false].include?(val) }
-              required(:interval) { |val| val.is_a?(Integer) && val.positive? }
-              required(:limit) do |val|
-                (val.is_a?(Integer) || val == Float::INFINITY) && val.positive?
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/karafka/pro/routing/features/virtual_partitions/contract.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-# This Karafka component is a Pro component under a commercial license.
-# This Karafka component is NOT licensed under LGPL.
-#
-# All of the commercial components are present in the lib/karafka/pro directory of this
-# repository and their usage requires commercial license agreement.
-#
-# Karafka has also commercial-friendly license, commercial support and commercial components.
-#
-# By sending a pull request to the pro components, you are agreeing to transfer the copyright of
-# your code to Maciej Mensfeld.
-
-module Karafka
-  module Pro
-    module Routing
-      module Features
-        class VirtualPartitions < Base
-          # Rules around virtual partitions
-          class Contract < Contracts::Base
-            configure do |config|
-              config.error_messages = YAML.safe_load(
-                File.read(
-                  File.join(Karafka.gem_root, 'config', 'locales', 'pro_errors.yml')
-                )
-              ).fetch('en').fetch('validations').fetch('topic')
-            end
-
-            nested(:virtual_partitions) do
-              required(:active) { |val| [true, false].include?(val) }
-              required(:partitioner) { |val| val.nil? || val.respond_to?(:call) }
-              required(:max_partitions) { |val| val.is_a?(Integer) && val >= 1 }
-            end
-
-            # When virtual partitions are defined, partitioner needs to respond to `#call` and it
-            # cannot be nil
-            virtual do |data, errors|
-              next unless errors.empty?
-
-              virtual_partitions = data[:virtual_partitions]
-
-              next unless virtual_partitions[:active]
-              next if virtual_partitions[:partitioner].respond_to?(:call)
-
-              [[%i[virtual_partitions partitioner], :respond_to_call]]
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/karafka/routing/features/active_job/contract.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module Karafka
-  module Routing
-    module Features
-      class ActiveJob < Base
-        # Rules around using ActiveJob routing - basically you need to have ActiveJob available
-        # in order to be able to use active job routing
-        class Contract < Contracts::Base
-          configure do |config|
-            config.error_messages = YAML.safe_load(
-              File.read(
-                File.join(Karafka.gem_root, 'config', 'locales', 'errors.yml')
-              )
-            ).fetch('en').fetch('validations').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')
-
-            [[%i[consumer], :active_job_missing]]
-          end
-
-          # ActiveJob needs to always run with manual offset management
-          # Automatic offset management cannot work with ActiveJob. Otherwise we could mark as
-          # consumed jobs that did not run because of shutdown.
-          virtual do |data, errors|
-            next unless errors.empty?
-            next unless data[:active_job][:active]
-            next if data[:manual_offset_management][:active]
-
-            [[%i[manual_offset_management], :must_be_enabled]]
-          end
-        end
-      end
-    end
-  end
-end

data/lib/karafka/routing/features/dead_letter_queue/contract.rb

@@ -1,42 +0,0 @@
-# frozen_string_literal: true
-
-module Karafka
-  module Routing
-    module Features
-      class DeadLetterQueue < Base
-        # Rules around dead letter queue settings
-        class Contract < Contracts::Base
-          configure do |config|
-            config.error_messages = YAML.safe_load(
-              File.read(
-                File.join(Karafka.gem_root, 'config', 'locales', 'errors.yml')
-              )
-            ).fetch('en').fetch('validations').fetch('topic')
-          end
-
-          nested :dead_letter_queue do
-            required(:active) { |val| [true, false].include?(val) }
-            required(:max_retries) { |val| val.is_a?(Integer) && val >= 0 }
-          end
-
-          # Validate topic name only if dlq is active
-          virtual do |data, errors|
-            next unless errors.empty?
-
-            dead_letter_queue = data[:dead_letter_queue]
-
-            next unless dead_letter_queue[:active]
-
-            topic = dead_letter_queue[:topic]
-
-            # When topic is set to false, it means we just want to skip dispatch on DLQ
-            next if topic == false
-            next if topic.is_a?(String) && Contracts::TOPIC_REGEXP.match?(topic)
-
-            [[%i[dead_letter_queue topic], :format]]
-          end
-        end
-      end
-    end
-  end
-end

data/lib/karafka/routing/features/declaratives/contract.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Karafka
-  module Routing
-    module Features
-      class Declaratives < Base
-        # Basic validation of the Kafka expected config details
-        class Contract < Contracts::Base
-          configure do |config|
-            config.error_messages = YAML.safe_load(
-              File.read(
-                File.join(Karafka.gem_root, 'config', 'locales', 'errors.yml')
-              )
-            ).fetch('en').fetch('validations').fetch('topic')
-          end
-
-          nested :declaratives do
-            required(:active) { |val| [true, false].include?(val) }
-            required(:partitions) { |val| val.is_a?(Integer) && val.positive? }
-            required(:replication_factor) { |val| val.is_a?(Integer) && val.positive? }
-            required(:details) do |val|
-              val.is_a?(Hash) &&
-                val.keys.all? { |key| key.is_a?(Symbol) }
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/karafka/routing/features/manual_offset_management/contract.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-module Karafka
-  module Routing
-    module Features
-      class ManualOffsetManagement < Base
-        # Rules around manual offset management settings
-        class Contract < Contracts::Base
-          configure do |config|
-            config.error_messages = YAML.safe_load(
-              File.read(
-                File.join(Karafka.gem_root, 'config', 'locales', 'errors.yml')
-              )
-            ).fetch('en').fetch('validations').fetch('topic')
-          end
-
-          nested :manual_offset_management do
-            required(:active) { |val| [true, false].include?(val) }
-          end
-        end
-      end
-    end
-  end
-end