karafka-web 0.10.4 → 0.11.0

data/lib/karafka/web/pro/ui/views/consumers/{controls.erb → controls/index.erb}

@@ -1,11 +1,14 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
 <% view_title 'Consumers Controls' %>
 
-<%== partial 'consumers/tabs' %>
+<%== partial 'consumers/consumers/tabs' %>
 
 <% unless @processes.empty? %>
   <div class="col-span-12 flex justify-end space-x-2 mb-6">
     <%
-      quiet_all_path = root_path('commanding', 'quiet_all')
+      quiet_all_path = consumers_path('commanding', 'quiet_all')
     %>
     <form action="<%= quiet_all_path %>" method="post" class="inline-flex items-center">
       <%== csrf_tag(quiet_all_path) %>
@@ -16,7 +19,7 @@
     </form>
 
     <%
-      stop_all_path = root_path('commanding', 'stop_all')
+      stop_all_path = consumers_path('commanding', 'stop_all')
     %>
     <form action="<%= stop_all_path %>" method="post" class="inline-flex items-center">
       <%== csrf_tag(stop_all_path) %>
@@ -38,7 +41,7 @@
       <table class="data-table">
         <thead>
           <tr>
-            <th><%== sort_link(:id) %></th>
+            <th><%== sort_link('Process ID', :id) %></th>
             <th><%== sort_link(:status) %></th>
             <th>Subscriptions</th>
             <th><%== sort_link(:started_at, rev: true) %></th>
@@ -52,7 +55,7 @@
           <%==
             render_each(
               @processes,
-              'consumers/_consumer_controls',
+              'consumers/controls/_controls',
               local: :process
             )
           %>

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

@@ -0,0 +1,36 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
+<li>
+  <a href="<%= consumers_path('overview') %>">
+    Consumers
+  </a>
+</li>
+
+<li>
+  <a href="<%= consumer_path(@process.id, 'subscriptions') %>">
+    <%== truncate(@process.id, strategy: :middle) %>
+  </a>
+</li>
+
+<li>
+  <a href="<%= consumer_path(@process.id, 'jobs') %>">
+    Jobs
+  </a>
+</li>
+
+<% if current_path.include?('/running') %>
+  <li>
+    <a href="<%= consumer_path(@process.id, 'jobs', 'pending') %>">
+      Running
+    </a>
+  </li>
+<% end %>
+
+<% if current_path.include?('/pending') %>
+  <li>
+    <a href="<%= consumer_path(@process.id, 'jobs', 'pending') %>">
+      Pending
+    </a>
+  </li>
+<% end %>

data/lib/karafka/web/pro/ui/views/consumers/{consumer → jobs}/_job.erb

@@ -1,8 +1,10 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
 <tr>
   <td>
     <span class="badge badge-secondary" title="Consumer group: <%= job.consumer_group %>">
-      <%= job.topic %>:
-      <%= job.partition %>
+      <%= topics_partition_identifier(job.topic, job.partition) %>
     </span>
   </td>
   <td>

data/lib/karafka/web/pro/ui/views/consumers/jobs/_no_jobs.erb

@@ -0,0 +1,6 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
+<div class="col-lg-12">
+  <%== alert_info("This process has no #{type} jobs at the moment.") %>
+</div>

data/lib/karafka/web/pro/ui/views/consumers/{pending_jobs.erb → jobs/pending.erb}

@@ -1,18 +1,17 @@
-<% view_title @process.id %>
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
 
-<%== partial 'consumers/consumer/commands', locals: { process: @process } %>
+<% view_title @process.id %>
 
 <div class="col-span-12">
   <% if @process.status == 'stopped' %>
-    <%== partial 'consumers/consumer/stopped' %>
+    <%== partial 'consumers/consumers/consumer/stopped' %>
   <% end %>
 
-  <%== partial 'consumers/consumer/metrics' %>
-
-  <%== partial 'consumers/consumer/tabs' %>
+  <%== partial 'consumers/consumers/consumer/tabs' %>
 
   <% if @pending_jobs.empty? %>
