karafka-web 0.11.5 → 0.11.6

data/lib/karafka/web/pro/ui/controllers/consumers/partitions/pauses_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,93 +27,102 @@ module Karafka
         module Controllers
           module Consumers
             module Partitions
-              # Controller for managing partitions pauses in the context of the given consumer
-              # process
+              # Controller for managing partition pauses at the consumer group level.
               class PausesController < BaseController
                 self.sortable_attributes = %w[].freeze
 
-                # Displays the toggle (pause / resume)
+                # Displays the pause configuration form for a partition
                 #
-                # @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 new(process_id, subscription_group_id, topic, partition_id)
-                  bootstrap!(process_id, subscription_group_id, topic, partition_id)
+                def new(consumer_group_id, topic, partition_id)
+                  bootstrap!(consumer_group_id, topic, partition_id)
 
                   render
                 end
 
-                # @param process_id [String]
-                # @param subscription_group_id [String]
+                # Dispatches the partition pause command to all processes
+                #
+                # @param consumer_group_id [String]
                 # @param topic [String]
                 # @param partition_id [Integer]
-                def create(process_id, subscription_group_id, topic, partition_id)
-                  new(process_id, subscription_group_id, topic, partition_id)
+                def create(consumer_group_id, topic, partition_id)
+                  new(consumer_group_id, topic, partition_id)
 
+                  # Broadcast to all processes with matchers to filter by consumer group,
+                  # topic, and partition
                   Commanding::Dispatcher.request(
                     Commanding::Commands::Partitions::Pause.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,
                       # User provides this in seconds, we operate on ms in the system
                       duration: params.int(:duration) * 1_000,
                       prevent_override: params.bool(:prevent_override)
+                    },
+                    matchers: {
+                      consumer_group_id: consumer_group_id,
+                      topic: topic,
+                      partition_id: partition_id
                     }
                   )
 
                   redirect(
                     :previous,
                     success: format_flash(
-                      'Initiated partition ? for ?#? (subscription group: ?)',
-                      'pause',
+                      "Initiated pause for partition ?#? in consumer group ?",
                       topic,
                       partition_id,
-                      subscription_group_id
+                      consumer_group_id
                     )
                   )
                 end
 
-                # @param process_id [String]
-                # @param subscription_group_id [String]
+                # Displays the resume configuration form for a partition
+                #
+                # @param consumer_group_id [String]
                 # @param topic [String]
                 # @param partition_id [Integer]
-                def edit(process_id, subscription_group_id, topic, partition_id)
-                  new(process_id, subscription_group_id, topic, partition_id)
+                def edit(consumer_group_id, topic, partition_id)
+                  new(consumer_group_id, topic, partition_id)
 
                   render
                 end
 
-                # @param process_id [String]
-                # @param subscription_group_id [String]
+                # Dispatches the partition resume command to all processes
+                #
+                # @param consumer_group_id [String]
                 # @param topic [String]
                 # @param partition_id [Integer]
-                def delete(process_id, subscription_group_id, topic, partition_id)
-                  new(process_id, subscription_group_id, topic, partition_id)
+                def delete(consumer_group_id, topic, partition_id)
+                  new(consumer_group_id, topic, partition_id)
 
+                  # Broadcast to all processes with matchers to filter by consumer group,
+                  # topic, and partition
                   Commanding::Dispatcher.request(
                     Commanding::Commands::Partitions::Resume.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,
                       reset_attempts: params.bool(:reset_attempts)
+                    },
+                    matchers: {
+                      consumer_group_id: consumer_group_id,
+                      topic: topic,
+                      partition_id: partition_id
                     }
                   )
 
                   redirect(
                     :previous,
                     success: format_flash(
-                      'Initiated partition ? for ?#? (subscription group: ?)',
-                      'resume',
+                      "Initiated resume for partition ?#? in consumer group ?",
                       topic,
                       partition_id,
-                      subscription_group_id
+                      consumer_group_id
                     )
                   )
                 end

data/lib/karafka/web/pro/ui/controllers/consumers/topics/pauses_controller.rb

