karafka-web 0.11.5 → 0.11.6

data/lib/karafka/web/pro/commanding/commands/partitions/seek.rb

@@ -1,7 +1,24 @@
 # frozen_string_literal: true
 
-# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
-# See LICENSE for details.
+# Karafka Pro - Source Available Commercial Software
+# Copyright (c) 2017-present Maciej Mensfeld. All rights reserved.
+#
+# This software is NOT open source. It is source-available commercial software
+# requiring a paid license for use. It is NOT covered by LGPL.
+#
+# PROHIBITED:
+# - Use without a valid commercial license
+# - Redistribution, modification, or derivative works without authorization
+# - Use as training data for AI/ML models or inclusion in datasets
+# - Scraping, crawling, or automated collection for any purpose
+#
+# PERMITTED:
+# - Reading, referencing, and linking for personal or commercial use
+# - Runtime retrieval by AI assistants, coding agents, and RAG systems
+#   for the purpose of providing contextual help to Karafka users
+#
+# License: https://karafka.io/docs/Pro-License-Comm/
+# Contact: contact@karafka.io
 
 module Karafka
   module Web
@@ -11,7 +28,7 @@ module Karafka
           module Partitions
             # Topic partition seek command request handler
             class Seek < Base
-              self.name = 'partitions.seek'
+              self.name = "partitions.seek"
 
               # Dispatches the seek request into the appropriate filter and indicates that the
               # seeking is in an acceptance state

data/lib/karafka/web/pro/commanding/commands/topics/pause.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# Karafka Pro - Source Available Commercial Software
+# Copyright (c) 2017-present Maciej Mensfeld. All rights reserved.
+#
+# This software is NOT open source. It is source-available commercial software
+# requiring a paid license for use. It is NOT covered by LGPL.
+#
+# PROHIBITED:
+# - Use without a valid commercial license
+# - Redistribution, modification, or derivative works without authorization
+# - Use as training data for AI/ML models or inclusion in datasets
+# - Scraping, crawling, or automated collection for any purpose
+#
+# PERMITTED:
+# - Reading, referencing, and linking for personal or commercial use
+# - Runtime retrieval by AI assistants, coding agents, and RAG systems
+#   for the purpose of providing contextual help to Karafka users
+#
+# License: https://karafka.io/docs/Pro-License-Comm/
+# Contact: contact@karafka.io
+
+module Karafka
+  module Web
+    module Pro
+      module Commanding
+        module Commands
+          # Namespace for topic-level command execution within a consumer group context
+          module Topics
+            # Delegates the topic pause request into the topic changes tracker and dispatches the
+            # acceptance message back to Kafka. This command pauses all partitions of a given topic
+            # within a specific consumer group. Matchers filter which processes handle the command.
+            class Pause < Base
+              self.name = "topics.pause"
+
+              # Delegates the pause request to async handling
+              def call
+                Handlers::Topics::Tracker.instance << command
+
+                acceptance(command.to_h)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/karafka/web/pro/commanding/commands/topics/resume.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# Karafka Pro - Source Available Commercial Software
+# Copyright (c) 2017-present Maciej Mensfeld. All rights reserved.
+#
+# This software is NOT open source. It is source-available commercial software
+# requiring a paid license for use. It is NOT covered by LGPL.
+#
+# PROHIBITED:
+# - Use without a valid commercial license
+# - Redistribution, modification, or derivative works without authorization
+# - Use as training data for AI/ML models or inclusion in datasets
+# - Scraping, crawling, or automated collection for any purpose
+#
+# PERMITTED:
+# - Reading, referencing, and linking for personal or commercial use
+# - Runtime retrieval by AI assistants, coding agents, and RAG systems
+#   for the purpose of providing contextual help to Karafka users
+#
+# License: https://karafka.io/docs/Pro-License-Comm/
+# Contact: contact@karafka.io
+
+module Karafka
+  module Web
+    module Pro
+      module Commanding
+        module Commands
+          module Topics
+            # Delegates the topic resume request into the topic changes tracker and dispatches the
+            # acceptance message back to Kafka. This command resumes all partitions of a given topic
+            # within a specific consumer group. Matchers filter which processes handle the command.
+            class Resume < Base
+              self.name = "topics.resume"
+
+              # Dispatches the resume request into the appropriate handler and indicates that the
+              # resuming is in an acceptance state
+              def call
+                Handlers::Topics::Tracker.instance << command
+
+                # Publish back info on who did this with all the details for inspection
+                acceptance(command.to_h)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/karafka/web/pro/commanding/config.rb

