autoscaler 0.14.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec6a1b37ad89976bcf80edccfd67480c72aee6f0
-  data.tar.gz: c94e28fe7bcd92502be6dbee2cd9fd45b2ecbcb9
+  metadata.gz: 2178b48972a2f8602b145cd95959d98df9df800a
+  data.tar.gz: 6fa236be6c17027b4283866739df03f45f62d601
 SHA512:
-  metadata.gz: 6885e017918b53921cffb12aff92b59579ea1023d41f4f5bc5828d6f50dda383a92b5ca8c6320905b72b30bd37bced45c5c39b31d20bfc6647b4f6531fca5733
-  data.tar.gz: 7c3c78d2c162e50a4432e95ea907c39977a5b07fb44433d5d84bfc35dcb9ae75dcddadaff765d67b3b2d3e379046d950aaefd679516e1e04d6bd594655cab8c6
+  metadata.gz: 690808fd62d423dcc2f928f44b0d50f705af9208aac0e38919d380326c40d8e2ee845ef92f4b19b4ffb5e0568f3c934bd1ce5158e329316a78b23c4ae11c6e0f
+  data.tar.gz: a81d4fd5ab0ae14640cd7814c7d2188a9516515e75c6bf3f8496bf66134f97a6cc7a23d45b684c602321b8300daab1c2735752e21e8feeda08c8d08900811444

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## 1.0.0
+
+Potentially breaking changes
+
+- Implemented named arguments for several classes. (Breaking if you instantiated these classes with arguments)
+  - `HerokuPlatformScaler`
+  - `BinaryScalingStrategy`
+  - `LinearScalingStrategy`
+  - `DelayedShutdown`
+- As consequence of above, specifies min ruby version 2.1
+- Remove depreciated ENV variables `HEROKU_ACCESS_TOKEN` and `HERKOU_APP`
+- `HerokuScaler` has been removed, as the old API has been disabled by Heroku. (See <https://devcenter.heroku.com/changelog-items/1181>)
+  Consider to use `HerokuPlatformScaler`.
+
 ## 0.14.0
 
 - Heroku has claimed the `HEROKU_` ENV prefix for Herkou-16 stack. The preferred variables are now `AUTOSCALER_HEROKU_APP` and `AUTOSCALER_HEROKU_ACCESS_TOKEN`. (The complex example has been similarly updated.) The old ENV variables will still be accepted, with a warning, but may be removed in a major release. (HerokuScaler was not updated.)

data/README.md

@@ -38,7 +38,7 @@ Install the middleware in your `Sidekiq.configure_` blocks
 
 - HerokuPlatformScaler includes an attempt at current-worker cache that may be overcomplication, and doesn't work very well on the server
 - Multiple scale-down loops may be started, particularly if there are multiple jobs queued when the servers comes up.  Heroku seems to handle multiple scale-down commands well.
-- The scale-down monitor is triggered on job completion (and server middleware is only run around jobs), so if the server nevers processes any jobs, it won't turn off.
+- The scale-down monitor is triggered on job completion (and server middleware is only run around jobs), so if the server never processes any jobs, it won't turn off.
 - The retry and schedule lists are considered - if you schedule a long-running task, the process will not scale-down.
 - If background jobs trigger jobs in other scaled processes, please note you'll need `config.client_middleware` in your `Sidekiq.configure_server` block in order to scale-up.
 - Exceptions while calling the Heroku API are caught and printed by default.  See `HerokuPlatformScaler#exception_handler` to override

data/examples/complex.rb

@@ -12,9 +12,9 @@ if ENV['AUTOSCALER_HEROKU_APP']
     # We are using the convention that worker process type is the
     # same as the queue name
     heroku[queue] = Autoscaler::HerokuPlatformScaler.new(
-      queue,
-      ENV['AUTOSCALER_HEROKU_ACCESS_TOKEN'],
-      ENV['AUTOSCALER_HEROKU_APP'])
+      type: queue,
+      token: ENV['AUTOSCALER_HEROKU_ACCESS_TOKEN'],
+      app: ENV['AUTOSCALER_HEROKU_APP'])
   end
 end
 

data/lib/autoscaler/binary_scaling_strategy.rb

