karafka 2.5.4 → 2.5.5

data/lib/karafka/admin/topics.rb

@@ -7,232 +7,278 @@ module Karafka
     # introspection
     class Topics < Admin
       class << self
-        # Allows us to read messages from the topic
-        #
         # @param name [String, Symbol] topic name
         # @param partition [Integer] partition
         # @param count [Integer] how many messages we want to get at most
-        # @param start_offset [Integer, Time] offset from which we should start. If -1 is provided
-        #   (default) we will start from the latest offset. If time is provided, the appropriate
-        #   offset will be resolved. If negative beyond -1 is provided, we move backwards more.
+        # @param start_offset [Integer, Time] offset from which we should start
         # @param settings [Hash] kafka extra settings (optional)
-        #
-        # @return [Array<Karafka::Messages::Message>] array with messages
+        # @see #read
         def read(name, partition, count, start_offset = -1, settings = {})
-          messages = []
-          tpl = Rdkafka::Consumer::TopicPartitionList.new
-          low_offset, high_offset = nil
+          new.read(name, partition, count, start_offset, settings)
+        end
+
+        # @param name [String] topic name
+        # @param partitions [Integer] number of partitions for this topic
+        # @param replication_factor [Integer] number of replicas
+        # @param topic_config [Hash] topic config details as described in the
+        #   `base topic configuration`))
+        # @see #create
+        def create(name, partitions, replication_factor, topic_config = {})
+          new.create(name, partitions, replication_factor, topic_config)
+        end
+
+        # @param name [String] topic name
+        # @see #delete
+        def delete(name)
+          new.delete(name)
+        end
+
+        # @param name [String] topic name
+        # @param partitions [Integer] total number of partitions we expect to end up with
+        # @see #create_partitions
+        def create_partitions(name, partitions)
+          new.create_partitions(name, partitions)
+        end
 
-          with_consumer(settings) do |consumer|
-            # Convert the time offset (if needed)
-            start_offset = resolve_offset(consumer, name.to_s, partition, start_offset)
+        # @param name_or_hash [String, Symbol, Hash] topic name or hash with topics and partitions
+        # @param partition [Integer, nil] partition (nil when using hash format)
+        # @see #read_watermark_offsets
+        def read_watermark_offsets(name_or_hash, partition = nil)
+          new.read_watermark_offsets(name_or_hash, partition)
+        end
 
-            low_offset, high_offset = consumer.query_watermark_offsets(name, partition)
+        # @param topic_name [String] name of the topic we're interested in
+        # @see #info
+        def info(topic_name)
+          new.info(topic_name)
+        end
+      end
 
-            # Select offset dynamically if -1 or less and move backwards with the negative
-            # offset, allowing to start from N messages back from high-watermark
-            start_offset = high_offset - count - start_offset.abs + 1 if start_offset.negative?
-            start_offset = low_offset if start_offset.negative?
+      # Allows us to read messages from the topic
+      #
+      # @param name [String, Symbol] topic name
+      # @param partition [Integer] partition
+      # @param count [Integer] how many messages we want to get at most
+      # @param start_offset [Integer, Time] offset from which we should start. If -1 is provided
+      #   (default) we will start from the latest offset. If time is provided, the appropriate
+      #   offset will be resolved. If negative beyond -1 is provided, we move backwards more.
+      # @param settings [Hash] kafka extra settings (optional)
+      #
+      # @return [Array<Karafka::Messages::Message>] array with messages
+      def read(name, partition, count, start_offset = -1, settings = {})
+        messages = []
+        tpl = Rdkafka::Consumer::TopicPartitionList.new
+        low_offset, high_offset = nil
 
-            # Build the requested range - since first element is on the start offset we need to
-            # subtract one from requested count to end up with expected number of elements
-            requested_range = (start_offset..(start_offset + count - 1))
-            # Establish theoretical available range. Note, that this does not handle cases related
-            # to log retention or compaction
-            available_range = (low_offset..(high_offset - 1))
-            # Select only offset that we can select. This will remove all the potential offsets
-            # that are below the low watermark offset
-            possible_range = requested_range.select { |offset| available_range.include?(offset) }
+        with_consumer(settings) do |consumer|
+          # Convert the time offset (if needed)
+          start_offset = resolve_offset(consumer, name.to_s, partition, start_offset)
 