@@ -0,0 +1,164 @@
+# 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 Ui
+        module Controllers
+          module Consumers
+            # Namespace for controllers related to topic-level operations in the consumers context.
+            module Topics
+              # Controller for managing topic-level pauses at the consumer group level.
+              class PausesController < BaseController
+                self.sortable_attributes = %w[].freeze
+
+                # Displays the pause configuration form for a topic
+                #
+                # @param consumer_group_id [String]
+                # @param topic [String]
+                def new(consumer_group_id, topic)
+                  bootstrap!(consumer_group_id, topic)
+
+                  render
+                end
+
+                # Dispatches the topic pause command to all processes
+                #
+                # @param consumer_group_id [String]
+                # @param topic [String]
+                def create(consumer_group_id, topic)
+                  new(consumer_group_id, topic)
+
+                  Commanding::Dispatcher.request(
+                    Commanding::Commands::Topics::Pause.name,
+                    {
+                      consumer_group_id: consumer_group_id,
+                      topic: topic,
+                      # User provides this in seconds, we operate on ms in the system
+                      duration: params.int(:duration) * 1_000,
+                      prevent_override: params.bool(:prevent_override)
+                    },
+                    matchers: {
+                      consumer_group_id: consumer_group_id,
+                      topic: topic
+                    }
+                  )
+
+                  redirect(
+                    :previous,
+                    success: format_flash(
+                      "Initiated pause for all partitions of the ? topic in consumer group ?",
+                      topic,
+                      consumer_group_id
+                    )
+                  )
+                end
+
+                # Displays the resume configuration form for a topic
+                #
+                # @param consumer_group_id [String]
+                # @param topic [String]
+                def edit(consumer_group_id, topic)
+                  new(consumer_group_id, topic)
+
+                  render
+                end
+
+                # Dispatches the topic resume command to all processes
+                #
+                # @param consumer_group_id [String]
+                # @param topic [String]
+                def delete(consumer_group_id, topic)
+                  new(consumer_group_id, topic)
+
+                  Commanding::Dispatcher.request(
+                    Commanding::Commands::Topics::Resume.name,
+                    {
+                      consumer_group_id: consumer_group_id,
+                      topic: topic,
+                      reset_attempts: params.bool(:reset_attempts)
+                    },
+                    matchers: {
+                      consumer_group_id: consumer_group_id,
+                      topic: topic
+                    }
+                  )
+
+                  redirect(
+                    :previous,
+                    success: format_flash(
+                      "Initiated resume for all partitions of the ? topic in consumer group ?",
+                      topic,
+                      consumer_group_id
+                    )
+                  )
+                end
+
+                private
+
+                # Finds all the needed details and if not found raises a not found.
+                # Uses the aggregated health stats data instead of process-specific data.
+                #
+                # @param consumer_group_id [String]
+                # @param topic [String]
+                def bootstrap!(consumer_group_id, topic)
+                  @consumer_group_id = consumer_group_id
+                  @topic = topic
+
+                  # Get aggregated stats from all processes
+                  current_state = Models::ConsumersState.current!
+                  @stats = Models::Health.current(current_state)
+
+                  # Find the consumer group
+                  cg_stats = @stats[@consumer_group_id]
+                  cg_stats || raise(Karafka::Web::Errors::Ui::NotFoundError)
+
+                  # Find the topic within the consumer group
+                  @topic_stats = cg_stats[:topics][@topic]
+                  @topic_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.consumer_group.id == @consumer_group_id &&
+                      r_topic.name == @topic
+                  end
+
+                  # 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
+          end
+        end
+      end
+    end
+  end
+end

data/lib/karafka/web/pro/ui/controllers/dashboard_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/dlq_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
@@ -15,17 +32,17 @@ module Karafka
               topics = Karafka::App.consumer_groups.flat_map(&:topics).flat_map(&:to_a)
 
               dlq_topic_patterns = topics
