shoryuken 5.2.3 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f2f8c9e8573b699391a74a70d26756e106ccf72b3df9a6fccc32b72d13ec0cd
-  data.tar.gz: 6a009d5a5e571da339d52a08f4ccda19f144ce06132f4a65e95fabc39aeffad4
+  metadata.gz: 9f4f8cbfdd04c4d39b7f672c549b0d112f64c99a8df4807b83083b57dab8addd
+  data.tar.gz: 0cfeaef14f59567382eefacb342be547a43f7dc7a118a3f824a6bdc88710ceea
 SHA512:
-  metadata.gz: e359eee09d82a917c4e13541a121c61f78587421a7e5977052552a4f18512eeb9a2eb720ebc8adf323d0a33fd979b37e9c059a95b5b180eda93cab5a3e034f6b
-  data.tar.gz: 5217287d2b7f66125852ac0b824353d934a2a8568e2dc07ca3c98f8991cad1a0dafbda87967a407bc5efaea62b1cafa85708e1ea17ccb659b2743878d079a267
+  metadata.gz: 0ee996f0a835c46c50adaef43f413374505df454e8e696c5a1faaefdd9c28a4ed7922f620b56f800a3aad152881c66dd812bad573fec91f9d2ed9bd168c468f8
+  data.tar.gz: 9208b28922188d06f60ade86d0c53d56c6bedbc8577e908d5aa4a819c23cc13889fdea5dcb8875608495f2bb785f3b198bddbdb4fd93f3d6f7fa53d2f9cfec3f

data/.gitignore

@@ -25,4 +25,4 @@ shoryuken.yml
 *.log
 .env
 rubocop.html
-.byebug_history
+.byebug_history

data/.rubocop.yml

