karafka-web 0.11.5 → 0.11.6

data/lib/karafka/web/management/actions/create_initial_states.rb

@@ -10,38 +10,38 @@ module Karafka
           # Whole default empty state
           # This will be further migrated by the migrator
           DEFAULT_STATE = {
-            schema_version: '0.0.0'
+            schema_version: "0.0.0"
           }.freeze
 
           # Default metrics state
           DEFAULT_METRICS = {
-            schema_version: '0.0.0'
+            schema_version: "0.0.0"
           }.freeze
 
           # Creates the initial states for the Web-UI if needed (if they don't exist)
           def call
             if exists?(Karafka::Web.config.topics.consumers.states.name)
-              exists('consumers state')
+              exists("consumers state")
             else
-              creating('consumers state')
+              creating("consumers state")
               ::Karafka::Web.producer.produce_sync(
                 topic: Karafka::Web.config.topics.consumers.states.name,
                 key: Karafka::Web.config.topics.consumers.states.name,
                 payload: DEFAULT_STATE.to_json
               )
-              created('consumers state')
+              created("consumers state")
             end
 
             if exists?(Karafka::Web.config.topics.consumers.metrics.name)
-              exists('consumers metrics')
+              exists("consumers metrics")
             else
-              creating('consumers metrics')
+              creating("consumers metrics")
               ::Karafka::Web.producer.produce_sync(
                 topic: Karafka::Web.config.topics.consumers.metrics.name,
                 key: Karafka::Web.config.topics.consumers.metrics.name,
                 payload: DEFAULT_METRICS.to_json
               )
-              created('consumers metrics')
+              created("consumers metrics")
             end
           end
 

data/lib/karafka/web/management/actions/enable.rb

@@ -35,7 +35,7 @@ module Karafka
           def ensure_karafka_initialized!
             return unless Karafka::App.config.internal.status.initializing?
 
-            raise Web::Errors::KarafkaNotInitializedError, 'Please initialize Karafka first'
+            raise Web::Errors::KarafkaNotInitializedError, "Please initialize Karafka first"
           end
 
           # Enables tracking if it was not explicitly disabled by the user
@@ -72,7 +72,7 @@ module Karafka
                   # This prevents us from dealing with cases, where client id would be changed and
                   # consumer group name would be renamed and we would start consuming all
                   # historical
-                  initial_offset 'latest'
+                  initial_offset "latest"
                   # Increase backoff time on errors. Incompatible schema errors are not recoverable
                   # until rolling upgrade completes, so we use a longer max timeout to prevent
                   # spamming errors in logs.
@@ -145,7 +145,7 @@ module Karafka
           #
           # In other places, this producer anyhow should not be used.
           def subscribe_to_close_web_producer
-            ::Karafka::App.monitor.subscribe('app.terminated') do
+            ::Karafka::App.monitor.subscribe("app.terminated") do
               # If Web producer is the same as `Karafka.producer` it will do nothing as you can
               # call `#close` multiple times without side effects
               ::Karafka::Web.producer.close

data/lib/karafka/web/management/actions/extend_boot_file.rb

@@ -7,7 +7,7 @@ module Karafka
         # Extends the boot file with Web components
         class ExtendBootFile < Base
           # Code that is needed in the `karafka.rb` to connect Web UI to Karafka
-          ENABLER_CODE = 'Karafka::Web.enable!'
+          ENABLER_CODE = "Karafka::Web.enable!"
 
           # Template with initial Web UI configuration
           # Session secret needs to be set per user and per env
@@ -27,8 +27,8 @@ module Karafka
             if File.readlines(Karafka.boot_file).any? { |line| line.start_with?(ENABLER_CODE) }
               puts "Web UI #{already} installed."
             else
-              puts 'Updating the Karafka boot file...'
-              File.open(Karafka.boot_file, 'a') do |f|
+              puts "Updating the Karafka boot file..."
+              File.open(Karafka.boot_file, "a") do |f|
                 f << "\n#{SETUP_TEMPLATE}\n"
               end
               puts "Karafka boot file #{successfully} updated."

data/lib/karafka/web/management/migrations/base.rb

