karafka 1.2.0 → 1.3.1

data/lib/karafka/persistence/client.rb

@@ -7,18 +7,22 @@ module Karafka
       # Thread.current key under which we store current thread messages consumer client
       PERSISTENCE_SCOPE = :client
 
-      # @param client [Karafka::Connection::Client] messages consumer client of
-      #   a current thread
-      # @return [Karafka::Connection::Client] persisted messages consumer client
-      def self.write(client)
-        Thread.current[PERSISTENCE_SCOPE] = client
-      end
+      private_constant :PERSISTENCE_SCOPE
+
+      class << self
+        # @param client [Karafka::Connection::Client] messages consumer client of
+        #   a current thread
+        # @return [Karafka::Connection::Client] persisted messages consumer client
+        def write(client)
+          Thread.current[PERSISTENCE_SCOPE] = client
+        end
 
-      # @return [Karafka::Connection::Client] persisted messages consumer client
-      # @raise [Karafka::Errors::MissingConsumer] raised when no thread messages consumer
-      #   client but we try to use it anyway
-      def self.read
-        Thread.current[PERSISTENCE_SCOPE] || raise(Errors::MissingClient)
+        # @return [Karafka::Connection::Client] persisted messages consumer client
+        # @raise [Karafka::Errors::MissingClientError] raised when no thread messages consumer
+        #   client but we try to use it anyway
+        def read
+          Thread.current[PERSISTENCE_SCOPE] || raise(Errors::MissingClientError)
+        end
       end
     end
   end

data/lib/karafka/persistence/{consumer.rb → consumers.rb}

@@ -7,30 +7,37 @@ module Karafka
     # Module used to provide a persistent cache across batch requests for a given
     # topic and partition to store some additional details when the persistent mode
     # for a given topic is turned on
-    class Consumer
+    class Consumers
       # Thread.current scope under which we store consumers data
       PERSISTENCE_SCOPE = :consumers
 
+      private_constant :PERSISTENCE_SCOPE
+
       class << self
-        # @return [Hash] current thread persistence scope hash with all the consumers
-        def all
-          # @note This does not need to be threadsafe (Hash) as it is always executed in a
-          # current thread context
-          Thread.current[PERSISTENCE_SCOPE] ||= Hash.new { |hash, key| hash[key] = {} }
+        # @return [Hash] current thread's persistence scope hash with all the consumers
+        def current
+          Thread.current[PERSISTENCE_SCOPE] ||= Concurrent::Hash.new do |hash, key|
+            hash[key] = Concurrent::Hash.new
+          end
         end
 
         # Used to build (if block given) and/or fetch a current consumer instance that will be
         #   used to process messages from a given topic and partition
-        # @return [Karafka::BaseConsumer] base consumer descendant
         # @param topic [Karafka::Routing::Topic] topic instance for which we might cache
         # @param partition [Integer] number of partition for which we want to cache
+        # @return [Karafka::BaseConsumer] base consumer descendant
         def fetch(topic, partition)
-          # We always store a current instance for callback reasons
-          if topic.persistent
-            all[topic][partition] ||= topic.consumer.new
-          else
-            all[topic][partition] = topic.consumer.new
-          end
+          current[topic][partition] ||= topic.consumer.new(topic)
+        end
+
+        # Removes all persisted instances of consumers from the consumer cache
+        # @note This is used to reload consumers instances when code reloading in development mode
+        #   is present. This should not be used in production.
+        def clear
+          Thread
+            .list
+            .select { |thread| thread[PERSISTENCE_SCOPE] }
+            .each { |thread| thread[PERSISTENCE_SCOPE].clear }
         end
       end
     end

