karafka 2.5.2 → 2.5.4.rc1

data/lib/karafka/pro/active_job/consumer.rb

@@ -14,7 +14,7 @@ module Karafka
       #
       # It contains slightly better revocation warranties than the regular blocking consumer as
       # it can stop processing batch of jobs in the middle after the revocation.
-      class Consumer < ::Karafka::ActiveJob::Consumer
+      class Consumer < Karafka::ActiveJob::Consumer
         # Runs ActiveJob jobs processing and handles lrj if needed
         def consume
           messages.each(clean: true) do |message|
@@ -25,7 +25,7 @@ module Karafka
             # We cannot early stop when running virtual partitions because the intermediate state
             # would force us not to commit the offsets. This would cause extensive
             # double-processing
-            break if Karafka::App.stopping? && !topic.virtual_partitions?
+            break if ::Karafka::App.stopping? && !topic.virtual_partitions?
 
             consume_job(message)
 

data/lib/karafka/pro/active_job/dispatcher.rb

@@ -10,7 +10,7 @@ module Karafka
       # Pro dispatcher that sends the ActiveJob job to a proper topic based on the queue name
       # and that allows to inject additional options into the producer, effectively allowing for a
       # much better and more granular control over the dispatch and consumption process.
-      class Dispatcher < ::Karafka::ActiveJob::Dispatcher
+      class Dispatcher < Karafka::ActiveJob::Dispatcher
         include Helpers::ConfigImporter.new(
           deserializer: %i[internal active_job deserializer]
         )
@@ -31,7 +31,7 @@ module Karafka
           # Allows for setting a callable producer since at the moment of defining the class,
           # variants may not be available
           #
-          # We do not initialize it with `-> { ::Karafka.producer }` so we do not have to call it
+          # We do not initialize it with `-> { Karafka.producer }` so we do not have to call it
           #   each time for the defaults to preserve CPU cycles.
           #
           # We also do **not** cache the execution of this producer lambda because we want to
@@ -122,7 +122,7 @@ module Karafka
         def producer(job)
           dynamic_producer = fetch_option(job, :producer, DEFAULTS)
 
-          dynamic_producer ? dynamic_producer.call(job) : ::Karafka.producer
+          dynamic_producer ? dynamic_producer.call(job) : Karafka.producer
         end
 
         # @param job [ActiveJob::Base] job instance

data/lib/karafka/pro/cleaner/messages/messages.rb

@@ -13,7 +13,7 @@ module Karafka
         # This module is prepended to Karafka::Messages::Messages to add cleaning functionality.
         # The implementation calls super() to maintain compatibility with other libraries that
         # also prepend modules to modify the #each method (e.g., DataDog tracing).
-        # See: https://github.com/DataDog/dd-trace-rb/issues/4867
+        # @see https://github.com/DataDog/dd-trace-rb/issues/4867
         module Messages
           # @param clean [Boolean] do we want to clean each message after we're done working with
           #   it.

data/lib/karafka/pro/cleaner.rb

@@ -19,9 +19,9 @@ module Karafka
       class << self
         # @param _config [Karafka::Core::Configurable::Node] root node config
         def pre_setup(_config)
-          ::Karafka::Messages::Message.prepend(Messages::Message)
-          ::Karafka::Messages::Metadata.prepend(Messages::Metadata)
-          ::Karafka::Messages::Messages.prepend(Messages::Messages)
+          Karafka::Messages::Message.prepend(Messages::Message)
+          Karafka::Messages::Metadata.prepend(Messages::Metadata)
+          Karafka::Messages::Messages.prepend(Messages::Messages)
         end
 
         # @param _config [Karafka::Core::Configurable::Node] root node config

data/lib/karafka/pro/cli/contracts/server.rb

@@ -10,7 +10,7 @@ module Karafka
       module Contracts
         # Contract for validating correctness of the server cli command options.
         # It differs slightly from the OSS one because it is aware of the routing patterns
