karafka-web 0.11.5 → 0.11.6

data/lib/karafka/web/ui/controllers/requests/params.rb

@@ -66,21 +66,21 @@ module Karafka
             def current_search
               return @current_search if @current_search
 
-              search = @request_params['search']
+              search = @request_params["search"]
 
               @current_search = search.is_a?(Hash) ? search : {}
             end
 
             # @return [String] sort query value
             def current_sort
-              @current_sort ||= @request_params['sort'].to_s.downcase
+              @current_sort ||= @request_params["sort"].to_s.downcase
             end
 
             # @return [Integer] current page for paginated views
             # @note It does basic sanitization
             def current_page
               @current_page ||= begin
-                page = @request_params['page'].to_i
+                page = @request_params["page"].to_i
 
                 page.positive? ? page : 1
               end
@@ -88,7 +88,7 @@ module Karafka
 
             # @return [String] Range type for charts we want to fetch
             def current_range
-              candidate = @request_params.fetch('range', 'seconds')
+              candidate = @request_params.fetch("range", "seconds")
               candidate = ALLOWED_RANGES.first unless ALLOWED_RANGES.include?(candidate)
               candidate.to_sym
             end
@@ -98,14 +98,14 @@ module Karafka
             #   is provided, we go with the high offset first page approach
             def current_offset
               @current_offset ||= begin
-                offset = @request_params.fetch('offset', -1).to_i
+                offset = @request_params.fetch("offset", -1).to_i
                 [offset, -1].max
               end
             end
 
             # @return [Integer] currently selected partition or -1 if nothing provided
             def current_partition
-              @current_partition ||= @request_params.fetch('partition', -1).to_i
+              @current_partition ||= @request_params.fetch("partition", -1).to_i
             end
           end
         end

data/lib/karafka/web/ui/helpers/application_helper.rb

@@ -11,22 +11,22 @@ module Karafka
           # Default attribute names mapped from the attributes themselves
           # It makes it easier as we do not have to declare those all the time
           SORT_NAMES = {
-            id: 'ID',
-            partition_id: 'Partition',
-            memory_usage: 'RSS',
-            started_at: 'Started',
-            committed_offset: 'Committed',
-            last_offset: 'Last',
-            first_offset: 'First',
-            lo_offset: 'Low',
-            hi_offset: 'High',
-            ls_offset: 'LSO',
-            lag_hybrid: 'Lag',
-            lag_stored: 'Stored',
-            stored_offset: 'Stored',
-            fetch_state: 'Fetch',
-            poll_state: 'Poll',
-            lso_risk_state: 'LSO'
+            id: "ID",
+            partition_id: "Partition",
+            memory_usage: "RSS",
+            started_at: "Started",
+            committed_offset: "Committed",
+            last_offset: "Last",
+            first_offset: "First",
+            lo_offset: "Low",
+            hi_offset: "High",
+            ls_offset: "LSO",
+            lag_hybrid: "Lag",
+            lag_stored: "Stored",
+            stored_offset: "Stored",
+            fetch_state: "Fetch",
+            poll_state: "Poll",
+            lso_risk_state: "LSO"
           }.freeze
 
           private_constant :SORT_NAMES
@@ -36,8 +36,8 @@ module Karafka
           def nav_class(location)
             comparator, value = location.to_a.first
 
-            local_location = request.path.gsub(env.fetch('SCRIPT_NAME'), '')
-            local_location.public_send(:"#{comparator}?", value) ? 'active' : ''
+            local_location = request.path.gsub(env.fetch("SCRIPT_NAME"), "")
+            local_location.public_send(:"#{comparator}?", value) ? "active" : ""
           end
 
           # Converts object into a string and for objects that would anyhow return their
@@ -47,7 +47,7 @@ module Karafka
           # @param object [Object]
           # @return [String]
           def object_value_to_s(object)
-            object.to_s.include?('#<') ? object.class.to_s : object.to_s
+            object.to_s.include?("#<") ? object.class.to_s : object.to_s
           end
 
           # Takes a status and recommends background style color
