karafka-web 0.10.1 → 0.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40794ee9c8b084cf75de0403b904134cbc6a762dbfa338bb9ce574b56e46ac36
-  data.tar.gz: dedefe087c54e118abb90e819b36b29aa253c4351aa18bd8a78d01e2c096ce79
+  metadata.gz: d471de1bcc756c234f8db2345c269b878863759fb5deb195ac8579e57365efde
+  data.tar.gz: 12d1348a0b83353dabeeea7a5ae164be7ff834d84088cfadb7b32c7343470f66
 SHA512:
-  metadata.gz: 88b9b6ed8082b0484dcd32a20b2cee2b77d4df762b65d0487325e03ef375e1e7ac621d612f81b3f4a6870aa4352e07286979863d656161ca7d8d880e5709d108
-  data.tar.gz: f9350f68d872c76d289933fbf2548b692179bae30fb2c0fccf923cdefca7131bbf3e6bf362e21a442c424fc4b43472e8334115b90c32449e80ef45a3518c3228
+  metadata.gz: 3f3eab846d445aa01714c8cea282874f9228f69af2475408d19a34b3ce43793b235f32c4484b640fad3b36ae29c90a2a8112dfd0b46685159528672355945f4c
+  data.tar.gz: f44a24702afe474270232a1cd5d785737fbd3e6d3b3e574b3eeb1cba5680147000092ec564ad5da7c663d6de124c7b59d9c3bd6c4e51ec80fc249eb90627fb5c

checksums.yaml.gz.sig