-        class Server < ::Karafka::Cli::Contracts::Server
+        class Server < Karafka::Cli::Contracts::Server
           configure do |config|
             config.error_messages = YAML.safe_load_file(
               File.join(Karafka.gem_root, 'config', 'locales', 'errors.yml')

data/lib/karafka/pro/cli/parallel_segments/base.rb

@@ -12,6 +12,7 @@ module Karafka
           include Helpers::Colorize
 
           # @param options [Hash] cli flags options
+          # @option options [Array<String>] :groups consumer group names to work with
           def initialize(options)
             @options = options
           end
@@ -23,12 +24,12 @@ module Karafka
 
           # Returns consumer groups for parallel segments with which we should be working
           #
-          # @return [Hash<String, Array<Karafka::Routing::ConsumerGroup>>] hash with all parallel
+          # @return [Hash{String => Array<Karafka::Routing::ConsumerGroup>}] hash with all parallel
           #   consumer groups as values and names of segments origin consumer group as the key.
           def applicable_groups
             requested_groups = options[:groups].dup || []
 
-            workable_groups = ::Karafka::App
+            workable_groups = Karafka::App
                               .routes
                               .select(&:parallel_segments?)
                               .group_by(&:segment_origin)
@@ -46,7 +47,7 @@ module Karafka
                 applicable_groups[requested_group] = workable_group
               else
                 raise(
-                  ::Karafka::Errors::ConsumerGroupNotFoundError,
+                  Karafka::Errors::ConsumerGroupNotFoundError,
                   "Consumer group #{requested_group} was not found"
                 )
               end

data/lib/karafka/pro/cli/parallel_segments/collapse.rb

@@ -132,7 +132,7 @@ module Karafka
             return unless inconclusive
 
             raise(
-              ::Karafka::Errors::CommandValidationError,
+              Karafka::Errors::CommandValidationError,
               "Parallel segments for #{red(segment_origin)} have #{red('inconclusive')} offsets"
             )
           end

data/lib/karafka/pro/cli/parallel_segments/distribute.rb

@@ -91,7 +91,7 @@ module Karafka
                   next unless offset.to_i.positive?
 
                   raise(
-                    ::Karafka::Errors::CommandValidationError,
+                    Karafka::Errors::CommandValidationError,
                     "Parallel segment #{red(cg_name)} already has offset #{red(offset)} " \
                     "set for #{red("#{topic_name}##{partition_id}")}"
                   )

data/lib/karafka/pro/cli/parallel_segments.rb

@@ -51,7 +51,7 @@ module Karafka
             Collapse.new(options).call
             Distribute.new(options).call
           else
-            raise ::ArgumentError, "Invalid topics action: #{action}"
+            raise ArgumentError, "Invalid topics action: #{action}"
           end
         end
       end

data/lib/karafka/pro/connection/manager.rb

@@ -184,8 +184,7 @@ module Karafka
                                     .assignments
                                     .select { |_, partitions| partitions.size > 1 }
                                     .keys
-                                    .map(&:subscription_group)
-                                    .map(&:name)
+                                    .map { |sg| sg.subscription_group.name }
                                     .uniq
 
           # Select connections for scaling up

data/lib/karafka/pro/connection/multiplexing/listener.rb

@@ -12,6 +12,7 @@ module Karafka
         # Listener used to connect listeners manager to the lifecycle events that are significant
         # to its operations
         class Listener
+          # Initializes the multiplexing listener with the connection manager
           def initialize
             @manager = App.config.internal.connection.manager
           end

data/lib/karafka/pro/contracts/base.rb

@@ -8,7 +8,7 @@ module Karafka
     # Pro contracts that aim to replace or complement the general framework contracts
     module Contracts
       # Base for all the Pro contracts
-      class Base < ::Karafka::Contracts::Base
+      class Base < Karafka::Contracts::Base
       end
     end
   end

data/lib/karafka/pro/encryption/cipher.rb

@@ -12,6 +12,7 @@ module Karafka
           encryption: %i[encryption]
         )
 
