ar_mysql_flexmaster 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7128789a429103745358fcfae3ae85249b345f26
-  data.tar.gz: e4f15822ba6c60a21c88044e23f82189f1a044d4
+  metadata.gz: 003ae600df9f49fa3ed61a3f24b50be9a1c1578f
+  data.tar.gz: 964eea239d02d3ac8984f690e73b0d9dcda4f4a8
 SHA512:
-  metadata.gz: 131250bff67cc391ef60a8f2815c489948a639f7f4850bed10ac71893d8cfa90d76206e4b09dd39cdd5415a056a13be4daaeafa217c832cfd8875683ecf1eae0
-  data.tar.gz: 631a3b9882f0583a71b66541f1208120139e8c119eb6446c3937a8508eb83c03a04bdd3d576272df7ca50bb564ad8046ba373987179e7595b2af7065b92de544
+  metadata.gz: 54d905d3643055ddd23984cb162519c7dac4f06613b63f2e0bee48e0f4b742983039f543244af8a425582b3a37fa7a65b6c163df586e802ab3ba13405e83f34e
+  data.tar.gz: 5d10d47653118fb716cf3af3146270e96c403eaf9041ccb1dec81dea699e481d3244eb3ef85917e4ebc6989acf3d8f13968881f382dcedaa236551c7c4ceccf5

data/.travis.yml

@@ -1,26 +1,25 @@
 language: ruby
 
 rvm:
-  - 2.0.0
-  - 2.1.8
-  - 2.2.4
+  - 2.2.6
+  - 2.3.3
+  - 2.4.1
 
 gemfile:
   - gemfiles/rails3.2.gemfile
-  - gemfiles/rails4.0.gemfile
-  - gemfiles/rails4.1.gemfile
   - gemfiles/rails4.2.gemfile
   - gemfiles/rails5.0.gemfile
 
-sudo: false
+sudo: required
 
 bundler_args: --no-deployment
 
+before_script:
+  - sudo cp /usr/share/doc/mysql-server-5.6/examples/my-default.cnf /usr/share/mysql/my-default.cnf
+
 script: bundle exec rake test
 
 matrix:
   exclude:
-    - rvm: 2.0.0
-      gemfile: gemfiles/rails5.0.gemfile
-    - rvm: 2.1.8
-      gemfile: gemfiles/rails5.0.gemfile
+    - rvm: 2.4.1
+      gemfile: gemfiles/rails3.2.gemfile

data/README.md