@@ -1,7 +1,24 @@
 # frozen_string_literal: true
 
-# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
-# See LICENSE for details.
+# Karafka Pro - Source Available Commercial Software
+# Copyright (c) 2017-present Maciej Mensfeld. All rights reserved.
+#
+# This software is NOT open source. It is source-available commercial software
+# requiring a paid license for use. It is NOT covered by LGPL.
+#
+# PROHIBITED:
+# - Use without a valid commercial license
+# - Redistribution, modification, or derivative works without authorization
+# - Use as training data for AI/ML models or inclusion in datasets
+# - Scraping, crawling, or automated collection for any purpose
+#
+# PERMITTED:
+# - Reading, referencing, and linking for personal or commercial use
+# - Runtime retrieval by AI assistants, coding agents, and RAG systems
+#   for the purpose of providing contextual help to Karafka users
+#
+# License: https://karafka.io/docs/Pro-License-Comm/
+# Contact: contact@karafka.io
 
 module Karafka
   module Web
@@ -31,12 +48,13 @@ module Karafka
           # The underlying iterator requires specific settings, do not change this unless you know
           # what you area doing
           setting :kafka, default: {
-            'enable.partition.eof': false,
-            'auto.offset.reset': 'latest'
+            "enable.partition.eof": false,
+            "auto.offset.reset": "latest"
           }
 
           setting :listeners, default: [
-            Handlers::Partitions::Listener.new
+            Handlers::Partitions::Listener.new,
+            Handlers::Topics::Listener.new
           ]
 
           configure

data/lib/karafka/web/pro/commanding/contracts/config.rb

@@ -1,7 +1,24 @@
 # frozen_string_literal: true
 
-# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
-# See LICENSE for details.
+# Karafka Pro - Source Available Commercial Software
+# Copyright (c) 2017-present Maciej Mensfeld. All rights reserved.
+#
+# This software is NOT open source. It is source-available commercial software
+# requiring a paid license for use. It is NOT covered by LGPL.
+#
+# PROHIBITED:
+# - Use without a valid commercial license
+# - Redistribution, modification, or derivative works without authorization
+# - Use as training data for AI/ML models or inclusion in datasets
+# - Scraping, crawling, or automated collection for any purpose
+#
+# PERMITTED:
+# - Reading, referencing, and linking for personal or commercial use
+# - Runtime retrieval by AI assistants, coding agents, and RAG systems
+#   for the purpose of providing contextual help to Karafka users
+#
+# License: https://karafka.io/docs/Pro-License-Comm/
+# Contact: contact@karafka.io
 
 module Karafka
   module Web
@@ -13,8 +30,8 @@ module Karafka
           class Config < ::Karafka::Contracts::Base
             configure do |config|
               config.error_messages = YAML.safe_load_file(
-                File.join(Karafka::Web.gem_root, 'config', 'locales', 'pro_errors.yml')
-              ).fetch('en').fetch('validations').fetch('config')
+                File.join(Karafka::Web.gem_root, "config", "locales", "pro_errors.yml")
+              ).fetch("en").fetch("validations").fetch("config")
             end
 
             nested(:commanding) do

data/lib/karafka/web/pro/commanding/dispatcher.rb

@@ -1,7 +1,24 @@
 # frozen_string_literal: true
 
-# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
-# See LICENSE for details.
+# Karafka Pro - Source Available Commercial Software
+# Copyright (c) 2017-present Maciej Mensfeld. All rights reserved.
+#
+# This software is NOT open source. It is source-available commercial software
+# requiring a paid license for use. It is NOT covered by LGPL.
+#
+# PROHIBITED:
+# - Use without a valid commercial license
+# - Redistribution, modification, or derivative works without authorization
+# - Use as training data for AI/ML models or inclusion in datasets
+# - Scraping, crawling, or automated collection for any purpose
+#
+# PERMITTED:
+# - Reading, referencing, and linking for personal or commercial use
+# - Runtime retrieval by AI assistants, coding agents, and RAG systems
+#   for the purpose of providing contextual help to Karafka users
+#
+# License: https://karafka.io/docs/Pro-License-Comm/
+# Contact: contact@karafka.io
 
 module Karafka
   module Web