@@ -3,7 +3,7 @@ module Autoscaler
   # The default strategy has a single worker when there is anything, or shuts it down.
   class BinaryScalingStrategy
     #@param [integer] active_workers number of workers when in the active state.
-    def initialize(active_workers = 1)
+    def initialize(active_workers: 1)
       @active_workers = active_workers
     end
 

data/lib/autoscaler/delayed_shutdown.rb

@@ -3,7 +3,7 @@ module Autoscaler
   class DelayedShutdown
     # @param [ScalingStrategy] strategy object that makes most decisions
     # @param [Numeric] timeout number of seconds to stay up after base strategy says zero
-    def initialize(strategy, timeout)
+    def initialize(strategy:, timeout:)
       @strategy = strategy
       @timeout = timeout
       active_now!

data/lib/autoscaler/heroku_platform_scaler.rb

@@ -8,18 +8,9 @@ module Autoscaler
     # @param [String] token Heroku OAuth access token
     # @param [String] app Heroku app name
     def initialize(
-        type = 'worker',
-        token = ENV['AUTOSCALER_HEROKU_ACCESS_TOKEN'],
-        app = ENV['AUTOSCALER_HEROKU_APP'])
-
-      if (token.nil? && ENV['HEROKU_ACCESS_TOKEN'])
-        warn "Autoscaler: ENV AUTOSCALER_HEROKU_ACCESS_TOKEN is now preferred, HEROKU_ACCESS_TOKEN may be removed in a future release"
-        token = ENV['HEROKU_ACCESS_TOKEN']
-      end
-      if (app.nil? && ENV['HEROKU_APP'])
-        warn "Autoscaler: ENV AUTOSCALER_HEROKU_APP is now preferred, HEROKU_APP may be removed in a future release"
-        app = ENV['HEROKU_APP']
-      end
+        type: 'worker',
+        token: ENV['AUTOSCALER_HEROKU_ACCESS_TOKEN'],
+        app: ENV['AUTOSCALER_HEROKU_APP'])
 
       @client = PlatformAPI.connect_oauth(token)
       @type = type

data/lib/autoscaler/linear_scaling_strategy.rb

@@ -5,7 +5,7 @@ module Autoscaler
     #@param [integer] max_workers     maximum number of workers to spin up.
     #@param [integer] worker_capacity the amount of jobs one worker can handle
     #@param [float]   min_factor      minimum work required to scale, as percentage of worker_capacity
-    def initialize(max_workers = 1, worker_capacity = 25, min_factor = 0)
+    def initialize(max_workers: 1, worker_capacity: 25, min_factor: 0)
       @max_workers             = max_workers # max # of workers we can scale to
       @total_capacity          = (@max_workers * worker_capacity).to_f # total capacity of max workers
       min_capacity             = [0, min_factor].max.to_f * worker_capacity # min capacity required to scale first worker

data/lib/autoscaler/sidekiq/thread_server.rb

@@ -32,7 +32,7 @@ module Autoscaler
         if timeout.respond_to?(:call)
           timeout
         else
-          DelayedShutdown.new(BinaryScalingStrategy.new, timeout)
+          DelayedShutdown.new(strategy: BinaryScalingStrategy.new, timeout: timeout)
         end
       end
 

data/lib/autoscaler/stub_scaler.rb

@@ -1,5 +1,3 @@
-require 'heroku-api'
-
 module Autoscaler
   # A minimal scaler to use as stub for local testing
   class StubScaler

data/lib/autoscaler/version.rb

@@ -1,4 +1,4 @@
 module Autoscaler
   # version number
-  VERSION = "0.14.0"
+  VERSION = "1.0.0"
 end

data/spec/autoscaler/binary_scaling_strategy_spec.rb

@@ -13,7 +13,7 @@ describe Autoscaler::BinaryScalingStrategy do
 
   it "does not scale with pending work" do
     system = TestSystem.new(1)
-    strategy = cut.new(2)
+    strategy = cut.new(active_workers: 2)
     expect(strategy.call(system, 1)).to eq 2
   end
 end

data/spec/autoscaler/delayed_shutdown_spec.rb

@@ -6,17 +6,17 @@ describe Autoscaler::DelayedShutdown do
   let(:cut) {Autoscaler::DelayedShutdown}
 
   it "returns normal values" do