@@ -1,19 +1,20 @@
-[![Build Status](https://travis-ci.org/osheroff/ar_mysql_flexmaster.svg?branch=master)](https://travis-ci.org/osheroff/ar_mysql_flexmaster)
+[![Build Status](https://travis-ci.org/zendesk/ar_mysql_flexmaster.svg?branch=master)](https://travis-ci.org/zendesk/ar_mysql_flexmaster)
 
 # 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.
+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:
 
-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).
+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:
+database.yml should contain a list of hosts – all of them potential masters, all
+of them potential replicas. It should look like this:
 
 ```
 production:
@@ -28,79 +29,86 @@ 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.
+In this example, we’ve configured two different connections for Rails to use.
+Note that they’re identical 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
 
 ### Overview
 
-The mysql "READ_ONLY" flag is used to indicate a current master amongst the cluster.  Only one member 
-of the replication chain may be read-write at any given time.  The application picks in run time, based 
-on the read_only flag, which host is correct.
+The MySQL `READ_ONLY` flag is used to indicate a current master amongst the
+cluster. Only one member of the replication chain may be read-write at any given
+time. The application picks in run time, based on the `READ_ONLY` flag, which
+host is correct.
 
-### boot time
+### Boot time
 
-Your activerecord application will pick a correct mysql host for the given configuration by probing hosts until 
-it finds the correct host.
+Your ActiveRecord application will pick a correct MySQL host for the given
+configuration by probing hosts until it finds the correct host.
 
-For master configurations (slave: true is not specified):
+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).
+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.
+If it finds more than one node where `READ_ONLY == 0`, it will abort.
 
-For slave configurations (slave: true specified):
+For slave configurations (`slave: true` specified):
 
-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.
+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
+### Run time
 
-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.
+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
+### Promoting a new master
 
-*The bin/master_cut script in this project will perform steps 3-5 for you.*
+*The `bin/master_cut` script in this project will perform steps 3–5 for you.*
 
 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: 
+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> 
-        
-   ```
-
-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 as a replica)
-1. set the new master to READ_ONLY = 0 
+                                              -> <other replicas>
 
-The application nodes will, in time, find that the old master is inactive and will move their connections to the 
-new master. 
+   ```
+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 as a replica).
+1. Set the new master to `READ_ONLY = 0`.
 
-The application will also eventually shift slave traffic to another node in the cluster.
+The application nodes will, in time, find that the old master is inactive and
+will move their connections to the new master.
 
-### caveats, gotchas
+The application will also eventually shift slave traffic to another node in the
+cluster.
 
-- Any explicit ( BEGIN ... END ) transaction that are in-flight when the old master goes READ_ONLY
-  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.
+### Caveats and gotchas
 
-- Connection variables are unsupported, due to the connection being able to go away at any time.
+- Any explicit (`BEGIN` … `END`) transaction that are in-flight when the old
+  master goes `READ_ONLY` 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:
+Add this line to your application’s Gemfile:
 
     gem 'ar_mysql_flexmaster'
 
@@ -119,5 +127,3 @@ Or install it yourself as:
 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

@@ -1,4 +1,4 @@
-#!/usr/bin/env rake
+require 'bundler/gem_tasks'
 require 'rake/testtask'
 
 require 'bump/tasks'

data/ar_mysql_flexmaster.gemspec

@@ -1,27 +1,30 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Ben Osheroff"]
-  gem.email         = ["ben@zendesk.com"]
-  gem.description   = %q{ar_mysql_flexmaster allows configuring N mysql servers in database.yml and auto-selects which is a master at runtime}
-  gem.summary       = %q{select a master at runtime from a list}
-  gem.homepage      = "http://github.com/osheroff/ar_mysql_flexmaster"
+  gem.authors       = ["Ben Osheroff", "Benjamin Quorning", "Gabe Martin-Dempesy", "Michael Grosser", "Pierre Schambacher"]
+  gem.email         = ["bquorning@zendesk.com", "gabe@zendesk.com", "mgrosser@zendesk.com", "pschambacher@zendesk.com"]
+  gem.description   = "ar_mysql_flexmaster allows configuring N mysql servers in database.yml and auto-selects which is a master at runtime"
+  gem.summary       = "select a master at runtime from a list"
+  gem.homepage      = "http://github.com/zendesk/ar_mysql_flexmaster"
 
   gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "ar_mysql_flexmaster"
   gem.require_paths = ["lib"]
-  gem.version       = "1.0.2"
+  gem.version       = "1.0.3"
+
+  gem.required_ruby_version = ">= 2.2"
 
   gem.add_runtime_dependency("mysql2")
   gem.add_runtime_dependency("activerecord")
   gem.add_runtime_dependency("activesupport")
+  gem.add_development_dependency("bundler")
   gem.add_development_dependency("rake")
   gem.add_development_dependency("wwtd")
   gem.add_development_dependency("minitest")
   gem.add_development_dependency("mocha", "~> 1.1.0")
   gem.add_development_dependency("bump")
   gem.add_development_dependency("pry")
-  gem.add_development_dependency("mysql_isolated_server", "~> 0.5")
+  gem.add_development_dependency("isolated_server")
 end

data/bin/master_cut

@@ -10,8 +10,8 @@ Thread.abort_on_exception = false
 
 opts = GetoptLong.new(
   ["--password",      "-p", GetoptLong::REQUIRED_ARGUMENT],
-  ["--rehome-master",   "-r", GetoptLong::NO_ARGUMENT],
-  ["--start-slave",   "-s", GetoptLong::NO_ARGUMENT],
+  ["--rehome-master", "-r", GetoptLong::NO_ARGUMENT],
+  ["--start-slave",   "-s", GetoptLong::NO_ARGUMENT]
 )
 
 opts.each do |opt, arg|
@@ -39,7 +39,6 @@ unless $old_master && $new_master && $username
   usage
 end
 
-
 def open_cx(host)
   host, port = host.split(":")
   port = port.to_i if port
@@ -121,7 +120,7 @@ def process_kill_thread
 end
 
 def wait_for_slave_catchup(master, slave)
-  while true
+  loop do
     master_info = master.query("show master status").first
     slave_info = slave.query("show slave status").first
     break if master_info['Position'] <= slave_info['Exec_Master_Log_Pos']
@@ -129,11 +128,9 @@ def wait_for_slave_catchup(master, slave)
 end
 
 def kill_query!(cx, id)
-  begin
-    cx.query("kill #{id}")
-  rescue Mysql2::Error => e
-    raise e unless e.errno == 1094 # unknown thread id error
-  end
+  cx.query("kill #{id}")
+rescue Mysql2::Error => e
+  raise e unless e.errno == 1094 # unknown thread id error
 end
 
 def swap_thread

data/gemfiles/rails3.2.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
-  remote: ../
+  remote: ..
   specs:
-    ar_mysql_flexmaster (0.6.0)
+    ar_mysql_flexmaster (1.0.2)
       activerecord
       activesupport
       mysql2
@@ -9,12 +9,12 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionmailer (3.2.22)
-      actionpack (= 3.2.22)
+    actionmailer (3.2.22.5)
+      actionpack (= 3.2.22.5)
       mail (~> 2.5.4)
-    actionpack (3.2.22)
-      activemodel (= 3.2.22)
-      activesupport (= 3.2.22)
+    actionpack (3.2.22.5)
+      activemodel (= 3.2.22.5)
+      activesupport (= 3.2.22.5)
       builder (~> 3.0.0)
       erubis (~> 2.7.0)
       journey (~> 1.0.4)
@@ -22,69 +22,69 @@ GEM
       rack-cache (~> 1.2)
       rack-test (~> 0.6.1)
       sprockets (~> 2.2.1)
-    activemodel (3.2.22)
-      activesupport (= 3.2.22)
+    activemodel (3.2.22.5)
+      activesupport (= 3.2.22.5)
       builder (~> 3.0.0)
-    activerecord (3.2.22)
-      activemodel (= 3.2.22)
-      activesupport (= 3.2.22)
+    activerecord (3.2.22.5)
+      activemodel (= 3.2.22.5)
+      activesupport (= 3.2.22.5)
       arel (~> 3.0.2)
       tzinfo (~> 0.3.29)
-    activeresource (3.2.22)
-      activemodel (= 3.2.22)
-      activesupport (= 3.2.22)
-    activesupport (3.2.22)
+    activeresource (3.2.22.5)
+      activemodel (= 3.2.22.5)
+      activesupport (= 3.2.22.5)
+    activesupport (3.2.22.5)
       i18n (~> 0.6, >= 0.6.4)
       multi_json (~> 1.0)
     arel (3.0.3)
     builder (3.0.4)
-    bump (0.5.3)
-    coderay (1.1.0)
+    bump (0.5.4)
+    coderay (1.1.1)
     erubis (2.7.0)
     hike (1.2.3)
-    i18n (0.7.0)
+    i18n (0.8.6)
+    isolated_server (0.4.12)
     journey (1.0.4)
-    json (1.8.3)
-    mail (2.5.4)
+    json (1.8.6)
+    mail (2.5.5)
       mime-types (~> 1.16)
       treetop (~> 1.4.8)
     metaclass (0.0.4)
     method_source (0.8.2)
     mime-types (1.25.1)
-    minitest (5.8.3)
+    minitest (5.10.3)
     mocha (1.1.0)
       metaclass (~> 0.0.1)
-    multi_json (1.11.2)
-    mysql2 (0.3.20)
-    mysql_isolated_server (0.5.3)
+    multi_json (1.12.1)
+    mysql2 (0.3.21)
     polyglot (0.3.5)
-    pry (0.10.3)
+    pry (0.10.4)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
     rack (1.4.7)
-    rack-cache (1.5.1)
+    rack-cache (1.7.0)
       rack (>= 0.4)
     rack-ssl (1.3.4)
       rack
     rack-test (0.6.3)
       rack (>= 1.0)
-    rails (3.2.22)
-      actionmailer (= 3.2.22)
-      actionpack (= 3.2.22)
-      activerecord (= 3.2.22)
-      activeresource (= 3.2.22)
-      activesupport (= 3.2.22)
+    rails (3.2.22.5)
+      actionmailer (= 3.2.22.5)
+      actionpack (= 3.2.22.5)
+      activerecord (= 3.2.22.5)
+      activeresource (= 3.2.22.5)
+      activesupport (= 3.2.22.5)
       bundler (~> 1.0)
-      railties (= 3.2.22)
-    railties (3.2.22)
-      actionpack (= 3.2.22)
-      activesupport (= 3.2.22)
+      railties (= 3.2.22.5)
+    railties (3.2.22.5)
+      actionpack (= 3.2.22.5)
+      activesupport (= 3.2.22.5)
       rack-ssl (~> 1.3.2)
       rake (>= 0.8.7)
       rdoc (~> 3.4)
       thor (>= 0.14.6, < 2.0)
-    rake (10.4.2)
+    rake (12.0.0)
     rdoc (3.12.2)
       json (~> 1.4)
     slop (3.6.0)
@@ -93,12 +93,12 @@ GEM
       multi_json (~> 1.0)
       rack (~> 1.0)
       tilt (~> 1.1, != 1.3.0)
-    thor (0.19.1)
+    thor (0.20.0)
     tilt (1.4.1)
     treetop (1.4.15)
       polyglot
       polyglot (>= 0.3.1)
-    tzinfo (0.3.46)
+    tzinfo (0.3.53)
     wwtd (1.3.0)
 
 PLATFORMS
@@ -107,14 +107,14 @@ PLATFORMS
 DEPENDENCIES
   ar_mysql_flexmaster!
   bump
+  isolated_server
   minitest
   mocha (~> 1.1.0)
   mysql2 (~> 0.3.0)
-  mysql_isolated_server (~> 0.5)
   pry
   rails (~> 3.2.0)
   rake
   wwtd
 
 BUNDLED WITH
-   1.11.2
+   1.15.4