karafka-web 0.10.0 → 0.10.2

data/lib/karafka/web/pro/ui/views/scheduled_messages/schedules/show.erb

@@ -0,0 +1,48 @@
+<% view_title @schedule_name %>
+
+<% @states.each do |partition, details| %>
+  <h3 class="h3">
+    Partition <%=  partition %>
+  </h3>
+
+  <% if details %>
+    <div class="data-table-wrapper">
+        <table class="data-table">
+        <thead>
+          <tr>
+            <th>Date</th>
+            <th>For Dispatch</th>
+          </tr>
+        </thead>
+        <tbody>
+          <% details[:daily].each do |date, for_dispatch| %>
+            <tr>
+              <td><%= date %></td>
+              <td><%= for_dispatch %></td>
+            </tr>
+          <% end %>
+        </tbody>
+      </table>
+
+      <p class="table_metadata">
+        Metadata:
+        <span class="badge">
+          Schema version: <%= details[:schema_version] %>
+        </span>
+
+        <span class="badge">
+          Reported at:&nbsp;
+          <%== relative_time(details[:dispatched_at]) %>
+        </span>
+
+        <span class="badge badge-<%= details[:state] == 'loaded' ? 'success' : 'warning' %>">
+          State: <%= details[:state] %>
+        </span>
+      </p>
+    </div>
+  <% else %>
+    <div class="mb-4">
+      <%== alert_warning 'No state information for this partition is available.' %>
+    </div>
+  <% end %>
+<% end %>

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

@@ -0,0 +1 @@
+<%== partial 'explorer/breadcrumbs' %>

data/lib/karafka/web/pro/ui/views/shared/_navigation.erb

@@ -62,6 +62,26 @@
       </a>
     </li>
 
+    <li>
+      <a
+        class="sidebar-nav-item <%= nav_class(start_with: '/recurring_tasks') %>"
+        href="<%= root_path('recurring_tasks') %>"
+      >
+        <%== icon(:arrow_path_rounded) %>
+        Cron
+      </a>
+    </li>
+
+    <li>
+      <a
+        class="sidebar-nav-item <%= nav_class(start_with: '/scheduled_messages') %>"
+        href="<%= root_path('scheduled_messages') %>"
+      >
+        <%== icon(:calendar) %>
+        Schedules
+      </a>
+    </li>
+
     <li>
       <a
         class="sidebar-nav-item <%= nav_class(start_with: '/errors') %>"

data/lib/karafka/web/pro/ui/views/topics/replication.erb

@@ -9,7 +9,7 @@
         <th><%== sort_link(:partition_id) %></th>
         <th><%== sort_link(:leader) %></th>
         <th><%== sort_link(:replica_count) %></th>
-        <th><%== sort_link('In sync brokers', :in_sync_replica_brokers) %></th>
+        <th><%== sort_link('In Sync Brokers', :in_sync_replica_brokers) %></th>
       </tr>
     </thead>
     <tbody>

data/lib/karafka/web/tracking/consumers/listeners/errors.rb

@@ -73,7 +73,9 @@ module Karafka
                 partition: consumer.partition,
                 first_offset: consumer.messages.metadata.first_offset,
                 last_offset: consumer.messages.metadata.last_offset,
-                committed_offset: consumer.coordinator.seek_offset - 1,
+                # We set it to -1000 if non-existent because after subtracting one, we will end up
+                # with -1001, which is "N/A" offset position for all the offsets here
+                committed_offset: (consumer.coordinator.seek_offset || -1_000) - 1,
                 consumer: consumer.class.to_s,
                 tags: consumer.tags
               }

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

@@ -133,7 +133,7 @@ module Karafka
         # @param query_data [Hash] query params we want to add to the current path
         path :current do |query_data = {}|
           # Merge existing request parameters with new query data
-          merged_params = request.params.deep_merge(query_data)
+          merged_params = deep_merge(request.params, query_data)
 
           # Flatten the merged parameters
           flattened_params = flatten_params('', merged_params)

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

@@ -28,13 +28,28 @@ module Karafka
 
           # Builds the render data object with assigned attributes based on instance variables.
           #
+          # @param attributes [Hash] attributes coming from the outside (in case of rebind)
           # @return [Responses::Render] data that should be used to render appropriate view
-          def render
-            attributes = {}
+          def render(attributes: {})
+            attributes = attributes.dup
+
+            full_parts = self.class.to_s.split('::')
+            separator = full_parts.index('Controllers')
+            base = full_parts[(separator + 1)..]
+
+            base.map!.with_index do |path_part, index|
+              if index == (base.size - 1)
+                path_part.gsub(/(.)([A-Z])/, '\1_\2').downcase.gsub('_controller', '')
+              else
+                path_part.gsub(/(.)([A-Z])/, '\1_\2').downcase
+              end
+            end
 
-            scope = self.class.to_s.split('::').last.gsub(/(.)([A-Z])/, '\1_\2').downcase.gsub('_controller', '')
+            scope = base.join('/')
             action = caller_locations(1, 1)[0].label.split('#').last
 
+            attributes[:breadcrums_scope] = scope
+
             instance_variables.each do |iv|
               next if iv.to_s.start_with?('@_')
               next if iv.to_s.start_with?('@params')

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

@@ -50,13 +50,6 @@ module Karafka
             object.to_s.include?('#<') ? object.class.to_s : object.to_s
           end
 
-          # Renders per scope breadcrumbs
-          def render_breadcrumbs
-            scope = request.path.delete_prefix(root_path).split('/')[0]
-
-            render "#{scope}/_breadcrumbs"
-          end
-
           # Takes a status and recommends background style color
           #
           # @param status [String] status
