garbageman 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rvmrc

@@ -0,0 +1 @@
+rvm 1.9.3-p327@garbageman

data/Gemfile

@@ -0,0 +1,7 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "rdoc", "~> 3.12"
+  gem "jeweler", "~> 1.8.4"
+  gem "rspec", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.2.4)
+    git (1.2.5)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.8.0)
+    rake (10.0.4)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jeweler (~> 1.8.4)
+  rdoc (~> 3.12)
+  rspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Doug Youch
+
+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.rdoc

@@ -0,0 +1,19 @@
+= garbageman
+
+Description goes here.
+
+== Contributing to garbageman
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2013 Doug Youch. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,36 @@
+# 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 = "garbageman"
+  gem.homepage = "http://github.com/dyouch5@yahoo.com/garbageman"
+  gem.license = "MIT"
+  gem.summary = %Q{Process requests without garbage collection}
+  gem.description = %Q{Disable GC while processing requests.  By using nginx upstream health checks to garbage collect when no one is there.}
+  gem.email = "doug@sessionm.com"
+  gem.authors = ["Doug Youch"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "garbageman #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/garbageman/collector.rb

@@ -0,0 +1,138 @@
+require 'singleton'
+
+module GarbageMan
+  class Collector
+    include Singleton
+
+    attr_accessor :request_count, :will_collect
+    attr_reader :fiber_poll
+
+    def initialize
+      reset
+    end
+
+    def register_fiber_pool(pool)
+      @fiber_poll = pool
+    end
+
+    def healthy?
+      unless can_disable?
+        debug "can not disable gc"
+        GC.enable
+        return true
+      end
+
+      if should_collect?
+        write_gc_yaml server_index, 'will_collect'
+        false
+      else
+        true
+      end
+    end
+
+    def collect
+      return unless can_collect?
+
+      write_gc_yaml server_index, 'starting'
+      debug "starting gc"
+      starts = Time.now
+      GC.enable
+      GC.start
+      diff = (Time.now - starts) * 1000
+      info "GC took #{'%.2f' % diff}ms"
+      write_gc_yaml server_index, 'finished'
+
+      reset
+
+      if can_disable? && select_next_server
+        debug "disabling gc"
+        GC.disable
+      else
+        debug "enabling gc, can not turn off"
+        GC.enable
+      end
+    end
+
+    def create_gc_yaml
+      return unless server_index
+      return if File.exists?(Config.gc_yaml_file)
+      write_gc_yaml server_index, 'selected'
+    end
+
+    private
+
+    def server_index
+      Thin::Backends::Base.server_index
+    end
+
+    def num_servers
+      self.thin_config['servers']
+    end
+
+    def write_gc_yaml(index, status)
+      config = {'gc' => {'server' => index, 'status' => status}}
+      File.open(Config.gc_yaml_file, 'w+') { |f| f.write config.to_yaml }
+    end
+
+    def select_next_server
+      Config.thin_config['servers'].times do |i|
+        next_server_index = (server_index + i + 1) % num_servers
+        file = self.thin_config['socket'].sub '.sock', ".#{next_server_index}.sock"
+        next unless File.exists?(file)
+        debug "selected #{next_server_index}"
+        write_gc_yaml next_server_index, 'selected'
+        return true
+      end
+      false
+    end
+
+    def reset
+      @request_count = 0
+      @will_collect = false
+    end
+
+    # no traffic and we've been selected by health check
+    def can_collect?
+      @will_collect && fiber_pool.busy_fibers.size == 0 && Thin::Backends::Base.num_connections == 0
+    end
+
+    # if the request count is high enough and it is our turn
+    def should_collect?
+      @will_collect = (@request_count >= Config.num_request_before_collecting && current_server?)
+    end
+
+    def current_server?
+      config = Config.gc_config
+      config && config['gc'] && config['gc']['server'] && config['gc']['server'] == server_index
+    end
+
+    def can_disable?
+      Config.thin_config.has_key?('socket') && not_alone?
+    end
+
+    # make sure I'm not the only server running
+    def not_alone?
+      Config.thin_config['servers'].times do |i|
+        next if i == server_index
+        file = self.thin_config['socket'].sub '.sock', ".#{i}.sock"
+        if File.exists?(file)
+          return true
+        end
+      end
+
+      debug "no other servers found"
+      false
+    end
+
+    def logger; GarbageMan.logger; end
+
+    def debug(msg)
+      logger.debug msg
+    end
+
+    def info(msg)
+      logger.info msg
+    end
+  end
+end
+

data/lib/garbageman/config.rb

@@ -0,0 +1,23 @@
+module GarbageMan
+  class Config
+    @@gc_health_check_request_path = '/gc_health_check'
+    def self.gc_health_check_request_path; @@gc_health_check_request_path; end
+
+    @@gc_yaml_file = nil
+    def self.gc_yaml_file; @@gc_yaml_file ||= "#{Rails.root}/data/gc.yml"; end
+    def self.gc_yaml_file=(file); @@gc_yaml_file = file; end
+
+    def self.gc_config
+      begin
+        File.exists?(self.gc_yaml_file) ? YAML.load_file(self.gc_yaml_file) : nil
+      rescue Errno::ENOENT => e
+        nil
+      end
+    end
+
+    @@thin_config = nil
+    def self.thin_config; @@thin_config ||= YAML.load_file("#{Rails.root}/config/thin.yml"); end
+
+    def self.num_request_before_collecting; 10; end
+  end
+end

data/lib/garbageman/ext/thin.rb

@@ -0,0 +1,86 @@
+module Thin
+  module Backends
+    class Base
+      cattr_reader :num_connections
+      @@num_connections = 0
+      cattr_accessor :server_index
+      @@server_index = nil
+
+      def connection_finished_with_count(connection)
+        connection_finished_without_count(connection).tap { @@num_connections -= 1 }
+      end
+      alias_method_chain :connection_finished, :count
+
+      protected
+
+      def initialize_connection_with_count(connection)
+        initialize_connection_without_count(connection).tap { @@num_connections += 1 }
+      end
+      alias initialize_connection_without_count count
+      alias count initialize_connection_with_count
+    end
+
+    class TcpServer
+      def connect_with_callbacks
+        Thin::Server.run_before_startup_callbacks
+        connect_without_callbacks.tap do
+          Thin::Server.run_after_startup_callbacks
+        end
+      end
+      alias connect_without_callbacks connect
+      alias connect connect_with_callbacks
+    end
+
+    class UnixServer
+      def connect_with_callbacks
+        Thin::Server.run_before_startup_callbacks
+        connect_without_callbacks.tap do
+          Thin::Backends::Base.server_index = @socket.to_s.sub(/^.*?\.(\d+)\.sock$/, '\\1').to_i
+          Thin::Server.run_after_startup_callbacks
+        end
+      end
+      alias connect_without_callbacks connect
+      alias connect connect_with_callbacks
+    end
+  end
+
+  class Server
+    @@before_startup_callbacks = []
+    @@after_startup_callbacks = []
+    @@close_callbacks = []
+
+    # thin is not yet excepting requests, but EM has started
+    def self.add_before_startup_callback(proc=nil, &block)
+      @@before_startup_callbacks << (proc || block)
+    end
+
+    # this is excepting requests and has written the socket file
+    def self.add_after_startup_callback(proc=nil, &block)
+      @@after_startup_callbacks << (proc || block)
+    end
+
+    # these callbacks are called after all the requests have been processed
+    def self.add_close_callback(proc=nil, &block)
+      @@close_callbacks << (proc || block)
+    end
+
+    def self.run_before_startup_callbacks
+      @@before_startup_callbacks.each { |c| c.call } if @@before_startup_callbacks
+      @@before_startup_callbacks = nil
+    end
+
+    def self.run_after_startup_callbacks
+      @@after_startup_callbacks.each { |c| c.call } if @@after_startup_callbacks
+      @@after_startup_callbacks = nil
+    end
+
+    def stop_with_callbacks!
+      stop_without_callbacks!.tap do
+        @@close_callbacks.each { |c| c.call } if @@close_callbacks
+        @@close_callbacks = nil
+      end
+    end
+    alias stop_without_callbacks! stop!
+    alias stop! stop_with_callbacks!
+  end
+end

data/lib/garbageman/rack/middleware.rb

@@ -0,0 +1,22 @@
+module GarbageMan
+  module Rack
+    class Middleware
+      def initialize(app)
+        @app = app
+      end
+
+      @@ok_response = [200, {'Content-Length' => '0'}, '']
+      @@gc_response = [589, {'Content-Length' => '0'}, '']
+      def call(env)
+        GcCollector.instance.request_count += 1
+
+        if env['REQUEST_PATH'] == GarbageMan::Config.gc_health_check_request_path
+          GarbageMan::Collector.instance.healthy? ? @@ok_response : @@gc_response
+        else
+          GcCollector.instance.debug("still receiving traffic even though I'm waiting to GC") if GcCollector.instance.will_collect
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/garbageman.rb

@@ -0,0 +1,22 @@
+# copied from dalli
+module GarbageMan
+  def self.logger
+    @logger ||= (rails_logger || default_logger)
+  end
+
+  def self.rails_logger
+    (defined?(Rails) && Rails.respond_to?(:logger) && Rails.logger) ||
+      (defined?(RAILS_DEFAULT_LOGGER) && RAILS_DEFAULT_LOGGER.respond_to?(:debug) && RAILS_DEFAULT_LOGGER)
+  end
+
+  def self.default_logger
+    require 'logger'
+    l = Logger.new(STDOUT)
+    l.level = Logger::INFO
+    l
+  end
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+end

data/test/helper.rb

@@ -0,0 +1,18 @@
+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 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'garbageman'
+
+class Test::Unit::TestCase
+end

data/test/test_garbageman.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestGarbageman < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: garbageman
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Doug Youch
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Disable GC while processing requests.  By using nginx upstream health
+  checks to garbage collect when no one is there.
+email: doug@sessionm.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/garbageman.rb
+- lib/garbageman/collector.rb
+- lib/garbageman/config.rb
+- lib/garbageman/ext/thin.rb
+- lib/garbageman/rack/middleware.rb
+- test/helper.rb
+- test/test_garbageman.rb
+homepage: http://github.com/dyouch5@yahoo.com/garbageman
+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: -3258579490044163618
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Process requests without garbage collection
+test_files: []