receptor_controller-client 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7e0fca40eecf936d8ef48f10f5ff0a9c0a8f285496d504a4942b85f5ad43b679
-  data.tar.gz: c48de26017a7f7b2193d13603abe1ebfafaf55974efd1e1cc5700e89b3097394
+  metadata.gz: f99fb38eec5c760bd12813db5026e87e6a344965ecc95e64c73599a14fd369de
+  data.tar.gz: a494ce84703f398a2716b7bde039b4d5cffe7a0390128ebdc660c2953998bbbd
 SHA512:
-  metadata.gz: 9cabdb3d3176a0d6591a4b4fb06422481cf51f248edf669db455fc9f1ab9a98c19887d2b3b4780568be92058477d424164c158f49bc5ec9afbe1630becd273d6
-  data.tar.gz: fbe4d361bb3dfff586d6e6da8391623a5a92fcdc224a15c6c3ace6379105748562b6bc87f360d84556170b271298b3661985b88bddd3b8d8fe9ab60e0e8f4e6c
+  metadata.gz: 26d9b2d4728bbb03b84903d9642937123a3a6226e1c7765d97cc3b0cdc618e75b92d3c35e1642b6d91fa95b74e8459f93cac4e96496e8e275cdb7cefe7a01511
+  data.tar.gz: 9761de4851573e324966bde349ff0da97072cf220c81f57d8586c09616c5618f085e30f987489763bfa443013130542930c01a73c4cfaf18a9a538c7ef34c8bb

data/CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.5] - 2020-08-11
+### Added
+- Unique Persist-ref for every response worker #18
+
 ## [0.0.4] - 2020-08-04
 ### Added
 - Default Kafka ACK to true
@@ -20,7 +24,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Added extra logging for messages
 
-[Unreleased]: https://github.com/RedHatInsights/receptor_controller-client-ruby/compare/v0.0.4...HEAD
+[Unreleased]: https://github.com/RedHatInsights/receptor_controller-client-ruby/compare/v0.0.5...HEAD
+[0.0.5]: https://github.com/RedHatInsights/receptor_controller-client-ruby/releases/tag/v0.0.5
 [0.0.4]: https://github.com/RedHatInsights/receptor_controller-client-ruby/releases/tag/v0.0.4
 [0.0.3]: https://github.com/RedHatInsights/receptor_controller-client-ruby/releases/tag/v0.0.3
 [0.0.2]: https://github.com/RedHatInsights/receptor_controller-client-ruby/releases/tag/v0.0.2

data/lib/receptor_controller/client/configuration.rb

@@ -42,7 +42,7 @@ module ReceptorController
       @queue_auto_ack    = true
       @queue_host        = nil
       @queue_max_bytes   = nil
-      @queue_persist_ref = nil
+      @queue_persist_ref = "receptor-client.#{SecureRandom.uuid}"
       @queue_port        = nil
       @queue_topic       = 'platform.receptor-controller.responses'
 

data/lib/receptor_controller/client/directive_blocking.rb

@@ -20,7 +20,7 @@ module ReceptorController
 
       msg_id = JSON.parse(response.body)['id']
 
-      logger.debug("Receptor response: registering message #{msg_id}".tap { |msg| msg << " req: #{body[:payload]}" if ENV["LOG_ALL_RECEPTOR_MESSAGES"]&.to_i != 0 })
+      logger.debug("Receptor response [#{ReceptorController::Client::Configuration.default.queue_persist_ref}]: registering message #{msg_id}, href_slug: #{body[:payload]["href_slug"]}")
       # registers message id for kafka responses
       response_worker.register_message(msg_id, self)
       wait_for_response(msg_id)

data/lib/receptor_controller/client/directive_non_blocking.rb

@@ -48,6 +48,7 @@ module ReceptorController
 
         # registers message id for kafka responses
         response_worker.register_message(msg_id, self)
+        logger.debug("Receptor response [#{ReceptorController::Client::Configuration.default.queue_persist_ref}]: registering message #{msg_id}, href_slug: #{body[:payload]["href_slug"]}")
 
         msg_id
       else

data/lib/receptor_controller/client/response_worker.rb

@@ -89,7 +89,7 @@ module ReceptorController
         process_message(message)
       end
     rescue => err
-      logger.error("Exception in kafka listener: #{err}\n#{err.backtrace.join("\n")}")
+      logger.error(response_log("Exception in kafka listener: #{err}\n#{err.backtrace.join("\n")}"))
     ensure
       client&.close
     end
@@ -98,7 +98,7 @@ module ReceptorController
       response = JSON.parse(message.payload)
 
       if (message_id = response['in_response_to'])
-        logger.debug("Receptor response for message #{message_id}: serial: #{response["serial"]}, type: #{response['message_type']}, payload: #{response['payload'] || "n/a"}")
+        logger.debug(response_log("Received message #{message_id}: serial: #{response["serial"]}, type: #{response['message_type']}, payload: #{response['payload'] || "n/a"}"))
         if (callbacks = registered_messages[message_id]).present?
           # Reset last_checked_at to avoid timeout in multi-response messages
           reset_last_checked_at(callbacks)
@@ -121,6 +121,7 @@ module ReceptorController
               callbacks[:receiver].send(callbacks[:response_callback], message_id, message_type, payload)
             else
               # Send the callback to release the thread.
+              logger.warn(response_log("Unexpected type | message #{message_id}, type: #{message_type}"))
               callbacks[:receiver].send(callbacks[:response_callback], message_id, message_type, payload)
             end
 
@@ -128,31 +129,31 @@ module ReceptorController
             if callbacks[:received_msgs] == callbacks[:total_msgs]
               registered_messages.delete(message_id)
               callbacks[:receiver].send(callbacks[:response_callback], message_id, EOF, payload)
