karafka-web 0.5.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9edb576f473624295de9b0f1d62cbed131c9be1b480958a63c33f891fbf7cb19
-  data.tar.gz: 4f71e3a6ce1ca6eb423550824c5381e3b2b237c1b2af88c9108359bd225a7444
+  metadata.gz: 9696cc8cfbcb6124155dbac2a3c92cadca69bd1acec727418874ecdd24f49de1
+  data.tar.gz: eb60dcbf83ba9cbd8f542b2e536e2e1c5328ee3fe358b234916575202ee75bba
 SHA512:
-  metadata.gz: 7e0f77ed2a8e6c902596d2fad16938c3117a49c3faa7d9c60e8018c24135b9c3f38e45ffe5a0aa6fffdbf6f514956d4122afbb90a021f0c6f6274e0cb5212e75
-  data.tar.gz: 6fc0272d850dcdd99c277dabb38c5a0761646709f679b794f5c4b8161eb9217439f087b7d3eba3763bec60902874413506c6492dbb9ee63a992a0b6674124689
+  metadata.gz: 133ecc3adc65e9559a317b4148813b95f21a41150a271f754e726d2617f19515e89498322b0b50e808825a9793a78472041618c584aaf3797e80259a2f296782
+  data.tar.gz: bf07811d4f0825f0c9770ae04218c2d73c24eed397296ae54fbeb5f8898a6db750952588426ad45ded5c88d9ce498b3aadf54a202852f4ec8193fd9ff4a159d3

data/CHANGELOG.md

@@ -1,6 +1,17 @@
 # Karafka Web changelog
 
