karafka 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45788f5dd509d8a61a1480ff5c1b41f89b683d2100e0dcedaf6e35e6ce3af447
-  data.tar.gz: d5e5638fd2a83b91f78cf1f38d03bd2594fb562a0cc8ad6cf2e45f60e72cc692
+  metadata.gz: 7bae0f63af5f741dc00d382e34a0a5a35262692c9b03930dc18fd05440bf418b
+  data.tar.gz: f9a82e8ee1324b62820f24e8dddd09fdd1ec153c50a32f4f31f50a9192983341
 SHA512:
-  metadata.gz: 75b2863022df6dc78f23ca557450a9757e137d110f9a6c49a29f572cd701863143e638394c341e8f982bdce4255df923879c8410ce081503c43e3f9a0ce2e777
-  data.tar.gz: ec0eee525c34634d15b04c85a492e329d4749f179ff2c21d3ce2e50cccb4b6d061465c13df322a026b8924974f743277448464db818e13d73ef90f5ce930f796
+  metadata.gz: a8fecf4be83990908c8aaf6b1e0f262391e9cdd65079362f76f68871d9ec3f45e4c0e9ceb1b277036de7f4c6ab2c140e52ee4ad855ec150c64626e9728a650a6
+  data.tar.gz: 2b626896aad5bc96bce14f0943a8d9c279dd877d2a221994f2ae56031d0bc97a33e5696b892bc8224f1c527a27e0861a79aaedd4b7716286528f6baf8f00de04

data/.ruby-version

@@ -1 +1 @@
-2.7.1
+2.7.2

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Karafka framework changelog
 
+## 1.4.1 (2020-12-04)
+- Return non-zero exit code when printing usage
+- Add support for :assignment_strategy for consumers
+
 ## 1.4.0 (2020-09-05)
 - Rename `Karafka::Params::Metadata` to `Karafka::Params::BatchMetadata`
 ` Rename consumer `#metadata` to `#batch_metadata`

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    karafka (1.4.0)
+    karafka (1.4.1)
       dry-configurable (~> 0.8)
       dry-inflector (~> 0.1)
       dry-monitor (~> 0.3)
@@ -17,7 +17,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.0.3.2)
+    activesupport (6.0.3.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -39,7 +39,7 @@ GEM
     dry-container (0.7.2)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.4.9)
+    dry-core (0.4.10)
       concurrent-ruby (~> 1.0)
     dry-equalizer (0.3.0)
     dry-events (0.2.0)
@@ -47,8 +47,8 @@ GEM
       dry-core (~> 0.4)
       dry-equalizer (~> 0.2)
     dry-inflector (0.2.0)
-    dry-initializer (3.0.3)
-    dry-logic (1.0.7)
+    dry-initializer (3.0.4)
+    dry-logic (1.0.8)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.2)
       dry-equalizer (~> 0.2)
@@ -57,7 +57,7 @@ GEM
       dry-core (~> 0.4)
       dry-equalizer (~> 0.2)
       dry-events (~> 0.2)
-    dry-schema (1.5.4)
+    dry-schema (1.5.6)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.8, >= 0.8.3)
       dry-core (~> 0.4)
@@ -86,35 +86,37 @@ GEM
     i18n (1.8.5)
       concurrent-ruby (~> 1.0)
     io-console (0.5.6)
-    irb (1.2.4)
-      reline (>= 0.0.1)
+    irb (1.2.7)
+      reline (>= 0.1.5)
     king_konf (0.3.7)
     minitest (5.14.2)
     rake (13.0.1)
