mongomapper_fallback 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mongomapper_fallback.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 TODO: Write your name
+
+MIT License
+
+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,47 @@
+# MongomapperFallback
+
+At this time, MongoMapper not have any mechanism to properly handle Replicaset connection failures (commonly master falls down and arbiter was not selected any server yet).
+
+MongomapperFallback is a alternative to handle these failures with a simple retry mechanism.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mongomapper_fallback'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongomapper_fallback
+
+## Usage
+
+    # example.rb
+    class Example
+      include MongomapperFallback
+
+      def execute
+        logger = Logger.new('your_logfile_here.log') # or Slogger
+
+        # available options:
+        # - retry_limit: limit of retries that will be executed
+        # - sig_quit: sends a QUIT to current process before retry failed code again
+
+        replicaset_safe_run!(logger, retry_limit: 10, sig_quit: true) do
+          # perform any operation
+        end
+      end
+    end
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/mongomapper_fallback/version.rb

@@ -0,0 +1,3 @@
+module MongomapperFallback
+  VERSION = '0.1.0'
+end

data/lib/mongomapper_fallback.rb

@@ -0,0 +1,53 @@
+require 'mongo_mapper'
+require 'mongomapper_fallback/version'
+
+module MongomapperFallback
+  def replicaset_safe_run!(logger, options = {})
+    sig_quit = options[:sig_quit] === true
+
+    retry_limit = options[:retry_limit].to_i
+    retry_limit = 5 if retry_limit == 0
+
+    attempts = 0
+    replicaset_errors = [ Mongo::ConnectionFailure, Mongo::OperationFailure ]
+
+    yield
+  rescue *replicaset_errors => e
+    error = e
+
+    begin
+      refresh!      if error.class == Mongo::ConnectionFailure
+      reconnect!    if error.class == Mongo::OperationFailure
+      quit_process! if sig_quit
+
+      stop_retry = true
+    rescue *replicaset_errors => ex
+      logger.error("Failed to reconnect to MongoDB: [#{ex}]")
+
+      attempts += 1
+      error = ex
+      raise(error) if attempts >= retry_limit
+
+      retry
+    end
+
+    logger.info('Successfully reconnected to MongoDB. Retrying now.')
+
+    retry
+  end
+
+  private
+
+  def refresh!
+    MongoMapper.connection.hard_refresh!
+  end
+
+  def reconnect!
+    MongoMapper.connection.reconnect
+  end
+
+  def quit_process!
+    Process.kill('QUIT', Process.ppid)
+  end
+end
+

data/mongomapper_fallback.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/mongomapper_fallback/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Marcelo Correia Pinheiro"]
+  gem.email         = ["salizzar@gmail.com"]
+  gem.description   = %q{MongoMapper replicaset fallback mechanism}
+  gem.summary       = %q{MongomapperFallback is a simple mechanism to handle common replicaset connection failures.}
+  gem.homepage      = "https://github.com/salizzar/mongomapper_fallback"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "mongomapper_fallback"
+  gem.require_paths = ["lib"]
+  gem.version       = MongomapperFallback::VERSION
+
+  gem.add_development_dependency  'rspec'
+  gem.add_development_dependency  'bson_ext'
+  gem.add_development_dependency  'debugger'
+
+  gem.add_runtime_dependency      'mongo_mapper'
+end

data/spec/mongomapper_fallback/mongomapper_fallback_spec.rb

