karafka-web 0.10.1 → 0.10.3

data/lib/karafka/web/pro/ui/lib/branding/contracts/config.rb

@@ -0,0 +1,56 @@
+# 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 Pro
+      module Ui
+        module Lib
+          module Branding
+            # Contracts for checking branding related setup
+            module Contracts
+              # Makes sure, all the expected UI branding config is defined as it should be
+              class Config < ::Karafka::Contracts::Base
+                configure do |config|
+                  config.error_messages = YAML.safe_load(
+                    File.read(
+                      File.join(Karafka::Web.gem_root, 'config', 'locales', 'pro_errors.yml')
+                    )
+                  ).fetch('en').fetch('validations').fetch('config')
+                end
+
+                nested(:ui) do
+                  nested(:branding) do
+                    required(:type) do |val|
+                      # Type of branding style wrapping needs to align with what we support
+                      # in other places
+                      ::Karafka::Web::Ui::Helpers::TailwindHelper::TYPES.include?(val)
+                    end
+
+                    required(:label) do |val|
+                      val == false || (val.is_a?(String) && val.size.positive?)
+                    end
+
+                    required(:notice) do |val|
+                      val == false || (val.is_a?(String) && val.size.positive?)
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/karafka/web/pro/ui/lib/branding.rb

@@ -0,0 +1,36 @@
+# 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 Pro
+      module Ui
+        module Lib
+          # Namespace for UI branding related stuff
+          # Branding allows users to set an extra label and notice per env so users won't be
+          # confused by dev vs prod etc.
+          module Branding
+            class << self
+              # Validates that the UI branding config is correct
+              #
+              # @param config [Karafka::Core::Configurable::Node] web config
+              def post_setup(config)
+                Branding::Contracts::Config.new.validate!(config.to_h)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/karafka/web/pro/ui/views/commands/_command.erb

@@ -15,7 +15,7 @@
       <td>
         <%
           color = case command[:command][:name]
-                  when 'probe'
+                  when 'trace'
                     'info'
                   when 'quiet'
                     'warning'

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

@@ -45,11 +45,11 @@
 
   <td class="commands-inline-3">
     <%
-      probe_path = root_path('commanding', process.id, 'probe')
+      trace_path = root_path('commanding', process.id, 'trace')
       disabled_class = process.status != 'stopped' ? '' : 'btn-disabled'
     %>
-    <form action="<%= probe_path %>" method="post" class="inline" title="Probe">
-      <%== csrf_tag(probe_path) %>
+    <form action="<%= trace_path %>" method="post" class="inline" title="Trace">
+      <%== csrf_tag(trace_path) %>
 
       <button type="submit" class="btn btn-info btn-sm <%= disabled_class %>">
         <%== icon(:gear) %>

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

@@ -1,21 +1,21 @@
 <% if Karafka::Web.config.commanding.active && !process.tags.include?('embedded') %>
   <div class="col-span-12 flex justify-end space-x-2 mb-6">
     <%
-      probe_path = root_path('commanding', process.id, 'probe')
+      trace_path = root_path('commanding', process.id, 'trace')
       disabled_class = process.status != 'stopped' ? '' : 'btn-disabled'
     %>
     <form
-      action="<%= probe_path %>"
+      action="<%= trace_path %>"
       method="post"
       class="inline-flex items-center"
     >
-      <%== csrf_tag(probe_path) %>
+      <%== csrf_tag(trace_path) %>
       <button
         type="submit"
         class="btn btn-info btn-sm <%= disabled_class %>"
       >
         <%== icon(:gear) %>
-        Probe
+        Trace
       </button>
     </form>
 

data/lib/karafka/web/pro/ui/views/explorer/_partition_option.erb

@@ -1,7 +1,15 @@
+<%
+  path = if @selector_path_method
+           public_send(@selector_path_method, @topic_id, partition)
+         else
+           explorer_path(@topic_id, partition)
+         end
+%>
+
 <% if @partition_id == partition %>
