ar_mysql_flexmaster 0.4.4 → 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dffa59e91370055f41c5d4e7d6f6d2d0995251a6
+  data.tar.gz: afcf28a678aa561fcf57d9cbe1fd63038e3385ae
+SHA512:
+  metadata.gz: 8123f48cb4a821997e488027544405776fb2dfc3aff20ae99b2f5018ea70f02e079a71f4b6328c2dc5351e9f1bd3715e1ec6694cf14ed65f2af3d456bb685086
+  data.tar.gz: f45fe4dbb857085b4bd5d0adbfdd778b52a625b22669def9812561505b08d6f64f7ee6d50cb06f65860689da7c58d6c9537aa1d50cc30c94021d0c0d2eb1f474

data/.travis.yml

@@ -1,13 +1,31 @@
+language: ruby
+
 rvm:
   - 1.9.3
   - 2.0
+  - 2.1
+
 gemfile:
-  - gemfiles/rails2.gemfile
-  - gemfiles/rails3.gemfile
+  - gemfiles/rails2.3.gemfile
+  - gemfiles/rails3.0.gemfile
   - gemfiles/rails3.2.gemfile
+  - gemfiles/rails4.0.gemfile
+  - gemfiles/rails4.1.gemfile
+  - gemfiles/rails4.2.gemfile
+
+sudo: false
+
+bundler_args: --no-deployment
+
+script: bundle exec rake test
+
 matrix:
   exclude:
     - rvm: 2.0
-      gemfile: gemfiles/rails2.gemfile
+      gemfile: gemfiles/rails2.3.gemfile
     - rvm: 2.0
-      gemfile: gemfiles/rails3.gemfile
+      gemfile: gemfiles/rails3.0.gemfile
+    - rvm: 2.1
+      gemfile: gemfiles/rails2.3.gemfile
+    - rvm: 2.1
+      gemfile: gemfiles/rails3.0.gemfile

data/Gemfile

@@ -1,6 +1,5 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in ar_mysql_flexmaster.gemspec
 gemspec
-gem "debugger", "~>1.5.0"
-gem "appraisal"
+
+gem "rake"

data/README.md

