amqp-failover 0.0.1

data/.document

@@ -0,0 +1,6 @@
+README.md
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE
+

data/.gitignore

@@ -0,0 +1,28 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+
+## PROJECT::SPECIFIC
+.yardoc/*
+spec/db/*
+doc/*
+

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rvmrc

@@ -0,0 +1 @@
+rvm gemset use amqp-failover

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in amqp-failover.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jim Myhrberg & Global Personals, Ltd.
+
+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,104 @@
+# amqp-failover #
+
+Add multi-server support with failover and fallback to the [amqp](https://github.com/ruby-amqp/amqp) gem. Failover is configured by providing multiple servers/configurations to `AMQP.start` or `AMQP.connect`. Both methods will still accept the same options input as they always have, they simply now support additional forms of options which when used, enables the failover features.
+
+
+## Basic Usage ##
+
+    require 'mq'
+    require 'amqp/failover'
+    opts = [{:port => 5672}, {:port => 5673}]
+    AMQP.start(opts) do
+      # code...
+    end
+
+By default the client will connect to `localhost:5672`, but if for any reason it can't connect, or looses connection to that server, it'll attempt to connect to `localhost:5673` instead.
+
+
+## Options Formats ##
+
+### Standard Non-Failover ###
+
+Hash:
+
+    opts = {:host => "hostname", :port => 5673}
+
+URL:
+
+    opts = "amqp://user:pass@hostname:5673/"
+
+### With Failover ###
+
+URLs
+
+    opts = "amqp://localhost:5672/,amqp://localhost:5673/"
+
+Array of Hashes:
+
+    opts = [{:port => 5672}, {:port => 5673}]
+
+Array of URLs:
+
+    opts = ["amqp://localhost:5672/", "amqp://localhost:5673/"]
+
+Specify AMQP servers and Failover options by passing a Hash containing a `:hosts` key with a value of either of the above three examples:
+
+    opts = {:hosts => "amqp://localhost:5672/,amqp://localhost:5673/", :fallback => true}
+    opts = {:hosts => [{:port => 5672}, {:port => 5673}], :fallback => true}
+    opts = {:hosts => ["amqp://localhost:5672/", "amqp://localhost:5673/"], :fallback => true}
+
+## Failover Options ##
+
+* `:retry_timeout`, time to wait before retrying a specific AMQP config after failure.
+* `:primary_config`, specify which of the supplied configurations is it the primary one. The default value is 0, the first item in the config array. Use 1 for the second and so on.
+* `:fallback`, check for the return of the primary server, and fallback to it if and when it returns. WARNING: This currently calls `Process.exit` cause I haven't figured out a way to artificially kill the EM connection without the AMQP channels also being closed, which causes nothing to work even after EM connects to the primary server. It works for me cause dead workers are automatically relaunched with their default config.
+* `:fallback_interval`, seconds between each check for original server if :fallback is true.
+* `:selection`, not yet implemented.
+
+
+## Notes ##
+
+I would recommend you test the failover functionality in your own infrastructure before deploy to production, as this gem is still very much alpha/beta quality, and it does do a little bit of monkey patching to the amqp gem. That said, it there's a number of specs which should ensure things work as advertised, and nothing breaks. We are currently using it at Global Personals without any problems.
+
+
+## Todo ##
+
+* Figure out a sane way to fallback without having to kill the Ruby process.
+* Better Readme/Documentation.
+* Add option for next server selection on failover to be selected by random rather than next on the list.
+* Convince get failover functionality merged in, or otherwise rewritten/added to the official AMQP gem.
+
+
+## Note on Patches/Pull Requests ##
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+
+## Liccense and Copyright ##
+
+Copyright (c) 2011 Jim Myhrberg & Global Personals, Ltd.
+
+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/Rakefile

@@ -0,0 +1,56 @@
+$LOAD_PATH.unshift File.expand_path("lib", File.dirname(__FILE__))
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+
+#
+# Rspec
+#
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec:all') do |spec|
+  spec.pattern = [ 'spec/unit/**/*_spec.rb',
+                   'spec/integration/**/*_spec.rb' ]
+end
+
+desc "Run unit specs"
+task :spec => ["spec:unit"]
+RSpec::Core::RakeTask.new('spec:unit') do |spec|
+  spec.pattern = 'spec/unit/**/*_spec.rb'
+end
+
+RSpec::Core::RakeTask.new('spec:integration') do |spec|
+  spec.pattern = 'spec/integration/**/*_spec.rb'
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+#
+# Yard
+#
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end
+
+
+#
+# Misc.
+#
+
+desc "Start irb with amqp-failover pre-loaded"
+task :console do
+  exec "irb -r spec/spec_helper"
+end
+task :c => :console