data/lib/karafka/persistence/topics.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Persistence
+    # Local cache for routing topics
+    # We use it in order not to build string instances and remap incoming topic upon each
+    # message / message batches received
+    class Topics
+      # Thread.current scope under which we store topics data
+      PERSISTENCE_SCOPE = :topics
+
+      private_constant :PERSISTENCE_SCOPE
+
+      class << self
+        # @return [Concurrent::Hash] hash with all the topics from given groups
+        def current
+          Thread.current[PERSISTENCE_SCOPE] ||= Concurrent::Hash.new do |hash, key|
+            hash[key] = Concurrent::Hash.new
+          end
+        end
+
+        # @param group_id [String] group id for which we fetch a topic representation
+        # @param raw_topic_name [String] raw topic name (before remapping) for which we fetch a
+        #   topic representation
+        # @return [Karafka::Routing::Topics] remapped topic representation that can be used further
+        #   on when working with given parameters
+        def fetch(group_id, raw_topic_name)
+          current[group_id][raw_topic_name] ||= begin
+            # We map from incoming topic name, as it might be namespaced, etc.
+            # @see topic_mapper internal docs
+            mapped_topic_name = Karafka::App.config.topic_mapper.incoming(raw_topic_name)
+            Routing::Router.find("#{group_id}_#{mapped_topic_name}")
+          end
+        end
+
+        # Clears the whole topics cache for all the threads
+        # This is used for in-development code reloading as we need to get rid of all the
+        # preloaded and cached instances of objects to make it work
+        def clear
+          Thread
+            .list
+            .select { |thread| thread[PERSISTENCE_SCOPE] }
+            .each { |thread| thread[PERSISTENCE_SCOPE].clear }
+        end
+      end
+    end
+  end
+end

data/lib/karafka/process.rb

@@ -4,8 +4,6 @@ module Karafka
   # Class used to catch signals from ruby Signal class in order to manage Karafka stop
   # @note There might be only one process - this class is a singleton
   class Process
