resque-heroku-scaling-canary 0.1.0

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gem 'resque', '~> 1.9'
+gem 'heroku', '~> 1.11'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.7"
+  gem "rspec-mocks", "~> 2.7"  
+  gem "jeweler", "~> 1.6.4"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Art.sy
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,79 @@
+resque-heroku-scaling-canary
+============================
+
+This gem defines a Resque plugin that allows you to automatically
+scale up the number of workers running on Heroku and then automatically scale them down once
+no work is left to do. To use, extend the module from your job:
+
+    class MyJob
+      extend Resque::Plugins::ScalingCanary
+      
+      def self.minimum_workers_needed
+        10
+      end
+
+      def self.perform
+        ...      
+      end
+    end
+
+Defining `minimum_workers_needed` like we did above is optional, but if you don't define it, it
+defaults to 1. ScalingCanary makes sure that when your job is enqueued there are at least this
+many workers working to service it.
+
+Next, define the environment variables HEROKU_USER, HEROKU_PASSWORD, and HEROKU_APP with your
+heroku credentials and app name:
+
+    $ heroku config:add HEROKU_USER=aaron@art.sy
+    $ heroku config:add HEROKU_PASSWORD=5u93r53cr37
+    $ heroku config:add HEROKU_APP=awesome-app
+
+When you enqueue your job, you'll see a new queue called "~scaling-canary" created with a single
+job in it. This job is the canary - its queue name is lexicographically after any other queue
+names you have, so it'll get processed last. When it runs, it looks around to see if any other
+jobs are being worked on or are awaiting workers on any queues. If any are, it requeues itself,
+but if everything's finished, it shuts down all workers.
+
+There are a few other gems that allow you to automatically scale up the Heroku workers you 
+use in response to your Resque load and then kill those workers automatically when 
+the work is done: [resque-heroku-autoscaler](https://github.com/ajmurmann/resque-heroku-autoscaler)
+and [hirefire](https://github.com/meskyanichi/hirefire) are two notable examples. This gem is
+takes a dumber but more easily auditable approach than either of the above alternatives that's
+better suited to systems running a largish set of batch jobs that might spawn other Resque jobs.
+In particular, this gem is meant to work well with jobs using 
+[resque-multi-step](https://github.com/pezra/resque-multi-step), which enqueues finalization
+jobs from within Resque tasks in a way that sometimes confuses other auto-scaling gems.
+
+This plugin works with Resque version 1.9 and above.
+
+Installation:
+-------------
+
+    gem install resque_heroku_scaling_canary
+
+Configuration:
+--------------
+
+You can configure the following parameters:
+
+   * `heroku_user`: defaults to the value of the environment variable HEROKU_USER
+   * `heroku_password`: defaults to the value of the environment variable HEROKU_PASSWORD
+   * `heroku_app`: defaults to the value of the environment variable HEROKU_APP
+   * `polling_interval`: the polling interval, in seconds, that the canary should wait
+      between checking the outstanding Resque jobs and working Resque workers. To be
+      safe, the canary checks these values twice, waiting for `polling_interval` seconds
+      in between, before shutting all workers down.
+   * `disable_scaling_if`: called with a block, will evaluate the block and disable
+      scaling entirely if it evaluates to `true`.
+
+These values are easiest to configure in an initializer, for example, create the
+file config/initializers/resque_heroku_scaling_canary.rb and put something like the
+following in the file:
+
+    require 'resque_heroku_scaling_canary'
+
+    Resque::Plugins::ScalingCanary.config do |config|
+      config.heroku_app = "myapp"
+      config.polling_interval = 3
+      config.disable_scaling_if{ Rails.env == 'development' }
+    end

data/Rakefile

@@ -0,0 +1,27 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "resque-heroku-scaling-canary"
+  gem.homepage = "http://github.com/aaw/resque-heroku-scaling-canary"
+  gem.license = "MIT"
+  gem.summary = %Q{Auto-scale Heroku workers for Resque}
+  gem.description = %Q{Auto-scale Heroku workers for Resque}
+  gem.email = "aaron.windsor@gmail.com"
+  gem.authors = ["Aaron Windsor"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/resque/plugins/resque_heroku_scaling_canary.rb

@@ -0,0 +1,22 @@
+require "resque/plugins/resque_heroku_scaling_canary/config"
+require "resque/plugins/resque_heroku_scaling_canary/canary_job"
+
+module Resque
+  module Plugins
+    module ScalingCanary
+      
+      def after_enqueue_ensure_heroku_workers(*args)
+        return if Config.scaling_disabled?
+        n = self.respond_to?(:minimum_workers_needed) ? self.minimum_workers_needed : 1
+        return if Config.heroku_client.info(Config.heroku_app)[:workers].to_i >= n
+        Config.heroku_client.set_workers(n)
+        Resque.enqueue(CanaryJob, Config.polling_interval) if CanaryJob.canary_jobs_pending == 0
+      end
+
+      def self.config
+        yield Config
+      end      
+
+    end
+  end
+end

data/lib/resque/plugins/resque_heroku_scaling_canary/canary_job.rb

@@ -0,0 +1,34 @@
+require "resque/plugins/resque_heroku_scaling_canary/config"
+
+module Resque
+  module Plugins
+    module ScalingCanary
+      class CanaryJob
+
+        @queue = "~scaling-canary"
+
+        def self.perform(timeout)
+          before = self.non_canary_jobs_pending
+          Kernel.sleep Config.polling_interval
+          after = self.non_canary_jobs_pending
+          if before == after and before == 0
+            Config.heroku_client.set_workers(0)
+          else
+            Resque.enqueue(self, timeout)
+          end
+        end
+
+        def self.canary_jobs_pending
+          Resque.size(@queue)
+        end
+
+        def self.non_canary_jobs_pending
+          waiting = Resque.queues.inject(0){ |accum, item| accum += Resque.size(item) unless item == @queue }
+          being_processed = Resque.workers.find_all{ |w| w.processing["queue"] and w.processing["queue"] != @queue }.count
+          waiting + being_processed
+        end
+
+      end
+    end
+  end
+end

data/lib/resque/plugins/resque_heroku_scaling_canary/config.rb

@@ -0,0 +1,43 @@
+module Resque
+  module Plugins
+    module ScalingCanary
+      module Config
+        extend self
+
+        @disable_scaling_if = lambda { false }
+        def disable_scaling_if(&block)
+          @disable_scaling_if = block
+        end
+
+        def scaling_disabled?
+          @disable_scaling_if.call
+        end
+
+        attr_writer :heroku_user
+        def heroku_user
+          @heroku_user ||= ENV['HEROKU_USER']
+        end
+
+        attr_writer :heroku_password
+        def heroku_password
+          @heroku_pass ||= ENV['HEROKU_PASS']
+        end
+
+        attr_writer :heroku_app
+        def heroku_app
+          @heroku_app ||= ENV['HEROKU_APP']
+        end
+
+        attr_writer :polling_interval
+        def polling_interval
+          @polling_interval ||= 5
+        end
+
+        def heroku_client
+          @@heroku_client ||= Heroku::Client.new(Config.heroku_user, Config.heroku_password)
+        end
+
+      end
+    end
+  end
+end

data/resque-heroku-scaling-canary.gemspec

@@ -0,0 +1,63 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "resque-heroku-scaling-canary"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Aaron Windsor"]
+  s.date = "2012-01-30"
+  s.description = "Auto-scale Heroku workers for Resque"
+  s.email = "aaron.windsor@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/resque/plugins/resque_heroku_scaling_canary.rb",
+    "lib/resque/plugins/resque_heroku_scaling_canary/canary_job.rb",
+    "lib/resque/plugins/resque_heroku_scaling_canary/config.rb",
+    "resque-heroku-scaling-canary.gemspec",
+    "spec/config_spec.rb",
+    "spec/resque_heroku_scaling_canary_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/aaw/resque-heroku-scaling-canary"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.10"
+  s.summary = "Auto-scale Heroku workers for Resque"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<resque>, ["~> 1.9"])
+      s.add_runtime_dependency(%q<heroku>, ["~> 1.11"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.7"])
+      s.add_development_dependency(%q<rspec-mocks>, ["~> 2.7"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+    else
+      s.add_dependency(%q<resque>, ["~> 1.9"])
+      s.add_dependency(%q<heroku>, ["~> 1.11"])
+      s.add_dependency(%q<rspec>, ["~> 2.7"])
+      s.add_dependency(%q<rspec-mocks>, ["~> 2.7"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    end
+  else
+    s.add_dependency(%q<resque>, ["~> 1.9"])
+    s.add_dependency(%q<heroku>, ["~> 1.11"])
+    s.add_dependency(%q<rspec>, ["~> 2.7"])
+    s.add_dependency(%q<rspec-mocks>, ["~> 2.7"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+  end
+end
+

data/spec/config_spec.rb

@@ -0,0 +1,15 @@
+require "spec_helper"
+
+describe Resque::Plugins::ScalingCanary::Config do
+  describe "scaling_disabled?" do
+    it "returns false by default" do
+      subject.scaling_disabled?.should be_false
+    end
+    it "returns the results of a call to disable_scaling_if when an implementation is provided" do
+      subject.disable_scaling_if{ true }
+      subject.scaling_disabled?.should be_true
+      subject.disable_scaling_if{ false }
+      subject.scaling_disabled?.should be_false
+    end
+  end
+end

data/spec/resque_heroku_scaling_canary_spec.rb

@@ -0,0 +1,58 @@
+require "spec_helper"
+
+class SmallBatchJob
+  extend Resque::Plugins::ScalingCanary
+  @queue = 'small-batch-job'
+
+  def self.perform; end
+end
+
+class LargeBatchJob
+  extend Resque::Plugins::ScalingCanary
+  @queue = 'large-batch-job'
+
+  def self.minimum_workers_needed
+    20
+  end
+
+  def self.perform; end
+end
+
+describe Resque::Plugins::ScalingCanary do
+  before(:each) do
+    @mock_heroku_client = Object.new
+    Resque::Plugins::ScalingCanary.config do |config|
+      config.heroku_user = "stub"
+      config.heroku_password = "stub"
+      config.heroku_app = "stub"
+      config.polling_interval = 0
+      config.stub(:heroku_client) { @mock_heroku_client }
+    end
+  end
+
+  it "should pass Resque's plugin lint test" do
+    lambda { Resque::Plugin.lint(Resque::Plugins::ScalingCanary) }.should_not raise_error
+  end
+  
+  describe "after_enqueue_ensure_heroku_workers" do
+    it "should scale workers up to 1 if no :minimum_workers_needed method is implemented" do
+      @mock_heroku_client.should_receive(:set_workers).with(1).once
+      @mock_heroku_client.should_receive(:set_workers).with(0).once
+      @mock_heroku_client.stub(:info) { {:workers => 0} }
+      Resque.enqueue SmallBatchJob
+    end
+    it "should scale workers up to the number specified by :minimum_workers_needed if an implementation is provided" do
+      @mock_heroku_client.should_receive(:set_workers).with(20).once
+      @mock_heroku_client.should_receive(:set_workers).with(0).once
+      @mock_heroku_client.stub(:info) { {:workers => 0} }
+      Resque.enqueue LargeBatchJob
+    end
+    it "should not scale workers at all if scaling is disabled" do
+      Resque::Plugins::ScalingCanary::Config.disable_scaling_if{ true }
+      @mock_heroku_client.stub(:set_workers){ raise "Not expecting call to :set_workers because scaling is disabled" }
+      @mock_heroku_client.stub(:info) { {:workers => 0} }
+      Resque.enqueue LargeBatchJob
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'rspec'
+require 'heroku'
+require 'resque'
+require 'resque/plugins/resque_heroku_scaling_canary/config'
+require 'resque/plugins/resque_heroku_scaling_canary'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.expect_with :rspec
+end
+
+Resque.inline = true

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: resque-heroku-scaling-canary
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Aaron Windsor
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-30 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: &2164966460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2164966460
+- !ruby/object:Gem::Dependency
+  name: heroku
+  requirement: &2164965560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2164965560
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2164964420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: *2164964420
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: &2164963280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: *2164963280
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &2164962200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :development
+  prerelease: false
+  version_requirements: *2164962200
+description: Auto-scale Heroku workers for Resque
+email: aaron.windsor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/resque/plugins/resque_heroku_scaling_canary.rb
+- lib/resque/plugins/resque_heroku_scaling_canary/canary_job.rb
+- lib/resque/plugins/resque_heroku_scaling_canary/config.rb
+- resque-heroku-scaling-canary.gemspec
+- spec/config_spec.rb
+- spec/resque_heroku_scaling_canary_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/aaw/resque-heroku-scaling-canary
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2123918992578808626
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Auto-scale Heroku workers for Resque
+test_files: []