karafka-web 0.11.5 → 0.11.6

data/lib/karafka/web/pro/commanding.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

data/lib/karafka/web/pro/loader.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
@@ -20,7 +37,7 @@ module Karafka
 
             loader = Zeitwerk::Loader.new
             loader.push_dir(
-              File.join(Karafka::Web.gem_root, 'lib/karafka/web/pro'),
+              File.join(Karafka::Web.gem_root, "lib/karafka/web/pro"),
               namespace: Karafka::Web::Pro
             )
 

data/lib/karafka/web/pro/ui/app.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,17 +28,17 @@ module Karafka
       module Ui
         # Main Roda Web App that servers all the metrics and stats
         class App < Web::Ui::Base
-          opts[:root] = Karafka::Web.gem_root.join('lib/karafka/web/pro/ui')
+          opts[:root] = Karafka::Web.gem_root.join("lib/karafka/web/pro/ui")
 
           instance_exec(&CONTEXT_DETAILS)
 
-          plugin :render, escape: true, engine: 'erb', allowed_paths: [
-            Karafka::Web.gem_root.join('lib/karafka/web/pro/ui/views'),
-            Karafka::Web.gem_root.join('lib/karafka/web/ui/views')
+          plugin :render, escape: true, engine: "erb", allowed_paths: [
+            Karafka::Web.gem_root.join("lib/karafka/web/pro/ui/views"),
+            Karafka::Web.gem_root.join("lib/karafka/web/ui/views")
           ]
 
           plugin :additional_view_directories, [
-            Karafka::Web.gem_root.join('lib/karafka/web/ui/views')
+            Karafka::Web.gem_root.join("lib/karafka/web/ui/views")
           ]
 
           before do
@@ -61,7 +78,7 @@ module Karafka
           private_constant :SUB_ROUTES
 
           route do |r|
-            r.root { r.redirect root_path('dashboard') }
+            r.root { r.redirect root_path("dashboard") }
 
             SUB_ROUTES.each { |sub_route| sub_route.bind(self, r) }
 

data/lib/karafka/web/pro/ui/controllers/base_controller.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

data/lib/karafka/web/pro/ui/controllers/cluster_controller.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

data/lib/karafka/web/pro/ui/controllers/consumers/base_controller.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

data/lib/karafka/web/pro/ui/controllers/consumers/commanding_controller.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
@@ -67,10 +84,7 @@ module Karafka
               def quiet_all
                 features.commanding!
 
-                request(
-                  Commanding::Commands::Consumers::Quiet,
-                  '*'
-                )
+                broadcast_request(Commanding::Commands::Consumers::Quiet)
 
                 redirect(
                   :back,
@@ -82,10 +96,7 @@ module Karafka
               def stop_all
                 features.commanding!
 
-                request(
-                  Commanding::Commands::Consumers::Stop,
-                  '*'
-                )
+                broadcast_request(Commanding::Commands::Consumers::Stop)
 
                 redirect(
                   :back,
@@ -95,13 +106,24 @@ module Karafka
 
               private
 
-              # Dispatches given command
+              # Dispatches given command to a specific process
               # @param command [Class] command class
               # @param process_id [String] process id
               def request(command, process_id)
                 Commanding::Dispatcher.request(
                   command.name,
-                  process_id
+                  {},
+                  matchers: { process_id: process_id }
+                )
+              end
+
+              # Dispatches given command to all processes (no matchers)
+              # @param command [Class] command class
+              def broadcast_request(command)
+                Commanding::Dispatcher.request(
+                  command.name,
+                  {},
+                  matchers: {}
                 )
               end
 
@@ -121,7 +143,7 @@ module Karafka
                 command_name = name.to_s.capitalize
 
                 format_flash(
-                  'The ? command has been dispatched to the ? process',
+                  "The ? command has been dispatched to the ? process",
                   command_name,
                   process_id
                 )
@@ -134,9 +156,9 @@ module Karafka
                 command_name = name.to_s.capitalize
 
                 format_flash(
-                  'The ? command has been dispatched to ? active processes',
+                  "The ? command has been dispatched to ? active processes",
                   command_name,
-                  'all'
+                  "all"
                 )
               end
             end

data/lib/karafka/web/pro/ui/controllers/consumers/commands_controller.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
@@ -65,15 +82,15 @@ module Karafka
 
                 # If nothing found, lets redirect user back to the commands list
                 redirect(
-                  'commands',
-                  warning: 'No recent commands available'
+                  "commands",
+                  warning: "No recent commands available"
                 )
               end
 
               private
 
-              # @return [Array] Array with requested messages as well as pagination details and other
-              #   obtained metadata
+              # @return [Array] Array with requested messages as well as pagination details
+              #   and other obtained metadata
               def current_partition_data
                 Models::Message.offset_page(
                   commands_topic,

data/lib/karafka/web/pro/ui/controllers/consumers/consumers_controller.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

data/lib/karafka/web/pro/ui/controllers/consumers/controls_controller.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

data/lib/karafka/web/pro/ui/controllers/consumers/jobs_controller.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

data/lib/karafka/web/pro/ui/controllers/consumers/partitions/base_controller.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,64 +34,48 @@ module Karafka
                 private
 
                 # Finds all the needed details and if not found raises a not found.
-                # This prevents most cases where something would change between visiting the pages
-                # and dispatching no longer valid data.
+                # Uses the aggregated health stats data instead of process-specific data.
                 #
-                # @param process_id [String]
-                # @param subscription_group_id [String]
+                # @param consumer_group_id [String]
                 # @param topic [String]
                 # @param partition_id [Integer]
-                def bootstrap!(
-                  process_id,
-                  subscription_group_id,
-                  topic,
-                  partition_id
-                )
-                  subscriptions(process_id)
-
-                  @subscription_group_id = subscription_group_id
+                def bootstrap!(consumer_group_id, topic, partition_id)
+                  @consumer_group_id = consumer_group_id
                   @topic = topic
-                  @partition_id = partition_id
-                  @consumer_group = nil
-                  @subscription_group = nil
-                  @partition_stats = nil
-
-                  # Looks for the appropriate details about given partition and so on in the
-                  # current process data. Since we operate in the context of the given process,
-                  # it must have those details. If not it means that assignment most likely have
-                  # changed and it is no longer valid anyhow.
-                  @process.consumer_groups.each do |consumer_group|
-                    consumer_group.subscription_groups.each do |subscription_group|
-                      next unless subscription_group.id == @subscription_group_id
+                  @partition_id = partition_id.to_i
 
-                      @subscription_group = subscription_group
-                      @consumer_group = consumer_group
+                  # Get aggregated stats from all processes
+                  current_state = Models::ConsumersState.current!
+                  @stats = Models::Health.current(current_state)
 
-                      subscription_group.topics.each do |s_topic|
-                        next unless s_topic.name == @topic
+                  # Find the consumer group
+                  cg_stats = @stats[@consumer_group_id]
+                  cg_stats || raise(Karafka::Web::Errors::Ui::NotFoundError)
 
-                        s_topic.partitions.each do |partition|
-                          next unless @partition_id.to_s == partition.partition_id.to_s
-
-                          @partition_stats = partition
-                        end
-                      end
-                    end
-                  end
+                  # Find the topic within the consumer group
+                  @topic_stats = cg_stats[:topics][@topic]
+                  @topic_stats || raise(Karafka::Web::Errors::Ui::NotFoundError)
 
-                  @subscription_group || raise(Karafka::Web::Errors::Ui::NotFoundError)
+                  # Find the partition within the topic
+                  @partition_stats = @topic_stats[:partitions][@partition_id]
+                  @partition_stats || raise(Karafka::Web::Errors::Ui::NotFoundError)
 
+                  # Check if topic is LRJ from routing
                   routing_topics = Karafka::App.routes.flat_map(&:topics).flat_map(&:to_a)
 
                   @routing_topic = routing_topics.find do |r_topic|
-                    r_topic.subscription_group.id == @subscription_group.id &&
+                    r_topic.consumer_group.id == @consumer_group_id &&
                       r_topic.name == @topic
                   end
 
-                  @partition_stats || raise(Karafka::Web::Errors::Ui::NotFoundError)
                   # May not be found when not all routing is available. In such cases we assume
                   # that topic is not LRJ and it's up to the end user to handle this correctly.
                   @topic_lrj = @routing_topic&.long_running_job?
+
+                  # Check if any active process is running (needed to issue commands)
+                  @any_process_running = Models::Processes.active(current_state).any? do |process|
+                    process.status == "running"
+                  end
                 end
               end
             end

data/lib/karafka/web/pro/ui/controllers/consumers/partitions/offsets_controller.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
@@ -10,58 +27,60 @@ module Karafka
         module Controllers
           module Consumers
             module Partitions
-              # Partition offset management controller in the context of current consumer process
-              # assignments
+              # Partition offset management controller at the consumer group level
               class OffsetsController < BaseController
                 self.sortable_attributes = [].freeze
 
                 # Displays the offset edit page with the edit form or a warning when not applicable
                 #
-                # @param process_id [String] id of the process we're interested in
-                # @param subscription_group_id [String]
+                # @param consumer_group_id [String]
                 # @param topic [String]
                 # @param partition_id [Integer]
-                def edit(process_id, subscription_group_id, topic, partition_id)
-                  bootstrap!(process_id, subscription_group_id, topic, partition_id)
+                def edit(consumer_group_id, topic, partition_id)
+                  bootstrap!(consumer_group_id, topic, partition_id)
 
                   render
                 end
 
                 # Triggers the offset change in the running process via the commanding API
                 #
-                # @param process_id [String] id of the process we're interested in
-                # @param subscription_group_id [String]
+                # @param consumer_group_id [String]
                 # @param topic [String]
                 # @param partition_id [Integer]
-                def update(process_id, subscription_group_id, topic, partition_id)
-                  edit(process_id, subscription_group_id, topic, partition_id)
+                def update(consumer_group_id, topic, partition_id)
+                  edit(consumer_group_id, topic, partition_id)
 
                   offset = params.int(:offset)
                   prevent_overtaking = params.bool(:prevent_overtaking)
                   force_resume = params.bool(:force_resume)
 
+                  # Broadcast to all processes with matchers to filter by consumer group,
+                  # topic, and partition
                   Commanding::Dispatcher.request(
                     Commanding::Commands::Partitions::Seek.name,
-                    process_id,
                     {
-                      consumer_group_id: @consumer_group.id,
-                      subscription_group_id: @subscription_group.id,
+                      consumer_group_id: consumer_group_id,
                       topic: topic,
                       partition_id: partition_id,
                       offset: offset,
                       prevent_overtaking: prevent_overtaking,
                       force_resume: force_resume
+                    },
+                    matchers: {
+                      consumer_group_id: consumer_group_id,
+                      topic: topic,
+                      partition_id: partition_id
                     }
                   )
 
                   redirect(
                     :previous,
                     success: format_flash(
-                      'Initiated offset adjustment to ? for ?#? (subscription group: ?)',
+                      "Initiated offset adjustment to ? for ?#? in consumer group ?",
                       offset,
                       topic,
                       partition_id,
-                      subscription_group_id
+                      consumer_group_id
                     )
                   )
                 end