karafka-web 0.10.4 → 0.11.0.beta2

data/lib/karafka/web/pro/ui/routes/topics.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
+# See LICENSE for details.
+
+module Karafka
+  module Web
+    module Pro
+      module Ui
+        module Routes
+          # Manages the topics related routes
+          class Topics < Base
+            route do |r|
+              r.on 'topics' do
+                r.on String, 'distribution' do |topic_id|
+                  controller = build(Controllers::Topics::DistributionsController)
+
+                  r.get 'edit' do
+                    controller.edit(topic_id)
+                  end
+
+                  r.put do
+                    controller.update(topic_id)
+                  end
+
+                  r.get do
+                    controller.show(topic_id)
+                  end
+                end
+
+                r.get String, 'replication' do |topic_id|
+                  controller = build(Controllers::Topics::ReplicationsController)
+                  controller.show(topic_id)
+                end
+
+                r.get String, 'offsets' do |topic_id|
+                  controller = build(Controllers::Topics::OffsetsController)
+                  controller.show(topic_id)
+                end
+
+                r.on String, 'config' do |topic_id|
+                  controller = build(Controllers::Topics::ConfigsController)
+
+                  r.get String, 'edit' do |property_name|
+                    controller.edit(topic_id, property_name)
+                  end
+
+                  r.put String do |property_name|
+                    controller.update(topic_id, property_name)
+                  end
+
+                  r.get do
+                    controller.index(topic_id)
+                  end
+                end
+
+                controller = build(Controllers::Topics::TopicsController)
+
+                r.get 'new' do
+                  controller.new
+                end
+
+                r.post do
+                  controller.create
+                end
+
+                # Topic removal confirmation page since it's a sensitive operation
+                r.get String, 'delete' do |topic_id|
+                  controller.edit(topic_id)
+                end
+
+                r.delete String do |topic_id|
+                  controller.delete(topic_id)
+                end
+
+                r.get do
+                  controller.index
+                end
+
+                r.get String do |topic_id|
+                  r.redirect root_path('topics', topic_id, 'config')
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/karafka/web/pro/ui/routes/ux.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
+# See LICENSE for details.
+
+module Karafka
+  module Web
+    module Pro
+      module Ui
+        module Routes
+          # Manages the UX controller routes
+          class Ux < Base
+            route do |r|
+              r.get 'ux' do
+                controller = build(Controllers::UxController)
+                controller.show
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,3 +1,6 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
 <li>
   <a href="<%= root_path('cluster') %>">
     Cluster informations

data/lib/karafka/web/pro/ui/views/cluster/_broker.erb

@@ -1,3 +1,6 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
 <tr>
   <td>
     <a href="<%= root_path('cluster', broker.id) %>">

data/lib/karafka/web/pro/ui/views/cluster/_config.erb

@@ -1,3 +1,6 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
 <tr>
   <td class="wrap-text">
     <% all_names = ([config.name] + config.synonyms.map(&:name)).uniq %>

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

@@ -1,3 +1,6 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
 <div class="tab-container-wrapper">
   <div class="tab-container">
     <a

data/lib/karafka/web/pro/ui/views/cluster/index.erb

@@ -1,3 +1,6 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
 <% view_title 'Cluster Informations' %>
 
 <%== partial 'cluster/tabs' %>
@@ -7,7 +10,7 @@
     <table class="data-table">
       <thead>
         <tr>
-          <th><%== sort_link(:id) %></th>
+          <th><%== sort_link('Node ID', :id) %></th>
           <th><%== sort_link(:name) %></th>
           <th><%== sort_link(:port) %></th>
         </tr>

data/lib/karafka/web/pro/ui/views/cluster/show.erb

@@ -1,3 +1,6 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
 <% view_title @broker.full_name %>
 
 <div class="data-table-wrapper">

data/lib/karafka/web/pro/ui/views/{commands → consumers/commands}/_backtrace.erb

@@ -1,3 +1,6 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
 <h3 class="h3 mt-6">
   <%= backtrace[:label] %>
 </h3>

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

@@ -0,0 +1,24 @@
+<%# 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>
+
+<% if current_path.include?('/commands') %>
+  <li>
+    <a href="<%= consumers_path('commands') %>">
+      Commands
+    </a>
+  </li>
+<% end %>
+
+<% if @command_message %>
+  <li>
+    <a href="<%= consumers_path('commands', @command_message.offset) %>">
+      <%= @command_message.offset %>
+    </a>
+  </li>
+<% end %>