@@ -27,7 +27,7 @@ module Karafka
 
             # @param state [Hash] deserialized state to be modified
             def migrate(state)
-              raise NotImplementedError, 'Implement in a subclass'
+              raise NotImplementedError, "Implement in a subclass"
             end
 
             # @return [Integer] index for sorting. Older migrations are always applied first
@@ -35,9 +35,9 @@ module Karafka
               instance_method(:migrate)
                 .source_location
                 .first
-                .split('/')
+                .split("/")
                 .last
-                .split('_')
+                .split("_")
                 .first
                 .to_i
             end

data/lib/karafka/web/management/migrations/consumers_metrics/0_set_initial.rb

@@ -10,7 +10,7 @@ module Karafka
           # This is the basic of metrics as they were when they were introduced.
           class SetInitial < Base
             # Always migrate from empty up
-            self.versions_until = '0.0.1'
+            self.versions_until = "0.0.1"
             self.type = :consumers_metrics
 
             # @param state [Hash] initial empty state

data/lib/karafka/web/management/migrations/consumers_metrics/1699543515_fill_missing_received_and_sent_bytes.rb

@@ -8,7 +8,7 @@ module Karafka
           # Adds bytes_sent and bytes_received to all the aggregated metrics samples, so we have
           # charts that do not have to fill gaps or check anything
           class FillMissingReceivedAndSentBytes < Base
-            self.versions_until = '1.1.0'
+            self.versions_until = "1.1.0"
             self.type = :consumers_metrics
 
             # @param state [Hash] metrics state

data/lib/karafka/web/management/migrations/consumers_metrics/1700234522_introduce_waiting.rb

@@ -7,7 +7,7 @@ module Karafka
         module ConsumersMetrics
           # Introduce waiting in consumers metrics to complement busy and enqueued for jobs metrics
           class IntroduceWaiting < Base
-            self.versions_until = '1.1.1'
+            self.versions_until = "1.1.1"
             self.type = :consumers_metrics
 
             # @param state [Hash]

data/lib/karafka/web/management/migrations/consumers_metrics/1700234522_remove_processing.rb

@@ -7,7 +7,7 @@ module Karafka
         module ConsumersMetrics
           # Moves unused "processing" that was used instead of "busy" in older versions
           class RemoveProcessing < Base
-            self.versions_until = '1.1.1'
+            self.versions_until = "1.1.1"
             self.type = :consumers_metrics
 
             # @param state [Hash]

data/lib/karafka/web/management/migrations/consumers_metrics/1704722380_split_listeners_into_active_and_paused.rb

@@ -8,7 +8,7 @@ module Karafka
           # Since we have introduced notion of pause listeners, we need to reflect this in the
           # UI, so the scaling changes are visible
           class SplitListenersIntoActiveAndPaused < Base
-            self.versions_until = '1.1.2'
+            self.versions_until = "1.1.2"
             self.type = :consumers_metrics
 
             # @param state [Hash]
@@ -16,12 +16,12 @@ module Karafka
               state[:aggregated].each_value do |metrics|
                 metrics.each do |metric|
                   listeners = if metric.last.key?(:listeners)