-    <%== partial 'consumers/consumer/no_jobs', locals: { type: 'pending' } %>
+    <%== partial 'consumers/jobs/no_jobs', locals: { type: 'pending' } %>
   <% else %>
     <div class="data-table-wrapper">
       <table class="data-table">
@@ -35,7 +34,7 @@
           <%==
             render_each(
               @pending_jobs,
-              'consumers/consumer/_job',
+              'consumers/jobs/_job',
               local: :job
             )
           %>

data/lib/karafka/web/pro/ui/views/consumers/{running_jobs.erb → jobs/running.erb}

@@ -1,18 +1,17 @@
-<% view_title @process.id %>
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
 
-<%== partial 'consumers/consumer/commands', locals: { process: @process } %>
+<% view_title @process.id %>
 
 <div class="col-span-12">
   <% if @process.status == 'stopped' %>
-    <%== partial 'consumers/consumer/stopped' %>
+    <%== partial 'consumers/consumers/consumer/stopped' %>
   <% end %>
 
-  <%== partial 'consumers/consumer/metrics' %>
-
-  <%== partial 'consumers/consumer/tabs' %>
+  <%== partial 'consumers/consumers/consumer/tabs' %>
 
   <% if @running_jobs.empty? %>
-    <%== partial 'consumers/consumer/no_jobs', locals: { type: 'running' } %>
+    <%== partial 'consumers/jobs/no_jobs', locals: { type: 'running' } %>
   <% else %>
     <div class="data-table-wrapper">
       <table class="data-table">
@@ -35,7 +34,7 @@
           <%==
             render_each(
               @running_jobs,
-              'consumers/consumer/_job',
+              'consumers/jobs/_job',
               local: :job
             )
           %>

data/lib/karafka/web/pro/ui/views/consumers/partitions/offsets/_basics.erb

@@ -0,0 +1,77 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
+<div class="grid grid-cols-1 lg:grid-cols-2 xl:grid-cols-4 gap-4 mb-6 mt-6">
+  <div class="card-metric">
+    <h3>Basic Info</h3>
+    <ul>
+      <li>
+        Process ID:
+        <%== badge_primary @process.id %>
+      </li>
+      <li>
+        Topic:
+        <%== badge_info @topic %>
+      </li>
+      <li>
+        Partition:
+        <%== badge_info @partition_id %>
+      </li>
+    </ul>
+  </div>
+
+  <div class="card-metric">
+    <h3>Consumer Details</h3>
+    <ul>
+      <li>
+        Consumer Group:
+        <%== badge_secondary @consumer_group.id %>
+      </li>
+      <li>
+        Subscription Group:
+        <%== badge_secondary @subscription_group.id %>
+      </li>
+      <li>
+        Poll State:
+        <%== poll_state_with_change_time_label(@partition_stats.poll_state, @partition_stats.poll_state_ch) %>
+      </li>
+    </ul>
+  </div>
+
+  <div class="card-metric">
+    <h3>Current Position</h3>
+    <ul>
+      <li>
+        Committed Offset:
+        <%== badge_secondary(normalized_metric(@partition_stats.committed_offset)) %>
+      </li>
+      <li>
+        Stored Offset:
+        <%== badge_secondary(normalized_metric(@partition_stats.stored_offset)) %>
+      </li>
+      <li>
+        Lag:
+
+        <%== badge_secondary(normalized_metric(@partition_stats.lag_hybrid)) %>
+      </li>
+    </ul>
+  </div>
+
+  <div class="card-metric">
+    <h3>Partition Details</h3>
+    <ul>
+      <li>
+        High Offset:
+        <%== badge_info(normalized_metric(@partition_stats.hi_offset)) %>
+      </li>
+      <li>
+        Low Offset:
+        <%== badge_info(normalized_metric(@partition_stats.lo_offset)) %>
+      </li>
+      <li>
+        EOF Offset:
+        <%== badge_info(normalized_metric(@partition_stats.eof_offset)) %>
+      </li>
+    </ul>
+  </div>
+</div>

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