@@ -23,7 +23,7 @@ Metrics/AbcSize:
   # because codeclimate already give that for us with more details
   Enabled: false
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 125
 
 Style/Alias:

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## [v5.3.0] - 2021-10-31
+
+- (Refactor) Use Forwardable within Message to avoid method boilerplate
+  - [#681](https://github.com/ruby-shoryuken/shoryuken/pull/681)
+
+- Add basic health check API
+  - [#679](https://github.com/ruby-shoryuken/shoryuken/pull/679)
+
 ## [v5.2.3] - 2021-07-29
 
 - Fire new `:utilization_update` event any time a worker pool's utilization changes

data/Gemfile

@@ -16,5 +16,5 @@ end
 group :development do
   gem 'appraisal', git: 'https://github.com/thoughtbot/appraisal.git'
   gem 'pry-byebug', '3.9.0'
-  gem 'rubocop'
+  gem 'rubocop', '<= 1.12'
 end

data/lib/shoryuken/launcher.rb

@@ -32,6 +32,13 @@ module Shoryuken
       executor.wait_for_termination
     end
 
+    def healthy?
+      Shoryuken.groups.keys.all? do |group|
+        manager = @managers.find { |m| m.group == group }
+        manager && manager.running?
+      end
+    end
+
     private
 
     def executor

data/lib/shoryuken/manager.rb

@@ -6,6 +6,8 @@ module Shoryuken
     # See https://github.com/phstc/shoryuken/issues/348#issuecomment-292847028
     MIN_DISPATCH_INTERVAL = 0.1
 
+    attr_reader :group
+
     def initialize(group, fetcher, polling_strategy, concurrency, executor)
       @group            = group
       @fetcher          = fetcher
@@ -21,12 +23,12 @@ module Shoryuken
       dispatch_loop
     end
 
-    private
-
     def running?
       @running.true? && @executor.running?
     end
 
+    private
+
     def dispatch_loop
       return unless running?
 

data/lib/shoryuken/message.rb

@@ -1,5 +1,16 @@
 module Shoryuken
   class Message
+    extend Forwardable
+
+    def_delegators(:data,
+                   :message_id,
+                   :receipt_handle,
+                   :md5_of_body,
+                   :body,
+                   :attributes,
+                   :md5_of_message_attributes,
+                   :message_attributes)
+
     attr_accessor :client, :queue_url, :queue_name, :data
 
     def initialize(client, queue, data)
@@ -29,33 +40,5 @@ module Shoryuken
         visibility_timeout: timeout
       )
     end
-
-    def message_id
-      data.message_id
-    end
-
-    def receipt_handle
-      data.receipt_handle
-    end
-
-    def md5_of_body
-      data.md5_of_body
-    end
-
-    def body
-      data.body
-    end
-
-    def attributes
-      data.attributes
-    end
-
-    def md5_of_message_attributes
-      data.md5_of_message_attributes
-    end
-
-    def message_attributes
-      data.message_attributes
-    end
   end
 end

data/lib/shoryuken/runner.rb

@@ -55,6 +55,10 @@ module Shoryuken
       end
     end
 
+    def healthy?
+      (@launcher && @launcher.healthy?) || false
+    end
+
     private
 
     def initialize_concurrent_logger

data/lib/shoryuken/version.rb

@@ -1,3 +1,3 @@
 module Shoryuken
-  VERSION = '5.2.3'.freeze
+  VERSION = '5.3.0'.freeze
 end

data/lib/shoryuken.rb

@@ -45,6 +45,10 @@ module Shoryuken
     @_shoryuken_options ||= Shoryuken::Options.new
   end
 
+  def self.healthy?
+    Shoryuken::Runner.instance.healthy?
+  end
+
   def_delegators(
     :shoryuken_options,
     :active_job?,

data/spec/shoryuken/launcher_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+require 'shoryuken/launcher'
+
+RSpec.describe Shoryuken::Launcher do
+  let(:executor) do
+    # We can't use Concurrent.global_io_executor in these tests since once you
+    # shut down a thread pool, you can't start it back up. Instead, we create
+    # one new thread pool executor for each spec. We use a new
+    # CachedThreadPool, since that most closely resembles
+    # Concurrent.global_io_executor
+    Concurrent::CachedThreadPool.new auto_terminate: true
+  end
+
+  let(:first_group_manager) { double(:first_group_manager, group: 'first_group') }
+  let(:second_group_manager) { double(:second_group_manager, group: 'second_group') }
+  let(:first_queue) { "launcher_spec_#{SecureRandom.uuid}" }
+  let(:second_queue) { "launcher_spec_#{SecureRandom.uuid}" }
+
+  before do
+    Shoryuken.add_group('first_group', 1)
+    Shoryuken.add_group('second_group', 1)
+    Shoryuken.add_queue(first_queue, 1, 'first_group')
+    Shoryuken.add_queue(second_queue, 1, 'second_group')
+    allow(Shoryuken).to receive(:launcher_executor).and_return(executor)
+    allow(Shoryuken::Manager).to receive(:new).with('first_group', any_args).and_return(first_group_manager)
+    allow(Shoryuken::Manager).to receive(:new).with('second_group', any_args).and_return(second_group_manager)
+    allow(first_group_manager).to receive(:running?).and_return(true)
+    allow(second_group_manager).to receive(:running?).and_return(true)
+  end
+
+  describe '#healthy?' do
+    context 'when all groups have managers' do
+      context 'when all managers are running' do
+        it 'returns true' do
+          expect(subject.healthy?).to be true
+        end
+      end
+
+      context 'when one manager is not running' do
+        before do
+          allow(second_group_manager).to receive(:running?).and_return(false)
+        end
+
+        it 'returns false' do
+          expect(subject.healthy?).to be false
+        end
+      end
+    end
+
+    context 'when all groups do not have managers' do
+      before do
+        allow(second_group_manager).to receive(:group).and_return('some_random_group')
+      end
+
+      it 'returns false' do
+        expect(subject.healthy?).to be false
+      end
+    end
+  end
+end

data/spec/shoryuken/manager_spec.rb

@@ -173,4 +173,26 @@ RSpec.describe Shoryuken::Manager do
       end
     end
   end
+
+  describe '#running?' do
+    context 'when the executor is running' do
+      before do
+        allow(executor).to receive(:running?).and_return(true)
+      end
+
+      it 'returns true' do
+        expect(subject.running?).to be true
+      end
+    end
+
+    context 'when the executor is not running' do
+      before do
+        allow(executor).to receive(:running?).and_return(false)
+      end
+
+      it 'returns false' do
+        expect(subject.running?).to be false
+      end
+    end
+  end
 end

data/spec/shoryuken_spec.rb

@@ -1,4 +1,13 @@
 require 'spec_helper'
 
 RSpec.describe Shoryuken do
+  describe '.healthy?' do
+    before do
+      allow(Shoryuken::Runner).to receive(:instance).and_return(double(:instance, healthy?: :some_result))
+    end
+
+    it 'delegates to the runner instance' do
+      expect(described_class.healthy?).to eq(:some_result)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shoryuken
 version: !ruby/object:Gem::Version
-  version: 5.2.3
+  version: 5.3.0
 platform: ruby
 authors:
 - Pablo Cantero
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-30 00:00:00.000000000 Z
+date: 2021-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -174,6 +174,7 @@ files:
 - spec/shoryuken/extensions/active_job_concurrent_send_adapter_spec.rb
 - spec/shoryuken/extensions/active_job_wrapper_spec.rb
 - spec/shoryuken/fetcher_spec.rb
+- spec/shoryuken/launcher_spec.rb
 - spec/shoryuken/manager_spec.rb
 - spec/shoryuken/middleware/chain_spec.rb
 - spec/shoryuken/middleware/server/auto_delete_spec.rb
@@ -231,6 +232,7 @@ test_files:
 - spec/shoryuken/extensions/active_job_concurrent_send_adapter_spec.rb
 - spec/shoryuken/extensions/active_job_wrapper_spec.rb
 - spec/shoryuken/fetcher_spec.rb
+- spec/shoryuken/launcher_spec.rb
 - spec/shoryuken/manager_spec.rb
 - spec/shoryuken/middleware/chain_spec.rb
 - spec/shoryuken/middleware/server/auto_delete_spec.rb