karafka-web 0.10.4 → 0.11.0.beta1

data/lib/karafka/web/pro/ui/controllers/recurring_tasks_controller.rb

@@ -1,15 +1,7 @@
 # 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.
+# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
+# See LICENSE for details.
 
 module Karafka
   module Web
@@ -94,7 +86,7 @@ module Karafka
 
             # @return [String] recurring tasks logs topic
             def logs_topic
-              ::Karafka::App.config.recurring_tasks.topics.logs
+              ::Karafka::App.config.recurring_tasks.topics.logs.name
             end
 
             # Runs the recurring tasks command
@@ -112,7 +104,11 @@ module Karafka
             def dispatched_to_one(command, task_id)
               command_name = command.to_s.capitalize
 
-              "The #{command_name} command has been dispatched to the #{task_id} task."
+              format_flash(
+                'The ? command has been dispatched to the ? task',
+                command_name,
+                task_id
+              )
             end
 
             # Generates a nice flash message about dispatch of multi-task command
@@ -121,7 +117,10 @@ module Karafka
             def dispatched_to_all(command)
               command_name = command.to_s.capitalize
 
-              "The #{command_name} command has been dispatched to all tasks."
+              format_flash(
+                'The ? command has been dispatched to all tasks',
+                command_name
+              )
             end
           end
         end

data/lib/karafka/web/pro/ui/controllers/routing_controller.rb

@@ -1,15 +1,7 @@
 # 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.
+# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
+# See LICENSE for details.
 
 module Karafka
   module Web

data/lib/karafka/web/pro/ui/controllers/scheduled_messages/base_controller.rb

@@ -1,15 +1,7 @@
 # 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.
+# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
+# See LICENSE for details.
 
 module Karafka
   module Web

data/lib/karafka/web/pro/ui/controllers/scheduled_messages/explorer_controller.rb

@@ -1,15 +1,7 @@
 # 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.
+# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
+# See LICENSE for details.
 
 module Karafka
   module Web
@@ -24,8 +16,8 @@ module Karafka
               #
               # @param topic_id [String]
               def topic(topic_id)
-                response = Controllers::ExplorerController
-                           .new(@params)
+                response = Controllers::Explorer::ExplorerController
+                           .new(@params, @session)
                            .topic(topic_id)
 
                 render(attributes: response.attributes)
@@ -36,8 +28,8 @@ module Karafka
               # @param topic_id [String]
               # @param partition_id [Integer]
               def partition(topic_id, partition_id)
-                response = Controllers::ExplorerController
-                           .new(@params)
+                response = Controllers::Explorer::ExplorerController
+                           .new(@params, @session)
                            .partition(topic_id, partition_id)
 
                 render(attributes: response.attributes)
@@ -50,8 +42,8 @@ module Karafka
               # @param partition_id [Integer]
               # @param time [Time] time of the message
               def closest(topic_id, partition_id, time)
-                response = Controllers::ExplorerController
-                           .new(@params)
+                response = Controllers::Explorer::ExplorerController
+                           .new(@params, @session)
                            .closest(topic_id, partition_id, time)
 
                 redirect("scheduled_messages/#{response.path}")

data/lib/karafka/web/pro/ui/controllers/scheduled_messages/messages_controller.rb

@@ -1,15 +1,7 @@
 # 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.
+# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
+# See LICENSE for details.
 
 module Karafka
   module Web
@@ -44,11 +36,13 @@ module Karafka
 
                 redirect(
                   :back,
-                  success: <<~MESSAGE
-                    A scheduled message with offset #{message_offset}
-                    from #{topic_id} partition #{partition_id}
-                    had a cancel request message successfully created.
-                  MESSAGE
+                  success: format_flash(
+                    'A scheduled message with offset ? from ?#? had a ? successfully created',
+                    message_offset,
+                    topic_id,
+                    partition_id,
+                    'cancel request'
+                  )
                 )
               end
             end

data/lib/karafka/web/pro/ui/controllers/scheduled_messages/schedules_controller.rb

@@ -1,15 +1,7 @@
 # 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.
+# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
+# See LICENSE for details.
 
 module Karafka
   module Web

data/lib/karafka/web/pro/ui/controllers/status_controller.rb

@@ -1,15 +1,7 @@
 # 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.
+# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
+# See LICENSE for details.
 
 module Karafka
   module Web

data/lib/karafka/web/pro/ui/controllers/support_controller.rb

@@ -1,15 +1,7 @@
 # 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.
+# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
+# See LICENSE for details.
 
 module Karafka
   module Web