@@ -309,7 +302,14 @@ module Karafka
           def sort_link(name, attribute = nil, rev: false)
             unless attribute
               attribute = name
-              name = SORT_NAMES[attribute] || attribute.to_s.tr('_', ' ').tr('?', '').capitalize
+
+              if SORT_NAMES[attribute]
+                name = SORT_NAMES[attribute]
+              else
+                name = attribute.to_s.tr('_', ' ').tr('?', '')
+                # Always capitalize the name
+                name = name.split(' ').map(&:capitalize).join(' ')
+              end
             end
 
             arrow_both = '&#x21D5;'
@@ -369,6 +369,27 @@ module Karafka
           def icon(name)
             render "shared/icons/_#{name}"
           end
+
+          # Merges two hashes deeply, combining nested hashes recursively.
+          #
+          # @param hash1 [Hash] The first hash to merge.
+          # @param hash2 [Hash] The second hash to merge.
+          # @return [Hash] A new hash that is the result of a deep merge of the two provided hashes.
+          def deep_merge(hash1, hash2)
+            merged_hash = hash1.dup
+
+            hash2.each_pair do |k, v|
+              tv = merged_hash[k]
+
+              merged_hash[k] = if tv.is_a?(Hash) && v.is_a?(Hash)
+                                 deep_merge(tv, v)
+                               else
+                                 v
+                               end
+            end
+
+            merged_hash
+          end
         end
       end
     end

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

@@ -65,6 +65,24 @@ module Karafka
           def explorer_path(topic_name = nil, partition_id = nil, offset = nil, action = nil)
             root_path(*['explorer', topic_name, partition_id, offset, action].compact)
           end
+
+          # Helps build scheduled messages paths.
+          # Similar to the explorer helper one
+          # @param topic_name [String]
+          # @param partition_id [Integer, nil]
+          # @param offset [Integer, nil]
+          # @param action [String, nil]
+          # @return [String] path to the expected location
+          def scheduled_messages_explorer_path(
+            topic_name = nil,
+            partition_id = nil,
+            offset = nil,
+            action = nil
+          )
+            root_path(
+              *['scheduled_messages', 'explorer', topic_name, partition_id, offset, action].compact
+            )
+          end
         end
       end
     end

data/lib/karafka/web/ui/models/recurring_tasks/log.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Web
+    module Ui
+      module Models
+        module RecurringTasks
+          # Single log entry for recurring tasks execution
+          class Log < Lib::HashProxy
+          end
+        end
+      end
+    end
+  end
+end

data/lib/karafka/web/ui/models/recurring_tasks/schedule.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Web
+    module Ui
+      module Models
+        # Namespace for models representing recurring tasks related components taken from Kafka
+        module RecurringTasks
+          # Karafka schedule representation
+          class Schedule < Web::Ui::Lib::HashProxy
+            # Rdkafka errors we expect and handle gracefully
+            EXPECTED_RDKAFKA_ERRORS = %i[
+              unknown_topic
+              unknown_partition
+              unknown_topic_or_part
+            ].freeze
+
+            private_constant :EXPECTED_RDKAFKA_ERRORS
+
+            class << self
+              # @return [Schedule, false] current schedule or false if it was not possible to
+              #   get it because requested topic/partition does not exist or nothing was present
+              def current
+                messages = Karafka::Admin.read_topic(
+                  config.topics.schedules,
+                  0,
+                  # We work here with the assumption that users won't click so fast to load
+                  # more than 20 commands prior to a state flush. If that happens, this will
+                  # return false. This is a known and expected limitation.
+                  20
+                )
+
+                # Out of those messages we pick the most recent persisted schedule
+                candidate = messages
+                            .reverse
+                            .find { |message| message.key == 'state:schedule' }
+
+                # If there is a schedule message we use its data to build schedule, if not false
+                return false unless candidate
+
+                # If the deserializer is not our dedicated recurring tasks deserializer, it means
+                # that routing for recurring tasks was not loaded, so recurring tasks are not
+                # active
+                #
+                # User might have used recurring tasks previously and disabled them, but still may
+                # navigate to them and then we should not show anything because without the
+                # correct deserializer it will crash anyhow
+                return false unless candidate.metadata.deserializers.payload == config.deserializer
+
+                new(candidate.payload)
+              rescue Rdkafka::RdkafkaError => e
+                # If any of "topic missing" is raised, we return false but other errors we re-raise
+                raise(e) unless EXPECTED_RDKAFKA_ERRORS.any? { |code| e.code == code }
+
+                false
+              end
+
+              private
+
+              # @return [Karafka::Core::Configurable::Node]
+              def config
+                Karafka::App.config.recurring_tasks
+              end
+            end
+
+            # @return [Array<Task>] tasks of the current schedule
+            def tasks
+              @tasks ||= super.values.map { |task_hash| Task.new(task_hash) }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/karafka/web/ui/models/recurring_tasks/task.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Web
+    module Ui
+      module Models
+        module RecurringTasks
+          # Represents a single recurring task
+          class Task < Lib::HashProxy
+            # @return [Boolean] true if this task is enabled, otherwise false
+            def enabled?
+              enabled
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/karafka/web/ui/public/javascripts/application.js

@@ -119,4 +119,4 @@ function addListeners() {
 
 document.addEventListener('turbo:load', addListeners);
 
-Turbo.setProgressBarDelay(250)
+Turbo.setProgressBarDelay(100)