waterdrop 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ca8a589d1b25ca64ff4fe5e0b9b501a73aa70fe14901b6d9a5da7e6792cad89
-  data.tar.gz: bd75fb0f84eab0ebdc69412e72bd7132a327c545585e7ff5c04d0e3771be82dd
+  metadata.gz: a79785b00fcedfb6385e4a5afeba36ba905ab2e6168b8efd9ec9ea2185382723
+  data.tar.gz: 388da5d63dcfee4acc918e7dfa1b65d969b28950eb4094d5314e58c74aabd322
 SHA512:
-  metadata.gz: c0e6501922e0e3fac96db78e8666b800fb1a8244e136c88b21f8af808803b5aaad81fb24726bb3d84eacba19a933dbde31660c94b3b0d992123cac66d032f824
-  data.tar.gz: f85d2617e9139e84b70b23221f92efa9f04c188da04b0077c945b0da978733aa9f9dbfc87b089c907faadb30b0931cd93bfd099914f9b258a4ab788f0cafcd8e
+  metadata.gz: 648f5ff9824df4cbe8f597e9c4c635d31f2ae4bab6cda643657ebe759a96a83e168166192b023aebdc6a848d1dfc27e18b69b0ccc101e37eac621dfc316a7424
+  data.tar.gz: 1a32f771148dd11f7836468acc9e92d77b3997b6bb3866587684548be464b5450251455b239c19794d5701bdc911cbb016c7b68e69dfb411963d5ea8cf8c8aa6

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 # WaterDrop changelog
 
+## 1.2.2
+- #55 - Codec settings unification and config applier
+
 ## 1.2.1
 - #54 - compression_codec api sync with king-konf requirements
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    waterdrop (1.2.1)
+    waterdrop (1.2.2)
       delivery_boy (~> 0.2)
       dry-configurable (~> 0.7)
       dry-monitor (~> 0.1)

data/lib/water_drop.rb

@@ -23,22 +23,8 @@ module WaterDrop
     # @param [Block] block configuration block
     def setup(&block)
       Config.setup(&block)
-
       DeliveryBoy.logger = self.logger = config.logger
-
-      # Recursive lambda for mapping config down to delivery boy
-      applier = lambda { |db_config, h|
-        h.each do |k, v|
-          applier.call(db_config, v) && next if v.is_a?(Hash)
-          next unless db_config.respond_to?(:"#{k}=")
-          db_config.public_send(:"#{k}=", v)
-        end
-      }
-
-      DeliveryBoy.config.tap do |config|
-        config.brokers = Config.config.kafka.seed_brokers
-        applier.call(config, Config.config.to_h)
-      end
+      ConfigApplier.call(DeliveryBoy.config, Config.config.to_h)
     end
 
     # @return [WaterDrop::Config] config instance
@@ -65,6 +51,7 @@ end
   schemas/message_options
   schemas/config
   config
+  config_applier
   errors
   base_producer
   sync_producer

data/lib/water_drop/config.rb

@@ -110,17 +110,6 @@ module WaterDrop
       setting :sasl_scram_mechanism, nil
     end
 
-    # option producer [Hash] - optional - producer configuration options
-    setting :producer do
-      # option compression_codec [Symbol] Sets producer compression codec
-      # More: https://github.com/zendesk/ruby-kafka#compression
-      # More: https://github.com/zendesk/ruby-kafka/blob/master/lib/kafka/compression.rb
-      setting :compression_codec, nil
-      # option compression_codec [Integer] Sets producer compression threshold
-      # More: https://github.com/zendesk/ruby-kafka#compression
-      setting :compression_threshold, 1
-    end
-
     class << self
       # Configurating method
       # @yield Runs a block of code providing a config singleton instance to it

data/lib/water_drop/config_applier.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module WaterDrop
+  # Engine used to propagate config application to DeliveryBoy with corner case handling
+  module ConfigApplier
+    class << self
+      # @param delivery_boy_config [DeliveryBoy::Config] delivery boy config instance
+      # @param settings [Hash] hash with WaterDrop settings
+      def call(delivery_boy_config, settings)
+        # Recursive lambda for mapping config down to delivery boy
+        settings.each do |key, value|
+          call(delivery_boy_config, value) && next if value.is_a?(Hash)
+
+          # If this is a special case that needs manual setup instead of a direct reassignment
+          if respond_to?(key, true)
+            send(key, delivery_boy_config, value)
+          else
+            # If this setting is our internal one, we should not sync it with the delivery boy
+            next unless delivery_boy_config.respond_to?(:"#{key}=")
+
+            delivery_boy_config.public_send(:"#{key}=", value)
+          end
+        end
+      end
+
+      private
+
+      # Extra setup for the compression codec as it behaves differently than other settings
+      # that are ported 1:1 from ruby-kafka
+      # For some crazy reason, delivery boy requires compression codec as a string, when
+      # ruby-kafka as a symbol. We follow ruby-kafka internal design, so we had to mimic
+      # that by assigning a stringified version that down the road will be symbolized again
+      # by delivery boy
+      # @param delivery_boy_config [DeliveryBoy::Config] delivery boy config instance
+      # @param codec_name [Symbol] codec name as a symbol
+      def compression_codec(delivery_boy_config, codec_name)
+        # If there is no compression codec, we don't apply anything
+        return unless codec_name
+        delivery_boy_config.compression_codec = codec_name.to_s
+      end
+
+      # We use the "seed_brokers" name and DeliveryBoy uses "brokers" so we pass the values
+      #   manually
+      # @param delivery_boy_config [DeliveryBoy::Config] delivery boy config instance
+      # @param seed_brokers [Array<String>] kafka seed brokers
+      def seed_brokers(delivery_boy_config, seed_brokers)
+        delivery_boy_config.brokers = seed_brokers
+      end
+    end
+  end
+end

data/lib/water_drop/schemas/config.rb

@@ -37,10 +37,10 @@ module WaterDrop
 
       required(:kafka).schema do
         required(:seed_brokers).filled { each(:broker_schema?) }
-        required(:connect_timeout).filled { (int? | float?) & gt?(0) }
-        required(:socket_timeout).filled { (int? | float?) & gt?(0) }
+        required(:connect_timeout).filled(:int?, gt?: 0)
+        required(:socket_timeout).filled(:int?, gt?: 0)
         required(:compression_threshold).filled(:int?, gteq?: 1)
-        optional(:compression_codec).maybe(included_in?: %w[snappy gzip lz4])
+        optional(:compression_codec).maybe(included_in?: %i[snappy gzip lz4])
 
         required(:max_buffer_bytesize).filled(:int?, gt?: 0)
         required(:max_buffer_size).filled(:int?, gt?: 0)

data/lib/water_drop/version.rb

@@ -3,5 +3,5 @@
 # WaterDrop library
 module WaterDrop
   # Current WaterDrop version
-  VERSION = '1.2.1'
+  VERSION = '1.2.2'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: waterdrop
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -102,6 +102,7 @@ files:
 - lib/water_drop/async_producer.rb
 - lib/water_drop/base_producer.rb
 - lib/water_drop/config.rb
+- lib/water_drop/config_applier.rb
 - lib/water_drop/errors.rb
 - lib/water_drop/instrumentation/listener.rb
 - lib/water_drop/instrumentation/monitor.rb