karafka-web 0.10.0 → 0.10.2

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

@@ -0,0 +1,58 @@
+<%
+  trigger_path = root_path('recurring_tasks', task.id, 'trigger')
+  disabled_class = task.enabled? ? '' : 'btn-disabled'
+%>
+<form
+  action="<%= trigger_path %>"
+  method="post"
+  class="inline"
+>
+  <%== csrf_tag(trigger_path) %>
+  <button
+    type="submit"
+    class="btn btn-primary btn-sm  "
+    title="Trigger"
+  >
+    <%== icon(:play) %>
+  </button>
+</form>
+
+<%
+  enable_path = root_path('recurring_tasks', task.id, 'enable')
+  disabled_class = task.enabled? ? 'btn-disabled' : ''
+%>
+<form
+  action="<%= enable_path %>"
+  method="post"
+  class="inline"
+  title="Enable"
+>
+  <%== csrf_tag(enable_path) %>
+  <button
+    type="submit"
+    class="btn btn-success btn-sm   <%= disabled_class %>"
+  >
+    <%== icon(:check) %>
+  </button>
+</form>
+
+<%
+  disable_path = root_path('recurring_tasks', task.id, 'disable')
+  disabled_class = task.enabled? ? '' : 'btn-disabled'
+%>
+<form
+  action="<%= disable_path %>"
+  method="post"
+  class="inline"
+  title="Disable"
+
+>
+  <%== csrf_tag(disable_path) %>
+  <button
+    type="submit"
+    class="btn btn-warning btn-sm  <%= disabled_class %>"
+
+  >
+    <%== icon(:pause) %>
+  </button>
+</form>

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

@@ -0,0 +1,45 @@
+<div class="col-span-12 flex justify-end space-x-2 mb-6">
+  <%
+    trigger_all_path = root_path('recurring_tasks', 'trigger_all')
+    disable_class = @tasks.empty? ? 'btn-disabled' : ''
+  %>
+  <form
+    action="<%= trigger_all_path %>"
+    method="post"
+    class="inline-flex items-center"
+  >
+    <%== csrf_tag(trigger_all_path) %>
+    <button type="submit" class="btn btn-primary btn-sm <%= disable_class %>">
+      <%== icon(:play) %>
+      Trigger All
+    </button>
+  </form>
+
+  <%
+    enable_all_path = root_path('recurring_tasks', 'enable_all')
+    disable_class = @tasks.all?(&:enabled?) ? 'btn-disabled' : ''
+  %>
+  <form
+    action="<%= enable_all_path %>"
+    method="post"
+    class="inline-flex items-center"
+  >
+    <%== csrf_tag(enable_all_path) %>
+    <button type="submit" class="btn btn-success btn-sm <%= disable_class %>">
+      <%== icon(:check) %>
+      Enable All
+    </button>
+  </form>
+
+  <%
+    disable_all_path = root_path('recurring_tasks', 'disable_all')
+    disable_class = @tasks.none?(&:enabled?) ? 'btn-disabled' : ''
+  %>
+  <form action="<%= disable_all_path %>" method="post" class="inline-flex items-center">
+    <%== csrf_tag(disable_all_path) %>
+    <button type="submit" class="btn btn-warning btn-sm <%= disable_class %>">
+      <%== icon(:pause) %>
+      Disable All
+    </button>
+  </form>
+</div>

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

@@ -0,0 +1,22 @@
+<li>
+  <a href="<%= root_path('recurring_tasks') %>">
+    Recurring Tasks
+  </a>
+</li>
+
+<% if current_path.include?('/schedule') %>
+  <li>
+    <a href="<%= root_path('recurring_tasks/schedule') %>">
+      Schedule
+      <%= @schedule ? @schedule.schedule_version : '' %>
+    </a>
+  </li>
+<% end %>
+
+<% if current_path.include?('/logs') %>
+  <li>
+    <a href="<%= root_path('recurring_tasks/logs') %>">
+      Logs
+    </a>
+  </li>
+<% end %>

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