-            start_offset = possible_range.first
-            count = possible_range.size
+          low_offset, high_offset = consumer.query_watermark_offsets(name, partition)
 
-            tpl.add_topic_and_partitions_with_offsets(name, partition => start_offset)
-            consumer.assign(tpl)
+          # Select offset dynamically if -1 or less and move backwards with the negative
+          # offset, allowing to start from N messages back from high-watermark
+          start_offset = high_offset - count - start_offset.abs + 1 if start_offset.negative?
+          start_offset = low_offset if start_offset.negative?
 
-            # We should poll as long as we don't have all the messages that we need or as long as
-            # we do not read all the messages from the topic
-            loop do
-              # If we've got as many messages as we've wanted stop
-              break if messages.size >= count
+          # Build the requested range - since first element is on the start offset we need to
+          # subtract one from requested count to end up with expected number of elements
+          requested_range = (start_offset..(start_offset + count - 1))
+          # Establish theoretical available range. Note, that this does not handle cases related
+          # to log retention or compaction
+          available_range = (low_offset..(high_offset - 1))
+          # Select only offset that we can select. This will remove all the potential offsets
+          # that are below the low watermark offset
+          possible_range = requested_range.select { |offset| available_range.include?(offset) }
 
-              message = consumer.poll(200)
+          start_offset = possible_range.first
+          count = possible_range.size
 
-              next unless message
+          tpl.add_topic_and_partitions_with_offsets(name, partition => start_offset)
+          consumer.assign(tpl)
 
-              # If the message we've got is beyond the requested range, stop
-              break unless possible_range.include?(message.offset)
+          # We should poll as long as we don't have all the messages that we need or as long as
+          # we do not read all the messages from the topic
+          loop do
+            # If we've got as many messages as we've wanted stop
+            break if messages.size >= count
 
-              messages << message
-            rescue Rdkafka::RdkafkaError => e
-              # End of partition
-              break if e.code == :partition_eof
+            message = consumer.poll(200)
 
-              raise e
-            end
-          end
+            next unless message
 
-          # Use topic from routes if we can match it or create a dummy one
-          # Dummy one is used in case we cannot match the topic with routes. This can happen
-          # when admin API is used to read topics that are not part of the routing
-          topic = Karafka::Routing::Router.find_or_initialize_by_name(name)
-
-          messages.map! do |message|
-            Messages::Builders::Message.call(
-              message,
-              topic,
-              Time.now
-            )
-          end
-        end
+            # If the message we've got is beyond the requested range, stop
+            break unless possible_range.include?(message.offset)
 
-        # Creates Kafka topic with given settings
-        #
-        # @param name [String] topic name
-        # @param partitions [Integer] number of partitions we expect
-        # @param replication_factor [Integer] number of replicas
-        # @param topic_config [Hash] topic config details as described here:
-        #   https://kafka.apache.org/documentation/#topicconfigs
-        #
-        # @return [void]
-        def create(name, partitions, replication_factor, topic_config = {})
-          with_admin do |admin|
-            handler = admin.create_topic(name, partitions, replication_factor, topic_config)
+            messages << message
+          rescue Rdkafka::RdkafkaError => e
+            # End of partition
+            break if e.code == :partition_eof
 
-            with_re_wait(
-              -> { handler.wait(max_wait_timeout: max_wait_time_seconds) },
-              -> { names.include?(name) }
-            )
+            raise e
           end
         end
 
-        # Deleted a given topic
-        #
-        # @param name [String] topic name
-        #
-        # @return [void]
-        def delete(name)
-          with_admin do |admin|
-            handler = admin.delete_topic(name)
+        # Use topic from routes if we can match it or create a dummy one
+        # Dummy one is used in case we cannot match the topic with routes. This can happen
+        # when admin API is used to read topics that are not part of the routing
+        topic = Karafka::Routing::Router.find_or_initialize_by_name(name)
 
-            with_re_wait(
-              -> { handler.wait(max_wait_timeout: max_wait_time_seconds) },
-              -> { !names.include?(name) }
-            )
-          end
+        messages.map! do |message|
+          Messages::Builders::Message.call(
+            message,
+            topic,
+            Time.now
+          )
         end
+      end
 