@@ -1 +1,3 @@
-��[����S�t���Y�Ě�D��������1�#�];Xły}�)ҙ�*��A�	��uѭȚܟ��
+@��)o�Ee۫�15��Ƣ�h�){�
+R�
+�O�ljJ�F�B�F�R+u��G������
���ev����y	~�D�����>�%�LikH��K���}S�[�>k�uM����

data/.ruby-version

@@ -1 +1 @@
-3.3.4
+3.3.5

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 # Karafka Web Changelog
 
-## 0.10.1 (Unreleased)
+## 0.10.2 (2024-09-03)
+- **[Feature]** Support Future Messages management (Pro).
+- [Enhancement] Do not live-reload when form active.
+- [Fix] Undefined method `deep_merge` for an instance of Hash.
+- [Fix] Prevent live-polling on elements wrapped in a button.
+- [Fix] Fix errors extractor failure on first message-less tick / eofed
+
+## 0.10.1 (2024-08-23)
 - **[Feature]** Support Recurring Tasks management (Pro).
 - [Enhancement] Optimize command buttons so they occupy less space.
 - [Enhancement] Improve tables headers capitalization.

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    karafka-web (0.10.1)
+    karafka-web (0.10.2)
       erubi (~> 1.4)
-      karafka (>= 2.4.9, < 2.5.0)
+      karafka (>= 2.4.10, < 2.5.0)
       karafka-core (>= 2.4.0, < 2.5.0)
       roda (~> 3.68, >= 3.69)
       tilt (~> 2.0)
@@ -40,7 +40,7 @@ GEM
       raabro (~> 1.4)
     i18n (1.14.5)
       concurrent-ruby (~> 1.0)
-    karafka (2.4.9)
+    karafka (2.4.10)
       base64 (~> 0.2)
       karafka-core (>= 2.4.3, < 2.5.0)
       karafka-rdkafka (>= 0.17.2)

data/karafka-web.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.licenses    = %w[LGPL-3.0-only Commercial]
 
   spec.add_dependency 'erubi', '~> 1.4'
-  spec.add_dependency 'karafka', '>= 2.4.9', '< 2.5.0'
+  spec.add_dependency 'karafka', '>= 2.4.10', '< 2.5.0'
   spec.add_dependency 'karafka-core', '>= 2.4.0', '< 2.5.0'
   spec.add_dependency 'roda', '~> 3.68', '>= 3.69'
   spec.add_dependency 'tilt', '~> 2.0'

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

@@ -272,6 +272,41 @@ module Karafka
               end
             end
 
+            r.on 'scheduled_messages' do
+              r.on 'schedules' do
+                controller = Controllers::ScheduledMessages::SchedulesController.new(params)
+
+                r.get String do |topic_id|
+                  controller.show(topic_id)
+                end
+
+                r.get do
+                  controller.index
+                end
+              end
+
+              r.on 'explorer' do
+                controller = Controllers::ScheduledMessages::ExplorerController.new(params)
+
+                r.get String do |topic_id|
+                  controller.topic(topic_id)
+                end
+
+                r.get String, Integer do |topic_id, partition_id|
+                  controller.partition(topic_id, partition_id)
+                end
+
+                # Jumps to offset matching the expected time
+                r.get String, Integer, Time do |topic_id, partition_id, time|
+                  controller.closest(topic_id, partition_id, time)
+                end
+              end
+
+              r.get do
+                r.redirect root_path('scheduled_messages/schedules')
+              end
+            end
+
             r.on 'health' do
               controller = Controllers::HealthController.new(params)
 

data/lib/karafka/web/pro/ui/controllers/scheduled_messages/base_controller.rb

@@ -0,0 +1,29 @@
+# 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 Controllers
+          # Namespace for all controllers related to scheduled messages
+          module ScheduledMessages
+            # Base Pro controller for scheduled messages
+            class BaseController < Controllers::BaseController
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/karafka/web/pro/ui/controllers/scheduled_messages/explorer_controller.rb

@@ -0,0 +1,65 @@
+# 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 Controllers
+          module ScheduledMessages
+            # Allows for exploration of dispatch messages in a less generic form that via the
+            # explorer as different details are present
+            class ExplorerController < BaseController
+              # Displays aggregated messages from (potentially) all partitions of a topic
+              #
+              # @param topic_id [String]
+              def topic(topic_id)
+                response = Controllers::ExplorerController
+                           .new(@params)
+                           .topic(topic_id)
+
+                render(attributes: response.attributes)
+              end
+
+              # Shows messages available in a given partition
+              #
+              # @param topic_id [String]
+              # @param partition_id [Integer]
+              def partition(topic_id, partition_id)
+                response = Controllers::ExplorerController
+                           .new(@params)
+                           .partition(topic_id, partition_id)
+
+                render(attributes: response.attributes)
+              end
+
+              # Finds the closest offset matching the requested time and redirects to this location
+              # Note, that it redirects to closest but always younger.
+              #
+              # @param topic_id [String]
+              # @param partition_id [Integer]
+              # @param time [Time] time of the message
+              def closest(topic_id, partition_id, time)
+                response = Controllers::ExplorerController
+                           .new(@params)
+                           .closest(topic_id, partition_id, time)
+
+                redirect("scheduled_messages/#{response.path}")
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/karafka/web/pro/ui/controllers/scheduled_messages/schedules_controller.rb

@@ -0,0 +1,84 @@
+# 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 Controllers
+          # Namespace for all controllers related to scheduled messages
+          module ScheduledMessages
+            # Controller to display list of schedules (groups) and details about each
+            class SchedulesController < BaseController
+              # Displays list of groups
+              def index
+                topics = Models::Topic.all
+
+                # Names of scheduled messages topics defined in the routing
+                # They may not exist (yet) so we filter them based on the existing topics in the
+                # cluster
+                candidates = Karafka::App
+                             .routes
+                             .map(&:topics)
+                             .map(&:to_a)
+                             .flatten
+                             .select(&:scheduled_messages?)
+                             .reject { |topic| topic.name.end_with?(states_postfix) }
+                             .map(&:name)
+                             .sort
+
+                @topics = topics.select { |topic| candidates.include?(topic.topic_name) }
+
+                render
+              end
+
+              # Displays all partitions statistics (if any) with number of messages to dispatch
+              # @param schedule_name [String] name of the schedules messages topic
+              def show(schedule_name)
+                @schedule_name = schedule_name
+                @stats_topic_name = "#{schedule_name}#{states_postfix}"
+                @stats_info = Karafka::Admin.topic_info(@stats_topic_name)
+
+                @states = {}
+                @stats_info[:partition_count].times { |i| @states[i] = false }
+
+                Karafka::Pro::Iterator.new({ @stats_topic_name => -1 }).each do |message|
+                  @states[message.partition] = message.payload
+                end
+
+                # Sort by partition id
+                @states = @states.sort_by { |key, _| key.to_s }.to_h
+                # Sort daily from closest date
+                @states.each_value do |details|
+                  # Skip false predefined values from sorting
+                  next unless details
+
+                  details[:daily] = details[:daily].sort_by { |key, _| key.to_s }.to_h
+                end
+
+                render
+              end
+
+              private
+
+              # @return [String] states topic postfix
+              def states_postfix
+                @states_postfix ||= Karafka::App.config.scheduled_messages.states_postfix
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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/_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/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>