-    strategy = cut.new(lambda{|s,t| 2}, 0)
+    strategy = cut.new(strategy: lambda{|s,t| 2}, timeout: 0)
     expect(strategy.call(nil, 1)).to eq 2
   end
 
   it "delays zeros" do
-    strategy = cut.new(lambda{|s,t| 0}, 60)
+    strategy = cut.new(strategy: lambda{|s,t| 0}, timeout: 60)
     expect(strategy.call(nil, 1)).to eq 1
   end
 
   it "eventually returns zero" do
-    strategy = cut.new(lambda{|s,t| 0}, 60)
+    strategy = cut.new(strategy: lambda{|s,t| 0}, timeout: 60)
     allow(strategy).to receive(:level_idle_time).and_return(61)
     expect(strategy.call(nil, 61)).to eq 0
   end

data/spec/autoscaler/linear_scaling_strategy_spec.rb

@@ -7,79 +7,79 @@ describe Autoscaler::LinearScalingStrategy do
 
   it "deactivates with no work" do
     system = TestSystem.new(0)
-    strategy = cut.new(1)
+    strategy = cut.new(max_workers: 1)
     expect(strategy.call(system, 1)).to eq 0
   end
 
   it "activates with some work" do
     system = TestSystem.new(1)
-    strategy = cut.new(1)
+    strategy = cut.new(max_workers: 1)
     expect(strategy.call(system, 1)).to be > 0
   end
 
   it "minimally scales with minimal work" do
     system = TestSystem.new(1)
-    strategy = cut.new(2, 2)
+    strategy = cut.new(max_workers: 2, worker_capacity: 2)
     expect(strategy.call(system, 1)).to eq 1
   end
 
   it "maximally scales with too much work" do
     system = TestSystem.new(5)
-    strategy = cut.new(2, 2)
+    strategy = cut.new(max_workers: 2, worker_capacity: 2)
     expect(strategy.call(system, 1)).to eq 2
   end
 
   it "proportionally scales with some work" do
     system = TestSystem.new(5)
-    strategy = cut.new(5, 2)
+    strategy = cut.new(max_workers: 5, worker_capacity: 2)
     expect(strategy.call(system, 1)).to eq 3
   end
 
   it "doesn't scale unless minimum is met" do
     system = TestSystem.new(2)
-    strategy = cut.new(10, 4, 0.5)
+    strategy = cut.new(max_workers: 10, worker_capacity: 4, min_factor: 0.5)
     expect(strategy.call(system, 1)).to eq 0
   end
 
   it "scales proprotionally with a minimum" do
     system = TestSystem.new(3)
-    strategy = cut.new(10, 4, 0.5)
+    strategy = cut.new(max_workers: 10, worker_capacity: 4, min_factor: 0.5)
     expect(strategy.call(system, 1)).to eq 1
   end
 
   it "scales maximally with a minimum" do
     system = TestSystem.new(25)
-    strategy = cut.new(5, 4, 0.5)
+    strategy = cut.new(max_workers: 5, worker_capacity: 4, min_factor: 0.5)
     expect(strategy.call(system, 1)).to eq 5
   end
 
   it "scales proportionally with a minimum > 1" do
     system = TestSystem.new(12)
-    strategy = cut.new(5, 4, 2)
+    strategy = cut.new(max_workers: 5, worker_capacity: 4, min_factor: 2)
     expect(strategy.call(system, 1)).to eq 2
   end
 
   it "scales maximally with a minimum factor > 1" do
     system = TestSystem.new(30)
-    strategy = cut.new(5, 4, 2)
+    strategy = cut.new(max_workers: 5, worker_capacity: 4, min_factor: 2)
     expect(strategy.call(system, 1)).to eq 5
   end
 
   it "doesn't scale down engaged workers" do
     system = TestSystem.new(0, 2)
-    strategy = cut.new(5, 4)
+    strategy = cut.new(max_workers: 5, worker_capacity: 4)
     expect(strategy.call(system, 1)).to eq 2
   end
 
   it "doesn't scale above max workers even if engaged workers is greater" do
     system = TestSystem.new(40, 6)
-    strategy = cut.new(5, 4)
+    strategy = cut.new(max_workers: 5, worker_capacity: 4)
     expect(strategy.call(system, 1)).to eq 5
   end
 
   it "returns zero if requested capacity is zero" do
     system = TestSystem.new(0, 0)
