karafka 2.5.4 → 2.5.6

data/lib/karafka/pro/scheduled_messages/deserializers/payload.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 Pro

data/lib/karafka/pro/scheduled_messages/dispatcher.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 Pro
@@ -37,10 +54,10 @@ module Karafka
         # @note It also produces needed tombstone event as well as an audit log message
         def <<(message)
           target_headers = message.raw_headers.merge(
-            'schedule_source_topic' => @topic,
-            'schedule_source_partition' => @partition.to_s,
-            'schedule_source_offset' => message.offset.to_s,
-            'schedule_source_key' => message.key
+            "schedule_source_topic" => @topic,
+            "schedule_source_partition" => @partition.to_s,
+            "schedule_source_offset" => message.offset.to_s,
+            "schedule_source_key" => message.key
           ).compact
 
           target = {
@@ -73,7 +90,7 @@ module Karafka
             # We use the state as a key, so we always have one state transition data available
             key: "#{tracker.state}_state",
             partition: @partition,
-            headers: { 'zlib' => 'true' }
+            headers: { "zlib" => "true" }
           )
         end
 

data/lib/karafka/pro/scheduled_messages/errors.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 Pro

data/lib/karafka/pro/scheduled_messages/max_epoch.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 Pro

data/lib/karafka/pro/scheduled_messages/proxy.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 Pro
@@ -67,9 +84,9 @@ module Karafka
             )
 
             headers = (message[:headers] || {}).merge(
-              'schedule_schema_version' => ScheduledMessages::SCHEMA_VERSION,
-              'schedule_target_epoch' => epoch.to_i.to_s,
-              'schedule_source_type' => 'schedule'
+              "schedule_schema_version" => ScheduledMessages::SCHEMA_VERSION,
+              "schedule_target_epoch" => epoch.to_i.to_s,
+              "schedule_source_type" => "schedule"
             )
 
             export(headers, message, :topic)
@@ -101,8 +118,8 @@ module Karafka
               key: key,
               payload: nil,
               headers: {
-                'schedule_schema_version' => ScheduledMessages::SCHEMA_VERSION,
-                'schedule_source_type' => 'cancel'
+                "schedule_schema_version" => ScheduledMessages::SCHEMA_VERSION,
+                "schedule_source_type" => "cancel"
               }
             }.merge(envelope)
 
@@ -123,9 +140,9 @@ module Karafka
               topic: message.topic,
               partition: message.partition,
               headers: message.raw_headers.merge(
-                'schedule_schema_version' => ScheduledMessages::SCHEMA_VERSION,
-                'schedule_source_type' => 'tombstone',
-                'schedule_source_offset' => message.offset.to_s
+                "schedule_schema_version" => ScheduledMessages::SCHEMA_VERSION,
+                "schedule_source_type" => "tombstone",
+                "schedule_source_offset" => message.offset.to_s
               )
             }
           end

data/lib/karafka/pro/scheduled_messages/schema_validator.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 Pro
@@ -16,7 +33,7 @@ module Karafka
           #
           # @param message [Karafka::Messages::Message]
           def call(message)
-            message_version = message.headers['schedule_schema_version']
+            message_version = message.headers["schedule_schema_version"]
 
             return if message_version <= ScheduledMessages::SCHEMA_VERSION
 

data/lib/karafka/pro/scheduled_messages/serializer.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 Pro

data/lib/karafka/pro/scheduled_messages/setup/config.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 Pro
@@ -13,7 +30,7 @@ module Karafka
           extend Karafka::Core::Configurable
 
           setting(:consumer_class, default: Consumer)
-          setting(:group_id, default: 'karafka_scheduled_messages')
+          setting(:group_id, default: "karafka_scheduled_messages")
 
           # By default we will run the scheduling every 15 seconds since we provide a minute-based
           # precision. Can be increased when having dedicated processes to run this. Lower values
@@ -35,7 +52,7 @@ module Karafka
           setting(:dispatcher_class, default: Dispatcher)
 
           # Postfix for the states topic to build the states based on the group name + postfix