data/lib/karafka/web/pro/ui/views/{commands → consumers/commands}/_command.erb

@@ -1,3 +1,6 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
 <% if command_message.is_a?(Array) %>
   <%== partial 'shared/not_a_message' %>
 <% else %>
@@ -6,7 +9,13 @@
   <% if command[:schema_version] == @schema_version %>
     <tr>
       <td>
-        <% color = command[:type] == 'result' ? 'success' : 'primary' %>
+        <%
+          type = command[:type]
+          color = 'primary'
+          color = 'success' if type == 'result'
+          color = 'secondary' if type == 'acceptance'
+        %>
+
         <span class="badge badge-<%= color %>">
           <%= command[:type] %>
         </span>
@@ -14,13 +23,20 @@
 
       <td>
         <%
+          scope = ::Karafka::Web::Pro::Commanding::Commands
           color = case command[:command][:name]
-                  when 'trace'
+                  when scope::Consumers::Trace.name
                     'info'
-                  when 'quiet'
+                  when scope::Consumers::Quiet.name
                     'warning'
-                  when 'stop'
+                  when scope::Consumers::Stop.name
                     'error'
+                  when scope::Partitions::Seek.name
+                    'primary'
+                  when scope::Partitions::Pause.name
+                    'warning'
+                  when scope::Partitions::Resume.name
+                    'warning'
                   else
                     'secondary'
                   end
@@ -34,7 +50,7 @@
         <% if command[:process][:id] == '*' %>
           *
         <% else %>
-          <a href="<%= root_path('consumers', command[:process][:id], 'subscriptions') %>">
+          <a href="<%= consumer_path(command[:process][:id], 'subscriptions') %>">
             <%= truncate(command[:process][:id], strategy: :middle) %>
           </a>
         <% end %>
@@ -45,7 +61,7 @@
       </td>
 
       <td>
-        <a href="<%= root_path('commands', command_message.offset) %>" class="btn btn-sm btn-primary">
+        <a href="<%= consumers_path('commands', command_message.offset) %>" class="btn btn-sm btn-primary">
           Details
         </a>
       </td>

data/lib/karafka/web/pro/ui/views/consumers/commands/_command_details.erb

@@ -0,0 +1,4 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
+<pre class="code"><code class="json"><%= JSON.pretty_generate command %></code></pre>

data/lib/karafka/web/pro/ui/views/consumers/commands/_empty.erb

@@ -0,0 +1,6 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
+<%==
+  alert_info('No commands found.')
+%>

data/lib/karafka/web/pro/ui/views/{commands → consumers/commands}/_incompatible_schema.erb

@@ -1,3 +1,6 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
 <% alert_box_error('Incompatible Command Schema') do %>
   This issue occurs when the Web UI and consumer processes use different command schemas, preventing the display of command details. It arises from version mismatches, where either the Web UI or the consumer processes are outdated. To resolve this, ensure both components use compatible versions with the same schema.
 <% end %>

data/lib/karafka/web/pro/ui/views/{commands → consumers/commands}/_metadata.erb

@@ -1,3 +1,6 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
 <%
   process_id = command[:process][:id]
 %>
@@ -30,7 +33,7 @@
           <% if process_id == '*' %>
               <%= process_id %>
           <% else %>
-            <a href="<%= root_path('consumers', process_id, 'subscriptions') %>">
+            <a href="<%= consumer_path(process_id, 'subscriptions') %>">
               <%= process_id %>
             </a>
           <% end %>

data/lib/karafka/web/pro/ui/views/{commands → consumers/commands}/_table.erb

@@ -1,10 +1,13 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
 <div class="data-table-wrapper">
   <table class="data-table">
     <thead>
       <tr>
         <th>Type</th>
         <th>Name</th>
-        <th>ID</th>
+        <th>Process ID</th>
         <th>Dispatched</th>
         <th></th>
       </tr>
@@ -14,7 +17,7 @@
       <%==
         each_partial(
           @command_messages,
-          'commands/command',
+          'consumers/commands/command',
           local: :command_message
         )
       %>

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

@@ -1,12 +1,15 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
 <% view_title 'Consumers Commands and Responses' %>
 
-<%== partial 'consumers/tabs' %>
+<%== partial 'consumers/consumers/tabs' %>
 
 <div class="col-span-12">
   <% if @command_messages && !@command_messages.empty? %>
     <section class="actions">
       <a