-    strategy = cut.new(0, 0)
+    strategy = cut.new(max_workers: 0, worker_capacity: 0)
     expect(strategy.call(system, 5)).to eq 0
   end
 end

data/spec/spec_helper.rb

@@ -5,8 +5,7 @@ REDIS = Sidekiq::RedisConnection.create(:url => 'redis://localhost:9736')
 RSpec.configure do |config|
   config.mock_with :rspec
 
-  config.filter_run_excluding :api1 => true unless ENV['HEROKU_API_KEY']
-  config.filter_run_excluding :platform_api => true unless ENV['AUTOSCALER_HEROKU_ACCESS_TOKEN'] || ENV['HEROKU_ACCESS_TOKEN']
+  config.filter_run_excluding :platform_api => true unless ENV['AUTOSCALER_HEROKU_ACCESS_TOKEN']
 end
 
 class TestScaler

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: autoscaler
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Justin Love
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-07 00:00:00.000000000 Z
+date: 2018-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -25,20 +25,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: heroku-api
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.0'
 - !ruby/object:Gem::Dependency
   name: platform-api
   requirement: !ruby/object:Gem::Requirement
@@ -142,7 +128,6 @@ files:
 - lib/autoscaler/counter_cache_redis.rb
 - lib/autoscaler/delayed_shutdown.rb
 - lib/autoscaler/heroku_platform_scaler.rb
-- lib/autoscaler/heroku_scaler.rb
 - lib/autoscaler/ignore_scheduled_and_retrying.rb
 - lib/autoscaler/linear_scaling_strategy.rb
 - lib/autoscaler/sidekiq.rb
@@ -160,7 +145,6 @@ files:
 - spec/autoscaler/counter_cache_redis_spec.rb
 - spec/autoscaler/delayed_shutdown_spec.rb
 - spec/autoscaler/heroku_platform_scaler_spec.rb
-- spec/autoscaler/heroku_scaler_spec.rb
 - spec/autoscaler/ignore_scheduled_and_retrying_spec.rb
 - spec/autoscaler/linear_scaling_strategy_spec.rb
 - spec/autoscaler/sidekiq/activity_spec.rb
@@ -181,9 +165,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -197,20 +181,19 @@ specification_version: 4
 summary: Start/stop Sidekiq workers on Heroku
 test_files:
 - Guardfile
-- spec/autoscaler/binary_scaling_strategy_spec.rb
-- spec/autoscaler/counter_cache_memory_spec.rb
+- spec/spec_helper.rb
+- spec/test_system.rb
 - spec/autoscaler/counter_cache_redis_spec.rb
-- spec/autoscaler/delayed_shutdown_spec.rb
-- spec/autoscaler/heroku_platform_scaler_spec.rb
-- spec/autoscaler/heroku_scaler_spec.rb
 - spec/autoscaler/ignore_scheduled_and_retrying_spec.rb
 - spec/autoscaler/linear_scaling_strategy_spec.rb
-- spec/autoscaler/sidekiq/activity_spec.rb
 - spec/autoscaler/sidekiq/client_spec.rb
-- spec/autoscaler/sidekiq/entire_queue_system_spec.rb
 - spec/autoscaler/sidekiq/sleep_wait_server_spec.rb
-- spec/autoscaler/sidekiq/specified_queue_system_spec.rb
 - spec/autoscaler/sidekiq/thread_server_spec.rb
-- spec/spec_helper.rb
-- spec/test_system.rb
+- spec/autoscaler/sidekiq/specified_queue_system_spec.rb
+- spec/autoscaler/sidekiq/activity_spec.rb
+- spec/autoscaler/sidekiq/entire_queue_system_spec.rb
+- spec/autoscaler/counter_cache_memory_spec.rb
+- spec/autoscaler/binary_scaling_strategy_spec.rb
+- spec/autoscaler/delayed_shutdown_spec.rb
+- spec/autoscaler/heroku_platform_scaler_spec.rb
 has_rdoc: 

data/lib/autoscaler/heroku_scaler.rb