@@ -1,26 +1,18 @@
-# ArMysqlFlexmaster
+[![Build Status](https://travis-ci.org/osheroff/ar_mysql_flexmaster.svg?branch=master)](https://travis-ci.org/osheroff/ar_mysql_flexmaster)
 
-Mysql Flexmaster is an adapter for ActiveRecord that allows an application node to choose
-among a list of potential masters at runtime.  It trades some properties of a more traditional
-HA solution (load balancing, middleware) for simplicity of operation.  
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'ar_mysql_flexmaster'
-
-And then execute:
+# Flexmaster
 
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install ar_mysql_flexmaster
+Flexmaster is an adapter for ActiveRecord and mysql that allows an application node to find a master
+among a list of potential masters at runtime.  It trades some properties of a more traditional
+HA solution (load balancing, middleware) for simplicity of operation.
 
 ## Configuration:
 
-database.yml contains a list of hosts -- all of them potential masters, all of them potential replicas.
+Your environment should be configured with 1 active master and N replicas.  Each replica should have mysql's
+global "READ_ONLY" flag set to true (this is really best practices for your replicas anyway, but flexmaster 
+depends on it).
+
+database.yml should contain a list of hosts -- all of them potential masters, all of them potential replicas.
 It should look like this:
 
 ```
@@ -36,6 +28,8 @@ production_slave:
   hosts: ["db01:3306", "db02:3306"]
 ```
 
+In this example, we've configured two diferent connections for rails to use.  Note that they're identicle except for the `slave:true` key in the production_slave yaml block.
+Adding `slave:true` indicates to flexmaster that this connection should prefer a read-only slave wherever possible.
 
 ## How it works
 
@@ -53,19 +47,22 @@ it finds the correct host.
 For master configurations (slave: true is not specified):
 
 The application will probe each host in turn, and find the mysql candidate among these nodes 
-that is read-write (SET GLOBAL READ_ONLY=0).  If it finds more than one node where READ_ONLY == 0, it will 
-abort.  
+that is read-write (SET GLOBAL READ\_ONLY=0).
+
+If it finds more than one node where READ_ONLY == 0, it will abort.
 
 For slave configurations (slave: true specified):
 
-The application will choose a replica at random from amongst those where READ_ONLY == 1. 
+The application will choose a replica at random from amongst those where READ_ONLY == 1.  If no active replicas are found, 
+it will fall back to the master.
 
 ### run time
 
-Before each transaction is begun on the master, the application checks the status of the READ_ONLY variable.
-If READ_ONLY == 0, it will proceed with the transaction as normal.  If READ_ONLY == 1, it will drop the current 
-connection and re-poll the cluster for the current master, sleeping up to a default of 5 seconds to wait for 
-the new master to be promoted.  When it finds the new master, it will begin the transaction there. 
+Before each transaction is opened on the master, the application checks the status of the READ_ONLY variable.
+If READ\_ONLY == 0 (our active connection is still to the current master), it will proceed with the 
+transaction as normal.  If READ\_ONLY == 1 (the master has been demoted), it will drop the current connection 
+and re-poll the cluster, sleeping for up to a default of 5 seconds for 
+a new master to be promoted.  When it finds the new master, it will continue playing the transaction on it.
 
 ### promoting a new master
 
@@ -76,7 +73,7 @@ The process of promoting a new master to head the cluster should be as follows:
 1. identify a new candidate master
 1. ensure that all other replicas in the cluster are chained off the candidate master; you want the 
    chain to look like this: 
-   
+
    ```
       <existing master> -> <candidate master> -> <other replicas>
                                               -> <other replicas> 
@@ -84,13 +81,13 @@ The process of promoting a new master to head the cluster should be as follows:
    ```
 
 1. set the old master to READ_ONLY = 1
-1. record the master-bin-log position of the candidate master (if you want to re-use the old master)
+1. record the master-bin-log position of the candidate master (if you want to re-use the old master as a replica)
 1. set the new master to READ_ONLY = 0 
 
-The application will eventually shift slave traffic to another node in the cluster, if available, and
-will drop their connection to the old master whenever a transaction is attempted, or after a certain 
-number of queries.
+The application nodes will, in time, find that the old master is inactive and will move their connections to the 
+new master. 
 
+The application will also eventually shift slave traffic to another node in the cluster.
 
 ### caveats, gotchas
 
@@ -98,6 +95,23 @@ number of queries.
   will crash.  In theory there's a workaround for this problem, in pratice it's rather unwieldy due
   to a lack of shared global variables in mysql.
 
+- Connection variables are unsupported, due to the connection being able to go away at any time.
+
+## Installation
+
+Do a little dance.  Drink a little water.  Or:
+Add this line to your application's Gemfile:
+
+    gem 'ar_mysql_flexmaster'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ar_mysql_flexmaster
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1,8 +1,8 @@
 #!/usr/bin/env rake
 require 'rake/testtask'
 
-require 'appraisal'
 require 'bump/tasks'
+require 'wwtd/tasks'
 
 Rake::TestTask.new(:test_units) do |test|
   test.libs << 'lib' << 'test'
@@ -10,10 +10,11 @@ Rake::TestTask.new(:test_units) do |test|
   test.verbose = true
 end
 
-task :test do 
+task :test do
   retval = true
   retval &= Rake::Task[:test_units].invoke
   retval &= system(File.dirname(__FILE__) + "/test/integration/run_integration_tests")
+  exit retval
 end
 
-task :default => :test
+task :default => 'wwtd:local'

data/ar_mysql_flexmaster.gemspec

@@ -12,12 +12,13 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "ar_mysql_flexmaster"
   gem.require_paths = ["lib"]
-  gem.version       = "0.4.4"
+  gem.version       = "0.5.0"
 
   gem.add_runtime_dependency("mysql2")
   gem.add_runtime_dependency("activerecord")
   gem.add_runtime_dependency("activesupport")
-  gem.add_development_dependency("appraisal")
+  gem.add_development_dependency("wwtd")
+  gem.add_development_dependency("minitest")
   gem.add_development_dependency("bump")
-  gem.add_development_dependency("mysql_isolated_server", "~> 0.1.1")
+  gem.add_development_dependency("mysql_isolated_server", "~> 0.5")
 end

data/gemfiles/rails2.3.gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gemspec :path => "../"
+
+gem "rake"
+gem "rails", "~> 2.3.15"
+gem "mysql2", "~> 0.2.0", "<= 0.2.18"

data/gemfiles/{rails2.gemfile.lock → rails2.3.gemfile.lock}

@@ -1,7 +1,7 @@
 PATH
-  remote: /Users/ben/src/ar_mysql_flexmaster
+  remote: ../
   specs:
-    ar_mysql_flexmaster (0.3.1)
+    ar_mysql_flexmaster (0.4.4)
       activerecord
       activesupport
       mysql2
@@ -19,18 +19,10 @@ GEM
     activeresource (2.3.18)
       activesupport (= 2.3.18)
     activesupport (2.3.18)
-    appraisal (0.5.2)
-      bundler
-      rake
-    columnize (0.3.6)
-    debugger (1.5.0)
-      columnize (>= 0.3.1)
-      debugger-linecache (~> 1.2.0)
-      debugger-ruby_core_source (~> 1.2.0)
-    debugger-linecache (1.2.0)
-    debugger-ruby_core_source (1.2.0)
+    bump (0.5.1)
+    minitest (5.4.3)
     mysql2 (0.2.18)
-    mysql_isolated_server (0.1.1)
+    mysql_isolated_server (0.5.3)
     rack (1.1.6)
     rails (2.3.18)
       actionmailer (= 2.3.18)
@@ -39,17 +31,18 @@ GEM
       activeresource (= 2.3.18)
       activesupport (= 2.3.18)
       rake (>= 0.8.3)
-    rake (10.0.4)
-    yaggy (0.1.7)
+    rake (10.4.2)
+    wwtd (0.5.5)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  appraisal
   ar_mysql_flexmaster!
-  debugger (~> 1.5.0)
-  mysql2 (~> 0.2.0)
-  mysql_isolated_server (~> 0.1.1)
+  bump
+  minitest
+  mysql2 (~> 0.2.0, <= 0.2.18)
+  mysql_isolated_server (~> 0.5)
   rails (~> 2.3.15)
-  yaggy
+  rake
+  wwtd

data/gemfiles/rails3.0.gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+gemspec :path => "../"
+
+gem "rake"
+gem "rails", "~> 3.0.0"
+gem "mysql2", "~> 0.2.0", "<= 0.2.18"

data/gemfiles/{rails3.gemfile.lock → rails3.0.gemfile.lock}

@@ -1,7 +1,7 @@
 PATH
-  remote: /Users/ben/src/ar_mysql_flexmaster
+  remote: ../
   specs:
-    ar_mysql_flexmaster (0.3.1)
+    ar_mysql_flexmaster (0.4.4)
       activerecord
       activesupport
       mysql2
@@ -36,31 +36,23 @@ GEM
       activemodel (= 3.0.20)
       activesupport (= 3.0.20)
     activesupport (3.0.20)
-    appraisal (0.5.2)
-      bundler
-      rake
     arel (2.0.10)
     builder (2.1.2)
-    columnize (0.3.6)
-    debugger (1.5.0)
-      columnize (>= 0.3.1)
-      debugger-linecache (~> 1.2.0)
-      debugger-ruby_core_source (~> 1.2.0)
-    debugger-linecache (1.2.0)
-    debugger-ruby_core_source (1.2.0)
+    bump (0.5.1)
     erubis (2.6.6)
       abstract (>= 1.0.0)
-    i18n (0.5.0)
-    json (1.7.7)
-    mail (2.2.19)
+    i18n (0.5.4)
+    json (1.8.1)
+    mail (2.2.20)
       activesupport (>= 2.3.6)
       i18n (>= 0.4.0)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
-    mime-types (1.23)
+    mime-types (1.25.1)
+    minitest (5.4.3)
     mysql2 (0.2.18)
-    mysql_isolated_server (0.1.1)
-    polyglot (0.3.3)
+    mysql_isolated_server (0.5.3)
+    polyglot (0.3.5)
     rack (1.2.8)
     rack-mount (0.6.14)
       rack (>= 1.0.0)
@@ -80,24 +72,25 @@ GEM
       rake (>= 0.8.7)
       rdoc (~> 3.4)
       thor (~> 0.14.4)
-    rake (10.0.4)
+    rake (10.4.2)
     rdoc (3.12.2)
       json (~> 1.4)
     thor (0.14.6)
-    treetop (1.4.12)
+    treetop (1.4.15)
       polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.37)
-    yaggy (0.1.7)
+    tzinfo (0.3.42)
+    wwtd (0.5.5)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  appraisal
   ar_mysql_flexmaster!
-  debugger (~> 1.5.0)
-  mysql2 (~> 0.2.0)
-  mysql_isolated_server (~> 0.1.1)
+  bump
+  minitest
+  mysql2 (~> 0.2.0, <= 0.2.18)
+  mysql_isolated_server (~> 0.5)
   rails (~> 3.0.0)
-  yaggy
+  rake
+  wwtd

data/gemfiles/rails3.2.gemfile

@@ -1,10 +1,7 @@
-# This file was generated by Appraisal
-
 source "https://rubygems.org"
 
-gem "debugger", "~>1.5.0"
-gem "appraisal"
-gem "rails", "~> 3.2.0"
-gem "mysql2", "~> 0.3.0"
+gemspec :path => "../"
 
-gemspec :path=>"../"
+gem "rake"
+gem "rails", "~> 3.2.0"
+gem "mysql2", "~> 0.3.0", "<= 0.3.11"

data/gemfiles/rails3.2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
-  remote: /Users/ben/src/ar_mysql_flexmaster
+  remote: ../
   specs:
-    ar_mysql_flexmaster (0.3.1)
+    ar_mysql_flexmaster (0.4.4)
       activerecord
       activesupport
       mysql2
@@ -9,12 +9,12 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionmailer (3.2.13)
-      actionpack (= 3.2.13)
-      mail (~> 2.5.3)
-    actionpack (3.2.13)
-      activemodel (= 3.2.13)
-      activesupport (= 3.2.13)
+    actionmailer (3.2.21)
+      actionpack (= 3.2.21)
+      mail (~> 2.5.4)
+    actionpack (3.2.21)
+      activemodel (= 3.2.21)
+      activesupport (= 3.2.21)
       builder (~> 3.0.0)
       erubis (~> 2.7.0)
       journey (~> 1.0.4)
@@ -22,92 +22,84 @@ GEM
       rack-cache (~> 1.2)
       rack-test (~> 0.6.1)
       sprockets (~> 2.2.1)
-    activemodel (3.2.13)
-      activesupport (= 3.2.13)
+    activemodel (3.2.21)
+      activesupport (= 3.2.21)
       builder (~> 3.0.0)
-    activerecord (3.2.13)
-      activemodel (= 3.2.13)
-      activesupport (= 3.2.13)
+    activerecord (3.2.21)
+      activemodel (= 3.2.21)
+      activesupport (= 3.2.21)
       arel (~> 3.0.2)
       tzinfo (~> 0.3.29)
-    activeresource (3.2.13)
-      activemodel (= 3.2.13)
-      activesupport (= 3.2.13)
-    activesupport (3.2.13)
-      i18n (= 0.6.1)
+    activeresource (3.2.21)
+      activemodel (= 3.2.21)
+      activesupport (= 3.2.21)
+    activesupport (3.2.21)
+      i18n (~> 0.6, >= 0.6.4)
       multi_json (~> 1.0)
-    appraisal (0.5.2)
-      bundler
-      rake
-    arel (3.0.2)
+    arel (3.0.3)
     builder (3.0.4)
-    columnize (0.3.6)
-    debugger (1.5.0)
-      columnize (>= 0.3.1)
-      debugger-linecache (~> 1.2.0)
-      debugger-ruby_core_source (~> 1.2.0)
-    debugger-linecache (1.2.0)
-    debugger-ruby_core_source (1.2.0)
+    bump (0.5.1)
     erubis (2.7.0)
-    hike (1.2.2)
-    i18n (0.6.1)
+    hike (1.2.3)
+    i18n (0.6.11)
     journey (1.0.4)
-    json (1.7.7)
-    mail (2.5.3)
-      i18n (>= 0.4.0)
+    json (1.8.1)
+    mail (2.5.4)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
-    mime-types (1.23)
-    multi_json (1.7.2)
+    mime-types (1.25.1)
+    minitest (5.4.3)
+    multi_json (1.10.1)
     mysql2 (0.3.11)
-    mysql_isolated_server (0.1.1)
-    polyglot (0.3.3)
+    mysql_isolated_server (0.5.3)
+    polyglot (0.3.5)
     rack (1.4.5)
     rack-cache (1.2)
       rack (>= 0.4)
-    rack-ssl (1.3.3)
+    rack-ssl (1.3.4)
       rack
     rack-test (0.6.2)
       rack (>= 1.0)
-    rails (3.2.13)
-      actionmailer (= 3.2.13)
-      actionpack (= 3.2.13)
-      activerecord (= 3.2.13)
-      activeresource (= 3.2.13)
-      activesupport (= 3.2.13)
+    rails (3.2.21)
+      actionmailer (= 3.2.21)
+      actionpack (= 3.2.21)
+      activerecord (= 3.2.21)
+      activeresource (= 3.2.21)
+      activesupport (= 3.2.21)
       bundler (~> 1.0)
-      railties (= 3.2.13)
-    railties (3.2.13)
-      actionpack (= 3.2.13)
-      activesupport (= 3.2.13)
+      railties (= 3.2.21)
+    railties (3.2.21)
+      actionpack (= 3.2.21)
+      activesupport (= 3.2.21)
       rack-ssl (~> 1.3.2)
       rake (>= 0.8.7)
       rdoc (~> 3.4)
       thor (>= 0.14.6, < 2.0)
-    rake (10.0.4)
+    rake (10.4.2)
     rdoc (3.12.2)
       json (~> 1.4)
-    sprockets (2.2.2)
+    sprockets (2.2.3)
       hike (~> 1.2)
       multi_json (~> 1.0)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
-    thor (0.18.1)
-    tilt (1.3.7)
-    treetop (1.4.12)
+    thor (0.19.1)
+    tilt (1.4.1)
+    treetop (1.4.15)
       polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.37)
-    yaggy (0.1.7)
+    tzinfo (0.3.42)
+    wwtd (0.5.5)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  appraisal
   ar_mysql_flexmaster!
-  debugger (~> 1.5.0)
-  mysql2 (~> 0.3.0)
-  mysql_isolated_server (~> 0.1.1)
+  bump
+  minitest
+  mysql2 (~> 0.3.0, <= 0.3.11)
+  mysql_isolated_server (~> 0.5)
   rails (~> 3.2.0)
-  yaggy
+  rake
+  wwtd