@@ -0,0 +1,58 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
+<li>
+  <a href="<%= consumers_path('overview') %>">
+    Consumers
+  </a>
+</li>
+
+<li>
+  <a href="<%= consumer_path(@process.id, 'subscriptions') %>">
+    <%== truncate(@process.id, strategy: :middle) %>
+  </a>
+</li>
+
+<% if @subscription_group_id %>
+  <li>
+    <a href="<%= consumer_path(@process.id, "subscriptions##{@subscription_group_id}") %>">
+      <%= @subscription_group_id %>
+    </a>
+  </li>
+
+  <%
+    edit_path = consumer_path(
+      @process.id,
+      'partitions',
+      @subscription_group_id,
+      @topic,
+      @partition_id,
+      'offset',
+      'edit'
+    )
+  %>
+
+  <li>
+    <a href="<%= edit_path %>">
+      <%= @topic %>
+    </a>
+  </li>
+
+  <li>
+    <a href="<%= edit_path %>">
+      <%= @partition_id %>
+    </a>
+  </li>
+
+  <li>
+    <a href="<%= edit_path %>">
+      Offsets
+    </a>
+  </li>
+
+  <li>
+    <a href="<%= edit_path %>">
+      Edit
+    </a>
+  </li>
+<% end %>

data/lib/karafka/web/pro/ui/views/consumers/partitions/offsets/_form.erb

@@ -0,0 +1,109 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
+<div class="card bg-base-100 mt-4">
+  <div class="card-body">
+    <%
+      update_path = consumer_path(
+        @process.id,
+        'partitions',
+        @subscription_group.id,
+        @topic,
+        @partition_id,
+        'offset'
+      )
+    %>
+
+    <form
+      class="space-y-4 mt-4 w-full"
+      method="post"
+      action="<%= update_path %>"
+    >
+      <%== csrf_tag(update_path, 'PUT') %>
+      <input type="hidden" name="_method" value="PUT">
+      <input type="hidden" name="referrer" value="<%= request.referrer %>">
+
+      <div class="flex items-center w-full mb-8">
+        <label class="w-1/4 text-gray-700">New Offset:</label>
+        <div class="w-3/4">
+          <input
+            type="number"
+            min="<%== @partition_stats.lo_offset %>"
+            max="<%= @partition_stats.hi_offset %>"
+            name="offset"
+            class="block input input-bordered w-full"
+            placeholder="Enter new offset position"
+            required
+          />
+        </div>
+      </div>
+
+      <div class="flex items-center w-full">
+        <label class="w-1/4 text-gray-700">Prevent Overtaking:</label>
+        <div class="w-3/4">
+          <label class="flex items-center gap-4 cursor-pointer">
+            <input type="hidden" name="prevent_overtaking" value="off">
+
+            <input
+              name="prevent_overtaking"
+              type="checkbox"
+              class="checkbox checkbox-warning"
+              checked
+            />
+
+            <div class="space-y-1">
+              <div class="flex items-center gap-2">
+                Only adjust if consumer hasn't moved beyond requested offset already
+              </div>
+              <div class="text-sm text-gray-500">
+                Prevents seeking back in case the consumer moved forward
+              </div>
+            </div>
+          </label>
+        </div>
+      </div>
+
+      <div class="flex items-center w-full mt-4 <%= 'text-muted' if @topic_lrj %>">
+        <label class="w-1/4 text-gray-700">Resume Immediately:</label>
+        <div class="w-3/4">
+          <label class="flex items-center gap-4 cursor-pointer">
+            <input type="hidden" name="force_resume" value="off">
+            <input
+              name="force_resume"
+              type="checkbox"
+              class="checkbox checkbox-warning"
+              <%= 'disabled' if @topic_lrj %>
+            />
+            <div class="space-y-1">
+              <div class="flex items-center gap-2">
+                If partition is currently paused, resume processing immediately
+              </div>
+              <div class="text-sm text-gray-500">
+                <% if @topic_lrj %>
+                  Option not available for Long-Running Jobs topics
+                <% elsif @routing_topic %>
+                  Has no effect if partition is not paused
+                <% else %>
+                  Option not available, since topic not visible in the Web UI routing
+                <% end %>
+              </div>
+            </div>
+          </label>
+        </div>
+      </div>
+
+      <div class="fieldset text-center mt-6 ">
+        <div class="flex gap-4 justify-end">
+          <a href="<%= root_path('health', 'overview') %>" class="btn btn-ghost">
+            Cancel
+          </a>
+
+          <button type="submit" class="btn btn-warning gap-2 btn-lockable">
+            <%== icon(:pencil_square) %>
+            Adjust Offset
+          </button>
+        </div>
+      </div>
+    </form>
+  </div>
+</div>

