karafka-testing 2.3.2 → 2.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4932859009198b689571ee03c117e5255efbba52deb34874c689577cd456bf47
-  data.tar.gz: a83d1892a15392beb4889d77f642c2368b9a57a07073e9ce6ae4f884ad6ba61c
+  metadata.gz: 91a12f6c61514bc890bdfd8f6c91e1a834dd1516299f8a6d421c54037d3b55b3
+  data.tar.gz: 70d467cb5994992d5a3046511bca0676fabc673b2b36c45d366b98d6aeeeae06
 SHA512:
-  metadata.gz: 0c99a0ece8c0ae1e2b46541148236b86ce26f1652c6e3cd82e4d3158ed42797b67019a4ec79db3c21efbc9a8e65e53e7e07cc6effa876190b5377dbd1cf2a8f2
-  data.tar.gz: d422ab991a2cfa2796e8dff02d9902c19f3d64e8f6d4d269283468abfbb0c20569f699faeef4f78dac440662ab94fea7da293361a7f824ba5219070358e6c1fa
+  metadata.gz: ebb18327ff48e4443377a54a09d35611c84f6806bc298ceb0792d1b2862f7f1c35e2c528bdb8b7e611d61998201f851dc8648530d398fdbbd33ec504d7fedae7
+  data.tar.gz: 9898b5f1bd9264b696361cfd60039226864eb26743722c21a251fad26d2bd9d633b9be0cadcf62dbc7638a5287b69a0aaf720b12ad70595cc03c6bc1c4fe920f

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Karafka Test gem changelog
 
+## 2.3.3 (2024-04-19)
+- [Refactor] Extract common components for Minitest and RSpec.
+- [Fix] Fix a case where multiplexed SG would fail with `TopicInManyConsumerGroupsError`
+
 ## 2.3.2 (2024-04-03)
 - [Enhancement] Support `Minitest::Spec`.
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    karafka-testing (2.3.2)
+    karafka-testing (2.3.3)
       karafka (>= 2.3.0, < 2.4.0)
       waterdrop (>= 2.6.12)
 

data/lib/karafka/testing/helpers.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Karafka
+  module Testing
+    # Common helper methods that are shared in between RSpec and Minitest
+    module Helpers
+      class << self
+        # Finds all the routing topics matching requested topic within all topics or within
+        # provided consumer group based on name
+        #
+        # @param requested_topic [String] requested topic name
+        # @param requested_consumer_group [String] requested consumer group or nil to look in all
+        # @return [Array<Karafka::Routing::Topic>] all matching topics
+        #
+        # @note Since we run the lookup on subscription groups, the search will automatically
+        #   expand with matching patterns
+        def karafka_consumer_find_candidate_topics(requested_topic, requested_consumer_group)
+          karafka_consumer_find_subscription_groups(requested_consumer_group)
+            # multiplexed subscriptions of the same origin share name, thus we can reduced
+            # multiplexing to the first one as during testing, there is no multiplexing parallel
+            # execution anyhow
+            .uniq(&:name)
+            .map(&:topics)
+            .filter_map do |topics|
+              topics.find(requested_topic.to_s)
+            rescue Karafka::Errors::TopicNotFoundError
+              nil
+            end
+        end
+
+        # Finds subscription groups from the requested consumer group or selects all if no
+        # consumer group specified
+        # @param requested_consumer_group [String] requested consumer group or nil to look in all
+        # @return [Array<Karafka::Routing::SubscriptionGroup>] requested subscription groups
+        def karafka_consumer_find_subscription_groups(requested_consumer_group)
+          if requested_consumer_group && !requested_consumer_group.empty?
+            ::Karafka::App
+              .subscription_groups
+              # Find matching consumer group
+              .find { |cg, _sgs| cg.name == requested_consumer_group.to_s }
+              # Raise error if not found
+              .tap { |cg| cg || raise(Errors::ConsumerGroupNotFound, requested_consumer_group) }
+              # Since lookup was on a hash, get the value, that is subscription groups
+              .last
+          else
+            ::Karafka::App
+              .subscription_groups
+              .values
+              .flatten
+          end
+        end
+      end
+    end
+  end
+end

data/lib/karafka/testing/minitest/helpers.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'karafka/testing/errors'
+require 'karafka/testing/helpers'
 require 'karafka/testing/spec_consumer_client'
 require 'karafka/testing/spec_producer_client'
 require 'karafka/testing/minitest/proxy'
@@ -53,7 +54,7 @@ module Karafka
         # @example Creates a consumer instance with settings for `my_requested_topic`
         #   consumer = @karafka.consumer_for(:my_requested_topic)
         def _karafka_consumer_for(requested_topic, requested_consumer_group = nil)