@@ -0,0 +1,26 @@
+<% result = log.task[:result] == 'success' %>
+<tr class="<%= result ? '' : 'status-row-error' %>">
+  <td>
+    <%= log.id %>
+  </td>
+  <td>
+    <% if result %>
+      <%== badge_success 'Success' %>
+    <% else %>
+      <%== badge_error 'Error' %>
+    <% end %>
+  </td>
+  <td>
+    <% if result %>
+      <%== log.task[:time_taken].round(2) %> ms
+    <% else %>
+      N/A
+    <% end %>
+  </td>
+  <td>
+    <%== relative_time log.dispatched_at %>
+  </td>
+  <td>
+    <%= log.schedule_version %>
+  </td>
+</tr>

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

@@ -0,0 +1,12 @@
+<% alert_box_info('Recurring Tasks Data Unavailable') do %>
+  <p class="mb-2">
+    We are unable to display data related to recurring tasks. Please ensure that:
+  </p>
+
+  <ul class="list-disc list-inside">
+    <li>Recurring Tasks are enabled in your routing configuration.</li>
+    <li>The necessary Kafka topics have been created.</li>
+    <li>A schedule has been defined.</li>
+    <li>Your Karafka server, with schedule awareness, is running and has persisted the state.</li>
+  </ul>
+<% end %>

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

@@ -0,0 +1,17 @@
+<div class="col-span-12 mb-9">
+  <div class="tab-container">
+    <a
+      href="<%= root_path('recurring_tasks', 'schedule') %>"
+      class="custom-tab <%= nav_class(include: 'schedule') %>"
+    >
+      Schedules
+    </a>
+
+    <a
+      href="<%= root_path('recurring_tasks', 'logs') %>"
+      class="custom-tab <%= nav_class(include: '/logs') %>"
+    >
+      Logs
+    </a>
+  </div>
+</div>

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

@@ -0,0 +1,46 @@
+<tr class="<%= task.enabled? ? '' : 'status-row-warning text-muted' %>">
+  <td>
+      <%= task.id %>
+  </td>
+
+  <td>
+    <% if task.enabled? %>
+      <%== badge_success('Enabled') %>
+    <% else %>
+      <%== badge_warning('Disabled') %>
+    <% end %>
+  </td>
+
+  <td>
+    <code><%= task.cron %></code>
+  </td>
+
+  <td>
+    <% if task.previous_time.positive? %>
+      <%== relative_time task.previous_time %>
+    <% else %>
+      Never
+    <% end %>
+  </td>
+
+  <td>
+    <% if task.enabled? %>
+      <% if task.next_time < Time.now.to_i %>
+        Right now
+      <% else %>
+        <%== relative_time task.next_time %>
+      <% end %>
+    <% else %>
+      Never
+    <% end %>
+  </td>
+
+  <td class="commands-inline-3">
+    <%==
+      partial(
+        'recurring_tasks/actions',
+        locals: { task: task }
+      )
+    %>
+  </td>
+</tr>

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/scheduled_messages/explorer/_breadcrumbs.erb

@@ -0,0 +1,30 @@
+<li>
+  <a href="<%= root_path('scheduled_messages') %>">
+    Scheduled Messages
+  </a>
+</li>
+
+<% if current_path.include?('/explorer') %>
+  <li>
+    <a href="<%= root_path("scheduled_messages/explorer/#{@topic_id}") %>">
+      Messages
+    </a>
+  </li>
+<% end %>
+
+<% if @topic_id %>
+  <li>
+    <a href="<%= root_path("scheduled_messages/explorer/#{@topic_id}") %>">
+      <%= @topic_id %>
+    </a>
+  </li>
+<% end %>
+
+<% if @partition_id %>
+  <li>
+    <a href="<%= root_path("scheduled_messages/explorer/#{@topic_id}/#{@partition_id}") %>">
+      Partition
+      <%= @partition_id %>
+    </a>
+  </li>
+<% end %>

data/lib/karafka/web/pro/ui/views/scheduled_messages/explorer/_message.erb

