manageiq-messaging 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f305d2c3c254dc42831ab6d12154fa65edeedc3461fbf88bfa77166e68613702
-  data.tar.gz: 939165f57c4671312398de35cec92781d5f97a82c08a584e7a0da727e2ed2eca
+  metadata.gz: cfe85cf657f8c2c1abbe3c4e89fbaddb02339972f0c93c2e325b5eadba10b456
+  data.tar.gz: 5e28a2cc86fa33a89893cad6652aa20acd5af801f5061c5a2c0632668f1c94c8
 SHA512:
-  metadata.gz: 14e817bf9ee97c577b866a49989b8041c96c8ec2f9949aace412c3065e5143f6bac18ffae0569b8ff87506dc33604349b2a79e4ed62edbf44820e7ebcae9bcfe
-  data.tar.gz: a8d5a83c36de5a9290573e893fcbd97468ef47700e96ec499cce1649e4dc68090a6d3fdb43acdf1a4a7b4ce62f8daa49f469db1b2f7b7be721e46122fda04f9b
+  metadata.gz: a20dad2e6813bdacfc24ebfb81a9edff1ae37156de353c307d8e403cb27915a4da928872feff00cb157fb8aa5539e67d024afc20c7ceaba79f68ea564cbbdd27
+  data.tar.gz: 786daacf2af78548fe5695e38d36083b21e1c9bedfe13977d287a5b8f1ae5f22d58f5b379ca40144382873e08b120acb0bebf2835cfda0d7eee67e556c085aee

data/.github/workflows/ci.yaml

@@ -28,6 +28,7 @@ jobs:
       with:
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true
+      timeout-minutes: 30
     - name: Run tests
       run: bundle exec rake
     - name: Report code coverage

data/CHANGELOG.md