+        # Initializes the cipher with empty private keys cache
         def initialize
           @private_pems = {}
         end
@@ -35,7 +36,7 @@ module Karafka
 
         # @return [::OpenSSL::PKey::RSA] rsa public key
         def public_pem
-          @public_pem ||= ::OpenSSL::PKey::RSA.new(encryption.public_key)
+          @public_pem ||= OpenSSL::PKey::RSA.new(encryption.public_key)
         end
 
         # @param version [String] version for which we want to get the rsa key
@@ -46,7 +47,7 @@ module Karafka
           key_string = encryption.private_keys[version]
           key_string || raise(Errors::PrivateKeyNotFoundError, version)
 
-          @private_pems[version] = ::OpenSSL::PKey::RSA.new(key_string)
+          @private_pems[version] = OpenSSL::PKey::RSA.new(key_string)
         end
       end
     end

data/lib/karafka/pro/encryption/contracts/config.rb

@@ -9,7 +9,7 @@ module Karafka
       # Encryption related contracts
       module Contracts
         # Makes sure, all the expected config is defined as it should be
-        class Config < ::Karafka::Contracts::Base
+        class Config < Karafka::Contracts::Base
           configure do |config|
             config.error_messages = YAML.safe_load_file(
               File.join(Karafka.gem_root, 'config', 'locales', 'pro_errors.yml')

data/lib/karafka/pro/encryption/messages/parser.rb

@@ -11,7 +11,7 @@ module Karafka
         # @note There may be a case where someone decides not to encrypt data and we start getting
         #   unencrypted payloads. That is why we always rely on message headers for encryption
         #   indication.
-        class Parser < ::Karafka::Messages::Parser
+        class Parser < Karafka::Messages::Parser
           include Helpers::ConfigImporter.new(
             cipher: %i[encryption cipher],
             active: %i[encryption active],

data/lib/karafka/pro/encryption/setup/config.rb

@@ -10,7 +10,7 @@ module Karafka
       module Setup
         # Config for encryption
         class Config
-          extend ::Karafka::Core::Configurable
+          extend Karafka::Core::Configurable
 
           # Should this feature be in use
           setting(:active, default: false)

data/lib/karafka/pro/iterator/tpl_builder.rb

@@ -22,7 +22,7 @@ module Karafka
         # @param consumer [::Rdkafka::Consumer] consumer instance needed to talk with Kafka
         # @param expanded_topics [Hash] hash with expanded and normalized topics data
         def initialize(consumer, expanded_topics)
-          @consumer = ::Karafka::Connection::Proxy.new(consumer)
+          @consumer = Karafka::Connection::Proxy.new(consumer)
           @expanded_topics = expanded_topics
           @mapped_topics = Hash.new { |h, k| h[k] = {} }
         end

data/lib/karafka/pro/iterator.rb

@@ -44,7 +44,7 @@ module Karafka
         @topics_with_partitions = Expander.new.call(topics)
 
         @routing_topics = @topics_with_partitions.to_h do |name, _|
-          [name, ::Karafka::Routing::Router.find_or_initialize_by_name(name)]
+          [name, Karafka::Routing::Router.find_or_initialize_by_name(name)]
         end
 
         @total_partitions = @topics_with_partitions.map(&:last).sum(&:count)

data/lib/karafka/pro/loader.rb

@@ -120,7 +120,7 @@ module Karafka
         # Loads the Pro features of Karafka
         # @note Object space lookup is not the fastest but we do it once during boot, so it's ok
         def load_topic_features
-          ::Karafka::Pro::Routing::Features::Base.load_all
+          Karafka::Pro::Routing::Features::Base.load_all
         end
       end
     end

data/lib/karafka/pro/processing/coordinator.rb

@@ -8,7 +8,7 @@ module Karafka
     module Processing
       # Pro coordinator that provides extra orchestration methods useful for parallel processing
       # within the same partition
-      class Coordinator < ::Karafka::Processing::Coordinator
+      class Coordinator < Karafka::Processing::Coordinator
         extend Forwardable
         include Helpers::ConfigImporter.new(
           errors_tracker_class: %i[internal processing errors_tracker_class]

data/lib/karafka/pro/processing/filters/base.rb

@@ -20,6 +20,7 @@ module Karafka
 
           include Karafka::Core::Helpers::Time
 
+          # Initializes the filter as not yet applied
           def initialize
             @applied = false
             @cursor = nil

data/lib/karafka/pro/processing/filters/delayer.rb

@@ -25,7 +25,7 @@ module Karafka
 
             # Time on message is in seconds with ms precision, so we need to convert the ttl that
             # is in ms to this format
-            border = ::Time.now.utc - (@delay / 1_000.0)
+            border = Time.now.utc - (@delay / 1_000.0)
 
             messages.delete_if do |message|
               too_young = message.timestamp > border

data/lib/karafka/pro/processing/filters/expirer.rb

@@ -26,7 +26,7 @@ module Karafka
 
             # Time on message is in seconds with ms precision, so we need to convert the ttl that
             # is in ms to this format
-            border = ::Time.now.utc - (@ttl / 1_000.to_f)
+            border = Time.now.utc - (@ttl / 1_000.to_f)
 
             messages.delete_if do |message|
               too_old = message.timestamp < border

data/lib/karafka/pro/processing/filters/inline_insights_delayer.rb

@@ -41,7 +41,7 @@ module Karafka
             # This can happen when we chain filters
             return unless @cursor
 
-            insights = ::Karafka::Processing::InlineInsights::Tracker.find(
+            insights = Karafka::Processing::InlineInsights::Tracker.find(
               @topic,
               @partition
             )

data/lib/karafka/pro/processing/jobs/consume_non_blocking.rb

@@ -17,7 +17,7 @@ module Karafka
         #
         # @note It needs to be working with a proper consumer that will handle the partition
         #   management. This layer of the framework knows nothing about Kafka messages consumption.
-        class ConsumeNonBlocking < ::Karafka::Processing::Jobs::Consume
+        class ConsumeNonBlocking < Karafka::Processing::Jobs::Consume
           self.action = :consume
 
           # Makes this job non-blocking from the start

data/lib/karafka/pro/processing/jobs/eofed_non_blocking.rb

@@ -11,7 +11,7 @@ module Karafka
         # We use this version for LRJ topics for cases where saturated resources would not allow
         # to run this job for extended period of time. Under such scenarios, if we would not use
         # a non-blocking one, we would reach max.poll.interval.ms.
-        class EofedNonBlocking < ::Karafka::Processing::Jobs::Eofed
+        class EofedNonBlocking < Karafka::Processing::Jobs::Eofed
           self.action = :eofed
 
           # @param args [Array] any arguments accepted by `::Karafka::Processing::Jobs::Eofed`

data/lib/karafka/pro/processing/jobs/periodic.rb

@@ -9,7 +9,7 @@ module Karafka
       module Jobs
         # Job that represents a "ticking" work. Work that we run periodically for the Periodics
         # enabled topics.
-        class Periodic < ::Karafka::Processing::Jobs::Base
+        class Periodic < Karafka::Processing::Jobs::Base
           self.action = :tick
 
           # @param executor [Karafka::Pro::Processing::Executor] pro executor that is suppose to

data/lib/karafka/pro/processing/jobs/revoked_non_blocking.rb

@@ -15,7 +15,7 @@ module Karafka
         # It can be useful when having long lasting jobs that would exceed `max.poll.interval`
         # in scenarios where there are more jobs than threads, without this being async we
         # would potentially stop polling
-        class RevokedNonBlocking < ::Karafka::Processing::Jobs::Revoked
+        class RevokedNonBlocking < Karafka::Processing::Jobs::Revoked
           self.action = :revoked
 
           # Makes this job non-blocking from the start

data/lib/karafka/pro/processing/jobs_builder.rb

@@ -7,7 +7,7 @@ module Karafka
   module Pro
     module Processing
       # Pro jobs builder that supports lrj
-      class JobsBuilder < ::Karafka::Processing::JobsBuilder
+      class JobsBuilder < Karafka::Processing::JobsBuilder
         # @param executor [Karafka::Pro::Processing::Executor]
         def idle(executor)
           Karafka::Processing::Jobs::Idle.new(executor)

data/lib/karafka/pro/processing/jobs_queue.rb

@@ -101,10 +101,8 @@ module Karafka
         end
 
         # Allows for explicit unlocking of locked queue of a group
-        #
         # @param group_id [String] id of the group we want to unlock
         # @param lock_id [Object] unique id we want to use to identify our lock
-        #
         def unlock_async(group_id, lock_id)
           @mutex.synchronize do
             if @locks[group_id].delete(lock_id)

data/lib/karafka/pro/processing/offset_metadata/fetcher.rb

@@ -28,6 +28,7 @@ module Karafka
             def_delegators :instance, :register, :clear, :find
           end
 
+          # Initializes the fetcher with empty caches
           def initialize
             @mutexes = {}
             @clients = {}

data/lib/karafka/pro/processing/partitioner.rb

@@ -7,7 +7,7 @@ module Karafka
   module Pro
     module Processing
       # Pro partitioner that can distribute work based on the virtual partitioner settings
-      class Partitioner < ::Karafka::Processing::Partitioner
+      class Partitioner < Karafka::Processing::Partitioner
         # @param topic [String] topic name
         # @param messages [Array<Karafka::Messages::Message>] karafka messages
         # @param coordinator [Karafka::Pro::Processing::Coordinator] processing coordinator that

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

@@ -10,7 +10,7 @@ module Karafka
       module Strategies
         # Base strategy for Pro
         module Base
-          include ::Karafka::Processing::Strategies::Base
+          include Karafka::Processing::Strategies::Base
         end
       end
     end

data/lib/karafka/pro/processing/strategies/default.rb

@@ -14,7 +14,7 @@ module Karafka
         # Nothing. Just standard, automatic flow
         module Default
           include Base
-          include ::Karafka::Processing::Strategies::Default
+          include Karafka::Processing::Strategies::Default
 
           # Apply strategy for a non-feature based flow
           FEATURES = %i[].freeze
@@ -263,7 +263,7 @@ module Karafka
           # the post-user code execution marking with transactional producer to result in a
           # boolean state of marking for further framework flow. This is a normalization to make it
           # behave the same way as it would behave with a non-transactional one
-          rescue ::Rdkafka::RdkafkaError, Errors::AssignmentLostError
+          rescue Rdkafka::RdkafkaError, Errors::AssignmentLostError
             false
           ensure
             @_transaction_internal = false

data/lib/karafka/pro/processing/strategies/dlq/default.rb

@@ -81,7 +81,7 @@ module Karafka
             # @return [Array<Karafka::Messages::Message, Boolean>] message we may want to skip and
             #   information if this message was from marked offset or figured out via mom flow
             def find_skippable_message
-              skippable_message = messages.find do |msg|
+              skippable_message = messages.raw.find do |msg|
                 coordinator.marked? && msg.offset == seek_offset
               end
 

data/lib/karafka/pro/processing/strategies/vp/default.rb

@@ -156,7 +156,7 @@ module Karafka
               return if collapsed?
 
               coordinator.virtual_offset_manager.register(
-                messages.map(&:offset)
+                messages.raw.map(&:offset)
               )
             end
           end

data/lib/karafka/pro/processing/strategy_selector.rb

@@ -23,6 +23,7 @@ module Karafka
           filtering
         ].freeze
 
+        # Initializes the strategy selector and preloads all strategies
         def initialize
           # Preload the strategies
           # We load them once for performance reasons not to do too many lookups

data/lib/karafka/pro/processing/virtual_partitions/distributors/balanced.rb

@@ -11,8 +11,10 @@ module Karafka
           # Balanced distributor that groups messages by partition key
           # and processes larger groups first while maintaining message order within groups
           class Balanced < Base
-            # @param messages [Array<Karafka::Messages::Message>] messages to distribute
-            # @return [Hash<Integer, Array<Karafka::Messages::Message>>] hash with group ids as
+            # Distributes messages to virtual partitions ensuring balanced load across workers
+            # by grouping messages by partition key and assigning larger groups first
+            # @param messages [Array<Karafka::Messages::Message>]
+            # @return [Hash{Integer => Array<Karafka::Messages::Message>}] hash with group ids as
             #   keys and message groups as values
             def call(messages)
               # Group messages by partition key

data/lib/karafka/pro/processing/virtual_partitions/distributors/consistent.rb

@@ -11,8 +11,10 @@ module Karafka
           # Consistent distributor that ensures messages with the same partition key
           # are always processed in the same virtual partition
           class Consistent < Base
-            # @param messages [Array<Karafka::Messages::Message>] messages to distribute
-            # @return [Hash<Integer, Array<Karafka::Messages::Message>>] hash with group ids as
+            # Distributes messages ensuring consistent routing where messages with the same
+            # partition key always go to the same virtual partition
+            # @param messages [Array<Karafka::Messages::Message>]
+            # @return [Hash{Integer => Array<Karafka::Messages::Message>}] hash with group ids as
             #   keys and message groups as values
             def call(messages)
               messages

data/lib/karafka/pro/recurring_tasks/consumer.rb

@@ -11,13 +11,14 @@ module Karafka
       #   - we only run schedules that are of same or newer version
       #   - we always mark as consumed in such a way, that the first message received after
       #     assignment (if any) is a state
-      class Consumer < ::Karafka::BaseConsumer
+      class Consumer < Karafka::BaseConsumer
         # @param args [Array] all arguments accepted by the consumer
         def initialize(*args)
           super
           @executor = Executor.new
         end
 
+        # Consumes messages and manages recurring tasks execution
         def consume
           # There is nothing we can do if we operate on a newer schedule. In such cases we should
           # just wait and re-raise error hoping someone will notice or that this will be
@@ -54,7 +55,7 @@ module Karafka
               # that collectively have a different outcome
               @executor.call
             else
-              raise ::Karafka::Errors::UnsupportedCaseError, type
+              raise Karafka::Errors::UnsupportedCaseError, type
             end
           end
 

data/lib/karafka/pro/recurring_tasks/contracts/config.rb

@@ -9,7 +9,7 @@ module Karafka
       # Recurring Tasks related contracts
       module Contracts
         # Makes sure, all the expected config is defined as it should be
-        class Config < ::Karafka::Contracts::Base
+        class Config < Karafka::Contracts::Base
           configure do |config|
             config.error_messages = YAML.safe_load_file(
               File.join(Karafka.gem_root, 'config', 'locales', 'pro_errors.yml')
@@ -17,7 +17,7 @@ module Karafka
           end
 
           nested(:recurring_tasks) do
-            required(:consumer_class) { |val| val < ::Karafka::BaseConsumer }
+            required(:consumer_class) { |val| val < Karafka::BaseConsumer }
             required(:deserializer) { |val| !val.nil? }
             required(:logging) { |val| [true, false].include?(val) }
             # Do not allow to run more often than every 5 seconds

data/lib/karafka/pro/recurring_tasks/contracts/task.rb

@@ -9,7 +9,7 @@ module Karafka
       # Recurring Tasks related contracts
       module Contracts
         # Ensures that task details are as expected
-        class Task < ::Karafka::Contracts::Base
+        class Task < Karafka::Contracts::Base
           configure do |config|
             config.error_messages = YAML.safe_load_file(
               File.join(Karafka.gem_root, 'config', 'locales', 'pro_errors.yml')

data/lib/karafka/pro/recurring_tasks/deserializer.rb

@@ -16,7 +16,7 @@ module Karafka
         # @param message [::Karafka::Messages::Message]
         # @return [Hash] deserialized data
         def call(message)
-          ::JSON.parse(
+          JSON.parse(
             Zlib::Inflate.inflate(message.raw_payload),
             symbolize_names: true
           )

data/lib/karafka/pro/recurring_tasks/dispatcher.rb

@@ -51,7 +51,7 @@ module Karafka
           # @note We do not fetch it via the ConfigImporter not to cache it so we can re-use it
           #   if needed
           def producer
-            ::Karafka::App.config.recurring_tasks.producer
+            Karafka::App.config.recurring_tasks.producer
           end
 
           # @return [Serializer]

data/lib/karafka/pro/recurring_tasks/executor.rb

@@ -17,6 +17,7 @@ module Karafka
           trigger
         ].freeze
 
+        # Initializes the executor in replaying mode
         def initialize
           @replaying = true
           @incompatible = false
@@ -131,7 +132,7 @@ module Karafka
 
         # @return [Karafka::Pro::RecurringTasks::Schedule] current in-memory schedule
         def schedule
-          ::Karafka::Pro::RecurringTasks.schedule
+          Karafka::Pro::RecurringTasks.schedule
         end
 
         # Dispatches the current schedule state to Kafka

data/lib/karafka/pro/recurring_tasks/schedule.rb

@@ -13,7 +13,7 @@ module Karafka
         # @return [String]
         attr_reader :version
 
-        # @return [Hash<String, Task>]
+        # @return [Hash{String => Task}]
         attr_reader :tasks
 
         # @param version [String] schedule version. In case of usage of versioning it is used to
@@ -43,7 +43,10 @@ module Karafka
         end
 
         # Allows us to have a nice DSL for defining schedules
-        # @param args [Array] attributes accepted by the task initializer
+        # @param args [Hash] attributes accepted by the task initializer
+        # @option args [String] :id unique task identifier
+        # @option args [String] :cron cron expression for task scheduling
+        # @option args [Proc] :previous_time optional lambda returning previous execution time
         def schedule(**args, &)
           self << Task.new(**args, &)
         end

data/lib/karafka/pro/recurring_tasks/serializer.rb

@@ -11,7 +11,8 @@ module Karafka
         # Current recurring tasks related schema structure
         SCHEMA_VERSION = '1.0'
 
-        # @param schedule [Karafka::Pro::RecurringTasks::Schedule] schedule to serialize
+        # Serializes and compresses the schedule with all its tasks and their execution state
+        # @param schedule [Karafka::Pro::RecurringTasks::Schedule]
         # @return [String] serialized and compressed current schedule data with its tasks and their
         #   current state.
         def schedule(schedule)
@@ -46,7 +47,7 @@ module Karafka
         def command(command_name, task_id)
           data = {
             schema_version: SCHEMA_VERSION,
-            schedule_version: ::Karafka::Pro::RecurringTasks.schedule.version,
+            schedule_version: Karafka::Pro::RecurringTasks.schedule.version,
             dispatched_at: Time.now.to_f,
             type: 'command',
             command: {
@@ -69,7 +70,7 @@ module Karafka
 
           data = {
             schema_version: SCHEMA_VERSION,
-            schedule_version: ::Karafka::Pro::RecurringTasks.schedule.version,
+            schedule_version: Karafka::Pro::RecurringTasks.schedule.version,
             dispatched_at: Time.now.to_f,
             type: 'log',
             task: {
@@ -92,9 +93,9 @@ module Karafka
           hash.to_json
         end
 
-        # Compresses the provided data
+        # Compresses the provided data using Zlib deflate algorithm
         #
-        # @param data [String] data to compress
+        # @param data [String]
         # @return [String] compressed data
         def compress(data)
           Zlib::Deflate.deflate(data)