sidekiq-heroku-scaler 0.3.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66b803338f9b37da0c0d1d34ba5a8ed1956fc26b145364870749f5946888bca0
-  data.tar.gz: a31471faa9c1fd25fcd67633dbca9fbb91dde764e726a9e894d15dc0cf314465
+  metadata.gz: 6073af100f49fa9fab13998d784522a9f29012da96c72837fb0fb4f9f66e8c8c
+  data.tar.gz: fbe8bb6c5e2d34c01e2984eadec3ec35c99f4f3292e8a553a41c8b3fba8e8fd9
 SHA512:
-  metadata.gz: 8464385f63357cb61ff63c6b3c62298b5c7668b745cc8461735ccaa0dcdaf3e2afba7624845cc22dabb18c2801d3f6ba187d45787423fa01eb6b4657e219a1de
-  data.tar.gz: 1657cc427f1b20cb0b1bb5d1ace58da4c2a12a622821000d5141375fffc7b6fb40cf6a097887f0cec0bc744de45a5edff6ccbcb3d966ec69d6deec4233d78941
+  metadata.gz: ba8a451c48eb108b933ee1efa44d273338032d904aa5f2e578257539ecc2820c67277d54ff74ea9ee57712bf4d0e377761bb62b873f09806475b97c8979ae71a
+  data.tar.gz: 680fba960076c21a633ace3a088a29045e616c1b96ff24619ceb02747885f7b30cf290bf46909787ad1ae30937de35d62edfcc6ae20e0fd2fd44c54ad49d504f

data/.rubocop.yml

@@ -1,9 +1,23 @@
+require:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+  - rubocop-factory_bot
 AllCops:
   NewCops: enable
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.0
   Exclude:
     - 'bin/*'
-Documentation:
-  Enabled: false
-Metrics/LineLength:
+Layout/LineLength:
   Max: 120
+Style/Documentation:
+  Enabled: false
+Style/OpenStructUse:
+  Enabled: false
+Naming/FileName:
+  Exclude:
+    - 'lib/sidekiq-heroku-scaler.rb'
+RSpec/NamedSubject:
+  Enabled: false
+RSpec/NestedGroups:
+  Max: 8

data/Gemfile

@@ -5,3 +5,14 @@ source 'https://rubygems.org'
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 gemspec
+
+gem 'bundler'
+
+gem 'rake'
+
+gem 'rspec'
+
+gem 'rubocop'
+gem 'rubocop-performance'
+gem 'rubocop-rake'
+gem 'rubocop-rspec'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sidekiq-heroku-scaler (0.3.5)
+    sidekiq-heroku-scaler (0.4.0)
       activesupport (> 5, < 8)
       platform-api (> 3, < 4)
       sidekiq (> 4, < 7)
@@ -9,77 +9,96 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4)
+    activesupport (7.0.7.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
     ast (2.4.2)
-    concurrent-ruby (1.1.10)
-    connection_pool (2.3.0)
+    base64 (0.1.1)
+    concurrent-ruby (1.2.2)
+    connection_pool (2.4.1)
     diff-lcs (1.5.0)
     erubis (2.7.0)
-    excon (0.92.5)
+    excon (0.102.0)
     heroics (0.1.2)
       erubis (~> 2.0)
       excon
       moneta
       multi_json (>= 1.9.2)
       webrick
-    i18n (1.12.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    json (2.6.2)
-    minitest (5.16.3)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    minitest (5.19.0)
     moneta (1.0.0)
     multi_json (1.15.0)
-    parallel (1.22.1)
-    parser (3.1.2.1)
+    parallel (1.23.0)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
+      racc
     platform-api (3.5.0)
       heroics (~> 0.1.1)
       moneta (~> 1.0.0)
       rate_throttle_client (~> 0.1.0)
-    rack (2.2.4)
+    racc (1.7.1)
+    rack (2.2.8)
     rainbow (3.1.1)
     rake (13.0.6)
     rate_throttle_client (0.1.2)
-    redis (4.8.0)
-    regexp_parser (2.5.0)
-    rexml (3.2.5)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.1)
+    redis (4.8.1)
+    regexp_parser (2.8.1)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.1)
-    rubocop (1.36.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.56.1)
+      base64 (~> 0.1.1)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.1.2.1)
+      parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.20.1, < 2.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.21.0)
-      parser (>= 3.1.1.0)
-    ruby-progressbar (1.11.0)
-    sidekiq (6.5.7)
-      connection_pool (>= 2.2.5)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.29.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.23.1)
+      rubocop (~> 1.33)
+    rubocop-performance (1.19.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.23.2)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    sidekiq (6.5.9)
+      connection_pool (>= 2.2.5, < 3)
       rack (~> 2.0)
       redis (>= 4.5.0, < 5)