-    include Singleton
-
     # Signal types that we handle
     HANDLED_SIGNALS = %i[
       SIGINT
@@ -34,10 +32,8 @@ module Karafka
 
     # Method catches all HANDLED_SIGNALS and performs appropriate callbacks (if defined)
     # @note If there are no callbacks, this method will just ignore a given signal that was sent
-    # @yield [Block] block of code that we want to execute and supervise
     def supervise
       HANDLED_SIGNALS.each { |signal| trap_signal(signal) }
-      yield
     end
 
     private

data/lib/karafka/responders/builder.rb

@@ -3,7 +3,7 @@
 module Karafka
   # Responders namespace encapsulates all the internal responder implementation parts
   module Responders
-    # Responders builder is used to finding (based on the consumer class name) a responder
+    # Responders builder is used for finding (based on the consumer class name) a responder
     # that match the consumer. We use it when user does not provide a responder inside routing,
     # but he still names responder with the same convention (and namespaces) as consumer
     #

data/lib/karafka/responders/topic.rb

@@ -7,8 +7,6 @@ module Karafka
     #   Karafka::Responders::Topic.new(:topic_name, {}) #=> #<Karafka::Responders::Topic...
     # @example Define optional topic
     #   Karafka::Responders::Topic.new(:topic_name, required: false)
-    # @example Define topic that on which we want to respond multiple times
-    #   Karafka::Responders::Topic.new(:topic_name, multiple_usage: true)
     class Topic
       # Name of the topic on which we want to respond
       attr_reader :name
@@ -26,16 +24,16 @@ module Karafka
         @options.key?(:required) ? @options[:required] : true
       end
 
-      # @return [Boolean] do we expect to use it multiple times in a single respond flow
-      def multiple_usage?
-        @options[:multiple_usage] || false
-      end
-
       # @return [Boolean] was usage of this topic registered or not
       def registered?
         @options[:registered] == true
       end
 
+      # @return [Class] Class to use to serialize messages for this topic
+      def serializer
+        @options[:serializer]
+      end
+
       # @return [Boolean] do we want to use async producer. Defaults to false as the sync producer
       #   is safer and introduces less problems
       def async?
@@ -46,9 +44,9 @@ module Karafka
       def to_h
         {
           name: name,
-          multiple_usage: multiple_usage?,
           required: required?,
           registered: registered?,
+          serializer: serializer,
           async: async?
         }
       end

data/lib/karafka/routing/builder.rb

@@ -9,26 +9,39 @@ module Karafka
     #       consumer NewVideosConsumer
     #     end
     #   end
-    class Builder < Array
-      include Singleton
+    class Builder < Concurrent::Array
+      # Consumer group consistency checking contract
+      CONTRACT = Karafka::Contracts::ConsumerGroup.new.freeze
+
+      private_constant :CONTRACT
+
+      def initialize
+        @draws = Concurrent::Array.new
+      end
 
       # Used to draw routes for Karafka
+      # @param block [Proc] block we will evaluate within the builder context
+      # @yield Evaluates provided block in a builder context so we can describe routes
+      # @raise [Karafka::Errors::InvalidConfigurationError] raised when configuration
+      #   doesn't match with the config contract
       # @note After it is done drawing it will store and validate all the routes to make sure that
       #   they are correct and that there are no topic/group duplications (this is forbidden)
-      # @yield Evaluates provided block in a builder context so we can describe routes
       # @example
       #   draw do
       #     topic :xyz do
       #     end
       #   end
       def draw(&block)
+        @draws << block
+
         instance_eval(&block)
 
         each do |consumer_group|
           hashed_group = consumer_group.to_h
-          validation_result = Karafka::Schemas::ConsumerGroup.call(hashed_group)
-          return if validation_result.success?
-          raise Errors::InvalidConfiguration, validation_result.errors
+          validation_result = CONTRACT.call(hashed_group)
+          next if validation_result.success?
+
+          raise Errors::InvalidConfigurationError, validation_result.errors.to_h
         end
       end
 
@@ -39,18 +52,33 @@ module Karafka
         select(&:active?)
       end
 
+      # Clears the builder and the draws memory
+      def clear
+        @draws.clear
+        super
+      end
+
+      # Redraws all the routes for the in-process code reloading.
+      # @note This won't allow registration of new topics without process restart but will trigger
+      #   cache invalidation so all the classes, etc are re-fetched after code reload
+      def reload
+        draws = @draws.dup
+        clear
+        draws.each { |block| draw(&block) }
+      end
+
       private
 
       # Builds and saves given consumer group
       # @param group_id [String, Symbol] name for consumer group
-      # @yield Evaluates a given block in a consumer group context
+      # @param block [Proc] proc that should be executed in the proxy context
       def consumer_group(group_id, &block)
         consumer_group = ConsumerGroup.new(group_id.to_s)
         self << Proxy.new(consumer_group, &block).target
       end
 
       # @param topic_name [String, Symbol] name of a topic from which we want to consumer
-      # @yield Evaluates a given block in a topic context
+      # @param block [Proc] proc we want to evaluate in the topic context
       def topic(topic_name, &block)
         consumer_group(topic_name) do
           topic(topic_name, &block).tap(&:build)

data/lib/karafka/routing/consumer_group.rb

@@ -29,7 +29,7 @@ module Karafka
 
       # Builds a topic representation inside of a current consumer group route
       # @param name [String, Symbol] name of topic to which we want to subscribe
-      # @yield Evaluates a given block in a topic context
+      # @param block [Proc] block that we want to evaluate in the topic context
       # @return [Karafka::Routing::Topic] newly built topic instance
       def topic=(name, &block)
         topic = Topic.new(name, self)

data/lib/karafka/routing/consumer_mapper.rb

@@ -4,29 +4,29 @@ module Karafka
   module Routing
     # Default consumer mapper that builds consumer ids based on app id and consumer group name
     # Different mapper can be used in case of preexisting consumer names or for applying
-    # other naming conventions not compatible wiih Karafkas client_id + consumer name concept
+    # other naming conventions not compatible with Karafka client_id + consumer name concept
     #
     # @example Mapper for using consumer groups without a client_id prefix
-    #   module MyMapper
-    #     def self.call(raw_consumer_group_name)
+    #   class MyMapper
+    #     def call(raw_consumer_group_name)
     #       raw_consumer_group_name
     #     end
     #   end
     #
     # @example Mapper for replacing "_" with "." in topic names
-    #   module MyMapper
-    #     def self.call(raw_consumer_group_name)
+    #   class MyMapper
+    #     def call(raw_consumer_group_name)
     #       [
-    #         Dry::Inflector.new.underscore(Karafka::App.config.client_id.to_s),
+    #         Karafka::Helpers::Inflector.map(Karafka::App.config.client_id.to_s),
     #         raw_consumer_group_name
     #       ].join('_').gsub('_', '.')
     #     end
     #   end
-    module ConsumerMapper
+    class ConsumerMapper
       # @param raw_consumer_group_name [String, Symbol] string or symbolized consumer group name
       # @return [String] remapped final consumer group name
-      def self.call(raw_consumer_group_name)
-        client_name = Dry::Inflector.new.underscore(Karafka::App.config.client_id.to_s)
+      def call(raw_consumer_group_name)
+        client_name = Karafka::Helpers::Inflector.map(Karafka::App.config.client_id.to_s)
         "#{client_name}_#{raw_consumer_group_name}"
       end
     end

data/lib/karafka/routing/proxy.rb

@@ -14,22 +14,31 @@ module Karafka
         !
       ].freeze
 
