karafka-web 0.10.4 → 0.11.0

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

@@ -1,220 +0,0 @@
-# frozen_string_literal: true
-
-# This Karafka component is a Pro component under a commercial license.
-# This Karafka component is NOT licensed under LGPL.
-#
-# All of the commercial components are present in the lib/karafka/pro directory of this
-# repository and their usage requires commercial license agreement.
-#
-# Karafka has also commercial-friendly license, commercial support and commercial components.
-#
-# By sending a pull request to the pro components, you are agreeing to transfer the copyright of
-# your code to Maciej Mensfeld.
-
-module Karafka
-  module Web
-    module Pro
-      module Ui
-        module Controllers
-          # Data explorer controller
-          class ExplorerController < BaseController
-            # Lists all the topics we can explore
-            def index
-              @topics = Models::ClusterInfo
-                        .topics
-                        .sort_by { |topic| topic[:topic_name] }
-
-              unless ::Karafka::Web.config.ui.visibility.internal_topics
-                @topics.reject! { |topic| topic[:topic_name].start_with?('__') }
-              end
-
-              render
-            end
-
-            # Displays aggregated messages from (potentially) all partitions of a topic
-            #
-            # @param topic_id [String]
-            #
-            # @note This view may not be 100% accurate because we merge multiple partitions data
-            #   into a single view and this is never accurate. It can be used however to quickly
-            #   look at most recent data flowing, etc, hence it is still useful for aggregated
-            #   metrics information
-            #
-            # @note We cannot use offset references here because each of the partitions may have
-            #   completely different values
-            def topic(topic_id)
-              @visibility_filter = ::Karafka::Web.config.ui.policies.messages
-
-              @topic_id = topic_id
-              @partitions_count = Models::ClusterInfo.partitions_count(topic_id)
-
-              @active_partitions, materialized_page, @limited = Paginators::Partitions.call(
-                @partitions_count, @params.current_page
-              )
-
-              @messages, next_page = Models::Message.topic_page(
-                topic_id, @active_partitions, materialized_page
-              )
-
-              paginate(@params.current_page, next_page)
-
-              render
-            end
-
-            # Shows messages available in a given partition
-            #
-            # @param topic_id [String]
-            # @param partition_id [Integer]
-            def partition(topic_id, partition_id)
-              @visibility_filter = ::Karafka::Web.config.ui.policies.messages
-              @topic_id = topic_id
-              @partition_id = partition_id
-              @watermark_offsets = Models::WatermarkOffsets.find(topic_id, partition_id)
-              @partitions_count = Models::ClusterInfo.partitions_count(topic_id)
-
-              previous_offset, @messages, next_offset = current_partition_data
-
-              paginate(
-                previous_offset,
-                @params.current_offset,
-                next_offset,
-                # If message is an array, it means it's a compacted dummy offset representation
-                @messages.map { |message| message.is_a?(Array) ? message.last : message.offset }
-              )
-
-              render
-            end
-
-            # Displays given message
-            #
-            # @param topic_id [String]
-            # @param partition_id [Integer]
-            # @param offset [Integer] offset of the message we want to display
-            # @param paginate [Boolean] do we want to have pagination
-            def show(topic_id, partition_id, offset, paginate: true)
-              Lib::PatternsDetector.new.call
-
-              @visibility_filter = ::Karafka::Web.config.ui.policies.messages
-              @topic_id = topic_id
-              @partition_id = partition_id
-              @offset = offset
-              @message = Models::Message.find(@topic_id, @partition_id, @offset)
-
-              @safe_key = Web::Pro::Ui::Lib::SafeRunner.new { @message.key }.tap(&:call)
-              @safe_headers = Web::Pro::Ui::Lib::SafeRunner.new { @message.headers }.tap(&:call)
-              @safe_payload = Web::Pro::Ui::Lib::SafeRunner.new { @message.payload }.tap(&:call)
-
-              # This may be off for certain views like recent view where we are interested only
-              # in the most recent all the time. It does not make any sense to display pagination
-              # there
-              if paginate
-                # We need watermark offsets to decide if we can paginate left and right
-                watermark_offsets = Models::WatermarkOffsets.find(topic_id, partition_id)
-                paginate(offset, watermark_offsets.low, watermark_offsets.high)
-              end
-
-              render
-            end
-
-            # Displays the most recent message on a topic/partition
-            #
-            # @param topic_id [String]
-            # @param partition_id [Integer, nil] partition we're interested in or nil if we are
-            #   interested in the most recent message from all the partitions
-            def recent(topic_id, partition_id)
-              if partition_id
-                active_partitions = [partition_id]
-              else
-                partitions_count = Models::ClusterInfo.partitions_count(topic_id)
-                active_partitions, = Paginators::Partitions.call(partitions_count, 1)
-              end
-
-              recent = nil
-
-              # This selects first pages with most recent messages and moves to next if first
-              # contains only compacted data, etc.
-              #
-              # We do it until we find a message we could refer to (if doable) within first
-              # ten pages
-              10.times do |page|
-                messages, = Models::Message.topic_page(topic_id, active_partitions, page + 1)
-
-                # Selects newest out of all partitions
-                # Reject compacted messages and transaction-related once
-                recent = messages.reject { |message| message.is_a?(Array) }.max_by(&:timestamp)
-
-                break if recent
-              end
-
-              recent || not_found!
-
-              show(topic_id, recent.partition, recent.offset, paginate: false)
-            end
-
-            # Computes a page on which the given offset is in the middle of the page (if possible)
-            # Useful often when debugging to be able to quickly jump to the historical location
-            # of message and its surrounding to understand failure
-            #
-            # @param topic_id [String]
-            # @param partition_id [Integer]
-            # @param offset [Integer] offset of the message we want to display
-            def surrounding(topic_id, partition_id, offset)
-              watermark_offsets = Models::WatermarkOffsets.find(topic_id, partition_id)
-
-              not_found! if offset < watermark_offsets.low
-              not_found! if offset >= watermark_offsets.high
-
-              # Assume we start from this offset
-              shift = 0
-              elements = 0
-
-              # Position the offset as close to the middle of offset based page as possible
-              ::Karafka::Web.config.ui.per_page.times do
-                break if elements >= ::Karafka::Web.config.ui.per_page
-
-                elements += 1 if offset + shift < watermark_offsets.high
-
-                if offset - shift > watermark_offsets.low
-                  shift += 1
-                  elements += 1
-                end
-              end
-
-              target = offset - shift
-
-              redirect("explorer/#{topic_id}/#{partition_id}?offset=#{target}")
-            end
-
-            # Finds the closest offset matching the requested time and redirects to this location
-            # Note, that it redirects to closest but always younger.
-            #
-            # @param topic_id [String]
-            # @param partition_id [Integer]
-            # @param time [Time] time of the message
-            def closest(topic_id, partition_id, time)
-              target = Web::Ui::Lib::Admin.read_topic(topic_id, partition_id, 1, time).first
-
-              partition_path = "explorer/#{topic_id}/#{partition_id}"
-              partition_path += "?offset=#{target.offset}" if target
-
-              redirect(partition_path)
-            end
-
-            private
-
-            # Fetches current page data
-            # @return [Array] fetched data with pagination information for the requested partition
-            def current_partition_data
-              Models::Message.offset_page(
-                @topic_id,
-                @partition_id,
-                @params.current_offset,
-                @watermark_offsets
-              )
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,107 +0,0 @@
-# frozen_string_literal: true
-
-# This Karafka component is a Pro component under a commercial license.
-# This Karafka component is NOT licensed under LGPL.
-#
-# All of the commercial components are present in the lib/karafka/pro directory of this
-# repository and their usage requires commercial license agreement.
-#
-# Karafka has also commercial-friendly license, commercial support and commercial components.
-#
-# By sending a pull request to the pro components, you are agreeing to transfer the copyright of
-# your code to Maciej Mensfeld.
-
-module Karafka
-  module Web
-    module Pro
-      module Ui
-        module Controllers
-          # Controller for working with messages
-          # While part of messages operations is done via explorer (exploring), this controller
-          # handles other cases not related to viewing data
-          class MessagesController < BaseController
-            # Takes a requested message content and republishes it again
-            #
-            # @param topic_id [String]
-            # @param partition_id [Integer]
-            # @param offset [Integer] offset of the message we want to republish
-            def republish(topic_id, partition_id, offset)
-              message = Models::Message.find(topic_id, partition_id, offset)
-
-              deny! unless visibility_filter.republish?(message)
-
-              delivery = ::Karafka::Web.producer.produce_sync(
-                topic: topic_id,
-                partition: partition_id,
-                payload: message.raw_payload,
-                headers: message.headers,
-                key: message.key
-              )
-
-              redirect(
-                :back,
-                success: reproduced(message, delivery)
-              )
-            end
-
-            # Dispatches the message raw payload to the browser as a file
-            #
-            # @param topic_id [String]
-            # @param partition_id [Integer]
-            # @param offset [Integer] offset of the message we want to download
-            def download(topic_id, partition_id, offset)
-              message = Models::Message.find(topic_id, partition_id, offset)
-
-              deny! unless visibility_filter.download?(message)
-
-              file(
-                message.raw_payload,
-                "#{topic_id}_#{partition_id}_#{offset}_payload.msg"
-              )
-            end
-
-            # Dispatches the message payload first deserialized and then serialized to JSON
-            # It differs from the raw payload in cases where raw payload is compressed or binary
-            # or contains data that the Web UI user should not see that was altered on the Web UI
-            # with the visibility filter.
-            #
-            # @param topic_id [String]
-            # @param partition_id [Integer]
-            # @param offset [Integer] offset of the message we want to export
-            def export(topic_id, partition_id, offset)
-              Lib::PatternsDetector.new.call
-
-              message = Models::Message.find(topic_id, partition_id, offset)
-
-              # Check if exports are allowed
-              deny! unless visibility_filter.export?(message)
-
-              file(
-                message.payload.to_json,
-                "#{topic_id}_#{partition_id}_#{offset}_payload.json"
-              )
-            end
-
-            private
-
-            # @param message [Karafka::Messages::Message]
-            # @param delivery [Rdkafka::Producer::DeliveryReport]
-            # @return [String] flash message about message reproducing
-            def reproduced(message, delivery)
-              <<~MSG
-                Message with offset #{message.offset}
-                has been sent again to #{message.topic}##{message.partition}
-                and received offset #{delivery.offset}.
-              MSG
-            end
-
-            # @return [Object] visibility filter. Either default or user-based
-            def visibility_filter
-              ::Karafka::Web.config.ui.policies.messages
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,73 +0,0 @@
-# frozen_string_literal: true
-
-# This Karafka component is a Pro component under a commercial license.
-# This Karafka component is NOT licensed under LGPL.
-#
-# All of the commercial components are present in the lib/karafka/pro directory of this
-# repository and their usage requires commercial license agreement.
-#
-# Karafka has also commercial-friendly license, commercial support and commercial components.
-#
-# By sending a pull request to the pro components, you are agreeing to transfer the copyright of
-# your code to Maciej Mensfeld.
-
-module Karafka
-  module Web
-    module Pro
-      module Ui
-        module Controllers
-          # Handles the search requests
-          # We present this as a part of explorer scope but we use a separate controller not to
-          # mix data exploring with searching.
-          class SearchController < Web::Ui::Controllers::ClusterController
-            # Runs the search if search parameters are provided
-            # If no parameters provided, displays the search modal and info to provide search data
-            # If invalid search parameters provided, modal contains errors
-            #
-            # @param topic_id [String] topic we're interested in
-            # @note In theory search can be used to detect pieces of information within messages.
-            #   Since we allow for custom search strategies, this is not an issue because users
-            #   that need to provide only granular search can do so.
-            def index(topic_id)
-              @topic_id = topic_id
-              @partitions_count = Models::ClusterInfo.partitions_count(topic_id)
-              # Select only matchers that should be available in the context of the current topic
-              @matchers = Web.config.ui.search.matchers.select { |match| match.active?(@topic_id) }
-              @search_criteria = !@params.current_search.empty?
-              @current_search = Lib::Search::Normalizer.call(@params.current_search)
-              # Needed when rendering found messages rows. We should always filter the messages
-              # details with the visibility filter
-              @visibility_filter = ::Karafka::Web.config.ui.policies.messages
-              @limits = ::Karafka::Web.config.ui.search.limits.sort
-
-              # 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
-
-              # If all good we run the search
-              if @search_criteria && @errors.empty?
-                found, @search_details = Lib::Search::Runner.new(
-                  @topic_id,
-                  @partitions_count,
-                  @current_search
-                ).call
-
-                @messages, last_page = Paginators::Arrays.call(
-                  found,
-                  @params.current_page
-                )
-
-                paginate(@params.current_page, !last_page)
-              end
-
-              render
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,130 +0,0 @@
-# frozen_string_literal: true
-
-# This Karafka component is a Pro component under a commercial license.
-# This Karafka component is NOT licensed under LGPL.
-#
-# All of the commercial components are present in the lib/karafka/pro directory of this
-# repository and their usage requires commercial license agreement.
-#
-# Karafka has also commercial-friendly license, commercial support and commercial components.
-#
-# By sending a pull request to the pro components, you are agreeing to transfer the copyright of
-# your code to Maciej Mensfeld.
-
-module Karafka
-  module Web
-    module Pro
-      module Ui
-        module Controllers
-          # Topics management controller
-          # Allows for exploration of settings and replication details
-          class TopicsController < BaseController
-            self.sortable_attributes = %w[
-              name
-              value
-              default?
-              read_only?
-              synonym?
-              sensitive?
-              partition_id
-              leader
-              replica_count
-              in_sync_replica_brokers
-              count
-              share
-              diff
-              low
-              high
-            ].freeze
-
-            # Lists available topics in the cluster
-            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
-
-            # Displays requested topic config details
-            #
-            # @param topic_name [String] topic we're interested in
-            def config(topic_name)
-              @topic = Models::Topic.find(topic_name)
-
-              @configs = refine(@topic.configs)
-
-              render
-            end
-
-            # Displays requested topic replication details
-            #
-            # @param topic_name [String] topic we're interested in
-            def replication(topic_name)
-              @topic = Models::Topic.find(topic_name)
-
-              @partitions = refine(@topic[:partitions])
-
-              render
-            end
-
-            # 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 distribution(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
-
-            # Displays high and low offsets for given topic
-            #
-            # @param topic_name [String] topic we're interested in
-            def offsets(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

data/lib/karafka/web/pro/ui/views/commands/_breadcrumbs.erb

@@ -1,21 +0,0 @@
-<li>
-  <a href="<%= root_path('consumers/overview') %>">
-    Consumers
-  </a>
-</li>
-
-<% if current_path.include?('/commands') %>
-  <li>
-    <a href="<%= root_path('commands') %>">
-      Commands
-    </a>
-  </li>
-<% end %>
-
-<% if @command_message %>
-  <li>
-    <a href="<%= root_path('commands', @command_message.offset) %>">
-      <%= @command_message.offset %>
-    </a>
-  </li>
-<% end %>

data/lib/karafka/web/pro/ui/views/commands/_command_details.erb

@@ -1 +0,0 @@
-<pre class="code"><code class="json"><%= JSON.pretty_generate command %></code></pre>

data/lib/karafka/web/pro/ui/views/commands/_empty.erb

@@ -1,3 +0,0 @@
-<%==
-  alert_info('No commands found.')
-%>

data/lib/karafka/web/pro/ui/views/commands/show.erb

@@ -1,33 +0,0 @@
-<% command = @command_message.payload %>
-
-<div class="col-span-12">
-  <% if command[:schema_version] == @schema_version %>
-    <% view_title "#{command[:command][:name]} #{command[:type]} #{@command_message.key}" %>
-
-    <%== partial 'consumers/tabs' %>
-
-    <%== partial 'commands/metadata', locals: { command: command } %>
-
-    <h2 class="h2">
-      <% if command[:type] == 'command' %>
-        Details
-      <% else %>
-        Backtraces
-      <% end %>
-    </h2>
-
-    <% if command[:type] == 'command' %>
-      <%== partial 'commands/command_details', locals: { command: command } %>
-    <% else %>
-      <% command[:result].each_value do |backtrace| %>
-        <%== partial 'commands/backtrace', locals: { backtrace: backtrace } %>
-      <% end %>
-    <% end %>
-  <% else %>
-    <% view_title 'Incompatible Command Schema' %>
-
-    <%== partial 'consumers/tabs' %>
-
-    <%== partial 'commands/incompatible_schema' %>
-  <% end %>
-</div>

data/lib/karafka/web/pro/ui/views/consumers/_breadcrumbs.erb

@@ -1,55 +0,0 @@
-<li>
-  <a href="<%= root_path('consumers/overview') %>">
-    Consumers
-  </a>
-</li>
-
-<% if current_path.include?('/performance') %>
-  <li>
-    <a href="<%= root_path('consumers', 'performance') %>">
-      Performance
-    </a>
-  </li>
-<% end %>
-
-<% if current_path.include?('/controls') %>
-  <li>
-    <a href="<%= root_path('consumers', 'controls') %>">
-      Controls
-    </a>
-  </li>
-<% end %>
-
-<% if @process %>
-  <li>
-    <a href="<%= root_path('consumers', @process.id, 'subscriptions') %>">
-      <%== truncate(@process.id, strategy: :middle) %>
-    </a>
-  </li>
-
-  <% if current_path.include?('/jobs') %>
-    <li>
-      <a href="<%= root_path('consumers', @process.id, 'jobs') %>">
-        Jobs
-      </a>
-    </li>
-
-    <li>
-      <a href="<%= root_path('consumers', @process.id, 'jobs') %>">
-        Running
-      </a>
-    </li>
-  <% elsif current_path.include?('/subscriptions') %>
-    <li>
-      <a href="<%= root_path('consumers', @process.id, 'subscriptions') %>">
-        Subscriptions
-      </a>
-    </li>
-  <% else %>
-    <li>
-      <a href="<%= root_path('consumers', @process.id, 'details') %>">
-        Details
-      </a>
-    </li>
-  <% end %>
-<% end %>

data/lib/karafka/web/pro/ui/views/consumers/_tabs.erb

@@ -1,33 +0,0 @@
-<div class="tab-container-wrapper">
-  <div class="tab-container">
-    <a
-      href="<%= root_path('consumers', 'overview') %>"
-      class="custom-tab <%= nav_class(include: 'overview') %>"
-    >
-      Overview
-    </a>
-
-    <a
-      href="<%= root_path('consumers', 'performance') %>"
-      class="custom-tab <%= nav_class(include: 'performance') %>"
-    >
-      Performance
-    </a>
-
-    <% if Karafka::Web.config.commanding.active %>
-      <a
-        href="<%= root_path('consumers', 'controls') %>"
-        class="custom-tab <%= nav_class(include: 'controls') %>"
-      >
-        Controls
-      </a>
-
-      <a
-        href="<%= root_path('commands') %>"
-        class="custom-tab <%= nav_class(include: 'commands') %>"
-      >
-        Commands
-      </a>
-    <% end %>
-  </div>
-</div>