-    tzinfo (2.0.5)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.3.0)
-    webrick (1.7.0)
+    unicode-display_width (2.4.2)
+    webrick (1.8.1)
 
 PLATFORMS
   ruby
@@ -89,7 +108,10 @@ DEPENDENCIES
   rake
   rspec
   rubocop
+  rubocop-performance
+  rubocop-rake
+  rubocop-rspec
   sidekiq-heroku-scaler!
 
 BUNDLED WITH
-   2.2.32
+   2.4.10

data/README.md

@@ -30,7 +30,8 @@ scale_strategy = SidekiqHerokuScaler::Strategy::Latency.new(
   max_latency: 5.minutes.to_i,
   min_latency: 1.minute.to_i,
   inc_count: 2, # default 1
-  dec_count: 2 # default 1
+  dec_count: 2, # default 1
+  smart_decrease: true # default false
 )
 ```
 or

data/lib/sidekiq-heroku-scaler/heroku/client.rb

@@ -22,7 +22,7 @@ module SidekiqHerokuScaler
       end
 
       def sidekiq_workers
-        @sidekiq_workers ||= formations.select { |formation| formation['command'].match(/sidekiq/) }
+        @sidekiq_workers ||= formations.select { |formation| formation['command'].include?('sidekiq') }
                                        .map { |formation| formation['type'] }
       end
 

data/lib/sidekiq-heroku-scaler/manager.rb

@@ -12,13 +12,19 @@ module SidekiqHerokuScaler
     end
 
     def perform
-      autoscalable_workers.each(&method(:autoscale_one))
+      autoscalable_workers.each do |worker_name|
+        autoscale_one(worker_name)
+      end
     end
 
     private
 
     attr_reader :heroku_client, :strategy, :workers
 
+    def autoscalable_workers
+      heroku_client.sidekiq_workers & workers
+    end
+
     def autoscale_one(worker_name)
       formation = heroku_client.formation_for(worker_name)
       return if formation.blank?
@@ -28,18 +34,33 @@ module SidekiqHerokuScaler
       process_formation(sidekiq_worker)
     end
 
+    def decrease_delta_for(sidekiq_worker, delta)
+      return delta unless strategy.smart_decrease
+
+      processes = sidekiq_worker.processes.reverse.take_while do |process|
+        process['busy'].zero? && process['quiet'] == 'false'
+      end
+
+      processes.size < delta.abs ? -processes.size : delta
+    end
+
     def process_formation(sidekiq_worker)
       if strategy.increase?(sidekiq_worker)
-        heroku_client.update_formation(sidekiq_worker.formation_id,
-                                       strategy.safe_quantity(sidekiq_worker.quantity + strategy.inc_count))
+        update_formation(sidekiq_worker, strategy.inc_count)
       elsif strategy.decrease?(sidekiq_worker)
-        heroku_client.update_formation(sidekiq_worker.formation_id,
-                                       strategy.safe_quantity(sidekiq_worker.quantity - strategy.dec_count))
+        stop_sidekiq_workers(sidekiq_worker, -strategy.dec_count)
       end
     end
 
-    def autoscalable_workers
-      heroku_client.sidekiq_workers & workers
+    def stop_sidekiq_workers(sidekiq_worker, delta)
+      delta = decrease_delta_for(sidekiq_worker, delta)
+
+      update_formation(sidekiq_worker, delta)
+    end
+
+    def update_formation(sidekiq_worker, delta)
+      heroku_client.update_formation(sidekiq_worker.formation_id,
+                                     strategy.safe_quantity(sidekiq_worker.quantity + delta))
     end
   end
 end

data/lib/sidekiq-heroku-scaler/sidekiq_config.rb

@@ -27,7 +27,7 @@ module SidekiqHerokuScaler
       end
     end
 
-    def option_parser(opts)
+    def option_parser(opts) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       OptionParser.new do |o|
         o.on '-c', '--concurrency INT', 'processor threads to use' do |arg|
           opts[:concurrency] = Integer(arg)
@@ -52,7 +52,7 @@ module SidekiqHerokuScaler
       end
     end
 
-    def parse_config(path)
+    def parse_config(path) # rubocop:disable Metrics/MethodLength
       erb = ERB.new(File.read(path))
       erb.filename = File.expand_path(path)
       opts = load_yaml(erb.result) || {}
@@ -90,7 +90,7 @@ module SidekiqHerokuScaler
       opts
     end
 
-    def setup_options(args)
+    def setup_options(args) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
       # parse CLI options
       opts = parse_options(args)
 

data/lib/sidekiq-heroku-scaler/strategy/latency.rb

@@ -3,24 +3,27 @@
 module SidekiqHerokuScaler
   module Strategy
     class Latency
-      attr_reader :inc_count, :dec_count
+      attr_reader :inc_count, :dec_count, :smart_decrease
 
+      # rubocop:disable Metrics/ParameterLists
       def initialize(min_dynos_count:, max_dynos_count:,
                      max_latency:, min_latency:,
-                     inc_count: nil, dec_count: nil)
+                     inc_count: nil, dec_count: nil,
+                     smart_decrease: false)
         @min_dynos_count = min_dynos_count
         @max_dynos_count = max_dynos_count
         @max_latency = max_latency
         @min_latency = min_latency
         @inc_count = (inc_count || 1).to_i
         @dec_count = (dec_count || 1).to_i
+        @smart_decrease = smart_decrease
       end
+      # rubocop:enable Metrics/ParameterLists
 
       def increase?(sidekiq_worker)
         sidekiq_worker.quantity < max_dynos_count &&
           (sidekiq_worker.latency > max_latency ||
-            (sidekiq_worker.quantity.zero? && sidekiq_worker.latency.positive?)) &&
-          sidekiq_worker.queues_size > sidekiq_worker.quantity * sidekiq_worker.concurrency
+            (sidekiq_worker.quantity.zero? && sidekiq_worker.latency.positive?))
       end
 
       def decrease?(sidekiq_worker)
@@ -33,7 +36,7 @@ module SidekiqHerokuScaler
       def safe_quantity(quantity)
         return min_dynos_count if quantity < min_dynos_count
 
-        quantity > max_dynos_count ? max_dynos_count : quantity
+        [quantity, max_dynos_count].min
       end
 
       private

data/lib/sidekiq-heroku-scaler/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SidekiqHerokuScaler
-  VERSION = '0.3.5'
+  VERSION = '0.4.0'
 end

data/lib/sidekiq-heroku-scaler/worker.rb

@@ -5,6 +5,8 @@ require 'sidekiq-heroku-scaler/sidekiq_config'
 
 module SidekiqHerokuScaler
   class Worker
+    attr_reader :worker_name
+
     def initialize(worker_name, formation)
       @worker_name = worker_name
       @formation = formation
@@ -34,9 +36,13 @@ module SidekiqHerokuScaler
       queues.sum { |queue| Sidekiq::Queue.new(queue).size }
     end
 
+    def processes
+      @processes ||= Sidekiq::ProcessSet.new.select { |process| process.identity.match?(/\A#{worker_name}\./) }
+    end
+
     private
 
-    attr_reader :formation, :worker_name
+    attr_reader :formation
 
     def build_process
       command = formation.command.gsub(/.*sidekiq(\s|\z)/, '').split
@@ -48,12 +54,8 @@ module SidekiqHerokuScaler
       process['queues'] || []
     end
 
-    def process_set
-      @process_set ||= Sidekiq::ProcessSet.new
-    end
-
     def process
-      @process ||= process_set.detect { |p| p.identity.match(/\A#{worker_name}\./) } || build_process
+      @process ||= processes.first || build_process
     end
   end
 end

data/sidekiq-heroku-scaler.gemspec

@@ -22,10 +22,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'rubocop'
+  spec.required_ruby_version = '>= 3.0.0'
 
   spec.add_dependency 'activesupport', '> 5', '< 8'
   spec.add_dependency 'platform-api', '> 3', '< 4'

metadata

@@ -1,71 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-heroku-scaler
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.0
 platform: ruby
 authors:
 - Vital Ryabchinskiy
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-22 00:00:00.000000000 Z
+date: 2023-08-28 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -166,14 +110,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Sidekiq Heroku Scaler