karafka-web 0.10.0 → 0.10.1

data/lib/karafka/web/pro/ui/views/recurring_tasks/logs.erb

@@ -0,0 +1,34 @@
+<% view_title 'Logs' %>
+
+<%== partial 'recurring_tasks/tabs' %>
+
+<div class="col-span-12">
+  <% if @logs.empty? && params.current_page <= 1 %>
+    <%== alert_info('There are no available logs.') %>
+  <% elsif @logs.empty? %>
+    <%== partial 'shared/no_paginated_data' %>
+  <% else %>
+    <div class="data-table-wrapper">
+      <table class="data-table">
+        <thead>
+          <tr>
+            <th>Task ID</th>
+            <th>Result</th>
+            <th>Time Taken</th>
+            <th>Dispatched At</th>
+            <th>Schedule Version</th>
+          </tr>
+        </thead>
+        <tbody>
+          <%==
+            render_each(
+              @logs,
+              'recurring_tasks/_log',
+              local: :log
+            )
+          %>
+        </tbody>
+      </table>
+    </div>
+  <% end %>
+</div>

data/lib/karafka/web/pro/ui/views/recurring_tasks/schedule.erb

@@ -0,0 +1,43 @@
+<% if @schedule %>
+  <% view_title "Schedule #{@schedule.schedule_version}" %>
+<% else %>
+  <% view_title 'Schedule' %>
+<% end %>
+
+<% if @schedule %>
+  <%== partial 'recurring_tasks/tabs' %>
+
+  <% unless @tasks.empty? %>
+    <%== partial 'recurring_tasks/batch_actions' %>
+  <% end %>
+<% end %>
+
+<div class="col-span-12">
+  <% if @schedule && !@tasks.empty? %>
+    <div class="data-table-wrapper">
+      <table class="data-table">
+        <thead>
+          <tr>
+            <th><%== sort_link('Task ID', :id) %></th>
+            <th><%== sort_link('Status', :enabled) %></th>
+            <th><%== sort_link(:cron) %></th>
+            <th><%== sort_link(:previous_time) %></th>
+            <th><%== sort_link(:next_time) %></th>
+            <th></th>
+          </tr>
+        </thead>
+        <tbody>
+          <%==
+            render_each(
+              @tasks,
+              'recurring_tasks/_task',
+              local: :task
+            )
+          %>
+        </tbody>
+      </table>
+    </div>
+  <% else %>
+    <%== partial 'recurring_tasks/not_active' %>
+  <% end %>
+</div>

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

@@ -62,6 +62,16 @@
       </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: '/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/ui/helpers/application_helper.rb

@@ -309,7 +309,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 = '⇕'

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

@@ -0,0 +1,26 @@
+# 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 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,86 @@
+# 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 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,30 @@
+# 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 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)