-          selected_topics = _karafka_consumer_find_candidate_topics(
+          selected_topics = Testing::Helpers.karafka_consumer_find_candidate_topics(
             requested_topic.to_s,
             requested_consumer_group.to_s
           )
@@ -166,47 +167,6 @@ module Karafka
           @consumer.instance_variable_set('@used', true)
           @consumer
         end
-
-        # Finds all the routing topics matching requested topic within all topics or within
-        # provided consumer group based on name
-        #
-        # @param requested_topic [String] requested topic name
-        # @param requested_consumer_group [String] requested consumer group or nil to look in all
-        # @return [Array<Karafka::Routing::Topic>] all matching topics
-        #
-        # @note Since we run the lookup on subscription groups, the search will automatically
-        #   expand with matching patterns
-        def _karafka_consumer_find_candidate_topics(requested_topic, requested_consumer_group)
-          _karafka_consumer_find_subscription_groups(requested_consumer_group)
-            .map(&:topics)
-            .filter_map do |topics|
-              topics.find(requested_topic.to_s)
-            rescue Karafka::Errors::TopicNotFoundError
-              nil
-            end
-        end
-
-        # Finds subscription groups from the requested consumer group or selects all if no
-        # consumer group specified
-        # @param requested_consumer_group [String] requested consumer group or nil to look in all
-        # @return [Array<Karafka::Routing::SubscriptionGroup>] requested subscription groups
-        def _karafka_consumer_find_subscription_groups(requested_consumer_group)
-          if requested_consumer_group && !requested_consumer_group.empty?
-            ::Karafka::App
-              .subscription_groups
-              # Find matching consumer group
-              .find { |cg, _sgs| cg.name == requested_consumer_group.to_s }
-              # Raise error if not found
-              .tap { |cg| cg || raise(Errors::ConsumerGroupNotFound, requested_consumer_group) }
-              # Since lookup was on a hash, get the value, that is subscription groups
-              .last
-          else
-            ::Karafka::App
-              .subscription_groups
-              .values
-              .flatten
-          end
-        end
       end
     end
   end

data/lib/karafka/testing/rspec/helpers.rb

@@ -2,6 +2,7 @@
 
 require 'waterdrop'
 require 'karafka/testing/errors'
+require 'karafka/testing/helpers'
 require 'karafka/testing/spec_consumer_client'
 require 'karafka/testing/spec_producer_client'
 require 'karafka/testing/rspec/proxy'
@@ -57,7 +58,7 @@ module Karafka
         #     subject(:consumer) { karafka.consumer_for(:my_requested_topic) }
         #   end
         def _karafka_consumer_for(requested_topic, requested_consumer_group = nil)
-          selected_topics = _karafka_consumer_find_candidate_topics(
+          selected_topics = Testing::Helpers.karafka_consumer_find_candidate_topics(
             requested_topic.to_s,
             requested_consumer_group.to_s
           )
@@ -176,47 +177,6 @@ module Karafka
           consumer.instance_variable_set('@used', true)
           consumer
         end
-
-        # Finds all the routing topics matching requested topic within all topics or within
-        # provided consumer group based on name
-        #
-        # @param requested_topic [String] requested topic name
-        # @param requested_consumer_group [String] requested consumer group or nil to look in all
-        # @return [Array<Karafka::Routing::Topic>] all matching topics
-        #
-        # @note Since we run the lookup on subscription groups, the search will automatically
-        #   expand with matching patterns
-        def _karafka_consumer_find_candidate_topics(requested_topic, requested_consumer_group)
-          _karafka_consumer_find_subscription_groups(requested_consumer_group)
-            .map(&:topics)
-            .filter_map do |topics|
-              topics.find(requested_topic.to_s)
-            rescue Karafka::Errors::TopicNotFoundError
-              nil
-            end
-        end
-
-        # Finds subscription groups from the requested consumer group or selects all if no
-        # consumer group specified
-        # @param requested_consumer_group [String] requested consumer group or nil to look in all
-        # @return [Array<Karafka::Routing::SubscriptionGroup>] requested subscription groups
-        def _karafka_consumer_find_subscription_groups(requested_consumer_group)
-          if requested_consumer_group && !requested_consumer_group.empty?
-            ::Karafka::App
-              .subscription_groups
-              # Find matching consumer group
-              .find { |cg, _sgs| cg.name == requested_consumer_group.to_s }
-              # Raise error if not found
-              .tap { |cg| cg || raise(Errors::ConsumerGroupNotFound, requested_consumer_group) }
-              # Since lookup was on a hash, get the value, that is subscription groups
-              .last
-          else
-            ::Karafka::App
-              .subscription_groups
-              .values
-              .flatten
-          end
-        end
       end
     end
   end

data/lib/karafka/testing/version.rb

@@ -4,6 +4,6 @@
 module Karafka
   module Testing
     # Current version of gem. It should match Karafka framework version
-    VERSION = '2.3.2'
+    VERSION = '2.3.3'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: karafka-testing
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 2.3.3
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -35,7 +35,7 @@ cert_chain:
   AnG1dJU+yL2BK7vaVytLTstJME5mepSZ46qqIJXMuWob/YPDmVaBF39TDSG9e34s
   msG3BiCqgOgHAnL23+CN3Rt8MsuRfEtoTKpJVcCfoEoNHOkc
   -----END CERTIFICATE-----
-date: 2024-04-11 00:00:00.000000000 Z
+date: 2024-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: karafka
@@ -97,6 +97,7 @@ files:
 - lib/karafka-testing.rb
 - lib/karafka/testing.rb
 - lib/karafka/testing/errors.rb
+- lib/karafka/testing/helpers.rb
 - lib/karafka/testing/minitest/helpers.rb
 - lib/karafka/testing/minitest/proxy.rb
 - lib/karafka/testing/rspec/helpers.rb