data/lib/karafka/web/pro/ui/controllers/topics/base_controller.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
+# See LICENSE for details.
+
+module Karafka
+  module Web
+    module Pro
+      module Ui
+        module Controllers
+          # Namespace for all the controllers related to working with topics
+          module Topics
+            # Base controller for all topics related controllers
+            class BaseController < Controllers::BaseController
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/karafka/web/pro/ui/controllers/topics/configs_controller.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
+# See LICENSE for details.
+
+module Karafka
+  module Web
+    module Pro
+      module Ui
+        module Controllers
+          module Topics
+            # Controller responsible for management of topics configs
+            class ConfigsController < BaseController
+              self.sortable_attributes = %w[
+                name
+                value
+                default?
+                sensitive?
+                read_only?
+              ].freeze
+
+              # Displays requested topic config details
+              #
+              # @param topic_name [String] topic we're interested in
+              def index(topic_name)
+                @topic = Models::Topic.find(topic_name)
+
+                @configs = refine(@topic.configs)
+
+                render
+              end
+
+              # Allows for editing of a particular configuration setting
+              # To simplify things we do not allow for batch editing of multiple parameters
+              # @param topic_name [String]
+              # @param property_name [String]
+              def edit(topic_name, property_name)
+                features.topics_management!
+
+                # This will load all the configs so we can validate that a requested config exists
+                # and we can get its current value for the form
+                index(topic_name)
+
+                @property = @configs.find { |config| config.name == property_name }
+
+                raise(Errors::Ui::NotFoundError) unless @property
+                raise(Errors::Ui::ForbiddenError) if @property.read_only?
+
+                render
+              end
+
+              # Tries to apply config change on a topic and either returns the error info or
+              # redirects if changed
+              # @param topic_name [String]
+              # @param property_name [String]
+              def update(topic_name, property_name)
+                edit(topic_name, property_name)
+
+                property_value = params[:property_value]
+
+                begin
+                  resource = Karafka::Admin::Configs::Resource.new(type: :topic, name: topic_name)
+                  resource.set(property_name, property_value)
+                  Karafka::Admin::Configs.alter(resource)
+                rescue Rdkafka::RdkafkaError => e
+                  @form_error = e
+                end
+
+                return edit(topic_name, property_name) if @form_error
+
+                redirect(
+                  "topics/#{topic_name}/config",
+                  success: format_flash(
+                    'Topic ? property ? successfully altered',
+                    topic_name,
+                    property_name
+                  )
+                )
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/karafka/web/pro/ui/controllers/topics/distributions_controller.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
+# See LICENSE for details.
+
+module Karafka
+  module Web
+    module Pro
+      module Ui
+        module Controllers
+          module Topics
+            # Controller responsible for checking the data distribution in topics
+            class DistributionsController < BaseController
+              self.sortable_attributes = %w[
+                partition_id
+                count
+                share
+                diff
+              ].freeze
+
+              # After repartitioning we need to clear the cache to get fresh state
+              after(:update) { cache.clear }
+
+              # Displays the messages distribution across various partitions
+              #
+              # @param topic_name [String] topic we're interested in
+              #
+              # @note Because computing distribution is fairly expensive, we paginate this. While
+              #   because of that results may not be exact, this allows us to support topics with
+              #   many partitions.
+              def show(topic_name)
+                @topic = Models::Topic.find(topic_name)
+
+                @active_partitions, _materialized_page, @limited = Paginators::Partitions.call(
+                  @topic.partition_count, @params.current_page
+                )
+
+                @aggregated, distribution = @topic.distribution(@active_partitions)
+
+                @distribution = refine(distribution)
+
+                next_page = @active_partitions.last < @topic.partition_count - 1
+                paginate(@params.current_page, next_page)
+
+                render
+              end
+
+              # @param topic_name [String]
+              def edit(topic_name)
+                features.topics_management!
+
+                @topic = Models::Topic.find(topic_name)
+
+                render
+              end
+
+              # @param topic_name [String]
+              def update(topic_name)
+                edit(topic_name)
+
+                partition_count = params.int(:partition_count)
+
+                begin
+                  Karafka::Admin.create_partitions(
+                    topic_name,
+                    partition_count
+                  )
+                rescue Rdkafka::RdkafkaError => e
+                  @form_error = e
+                rescue Rdkafka::Config::ConfigError => e
+                  @form_error = e
+                end
+
+                return edit(topic_name) if @form_error
+
+                redirect(
+                  "topics/#{topic_name}/distribution",
+                  success: format_flash(
+                    'Topic ? repartitioning to ? partitions successfully started',
+                    topic_name,
+                    partition_count
+                  )
+                )
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/karafka/web/pro/ui/controllers/topics/offsets_controller.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
+# See LICENSE for details.
+
+module Karafka
+  module Web
+    module Pro
+      module Ui
+        module Controllers
+          module Topics
+            # Controller responsible for viewing topics offsets details
+            class OffsetsController < BaseController
+              self.sortable_attributes = %w[
+                partition_id
+                low
+                high
+                diff
+              ].freeze
+
+              # Displays high and low offsets for given topic
+              #
+              # @param topic_name [String] topic we're interested in
+              def show(topic_name)
+                @topic = Models::Topic.find(topic_name)
+
+                @active_partitions, _materialized_page, @limited = Paginators::Partitions.call(
+                  @topic.partition_count, @params.current_page
+                )
+
+                offsets = @active_partitions.map do |partition_id|
+                  part_offsets = Admin.read_watermark_offsets(topic_name, partition_id)
+
+                  {
+                    partition_id: partition_id,
+                    low: part_offsets.first,
+                    high: part_offsets.last,
+                    diff: part_offsets.last - part_offsets.first
+                  }
+                end
+
+                @offsets = refine(offsets)
+
+                next_page = @active_partitions.last < @topic.partition_count - 1
+                paginate(@params.current_page, next_page)
+
+                render
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/karafka/web/pro/ui/controllers/topics/replications_controller.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
+# See LICENSE for details.
+
+module Karafka
+  module Web
+    module Pro
+      module Ui
+        module Controllers
+          module Topics
+            # Controller responsible for viewing and managing topics replication details
+            class ReplicationsController < BaseController
+              self.sortable_attributes = %w[
+                partition_id
+                leader
+                replica_count
+                in_sync_replica_brokers
+              ].freeze
+
+              # Displays requested topic replication details
+              #
+              # @param topic_name [String] topic we're interested in
+              def show(topic_name)
+                @topic = Models::Topic.find(topic_name)
+
+                @partitions = refine(@topic[:partitions])
+
+                render
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/karafka/web/pro/ui/controllers/topics/topics_controller.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
+# See LICENSE for details.
+
+module Karafka
+  module Web
+    module Pro
+      module Ui
+        module Controllers
+          module Topics
+            # The primary controller for topics listing and creation / removal
+            class TopicsController < BaseController
+              self.sortable_attributes = [].freeze
+
+              after(:create, :delete) { cache.clear }
+
+              # Displays list of topics we can work with
+              def index
+                @topics = Models::Topic.all.sort_by(&:topic_name)
+
+                unless ::Karafka::Web.config.ui.visibility.internal_topics
+                  @topics.delete_if { |topic| topic[:topic_name].start_with?('__') }
+                end
+
+                render
+              end
+
+              # Renders form for creating a new topic with basic details like number of partitions
+              # and the replication factor
+              def new
+                features.topics_management!
+
+                render
+              end
+
+              # Creates topic and redirects on success
+              # @note Upon creation we do not redirect to the topic config page because it may take
+              #   a topic a moment to be fully available in the cluster. We "buy" ourselves this
+              #   time by redirecting user back to the topics list
+              def create
+                features.topics_management!
+
+                begin
+                  Karafka::Admin.create_topic(
+                    params[:topic_name],
+                    params.int(:partitions_count),
+                    params.int(:replication_factor)
+                  )
+                rescue Rdkafka::RdkafkaError => e
+                  @form_error = e
+                end
+
+                return new if @form_error
+
+                redirect(
+                  'topics',
+                  success: format_flash(
+                    'Topic ? successfully created',
+                    params[:topic_name]
+                  )
+                )
+              end
+
+              # Renders a confirmation page for topic removal since it is a sensitive operation
+              #
+              # @param topic_name [String]
+              def edit(topic_name)
+                features.topics_management!
+
+                @topic = Models::Topic.find(topic_name)
+                @topic_name = topic_name
+
+                render
+              end
+
+              # Deletes the requested topic
+              #
+              # @param topic_name [String] name of the topic we want to remove
+              def delete(topic_name)
+                features.topics_management!
+
+                edit(topic_name)
+
+                Karafka::Admin.delete_topic(topic_name)
+
+                redirect(
+                  'topics',
+                  success: format_flash(
+                    'Topic ? successfully deleted',
+                    topic_name
+                  )
+                )
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/karafka/web/pro/ui/controllers/ux_controller.rb

@@ -1,15 +1,7 @@
 # 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.
+# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
+# See LICENSE for details.
 
 module Karafka
   module Web

data/lib/karafka/web/pro/ui/lib/branding/config.rb

@@ -1,15 +1,7 @@
 # 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.
+# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
+# See LICENSE for details.
 
 module Karafka
   module Web