@@ -6,6 +6,15 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [1.2.0] - 19-Oct-2022
+
+* Add ssl and ca_file options to `Client.open` [#76](https://github.com/ManageIQ/manageiq-messaging/pull/76)
+* Add wait_for_topic option to Kafka [#75](https://github.com/ManageIQ/manageiq-messaging/pull/75)
+
+## [1.1.2] - 6-Oct-2022
+
+* Fix kafka publish_topic on ruby3 [#74](https://github.com/ManageIQ/manageiq-messaging/pull/74)
+
 ## [1.1.1] - 6-May-2022
 
 * Ruby 3.0 support [#71](https://github.com/ManageIQ/manageiq-messaging/pull/71)

data/lib/manageiq/messaging/client.rb

@@ -33,6 +33,12 @@ module ManageIQ
       # Open or create a connection to the message broker.
       # Expected +options+ keys are:
       # * :protocol (Implemented: 'Stomp', 'Kafka'. Default 'Stomp')
+      # * :host (hostname or IP address of the messaging broker)
+      # * :port (host port number)
+      # * :username (optional)
+      # * :password (optional)
+      # * :ssl (true/false)
+      # * :ca_file (optional. path to a certificate authority cert)
       # * :encoding ('yaml' or 'json'. Default 'yaml')
       # Other connection options are underlying messaging system specific.
       #

data/lib/manageiq/messaging/kafka/client.rb

@@ -8,13 +8,11 @@ module ManageIQ
       # Kafka specific connection options accepted by +open+ method:
       # * :client_ref (A reference string to identify the client)
       # * :hosts (Array of Kafka cluster hosts, or)
-      # * :host (Single host name)
-      # * :port (host port number)
       #
-      # For additional security options, please refer to 
+      # For additional security options, please refer to
       # https://github.com/edenhill/librdkafka/wiki/Using-SSL-with-librdkafka and
-      # https://github.com/edenhill/librdkafka/wiki/Using-SASL-with-librdkafka 
-      # 
+      # https://github.com/edenhill/librdkafka/wiki/Using-SASL-with-librdkafka
+      #
       #
       # Kafka specific +publish_message+ options:
       # * :group_name (Used as Kafka partition_key)
@@ -89,10 +87,14 @@ module ManageIQ
 
           result = {:"bootstrap.servers" => hosts.join(',')}
           result[:"client.id"] = options[:client_ref] if options[:client_ref]
-          result[:"sasl.username"] = options[:username] if options[:username]
-          result[:"sasl.password"] = options[:password] if options[:password]
 
-          result.merge(options.except(:port, :host, :hosts, :encoding, :protocol, :client_ref, :username, :password))
+          result[:"sasl.mechanism"]    = "PLAIN"
+          result[:"sasl.username"]     = options[:username] if options[:username]
+          result[:"sasl.password"]     = options[:password] if options[:password]
+          result[:"ssl.ca.location"]   = options[:ca_file] if options[:ca_file]
+          result[:"security.protocol"] = !!options[:ssl] ? "SASL_SSL" : "PLAINTEXT"
+
+          result.merge(options.except(:port, :host, :hosts, :encoding, :protocol, :client_ref, :username, :password, :ssl, :ca_file))
         end
       end
     end

data/lib/manageiq/messaging/kafka/common.rb

@@ -23,7 +23,7 @@ module ManageIQ
 
         def raw_publish(body, options)
           options[:payload] = encode_body(options[:headers], body)
-          producer.produce(options)
+          producer.produce(**options)
         end
 
         def queue_for_publish(options)
@@ -94,6 +94,22 @@ module ManageIQ
           end
         end
 
+        def wait_for_topic(wait = true)
+          retry_count     = 0
+          maximum_backoff = 300
+
+          begin
+            yield
+          rescue Rdkafka::RdkafkaError => err
+            raise if err.code != :unknown_topic_or_part || !wait
+
+            retry_count += 1
+            sleep([1.5 * retry_count, maximum_backoff].min)
+
+            retry
+          end
+        end
+
         def message_header_keys
           [:sender, :message_type, :class_name]
         end

data/lib/manageiq/messaging/kafka/queue.rb

@@ -17,13 +17,18 @@ module ManageIQ
         end
 
         def subscribe_messages_impl(options, &block)
+          wait = options.delete(:wait_for_topic)
+          wait = true if wait.nil?
+
           topic = address(options)
           options[:persist_ref] = GROUP_FOR_QUEUE_MESSAGES + topic
 
-          queue_consumer = consumer(true, options)
-          queue_consumer.subscribe(topic)
-          queue_consumer.each do |message|
-            process_queue_message(queue_consumer, topic, message, &block)
+          wait_for_topic(wait) do
+            queue_consumer = consumer(true, options)
+            queue_consumer.subscribe(topic)
+            queue_consumer.each do |message|
+              process_queue_message(queue_consumer, topic, message, &block)
+            end
           end
         end
       end

data/lib/manageiq/messaging/kafka/topic.rb

@@ -14,13 +14,19 @@ module ManageIQ
         end
 
         def subscribe_topic_impl(options, &block)
+          wait = options.delete(:wait_for_topic)
+          wait = true if wait.nil?
+
           topic = address(options)
 
           options[:persist_ref] = "#{GROUP_FOR_ADHOC_LISTENERS}_#{Time.now.to_i}" unless options[:persist_ref]
-          topic_consumer = consumer(false, options)
-          topic_consumer.subscribe(topic)
-          topic_consumer.each do |message|
-            process_topic_message(topic_consumer, topic, message, &block)
+
+          wait_for_topic(wait) do
+            topic_consumer = consumer(false, options)
+            topic_consumer.subscribe(topic)
+            topic_consumer.each do |message|
+              process_topic_message(topic_consumer, topic, message, &block)
+            end
           end
         end
       end

data/lib/manageiq/messaging/stomp/client.rb

@@ -61,7 +61,7 @@ module ManageIQ
         attr_reader :stomp_client
 
         def initialize(options)
-          host = options.slice(:host, :port)
+          host = options.slice(:host, :port, :ssl)
           host[:passcode] = options[:password] if options[:password]
           host[:login] = options[:username] if options[:username]
 

data/lib/manageiq/messaging/version.rb

@@ -1,5 +1,5 @@
 module ManageIQ
   module Messaging
-    VERSION = "1.1.1"
+    VERSION = "1.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: manageiq-messaging
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - ManageIQ Authors
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-05-05 00:00:00.000000000 Z
+date: 2022-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -197,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.5
+rubygems_version: 3.3.15
 signing_key:
 specification_version: 4
 summary: Client library for ManageIQ components to exchange messages through its internal