data/lib/karafka/web/pro/ui/views/consumers/partitions/offsets/_not_running_error.erb

@@ -0,0 +1,16 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
+<% alert_box_error 'This Operation Cannot Be Performed' do %>
+  <p>
+    Consumer offsets can only be modified using Web UI when the consumer is in a running state.
+  </p>
+<% end %>
+
+<div class="fieldset text-center mt-6">
+  <div class="flex justify-end">
+    <a href="<%= root_path('health', 'overview') %>" class="btn btn-ghost">
+      Cancel
+    </a>
+  </div>
+</div>

data/lib/karafka/web/pro/ui/views/consumers/partitions/offsets/_running_warning.erb

@@ -0,0 +1,15 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
+<% alert_box_warning('Running Consumer Process Operation') do %>
+  <p>
+    You are about to modify offset for an actively running consumer. This operation:
+  </p>
+
+  <ul class="list-disc ml-6 mt-2">
+    <li>Takes effect during the next poll operation</li>
+    <li>May affect message processing</li>
+    <li>Cannot be undone</li>
+    <li>Will take effect only if the current process still owns the assignment</li>
+  </ul>
+<% end %>

data/lib/karafka/web/pro/ui/views/consumers/partitions/offsets/edit.erb

@@ -0,0 +1,16 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
+<%
+  tpi = topics_partition_identifier(@topic, @partition_id)
+
+  view_title "#{@process.id} - Offset Adjustment - #{@subscription_group_id} - #{tpi}"
+%>
+
+<% if @process.status != 'running' %>
+  <%== partial 'consumers/partitions/offsets/not_running_error' %>
+<% else %>
+  <%== partial 'consumers/partitions/offsets/running_warning' %>
+  <%== partial 'consumers/partitions/offsets/basics' %>
+  <%== partial 'consumers/partitions/offsets/form' %>
+<% end %>

data/lib/karafka/web/pro/ui/views/consumers/partitions/pauses/_active_not_editable.erb

@@ -0,0 +1,22 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
+<% alert_box_error 'Cannot Configure Pause Settings' do %>
+  <p class="mb-2">
+    This partition is currently active and processing messages.
+  </p>
+  <p class="mb-2">
+    Pause settings can only be configured for partitions that are already in a paused state.
+  </p>
+  <p>
+    You can pause this partition first using the pause action from the partitions list.
+  </p>
+<% end %>
+
+<div class="fieldset text-center mt-6">
+  <div class="flex justify-end">
+    <a href="<%= root_path('health', 'overview') %>" class="btn btn-ghost">
+      Cancel
+    </a>
+  </div>
+</div>

data/lib/karafka/web/pro/ui/views/consumers/partitions/pauses/_adjusting_warning.erb

@@ -0,0 +1,27 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
+<% alert_box_warning('Running Consumer Process Operation') do %>
+  <p>
+    You are about to adjust pause for an actively running consumer. This operation:
+  </p>
+
+  <ul class="list-disc ml-6 mt-2 mb-2">
+    <li>Takes effect during the next poll operation</li>
+    <li>May affect message processing</li>
+    <li>Cannot be undone</li>
+    <li>Will take effect only if the current process still owns the assignment</li>
+  </ul>
+
+  <hr/>
+
+  <p class="mt-2">
+    During long pauses, lag reporting on this topic partition may stop as librdkafka freezes the last known high watermark.
+  </p>
+
+  <p class="mt-2">
+    Real-time, state-independent lag metrics can always be checked in the
+    <a href="<%= root_path('health', 'cluster_lags') %>">Cluster Lags</a> tab
+    of the <a href="<%= root_path('health') %>">Health</a> section.
+  </p>
+<% end %>

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