data/amqp-failover.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "amqp/failover/version"
+
+Gem::Specification.new do |s|
+  s.name        = "amqp-failover"
+  s.version     = AMQP::Failover::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jim Myhrberg"]
+  s.email       = ["contact@jimeh.me"]
+  s.homepage    = 'http://github.com/jimeh/amqp-failover'
+  s.summary     = 'Add multi-server failover and fallback to amqp gem.'
+  s.description = 'Add multi-server failover and fallback to amqp gem.'
+
+  s.rubyforge_project = "amqp-failover"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_runtime_dependency 'amqp', '>= 0.7.0'
+  
+  s.add_development_dependency 'rake', '>= 0.8.7'
+  s.add_development_dependency 'rack-test', '>= 0.5.6'
+  s.add_development_dependency 'rspec', '>= 2.1.0'
+  s.add_development_dependency 'yard', '>= 0.6.3'
+  s.add_development_dependency 'json', '>= 1.5.0'
+  s.add_development_dependency 'ruby-debug'
+end

data/lib/amqp/failover/config.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+module AMQP
+  class Failover
+    class Config < ::Hash
+      
+      attr_accessor :last_fail
+      
+      def initialize(hash = {}, last_fail_date = nil)
+        self.replace(symbolize_keys(defaults.merge(hash)))
+        self.last_fail = last_fail_date if last_fail_date
+      end
+      
+      def defaults
+        AMQP.settings
+      end
+      
+      def symbolize_keys(hash = {})
+        hash.inject({}) do |result, (key, value)|
+          result[key.is_a?(String) ? key.to_sym : key] = value
+          result
+        end
+      end
+      
+      # order by latest fail, potentially useful if random config selection is used
+      def <=>(other)
+        if self.respond_to?(:last_fail) && other.respond_to?(:last_fail)
+          if self.last_fail.nil? && other.last_fail.nil?
+            return 0
+          elsif self.last_fail.nil? && !other.last_fail.nil?
+            return 1
+          elsif !self.last_fail.nil? && other.last_fail.nil?
+            return -1
+          end
+          return other.last_fail <=> self.last_fail
+        end
+        return 0
+      end
+      
+    end # Config
+  end # Failover
+end # AMQP

data/lib/amqp/failover/configurations.rb

@@ -0,0 +1,92 @@
+# encoding: utf-8
+
+module AMQP
+  class Failover
+    class Configurations < Array
+      
+      def initialize(confs = nil)
+        load(confs)
+      end
+      
+      def [](*args)
+        if args[0].is_a?(Symbol)
+          return primary if args[0] == :primary
+          get(args[0])
+        else
+          super(*args)
+        end
+      end
+      
+      def []=(*args)
+        if args[0].is_a?(Symbol)
+          return primary = args.last if args[0] == :primary
+          set(args.last, args[0])
+        end
+        super(*args)
+      end
+      
+      def refs
+        @refs ||= {}
+      end
+      
+      def primary_ref
+        @primary_ref ||= 0
+      end
+      
+      def primary_ref=(ref)
+        @primary_ref = ref
+      end
+      
+      def primary
+        get(primary_ref) || AMQP.settings
+      end
+      
+      def primary=(conf = {})
+        set(conf, primary_ref)
+      end
+      
+      def get(ref = nil)
+        return self[ref] if ref.is_a?(Fixnum)
+        self[refs[ref]] if refs[ref]
+      end
+      
+      def set(conf = {}, ref = nil)
+        conf = Failover::Config.new(conf) if !conf.is_a?(Failover::Config)
+        if (index = self.index(conf)).nil?
+          self << conf
+        else
+          conf = self[index]
+        end
+        refs[ref] = (index || self.index(conf)) if ref
+        conf
+      end
+      
+      def find_next(conf = {})
+        current = self.index(conf)
+        self[(current+1 == self.size) ? 0 : current+1] if current
+      end
+      
+      def load(conf)
+        if conf.is_a?(Array)
+          load_array(conf)
+        elsif conf.is_a?(Hash)
+          load_hash(conf)
+        end
+      end
+      
+      def load_array(confs = [])
+        self.clear
+        refs = {}
+        confs.each do |conf|
+          conf = AMQP::Client.parse_amqp_url(conf) if conf.is_a?(String)
+          load_hash(conf)
+        end
+      end
+      
+      def load_hash(conf = {})
+        set(conf)
+      end
+      
+    end # Config
+  end # Failover
+end # AMQP

