karafka-web 0.11.1 → 0.11.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb9cef529c70e9f643eef6d7d8e70022ddd99fcf2909d40c350d1948bc50dc8f
-  data.tar.gz: '02795dbd46f18bba63aadc8ccdd95910e183f0df5a8147ab8ac897c6e4a85623'
+  metadata.gz: 7b958131581b6fe2fd1a45a68b7366fb842ca15eccd946988516e78b7fcc3cce
+  data.tar.gz: 899898076b7fc09111d8cfd77f5e68fe6158b9bfee3128292f77248f2b5922c8
 SHA512:
-  metadata.gz: 21559bfd9b8d66872b6499823feec8c34ad7827a36ca5c7170d2a37d74dc2ffbc11ffc109c65cf7c7a6b5e2a70e1493a585cfbd550779f7b21077c62f2b8de8a
-  data.tar.gz: a6fc4f1592472218556b82c6a5cd3cf0b4a5acc2d1db6546245a5eaab8a7d3d81733f9cea7d9e344e919793e05768da5f5d6f516158559ffc6ef6a9939d0a76f
+  metadata.gz: b53b0e2dc696cf5af719ad49b90c130a7122261a8123e5ac8ca4deb31d0f397e49f09d71032df4e840ad3a5f9b5b3115709fbcd08568a0991ee24b0da1b7054e
+  data.tar.gz: b3eeac33c925b9527aef85231a74a255c3d59aedd36f20a174e72b282db744cb6a0779258c9136266f54041ab0e81ce8c95a6a042d4ecc908e0cbba299d651f3

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Karafka Web Changelog
 
+## 0.11.3 (2025-09-29)
+- [Enhancement] Upgrade DaisyUI to 5.1.
+- [Change] Remove Ruby `3.1` support according to the EOL schedule.
+- [Change] Normalize how libs and dependencies are required (no functional change for the end user)
+- [Fix] Fix a case where the states JSON would contain multiple entries for the same processes causing `JSON.parse` with `allow_duplicate_key: false` to fail.
+- [Fix] Fix incorrect reference to `IncompatibleSchemaError`.
+
+## 0.11.2 (2025-08-18)
+- [Enhancement] Make sure that TTL counters related `#inspect` are thread-safe.
+- [Change] Add new CI action to trigger auto-doc refresh.
+- [Change] Update daisyUI to `5.0.50`
+
 ## 0.11.1 (2025-06-23)
 - [Fix] Extremely high error turnover from hundreds of partitions can cause a deadlock in the reporter for transactional Web producer.
 
@@ -153,6 +165,9 @@
 - [Fix] License identifier `LGPL-3.0` is deprecated for SPDX (#2177).
 - [Fix] Do not include prettifying the payload for visibility in the resource computation cost.
 
+## 0.9.2 (2025-09-19)
+- [Fix] Fix BaseController caller action name extraction.
+
 ## 0.9.1 (2024-05-03)
 - [Fix] OSS `lag_stored` for not-subscribed consumers causes Web UI to crash.
 

data/Gemfile

@@ -6,8 +6,6 @@ plugin 'diffend'
 
 gemspec
 
-gem 'karafka'
-
 group :test do
   gem 'byebug'
   gem 'factory_bot'

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    karafka-web (0.11.1)
+    karafka-web (0.11.3)
       erubi (~> 1.4)
-      karafka (>= 2.5.0.rc2, < 2.6.0)
+      karafka (>= 2.5.0, < 2.6.0)
       karafka-core (>= 2.5.0, < 2.6.0)
       roda (~> 3.68, >= 3.69)
       tilt (~> 2.0)
@@ -11,7 +11,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.2.2.1)
+    activesupport (7.2.2.2)
       base64
       benchmark (>= 0.3)
       bigdecimal
@@ -35,10 +35,20 @@ GEM
     erubi (1.13.1)
     et-orbi (1.2.11)
       tzinfo
-    factory_bot (6.5.4)
+    factory_bot (6.5.5)
       activesupport (>= 6.1.0)
     ffi (1.17.2)
-    fugit (1.11.1)
+    ffi (1.17.2-aarch64-linux-gnu)
+    ffi (1.17.2-aarch64-linux-musl)
+    ffi (1.17.2-arm-linux-gnu)
+    ffi (1.17.2-arm-linux-musl)
+    ffi (1.17.2-arm64-darwin)
+    ffi (1.17.2-x86-linux-gnu)
+    ffi (1.17.2-x86-linux-musl)
+    ffi (1.17.2-x86_64-darwin)
+    ffi (1.17.2-x86_64-linux-gnu)
+    ffi (1.17.2-x86_64-linux-musl)
+    fugit (1.11.2)
       et-orbi (~> 1, >= 1.2.11)
       raabro (~> 1.4)
     i18n (1.14.7)