@@ -0,0 +1,60 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
+<li>
+  <a href="<%= consumers_path('overview') %>">
+    Consumers
+  </a>
+</li>
+
+<li>
+  <a href="<%= consumer_path(@process.id, 'subscriptions') %>">
+    <%== truncate(@process.id, strategy: :middle) %>
+  </a>
+</li>
+
+<% if @subscription_group_id %>
+  <li>
+    <a href="<%= consumer_path(@process.id, "subscriptions##{@subscription_group_id}") %>">
+      <%= @subscription_group_id %>
+    </a>
+  </li>
+
+  <%
+    action = current_path.include?('/new') ? 'new' : 'edit'
+
+    target_path = consumer_path(
+      @process.id,
+      'partitions',
+      @subscription_group_id,
+      @topic,
+      @partition_id,
+      'pause',
+      action
+    )
+  %>
+
+  <li>
+    <a href="<%= target_path %>">
+      <%= @topic %>
+    </a>
+  </li>
+
+  <li>
+    <a href="<%= target_path %>">
+      <%= @partition_id %>
+    </a>
+  </li>
+
+  <li>
+    <a href="<%= target_path %>">
+      Pauses
+    </a>
+  </li>
+
+  <li>
+    <a href="<%= target_path %>">
+      <%= action.capitalize %>
+    </a>
+  </li>
+<% end %>

data/lib/karafka/web/pro/ui/views/consumers/partitions/pauses/_edit_form.erb

@@ -0,0 +1,59 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
+<%
+  resume_path = consumer_path(
+    @process.id,
+    'partitions',
+    @subscription_group.id,
+    @topic,
+    @partition_id,
+    'pause'
+  )
+%>
+
+<div class="card bg-base-100 mt-4">
+  <div class="card-body">
+    <form
+      class="space-y-4 w-full"
+      method="post"
+      action="<%= resume_path %>"
+    >
+      <%== csrf_tag(resume_path, 'DELETE') %>
+      <input type="hidden" name="_method" value="delete">
+
+      <div class="flex items-center w-full">
+        <label class="w-1/4 text-gray-700">Reset Counter:</label>
+
+        <div class="w-3/4">
+          <label class="flex items-center gap-4 cursor-pointer">
+            <input type="hidden" name="reset_attempts" value="off">
+            <input type="checkbox" name="reset_attempts" class="checkbox checkbox-warning" />
+            <div class="space-y-1">
+              <div class="flex items-center gap-2">
+                Reset the processing attempts counter when resuming
+              </div>
+
+              <div class="text-sm text-gray-500">
+                Resets retries counter for features like DLQ dispatching. Does not affect message offset position.
+              </div>
+            </div>
+          </label>
+        </div>
+      </div>
+
+      <div class="fieldset text-center mt-6">
+        <div class="flex gap-4 justify-end">
+          <a href="<%= root_path('health', 'overview') %>" class="btn btn-ghost">
+           Cancel
+          </a>
+
+          <button type="submit" class="btn btn-warning gap-2 btn-lockable">
+            <%== icon(:play) %>
+            Resume Processing
+          </button>
+        </div>
+      </div>
+    </form>
+  </div>
+</div>

data/lib/karafka/web/pro/ui/views/consumers/partitions/pauses/_lrj_not_manageable.erb

@@ -0,0 +1,24 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
+<% alert_box_error 'Cannot Manage Long-Running Job Partitions Pausing' do %>
+  <p class="mb-2">
+    Manual pause/resume operations are not supported for topics using Long-Running Jobs.
+  </p>
+
+  <p class="mb-2">
+    These topics partitions are automatically paused and resumed based on the message processing flow to ensure reliable and consistent behavior.
+  </p>
+
+  <p>
+    Long-Running Jobs handle partition pausing internally to maintain processing stability and prevent message duplication or loss.
+  </p>
+<% end %>
+
+<div class="fieldset text-center mt-6">
+  <div class="flex justify-end">
+    <a href="<%= root_path('health', 'overview') %>" class="btn btn-ghost">
+      Cancel
+    </a>
+  </div>
+</div>