@@ -0,0 +1,84 @@
+<% safe_key = ::Karafka::Web::Pro::Ui::Lib::SafeRunner.new { message.key } %>
+
+<% if message.is_a?(Array) %>
+  <tr>
+    <td class="text-muted">
+      <%= message[0] %>
+    </td>
+    <td class="text-muted">
+      <%= message[1] %>
+    </td>
+    <td colspan="8" class="text-center text-muted">
+      This offset does not contain any data. The message may have been compacted or is a system entry.
+    </td>
+  </tr>
+<% else %>
+  <% type = message.headers['schedule_source_type'] %>
+  <tr>
+    <td>
+      <%= message.partition %>
+    </td>
+    <td>
+      <%= message.offset %>
+    </td>
+    <td>
+      <% if type == 'tombstone' %>
+        <%== badge_secondary type %>
+      <% end %>
+
+      <% if type == 'cancel' %>
+        <%== badge_warning type %>
+      <% end %>
+
+      <% if type == 'schedule' %>
+        <%== badge_primary type %>
+      <% end %>
+    </td>
+    <td>
+      <%= message.headers['schedule_schema_version'] %>
+    </td>
+
+    <% if type == 'cancel' %>
+      <td colspan="5" class="text-center text-muted">
+        Cancellation messages do not contain those details.
+      </td>
+    <% else %>
+      <td>
+        <%== relative_time(message.timestamp) %>
+      </td>
+      <td>
+        <%== relative_time message.headers['schedule_target_epoch'].to_i %>
+      </td>
+      <td>
+        <% if @visibility_filter.key?(message) %>
+          <% if safe_key.success? %>
+            <%= safe_key.result %>
+          <% else %>
+            <span class="text-muted">[Deserialization Failed]</span>
+          <% end %>
+        <% else %>
+          <span class="text-muted">[Filtered]</span>
+        <% end %>
+      </td>
+      <td>
+        <%= message.headers['schedule_target_topic'] %>
+      </td>
+      <td>
+        <% if @visibility_filter.key?(message) %>
+          <%= message.headers['schedule_target_key'] %>
+        <% else %>
+          <span class="text-muted">[Filtered]</span>
+        <% end %>
+      </td>
+    <% end %>
+
+    <td>
+      <%==
+        link_button_primary_sm(
+          'Details',
+          explorer_path(message.topic, message.partition, message.offset)
+        )
+      %>
+    </td>
+  </tr>
+<% end %>

data/lib/karafka/web/pro/ui/views/scheduled_messages/explorer/_messages.erb

@@ -0,0 +1,28 @@
+<div class="data-table-wrapper">
+  <table class="data-table">
+    <thead>
+      <tr>
+        <th>Partition</th>
+        <th>Offset</th>
+        <th>Type</th>
+        <th>Schema</th>
+        <th>Created At</th>
+        <th>Dispatch At</th>
+        <th>Key</th>
+        <th>Target Topic</th>
+        <th>Target Key</th>
+        <th></th>
+      </tr>
+    </thead>
+    <tbody>
+      <%==
+        each_partial(
+          @messages,
+          'scheduled_messages/explorer/message'
+        )
+      %>
+    </tbody>
+  </table>
+
+  <%== content_for :table_metadata %>
+</div>

data/lib/karafka/web/pro/ui/views/scheduled_messages/explorer/partition.erb

@@ -0,0 +1,72 @@
+<% view_title "#{@topic_id} partition #{@partition_id}" %>
+
+<% @selector_path_method = :scheduled_messages_explorer_path %>
+
+<div class="col-span-4">
+  <section class="actions">
+    <% if @messages && !@messages.empty? %>
+      <a
+        href="<%= explorer_path(@topic_id, @partition_id, 'recent') %>"
+        class="btn-action"
+        title="Display the most recent message for this partition with auto-refresh"
+      >
+        <%== icon(:play_circle) %>
+      </a>
+
+      <a
+        href="<%= explorer_path(@topic_id, 'search', "?partition=#{@partition_id}") %>"
+        class="btn-action"
+        title="Search in this topic"
+      >
+        <%== icon(:magnifying_glass) %>
+      </a>
+
+      <% closest_path = scheduled_messages_explorer_path(@topic_id, @partition_id) %>
+      <input
+        type="image"
+        src="<%= asset_path('images/calendar.svg') %>"
+        width="45"
+        height="32"
+        class="btn-action p-1 opacity-60"
+        id="offset-lookup-datepicker"
+        value=""
+        data-target="<%= closest_path %>"
+      />
+    <% end %>
+  </section>
+</div>
+
+<div class="col-span-8 mb-3">
+  <section class="actions">
+    <%== partial 'explorer/selector' %>
+  </section>
+</div>
+
+<div class="col-span-12">
+  <% if @limited %>
+    <%== partial('explorer/topic/limited') %>
+  <% end %>
+
+  <% if @watermark_offsets.empty? && params.current_page == 1 %>
+    <%== partial 'explorer/partition/empty' %>
+  <% elsif @watermark_offsets.cleaned? && params.current_page == 1 %>
+    <%== partial 'explorer/partition/cleaned' %>
+  <% elsif @messages.empty? %>
+    <%== partial 'shared/no_paginated_data' %>
+  <% else %>
+    <% content_for :table_metadata do %>
+      <p class="table_metadata">
+        Watermark offsets:
+        <span class="badge badge-secondary mt-1 mb-1">
+          high: <%= @watermark_offsets.high %>
+        </span>
+
+        <span class="badge badge-secondary mt-1 mb-1">
+          low: <%= @watermark_offsets.low %>
+        </span>
+      </p>
+    <% end %>
+
+    <%== partial('scheduled_messages/explorer/messages') %>
+  <% end %>
+</div>

