waterdrop 2.2.0 → 2.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db36e5203312e482d0d98a83d3bfb4fd5e274c342e5b3c63829d6bb5f616b52e
-  data.tar.gz: 6e49baf2f5ebd33aded769899fc0eb7f3c130ac97d9a6156fd491d000fd04306
+  metadata.gz: 154b5f8a103fcfaa47c5d410583d1aa2c0b689b52cd284614b06e7f7a9460179
+  data.tar.gz: c01ae313dbcf2830267438d3dd19f269a0a7bf29cad824af95f4313f6f04368e
 SHA512:
-  metadata.gz: 426d9f910ca5e24a7e86db1ceec672f895186ace830554708e8741d21bb83f929c9278ed5018bff6468b354523ac7cc790cba0b91b8c13dd2bb28e58f8a52dc6
-  data.tar.gz: b3871df6868ce287daf0765f522031cfdd566b96d0e5f8bf3ca1cd9724a7a68d5b3e4e1a33e0bdcc9b65063150d48cfc213e19348d19a6268a309b1c69dcab50
+  metadata.gz: 33e5ab153d45e265dd6cdb2b3ab9bb63bda7c8c4399097f1c5c130d4c493de635ee7fad957c83b97d6e5fdd6c4c049a0419ca5e0e063f8163478182cde6b92ed
+  data.tar.gz: 3858e9ac8d2f860f888a5445ec8c59d98d35dce199816058da850bfaaf80308ccd40cff2eb5e872eb3ba111259c4c4d07d0a0219e0a641da0ad0c456d184030a

data/.ruby-version

@@ -1 +1 @@
-3.1.0
+3.1.2

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # WaterDrop changelog
 
+## 2.3.2 (2022-07-17)
+- Replace `dry-configurable` with home-brew config and drop direct dependency on `dry-configurable`.
+
+## 2.3.1 (2022-06-17)
+- Update rdkafka patches to align with `0.12.0` and `0.11.1` support.
+
+## 2.3.0 (2022-04-03)
+-  Rename StdoutListener to LoggerListener (#240)
+
 ## 2.2.0 (2022-02-18)
 - Add Datadog listener for metrics + errors publishing
 - Add Datadog example dashboard template

data/Gemfile.lock

@@ -1,9 +1,8 @@
 PATH
   remote: .
   specs:
-    waterdrop (2.2.0)
+    waterdrop (2.3.2)
       concurrent-ruby (>= 1.1)
-      dry-configurable (~> 0.13)
       dry-monitor (~> 0.5)
       dry-validation (~> 1.7)
       rdkafka (>= 0.10)
@@ -12,36 +11,36 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.2)
+    activesupport (7.0.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     byebug (11.1.3)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
     docile (1.4.0)
-    dry-configurable (0.14.0)
+    dry-configurable (0.15.0)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.6)
-    dry-container (0.9.0)
+    dry-container (0.10.0)
       concurrent-ruby (~> 1.0)
-      dry-configurable (~> 0.13, >= 0.13.0)
-    dry-core (0.7.1)
+    dry-core (0.8.0)
       concurrent-ruby (~> 1.0)
     dry-events (0.3.0)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.5, >= 0.5)
-    dry-inflector (0.2.1)
+    dry-inflector (0.3.0)
     dry-initializer (3.1.1)
     dry-logic (1.2.0)
       concurrent-ruby (~> 1.0)
       dry-core (~> 0.5, >= 0.5)
-    dry-monitor (0.5.0)
+    dry-monitor (0.6.1)
       dry-configurable (~> 0.13, >= 0.13.0)
       dry-core (~> 0.5, >= 0.5)
       dry-events (~> 0.2)
-    dry-schema (1.8.0)
+      zeitwerk (~> 2.5)
+    dry-schema (1.9.3)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.13, >= 0.13.0)
       dry-core (~> 0.5, >= 0.5)
@@ -54,21 +53,21 @@ GEM
       dry-core (~> 0.5, >= 0.5)
       dry-inflector (~> 0.1, >= 0.1.2)
       dry-logic (~> 1.0, >= 1.0.2)