-        href="<%= root_path('commands', 'recent') %>"
+        href="<%= consumers_path('commands', 'recent') %>"
         class="btn-action"
         title="Display the most recent command"
       >
@@ -16,8 +19,8 @@
   <% end %>
 
   <% if @command_messages.empty? && params.current_page == 1 %>
-    <%== partial 'commands/empty' %>
+    <%== partial 'consumers/commands/empty' %>
   <% else %>
-    <%== partial 'commands/table' %>
+    <%== partial 'consumers/commands/table' %>
   <% end %>
 </div>

data/lib/karafka/web/pro/ui/views/consumers/commands/show.erb

@@ -0,0 +1,32 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
+<% command = @command_message.payload %>
+
+<div class="col-span-12">
+  <% if command[:schema_version] == @schema_version %>
+    <% view_title "#{command[:command][:name]} #{command[:type]} #{@command_message.key}" %>
+
+    <%== partial 'consumers/consumers/tabs' %>
+
+    <%== partial 'consumers/commands/metadata', locals: { command: command } %>
+
+    <% if command[:type] == 'result' && command[:command][:name] == 'consumers.trace' %>
+      <h2 class="h2">Backtraces</h2>
+
+      <% command[:result].each_value do |backtrace| %>
+        <%== partial 'consumers/commands/backtrace', locals: { backtrace: backtrace } %>
+      <% end %>
+    <% else %>
+      <h2 class="h2">Details</h2>
+
+      <%== partial 'consumers/commands/command_details', locals: { command: command } %>
+    <% end %>
+  <% else %>
+    <% view_title 'Incompatible Command Schema' %>
+
+    <%== partial 'consumers/consumers/tabs' %>
+
+    <%== partial 'consumers/commands/incompatible_schema' %>
+  <% end %>
+</div>

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

@@ -0,0 +1,46 @@
+<%# 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>
+
+<% if current_path.include?('/overview') %>
+  <li>
+    <a href="<%= consumers_path('overview') %>">
+      Overview
+    </a>
+  </li>
+<% end %>
+
+<% if current_path.include?('/performance') %>
+  <li>
+    <a href="<%= consumers_path('performance') %>">
+      Performance
+    </a>
+  </li>
+<% end %>
+
+<% if @process %>
+  <li>
+    <a href="<%= consumer_path(@process.id, 'subscriptions') %>">
+      <%== truncate(@process.id, strategy: :middle) %>
+    </a>
+  </li>
+
+  <% if current_path.include?('/subscriptions') %>
+    <li>
+      <a href="<%= consumer_path(@process.id, 'subscriptions') %>">
+        Subscriptions
+      </a>
+    </li>
+  <% else %>
+    <li>
+      <a href="<%= consumer_path(@process.id, 'details') %>">
+        Details
+      </a>
+    </li>
+  <% end %>
+<% end %>

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

@@ -1,7 +1,10 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
 <tr class="status-row-<%= process.status %>">
   <td>
     <p>
-      <a href="<%= root_path('consumers', process.id, 'subscriptions') %>">
+      <a href="<%= consumer_path(process.id, 'subscriptions') %>">
         <%== truncate(process.id, strategy: :middle) %>
       </a>
     </p>

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

@@ -1,6 +1,9 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
 <tr class="status-row-<%= process.status %>">
   <td>
-    <a href="<%= root_path('consumers', process.id, 'subscriptions') %>">
+    <a href="<%= consumer_path(process.id, 'subscriptions') %>">
       <%== truncate(process.id, strategy: :middle) %>
     </a>
 

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

@@ -0,0 +1,38 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
+<div class="tab-container-wrapper">
+  <div class="tab-container">
+    <a
+      href="<%= consumers_path('overview') %>"
+      class="custom-tab <%= nav_class(include: 'overview') %>"
+    >
+      Overview
+    </a>
+
+    <a
+      href="<%= consumers_path('performance') %>"
+      class="custom-tab <%= nav_class(include: 'performance') %>"
+    >
+      Performance
+    </a>
+
+    <%
+      disabled = 'disabled btn-disabled'
+      disabled = '' if features.commanding?
+    %>
+    <a
+      href="<%= consumers_path('controls') %>"
+      class="custom-tab <%= nav_class(include: 'controls') %> <%= disabled %>"
+    >
+      Controls
+    </a>
+
+    <a
+      href="<%= consumers_path('commands') %>"
+      class="custom-tab <%= nav_class(include: 'commands') %> <%= disabled %>"
+    >
+      Commands
+    </a>
+  </div>
+</div>