@@ -56,14 +56,14 @@ module Karafka
           # @return [String] background style
           def status_badge(status)
             case status
-            when 'initialized' then 'badge-success'
-            when 'supervising' then 'badge-success'
-            when 'running' then 'badge-success'
-            when 'quieting' then 'badge-warning'
-            when 'quiet' then 'badge-warning'
-            when 'stopping' then 'badge-warning'
-            when 'stopped' then 'badge-error'
-            when 'terminated' then 'badge-error'
+            when "initialized" then "badge-success"
+            when "supervising" then "badge-success"
+            when "running" then "badge-success"
+            when "quieting" then "badge-warning"
+            when "quiet" then "badge-warning"
+            when "stopping" then "badge-warning"
+            when "stopped" then "badge-error"
+            when "terminated" then "badge-error"
             else
               raise ::Karafka::Errors::UnsupportedCaseError, status
             end
@@ -74,9 +74,9 @@ module Karafka
           # @param trend [Numeric] lag trend
           # @return [String] bg classes
           def lag_trend_badge(trend)
-            bg = 'badge-success' if trend.negative?
-            bg ||= 'badge-warning' if trend.positive?
-            bg ||= 'badge-secondary'
+            bg = "badge-success" if trend.negative?
+            bg ||= "badge-warning" if trend.positive?
+            bg ||= "badge-secondary"
             bg
           end
 