@@ -52,42 +62,58 @@ GEM
     karafka-core (2.5.2)
       karafka-rdkafka (>= 0.19.2, < 0.21.0)
       logger (>= 1.6.0)
-    karafka-rdkafka (0.19.5)
+    karafka-rdkafka (0.20.1)
       ffi (~> 1.15)
+      logger
+      mini_portile2 (~> 2.6)
+      rake (> 12)
+    karafka-rdkafka (0.20.1-arm64-darwin)
+      ffi (~> 1.15)
+      logger
+      mini_portile2 (~> 2.6)
+      rake (> 12)
+    karafka-rdkafka (0.20.1-x86_64-linux-gnu)
+      ffi (~> 1.15)
+      logger
+      mini_portile2 (~> 2.6)
+      rake (> 12)
+    karafka-rdkafka (0.20.1-x86_64-linux-musl)
+      ffi (~> 1.15)
+      logger
       mini_portile2 (~> 2.6)
       rake (> 12)
     logger (1.7.0)
     mini_portile2 (2.8.9)
     minitest (5.25.5)
-    nokogiri (1.18.8)
+    nokogiri (1.18.10)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    nokogiri (1.18.8-aarch64-linux-gnu)
+    nokogiri (1.18.10-aarch64-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.18.8-aarch64-linux-musl)
+    nokogiri (1.18.10-aarch64-linux-musl)
       racc (~> 1.4)
-    nokogiri (1.18.8-arm-linux-gnu)
+    nokogiri (1.18.10-arm-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.18.8-arm-linux-musl)
+    nokogiri (1.18.10-arm-linux-musl)
       racc (~> 1.4)
-    nokogiri (1.18.8-arm64-darwin)
+    nokogiri (1.18.10-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.18.8-x86_64-darwin)
+    nokogiri (1.18.10-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.18.8-x86_64-linux-gnu)
+    nokogiri (1.18.10-x86_64-linux-gnu)
       racc (~> 1.4)
-    nokogiri (1.18.8-x86_64-linux-musl)
+    nokogiri (1.18.10-x86_64-linux-musl)
       racc (~> 1.4)
-    ostruct (0.6.2)
+    ostruct (0.6.3)
     raabro (1.4.0)
     racc (1.8.1)
-    rack (3.1.15)
+    rack (3.1.16)
     rack-test (2.2.0)
       rack (>= 1.3)
     rackup (0.2.3)
       rack (>= 3.0.0.beta1)
       webrick
-    rake (13.2.1)
+    rake (13.3.0)
     roda (3.92.0)
       rack
     rspec (3.13.1)
@@ -137,7 +163,6 @@ DEPENDENCIES
   byebug
   factory_bot
   fugit
-  karafka
   karafka-web!
   nokogiri
   ostruct

data/bin/verify_kafka_warnings

@@ -13,7 +13,7 @@ allowed_patterns=(
 )
 
 # Get all warnings
-warnings=$(docker logs --since=0 kafka | grep WARN)
+warnings=$(docker logs --since=0 kafka | grep "] WARN ")
 exit_code=0
 
 while IFS= read -r line; do

data/config/locales/errors.yml

@@ -7,3 +7,4 @@ en:
       missing: needs to be present
       id_format: needs to be a String
       format: is invalid
+      processes_format: must be a hash with symbol keys

data/docker-compose.yml

@@ -1,9 +1,7 @@
-version: '2'
-
 services:
   kafka:
     container_name: kafka
-    image: confluentinc/cp-kafka:8.0.0
+    image: confluentinc/cp-kafka:8.0.1
 
     ports:
       - 9092:9092

data/karafka-web.gemspec

@@ -17,14 +17,14 @@ Gem::Specification.new do |spec|
   spec.licenses    = %w[LGPL-3.0-only Commercial]
 
   spec.add_dependency 'erubi', '~> 1.4'
-  spec.add_dependency 'karafka', '>= 2.5.0.rc2', '< 2.6.0'
+  spec.add_dependency 'karafka', '>= 2.5.0', '< 2.6.0'
   spec.add_dependency 'karafka-core', '>= 2.5.0', '< 2.6.0'
   spec.add_dependency 'roda', '~> 3.68', '>= 3.69'
   spec.add_dependency 'tilt', '~> 2.0'
 
   spec.add_development_dependency 'rackup', '~> 0.2'
 