@@ -14,28 +31,27 @@ module Karafka
         # Dispatcher requires Web UI to have a producer
         class Dispatcher
           # What schema do we have in current Karafka version for commands dispatches
-          SCHEMA_VERSION = '1.1.0'
+          SCHEMA_VERSION = "1.2.0"
 
           class << self
             # Dispatches the command request
             #
-            # @param command_name [String, Symbol] name of the command we want to deal with in the process
-            # @param process_id [String] id of the process. We use name instead of id only
-            #   because in the web ui we work with the full name and it is easier. Since
+            # @param command_name [String, Symbol] name of the command we want to deal with in the
+            #   process
             # @param params [Hash] hash with extra command params that some commands may use.
-            def request(command_name, process_id, params = {})
-              produce(
-                process_id,
-                'request',
+            # @param matchers [Hash] hash with matching criteria for filtering which processes
+            #   should handle this command.
+            def request(command_name, params = {}, matchers: {})
+              produce_request(
                 {
                   schema_version: SCHEMA_VERSION,
-                  type: 'request',
+                  type: "request",
+                  # UUID to uniquely identify this command instance
+                  id: SecureRandom.uuid,
                   # Name is auto-generated and required. Should not be changed
                   command: params.merge(name: command_name),
                   dispatched_at: Time.now.to_f,
-                  process: {
-                    id: process_id
-                  }
+                  matchers: matchers
                 }
               )
             end
@@ -48,12 +64,13 @@ module Karafka
             # @param process_id [String] related process id
             # @param params [Hash] input command params (or empty hash if none)
             def acceptance(command_name, process_id, params = {})
-              produce(
+              produce_reply(
                 process_id,
-                'acceptance',
+                "acceptance",
                 {
                   schema_version: SCHEMA_VERSION,
-                  type: 'acceptance',
+                  type: "acceptance",
+                  id: SecureRandom.uuid,
                   command: params.merge(name: command_name),
                   dispatched_at: Time.now.to_f,
                   process: {
@@ -69,12 +86,13 @@ module Karafka
             # @param process_id [String] related process id
             # @param result [Object] anything that can be the result of the command execution
             def result(command_name, process_id, result)
-              produce(
+              produce_reply(
                 process_id,
-                'result',
+                "result",
                 {
                   schema_version: SCHEMA_VERSION,
-                  type: 'result',
+                  type: "result",
+                  id: SecureRandom.uuid,
                   command: {
                     name: command_name
                   },
@@ -99,20 +117,37 @@ module Karafka
               ::Karafka::Web.config.topics.consumers.commands.name
             end
 
-            # Converts payload to json, compresses it and dispatches to Kafka
+            # Produces a command request message. Request messages are broadcast to all processes
+            # and do not require a specific process_id since filtering is done via matchers.
+            #
+            # @param payload [Hash] hash with payload
+            def produce_request(payload)
+              producer.produce_async(
+                topic: commands_topic,
+                partition: 0,
+                payload: ::Zlib::Deflate.deflate(payload.to_json),
+                headers: {
+                  "zlib" => "true",
+                  "type" => "request"
+                }
+              )
+            end
+
+            # Produces a reply message (acceptance or result). Reply messages include
+            # the process_id as the Kafka key for routing and identification.
             #
-            # @param process_id [String]
-            # @param type [String] type of the request
+            # @param process_id [String] related process id
+            # @param type [String] type of the reply ('acceptance' or 'result')
             # @param payload [Hash] hash with payload
-            def produce(process_id, type, payload)
+            def produce_reply(process_id, type, payload)
               producer.produce_async(
                 topic: commands_topic,
                 key: process_id,
                 partition: 0,
                 payload: ::Zlib::Deflate.deflate(payload.to_json),
                 headers: {
-                  'zlib' => 'true',
-                  'type' => type
+                  "zlib" => "true",
+                  "type" => type
                 }
               )
             end

data/lib/karafka/web/pro/commanding/handlers/partitions/commands/base.rb

@@ -1,7 +1,24 @@
 # frozen_string_literal: true
 
-# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
-# See LICENSE for details.
+# Karafka Pro - Source Available Commercial Software
+# Copyright (c) 2017-present Maciej Mensfeld. All rights reserved.
+#
+# This software is NOT open source. It is source-available commercial software
+# requiring a paid license for use. It is NOT covered by LGPL.
+#
+# PROHIBITED:
+# - Use without a valid commercial license
+# - Redistribution, modification, or derivative works without authorization
+# - Use as training data for AI/ML models or inclusion in datasets
+# - Scraping, crawling, or automated collection for any purpose
+#
+# PERMITTED:
+# - Reading, referencing, and linking for personal or commercial use
+# - Runtime retrieval by AI assistants, coding agents, and RAG systems
+#   for the purpose of providing contextual help to Karafka users
+#
+# License: https://karafka.io/docs/Pro-License-Comm/
+# Contact: contact@karafka.io
 
 module Karafka
   module Web
@@ -26,7 +43,7 @@ module Karafka
 
                 # Runs the command
                 def call
-                  raise NotImplementedError, 'Implement in a subclass'
+                  raise NotImplementedError, "Implement in a subclass"
                 end
 
                 private

data/lib/karafka/web/pro/commanding/handlers/partitions/commands/pause.rb

@@ -1,7 +1,24 @@
 # frozen_string_literal: true
 
-# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
-# See LICENSE for details.
+# Karafka Pro - Source Available Commercial Software
+# Copyright (c) 2017-present Maciej Mensfeld. All rights reserved.
+#
+# This software is NOT open source. It is source-available commercial software
+# requiring a paid license for use. It is NOT covered by LGPL.
+#
+# PROHIBITED:
+# - Use without a valid commercial license
+# - Redistribution, modification, or derivative works without authorization
+# - Use as training data for AI/ML models or inclusion in datasets
+# - Scraping, crawling, or automated collection for any purpose
+#
+# PERMITTED:
+# - Reading, referencing, and linking for personal or commercial use
+# - Runtime retrieval by AI assistants, coding agents, and RAG systems
+#   for the purpose of providing contextual help to Karafka users
+#
+# License: https://karafka.io/docs/Pro-License-Comm/
+# Contact: contact@karafka.io
 
 module Karafka
   module Web
@@ -21,7 +38,7 @@ module Karafka
                 def call
                   # If pause is already there and we don't want to change the way it is, we skip
                   if coordinator.pause_tracker.paused? && request[:prevent_override]
-                    result('prevented')
+                    result("prevented")
 
                     return
                   end
@@ -32,7 +49,7 @@ module Karafka
                   coordinator.pause_tracker.pause(duration)
                   client.pause(topic, partition_id, nil, duration)
 
-                  result('applied')
+                  result("applied")
                 end
               end
             end

data/lib/karafka/web/pro/commanding/handlers/partitions/commands/resume.rb

@@ -1,7 +1,24 @@
 # frozen_string_literal: true
 
-# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
-# See LICENSE for details.
+# Karafka Pro - Source Available Commercial Software
+# Copyright (c) 2017-present Maciej Mensfeld. All rights reserved.
+#
+# This software is NOT open source. It is source-available commercial software
+# requiring a paid license for use. It is NOT covered by LGPL.
+#
+# PROHIBITED:
+# - Use without a valid commercial license
+# - Redistribution, modification, or derivative works without authorization
+# - Use as training data for AI/ML models or inclusion in datasets
+# - Scraping, crawling, or automated collection for any purpose
+#
+# PERMITTED:
+# - Reading, referencing, and linking for personal or commercial use
+# - Runtime retrieval by AI assistants, coding agents, and RAG systems
+#   for the purpose of providing contextual help to Karafka users
+#
+# License: https://karafka.io/docs/Pro-License-Comm/
+# Contact: contact@karafka.io
 
 module Karafka
   module Web
@@ -17,7 +34,7 @@ module Karafka
                   coordinator.pause_tracker.expire
                   coordinator.pause_tracker.reset if request[:reset_attempts]
 
-                  result('applied')
+                  result("applied")
                 end
               end
             end

data/lib/karafka/web/pro/commanding/handlers/partitions/commands/seek.rb

@@ -1,7 +1,24 @@
 # frozen_string_literal: true
 
-# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
-# See LICENSE for details.
+# Karafka Pro - Source Available Commercial Software
+# Copyright (c) 2017-present Maciej Mensfeld. All rights reserved.
+#
+# This software is NOT open source. It is source-available commercial software
+# requiring a paid license for use. It is NOT covered by LGPL.
+#
+# PROHIBITED:
+# - Use without a valid commercial license
+# - Redistribution, modification, or derivative works without authorization
+# - Use as training data for AI/ML models or inclusion in datasets
+# - Scraping, crawling, or automated collection for any purpose
+#
+# PERMITTED:
+# - Reading, referencing, and linking for personal or commercial use
+# - Runtime retrieval by AI assistants, coding agents, and RAG systems
+#   for the purpose of providing contextual help to Karafka users
+#
+# License: https://karafka.io/docs/Pro-License-Comm/
+# Contact: contact@karafka.io
 
 module Karafka
   module Web
@@ -18,9 +35,9 @@ module Karafka
                   # If user enabled overtaking prevention and we're already ahead of the requested
                   # offset, we should ditch such a request
                   if prevent_overtaking? &&
-                     coordinator.seek_offset &&
-                     coordinator.seek_offset >= desired_offset
-                    result('prevented')
+                      coordinator.seek_offset &&
+                      coordinator.seek_offset >= desired_offset
+                    result("prevented")
 
                     return
                   end
@@ -35,7 +52,7 @@ module Karafka
                   # If we were not able to mark as consumed it means that the assignment was lost
                   # We should signal this and stop
                   unless assigned
-                    result('lost_partition')
+                    result("lost_partition")
 
                     return
                   end
@@ -50,7 +67,7 @@ module Karafka
                   # can reset it so the work starts immediately.
                   coordinator.pause_tracker.expire if force_resume?
 
-                  result('applied')
+                  result("applied")
                 end
 
                 private

data/lib/karafka/web/pro/commanding/handlers/partitions/executor.rb

@@ -1,7 +1,24 @@
 # frozen_string_literal: true
 
-# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
-# See LICENSE for details.
+# Karafka Pro - Source Available Commercial Software
+# Copyright (c) 2017-present Maciej Mensfeld. All rights reserved.
+#
+# This software is NOT open source. It is source-available commercial software
+# requiring a paid license for use. It is NOT covered by LGPL.
+#
+# PROHIBITED:
+# - Use without a valid commercial license
+# - Redistribution, modification, or derivative works without authorization
+# - Use as training data for AI/ML models or inclusion in datasets
+# - Scraping, crawling, or automated collection for any purpose
+#
+# PERMITTED:
+# - Reading, referencing, and linking for personal or commercial use
+# - Runtime retrieval by AI assistants, coding agents, and RAG systems
+#   for the purpose of providing contextual help to Karafka users
+#
+# License: https://karafka.io/docs/Pro-License-Comm/
+# Contact: contact@karafka.io
 
 module Karafka
   module Web
@@ -19,15 +36,15 @@ module Karafka
               # @param request [Request]
               def call(listener, client, request)
                 command = case request.name
-                          when Commanding::Commands::Partitions::Resume.name
-                            Commands::Resume
-                          when Commanding::Commands::Partitions::Pause.name
-                            Commands::Pause
-                          when Commanding::Commands::Partitions::Seek.name
-                            Commands::Seek
-                          else
-                            raise ::Karafka::Errors::UnsupportedCaseError, request.name
-                          end
+                when Commanding::Commands::Partitions::Resume.name
+                  Commands::Resume
+                when Commanding::Commands::Partitions::Pause.name
+                  Commands::Pause
+                when Commanding::Commands::Partitions::Seek.name
+                  Commands::Seek
+                else
+                  raise ::Karafka::Errors::UnsupportedCaseError, request.name
+                end
 
                 command.new(
                   listener,
@@ -44,9 +61,16 @@ module Karafka
                 Dispatcher.result(
                   request.name,
                   process_id,
-                  request.to_h.merge(status: 'rebalance_rejected')
+                  request.to_h.merge(status: "rebalance_rejected")
                 )
               end
+
+              private
+
+              # @return [String] id of the current consumer process
+              def process_id
+                ::Karafka::Web.config.tracking.consumers.sampler.process_id
+              end
             end
           end
         end