-        # Creates more partitions for a given topic
-        #
-        # @param name [String] topic name
-        # @param partitions [Integer] total number of partitions we expect to end up with
-        #
-        # @return [void]
-        def create_partitions(name, partitions)
-          with_admin do |admin|
-            handler = admin.create_partitions(name, partitions)
+      # Creates Kafka topic with given settings
+      #
+      # @param name [String] topic name
+      # @param partitions [Integer] number of partitions we expect
+      # @param replication_factor [Integer] number of replicas
+      # @param topic_config [Hash] topic config details as described here:
+      #   https://kafka.apache.org/documentation/#topicconfigs
+      #
+      # @return [void]
+      def create(name, partitions, replication_factor, topic_config = {})
+        with_admin do |admin|
+          handler = admin.create_topic(name, partitions, replication_factor, topic_config)
 
-            with_re_wait(
-              -> { handler.wait(max_wait_timeout: max_wait_time_seconds) },
-              -> { info(name).fetch(:partition_count) >= partitions }
-            )
-          end
+          with_re_wait(
+            -> { handler.wait(max_wait_timeout: max_wait_time_seconds) },
+            -> { names.include?(name) }
+          )
         end
+      end
 
-        # Fetches the watermark offsets for a given topic partition or multiple topics and
-        # partitions
-        #
-        # @param name_or_hash [String, Symbol, Hash] topic name or hash with topics and partitions
-        # @param partition [Integer, nil] partition number
-        #   (required when first param is topic name)
-        #
-        # @return [Array<Integer, Integer>, Hash] when querying single partition returns array with
-        #   low and high watermark offsets, when querying multiple returns nested hash
-        #
-        # @example Query single partition
-        #   Karafka::Admin::Topics.read_watermark_offsets('events', 0)
-        #   # => [0, 100]
-        #
-        # @example Query specific partitions across multiple topics
-        #   Karafka::Admin::Topics.read_watermark_offsets(
-        #     { 'events' => [0, 1], 'logs' => [0] }
-        #   )
-        #   # => {
-        #   #   'events' => {
-        #   #     0 => [0, 100],
-        #   #     1 => [0, 150]
-        #   #   },
-        #   #   'logs' => {
-        #   #     0 => [0, 50]
-        #   #   }
-        #   # }
-        def read_watermark_offsets(name_or_hash, partition = nil)
-          # Normalize input to hash format
-          topics_with_partitions = partition ? { name_or_hash => [partition] } : name_or_hash
+      # Deleted a given topic
+      #
+      # @param name [String] topic name
+      #
+      # @return [void]
+      def delete(name)
+        with_admin do |admin|
+          handler = admin.delete_topic(name)
 
-          result = Hash.new { |h, k| h[k] = {} }
+          with_re_wait(
+            -> { handler.wait(max_wait_timeout: max_wait_time_seconds) },
+            -> { !names.include?(name) }
+          )
+        end
+      end
 
-          with_consumer do |consumer|
-            topics_with_partitions.each do |topic, partitions|
-              partitions.each do |partition_id|
-                result[topic][partition_id] = consumer.query_watermark_offsets(topic, partition_id)
-              end
-            end
-          end
+      # Creates more partitions for a given topic
+      #
+      # @param name [String] topic name
+      # @param partitions [Integer] total number of partitions we expect to end up with
+      #
+      # @return [void]
+      def create_partitions(name, partitions)
+        with_admin do |admin|
+          handler = admin.create_partitions(name, partitions)
 
-          # Return single array for single partition query, hash for multiple
-          partition ? result.dig(name_or_hash, partition) : result
+          with_re_wait(
+            -> { handler.wait(max_wait_timeout: max_wait_time_seconds) },
+            -> { info(name).fetch(:partition_count) >= partitions }
+          )
         end
+      end
 