@@ -87,7 +87,7 @@ module Karafka
           def tags(tags_array)
             tags_array
               .map { |tag| %(<span class="badge badge-info">#{tag}</span>) }
-              .join(' ')
+              .join(" ")
           end
 
           # Takes a kafka report state and recommends background style color
@@ -95,18 +95,18 @@ module Karafka
           # @return [String] background style
           def kafka_state_badge(state)
             case state
-            when 'up' then 'badge-success'
-            when 'active' then 'badge-success'
-            when 'steady' then 'badge-success'
+            when "up" then "badge-success"
+            when "active" then "badge-success"
+            when "steady" then "badge-success"
             else
-              'badge-warning'
+              "badge-warning"
             end
           end
 
           # @param mem_kb [Integer] memory used in KB
           # @return [String] formatted memory usage
           def format_memory(mem_kb)
-            return '0' if !mem_kb || mem_kb.zero?
+            return "0" if !mem_kb || mem_kb.zero?
 
             if mem_kb < 10_240
               "#{number_with_delimiter(mem_kb.round(4))} KB"
@@ -121,12 +121,12 @@ module Karafka
           # @param number [Numeric]
           # @param delimiter [String] delimiter (comma by default)
           # @return [String] number with delimiter
-          def number_with_delimiter(number, delimiter = ',')
-            return '' unless number
+          def number_with_delimiter(number, delimiter = ",")
+            return "" unless number
 
-            parts = number.to_s.to_str.split('.')
+            parts = number.to_s.to_str.split(".")
             parts[0].gsub!(/(\d)(?=(\d\d\d)+(?!\d))/, "\\1#{delimiter}")
-            parts.join('.')
+            parts.join(".")
           end
 
           # @param lag [Integer] lag
@@ -134,7 +134,7 @@ module Karafka
           # @see #offset_with_label
           def lag_with_label(lag)
             if lag.negative?
-              title = 'Not available until first offset commit'
+              title = "Not available until first offset commit"
               %(<span class="badge badge-secondary" title="#{title}">N/A</span>)
             else
               lag.to_s
@@ -150,7 +150,7 @@ module Karafka
           #   yet committed and there is no value we know of
           def offset_with_label(topic_name, partition_id, offset, explore: false)
             if offset.negative?
-              title = 'Not available until first offset commit'
+              title = "Not available until first offset commit"
               %(<span class="badge badge-secondary" title="#{title}">N/A</span>)
             elsif explore
               path = explorer_topics_path(topic_name, partition_id, offset)
@@ -166,7 +166,7 @@ module Karafka
           # @param value [Integer]
           # @return [String] input value if not negative or N/A
           def normalized_metric(value)
-            value.negative? ? 'N/A' : value.to_s
+            value.negative? ? "N/A" : value.to_s
           end
 
           # @param details [::Karafka::Web::Ui::Models::Partition] partition information with
@@ -175,11 +175,11 @@ module Karafka
           def lso_risk_state_bg(details)
             case details.lso_risk_state
             when :active
-              ''
+              ""
             when :at_risk
-              'bg-warning bg-opacity-25'
+              "bg-warning bg-opacity-25"
             when :stopped
-              'bg-error bg-opacity-25'
+              "bg-error bg-opacity-25"
             else
               raise ::Karafka::Errors::UnsupportedCaseError
             end
@@ -191,11 +191,11 @@ module Karafka
           def lso_risk_state_badge(details)
             case details.lso_risk_state
             when :active
-              ''
+              ""
             when :at_risk
-              'badge-warning'
+              "badge-warning"
             when :stopped
-              'badge-error'
+              "badge-error"
             else
               raise ::Karafka::Errors::UnsupportedCaseError
             end
@@ -245,15 +245,15 @@ module Karafka
               if SORT_NAMES[attribute]
                 name = SORT_NAMES[attribute]
               else
-                name = attribute.to_s.tr('_', ' ').tr('?', '')
+                name = attribute.to_s.tr("_", " ").tr("?", "")
                 # Always capitalize the name
-                name = name.split.map(&:capitalize).join(' ')
+                name = name.split.map(&:capitalize).join(" ")
               end
             end
 
-            arrow_both = '&#x21D5;'
-            arrow_down = '&#9662;'
-            arrow_up = '&#9652;'
+            arrow_both = "&#x21D5;"
+            arrow_down = "&#9662;"
+            arrow_up = "&#9652;"
 
             desc = "#{attribute} desc"
             asc = "#{attribute} asc"
@@ -286,7 +286,7 @@ module Karafka
           # @param omission [String] truncation omission
           # @param strategy [Symbol] `:default` or `:middle` how should we truncate
           # @return [String] HTML span tag with truncated content and full content title
-          def truncate(string, length: 50, omission: '...', strategy: :default)
+          def truncate(string, length: 50, omission: "...", strategy: :default)
             return string if string.length <= length
 
             case strategy
@@ -321,10 +321,10 @@ module Karafka
               tv = merged_hash[k]
 
               merged_hash[k] = if tv.is_a?(Hash) && v.is_a?(Hash)
-                                 deep_merge(tv, v)
-                               else
-                                 v
-                               end
+                deep_merge(tv, v)
+              else
+                v
+              end
             end
 
             merged_hash

data/lib/karafka/web/ui/helpers/paths_helper.rb

@@ -48,7 +48,7 @@ module Karafka
           #   mounted in a sub-path and we need to make sure our all paths are relative to "our"
           #   root, not the root of the app in which it was mounted.
           def root_path(*args)
-            "#{env.fetch('SCRIPT_NAME')}/#{args.join('/')}"
+            "#{env.fetch("SCRIPT_NAME")}/#{args.join("/")}"
           end
 
           # Generates a full path to any asset with our web-ui version. We ship all assets with
@@ -66,7 +66,7 @@ module Karafka
           # @param args [Array<String>] sub-paths
           # @return [String] path to the expected location
           def explorer_path(*args)
-            root_path(*['explorer', args.compact].flatten)
+            root_path(*["explorer", args.compact].flatten)
           end
 
           # Generates routes for explorer topics paths
@@ -74,7 +74,7 @@ module Karafka
           # @param args [Array<String>] sub-paths
           # @return explorer topics path
           def explorer_topics_path(*args)
-            explorer_path(*['topics', args.compact].flatten)
+            explorer_path(*["topics", args.compact].flatten)
           end
 
           # Generates routes for explorer messages paths
@@ -82,21 +82,21 @@ module Karafka
           # @param args [Array<String>] sub-paths
           # @return [String] explorer messages path
           def explorer_messages_path(*args)
-            explorer_path(*['messages', args.compact].flatten)
+            explorer_path(*["messages", args.compact].flatten)
           end
 
           # Helps build topics paths
           #
           # @return [String] topics scope path
           def topics_path(*)
-            root_path('topics', *)
+            root_path("topics", *)
           end
 
           # Helps build consumers paths
           #
           # @return [String] consumers scope path
           def consumers_path(*)
-            root_path('consumers', *)
+            root_path("consumers", *)
           end
 
           # Helps build per-consumer scope paths
@@ -121,7 +121,15 @@ module Karafka
             action = nil
           )
             root_path(
-              *['scheduled_messages', 'explorer', 'topics', topic_name, partition_id, offset, action].compact
+              *[
+                "scheduled_messages",
+                "explorer",
+                "topics",
+                topic_name,
+                partition_id,
+                offset,
+                action
+              ].compact
             )
           end
         end

data/lib/karafka/web/ui/helpers/tailwind_helper.rb

@@ -26,7 +26,7 @@ module Karafka
           # @param content [String] badge content
           # @param classes [String] extra css classes
           # @return [String] badge html
-          def badge(content, classes: '')
+          def badge(content, classes: "")
             %(<span class="badge #{classes}">#{content}</span>)
           end
 
@@ -36,26 +36,26 @@ module Karafka
           # @param classes [String] extra css classes
           # @param title [String, nil] title (if any)
           # @return [String] button link html
-          def link_button(name, path, classes: '', title: nil)
+          def link_button(name, path, classes: "", title: nil)
             %(<a href="#{path}" class="btn #{classes}" title="#{title}">#{name}</a>)
           end
 
           # Defines various methods for badges and links that simplify defining them without
           # having to provide whole classes scopes always.
           TYPES.each do |type|
-            define_method :"badge_#{type}" do |content, classes: ''|
+            define_method :"badge_#{type}" do |content, classes: ""|
               badge(content, classes: "#{classes} badge-#{type}")
             end
 
-            define_method :"badge_#{type}_sm" do |content, classes: ''|
+            define_method :"badge_#{type}_sm" do |content, classes: ""|
               badge(content, classes: "#{classes} badge-#{type} badge-sm")
             end
 
-            define_method :"link_button_#{type}" do |name, path, classes: ''|
+            define_method :"link_button_#{type}" do |name, path, classes: ""|
               link_button(name, path, classes: "#{classes} btn-#{type}")
             end
 
-            define_method :"link_button_#{type}_sm" do |name, path, classes: '', title: nil|
+            define_method :"link_button_#{type}_sm" do |name, path, classes: "", title: nil|
               link_button(name, path, classes: "#{classes} btn-#{type} btn-sm", title: title)
             end
 

data/lib/karafka/web/ui/helpers/time_helper.rb

@@ -51,7 +51,7 @@ module Karafka
             state_ch_in_seconds = state_ch / 1_000.0
 
             # If state is active, there is no date of change
-            if state == 'active'
+            if state == "active"
               %(
                 <span class="badge #{kafka_state_badge(state)}">#{state}</span>
               )

data/lib/karafka/web/ui/helpers/topics_helper.rb

@@ -59,9 +59,9 @@ module Karafka
               # Apply limit if specified and partitions exceed it
               elsif limit && sorted_partitions.size > limit
                 displayed_partitions = sorted_partitions.first(limit)
-                "#{topic}-[#{displayed_partitions.join(',')}...]"
+                "#{topic}-[#{displayed_partitions.join(",")}...]"
               else
-                "#{topic}-[#{sorted_partitions.join(',')}]"
+                "#{topic}-[#{sorted_partitions.join(",")}]"
               end
             end
           end
@@ -97,9 +97,9 @@ module Karafka
             elsif sorted_partitions.size > limit
               displayed = sorted_partitions.first(limit)
               remaining = sorted_partitions.size - limit
-              "#{topic}-[#{displayed.join(',')}] (+#{remaining} more)"
+              "#{topic}-[#{displayed.join(",")}] (+#{remaining} more)"
             else
-              "#{topic}-[#{sorted_partitions.join(',')}]"
+              "#{topic}-[#{sorted_partitions.join(",")}]"
             end
           end
 

data/lib/karafka/web/ui/lib/admin.rb

@@ -24,8 +24,8 @@ module Karafka
             # @param name [String, Symbol] topic name
             # @param partition [Integer] partition
             # @param count [Integer] how many messages we want to get at most
-            # @param start_offset [Integer, Time] offset from which we should start. If -1 is provided
-            #   (default) we will start from the latest offset. If time is provided, the appropriate
+            # @param start_offset [Integer, Time] offset from which we should start. If -1 is
+            #   provided (default) we will start from the latest offset. If time is provided, the
             #   offset will be resolved. If negative beyond -1 is provided, we move backwards more.
             # @param settings [Hash] kafka extra settings (optional)
             #

data/lib/karafka/web/ui/lib/paginations/base.rb

@@ -17,41 +17,41 @@ module Karafka
 
             # @return [Boolean] Should we show pagination at all
             def paginate?
-              raise NotImplementedError, 'Implement in a subclass'
+              raise NotImplementedError, "Implement in a subclass"
             end
 
             # @return [Boolean] Should first offset link be active. If false, the first offset link
             #   will be disabled
             def first_offset?
-              raise NotImplementedError, 'Implement in a subclass'
+              raise NotImplementedError, "Implement in a subclass"
             end
 
             # @return [String] first offset url value
             def first_offset
-              raise NotImplementedError, 'Implement in a subclass'
+              raise NotImplementedError, "Implement in a subclass"
             end
 
             # @return [Boolean] Should previous offset link be active. If false, the previous
             #   offset link will be disabled
             def previous_offset?
-              raise NotImplementedError, 'Implement in a subclass'
+              raise NotImplementedError, "Implement in a subclass"
             end
 
             # @return [Boolean] Should we show current offset. If false, the current offset link
             #   will not be visible at all. Useful for non-linear pagination.
             def current_offset?
-              raise NotImplementedError, 'Implement in a subclass'
+              raise NotImplementedError, "Implement in a subclass"
             end
 
             # @return [Boolean] Should we show next offset pagination. If false, next offset link
             #   will be disabled.
             def next_offset?
-              raise NotImplementedError, 'Implement in a subclass'
+              raise NotImplementedError, "Implement in a subclass"
             end
 
             # @return [String] the url offset key
             def offset_key
-              raise NotImplementedError, 'Implement in a subclass'
+              raise NotImplementedError, "Implement in a subclass"
             end
           end
         end

data/lib/karafka/web/ui/lib/paginations/offset_based.rb

@@ -80,12 +80,12 @@ module Karafka
             def current_label
               first = @visible_offsets.first
               last = @visible_offsets.last
-              [first, last].compact.uniq.join(' - ').to_s
+              [first, last].compact.uniq.join(" - ").to_s
             end
 
             # @return [String] for offset based pagination we use the offset param name
             def offset_key
-              'offset'
+              "offset"
             end
           end
         end

data/lib/karafka/web/ui/lib/paginations/page_based.rb

@@ -60,7 +60,7 @@ module Karafka
 
             # @return [String] for page pages pagination, always use page as the url value
             def offset_key
-              'page'
+              "page"
             end
           end
         end

data/lib/karafka/web/ui/lib/paginations/paginators/arrays.rb

@@ -13,9 +13,9 @@ module Karafka
               class << self
                 # @param array [Array] array we want to paginate
                 # @param current_page [Integer] page we want to be on
-                # @return [Array<Array, Boolean>] Array with two elements: first is the array with
-                #   data of the given page and second is a boolean flag with info if the elements we got
-                #   are from the last page
+                # @return [Array<Array, Boolean>] Array with two elements: first is the array
+                #   with data of the given page and second is a boolean flag with info if the
+                #   elements we got are from the last page
                 def call(array, current_page)
                   slices = array.each_slice(per_page).to_a
                   current_data = slices[current_page - 1] || []

data/lib/karafka/web/ui/lib/paginations/watermark_offsets_based.rb

@@ -65,7 +65,7 @@ module Karafka
 
             # @return [String] params offset key
             def offset_key
-              'offset'
+              "offset"
             end
           end
         end

data/lib/karafka/web/ui/lib/sorter.rb

@@ -30,7 +30,7 @@ module Karafka
             # Normalize the key since we do not operate on capitalized values
             @field = field.to_s.downcase
 
-            @field = '' unless allowed_attributes.include?(@field)
+            @field = "" unless allowed_attributes.include?(@field)
 
             # Things we have already seen and sorted. Prevents crashing on the circular
             # dependencies sorting when same resources are present in different parts of the tree
@@ -135,7 +135,7 @@ module Karafka
 
           # @return [Boolean] true if we sort in desc, otherwise false
           def desc?
-            @order == 'desc'
+            @order == "desc"
           end
 
           # Extracts the attribute based on which we should sort (if present)

data/lib/karafka/web/ui/models/counters.rb

@@ -42,7 +42,7 @@ module Karafka
               # Most of the users use one or few error partitions at most, so this is fairly
               # efficient and not problematic
               rescue Rdkafka::RdkafkaError => e
-                e.code == :unknown_partition ? break : raise
+                (e.code == :unknown_partition) ? break : raise
               end
 
               estimated += offsets.last - offsets.first

data/lib/karafka/web/ui/models/health.rb

@@ -66,6 +66,7 @@ module Karafka
                 stats[cg_id][:topics][t_name][:partitions][pt_id] = partition
                 stats[cg_id][:topics][t_name][:partitions][pt_id][:process] = process
                 stats[cg_id][:topics][t_name][:partitions][pt_id][:subscription_group_id] = sg_id
+                stats[cg_id][:topics][t_name][:partitions][pt_id][:instance_id] = subscription_group.instance_id
               end
             end
 

data/lib/karafka/web/ui/models/jobs.rb

@@ -21,12 +21,12 @@ module Karafka
 
           # @return [Jobs] running jobs
           def running
-            select { |job| job.status == 'running' }
+            select { |job| job.status == "running" }
           end
 
           # @return [Jobs] pending jobs
           def pending
-            select { |job| job.status == 'pending' }
+            select { |job| job.status == "pending" }
           end
 
           # Creates a new Jobs object with selected jobs

data/lib/karafka/web/ui/models/message.rb

@@ -39,14 +39,14 @@ module Karafka
               # requested offset is within the range and if so, it means it has been cleaned or
               # is a system entry. In such cases we do display user an info message.
               return nil if watermark_offsets &&
-                            offset >= watermark_offsets.low &&
-                            offset < watermark_offsets.high
+                offset >= watermark_offsets.low &&
+                offset < watermark_offsets.high
 
               # If beyond the watermark offsets, we raise 404 as user should not reach such
               # non-existent messages as we cannot reason about them
               raise(
                 ::Karafka::Web::Errors::Ui::NotFoundError,
-                [topic_id, partition_id, offset].join(', ')
+                [topic_id, partition_id, offset].join(", ")
               )
             end
 
@@ -111,7 +111,7 @@ module Karafka
                   # We do not reset the offset here because we are not interested in seeking from
                   # any offset. We are interested in the indication, that there is no offset of a
                   # given value so we can try with a more recent one
-                  'auto.offset.reset': 'error'
+                  "auto.offset.reset": "error"
                 )
 
                 next unless messages
@@ -126,11 +126,11 @@ module Karafka
                   previous_offset
                 end
 
-                return [
-                  previous_offset,
-                  fill_compacted(messages, partition_id, context_offset, context_count, high_offset).reverse,
-                  next_offset
-                ]
+                filled = fill_compacted(
+                  messages, partition_id, context_offset, context_count, high_offset
+                )
+
+                return [previous_offset, filled.reverse, next_offset]
               end
 
               no_data_result