-    dry-validation (1.7.0)
+    dry-validation (1.8.1)
       concurrent-ruby (~> 1.0)
       dry-container (~> 0.7, >= 0.7.1)
       dry-core (~> 0.5, >= 0.5)
       dry-initializer (~> 3.0)
       dry-schema (~> 1.8, >= 1.8.0)
-    factory_bot (6.2.0)
+    factory_bot (6.2.1)
       activesupport (>= 5.0.0)
     ffi (1.15.5)
-    i18n (1.9.1)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    mini_portile2 (2.7.1)
-    minitest (5.15.0)
+    mini_portile2 (2.8.0)
+    minitest (5.16.0)
     rake (13.0.6)
-    rdkafka (0.11.1)
+    rdkafka (0.12.0)
       ffi (~> 1.15)
       mini_portile2 (~> 2.6)
       rake (> 12)
@@ -81,7 +80,7 @@ GEM
     rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
@@ -90,12 +89,13 @@ GEM
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
-    simplecov_json_formatter (0.1.3)
+    simplecov_json_formatter (0.1.4)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    zeitwerk (2.5.4)
+    zeitwerk (2.6.0)
 
 PLATFORMS
+  arm64-darwin-21
   x86_64-linux
 
 DEPENDENCIES
@@ -106,4 +106,4 @@ DEPENDENCIES
   waterdrop!
 
 BUNDLED WITH
-   2.3.7
+   2.3.15

data/README.md

@@ -1,8 +1,8 @@
 # WaterDrop
 
-**Note**: Documentation presented here refers to WaterDrop `2.0.0`.
+**Note**: Documentation presented here refers to WaterDrop `2.x`.
 
