karafka 1.3.0 → 1.4.14

data/lib/karafka/contracts/server_cli_options.rb

@@ -6,6 +6,8 @@ module Karafka
     # We validate some basics + the list of consumer_groups on which we want to use, to make
     # sure that all of them are defined, plus that a pidfile does not exist
     class ServerCliOptions < Dry::Validation::Contract
+      config.messages.load_paths << File.join(Karafka.gem_root, 'config', 'errors.yml')
+
       params do
         optional(:pid).filled(:str?)
         optional(:daemon).filled(:bool?)

data/lib/karafka/contracts.rb

@@ -5,6 +5,6 @@ module Karafka
   module Contracts
     # Regexp for validating format of groups and topics
     # @note It is not nested inside of the contracts, as it is used by couple of them
-    TOPIC_REGEXP = /\A(\w|\-|\.)+\z/.freeze
+    TOPIC_REGEXP = /\A(\w|-|\.)+\z/.freeze
   end
 end

data/lib/karafka/helpers/class_matcher.rb

@@ -8,7 +8,7 @@ module Karafka
     class ClassMatcher
       # Regexp used to remove any non classy like characters that might be in the consumer
       # class name (if defined dynamically, etc)
-      CONSTANT_REGEXP = %r{[?!=+\-\*/\^\|&\[\]<>%~\#\:\s\(\)]}.freeze
+      CONSTANT_REGEXP = %r{[?!=+\-*/\^|&\[\]<>%~\#:\s()]}.freeze
 
       private_constant :CONSTANT_REGEXP
 
@@ -44,7 +44,7 @@ module Karafka
       # @example From Namespaced::Super2Consumer matching responder
       #   matcher.name #=> Super2Responder
       def name
-        inflected = @klass.to_s.split('::').last.to_s
+        inflected = +@klass.to_s.split('::').last.to_s
         # We inject the from into the name just in case it is missing as in a situation like
         # that it would just sanitize the name without adding the "to" postfix.
         # It could create cases when we want to build for example a responder to a consumer

data/lib/karafka/instrumentation/logger.rb

@@ -20,7 +20,6 @@ module Karafka
       # @param _args Any arguments that we don't care about but that are needed in order to
       #   make this logger compatible with the default Ruby one
       def initialize(*_args)
-        ensure_dir_exists
         super(target)
         self.level = ENV_MAP[Karafka.env] || ENV_MAP['default']
       end
@@ -29,17 +28,11 @@ module Karafka
 
       # @return [Karafka::Helpers::MultiDelegator] multi delegator instance
       #   to which we will be writing logs
-      # We use this approach to log stuff to file and to the STDOUT at the same time
+      # We use this approach to log stuff to file and to the $stdout at the same time
       def target
         Karafka::Helpers::MultiDelegator
           .delegate(:write, :close)
-          .to(STDOUT, file)
-      end
-
-      # Makes sure the log directory exists
-      def ensure_dir_exists
-        dir = File.dirname(log_path)
-        FileUtils.mkdir_p(dir) unless Dir.exist?(dir)
+          .to(*[$stdout, file].compact)
       end
 
       # @return [Pathname] Path to a file to which we should log
@@ -50,7 +43,11 @@ module Karafka
       # @return [File] file to which we want to write our logs
       # @note File is being opened in append mode ('a')
       def file
+        FileUtils.mkdir_p(File.dirname(log_path))
+
         @file ||= File.open(log_path, 'a')
+      rescue Errno::EACCES, Errno::EROFS
+        nil
       end
     end
   end

data/lib/karafka/instrumentation/stdout_listener.rb

@@ -43,7 +43,7 @@ module Karafka
         # so it returns a topic as a string, not a routing topic
         debug(
           <<~MSG.chomp.tr("\n", ' ')
-            Params deserialization for #{event[:caller].topic} topic
+            Params deserialization for #{event[:caller].metadata.topic} topic
             successful in #{event[:time]} ms
           MSG
         )
@@ -52,7 +52,9 @@ module Karafka
       # Logs unsuccessful deserialization attempts of incoming data
       # @param event [Dry::Events::Event] event details including payload
       def on_params_params_deserialize_error(event)
-        error "Params deserialization error for #{event[:caller].topic} topic: #{event[:error]}"
+        topic = event[:caller].metadata.topic
+        error = event[:error]
+        error "Params deserialization error for #{topic} topic: #{error}"
       end
 
       # Logs errors that occurred in a listener fetch loop
@@ -101,10 +103,10 @@ module Karafka
         info "Responded from #{calling.class} using #{responder} with following data #{data}"
       end
 
-      # Logs info that we're initializing Karafka app
+      # Logs info that we're initializing Karafka framework components
       # @param _event [Dry::Events::Event] event details including payload
       def on_app_initializing(_event)
-        info "Initializing Karafka server #{::Process.pid}"
+        info "Initializing Karafka framework #{::Process.pid}"
       end
 
       # Logs info that we're running Karafka app

data/lib/karafka/params/batch_metadata.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Params
+    # Simple batch metadata object that stores all non-message information received from Kafka
+    # cluster while fetching the data
+    # @note This metadata object refers to per batch metadata, not `#params.metadata`
+    BatchMetadata = Struct.new(
+      :batch_size,
+      :first_offset,
+      :highwater_mark_offset,
+      :unknown_last_offset,
+      :last_offset,
+      :offset_lag,
+      :deserializer,
+      :partition,
+      :topic,
+      keyword_init: true
+    ) do
+      # @return [Boolean] is the last offset known or unknown
+      def unknown_last_offset?
+        unknown_last_offset
+      end
+    end
+  end
+end

data/lib/karafka/params/builders/batch_metadata.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Params
+    module Builders
+      # Builder for creating batch metadata object based on the batch informations
+      module BatchMetadata
+        class << self
+          # Creates metadata based on the kafka batch data
+          # @param kafka_batch [Kafka::FetchedBatch] kafka batch details
+          # @param topic [Karafka::Routing::Topic] topic for which we've fetched the batch
+          # @return [Karafka::Params::BatchMetadata] batch metadata object
+          def from_kafka_batch(kafka_batch, topic)
+            Karafka::Params::BatchMetadata.new(
+              batch_size: kafka_batch.messages.count,
+              first_offset: kafka_batch.first_offset,
+              highwater_mark_offset: kafka_batch.highwater_mark_offset,
+              unknown_last_offset: kafka_batch.unknown_last_offset?,
+              last_offset: kafka_batch.last_offset,
+              offset_lag: kafka_batch.offset_lag,
+              deserializer: topic.deserializer,
+              partition: kafka_batch.partition,
+              topic: topic.name
+            ).freeze
+          end
+        end
+      end
+    end
+  end
+end

data/lib/karafka/params/builders/params.rb

@@ -12,22 +12,24 @@ module Karafka
         class << self
           # @param kafka_message [Kafka::FetchedMessage] message fetched from Kafka
           # @param topic [Karafka::Routing::Topic] topic for which this message was fetched
-          # @return [Karafka::Params::Params] params object
+          # @return [Karafka::Params::Params] params object with payload and message metadata
           def from_kafka_message(kafka_message, topic)
-            Karafka::Params::Params
-              .new
-              .merge!(
-                'create_time' => kafka_message.create_time,
-                'headers' => kafka_message.headers || {},
-                'is_control_record' => kafka_message.is_control_record,
-                'key' => kafka_message.key,
-                'offset' => kafka_message.offset,
-                'deserializer' => topic.deserializer,
-                'partition' => kafka_message.partition,
-                'receive_time' => Time.now,
-                'topic' => kafka_message.topic,
-                'payload' => kafka_message.value
-              )
+            metadata = Karafka::Params::Metadata.new(
+              create_time: kafka_message.create_time,
+              headers: kafka_message.headers || {},
+              is_control_record: kafka_message.is_control_record,
+              key: kafka_message.key,
+              offset: kafka_message.offset,
+              deserializer: topic.deserializer,
+              partition: kafka_message.partition,
+              receive_time: Time.now,
+              topic: topic.name
+            ).freeze
+
+            Karafka::Params::Params.new(
+              kafka_message.value,
+              metadata
+            )
           end
         end
       end

data/lib/karafka/params/builders/params_batch.rb

@@ -12,11 +12,11 @@ module Karafka
           # @param topic [Karafka::Routing::Topic] topic for which we're received messages
           # @return [Karafka::Params::ParamsBatch<Karafka::Params::Params>] batch with params
           def from_kafka_messages(kafka_messages, topic)
-            params_array = kafka_messages.map! do |message|
+            params_array = kafka_messages.map do |message|
               Karafka::Params::Builders::Params.from_kafka_message(message, topic)
             end
 
-            Karafka::Params::ParamsBatch.new(params_array)
+            Karafka::Params::ParamsBatch.new(params_array).freeze
           end
         end
       end

data/lib/karafka/params/metadata.rb

@@ -2,34 +2,19 @@
 
 module Karafka
   module Params
-    # Simple metadata object that stores all non-message information received from Kafka cluster
-    # while fetching the data
-    class Metadata < Hash
-      # Attributes that should be accessible as methods as well (not only hash)
-      METHOD_ATTRIBUTES = %w[
-        batch_size
-        first_offset
-        highwater_mark_offset
-        last_offset
-        offset_lag
-        deserializer
-        partition
-        topic
-      ].freeze
-
-      private_constant :METHOD_ATTRIBUTES
-
-      METHOD_ATTRIBUTES.each do |attr|
-        # Defines a method call accessor to a particular hash field.
-        define_method(attr) do
-          self[attr]
-        end
-      end
-
-      # @return [Boolean] is the last offset known or unknown
-      def unknown_last_offset?
-        self['unknown_last_offset']
-      end
-    end
+    # Single message / params metadata details that can be accessed without the need for the
+    # payload deserialization
+    Metadata = Struct.new(
+      :create_time,
+      :headers,
+      :is_control_record,
+      :key,
+      :offset,
+      :deserializer,
+      :partition,
+      :receive_time,
+      :topic,
+      keyword_init: true
+    )
   end
 end

data/lib/karafka/params/params.rb

@@ -6,58 +6,44 @@ module Karafka
     # It provides lazy loading not only until the first usage, but also allows us to skip
     # using deserializer until we execute our logic. That way we can operate with
     # heavy-deserialization data without slowing down the whole application.
-    class Params < Hash
-      # Params attributes that should be available via a method call invocation for Kafka
-      # client compatibility.
-      # Kafka passes internally Kafka::FetchedMessage object and the ruby-kafka consumer
-      # uses those fields via method calls, so in order to be able to pass there our params
-      # objects, have to have same api.
-      METHOD_ATTRIBUTES = %w[
-        create_time
-        headers
-        is_control_record
-        key
-        offset
-        deserializer
-        deserialized
-        partition
-        receive_time
-        topic
-        payload
-      ].freeze
+    class Params
+      extend Forwardable
 
-      private_constant :METHOD_ATTRIBUTES
+      attr_reader :raw_payload, :metadata
 
-      METHOD_ATTRIBUTES.each do |attr|
-        # Defines a method call accessor to a particular hash field.
-        # @note Won't work for complex key names that contain spaces, etc
-        # @param key [Symbol] name of a field that we want to retrieve with a method call
-        # @example
-        #   key_attr_reader :example
-        #   params.example #=> 'my example payload'
-        define_method(attr) do
-          self[attr]
-        end
+      def_delegators :metadata, *Metadata.members
+
+      # @param raw_payload [Object] incoming payload before deserialization
+      # @param metadata [Karafka::Params::Metadata] message metadata object
+      def initialize(raw_payload, metadata)
+        @raw_payload = raw_payload
+        @metadata = metadata
+        @deserialized = false
+        @payload = nil
       end
 
-      # @return [Karafka::Params::Params] This method will trigger deserializer execution. If we
-      #   decide to retrieve data, deserializer will be executed to get data. Output of that will
-      #   be merged to the current object. This object will be also marked as already deserialized,
-      #   so we won't deserialize it again.
-      def deserialize!
-        return self if self['deserialized']
+      # @return [Object] lazy-deserialized data (deserialized upon first request)
+      def payload
+        return @payload if deserialized?
+
+        @payload = deserialize
+        # We mark deserialization as successful after deserialization, as in case of an error
+        # this won't be falsely set to true
+        @deserialized = true
+        @payload
+      end
 
-        self['deserialized'] = true
-        self['payload'] = deserialize
-        self
+      # @return [Boolean] did given params payload were deserialized already
+      def deserialized?
+        @deserialized
       end
 
       private
 
-      # @return [Object] deserialized data
+      # @return [Object] tries de-serializes data
       def deserialize
         Karafka.monitor.instrument('params.params.deserialize', caller: self) do
-          self['deserializer'].call(self)
+          metadata.deserializer.call(self)
         end
       rescue ::StandardError => e
         Karafka.monitor.instrument('params.params.deserialize.error', caller: self, error: e)

data/lib/karafka/params/params_batch.rb

@@ -15,47 +15,46 @@ module Karafka
         @params_array = params_array
       end
 
-      # @yieldparam [Karafka::Params::Params] each deserialized and loaded params instance
-      # @note Invocation of this method will cause loading and deserializing each param after
-      #   another. If you want to get access without deserializing, please access params_array
-      #   directly
+      # @yieldparam [Karafka::Params::Params] each params instance
+      # @note Invocation of this method will not cause loading and deserializing each param after
+      #   another.
       def each
-        @params_array.each { |param| yield(param.deserialize!) }
+        @params_array.each { |param| yield(param) }
       end
 
       # @return [Array<Karafka::Params::Params>] returns all the params in a loaded state, so they
       #   can be used for batch insert, etc. Without invoking all, up until first use, they won't
       #   be deserialized
       def deserialize!
-        each(&:itself)
+        each(&:payload)
       end
 
       # @return [Array<Object>] array with deserialized payloads. This method can be useful when
       #   we don't care about metadata and just want to extract all the data payloads from the
       #   batch
       def payloads
-        deserialize!.map(&:payload)
+        map(&:payload)
       end
 
-      # @return [Karafka::Params::Params] first element after the deserialization process
+      # @return [Karafka::Params::Params] first element
       def first
-        @params_array.first.deserialize!
+        @params_array.first
       end
 
-      # @return [Karafka::Params::Params] last element after the deserialization process
+      # @return [Karafka::Params::Params] last element
       def last
-        @params_array.last.deserialize!
-      end
-
-      # @return [Array<Karafka::Params::Params>] pure array with params (not deserialized)
-      def to_a
-        @params_array
+        @params_array.last
       end
 
       # @return [Integer] number of messages in the batch
       def size
         @params_array.size
       end
+
+      # @return [Array<Karafka::Params::Params>] pure array with params
+      def to_a
+        @params_array
+      end
     end
   end
 end

data/lib/karafka/routing/builder.rb

@@ -16,6 +16,7 @@ module Karafka
       private_constant :CONTRACT
 
       def initialize
+        super
         @draws = Concurrent::Array.new
       end
 

data/lib/karafka/routing/consumer_group.rb

@@ -8,9 +8,11 @@ module Karafka
     class ConsumerGroup
       extend Helpers::ConfigRetriever
 
-      attr_reader :topics
-      attr_reader :id
-      attr_reader :name
+      attr_reader(
+        :topics,
+        :id,
+        :name
+      )
 
       # @param name [String, Symbol] raw name of this consumer group. Raw means, that it does not
       #   yet have an application client_id namespace, this will be added here by default.

data/lib/karafka/serialization/json/deserializer.rb

@@ -17,8 +17,8 @@ module Karafka
         #   }
         #   Deserializer.call(params) #=> { 'a' => 1 }
         def call(params)
-          ::MultiJson.load(params['payload'])
-        rescue ::MultiJson::ParseError => e
+          params.raw_payload.nil? ? nil : ::JSON.parse(params.raw_payload)
+        rescue ::JSON::ParserError => e
           raise ::Karafka::Errors::DeserializationError, e
         end
       end

data/lib/karafka/server.rb

@@ -58,9 +58,12 @@ module Karafka
       def stop_supervised
         Karafka::App.stop!
 
+        # See https://github.com/dry-rb/dry-configurable/issues/93
+        timeout = Thread.new { Karafka::App.config.shutdown_timeout }.join.value
+
         # We check from time to time (for the timeout period) if all the threads finished
         # their work and if so, we can just return and normal shutdown process will take place
-        (Karafka::App.config.shutdown_timeout * SUPERVISION_CHECK_FACTOR).to_i.times do
+        (timeout * SUPERVISION_CHECK_FACTOR).to_i.times do
           if consumer_threads.count(&:alive?).zero?
             Thread.new { Karafka.monitor.instrument('app.stopped') }.join
             return