data/lib/amqp/failover/ext/amqp/client.rb

@@ -0,0 +1,67 @@
+# encoding: utf-8
+
+AMQP.client = AMQP::FailoverClient
+
+module AMQP
+  module Client
+    
+    class << self
+      
+      # Connect with Failover supports specifying multiple AMQP servers and configurations.
+      # 
+      # Argument Examples:
+      #   - "amqp://guest:guest@host:5672,amqp://guest:guest@host:5673"
+      #   - ["amqp://guest:guest@host:5672", "amqp://guest:guest@host:5673"]
+      #   - [{:host => "host", :port => 5672}, {:host => "host", :port => 5673}]
+      #   - {:hosts => ["amqp://user:pass@host:5672", "amqp://user:pass@host:5673"]}
+      #   - {:hosts => [{:host => "host", :port => 5672}, {:host => "host", :port => 5673}]}
+      #
+      # The last two examples are by far the most flexible, cause they also let you specify
+      # failover and fallback specific options. Like so:
+      #   - {:hosts => ["amqp://localhost:5672"], :fallback => false}
+      # 
+      # Available failover options are:
+      #   - :retry_timeout, time to wait before retrying a specific AMQP config after failure.
+      #   - :primary_config, specify which of the supplied configurations is it the primary one. The default
+      #                      value is 0, the first item in the config array. Use 1 for the second and so on.
+      #   - :fallback, check for the return of the primary server, and fallback to it if and when it returns.
+      #   - :fallback_interval, seconds between each check for original server if :fallback is true.
+      #   - :selection, not yet implimented.
+      # 
+      def connect_with_failover(opts = nil)
+        opts = parse_amqp_url_or_opts(opts)
+        connect_without_failover(opts)
+      end
+      alias :connect_without_failover :connect
+      alias :connect :connect_with_failover
+      
+      def parse_amqp_url_or_opts(opts = nil)
+        if opts.is_a?(String) && opts.index(',').nil?
+          opts = init_failover(opts.split(','))
+        elsif opts.is_a?(Array)
+          opts = init_failover(opts)
+        elsif opts.is_a?(Hash) && opts[:hosts].is_a?(Array)
+          confs = opts.delete(:hosts)
+          opts = init_failover(confs, opts)
+        end
+        opts
+      end
+      
+      def init_failover(confs = nil, opts = {})
+        if !confs.nil? && confs.size > 0
+          failover = Failover.new(confs, opts)
+          failover.primary.merge({ :failover => failover })
+        end
+      end
+      
+    end # << self
+    
+    def disconnected_with_failover
+      return failover_switch if @failover
+      disconnected_without_failover
+    end
+    alias :disconnected_without_failover :disconnected
+    alias :disconnected :disconnected_with_failover
+    
+  end # Client
+end # AMQP

data/lib/amqp/failover/logger.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+module AMQP
+  class Failover
+    class Logger
+      
+      attr_accessor :enabled
+      
+      def initialize(enabled = nil)
+        @enabled = enabled || true
+      end
+      
+      def error(*msg)
+        msg[0] = "[ERROR]: " + msg[0] if msg[0].is_a?(String)
+        write(*msg)
+      end
+      
+      def info(*msg)
+        write(*msg)
+      end
+      
+      private
+      
+      def write(*msg)
+        return if !@enabled
+        puts *msg
+      end
+      
+    end # Logger
+  end # Failover
+end # AMQP

