autoscaler 0.5.0 → 0.6.0

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 0.6.0
+
+- Excon errors from the Heroku API are caught be default.  See `HerokuScaler#exception_handler` to override behavior
+- Client side scaling occurs after enquing the job, previously it was before.
+
 ## 0.5.0
 
 - Experimental: `Client#set_initial_workers` to start workers on main process startup; typically:

data/README.md

@@ -41,11 +41,16 @@ Install the middleware in your `Sidekiq.configure_` blocks
 - 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 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 `HerokuScaler#exception_handler` to override
 
 ## Experimental
 
 You can pass a scaling strategy object instead of the timeout to the server middleware.  The object (or lambda) should respond to `#call(system, idle_time)` and return the desired number of workers.  See `lib/autoscaler/binary_scaling_strategy.rb` for an example.
 
+`Client#set_initial_workers` to start workers on main process startup; typically:
+
+    Autoscaler::Sidekiq::Client.add_to_chain(chain, 'default' => heroku).set_initial_workers
+
 ## Tests
 
 The project is setup to run RSpec with Guard.  It expects a redis instance on a custom port, which is started by the Guardfile.

data/examples/simple.rb

@@ -5,6 +5,7 @@ require 'autoscaler/heroku_scaler'
 heroku = nil
 if ENV['HEROKU_APP']
   heroku = Autoscaler::HerokuScaler.new
+  #heroku.exception_handler = lambda {|exception| MyApp.logger.error(exception)}
 end
 
 Sidekiq.configure_client do |config|

data/lib/autoscaler/binary_scaling_strategy.rb

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

data/lib/autoscaler/heroku_scaler.rb

@@ -26,7 +26,7 @@ module Autoscaler
       if known?
         @workers
       else
-        know client.get_ps(app).body.count {|ps| ps['process'].match /#{type}\.\d?/ }
+        know heroku_get_workers
       end
     end
 
@@ -35,11 +35,23 @@ module Autoscaler
     def workers=(n)
       if n != @workers || !known?
         p "Scaling #{type} to #{n}"
-        client.post_ps_scale(app, type, n)
+        heroku_set_workers(n)
         know 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
+
     private
     attr_reader :client
 
@@ -51,5 +63,25 @@ module Autoscaler
     def known?
       Time.now < @known
     end
+
+    def heroku_get_workers
+      client.get_ps(app).body.count {|ps| ps['process'].match /#{type}\.\d?/ }
+    rescue Excon::Errors::Error => e
+      exception_handler.call(e)
+      @workers
+    end
+
+    def heroku_set_workers(n)
+      client.post_ps_scale(app, type, n)
+    rescue Excon::Errors::Error => e
+      exception_handler.call(e)
+    end
+
+    def exception_handler
+      @exception_handler ||= lambda {|exception|
+        p exception
+        puts exception.backtrace
+      }
+    end
   end
 end

data/lib/autoscaler/sidekiq/client.rb

@@ -14,12 +14,14 @@ module Autoscaler
 
       # Sidekiq middleware api method
       def call(worker_class, item, queue)
+        result = yield
+
         scaler = @scalers[queue]
         if scaler && scaler.workers < 1
           scaler.workers = 1
         end
 
-        yield
+        result
       end
 
       # Check for interrupted or scheduled work on startup.

data/lib/autoscaler/version.rb

@@ -1,4 +1,4 @@
 module Autoscaler
   # version number
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/spec/autoscaler/heroku_scaler_spec.rb

@@ -17,4 +17,27 @@ describe Autoscaler::HerokuScaler, :online => true do
 
     its(:workers) {should == 1}
   end
+
+  describe 'exception handling', :focus => true do
+    before do
+      def client.client
+        raise Excon::Errors::SocketError.new(Exception.new('oops'))
+      end
+    end
+
+    describe "default handler" do
+      it {expect{client.workers}.to_not raise_error}
+      it {client.workers.should == 0}
+      it {expect{client.workers = 1}.to_not raise_error}
+    end
+
+    describe "custom handler" do
+      before do
+        @caught = false
+        client.exception_handler = lambda {|exception| @caught = true}
+      end
+
+      it {client.workers; @caught.should be_true}
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: autoscaler
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-21 00:00:00.000000000 Z
+date: 2013-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq