phobos 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77558904b4cc06321149de51f2b13edeb97704a93128749214ba8454ff997db3
-  data.tar.gz: c88ded6d626d55f56eef5645147f102867097bbc5d32c8c4d3604a24b53f8d57
+  metadata.gz: ec66514784d6b38c90a4ca0aaf063e001536d2680732c4afa535b49c2a55cb9c
+  data.tar.gz: 1d988dd76e39305cfb30d3dd8e8fd926065631e391ed077d7c0459e6760587b4
 SHA512:
-  metadata.gz: e2c541adb24d1a42be9c99958508ebc143c078c3294df9245094c954de8c5d240be89fdf8a1afcf05ed3ad556290b2a7928b5722b4e1b56a25b2095f9e3d2b69
-  data.tar.gz: 49af36a25cc903e7bcc87e6a7a453dfd32127111ce99896b77bf31f50c1967cc8550b9e3740d47d42febaae44ffa92c7dd5e3959c96a0b637bcc5bb20ddf0c66
+  metadata.gz: 07a92fdf61d970a61f98cfb8615568fa48af0550fb473458b6dce67b479b684ce8e280dbd97b20b5c16f84bf14fa18eea47f8bae490c6ac5712b8d21d2c4d037
+  data.tar.gz: 59bb2c58cfd017b8f9462eb431d2bb62322bdc817a1260816648481abff4ff0a5d6f1df5430f3888a0bad3cb92eeb11ee2ace3ced62df1e8ee02756bb1e8a795

data/.gitignore

@@ -13,3 +13,4 @@ config/*.yml
 log/*.log
 .byebug_history
 .idea
+*.gem

data/CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ``
 ## UNRELEASED
 
+## [2.1.0] - 2021-05-27
+
+- Modify config to allow specifying kafka connection information separately for consumers and producers
+
 ## [2.0.2] - 2021-01-28
 - Additional fixes for Ruby 3.0
 

data/README.md

@@ -404,9 +404,12 @@ All [options supported by  `ruby-kafka`][ruby-kafka-client] can be provided.
 __producer__ provides configurations for all producers created over the application,
 the options are the same for regular and async producers.
 All [options supported by  `ruby-kafka`][ruby-kafka-producer] can be provided.
+If the __kafka__ key is present under __producer__, it is merged into the top-level __kafka__, allowing different connection configuration for producers.
 
 __consumer__ provides configurations for all consumer groups created over the application.
 All [options supported by  `ruby-kafka`][ruby-kafka-consumer] can be provided.
+If the __kafka__ key is present under __consumer__, it is merged into the top-level __kafka__, allowing different connection configuration for consumers.
+
 
 __backoff__ Phobos provides automatic retries for your handlers. If an exception
 is raised, the listener will retry following the back off configured here.
@@ -582,8 +585,11 @@ After checking out the repo:
 * make sure `docker` is installed and running (for windows and mac this also includes `docker-compose`).
 * Linux: make sure `docker-compose` is installed and running.
 * run `bin/setup` to install dependencies
-* run `docker-compose up` to start the required kafka containers in a window
-* run `rspec` to run the tests in another window
+* run `docker-compose up -d --force-recreate kafka zookeeper` to start the required kafka containers
+* run tests to confirm no environmental issues
+  * wait a few seconds for kafka broker to get set up - `sleep 30`
+  * run `docker-compose run --rm test`
+  * make sure it reports `X examples, 0 failures`
 
 You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 

data/config/phobos.yml.example

@@ -65,6 +65,10 @@ producer:
   # that you need to manually call sync_producer_shutdown before exiting,
   # similar to async_producer_shutdown.
   persistent_connections: false
+  # kafka here supports the same parameters as the top-level, allowing custom connection
+  # configuration details for producers
+  kafka:
+    connect_timeout: 120
 
 consumer:
   # number of seconds after which, if a client hasn't contacted the Kafka cluster,
@@ -79,6 +83,10 @@ consumer:
   offset_retention_time:
   # interval between heartbeats; must be less than the session window
   heartbeat_interval: 10
+  # kafka here supports the same parameters as the top-level, allowing custom connection
+  # configuration details for consumers
+  kafka:
+    connect_timeout: 130
 
 backoff:
   min_ms: 1000

data/lib/phobos.rb

@@ -55,8 +55,12 @@ module Phobos
 
     def configure(configuration)
       @config = fetch_configuration(configuration)
-      @config.class.send(:define_method, :producer_hash) { Phobos.config.producer&.to_hash }
-      @config.class.send(:define_method, :consumer_hash) { Phobos.config.consumer&.to_hash }
+      @config.class.send(:define_method, :producer_hash) do
+        Phobos.config.producer&.to_hash&.except(:kafka)
+      end
+      @config.class.send(:define_method, :consumer_hash) do
+        Phobos.config.consumer&.to_hash&.except(:kafka)
+      end
       @config.listeners ||= []
       configure_logger
     end
@@ -66,8 +70,14 @@ module Phobos
       @config.listeners += listeners_config.listeners
     end
 
-    def create_kafka_client
-      Kafka.new(**config.kafka.to_hash.merge(logger: @ruby_kafka_logger))
+    def create_kafka_client(config_key = nil)
+      kafka_config = config.kafka.to_hash.merge(logger: @ruby_kafka_logger)
+
+      if config_key
+        kafka_config = kafka_config.merge(**config.send(config_key)&.kafka&.to_hash || {})
+      end
+
+      Kafka.new(**kafka_config)
     end
 
     def create_exponential_backoff(backoff_config = nil)

data/lib/phobos/listener.rb

@@ -35,7 +35,7 @@ module Phobos
       )
       @encoding = Encoding.const_get(force_encoding.to_sym) if force_encoding
       @message_processing_opts = compact(min_bytes: min_bytes, max_wait_time: max_wait_time)
-      @kafka_client = Phobos.create_kafka_client
+      @kafka_client = Phobos.create_kafka_client(:consumer)
       @producer_enabled = @handler_class.ancestors.include?(Phobos::Producer)
     end
     # rubocop:enable Metrics/MethodLength

data/lib/phobos/producer.rb

@@ -77,7 +77,7 @@ module Phobos
         end
 
         def create_sync_producer
-          client = kafka_client || configure_kafka_client(Phobos.create_kafka_client)
+          client = kafka_client || configure_kafka_client(Phobos.create_kafka_client(:producer))
           sync_producer = client.producer(**regular_configs)
           if Phobos.config.producer_hash[:persistent_connections]
             producer_store[:sync_producer] = sync_producer
@@ -108,7 +108,7 @@ module Phobos
         end
 
         def create_async_producer
-          client = kafka_client || configure_kafka_client(Phobos.create_kafka_client)
+          client = kafka_client || configure_kafka_client(Phobos.create_kafka_client(:producer))
           async_producer = client.async_producer(**async_configs)
           producer_store[:async_producer] = async_producer
         end

data/lib/phobos/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Phobos
-  VERSION = '2.0.2'
+  VERSION = '2.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phobos
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Túlio Ornelas
@@ -15,7 +15,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-01-28 00:00:00.000000000 Z
+date: 2021-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -314,7 +314,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.16
 signing_key:
 specification_version: 4
 summary: Simplifying Kafka for ruby apps