-  <option value="<%= explorer_path(@topic_id, partition) %>" selected=selected>
+  <option value="<%= path %>" selected=selected>
 <% else %>
-  <option value="<%= explorer_path(@topic_id, partition) %>">
+  <option value="<%= path %>">
 <% end %>
   <%= partition || 'All' %>
 </option>

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

@@ -30,7 +30,7 @@
   <%== csrf_tag(enable_path) %>
   <button
     type="submit"
-    class="btn btn-success btn-sm   <%= disabled_class %>"
+    class="btn btn-success btn-sm <%= disabled_class %>"
   >
     <%== icon(:check) %>
   </button>
@@ -50,7 +50,7 @@
   <%== csrf_tag(disable_path) %>
   <button
     type="submit"
-    class="btn btn-warning btn-sm  <%= disabled_class %>"
+    class="btn btn-warning btn-sm <%= disabled_class %>"
 
   >
     <%== icon(:pause) %>

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

@@ -7,6 +7,6 @@
     <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>our Karafka server, with schedule awareness, is running and has persisted the state.</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/routing/_consumer_group.erb

@@ -10,6 +10,7 @@
           <th>Subscription group</th>
           <th><%== sort_link('Topic', :name) %></th>
           <th>Type</th>
+          <th>Assigned</th>
           <th><%== sort_link(:active?) %></th>
           <th></th>
         </tr>
@@ -21,6 +22,7 @@
               'routing/topic',
               locals: {
                 subscription_group: topic.subscription_group,
+                consumer_group: consumer_group.id,
                 topic: topic
               }
             )

data/lib/karafka/web/pro/ui/views/routing/_topic.erb

@@ -20,6 +20,16 @@
     <% end %>
   </td>
 
+  <td>
+    <% assigned = @assigned[consumer_group].include?(topic.name) %>
+
+    <% if assigned %>
+      <%== badge_success assigned %>
+    <% else %>
+      <%== badge_secondary assigned %>
+    <% end %>
+  </td>
+
   <td>
     <% if topic.active? %>
       <%== badge_success topic.active? %>

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/_key.erb

@@ -0,0 +1,9 @@
+<% 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 %>

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

@@ -0,0 +1,122 @@
+<% 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>
+        <%== relative_time(message.timestamp) %>
+      </td>
+      <td class="text-center text-muted">
+        N/A
+      </td>
+      <td>
+        <%==
+          partial(
+            'scheduled_messages/explorer/key',
+            locals: { message: message, safe_key: safe_key }
+          )
+        %>
+      </td>
+      <td colspan="2" class="text-center text-muted">
+        N/A
+      </td>
+    <% else %>
+      <td>
+        <%== relative_time(message.timestamp) %>
+      </td>
+      <td>
+        <%== relative_time message.headers['schedule_target_epoch'].to_i %>
+      </td>
+      <td>
+        <%==
+          partial(
+            'scheduled_messages/explorer/key',
+            locals: { message: message, safe_key: safe_key }
+          )
+        %>
+      </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>
+      <% if type == 'schedule' %>
+        <%
+          cancel_path = root_path(
+            "scheduled_messages/messages",
+            message.topic,
+            message.partition,
+            message.offset,
+            'cancel'
+          )
+        %>
+        <form
+          action="<%= cancel_path %>"
+          method="post"
+          class="inline"
+        >
+          <%== csrf_tag(cancel_path) %>
+          <button
+            type="submit"
+            class="btn btn-error btn-sm confirm-action"
+            title="Cancel dispatch of this scheduled message"
+          >
+            <%== icon(:x_circle) %>
+          </button>
+        </form>
+      <% end %>
+
+      <%==
+        link_button_primary_sm(
+          icon(:info_circle),
+          explorer_path(message.topic, message.partition, message.offset),
+          title: 'Display details of this message'
+        )
+      %>
+    </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>

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' %>