-                                metric.last[:listeners].to_i
-                              elsif metric.last.key?(:listeners_count)
-                                metric.last[:listeners_count].to_i
-                              else
-                                0
-                              end
+                    metric.last[:listeners].to_i
+                  elsif metric.last.key?(:listeners_count)
+                    metric.last[:listeners_count].to_i
+                  else
+                    0
+                  end
 
                   metric.last[:listeners] = {
                     active: listeners,

data/lib/karafka/web/management/migrations/consumers_metrics/1706607960_introduce_lag_total.rb

@@ -7,7 +7,7 @@ module Karafka
         module ConsumersMetrics
           # Moves to using lag total as a normalization for both lags
           class IntroduceLagTotal < Base
-            self.versions_until = '1.2.0'
+            self.versions_until = "1.2.0"
             self.type = :consumers_metrics
 
             # @param state [Hash]

data/lib/karafka/web/management/migrations/consumers_metrics/1706611396_rename_lag_total_to_lag_hybrid.rb

@@ -7,7 +7,7 @@ module Karafka
         module ConsumersMetrics
           # Renames total lag to hybrid to better represent what it is
           class RenameLagTotalToLagHybrid < Base
-            self.versions_until = '1.2.1'
+            self.versions_until = "1.2.1"
             self.type = :consumers_metrics
 
             # @param state [Hash]

data/lib/karafka/web/management/migrations/consumers_metrics/1716218393_populate_jobs_metrics.rb

@@ -7,7 +7,7 @@ module Karafka
         module ConsumersMetrics
           # Adds the jobs metric matching batches for aggregated metrics results
           class PopulateJobsMetrics < Base
-            self.versions_until = '1.3.0'
+            self.versions_until = "1.3.0"
             self.type = :consumers_metrics
 
             # @param state [Hash]

data/lib/karafka/web/management/migrations/consumers_reports/1761645571_rename_process_name_to_id.rb

@@ -16,7 +16,7 @@ module Karafka
           # expect the :id field.
           class RenameProcessNameToId < Base
             # Apply to all schema versions before 1.3.0
-            self.versions_until = '1.3.0'
+            self.versions_until = "1.3.0"
             self.type = :consumers_reports
 
             # @param report [Hash] consumer report to migrate

data/lib/karafka/web/management/migrations/consumers_reports/1765657887_add_group_instance_id_to_subscription_groups.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Web
+    module Management
+      module Migrations
+        module ConsumersReports
+          # Adds the instance_id field to subscription groups
+          #
+          # In schema versions before 1.6.0, subscription groups did not include the
+          # instance_id field which is used for static group membership tracking.
+          #
+          # This migration ensures old reports can be processed by adding the field with
+          # false value (indicating no static membership configured).
+          class AddGroupInstanceIdToSubscriptionGroups < Base
+            self.versions_until = "1.6.0"
+            self.type = :consumers_reports
+
+            # @param report [Hash] consumer report to migrate
+            def migrate(report)
+              consumer_groups = report[:consumer_groups]
+
+              return unless consumer_groups
+
+              consumer_groups.each_value do |cg_details|
+                subscription_groups = cg_details[:subscription_groups]
+
+                next unless subscription_groups
+
+                subscription_groups.each_value do |sg_details|
+                  next if sg_details.key?(:instance_id)
+
+                  sg_details[:instance_id] = false
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/karafka/web/management/migrations/consumers_states/0_set_initial.rb

@@ -10,7 +10,7 @@ module Karafka
           # This is the basic of state as they were when they were introduced.
           class SetInitial < Base
             # Run this only on the first setup
-            self.versions_until = '0.0.1'
+            self.versions_until = "0.0.1"
             self.type = :consumers_states
 
             # @param state [Hash]
@@ -34,7 +34,7 @@ module Karafka
                   lag_stored: 0,
                   lag: 0
                 },
-                schema_state: 'accepted',
+                schema_state: "accepted",
                 dispatched_at: float_now
               )
             end

data/lib/karafka/web/management/migrations/consumers_states/1699543515_fill_missing_received_and_sent_bytes.rb

@@ -9,7 +9,7 @@ module Karafka
           # present as expected
           class FillMissingReceivedAndSentBytes < Base
             # Network metrics were introduced with schema 1.2.0
-            self.versions_until = '1.2.0'
+            self.versions_until = "1.2.0"
             self.type = :consumers_states
 
             # @param state [Hash]

data/lib/karafka/web/management/migrations/consumers_states/1700234522_introduce_waiting.rb

@@ -7,7 +7,7 @@ module Karafka
         module ConsumersStates
           # Introduce waiting in consumers metrics to complement busy and enqueued for jobs stats
           class IntroduceWaiting < Base
-            self.versions_until = '1.2.1'
+            self.versions_until = "1.2.1"
             self.type = :consumers_states
 
             # @param state [Hash]

data/lib/karafka/web/management/migrations/consumers_states/1700234522_remove_processing.rb

@@ -7,7 +7,7 @@ module Karafka
         module ConsumersStates
           # Moves unused "processing" that was used instead of "busy" in older versions
           class RemoveProcessing < Base