-  spec.required_ruby_version = '>= 3.1.0'
+  spec.required_ruby_version = '>= 3.2.0'
 
   spec.executables   = %w[karafka-web]
   spec.require_paths = %w[lib]

data/lib/karafka/web/deserializer.rb

@@ -21,7 +21,12 @@ module Karafka
 
         ::JSON.parse(
           raw_payload,
-          symbolize_names: true
+          symbolize_names: true,
+          # We allow duplicates keys because of a fixed bug that was causing duplicated process
+          # ids to leak into the consumers states data. Once a proper migration is written, this
+          # can be retired
+          # @see https://github.com/karafka/karafka-web/issues/741
+          allow_duplicate_key: true
         )
       end
     end

data/lib/karafka/web/errors.rb

@@ -54,6 +54,14 @@ module Karafka
 
         # Similar to the one related to consumers states
         MissingConsumersMetricsTopicError = Class.new(BaseError)
+
+        # Similar to management and ui errors with the same name, it is raised when a critical
+        # incompatibility is detected during processing.
+        #
+        # This error is raised when there was an attempt to process reports that are in a newer
+        # version that the one in the current process. We prevent this from happening not to
+        # corrupt the data. Please upgrade all the Web UI consumers to the same version
+        IncompatibleSchemaError = Class.new(BaseError)
       end
 
       # Ui related errors
@@ -67,11 +75,6 @@ module Karafka
 
         # Raised when we want to stop the flow and render 403
         ForbiddenError = Class.new(BaseError)
-
-        # Raised when trying to get info about a consumer that has incompatible schema in its
-        # report. It usually means you are running different version of the Web UI in the consumer
-        # and in the Web server
-        IncompatibleSchemaError = Class.new(BaseError)
       end
     end
   end

data/lib/karafka/web/processing/consumers/aggregators/state.rb

@@ -51,7 +51,11 @@ module Karafka
             # @param report [Hash]
             # @param offset [Integer]
             def add_state(report, offset)
-              process_id = report[:process][:id]
+              # When we deserialize the keys from the stored state, because we convert keys into
+              # symbols, we may have given process state already stored. This means that in order
+              # to update it, we do need to have the new report process id also as a symbol to
+              # act as the key
+              process_id = report[:process][:id].to_sym
 
               state[:processes][process_id] = {
                 dispatched_at: report[:dispatched_at],

data/lib/karafka/web/processing/consumers/contracts/state.rb

@@ -19,9 +19,14 @@ module Karafka
             required(:schema_version) { |val| val.is_a?(String) && !val.empty? }
             required(:dispatched_at) { |val| val.is_a?(Numeric) && val.positive? }
             required(:stats) { |val| val.is_a?(Hash) }
-            required(:processes) { |val| val.is_a?(Hash) }
             required(:schema_state) { |val| VALID_SCHEMA_STATES.include?(val) }
 
+            required(:processes) do |val|
+              next false unless val.is_a?(Hash)
+
+              val.keys.all? { |key| key.is_a?(Symbol) }
+            end
+
             virtual do |data, errors|
               next unless errors.empty?
 

data/lib/karafka/web/tracking/helpers/ttls/array.rb

@@ -56,6 +56,17 @@ module Karafka
               super
             end
 
+            # @return [String] thread-safe inspection string
+            def inspect
+              clear
+              size = @accu.size
+
+              parts = ["ttl=#{@ttl}ms"]
+              parts << "size=#{size}"
+
+              "#<#{self.class.name}:#{format('%#x', object_id)} #{parts.join(' ')}>"
+            end
+
             private
 
             # Evicts outdated samples

data/lib/karafka/web/tracking/helpers/ttls/hash.rb

@@ -10,7 +10,8 @@ module Karafka
           class Hash < Hash
             # @param ttl [Integer] milliseconds ttl
             def initialize(ttl)
-              super() { |k, v| k[v] = Ttls::Array.new(ttl) }
+              @ttl = ttl
+              super() { |k, v| k[v] = Ttls::Array.new(@ttl) }
             end
 
             # Takes a block where we provide a hash select filtering to select keys we are
@@ -26,6 +27,11 @@ module Karafka
                 select(&block)
               )
             end
+
+            # @return [String] thread-safe inspect of the ttls hash
+            def inspect
+              "#<#{self.class.name}:#{format('%#x', object_id)} size=#{size} ttl=#{@ttl}ms>"
+            end
           end
         end
       end

data/lib/karafka/web/tracking/producers/listeners/base.rb

@@ -12,7 +12,7 @@ module Karafka
             extend Forwardable
 
             def_delegators :sampler, :track
-            def_delegators :reporter, :report, :report!
+            def_delegators :reporter, :report
 
             private