-          setting(:states_postfix, default: '_states')
+          setting(:states_postfix, default: "_states")
 
           setting(:deserializers) do
             # Deserializer for schedules messages to convert epochs

data/lib/karafka/pro/scheduled_messages/state.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 Pro
@@ -29,7 +46,7 @@ module Karafka
 
         # Initializes the state as fresh
         def initialize
-          @state = 'fresh'
+          @state = "fresh"
         end
 
         STATES.each do |state|

data/lib/karafka/pro/scheduled_messages/tracker.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 Pro
@@ -23,7 +40,7 @@ module Karafka
           @daily = Hash.new { |h, k| h[k] = 0 }
           @started_at = Time.now.to_i
           @offsets = { low: -1, high: -1 }
-          @state = 'fresh'
+          @state = "fresh"
           @reloads = 0
         end
 
@@ -54,7 +71,7 @@ module Karafka
         #   drastically increase complexity. For given day we use the accurate counter and for
         #   future days we use estimates.
         def future(message)
-          epoch = message.headers['schedule_target_epoch']
+          epoch = message.headers["schedule_target_epoch"]
 
           @daily[epoch_to_date(epoch)] += 1
         end

data/lib/karafka/pro/scheduled_messages.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 Pro
@@ -16,11 +33,11 @@ module Karafka
       # Version of the schema we use for envelops in scheduled messages.
       # We use it to detect any potential upgrades similar to other components of Karafka and to
       # stop processing of incompatible versions
-      SCHEMA_VERSION = '1.0.0'
+      SCHEMA_VERSION = "1.0.0"
 
       # Version of the states schema. Used to publish per partition simple aggregated metrics
       # that can be used for schedules reporting
-      STATES_SCHEMA_VERSION = '1.0.0'
+      STATES_SCHEMA_VERSION = "1.0.0"
 
       class << self
         # Runs the `Proxy.call`

data/lib/karafka/pro/swarm/liveness_listener.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 Pro
@@ -164,7 +181,7 @@ module Karafka
 
         # @return [Integer] RSS in MB for the current process
         def rss_mb
-          RUBY_PLATFORM.include?('linux') ? rss_mb_linux : rss_mb_macos
+          RUBY_PLATFORM.include?("linux") ? rss_mb_linux : rss_mb_macos
         end
 
         # @return [Integer] RSS in MB for the current process on Linux
@@ -172,7 +189,7 @@ module Karafka
           kb_rss = 0
 
           File.readlines("/proc/#{node.pid}/status").each do |line|
-            next unless line.start_with?('VmRSS:')
+            next unless line.start_with?("VmRSS:")
 
             kb_rss = line.split[1].to_i
             break

data/lib/karafka/process.rb

@@ -98,7 +98,7 @@ module Karafka
     # Informs monitoring about trapped signal
     # @param signal [Symbol] signal type that we received
     def notice_signal(signal)
-      Karafka.monitor.instrument('process.notice_signal', caller: self, signal: signal)
+      Karafka.monitor.instrument("process.notice_signal", caller: self, signal: signal)
     end
   end
 end

data/lib/karafka/processing/coordinator.rb

@@ -100,7 +100,7 @@ module Karafka
 
           # This should never happen. If it does, something is heavily out of sync. Please reach
           # out to us if you encounter this
-          raise Karafka::Errors::InvalidCoordinatorStateError, 'Was zero before decrementation'
+          raise Karafka::Errors::InvalidCoordinatorStateError, "Was zero before decrementation"
         end
       end
 

data/lib/karafka/processing/inline_insights/consumer.rb

@@ -33,10 +33,10 @@ module Karafka
           !insights.empty?
         end
 
-        alias statistics insights
-        alias statistics? insights?
-        alias inline_insights insights
-        alias inline_insights? insights?
+        alias_method :statistics, :insights
+        alias_method :statistics?, :insights?
+        alias_method :inline_insights, :insights
+        alias_method :inline_insights?, :insights?
       end
     end
   end

data/lib/karafka/processing/inline_insights/tracker.rb