data/lib/karafka/web/pro/ui/views/consumers/consumers/consumer/_commands.erb

@@ -0,0 +1,80 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
+<%
+  commanding_class = 'btn-disabled'
+  commanding_class = '' if features.commanding?
+  trace_class = 'btn-disabled'
+  trace_class = '' unless process.tags.include?('embedded')
+%>
+
+<div class="col-span-12 flex justify-end space-x-2 mb-6">
+  <%
+    trace_path = consumers_path('commanding', process.id, 'trace')
+    disabled_class = process.status != 'stopped' ? '' : 'btn-disabled'
+  %>
+  <form
+    action="<%= trace_path %>"
+    method="post"
+    class="inline-flex items-center"
+  >
+    <%== csrf_tag(trace_path) %>
+    <button
+      type="submit"
+      class="btn btn-info btn-sm btn-lockable <%= disabled_class %> <%= commanding_class %>"
+    >
+      <%== icon(:gear) %>
+      Trace
+    </button>
+  </form>
+
+  <%
+    quiet_path = consumers_path('commanding', process.id, 'quiet')
+    disabled_class = process.status == 'running' ? '' : 'btn-disabled'
+
+    unless process.execution_mode == 'standalone'
+      disabled_class = 'btn-disabled'
+      title = 'Supported only in standalone consumer processes'
+    end
+  %>
+  <form
+    action="<%= quiet_path %>"
+    method="post"
+    class="inline-flex items-center"
+    title="<%= title %>"
+  >
+    <%== csrf_tag(quiet_path) %>
+    <button
+      type="submit"
+      class="btn btn-warning btn-sm btn-lockable <%= disabled_class %> <%= commanding_class %> <%= trace_class %>"
+    >
+      <%== icon(:pause) %>
+      Quiet
+    </button>
+  </form>
+
+  <%
+    stop_path = consumers_path('commanding', process.id, 'stop')
+    disabled_class = process.status != 'stopping' && process.status != 'stopped' ? '' : 'btn-disabled'
+
+    unless process.execution_mode == 'standalone'
+      disabled_class = 'btn-disabled'
+      title = 'Supported only in standalone consumer processes'
+    end
+  %>
+  <form
+    action="<%= stop_path %>"
+    method="post"
+    class="inline-flex items-center"
+    title="<%= title %>"
+  >
+    <%== csrf_tag(stop_path) %>
+    <button
+      type="submit"
+      class="btn btn-error btn-sm btn-lockable <%= disabled_class %> <%= commanding_class %> <%= trace_class %>"
+    >
+      <%== icon(:stop) %>
+      Stop
+    </button>
+  </form>
+</div>

data/lib/karafka/web/pro/ui/views/consumers/consumers/consumer/_consumer_group.erb

@@ -0,0 +1,11 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
+<%==
+  render_each(
+    consumer_group.subscription_groups,
+    'consumers/consumers/consumer/_subscription_group',
+    local: :subscription_group,
+    locals: { consumer_group: consumer_group }
+  )
+%>

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

@@ -1,3 +1,6 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
 <div id="metrics" class="w-full">
   <div class="grid grid-cols-1 lg:grid-cols-2 xl:grid-cols-4 gap-4 mb-6">
     <div class="card-metric">

data/lib/karafka/web/pro/ui/views/consumers/consumers/consumer/_no_subscriptions.erb

@@ -0,0 +1,10 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
+<div class="container-wrapper mb-4">
+  <div class="row">
+    <div class="col-lg-12">
+      <%== alert_info('This process is not subscribed to any topics.') %>
+    </div>
+  </div>
+</div>

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

@@ -1,3 +1,6 @@
+<%# This code is part of Karafka Pro, a commercial component not licensed under LGPL. %>
+<%# See LICENSE for details. %>
+
 <tr class="<%= lso_risk_state_bg(partition) %>">
   <td>
     <%= partition.id %>
@@ -33,4 +36,17 @@
       <%= partition.lso_risk_state %>
     </span>
   </td>
+
+  <td>
+    <%== partial(
+      'consumers/consumers/consumer/partition_edit_options',
+      locals: {
+        process: @process,
+        subscription_group_id: subscription_group.id,
+        topic_name: topic.name,
+        partition: partition
+      }
+    )
+    %>
+  </td>
 </tr>