-WaterDrop `2.0` does **not** work with Karafka `1.*` and aims to either work as a standalone producer outside of Karafka `1.*` ecosystem or as a part of soon to be released Karafka `2.0.*`.
+WaterDrop `2.x` does **not** work with Karafka `1.*` and aims to either work as a standalone producer outside of Karafka `1.*` ecosystem or as a part of soon to be released Karafka `2.0.*`.
 
 Please refer to [this](https://github.com/karafka/waterdrop/tree/1.4) branch and its documentation for details about WaterDrop `1.*` usage.
 
@@ -314,7 +314,7 @@ end
 producer.monitor.subscribe(listener)
 ```
 
-You can also find a ready to import DataDog dashboard configuration file that you can use to monitor all of your producer.
+You can also find [here](https://github.com/karafka/waterdrop/blob/master/lib/waterdrop/instrumentation/vendors/datadog/dashboard.json) a ready to import DataDog dashboard configuration file that you can use to monitor all of your producers.
 
 ### Error notifications
 

data/lib/waterdrop/config.rb

@@ -5,7 +5,7 @@
 module WaterDrop
   # Configuration object for setting up all options required by WaterDrop
   class Config
-    include Dry::Configurable
+    include Configurable
 
     # Defaults for kafka settings, that will be overwritten only if not present already
     KAFKA_DEFAULTS = {
@@ -68,6 +68,8 @@ module WaterDrop
 
         ::Rdkafka::Config.logger = config.logger
       end
+
+      self
     end
 
     private

data/lib/waterdrop/configurable/leaf.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module WaterDrop
+  module Configurable
+    # Single end config value representation
+    Leaf = Struct.new(:name, :default, :constructor)
+  end
+end

data/lib/waterdrop/configurable/node.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module WaterDrop
+  module Configurable
+    # Single non-leaf node
+    # This is a core component for the configurable settings
+    #
+    # The idea here is simple: we collect settings (leafs) and children (nodes) information and we
+    # only compile/initialize the values prior to user running the `#configure` API. This API needs
+    # to run prior to using the result stuff even if there is nothing to configure
+    class Node
+      attr_reader :name, :nestings
+
+      # We need to be able to redefine children for deep copy
+      attr_accessor :children
+
+      # @param name [Symbol] node name
+      # @param nestings [Proc] block for nested settings
+      def initialize(name, nestings = ->(_) {})
+        @name = name
+        @children = []
+        @nestings = nestings
+        instance_eval(&nestings)
+      end
+
+      # Allows for a single leaf or nested node definition
+      #
+      # @param name [Symbol] setting or nested node name
+      # @param default [Object] default value
+      # @param constructor [#call, nil] callable or nil
+      # @param block [Proc] block for nested settings
+      def setting(name, default: nil, constructor: nil, &block)
+        @children << if block
+                       Node.new(name, block)
+                     else
+                       Leaf.new(name, default, constructor)
+                     end
+      end
+
+      # Allows for the configuration and setup of the settings
+      #
+      # Compile settings, allow for overrides via yielding
+      # @return [Node] returns self after configuration
+      def configure
+        compile
+        yield(self) if block_given?
+        self
+      end
+
+      # @return [Hash] frozen config hash representation
+      def to_h
+        config = {}
+
+        @children.each do |value|
+          config[value.name] = if value.is_a?(Leaf)
+                                 public_send(value.name)
+                               else
+                                 value.to_h
+                               end
+        end
+
+        config.freeze
+      end
+
+      # Deep copies all the children nodes to allow us for templates building on a class level and
+      # non-side-effect usage on an instance/inherited.
+      # @return [Node] duplicated node
+      def deep_dup
+        dupped = Node.new(name, nestings)
+
+        dupped.children += children.map do |value|
+          value.is_a?(Leaf) ? value.dup : value.deep_dup
+        end
+
+        dupped
+      end
+
+      # Converts the settings definitions into end children
+      # @note It runs once, after things are compiled, they will not be recompiled again
+      def compile
+        @children.each do |value|
+          # Do not redefine something that was already set during compilation
+          # This will allow us to reconfigure things and skip override with defaults
+          next if respond_to?(value.name)
+
+          singleton_class.attr_accessor value.name
+
+          initialized = if value.is_a?(Leaf)
+                          value.constructor ? value.constructor.call(value.default) : value.default
+                        else
+                          value.compile
+                          value
+                        end
+
+          public_send("#{value.name}=", initialized)
+        end
+      end
+    end
+  end
+end

data/lib/waterdrop/configurable.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module WaterDrop
+  # A simple dry-configuration API compatible module for defining settings with defaults and a
+  # constructor.
+  module Configurable
+    # A simple settings layer that works similar to dry-configurable
+    # It allows us to define settings on a class and per instance level with templating on a class
+    # level. It handles inheritance and allows for nested settings.
+    #
+    # @note The core settings template needs to be defined on a class level
+    class << self
+      # Sets up all the class methods and inits the core root node.
+      # Useful when only per class settings are needed as does not include instance methods
+      # @param base [Class] class that we extend
+      def extended(base)
+        base.extend ClassMethods
+      end
+
+      # Sets up all the class and instance methods and inits the core root node
+      #
+      # @param base [Class] class to which we want to add configuration
+      #
+      # Needs to be used when per instance configuration is needed
+      def included(base)
+        base.include InstanceMethods
+        base.extend self
+      end
+    end
+
+    # Instance related methods
+    module InstanceMethods
+      # @return [Node] config root node
+      def config
+        @config ||= self.class.config.deep_dup
+      end
+
+      # Allows for a per instance configuration (if needed)
+      # @param block [Proc] block for configuration
+      def configure(&block)
+        config.configure(&block)
+      end
+    end
+
+    # Class related methods
+    module ClassMethods
+      # @return [Node] root node for the settings
+      def config
+        return @config if @config
+
+        # This will handle inheritance
+        @config = if superclass.respond_to?(:config)
+                    superclass.config.deep_dup
+                  else
+                    Node.new(:root)
+                  end
+      end
+
+      # Allows for a per class configuration (if needed)
+      # @param block [Proc] block for configuration
+      def configure(&block)
+        config.configure(&block)
+      end
+
+      # Pipes the settings setup to the config root node
+      def setting(...)
+        config.setting(...)
+      end
+    end
+  end
+end

data/lib/waterdrop/instrumentation/{stdout_listener.rb → logger_listener.rb}

@@ -6,8 +6,8 @@ module WaterDrop
     # It can be removed/replaced or anything without any harm to the Waterdrop flow
     # @note It is a module as we can use it then as a part of the Karafka framework listener
     #   as well as we can use it standalone
-    class StdoutListener
-      # @param logger [Object] stdout logger we want to use
+    class LoggerListener
+      # @param logger [Object] logger we want to use
       def initialize(logger)
         @logger = logger
       end

data/lib/waterdrop/patches/rdkafka/producer.rb

@@ -10,7 +10,15 @@ module WaterDrop
         # Adds a method that allows us to get the native kafka producer name
         # @return [String] producer instance name
         def name
-          ::Rdkafka::Bindings.rd_kafka_name(@native_kafka)
+          unless @_native
+            version = ::Gem::Version.new(::Rdkafka::VERSION)
+            change = ::Gem::Version.new('0.12.0')
+            # 0.12.0 changed how the native producer client reference works.
+            # This code supports both older and newer versions of rdkafka
+            @_native = version >= change ? @client.native : @native_kafka
+          end
+
+          ::Rdkafka::Bindings.rd_kafka_name(@_native)
         end
       end
     end

data/lib/waterdrop/version.rb

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

data/lib/waterdrop.rb

@@ -4,7 +4,6 @@
 # delegate should be removed because we don't need it, we just add it because of ruby-kafka
 %w[
   concurrent/array
-  dry-configurable
   dry/monitor/notifications
   dry-validation
   rdkafka

data/waterdrop.gemspec

@@ -17,7 +17,6 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
 
   spec.add_dependency 'concurrent-ruby', '>= 1.1'
-  spec.add_dependency 'dry-configurable', '~> 0.13'
   spec.add_dependency 'dry-monitor', '~> 0.5'
   spec.add_dependency 'dry-validation', '~> 1.7'
   spec.add_dependency 'rdkafka', '>= 0.10'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: waterdrop
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.2
 platform: ruby
 authors:
 - Maciej Mensfeld
@@ -34,7 +34,7 @@ cert_chain:
   R2P11bWoCtr70BsccVrN8jEhzwXngMyI2gVt750Y+dbTu1KgRqZKp/ECe7ZzPzXj
   pIy9vHxTANKYVyI4qj8OrFdEM5BQNu8oQpL0iQ==
   -----END CERTIFICATE-----
-date: 2022-02-18 00:00:00.000000000 Z
+date: 2022-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
@@ -50,20 +50,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: dry-configurable
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.13'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: dry-monitor
   requirement: !ruby/object:Gem::Requirement
@@ -144,6 +130,9 @@ files:
 - docker-compose.yml
 - lib/waterdrop.rb
 - lib/waterdrop/config.rb
+- lib/waterdrop/configurable.rb
+- lib/waterdrop/configurable/leaf.rb
+- lib/waterdrop/configurable/node.rb
 - lib/waterdrop/contracts.rb
 - lib/waterdrop/contracts/base.rb
 - lib/waterdrop/contracts/config.rb
@@ -155,8 +144,8 @@ files:
 - lib/waterdrop/instrumentation/callbacks/statistics.rb
 - lib/waterdrop/instrumentation/callbacks/statistics_decorator.rb
 - lib/waterdrop/instrumentation/callbacks_manager.rb
+- lib/waterdrop/instrumentation/logger_listener.rb
 - lib/waterdrop/instrumentation/monitor.rb
-- lib/waterdrop/instrumentation/stdout_listener.rb
 - lib/waterdrop/instrumentation/vendors/datadog/dashboard.json
 - lib/waterdrop/instrumentation/vendors/datadog/listener.rb
 - lib/waterdrop/patches/rdkafka/bindings.rb
@@ -192,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.4
+rubygems_version: 3.3.7
 signing_key: 
 specification_version: 4
 summary: Kafka messaging made easy!

metadata.gz.sig

@@ -1 +1 @@
-`+k�0@�a�F�B�%Gȣ����vR۽���^�
+-���m�E�ΕQQiPq�ǶKP k�]�N|�<�b^@�{�@�i�[��B��7މ_˘d�v;G�8%��Htic�D�U+