karafka 2.5.4 → 2.5.6

data/lib/karafka/admin/configs.rb

@@ -11,91 +11,105 @@ module Karafka
     # Altering is done in the incremental way.
     class Configs < Admin
       class << self
-        # Fetches given resources configurations from Kafka
-        #
-        # @param resources [Resource, Array<Resource>] single resource we want to describe or
-        #   list of resources we are interested in. It is useful to provide multiple resources
-        #   when you need data from multiple topics, etc. Karafka will make one query for all the
-        #   data instead of doing one per topic.
-        #
-        # @return [Array<Resource>] array with resources containing their configuration details
-        #
-        # @note Even if you request one resource, result will always be an array with resources
-        #
-        # @example Describe topic named "example" and print its config
-        #   resource = Karafka::Admin::Configs::Resource.new(type: :topic, name: 'example')
-        #   results = Karafka::Admin::Configs.describe(resource)
-        #   results.first.configs.each do |config|
-        #     puts "#{config.name} - #{config.value}"
-        #   end
+        # @param resources [Resource, Array<Resource>] single resource or list of resources
+        #   to fetch configuration from Kafka
+        # @see #describe
         def describe(*resources)
-          operate_on_resources(
-            :describe_configs,
-            resources
-          )
+          new.describe(*resources)
         end
 
-        # Alters given resources based on the alteration operations accumulated in the provided
-        # resources
-        #
-        # @param resources [Resource, Array<Resource>] single resource we want to alter or
-        #   list of resources.
-        #
-        # @note This operation is not transactional and can work only partially if some config
-        #   options are not valid. Always make sure, your alterations are correct.
-        #
-        # @note We call it `#alter` despite using the Kafka incremental alter API because the
-        #   regular alter is deprecated.
-        #
-        # @example Alter the `delete.retention.ms` and set it to 8640001
-        #   resource = Karafka::Admin::Configs::Resource.new(type: :topic, name: 'example')
-        #   resource.set('delete.retention.ms', '8640001')
-        #   Karafka::Admin::Configs.alter(resource)
+        # @param resources [Resource, Array<Resource>] single resource or list of resources
+        #   with accumulated alteration operations to apply
+        # @see #alter
         def alter(*resources)
-          operate_on_resources(
-            :incremental_alter_configs,
-            resources
-          )
+          new.alter(*resources)
         end
+      end
 
-        private
+      # Fetches given resources configurations from Kafka
+      #
+      # @param resources [Resource, Array<Resource>] single resource we want to describe or
+      #   list of resources we are interested in. It is useful to provide multiple resources
+      #   when you need data from multiple topics, etc. Karafka will make one query for all the
+      #   data instead of doing one per topic.
+      #
+      # @return [Array<Resource>] array with resources containing their configuration details
+      #
+      # @note Even if you request one resource, result will always be an array with resources
+      #
+      # @example Describe topic named "example" and print its config
+      #   resource = Karafka::Admin::Configs::Resource.new(type: :topic, name: 'example')
+      #   results = Karafka::Admin::Configs.describe(resource)
+      #   results.first.configs.each do |config|
+      #     puts "#{config.name} - #{config.value}"
+      #   end
+      def describe(*resources)
+        operate_on_resources(
+          :describe_configs,
+          resources
+        )
+      end
 
-        # @param action [Symbol] runs given action via Rdkafka Admin
-        # @param resources [Array<Resource>] resources on which we want to operate
-        def operate_on_resources(action, resources)
-          resources = Array(resources).flatten
+      # Alters given resources based on the alteration operations accumulated in the provided
+      # resources
+      #
+      # @param resources [Resource, Array<Resource>] single resource we want to alter or
+      #   list of resources.
+      #
+      # @note This operation is not transactional and can work only partially if some config
+      #   options are not valid. Always make sure, your alterations are correct.
+      #
+      # @note We call it `#alter` despite using the Kafka incremental alter API because the
+      #   regular alter is deprecated.
+      #
+      # @example Alter the `delete.retention.ms` and set it to 8640001
+      #   resource = Karafka::Admin::Configs::Resource.new(type: :topic, name: 'example')
+      #   resource.set('delete.retention.ms', '8640001')
+      #   Karafka::Admin::Configs.alter(resource)
+      def alter(*resources)
+        operate_on_resources(
+          :incremental_alter_configs,
+          resources
+        )
+      end
 
-          result = with_admin_wait do |admin|
-            admin.public_send(
-              action,
-              resources.map(&:to_native_hash)
-            )
-          end
+      private
 
-          result.resources.map do |rd_kafka_resource|
-            # Create back a resource
-            resource = Resource.new(
-              name: rd_kafka_resource.name,
-              type: rd_kafka_resource.type
-            )
+      # @param action [Symbol] runs given action via Rdkafka Admin
+      # @param resources [Array<Resource>] resources on which we want to operate
+      def operate_on_resources(action, resources)
+        resources = Array(resources).flatten
 
-            rd_kafka_resource.configs.each do |rd_kafka_config|
-              resource.configs << Config.from_rd_kafka(rd_kafka_config)
-            end
+        result = with_admin_wait do |admin|
+          admin.public_send(
+            action,
+            resources.map(&:to_native_hash)
+          )
+        end
 
-            resource.configs.sort_by!(&:name)
-            resource.configs.freeze
+        result.resources.map do |rd_kafka_resource|
+          # Create back a resource
+          resource = Resource.new(
+            name: rd_kafka_resource.name,
+            type: rd_kafka_resource.type
+          )
 
-            resource
+          rd_kafka_resource.configs.each do |rd_kafka_config|
+            resource.configs << Config.from_rd_kafka(rd_kafka_config)
           end
+
+          resource.configs.sort_by!(&:name)
+          resource.configs.freeze
+
+          resource
         end
+      end
 
-        # Yields admin instance, allows to run Acl operations and awaits on the final result
-        # Makes sure that admin is closed afterwards.
-        def with_admin_wait
-          with_admin do |admin|
-            yield(admin).wait(max_wait_timeout: max_wait_time)
-          end
+      # Yields admin instance, allows to run Configs operations and awaits on the final result
+      # Makes sure that admin is closed afterwards.
+      def with_admin_wait
+        with_admin do |admin|
+          yield(admin).wait(max_wait_timeout_ms: self.class.max_wait_time)
         end
       end
     end