data/lib/karafka/web/pro/ui/views/scheduled_messages/explorer/topic.erb

@@ -0,0 +1,33 @@
+<% view_title @topic_id %>
+
+<% @selector_path_method = :scheduled_messages_explorer_path %>
+
+<%== partial 'explorer/topic/actions' %>
+
+<div class="col-span-12">
+  <% if @limited %>
+    <div class="mb-6">
+      <%== partial('explorer/topic/limited') %>
+    </div>
+  <% end %>
+
+  <% if @messages.empty? && params.current_page == 1 %>
+    <%== partial 'explorer/topic/empty' %>
+  <% elsif @messages.empty? %>
+    <%== partial 'shared/no_paginated_data' %>
+  <% else %>
+    <% content_for :table_metadata do %>
+      <p class="table_metadata">
+        Partitions:
+
+        <%== badge("total: #{@partitions_count}") %>
+        <%==
+          range = [@active_partitions.first, @active_partitions.last].uniq.join(' to ')
+          badge("visible: #{range}")
+        %>
+      </p>
+    <% end %>
+
+    <%== partial('scheduled_messages/explorer/messages') %>
+  <% end %>
+</div>

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

@@ -0,0 +1,21 @@
+<li>
+  <a href="<%= root_path('scheduled_messages') %>">
+    Scheduled Messages
+  </a>
+</li>
+
+<% if current_path.include?('/schedules') %>
+  <li>
+    <a href="<%= root_path('scheduled_messages/schedules') %>">
+      Schedules
+    </a>
+  </li>
+<% end %>
+
+<% if @schedule_name %>
+  <li>
+    <a href="<%= root_path("scheduled_messages/schedules/#{@schedule_name}") %>">
+      <%= @schedule_name %>
+    </a>
+  </li>
+<% end %>

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

@@ -0,0 +1,11 @@
+<% alert_box_info 'Scheduled Messages Data Not Available' do %>
+  <p class="mb-2">
+    We are unable to display data related to scheduled messages. Please ensure that:
+  </p>
+
+  <ul class="list-disc list-inside">
+    <li>Scheduled Messages are enabled in your routing configuration.</li>
+    <li>The necessary Kafka topics have been created.</li>
+    <li>Your Karafka server, with scheduled messages awareness, is running and has persisted the state.</li>
+  </ul>
+<% end %>

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

@@ -0,0 +1,38 @@
+<% view_title 'Schedules' %>
+
+<div class="col-span-12">
+  <% if @topics.empty? %>
+    <%== partial 'scheduled_messages/schedules/no_groups' %>
+  <% else %>
+    <% @topics.each do |topic| %>
+      <div class="grid grid-cols-1 md:grid-cols-2 gap-8">
+        <div class="card-support">
+          <h3>
+            <%== icon(:calendar) %>
+            <span>
+              <%= topic.topic_name %>
+              /
+              <%= topic.partition_count %>
+            </span>
+          </h3>
+
+          <p class="flex justify-center space-x-2 mb-3">
+            <a
+              href="<%= root_path("scheduled_messages/schedules/#{topic.topic_name}") %>"
+              class="btn btn-primary btn-sm flex-1"
+            >
+              Planned
+            </a>
+
+            <a
+              href="<%= root_path("scheduled_messages/explorer/#{topic.topic_name}") %>"
+              class="btn btn-primary btn-sm flex-1"
+            >
+              Messages
+            </a>
+          </p>
+        </div>
+      </div>
+    <% end %>
+  <% end %>
+</div>