data/lib/amqp/failover/server_discovery.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+
+module AMQP
+  class Failover
+    class ServerDiscovery < EM::Connection
+      
+      class << self
+        attr_accessor :connection
+      end
+      
+      def self.monitor(conf = {}, retry_interval = nil, &block)
+        if EM.reactor_running?
+          start_monitoring(conf, retry_interval, &block)
+        else
+          EM.run { start_monitoring(conf, retry_interval, &block) }
+        end
+      end
+      
+      def initialize(args)
+        @done = args[:done]
+        @timer = args[:timer]
+      end
+      
+      def connection_completed
+        @done.call
+        @timer.cancel
+        close_connection
+      end
+            
+      def self.start_monitoring(conf = {}, retry_interval = nil, &block)
+        conf = conf.clone
+        retry_interval ||= 5
+        conf[:done] = block
+        conf[:timer] = EM::PeriodicTimer.new(retry_interval) do
+          @connection = connect(conf)
+        end
+      end
+      
+      def self.connect(conf)
+        EM.connect(conf[:host], conf[:port], self, conf)
+      end
+      
+    end # ServerDiscovery
+  end # Failover
+end # AMQP

data/lib/amqp/failover/version.rb

@@ -0,0 +1,7 @@
+# encoding: utf-8
+
+module AMQP
+  class Failover
+    VERSION = "0.0.1"
+  end
+end

data/lib/amqp/failover.rb

@@ -0,0 +1,111 @@
+# encoding: utf-8
+
+require 'amqp/failover_client'
+require 'amqp/failover/config'
+require 'amqp/failover/configurations'
+require 'amqp/failover/logger'
+require 'amqp/failover/server_discovery'
+require 'amqp/failover/version'
+require 'amqp/failover/ext/amqp/client.rb'
+
+
+module AMQP
+  class Failover
+    
+    attr_reader :latest_failed
+    attr_accessor :primary
+    attr_accessor :retry_timeout
+    attr_accessor :fallback
+    
+    def initialize(confs = nil, opts = {})
+      @configs = Failover::Configurations.new(confs)
+      @options = default_options.merge(opts)
+      @configs.primary_ref = @options[:primary_config]
+    end
+    
+    class << self
+      # pluggable logger specifically for tracking failover and fallbacks
+      def logger
+        @logger ||= Logger.new
+      end
+      attr_writer :logger
+    end
+    
+    def default_options
+      { :primary_config => 0,
+        :retry_timeout => 1,
+        :selection => :sequential, #TODO: Implement next server selection algorithm
+        :fallback => false, #TODO: Enable by default once a sane implementation is figured out
+        :fallback_interval => 10 }
+    end
+    
+    def options
+      @options ||= {}
+    end
+    
+    def fallback_interval
+      options[:fallback_interval] ||= default_options[:fallback_interval]
+    end
+    
+    def primary
+      configs[:primary]
+    end
+    
+    def refs
+      @refs ||= {}
+    end
+    
+    def configs
+      @configs ||= Configurations.new
+    end
+    
+    def add_config(conf = {}, ref = nil)
+      index = configs.index(conf)
+      configs.set(conf) if index.nil?
+      refs[ref] = (index || configs.index(conf)) if !ref.nil?
+    end
+    
+    def failover_from(conf = {}, time = nil)
+      failed_with(conf, nil, time)
+      next_config
+    end
+    alias :from :failover_from
+    
+    def failed_with(conf = {}, ref = nil, time = nil)
+      time ||= Time.now
+      if !(index = configs.index(conf)).nil?
+        configs[index].last_fail = time
+        @latest_failed = configs[index]
+      else
+        @latest_failed = configs.set(conf)
+        configs.last.last_fail = time
+      end
+      refs[ref] = (index || configs.index(conf)) if !ref.nil?
+    end
+    
+    def next_config(retry_timeout = nil, after = nil)
+      return nil if configs.size <= 1
+      retry_timeout ||= @options[:retry_timeout]
+      after ||= @latest_failed
+      index = configs.index(after)
+      available = (index > 0) ? configs[index+1..-1] + configs[0..index-1] : configs[1..-1]
+      available.each do |conf|
+        return conf if conf.last_fail.nil? || (conf.last_fail.to_i + retry_timeout) < Time.now.to_i
+      end
+      return nil
+    end
+    
+    def last_fail_of(match)
+      ((match.is_a?(Hash) ? get_by_conf(match) : get_by_ref(match)) || Config::Failed.new).last_fail
+    end
+    
+    def get_by_conf(conf = {})
+      configs[configs.index(conf)]
+    end
+    
+    def get_by_ref(ref = nil)
+      configs[refs[ref]] if refs[ref]
+    end
+    
+  end # Failover
+end # AMQP