-              logger.debug("Receptor Message #{message_id} complete, total bytes: #{callbacks[:msg_size]}")
+              logger.debug(response_log("Message #{message_id} complete, total bytes: #{callbacks[:msg_size]}"))
             end
 
-            logger.debug("Receptor response: OK | message: #{message_id}, serial: #{response["serial"]}, type: #{message_type}, payload: #{payload || "n/a"}")
+            logger.debug(response_log("OK | message: #{message_id}, serial: #{response["serial"]}, type: #{message_type}, payload: #{payload || "n/a"}"))
           else
             #
             # Response Error
             #
             registered_messages.delete(message_id)
 
-            logger.error("Receptor response: ERROR | message #{message_id} (#{response})")
+            logger.error(response_log("ERROR | message #{message_id} (#{response})"))
 
             callbacks[:receiver].send(callbacks[:error_callback], message_id, response['code'], response['payload'])
           end
         elsif ENV["LOG_ALL_RECEPTOR_MESSAGES"]&.to_i != 0
           # noop, it's not error if not registered, can be processed by another pod
-          logger.debug("Receptor response unhandled: #{message_id} (#{response['code']})")
+          logger.debug(response_log("NOT REGISTERED | #{message_id} (#{response['code']})"))
         end
       else
-        logger.error("Receptor response: Message id (in_response_to) not received! #{response}")
+        logger.error(response_log("MISSING | Message id (in_response_to) not received! #{response}"))
       end
     rescue JSON::ParserError => e
-      logger.error("Receptor response: Failed to parse Kafka response (#{e.message})\n#{message.payload}")
+      logger.error(response_log("Failed to parse Kafka response (#{e.message})\n#{message.payload}"))
     rescue => e
-      logger.error("Receptor response: #{e}\n#{e.backtrace.join("\n")}")
+      logger.error(response_log("#{e}\n#{e.backtrace.join("\n")}"))
     ensure
       message.ack unless config.queue_auto_ack
     end
@@ -213,12 +214,15 @@ module ReceptorController
     end
 
     # No persist_ref here, because all instances (pods) needs to receive kafka message
+    # TODO: temporary changed to unique persist_ref
     def queue_opts
-      opts               = {:service  => config.queue_topic,
-                            :auto_ack => config.queue_auto_ack}
-      opts[:max_bytes]   = config.queue_max_bytes if config.queue_max_bytes
-      opts[:persist_ref] = config.queue_persist_ref if config.queue_persist_ref
-      opts
+      return @queue_opts if @queue_opts
+
+      @queue_opts               = {:service  => config.queue_topic,
+                                   :auto_ack => config.queue_auto_ack}
+      @queue_opts[:max_bytes]   = config.queue_max_bytes if config.queue_max_bytes
+      @queue_opts[:persist_ref] = config.queue_persist_ref if config.queue_persist_ref
+      @queue_opts
     end
 
     def default_messaging_opts
@@ -229,5 +233,9 @@ module ReceptorController
         :client_ref => "receptor_client-responses-#{Time.now.to_i}", # A reference string to identify the client
       }
     end
+
+    def response_log(message)
+      "Receptor Response [#{queue_opts[:persist_ref]}]: #{message}"
+    end
   end
 end

data/lib/receptor_controller/client/version.rb

@@ -1,5 +1,5 @@
 module ReceptorController
   class Client
-    VERSION = "0.0.4".freeze
+    VERSION = "0.0.5".freeze
   end
 end

data/spec/receptor_controller/response_worker_spec.rb

@@ -9,7 +9,13 @@ RSpec.describe ReceptorController::Client::ResponseWorker do
 
   before do
     allow(logger).to receive_messages(%i[debug info warn error fatal])
-    allow(config).to receive_messages(:queue_auto_ack => false, :response_timeout => 0, :response_timeout_poll_time => 0)
+    allow(config).to receive_messages(:queue_auto_ack => false,
+                                      :queue_max_bytes => nil,
+                                      :queue_persist_ref => 'consumer-group-1',
+                                      :queue_topic => 'receptor.kafka.topic',
+                                      :response_timeout => 0,
+                                      :response_timeout_poll_time => 0,
+                                      )
   end
 
   describe "#register_message" do
@@ -87,7 +93,7 @@ RSpec.describe ReceptorController::Client::ResponseWorker do
         end
 
         it "logs error" do
-          expect(logger).to receive(:error).with(/Receptor response: Failed to parse Kafka response/)
+          expect(logger).to receive(:error).with(/Failed to parse Kafka response/)
 
           subject.send(:process_message, message)
         end
@@ -97,7 +103,7 @@ RSpec.describe ReceptorController::Client::ResponseWorker do
         let(:payload) { {'code' => 0, 'message_type' => 'response', 'payload' => response_body} }
 
         it "logs error" do
-          expect(logger).to receive(:error).with(/Receptor response: Message id \(in_response_to\) not received!/)
+          expect(logger).to receive(:error).with(/Message id \(in_response_to\) not received!/)
 
           subject.send(:process_message, message)
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: receptor_controller-client
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Martin Slemr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-04 00:00:00.000000000 Z
+date: 2020-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -261,8 +261,8 @@ signing_key:
 specification_version: 4
 summary: Client for communication with Platform Receptor Controller - Gem
 test_files:
-- spec/receptor_controller/directive_blocking_spec.rb
-- spec/receptor_controller/response_worker_spec.rb
 - spec/receptor_controller/client_spec.rb
+- spec/receptor_controller/response_worker_spec.rb
 - spec/receptor_controller/directive_non_blocking_spec.rb
+- spec/receptor_controller/directive_blocking_spec.rb
 - spec/spec_helper.rb