-                                   .map { |source_topic| source_topic.dead_letter_queue.topic }
-                                   .uniq
-                                   .compact
-                                   .select(&:itself)
+                .map { |source_topic| source_topic.dead_letter_queue.topic }
+                .uniq
+                .compact
+                .select(&:itself)
 
               dlq_topic_patterns += Web.config.ui.dlq_patterns
 
               @dlq_topics = Models::ClusterInfo
-                            .topics
-                            .select { |topic| dlq?(dlq_topic_patterns, topic[:topic_name]) }
-                            .sort_by { |topic| topic[:topic_name] }
+                .topics
+                .select { |topic| dlq?(dlq_topic_patterns, topic[:topic_name]) }
+                .sort_by { |topic| topic[:topic_name] }
 
               render
             end

data/lib/karafka/web/pro/ui/controllers/errors_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
@@ -42,13 +59,12 @@ module Karafka
                 @watermark_offsets
               )
 
-              paginate(
-                previous_offset,
-                @params.current_offset,
-                next_offset,
-                # If message is an array, it means it's a compacted dummy offset representation
-                @error_messages.map { |message| message.is_a?(Array) ? message.last : message.offset }
-              )
+              # If message is an array, it means it's a compacted dummy offset representation
+              mapped = @error_messages.map do |message|
+                message.is_a?(Array) ? message.last : message.offset
+              end
+
+              paginate(previous_offset, @params.current_offset, next_offset, mapped)
 
               render
             end

data/lib/karafka/web/pro/ui/controllers/explorer/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/explorer/explorer_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
@@ -14,11 +31,11 @@ module Karafka
               # Lists all the topics we can explore
               def index
                 @topics = Models::ClusterInfo
-                          .topics
-                          .sort_by { |topic| topic[:topic_name] }
+                  .topics
+                  .sort_by { |topic| topic[:topic_name] }
 
                 unless ::Karafka::Web.config.ui.visibility.internal_topics
-                  @topics.reject! { |topic| topic[:topic_name].start_with?('__') }
+                  @topics.reject! { |topic| topic[:topic_name].start_with?("__") }
                 end
 
                 render

data/lib/karafka/web/pro/ui/controllers/explorer/messages_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
@@ -31,11 +48,11 @@ module Karafka
                 @target_partition = @partition_id
 
                 @topics = Models::ClusterInfo
-                          .topics
-                          .sort_by { |topic| topic[:topic_name] }
+                  .topics
+                  .sort_by { |topic| topic[:topic_name] }
 
                 unless ::Karafka::Web.config.ui.visibility.internal_topics
-                  @topics.reject! { |topic| topic[:topic_name].start_with?('__') }
+                  @topics.reject! { |topic| topic[:topic_name].start_with?("__") }
                 end
 
                 render
@@ -65,9 +82,9 @@ module Karafka
                 # Include source headers for enhanced debuggability
                 if params.bool(:include_source_headers)
                   dispatch_message[:headers].merge!(
-                    'source_topic' => @message.topic,
-                    'source_partition' => @message.partition.to_s,
-                    'source_offset' => @message.offset.to_s
+                    "source_topic" => @message.topic,
+                    "source_partition" => @message.partition.to_s,
+                    "source_offset" => @message.offset.to_s
                   )
                 end
 
@@ -124,7 +141,7 @@ module Karafka
               # @return [String] flash message about message reproducing
               def republished(message, delivery)
                 format_flash(
-                  'Message with offset ? has been sent to ?#? and received offset ?',
+                  "Message with offset ? has been sent to ?#? and received offset ?",
                   message.offset,
                   delivery.topic,
                   delivery.partition,

data/lib/karafka/web/pro/ui/controllers/explorer/search_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
@@ -36,10 +53,10 @@ module Karafka
 
                 # If there is search form filled, we validate it to make sure there are no errors
                 @errors = if @search_criteria
-                            Lib::Search::Contracts::Form.new.call(@current_search).errors
-                          else
-                            {}
-                          end
+                  Lib::Search::Contracts::Form.new.call(@current_search).errors
+                else
+                  {}
+                end
 
                 # If all good we run the search
                 if @search_criteria && @errors.empty?

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