@@ -68,8 +68,8 @@ module Karafka
         # @param statistics [Hash] librdkafka enriched statistics
         def add(consumer_group_id, statistics)
           @mutex.synchronize do
-            statistics.fetch('topics', EMPTY_HASH).each do |topic_name, t_details|
-              t_details.fetch('partitions', EMPTY_HASH).each do |partition_id, p_details|
+            statistics.fetch("topics", EMPTY_HASH).each do |topic_name, t_details|
+              t_details.fetch("partitions", EMPTY_HASH).each do |partition_id, p_details|
                 next unless track?(partition_id, p_details)
 
                 key = "#{consumer_group_id}_#{topic_name}_#{partition_id}"
@@ -114,12 +114,12 @@ module Karafka
         # @param p_details [Hash] partition statistics details
         # @return [Boolean] true if we should track given partition
         def track?(partition_id, p_details)
-          return false if partition_id == '-1'
+          return false if partition_id == "-1"
 
-          fetch_state = p_details.fetch('fetch_state')
+          fetch_state = p_details.fetch("fetch_state")
 
-          return false if fetch_state == 'stopped'
-          return false if fetch_state == 'none'
+          return false if fetch_state == "stopped"
+          return false if fetch_state == "none"
 
           true
         end

data/lib/karafka/processing/jobs/base.rb

@@ -38,19 +38,21 @@ module Karafka
         # When redefined can run any code prior to the job being scheduled
         # @note This will run in the listener thread and not in the worker
         def before_schedule
-          raise NotImplementedError, 'Please implement in a subclass'
+          raise NotImplementedError, "Please implement in a subclass"
         end
 
         # When redefined can run any code that should run before executing the proper code
-        def before_call; end
+        def before_call
+        end
 
         # The main entry-point of a job
         def call
-          raise NotImplementedError, 'Please implement in a subclass'
+          raise NotImplementedError, "Please implement in a subclass"
         end
 
         # When redefined can run any code that should run after executing the proper code
-        def after_call; end
+        def after_call
+        end
 
         # @return [Boolean] is this a non-blocking job
         #

data/lib/karafka/processing/schedulers/default.rb

@@ -21,10 +21,10 @@ module Karafka
         end
 
         # Revocation, shutdown and idle jobs can also run in fifo by default
-        alias on_schedule_revocation on_schedule_consumption
-        alias on_schedule_shutdown on_schedule_consumption
-        alias on_schedule_idle on_schedule_consumption
-        alias on_schedule_eofed on_schedule_consumption
+        alias_method :on_schedule_revocation, :on_schedule_consumption
+        alias_method :on_schedule_shutdown, :on_schedule_consumption
+        alias_method :on_schedule_idle, :on_schedule_consumption
+        alias_method :on_schedule_eofed, :on_schedule_consumption
 
         # This scheduler does not have anything to manage as it is a pass through and has no state
         def on_manage

data/lib/karafka/processing/strategies/base.rb

@@ -28,32 +28,32 @@ module Karafka
 
         # What should happen before we kick in the processing
         def handle_before_consume
-          raise NotImplementedError, 'Implement in a subclass'
+          raise NotImplementedError, "Implement in a subclass"
         end
 
         # What should happen in the processing
         def handle_consume
-          raise NotImplementedError, 'Implement in a subclass'
+          raise NotImplementedError, "Implement in a subclass"
         end
 
         # Post-consumption handling
         def handle_after_consume
-          raise NotImplementedError, 'Implement in a subclass'
+          raise NotImplementedError, "Implement in a subclass"
         end
 
         # Idle run handling
         def handle_idle
-          raise NotImplementedError, 'Implement in a subclass'
+          raise NotImplementedError, "Implement in a subclass"
         end
 
         # Revocation handling
         def handle_revoked
-          raise NotImplementedError, 'Implement in a subclass'
+          raise NotImplementedError, "Implement in a subclass"
         end
 
         # Shutdown handling
         def handle_shutdown
-          raise NotImplementedError, 'Implement in a subclass'
+          raise NotImplementedError, "Implement in a subclass"
         end
       end
     end