@@ -1,85 +0,0 @@
-require 'heroku-api'
-require 'autoscaler/counter_cache_memory'
-
-module Autoscaler
-  # Wraps the Heroku API to provide just the interface that we need for scaling.
-  #  OBSOLETE: The v1 Heroku API is no longer available, and HerokuScaler will likely be removed in a future major release. Please see current setup instructions and examples for HerokuPlatformScaler.
-  class HerokuScaler
-    # @param [String] type process type this scaler controls
-    # @param [String] key Heroku API key
-    # @param [String] app Heroku app name
-    def initialize(
-        type = 'worker',
-        key = ENV['HEROKU_API_KEY'],
-        app = ENV['HEROKU_APP'])
-
-      warn "Autoscaler: The v1 Heroku API is no longer available, and HerokuScaler will likely be removed in a future major release. Please see current setup instructions and examples for HerokuPlatformScaler."
-
-      @client = Heroku::API.new(:api_key => key)
-      @type = type
-      @app = app
-      @workers = CounterCacheMemory.new
-    end
-
-    attr_reader :app
-    attr_reader :type
-
-    # Read the current worker count (value may be cached)
-    # @return [Numeric] number of workers
-    def workers
-      @workers.counter {@workers.counter = heroku_get_workers}
-    end
-
-    # Set the number of workers (noop if workers the same)
-    # @param [Numeric] n number of workers
-    def workers=(n)
-      unknown = false
-      current = @workers.counter{unknown = true; 1}
-      if n != current || unknown
-        p "Scaling #{type} to #{n}"
-        heroku_set_workers(n)
-        @workers.counter = n
-      end
-    end
-
-    # Callable object which responds to exceptions during api calls #
-    # @example
-    #   heroku.exception_handler = lambda {|exception| MyApp.logger.error(exception)}
-    #   heroku.exception_handler = lambda {|exception| raise}
-    #   # default
-    #   lambda {|exception|
-    #     p exception
-    #     puts exception.backtrace
-    #   }
-    attr_writer :exception_handler
-
-    # Object which supports #counter and #counter=
-    # Defaults to CounterCacheMemory
-    def counter_cache=(cache)
-      @workers = cache
-    end
-
-    private
-    attr_reader :client
-
-    def heroku_get_workers
-      client.get_ps(app).body.count {|ps| ps['process'].match /#{type}\.\d?/ }
-    rescue Excon::Errors::Error, Heroku::API::Errors::Error => e
-      exception_handler.call(e)
-      0
-    end
-
-    def heroku_set_workers(n)
-      client.post_ps_scale(app, type, n)
-    rescue Excon::Errors::Error, Heroku::API::Errors::Error => e
-      exception_handler.call(e)
-    end
-
-    def exception_handler
-      @exception_handler ||= lambda {|exception|
-        p exception
-        puts exception.backtrace
-      }
-    end
-  end
-end

data/spec/autoscaler/heroku_scaler_spec.rb

@@ -1,49 +0,0 @@
-require 'spec_helper'
-require 'autoscaler/heroku_scaler'
-require 'heroku/api/errors'
-
-describe Autoscaler::HerokuScaler, :api1 => true do
-  let(:cut) {Autoscaler::HerokuScaler}
-  let(:client) {cut.new}
-  subject {client}
-
-  its(:workers) {should eq(0)}
-
-  describe 'scaled' do
-    around do |example|
-      client.workers = 1
-      example.call
-      client.workers = 0
-    end
-
-    its(:workers) {should eq(1)}
-  end
-
-  shared_examples 'exception handler' do |exception_class|
-    before do
-      expect(client).to receive(:client){
-        raise exception_class.new(Exception.new('oops'))
-      }
-    end
-
-    describe "default handler" do
-      it {expect{client.workers}.to_not raise_error}
-      it {expect(client.workers).to eq(0)}
-      it {expect{client.workers = 2}.to_not raise_error}
-    end
-
-    describe "custom handler" do
-      before do
-        @caught = false
-        client.exception_handler = lambda {|exception| @caught = true}
-      end
-
-      it {client.workers; expect(@caught).to be(true)}
-    end
-  end
-
-  describe 'exception handling', :focus => true do
-    it_behaves_like 'exception handler', Excon::Errors::SocketError
-    it_behaves_like 'exception handler', Heroku::API::Errors::Error
-  end
-end