topological_inventory-providers-common 1.0.11 → 1.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2593d36aee528450e29282d903ddcc2d74c6593e9579c69ec2a510c9fcc15ab
-  data.tar.gz: 47b0675fcab7eaab9c2b3899837b597295a0e7c6c737f1ce39ca49c4a7968cc5
+  metadata.gz: b81c523169c3ca87e678e3e7d046b4daee863200cf4eadd695e9022d17a11e5a
+  data.tar.gz: 1fc2a47cedf6f8d3b41f0df728a5ac8ceceaea03b58d43ef67da90680861c0eb
 SHA512:
-  metadata.gz: 03f98f6334065f62a4462e30633c6a6d852552f49414be2293b4864d3971372ce66ab52d47e23b4a7ad2f8c0277d9d2352f38519e2621a80f6c9b2b011a7cdd4
-  data.tar.gz: b801478114b42cc897329a12eca067cc707306f488ed7e84eddf7eddd91c0098dbbdf5d6d3fcb116734b39cd08d25dcabdd6731b60057fc900ca2c39a5008bd8
+  metadata.gz: 9afb8ba326d632ba59245d93837f32bd8edbcb34b3d82e029c351f904bb75f196592eb4724116a48caf0b7df8fc7f4101f5b59bd0e23b65d6fca25ada3ac4cb6
+  data.tar.gz: '00924d04d1fc4623cd4e0f0a719c5471dbd39635820375b4957278db1c6e3ecbdf2b58c25758bca22e91e979511286708279922919f6303118401e58ac9cc5c4'

data/CHANGELOG.md

@@ -4,6 +4,9 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.12] - 2020-10-01
+Add Operations Async Worker class #55
+
 ## [1.0.11]
 Make Collector Poll Time a parameter so we can tweak the collection interval #51
 
@@ -56,7 +59,8 @@ manageiq-loggers to >= 0.4.2 #20
 ## [1.0.0] - 2020-03-19
 ### Initial release to rubygems.org
 
-[Unreleased]: https://github.com/RedHatInsights/topological_inventory-providers-common/compare/v1.0.11...HEAD
+[Unreleased]: https://github.com/RedHatInsights/topological_inventory-providers-common/compare/v1.0.12...HEAD
+[1.0.12]: https://github.com/RedHatInsights/topological_inventory-providers-common/compare/v1.0.11...v1.0.12
 [1.0.11]: https://github.com/RedHatInsights/topological_inventory-providers-common/compare/v1.0.10...v1.0.11
 [1.0.10]: https://github.com/RedHatInsights/topological_inventory-providers-common/compare/v1.0.9...v1.0.10
 [1.0.9]: https://github.com/RedHatInsights/topological_inventory-providers-common/compare/v1.0.8...v1.0.9

data/lib/topological_inventory/providers/common/operations/async_worker.rb

@@ -0,0 +1,56 @@
+require "topological_inventory/providers/common/logging"
+require "topological_inventory/providers/common/operations/health_check"
+
+module TopologicalInventory
+  module Providers
+    module Common
+      module Operations
+        class AsyncWorker
+          include Logging
+
+          def initialize(processor, queue = nil)
+            @processor = processor
+            @queue = queue || Queue.new
+          end
+
+          def start
+            return if thread.present?
+
+            @thread = Thread.new { listen }
+          end
+
+          def stop
+            thread&.exit
+          end
+
+          def enqueue(msg)
+            queue << msg
+          end
+
+          def listen
+            loop do
+              # the queue thread waits for a message to come during `Queue#pop`
+              msg = queue.pop
+              process_message(msg)
+            end
+          end
+
+          private
+
+          attr_reader :thread, :queue, :processor
+
+          def process_message(msg)
+            processor.process!(msg)
+          rescue => err
+            model, method = msg.message.to_s.split(".")
+            logger.error("#{model}##{method}: async worker failure: #{err.cause}\n#{err}\n#{err.backtrace.join("\n")}")
+          ensure
+            msg.ack
+            TopologicalInventory::Providers::Common::Operations::HealthCheck.touch_file
+            logger.debug("Operations::AsyncWorker queue length: #{queue.length}") if queue.length >= 20 && queue.length % 5 == 0
+          end
+        end
+      end
+    end
+  end
+end

data/lib/topological_inventory/providers/common/version.rb

@@ -1,7 +1,7 @@
 module TopologicalInventory
   module Providers
     module Common
-      VERSION = "1.0.11"
+      VERSION = "1.0.12"
     end
   end
 end

data/spec/topological_inventory/providers/common/operations/async_worker_spec.rb

@@ -0,0 +1,36 @@
+require "topological_inventory/providers/common/operations/async_worker"
+
+describe TopologicalInventory::Providers::Common::Operations::AsyncWorker do
+  let(:queue) { double }
+  let(:impl) { double }
+  let(:msg) { double }
+  subject { described_class.new(impl, queue) }
+
+  before do
+    allow(queue).to receive(:length).and_return(0)
+    allow(msg).to receive(:message).and_return("Source.availability_check")
+  end
+
+  context "when the message is able to be processed" do
+    before do
+      allow(impl).to receive(:process!).with(msg)
+      allow(msg).to receive(:ack)
+    end
+
+    it "drains messages that are added to the queue" do
+      expect(impl).to receive(:process!).with(msg).once
+      subject.send(:process_message, msg)
+    end
+  end
+
+  context "when the message results in an error" do
+    before do
+      allow(impl).to receive(:process!).with(msg).and_raise(StandardError.new("boom!"))
+    end
+
+    it "ack's the message on failure" do
+      expect(msg).to receive(:ack).once
+      subject.send(:process_message, msg)
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: topological_inventory-providers-common
 version: !ruby/object:Gem::Version
-  version: 1.0.11
+  version: 1.0.12
 platform: ruby
 authors:
 - Martin Slemr
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-04 00:00:00.000000000 Z
+date: 2020-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -252,6 +252,7 @@ files:
 - lib/topological_inventory/providers/common/collector/parser.rb
 - lib/topological_inventory/providers/common/collectors_pool.rb
 - lib/topological_inventory/providers/common/logging.rb
+- lib/topological_inventory/providers/common/operations/async_worker.rb
 - lib/topological_inventory/providers/common/operations/endpoint_client.rb
 - lib/topological_inventory/providers/common/operations/health_check.rb
 - lib/topological_inventory/providers/common/operations/processor.rb
@@ -269,6 +270,7 @@ files:
 - spec/topological_inventory/providers/common/collectors/inventory_collection_wrapper_spec.rb
 - spec/topological_inventory/providers/common/collectors_pool_spec.rb
 - spec/topological_inventory/providers/common/logger_spec.rb
+- spec/topological_inventory/providers/common/operations/async_worker_spec.rb
 - spec/topological_inventory/providers/common/operations/processor_spec.rb
 - spec/topological_inventory/providers/common/operations/source_spec.rb
 - spec/topological_inventory/providers/common/save_inventory/saver_spec.rb