-    reline (0.1.4)
+    reline (0.1.9)
       io-console (~> 0.5)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    ruby-kafka (1.2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    ruby-kafka (1.3.0)
       digest-crc
-    simplecov (0.19.0)
+    simplecov (0.20.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
-    simplecov-html (0.12.2)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
     thor (1.0.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.7)
+    tzinfo (1.2.8)
       thread_safe (~> 0.1)
     waterdrop (1.4.0)
       delivery_boy (>= 0.2, < 2.x)
@@ -123,7 +125,7 @@ GEM
       dry-validation (~> 1.2)
       ruby-kafka (>= 0.7.8)
       zeitwerk (~> 2.1)
-    zeitwerk (2.4.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby

data/config/errors.yml

@@ -37,3 +37,5 @@ en:
         Unknown consumer group
       does_not_exist:
         Given file does not exist or cannot be read
+      does_not_respond_to_call: >
+        needs to respond to a #call method

data/lib/karafka/assignment_strategies/round_robin.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Karafka
+  # Strategies for Kafka partitions assignments
+  module AssignmentStrategies
+    # Standard RoundRobin strategy
+    class RoundRobin < SimpleDelegator
+      def initialize
+        super(Kafka::RoundRobinAssignmentStrategy.new)
+      end
+    end
+  end
+end

data/lib/karafka/attributes_map.rb

@@ -19,6 +19,7 @@ module Karafka
           consumer: %i[
             session_timeout offset_commit_interval offset_commit_threshold
             offset_retention_time heartbeat_interval fetcher_max_queue_size
+            assignment_strategy
           ],
           subscribe: %i[start_from_beginning max_bytes_per_partition],
           consumption: %i[min_bytes max_bytes max_wait_time],

data/lib/karafka/cli.rb

@@ -10,6 +10,8 @@ module Karafka
   class Cli < Thor
     package_name 'Karafka'
 
+    default_task :missingno
+
     class << self
       # Loads all Cli commands into Thor framework
       # This method should be executed before we run Karafka::Cli.start, otherwise we won't
@@ -20,6 +22,12 @@ module Karafka
         end
       end
 
+      # When there is a CLI crash, exit
+      # @return [true]
+      def exit_on_failure?
+        true
+      end
+
       private
 
       # @return [Array<Class>] Array with Cli action classes that can be used as commands

data/lib/karafka/cli/base.rb

@@ -43,16 +43,16 @@ module Karafka
         end
 
         # Allows to set description of a given cli command
-        # @param desc [String] Description of a given cli command
-        def desc(desc)
-          @desc ||= desc
+        # @param args [Array] All the arguments that Thor desc method accepts
+        def desc(*args)
+          @desc ||= args
         end
 
         # This method will bind a given Cli command into Karafka Cli
         # This method is a wrapper to way Thor defines its commands
         # @param cli_class [Karafka::Cli] Karafka cli_class
         def bind_to(cli_class)
-          cli_class.desc name, @desc
+          cli_class.desc name, *@desc
 
           (@options || []).each { |option| cli_class.option(*option) }
 

data/lib/karafka/cli/missingno.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Karafka
+  class Cli < Thor
+    # Command that gets invoked when no method is provided when running the CLI
+    # It allows us to exit with exit code 1 instead of default 0 to indicate that something
+    #   was missing
+    # @see https://github.com/karafka/karafka/issues/619
+    class Missingno < Base
+      desc 'Hidden command that gets invoked when no command is provided', hide: true
+
+      # Prints an error about the lack of command (nothing selected)
+      def call
+        Karafka.logger.error('No command provided')
+        exit 1
+      end
+    end
+  end
+end

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/contracts/consumer_group.rb

@@ -32,6 +32,7 @@ module Karafka
         required(:offset_retention_time).maybe(:integer)
         required(:heartbeat_interval).filled { (int? | float?) & gteq?(0) }
         required(:fetcher_max_queue_size).filled(:int?, gt?: 0)
+        required(:assignment_strategy).value(:any)
         required(:connect_timeout).filled { (int? | float?) & gt?(0) }
         required(:reconnect_timeout).filled { (int? | float?) & gteq?(0) }
         required(:socket_timeout).filled { (int? | float?) & gt?(0) }
@@ -70,13 +71,13 @@ module Karafka
 
       # Uri rule to check if uri is in a Karafka acceptable format
       rule(:seed_brokers) do
-        if value&.is_a?(Array) && !value.all?(&method(:kafka_uri?))
+        if value.is_a?(Array) && !value.all?(&method(:kafka_uri?))
           key.failure(:invalid_broker_schema)
         end
       end
 
       rule(:topics) do
-        if value&.is_a?(Array)
+        if value.is_a?(Array)
           names = value.map { |topic| topic[:name] }
 
           key.failure(:topics_names_not_unique) if names.size != names.uniq.size
@@ -84,7 +85,7 @@ module Karafka
       end
 
       rule(:topics) do
-        if value&.is_a?(Array)
+        if value.is_a?(Array)
           value.each_with_index do |topic, index|
             TOPIC_CONTRACT.call(topic).errors.each do |error|
               key([:topics, index, error.path[0]]).failure(error.text)
@@ -93,6 +94,10 @@ module Karafka
         end
       end
 
+      rule(:assignment_strategy) do
+        key.failure(:does_not_respond_to_call) unless value.respond_to?(:call)
+      end
+
       rule(:ssl_client_cert, :ssl_client_cert_key) do
         if values[:ssl_client_cert] && !values[:ssl_client_cert_key]
           key(:ssl_client_cert_key).failure(:ssl_client_cert_with_ssl_client_cert_key)

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
 

data/lib/karafka/instrumentation/logger.rb

@@ -29,11 +29,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)
+          .to($stdout, file)
       end
 
       # Makes sure the log directory exists as long as we can write to it

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/setup/config.rb

@@ -89,6 +89,9 @@ module Karafka
         #   are stored for further processing. Note, that each item in the queue represents a
         #   response from a single broker
         setting :fetcher_max_queue_size, 10
+        # option assignment_strategy [Object] a strategy determining the assignment of
+        #   partitions to the consumers.
+        setting :assignment_strategy, Karafka::AssignmentStrategies::RoundRobin.new
         # option max_bytes_per_partition [Integer] the maximum amount of data fetched
         #   from a single partition at a time.
         setting :max_bytes_per_partition, 1_048_576

data/lib/karafka/version.rb

@@ -3,5 +3,5 @@
 # Main module namespace
 module Karafka
   # Current Karafka version
-  VERSION = '1.4.0'
+  VERSION = '1.4.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karafka
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -36,7 +36,7 @@ cert_chain:
   2DND//YJUikn1zwbz1kT70XmHd97B4Eytpln7K+M1u2g1pHVEPW4owD/ammXNpUy
   nt70FcDD4yxJQ+0YNiHd0N8IcVBM1TMIVctMNQ==
   -----END CERTIFICATE-----
-date: 2020-09-05 00:00:00.000000000 Z
+date: 2020-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -227,6 +227,7 @@ files:
 - karafka.gemspec
 - lib/karafka.rb
 - lib/karafka/app.rb
+- lib/karafka/assignment_strategies/round_robin.rb
 - lib/karafka/attributes_map.rb
 - lib/karafka/backends/inline.rb
 - lib/karafka/base_consumer.rb
@@ -237,6 +238,7 @@ files:
 - lib/karafka/cli/flow.rb
 - lib/karafka/cli/info.rb
 - lib/karafka/cli/install.rb
+- lib/karafka/cli/missingno.rb
 - lib/karafka/cli/server.rb
 - lib/karafka/code_reloader.rb
 - lib/karafka/connection/api_adapter.rb