+      private_constant :IGNORED_POSTFIXES
+
       # @param target [Object] target object to which we proxy any DSL call
-      # @yield Evaluates block in the proxy context
+      # @param block [Proc] block that we want to evaluate in the proxy context
       def initialize(target, &block)
         @target = target
         instance_eval(&block)
       end
 
       # Translates the no "=" DSL of routing into elements assignments on target
+      # @param method_name [Symbol] name of the missing method
+      # @param arguments [Array] array with it's arguments
+      # @param block [Proc] block provided to the method
       def method_missing(method_name, *arguments, &block)
         return super unless respond_to_missing?(method_name)
+
         @target.public_send(:"#{method_name}=", *arguments, &block)
       end
 
       # Tells whether or not a given element exists on the target
+      # @param method_name [Symbol] name of the missing method
+      # @param include_private [Boolean] should we include private in the check as well
       def respond_to_missing?(method_name, include_private = false)
         return false if IGNORED_POSTFIXES.any? { |postfix| method_name.to_s.end_with?(postfix) }
+
         @target.respond_to?(:"#{method_name}=", include_private) || super
       end
     end

data/lib/karafka/routing/topic.rb

@@ -7,10 +7,13 @@ module Karafka
     # It is a part of Karafka's DSL
     class Topic
       extend Helpers::ConfigRetriever
+      extend Forwardable
 
       attr_reader :id, :consumer_group
       attr_accessor :consumer
 
+      def_delegator :@consumer_group, :batch_fetching
+
       # @param [String, Symbol] name of a topic on which we want to listen
       # @param consumer_group [Karafka::Routing::ConsumerGroup] owning consumer group of this topic
       def initialize(name, consumer_group)
@@ -19,7 +22,7 @@ module Karafka
         @attributes = {}
         # @note We use identifier related to the consumer group that owns a topic, because from
         #   Karafka 0.6 we can handle multiple Kafka instances with the same process and we can
-        #   have same topic name across mutliple Kafkas
+        #   have same topic name across multiple Kafkas
         @id = "#{consumer_group.id}_#{@name}"
       end
 
@@ -29,12 +32,11 @@ module Karafka
       # example for Sidekiq
       def build
         Karafka::AttributesMap.topic.each { |attr| send(attr) }
-        consumer&.topic = self
         self
       end
 
       # @return [Class, nil] Class (not an instance) of a responder that should respond from
-      #   consumer back to Kafka (usefull for piping dataflows)
+      #   consumer back to Kafka (useful for piping data flows)
       def responder
         @responder ||= Karafka::Responders::Builder.new(consumer).build
       end

data/lib/karafka/routing/topic_mapper.rb

@@ -8,7 +8,7 @@ module Karafka
     # routes and responders
     #
     # @example Mapper for mapping prefixed topics
-    #   module MyMapper
+    #   class MyMapper
     #     PREFIX = "my_user_name."
     #
     #     def incoming(topic)
@@ -21,7 +21,7 @@ module Karafka
     #   end
     #
     # @example Mapper for replacing "." with "_" in topic names
-    #   module MyMapper
+    #   class MyMapper
     #     PREFIX = "my_user_name."
     #
     #     def incoming(topic)
@@ -32,23 +32,21 @@ module Karafka
     #       topic.to_s.gsub('_', '.')
     #     end
     #   end
-    module TopicMapper
-      class << self
-        # @param topic [String, Symbol] topic
-        # @return [String, Symbol] same topic as on input
-        # @example
-        #   incoming('topic_name') #=> 'topic_name'
-        def incoming(topic)
-          topic
-        end
+    class TopicMapper
+      # @param topic [String, Symbol] topic
+      # @return [String, Symbol] same topic as on input
+      # @example
+      #   incoming('topic_name') #=> 'topic_name'
+      def incoming(topic)
+        topic
+      end
 
-        # @param topic [String, Symbol] topic
-        # @return [String, Symbol] same topic as on input
-        # @example
-        #   outgoing('topic_name') #=> 'topic_name'
-        def outgoing(topic)
-          topic
-        end
+      # @param topic [String, Symbol] topic
+      # @return [String, Symbol] same topic as on input
+      # @example
+      #   outgoing('topic_name') #=> 'topic_name'
+      def outgoing(topic)
+        topic
       end
     end
   end