karafka-web 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '069037558ca061c8dd11c4fd48658699814f9904668463a957c7fabeff16fb4c'
-  data.tar.gz: 7627bf19b437d6b9e040c7d164a615d6cfcf0777d0294bb5958e4ea8b8e8a20c
+  metadata.gz: b03937826882f0a85bbd1718f2b09411148ec9647ab46d0d9a9701c278a07b66
+  data.tar.gz: 257bbf154f1d19aaaecd7150105ecd7233aa33f8bd42c4195a938c215061220b
 SHA512:
-  metadata.gz: 2bbd71a7eb35f534dbd262089651aaa241b481b44cd7e9841954571f47d7c8737c0f9c8dd14f479fec5d8b80315f5317c9177ca4c1a11689b8e973541a9107c4
-  data.tar.gz: 4b5100c7fb244bb53e5590b94cf16ef98203295944ffffb44f5e29af912848608e0d514d4eeaca0f47ff9aee85cb86e17712f79ceb698eccd96ea9ddf070fa4d
+  metadata.gz: 1aed9e94d037cd9bdaa07e55f96281f83dc18ebe151ec4a7f936e1592ac9d530a45fbb45dbd7c5d843692ede58bbca5d1d81a63974e222b0649cd0aa6bd8a9b6
+  data.tar.gz: 4ce6deaac3737bb8d25952158ac2b022621187bb8b0d42f952261b831d664e21cf5e12ff15bbccc054927a0b9dd000f75361270adeb3cb6708df93144b848d08

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Karafka Web changelog
 
+## 0.2.4 (2023-03-14)
+- [Improvement] Paginate topics list in cluster info on every 100 partitions.
+- [Improvement] Provide current page in the pagination.
+- [Improvement] Report usage of Karafka Pro on the status page view.
+- [Fix] Add missing three months limit on errors storage.
+- [Maintenance] Exclude Karafka Web UI topics from declarative topics.
+
 ## 0.2.3 (2023-03-04)
 - [Improvement] Snapshot current consumer tags upon consumer errors.
 - [Improvement] Optimize exception message extraction from errors.

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    karafka-web (0.2.3)
+    karafka-web (0.2.4)
       erubi (~> 1.4)
-      karafka (>= 2.0.33, < 3.0.0)
+      karafka (>= 2.0.35, < 3.0.0)
       karafka-core (>= 2.0.12, < 3.0.0)
       roda (~> 3.63)
       tilt (~> 2.0)
@@ -26,7 +26,7 @@ GEM
     ffi (1.15.5)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    karafka (2.0.33)
+    karafka (2.0.35)
       karafka-core (>= 2.0.12, < 3.0.0)
       thor (>= 0.20)
       waterdrop (>= 2.4.10, < 3.0.0)

data/karafka-web.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   spec.licenses    = %w[LGPL-3.0 Commercial]
 
   spec.add_dependency 'erubi', '~> 1.4'
-  spec.add_dependency 'karafka', '>= 2.0.33', '< 3.0.0'
+  spec.add_dependency 'karafka', '>= 2.0.35', '< 3.0.0'
   spec.add_dependency 'karafka-core', '>= 2.0.12', '< 3.0.0'
   spec.add_dependency 'roda', '~> 3.63'
   spec.add_dependency 'tilt', '~> 2.0'

data/lib/karafka/web/installer.rb

@@ -45,6 +45,7 @@ module Karafka
           consumer_group ::Karafka::Web.config.processing.consumer_group do
             # Topic we listen on to materialize the states
             topic ::Karafka::Web.config.topics.consumers.reports do
+              config(active: false)
               active ::Karafka::Web.config.processing.active
               # Since we materialize state in intervals, we can poll for half of this time without
               # impacting the reporting responsiveness
@@ -58,11 +59,13 @@ module Karafka
             # We define those two here without consumption, so Web understands how to deserialize
             # them when used / viewed
             topic ::Karafka::Web.config.topics.consumers.states do
+              config(active: false)
               active false
               deserializer web_deserializer
             end
 
             topic ::Karafka::Web.config.topics.errors do
+              config(active: false)
               active false
               deserializer web_deserializer
             end
@@ -126,7 +129,9 @@ module Karafka
           ::Karafka::Admin.create_topic(
             errors_topic,
             1,
-            replication_factor
+            replication_factor,
+            # Remove really old errors (older than 3 months just to preserve space)
+            { 'retention.ms': 3 * 31 * 24 * 60 * 60 * 1_000 }
           )
         end
       end

data/lib/karafka/web/ui/controllers/cluster.rb

@@ -10,13 +10,33 @@ module Karafka
           def index
             @cluster_info = Karafka::Admin.cluster_info
 
-            @topics = @cluster_info
-                      .topics
-                      .reject { |topic| topic[:topic_name] == '__consumer_offsets' }
-                      .sort_by { |topic| topic[:topic_name] }
+            partitions_total = []
+
+            displayable_topics(@cluster_info).each do |topic|
+              topic[:partitions].each do |partition|
+                partitions_total << partition.merge(topic: topic)
+              end
+            end
+
+            @partitions, @next_page = Ui::Lib::PaginateArray.new.call(
+              partitions_total,
+              @params.current_page
+            )
 
             respond
           end