-        # Returns basic topic metadata
-        #
-        # @param topic_name [String] name of the topic we're interested in
-        # @return [Hash] topic metadata info hash
-        # @raise [Rdkafka::RdkafkaError] `unknown_topic_or_part` if requested topic is not found
-        #
-        # @note This query is much more efficient than doing a full `#cluster_info` + topic lookup
-        #   because it does not have to query for all the topics data but just the topic we're
-        #   interested in
-        def info(topic_name)
-          with_admin do |admin|
-            admin
-              .metadata(topic_name)
-              .topics
-              .find { |topic| topic[:topic_name] == topic_name }
+      # Fetches the watermark offsets for a given topic partition or multiple topics and
+      # partitions
+      #
+      # @param name_or_hash [String, Symbol, Hash] topic name or hash with topics and partitions
+      # @param partition [Integer, nil] partition number
+      #   (required when first param is topic name)
+      #
+      # @return [Array<Integer, Integer>, Hash] when querying single partition returns array with
+      #   low and high watermark offsets, when querying multiple returns nested hash
+      #
+      # @example Query single partition
+      #   Karafka::Admin::Topics.read_watermark_offsets('events', 0)
+      #   # => [0, 100]
+      #
+      # @example Query specific partitions across multiple topics
+      #   Karafka::Admin::Topics.read_watermark_offsets(
+      #     { 'events' => [0, 1], 'logs' => [0] }
+      #   )
+      #   # => {
+      #   #   'events' => {
+      #   #     0 => [0, 100],
+      #   #     1 => [0, 150]
+      #   #   },
+      #   #   'logs' => {
+      #   #     0 => [0, 50]
+      #   #   }
+      #   # }
+      def read_watermark_offsets(name_or_hash, partition = nil)
+        # Normalize input to hash format
+        topics_with_partitions = partition ? { name_or_hash => [partition] } : name_or_hash
+
+        result = Hash.new { |h, k| h[k] = {} }
+
+        with_consumer do |consumer|
+          topics_with_partitions.each do |topic, partitions|
+            partitions.each do |partition_id|
+              result[topic][partition_id] = consumer.query_watermark_offsets(topic, partition_id)
+            end
           end
         end
 
-        private
+        # Return single array for single partition query, hash for multiple
+        partition ? result.dig(name_or_hash, partition) : result
+      end
 
-        # @return [Array<String>] topics names
-        def names
-          cluster_info.topics.map { |topic| topic.fetch(:topic_name) }
+      # Returns basic topic metadata
+      #
+      # @param topic_name [String] name of the topic we're interested in
+      # @return [Hash] topic metadata info hash
+      # @raise [Rdkafka::RdkafkaError] `unknown_topic_or_part` if requested topic is not found
+      #
+      # @note This query is much more efficient than doing a full `#cluster_info` + topic lookup
+      #   because it does not have to query for all the topics data but just the topic we're
+      #   interested in
+      def info(topic_name)
+        with_admin do |admin|
+          admin
+            .metadata(topic_name)
+            .topics
+            .find { |topic| topic[:topic_name] == topic_name }
         end
+      end
 
-        # Resolves the offset if offset is in a time format. Otherwise returns the offset without
-        # resolving.
-        # @param consumer [::Rdkafka::Consumer]
-        # @param name [String, Symbol] expected topic name
-        # @param partition [Integer]
-        # @param offset [Integer, Time]
-        # @return [Integer] expected offset
-        def resolve_offset(consumer, name, partition, offset)
-          if offset.is_a?(Time)
-            tpl = Rdkafka::Consumer::TopicPartitionList.new
-            tpl.add_topic_and_partitions_with_offsets(
-              name, partition => offset
-            )
-
-            real_offsets = consumer.offsets_for_times(tpl)
-            detected_offset = real_offsets
-                              .to_h
-                              .fetch(name)
-                              .find { |p_data| p_data.partition == partition }
-
-            detected_offset&.offset || raise(Errors::InvalidTimeBasedOffsetError)
-          else
-            offset
-          end
+      private
+
+      # @return [Array<String>] topics names
+      def names
+        cluster_info.topics.map { |topic| topic.fetch(:topic_name) }
+      end
+
+      # Resolves the offset if offset is in a time format. Otherwise returns the offset without
+      # resolving.
+      # @param consumer [::Rdkafka::Consumer]
+      # @param name [String, Symbol] expected topic name
+      # @param partition [Integer]
+      # @param offset [Integer, Time]
+      # @return [Integer] expected offset
+      def resolve_offset(consumer, name, partition, offset)
+        if offset.is_a?(Time)
+          tpl = Rdkafka::Consumer::TopicPartitionList.new
+          tpl.add_topic_and_partitions_with_offsets(
+            name, partition => offset
+          )
+
+          real_offsets = consumer.offsets_for_times(tpl)
+          detected_offset = real_offsets
+                            .to_h
+                            .fetch(name)
+                            .find { |p_data| p_data.partition == partition }
+
+          detected_offset&.offset || raise(Errors::InvalidTimeBasedOffsetError)
+        else
+          offset
         end
       end
     end