-            self.versions_until = '1.2.1'
+            self.versions_until = "1.2.1"
             self.type = :consumers_states
 
             # @param state [Hash]

data/lib/karafka/web/management/migrations/consumers_states/1704722380_split_listeners_into_active_and_paused.rb

@@ -8,18 +8,18 @@ module Karafka
           # Since we have introduced notion of pause listeners, we need to reflect this in the
           # UI, so the scaling changes are visible
           class SplitListenersIntoActiveAndPaused < Base
-            self.versions_until = '1.2.2'
+            self.versions_until = "1.2.2"
             self.type = :consumers_states
 
             # @param state [Hash]
             def migrate(state)
               listeners = if state[:stats].key?(:listeners)
-                            state[:stats][:listeners].to_i
-                          elsif state[:stats].key?(:listeners_count)
-                            state[:stats][:listeners_count].to_i
-                          else
-                            0
-                          end
+                state[:stats][:listeners].to_i
+              elsif state[:stats].key?(:listeners_count)
+                state[:stats][:listeners_count].to_i
+              else
+                0
+              end
 
               state[:stats][:listeners] = {
                 active: listeners,

data/lib/karafka/web/management/migrations/consumers_states/1706607960_introduce_lag_total.rb

@@ -7,7 +7,7 @@ module Karafka
         module ConsumersStates
           # Moves to using lag total as a normalization for both lags
           class IntroduceLagTotal < Base
-            self.versions_until = '1.3.0'
+            self.versions_until = "1.3.0"
             self.type = :consumers_states
 
             # @param state [Hash]

data/lib/karafka/web/management/migrations/consumers_states/1706611396_rename_lag_total_to_lag_hybrid.rb

@@ -7,7 +7,7 @@ module Karafka
         module ConsumersStates
           # Renames total lag to hybrid to better represent what it is
           class RenameLagTotalToLagHybrid < Base
-            self.versions_until = '1.3.1'
+            self.versions_until = "1.3.1"
             self.type = :consumers_states
 
             # @param state [Hash]

data/lib/karafka/web/management/migrations/consumers_states/1716218393_add_jobs_counter.rb

@@ -7,7 +7,7 @@ module Karafka
         module ConsumersStates
           # Adds the jobs counter matching batches
           class AddJobsCounter < Base
-            self.versions_until = '1.4.0'
+            self.versions_until = "1.4.0"
             self.type = :consumers_states
 
             # @param state [Hash]

data/lib/karafka/web/management/migrator.rb

@@ -55,14 +55,14 @@ module Karafka
           if consumers_states[:schema_version] > State::SCHEMA_VERSION
             raise(
               Errors::Management::IncompatibleSchemaError,
-              'consumers state newer than supported'
+              "consumers state newer than supported"
             )
           end
 
           if consumers_metrics[:schema_version] > Metrics::SCHEMA_VERSION
             raise(
               Errors::Management::IncompatibleSchemaError,
-              'consumers metrics newer than supported'
+              "consumers metrics newer than supported"
             )
           end
         end

data/lib/karafka/web/pro/commanding/commands/base.rb

@@ -1,8 +1,24 @@
 # frozen_string_literal: true
 
-# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
-# See LICENSE for details.
-
+# Karafka Pro - Source Available Commercial Software
+# Copyright (c) 2017-present Maciej Mensfeld. All rights reserved.
+#
+# This software is NOT open source. It is source-available commercial software
+# requiring a paid license for use. It is NOT covered by LGPL.
+#
+# PROHIBITED:
+# - Use without a valid commercial license
+# - Redistribution, modification, or derivative works without authorization
+# - Use as training data for AI/ML models or inclusion in datasets
+# - Scraping, crawling, or automated collection for any purpose
+#
+# PERMITTED:
+# - Reading, referencing, and linking for personal or commercial use
+# - Runtime retrieval by AI assistants, coding agents, and RAG systems
+#   for the purpose of providing contextual help to Karafka users
+#
+# License: https://karafka.io/docs/Pro-License-Comm/
+# Contact: contact@karafka.io
 module Karafka
   module Web
     module Pro
@@ -26,7 +42,7 @@ module Karafka
 
             # Executes the command after receiving it.
             def call
-              raise NotImlementedError, 'Please implement in a subclass'
+              raise NotImlementedError, "Please implement in a subclass"
             end
 
             private

data/lib/karafka/web/pro/commanding/commands/consumers/quiet.rb

@@ -1,7 +1,24 @@
 # frozen_string_literal: true
 
-# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
-# See LICENSE for details.
+# Karafka Pro - Source Available Commercial Software
+# Copyright (c) 2017-present Maciej Mensfeld. All rights reserved.
+#
+# This software is NOT open source. It is source-available commercial software
+# requiring a paid license for use. It is NOT covered by LGPL.
+#
+# PROHIBITED:
+# - Use without a valid commercial license
+# - Redistribution, modification, or derivative works without authorization
+# - Use as training data for AI/ML models or inclusion in datasets
+# - Scraping, crawling, or automated collection for any purpose
+#
+# PERMITTED:
+# - Reading, referencing, and linking for personal or commercial use
+# - Runtime retrieval by AI assistants, coding agents, and RAG systems
+#   for the purpose of providing contextual help to Karafka users
+#
+# License: https://karafka.io/docs/Pro-License-Comm/
+# Contact: contact@karafka.io
 
 module Karafka
   module Web
@@ -14,15 +31,15 @@ module Karafka
             # Sends a signal to quiet the consumer
             # @note Does not work in an embedded mode because we do not own the Ruby process.
             class Quiet < Base
-              self.name = 'consumers.quiet'
+              self.name = "consumers.quiet"
 
               # Performs the command if not in embedded mode
               def call
                 return unless standalone?
 
-                ::Process.kill('TSTP', ::Process.pid)
+                ::Process.kill("TSTP", ::Process.pid)
 
-                result(status: 'applied')
+                result(status: "applied")
               end
             end
           end

data/lib/karafka/web/pro/commanding/commands/consumers/stop.rb

@@ -1,7 +1,24 @@
 # frozen_string_literal: true
 
-# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
-# See LICENSE for details.
+# Karafka Pro - Source Available Commercial Software
+# Copyright (c) 2017-present Maciej Mensfeld. All rights reserved.
+#
+# This software is NOT open source. It is source-available commercial software
+# requiring a paid license for use. It is NOT covered by LGPL.
+#
+# PROHIBITED:
+# - Use without a valid commercial license
+# - Redistribution, modification, or derivative works without authorization
+# - Use as training data for AI/ML models or inclusion in datasets
+# - Scraping, crawling, or automated collection for any purpose
+#
+# PERMITTED:
+# - Reading, referencing, and linking for personal or commercial use
+# - Runtime retrieval by AI assistants, coding agents, and RAG systems
+#   for the purpose of providing contextual help to Karafka users
+#
+# License: https://karafka.io/docs/Pro-License-Comm/
+# Contact: contact@karafka.io
 
 module Karafka
   module Web
@@ -13,15 +30,15 @@ module Karafka
             # Sends a signal to stop the process
             # @note Does not work in an embedded mode because we do not own the Ruby process.
             class Stop < Base
-              self.name = 'consumers.stop'
+              self.name = "consumers.stop"
 
               # Performs the command if not in embedded mode
               def call
                 return unless standalone?
 
-                ::Process.kill('QUIT', ::Process.pid)
+                ::Process.kill("QUIT", ::Process.pid)
 
-                result(status: 'applied')
+                result(status: "applied")
               end
             end
           end

data/lib/karafka/web/pro/commanding/commands/consumers/trace.rb

@@ -1,7 +1,24 @@
 # frozen_string_literal: true
 
-# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
-# See LICENSE for details.
+# Karafka Pro - Source Available Commercial Software
+# Copyright (c) 2017-present Maciej Mensfeld. All rights reserved.
+#
+# This software is NOT open source. It is source-available commercial software
+# requiring a paid license for use. It is NOT covered by LGPL.
+#
+# PROHIBITED:
+# - Use without a valid commercial license
+# - Redistribution, modification, or derivative works without authorization
+# - Use as training data for AI/ML models or inclusion in datasets
+# - Scraping, crawling, or automated collection for any purpose
+#
+# PERMITTED:
+# - Reading, referencing, and linking for personal or commercial use
+# - Runtime retrieval by AI assistants, coding agents, and RAG systems
+#   for the purpose of providing contextual help to Karafka users
+#
+# License: https://karafka.io/docs/Pro-License-Comm/
+# Contact: contact@karafka.io
 
 module Karafka
   module Web
@@ -13,7 +30,7 @@ module Karafka
             # Collects all backtraces from the available Ruby threads and publishes their details
             #   back to Kafka for debug.
             class Trace < Base
-              self.name = 'consumers.trace'
+              self.name = "consumers.trace"
 
               # Runs tracing and publishes result back to Kafka
               def call
@@ -23,7 +40,7 @@ module Karafka
                   tid = (thread.object_id ^ ::Process.pid).to_s(36)
                   t_d = threads[tid] = {}
                   t_d[:label] = "Thread TID-#{tid} #{thread.name}"
-                  t_d[:backtrace] = (thread.backtrace || ['<no backtrace available>']).join("\n")
+                  t_d[:backtrace] = (thread.backtrace || ["<no backtrace available>"]).join("\n")
                 end
 
                 result(threads)

data/lib/karafka/web/pro/commanding/commands/partitions/pause.rb

@@ -1,7 +1,24 @@
 # frozen_string_literal: true
 
-# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
-# See LICENSE for details.
+# Karafka Pro - Source Available Commercial Software
+# Copyright (c) 2017-present Maciej Mensfeld. All rights reserved.
+#
+# This software is NOT open source. It is source-available commercial software
+# requiring a paid license for use. It is NOT covered by LGPL.
+#
+# PROHIBITED:
+# - Use without a valid commercial license
+# - Redistribution, modification, or derivative works without authorization
+# - Use as training data for AI/ML models or inclusion in datasets
+# - Scraping, crawling, or automated collection for any purpose
+#
+# PERMITTED:
+# - Reading, referencing, and linking for personal or commercial use
+# - Runtime retrieval by AI assistants, coding agents, and RAG systems
+#   for the purpose of providing contextual help to Karafka users
+#
+# License: https://karafka.io/docs/Pro-License-Comm/
+# Contact: contact@karafka.io
 
 module Karafka
   module Web
@@ -13,7 +30,7 @@ module Karafka
             # Delegates the pause request into the partition changes tracker and dispatches the
             # acceptance message back to Kafka
             class Pause < Base
-              self.name = 'partitions.pause'
+              self.name = "partitions.pause"
 
               # Delegates the pause request to async handling
               def call

data/lib/karafka/web/pro/commanding/commands/partitions/resume.rb

@@ -1,7 +1,24 @@
 # frozen_string_literal: true
 
-# This code is part of Karafka Pro, a commercial component not licensed under LGPL.
-# See LICENSE for details.
+# Karafka Pro - Source Available Commercial Software
+# Copyright (c) 2017-present Maciej Mensfeld. All rights reserved.
+#
+# This software is NOT open source. It is source-available commercial software
+# requiring a paid license for use. It is NOT covered by LGPL.
+#
+# PROHIBITED:
+# - Use without a valid commercial license
+# - Redistribution, modification, or derivative works without authorization
+# - Use as training data for AI/ML models or inclusion in datasets
+# - Scraping, crawling, or automated collection for any purpose
+#
+# PERMITTED:
+# - Reading, referencing, and linking for personal or commercial use
+# - Runtime retrieval by AI assistants, coding agents, and RAG systems
+#   for the purpose of providing contextual help to Karafka users
+#
+# License: https://karafka.io/docs/Pro-License-Comm/
+# Contact: contact@karafka.io
 
 module Karafka
   module Web
@@ -11,7 +28,7 @@ module Karafka
           module Partitions
             # Delegates the resuming of the processing
             class Resume < Base
-              self.name = 'partitions.resume'
+              self.name = "partitions.resume"
 
               # Dispatches the seek request into the appropriate filter and indicates that the
               # seeking is in an acceptance state