@@ -0,0 +1,112 @@
+require 'spec_helper'
+
+describe MongomapperFallback do
+  subject do
+    class Example
+      include MongomapperFallback
+
+      def execute
+        replicaset_safe_run!(Logger.new(StringIO.new)) { perform_a_operation }
+      end
+
+      def perform_a_operation ; end
+    end
+
+    Example.new
+  end
+
+  let(:connection) { double('MongoMapper database connection') }
+
+  before :each do
+    MongoMapper.stub(connection: connection)
+  end
+
+  it 'raises error when it is not related to a MongoDB connection error' do
+    error = Exception.new 'an error'
+    subject.should_receive(:perform_a_operation).and_raise(error)
+
+    expect { subject.execute }.to raise_error(error)
+  end
+
+  describe 'detecting MongoDB connection errors' do
+    describe 'detecting Mongo::ConnectionFailure error' do
+      it 'refreshs connection' do
+        subject.should_receive(:perform_a_operation).and_raise(Mongo::ConnectionFailure)
+        connection.should_receive(:hard_refresh!)
+        connection.should_not_receive(:reconnect)
+        subject.should_receive(:perform_a_operation).and_return(true)
+
+        expect { subject.execute }.to_not raise_error
+      end
+    end
+
+    describe 'detecting Mongo::OperationFailure error' do
+      it 'reconnects to database server' do
+        subject.should_receive(:perform_a_operation).and_raise(Mongo::OperationFailure)
+        connection.should_receive(:reconnect)
+        connection.should_not_receive(:hard_refresh!)
+        subject.should_receive(:perform_a_operation).and_return(true)
+
+        expect { subject.execute }.to_not raise_error
+      end
+    end
+
+    describe 'retrying if attempts raises an error' do
+      it 'raises if retry limit is reached' do
+        subject.stub(:perform_a_operation).and_raise(Mongo::ConnectionFailure)
+
+        connection.should_receive(:hard_refresh!).exactly(5).times.and_raise(Mongo::ConnectionFailure)
+
+        expect { subject.execute }.to raise_error(Mongo::ConnectionFailure)
+      end
+
+      it 'performs a reconnection if hard refresh raises a operation failure' do
+        subject.should_receive(:perform_a_operation).and_raise(Mongo::ConnectionFailure)
+        connection.should_receive(:hard_refresh!).and_raise(Mongo::OperationFailure)
+        connection.should_receive(:reconnect).and_return(true)
+        subject.should_receive(:perform_a_operation).and_return(true)
+
+        expect { subject.execute }.to_not raise_error
+      end
+
+      it 'performs a hard refresh if reconnection raises a connection failure' do
+        subject.should_receive(:perform_a_operation).and_raise(Mongo::OperationFailure)
+        connection.should_receive(:reconnect).and_raise(Mongo::ConnectionFailure)
+        connection.should_receive(:hard_refresh!).and_return(true)
+        subject.should_receive(:perform_a_operation).and_return(true)
+
+        expect { subject.execute }.to_not raise_error
+      end
+    end
+  end
+
+  describe 'custom configuration' do
+    before :each do
+      subject.class_eval do
+        def execute
+          replicaset_safe_run!(Logger.new(StringIO.new), sig_quit: true, retry_limit: 10) { perform_a_operation }
+        end
+      end
+    end
+
+    it 'sends a SIGQUIT if flag is setted' do
+      ppid = 1234
+      Process.should_receive(:ppid).and_return(ppid)
+      Process.should_receive(:kill).with('QUIT', ppid)
+
+      subject.should_receive(:perform_a_operation).and_raise(Mongo::OperationFailure)
+      connection.should_receive(:reconnect)
+      subject.should_receive(:perform_a_operation).and_return(true)
+
+      expect { subject.execute }.to_not raise_error
+    end
+
+    it 'retries based on informed value when informed' do
+      subject.should_receive(:perform_a_operation).and_raise(Mongo::ConnectionFailure)
+      connection.should_receive(:hard_refresh!).exactly(10).times.and_raise(Mongo::ConnectionFailure)
+
+      expect { subject.execute }.to raise_error(Mongo::ConnectionFailure)
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'bundler/setup'
+require 'rspec'
+require 'mongomapper_fallback'
+

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: mongomapper_fallback
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Marcelo Correia Pinheiro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-21 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: bson_ext
+  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'
+- !ruby/object:Gem::Dependency
+  name: debugger
+  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'
+- !ruby/object:Gem::Dependency
+  name: mongo_mapper
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: MongoMapper replicaset fallback mechanism
+email:
+- salizzar@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/mongomapper_fallback.rb
+- lib/mongomapper_fallback/version.rb
+- mongomapper_fallback.gemspec
+- spec/mongomapper_fallback/mongomapper_fallback_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/salizzar/mongomapper_fallback
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+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: MongomapperFallback is a simple mechanism to handle common replicaset connection
+  failures.
+test_files:
+- spec/mongomapper_fallback/mongomapper_fallback_spec.rb
+- spec/spec_helper.rb