-## 0.5.0 (2022-04-13)
+## 0.5.2 (2023-05-22)
+- Label ActiveJob consumers jobs with `active_job` tag.
+- Label Virtual Partitions consumers with `virtual` tag.
+- Label Long Running Jobs with `long_running_job` tag.
+- Label collapsed Virtual Partition with `collapsed` tag.
+- Display consumer tags always below the consumer class name in Jobs/Consumer Jobs views.
+- Add label with the attempt count on work being retried.
+
+## 0.5.1 (2023-04-16)
+- [Fix] Use CSP header matching Sidekiq one to ensure styles and js loading (#55)
+
+## 0.5.0 (2023-04-13)
 - [Improvement] Report job `-1001` offsets as `N/A` as in all the other places.
 - [Fix] Fix misspelling of word `committed`.
 - [Fix] Shutdown and revocation jobs statistics extraction crashes when idle initialized without messages (#53)

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    karafka-web (0.5.0)
+    karafka-web (0.5.2)
       erubi (~> 1.4)
       karafka (>= 2.0.40, < 3.0.0)
       karafka-core (>= 2.0.12, < 3.0.0)
@@ -24,9 +24,9 @@ GEM
     factory_bot (6.2.1)
       activesupport (>= 5.0.0)
     ffi (1.15.5)
-    i18n (1.12.0)
+    i18n (1.13.0)
       concurrent-ruby (~> 1.0)
-    karafka (2.0.40)
+    karafka (2.0.41)
       karafka-core (>= 2.0.12, < 3.0.0)
       thor (>= 0.20)
       waterdrop (>= 2.4.10, < 3.0.0)
@@ -38,22 +38,22 @@ GEM
       ffi (~> 1.15)
       mini_portile2 (~> 2.6)
       rake (> 12)
-    mini_portile2 (2.8.1)
+    mini_portile2 (2.8.2)
     minitest (5.18.0)
     rack (3.0.7)
     rackup (0.2.3)
       rack (>= 3.0.0.beta1)
       webrick
     rake (13.0.6)
-    roda (3.66.0)
+    roda (3.67.0)
       rack
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
       rspec-expectations (~> 3.12.0)
       rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.1)
+    rspec-core (3.12.2)
       rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-mocks (3.12.5)
@@ -70,14 +70,13 @@ GEM
     tilt (2.1.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    waterdrop (2.5.1)
+    waterdrop (2.5.2)
       karafka-core (>= 2.0.12, < 3.0.0)
       zeitwerk (~> 2.3)
     webrick (1.8.1)
-    zeitwerk (2.6.7)
+    zeitwerk (2.6.8)
 
 PLATFORMS
-  arm64-darwin-21
   x86_64-linux
 
 DEPENDENCIES
@@ -89,4 +88,4 @@ DEPENDENCIES
   simplecov
 
 BUNDLED WITH
-   2.4.10
+   2.4.12

data/lib/karafka/web/config.rb

@@ -45,7 +45,8 @@ module Karafka
             Tracking::Consumers::Listeners::Errors.new,
             Tracking::Consumers::Listeners::Statistics.new,
             Tracking::Consumers::Listeners::Pausing.new,
-            Tracking::Consumers::Listeners::Processing.new
+            Tracking::Consumers::Listeners::Processing.new,
+            Tracking::Consumers::Listeners::Tags.new
           ]
         end
 

data/lib/karafka/web/tracking/consumers/listeners/tags.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Web
+    module Tracking
+      module Consumers
+        module Listeners
+          # Listener used to attach tags to consumers for Web-UI usage. Those tags will be picked
+          # up by another listener
+          #
+          # @note We cannot attach here certain the ActiveJob consumer tags and they need to be
+          #   in Karafka itself (mainly the per AJ job tag) because from the outside consumer
+          #   perspective we have a single consumption that can run multiple different AJ jobs
+          #
+          # @note We can assign tags here and the order of tracking listeners does not matter,
+          #   because tags state for consumers is materialized in the moment of reporting.
+          class Tags < Base
+            # @param event [Karafka::Core::Monitoring::Event]
+            def on_consumer_consume(event)
+              consumer = event.payload[:caller]
+
+              tag_active_job(consumer)
+              tag_attempt(consumer)
+
+              return unless Karafka.pro?
+
+              tag_virtual_partitions(consumer)
+              tag_long_running_job(consumer)
+            end
+
+            private
+
+            # Adds ActiveJob consumer related tags
+            #
+            # @param consumer [Karafka::BaseConsumer]
+            def tag_active_job(consumer)
+              return unless consumer.topic.active_job?
+
+              consumer.tags.add(:active_job, :active_job)
+            end
+
+            # Adds attempts counter if this is not the first attempt. Not the first means, there
+            # was an error and we are re-processing.
+            #
+            # @param consumer [Karafka::BaseConsumer]
+            def tag_attempt(consumer)
+              attempt = consumer.coordinator.pause_tracker.attempt
+
+              if attempt > 1
+                consumer.tags.add(:attempt, "attempt:#{attempt}")
+              else
+                consumer.tags.delete(:attempt)
+              end
+            end
+
+            # Tags virtual partitioned consumers and adds extra info if operates in a collapsed
+            # mode
+            #
+            # @param consumer [Karafka::BaseConsumer]
+            def tag_virtual_partitions(consumer)
+              return unless consumer.topic.virtual_partitions?
+
+              consumer.tags.add(:virtual, :virtual)
+
+              if consumer.collapsed?
+                consumer.tags.add(:collapsed, :collapsed)
+              else
+                consumer.tags.delete(:collapsed)
+              end
+            end
+
+            # Tags long running job consumer work
+            #
+            # @param consumer [Karafka::BaseConsumer]
+            def tag_long_running_job(consumer)
+              return unless consumer.topic.long_running_job?
+
+              consumer.tags.add(:long_running_job, :long_running)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/karafka/web/ui/base.rb

@@ -25,6 +25,24 @@ module Karafka
         plugin :not_found
         plugin :path
 
+        # Based on
+        # https://github.com/sidekiq/sidekiq/blob/ae6ca119/lib/sidekiq/web/application.rb#L8
+        plugin :content_security_policy do |csp|
+          csp.default_src "'self' https: http:"
+          csp.child_src "'self'"
+          csp.connect_src "'self' https: http: wss: ws:"
+          csp.font_src "'self' https: http:"
+          csp.frame_src "'self'"
+          csp.img_src "'self' https: http: data:"
+          csp.manifest_src "'self'"
+          csp.media_src "'self'"
+          csp.object_src "'none'"
+          csp.script_src "'self' https: http: 'unsafe-inline'"
+          csp.style_src "'self' https: http: 'unsafe-inline'"
+          csp.worker_src "'self'"
+          csp.base_uri "'self'"
+        end
+
         # Display appropriate error specific to a given error type
         plugin :error_handler, classes: [
           ::Karafka::Web::Errors::Ui::NotFoundError,

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

@@ -2,8 +2,9 @@
   <td>
     <code><%= job.consumer %></code>
 
-    <% job.tags.each do |tag| %>
-      <span class="badge bg-info"><%= tag %></span>
+    <% unless job.tags.empty? %>
+      <br/>
+      <%== tags(job.tags) %>
     <% end %>
   </td>
   <td>

data/lib/karafka/web/ui/pro/views/jobs/_job.erb

@@ -13,7 +13,10 @@
   <td>
     <code><%= job.consumer %></code>
 
-    <%== tags(job.tags) %>
+    <% unless job.tags.empty? %>
+      <br/>
+      <%== tags(job.tags) %>
+    <% end %>
   </td>
   <td>
     <code>#<%= job.type %></code>

data/lib/karafka/web/ui/views/jobs/_job.erb

@@ -13,7 +13,10 @@
   <td>
     <code><%= job.consumer %></code>
 
-    <%== tags(job.tags) %>
+    <% unless job.tags.empty? %>
+      <br/>
+      <%== tags(job.tags) %>
+    <% end %>
   </td>
   <td>
     <code>#<%= job.type %></code>

data/lib/karafka/web/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karafka-web
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -35,7 +35,7 @@ cert_chain:
   Qf04B9ceLUaC4fPVEz10FyobjaFoY4i32xRto3XnrzeAgfEe4swLq8bQsR3w/EF3
   MGU0FeSV2Yj7Xc2x/7BzLK8xQn5l7Yy75iPF+KP3vVmDHnNl
   -----END CERTIFICATE-----
-date: 2023-04-13 00:00:00.000000000 Z
+date: 2023-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: erubi
@@ -184,6 +184,7 @@ files:
 - lib/karafka/web/tracking/consumers/listeners/processing.rb
 - lib/karafka/web/tracking/consumers/listeners/statistics.rb
 - lib/karafka/web/tracking/consumers/listeners/status.rb
+- lib/karafka/web/tracking/consumers/listeners/tags.rb
 - lib/karafka/web/tracking/consumers/sampler.rb
 - lib/karafka/web/tracking/memoized_shell.rb
 - lib/karafka/web/tracking/reporter.rb