+
+          private
+
+          # @param cluster_info [Rdkafka::Metadata] cluster metadata
+          # @return [Array<Hash>] array with topics to be displayed sorted in an alphabetical
+          #   order
+          def displayable_topics(cluster_info)
+            cluster_info
+              .topics
+              .reject { |topic| topic[:topic_name] == '__consumer_offsets' }
+              .sort_by { |topic| topic[:topic_name] }
+          end
         end
       end
     end

data/lib/karafka/web/ui/models/status.rb

@@ -118,6 +118,22 @@ module Karafka
             )
           end
 
+          # @return [Status::Step] is Pro enabled with all of its features.
+          # @note It's not an error not to have it but we want to warn, that some of the features
+          #   may not work without Pro.
+          def pro_subscription
+            status = if state_calculation.success?
+                       ::Karafka.pro? ? :success : :warning
+                     else
+                       :halted
+                     end
+
+            Step.new(
+              status,
+              nil
+            )
+          end
+
           private
 
           # @return [String] consumers states topic name

data/lib/karafka/web/ui/views/cluster/_partition.erb

@@ -1,3 +1,5 @@
+<% topic = partition[:topic] %>
+
 <% if topic[:topic_name] != '__consumer_offsets' %>
   <tr>
     <td>

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

@@ -56,15 +56,12 @@
             </tr>
           </thead>
           <tbody>
-            <% @topics.each do |topic| %>
-              <%==
-                each_partial(
-                  topic[:partitions],
-                  'cluster/partition',
-                  locals: { topic: topic }
-                )
-              %>
-            <% end %>
+            <%==
+              each_partial(
+                @partitions,
+                'cluster/partition'
+              )
+            %>
           </tbody>
         </table>
     </div>

data/lib/karafka/web/ui/views/shared/_pagination.erb

@@ -9,6 +9,12 @@
             </a>
           </li>
 
+          <li class="page-item active disabled">
+            <a class="page-link" href="<%= current_path(page: @current_page) %>">
+              <span><%= @current_page %></span>
+            </a>
+          </li>
+
           <li class="page-item <%= 'disabled' unless @next_page %>">
             <a class="page-link" href="<%= current_path(page: @next_page) %>">
               <span>Next &raquo;</span>

data/lib/karafka/web/ui/views/status/_warning.erb

@@ -0,0 +1,14 @@
+<div class="card border-warning mb-3">
+  <div class="card-header text-bg-warning">
+    <span>
+      <%= title %>
+    </span>
+
+    <span class="float-end">
+      <span class="badge  text-bg-light">Warning</span>
+    </span>
+  </div>
+  <div class="card-body">
+    <%== description %>
+  </div>
+</div>

data/lib/karafka/web/ui/views/status/show.erb

@@ -89,6 +89,21 @@
         )
       %>
 
+      <%==
+        partial(
+          "status/#{@status.pro_subscription.to_s}",
+          locals: {
+            title: 'Karafka Pro subscription',
+            description: partial(
+              'status/warnings/pro_subscription',
+              locals: {
+                details: @status.pro_subscription.details
+              }
+            )
+          }
+        )
+      %>
+
     </div>
   </div>
 </div>

data/lib/karafka/web/ui/views/status/warnings/_pro_subscription.erb

@@ -0,0 +1,9 @@
+<p>
+  You are using the OSS version of the Karafka ecosystem, and some of the Karafka ecosystem features are unavailable in the OSS version.
+</p>
+
+<p class="mb-0">
+  Please help us make the Karafka ecosystem better by subscribing to our
+  <a target="_blank" href="https://karafka.io/#become-pro">Pro</a>
+  offering.
+</p>

data/lib/karafka/web/version.rb

@@ -3,6 +3,6 @@
 module Karafka
   module Web
     # Current gem version
-    VERSION = '0.2.3'
+    VERSION = '0.2.4'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karafka-web
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -35,7 +35,7 @@ cert_chain:
   Qf04B9ceLUaC4fPVEz10FyobjaFoY4i32xRto3XnrzeAgfEe4swLq8bQsR3w/EF3
   MGU0FeSV2Yj7Xc2x/7BzLK8xQn5l7Yy75iPF+KP3vVmDHnNl
   -----END CERTIFICATE-----
-date: 2023-03-04 00:00:00.000000000 Z
+date: 2023-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubi
@@ -57,7 +57,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.33
+        version: 2.0.35
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
@@ -67,7 +67,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.0.33
+        version: 2.0.35
     - - "<"
       - !ruby/object:Gem::Version
         version: 3.0.0
@@ -314,6 +314,7 @@ files:
 - lib/karafka/web/ui/views/status/_failure.erb
 - lib/karafka/web/ui/views/status/_halted.erb
 - lib/karafka/web/ui/views/status/_success.erb
+- lib/karafka/web/ui/views/status/_warning.erb
 - lib/karafka/web/ui/views/status/failures/_connection.erb
 - lib/karafka/web/ui/views/status/failures/_initial_state.erb
 - lib/karafka/web/ui/views/status/failures/_live_reporting.erb
@@ -321,6 +322,7 @@ files:
 - lib/karafka/web/ui/views/status/failures/_state_calculation.erb
 - lib/karafka/web/ui/views/status/failures/_topics.erb
 - lib/karafka/web/ui/views/status/show.erb
+- lib/karafka/web/ui/views/status/warnings/_pro_subscription.erb
 - lib/karafka/web/version.rb
 homepage: https://karafka.io
 licenses: