activerecord-mysql-reconnect-before-retry 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e74e264eb347ad48e9f32999a598468ff82ef673beeeceb007dc16774faeece4
+  data.tar.gz: 8cb24217590520df18e4cb630a3fd410f086f72d59ea8c138a55f8b984105fc2
+SHA512:
+  metadata.gz: e660f5073b7863071bd6722392957b863e2f6df9e301c64b12f78bd349802d799a92f76cf909f29aee7182f3fc355c5171b7c3ef56596254228bbea0f2aef231
+  data.tar.gz: 2aeadc0cb5148069ab8b61f367d5793c0f2879e0c9b5880908f56cbfb65bc34d3d0b26ebb0cc6cee0bedf05bd3b3ff11ede24aa74667d3650ffcea97b7afade5

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--colour
+--format documentation

data/.travis.yml

@@ -0,0 +1,45 @@
+dist: trusty
+sudo: required
+language: ruby
+rvm:
+  - 2.3.8
+  - 2.4.6
+  - 2.5.5
+  - 2.6.3
+  - 2.7.0
+before_install:
+  - docker-compose up -d
+  - function mysql_ping { mysqladmin -u root -h 127.0.0.1 -ppassword ping > /dev/null 2> /dev/null; }
+  - for i in {1..60}; do mysql_ping && break; sleep 1; done
+  - gem install bundler
+  - docker-compose stop
+script:
+  - bundle exec rake
+gemfile:
+  - gemfiles/activerecord_4.2.gemfile
+  - gemfiles/activerecord_5.0.gemfile
+  - gemfiles/activerecord_5.1.gemfile
+  - gemfiles/activerecord_5.2.gemfile
+  - gemfiles/activerecord_6.0.gemfile
+  - gemfiles/activerecord_master.gemfile
+env:
+  matrix:
+    - ACTIVERECORD_MYSQL_RECONNECT_ENGINE=InnoDB
+    - ACTIVERECORD_MYSQL_RECONNECT_ENGINE=MyISAM
+jobs:
+  exclude:
+    - rvm: 2.3.8
+      gemfile: gemfiles/activerecord_6.0.gemfile
+    - rvm: 2.3.8
+      gemfile: gemfiles/activerecord_master.gemfile
+    - rvm: 2.4.6
+      gemfile: gemfiles/activerecord_6.0.gemfile
+    - rvm: 2.4.6
+      gemfile: gemfiles/activerecord_master.gemfile
+    - rvm: 2.7.0
+      gemfile: gemfiles/activerecord_4.2.gemfile
+addons:
+  apt:
+    packages:
+      - mysql-client-core-5.6
+      - mysql-client-5.6

data/Appraisals

@@ -0,0 +1,24 @@
+appraise "activerecord-4.2" do
+  gem "activerecord", "~> 4.2.0"
+  gem "mysql2", "< 0.5"
+end
+
+appraise "activerecord-5.0" do
+  gem "activerecord", "~> 5.0.0"
+end
+
+appraise "activerecord-5.1" do
+  gem "activerecord", "~> 5.1.0"
+end
+
+appraise "activerecord-5.2" do
+  gem "activerecord", "~> 5.2.0"
+end
+
+appraise "activerecord-6.0" do
+  gem "activerecord", "~> 6.0.2"
+end
+
+appraise "activerecord-master" do
+  gem "activerecord", git: "https://github.com/rails/rails.git"
+end

data/ChangeLog

@@ -0,0 +1,31 @@
+activerecord-mysql-reconnect 0.4.1 (Aug 8, 2016)
+
+	* Support AR 5.0 (RP#5 @ssig33)
+	* Fix test (use docker-compose)
+
+activerecord-mysql-reconnect 0.4.0 (Mar 22, 2016)
+
+	* Remove `retryable_transaction`
+	* Disable support AR 3.x 4.0
+
+activerecord-mysql-reconnect 0.3.3 (Jan 18, 2014)
+
+	* use BigDecimal for sleep
+	* add handling error ('The MySQL server is running with the --read-only...')
+
+activerecord-mysql-reconnect 0.3.1 (Jan 9, 2014)
+
+	* Retry mode is added
+
+activerecord-mysql-reconnect 0.3.0 (Jan 9, 2014)
+
+	* Retry is disabled by default
+	* Read-only mode is added
+
+activerecord-mysql-reconnect 0.2.0 (Jan 4, 2014)
+
+	* Retry transaction is supported
+
+activerecord-mysql-reconnect 0.1.0 (Oct 11, 2013)
+
+	* activerecord-mysql-reconnect is released

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Genki Sugawara
+
+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,124 @@
+# activerecord-mysql-reconnect
+
+It is the library to reconnect automatically when ActiveRecord is disconnected from MySQL.
+
+[![Gem Version](https://badge.fury.io/rb/activerecord-mysql-reconnect.svg)](http://badge.fury.io/rb/activerecord-mysql-reconnect)
+[![Build Status](https://travis-ci.org/winebarrel/activerecord-mysql-reconnect.svg?branch=master)](https://travis-ci.org/winebarrel/activerecord-mysql-reconnect)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activerecord-mysql-reconnect'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord-mysql-reconnect
+
+## Usage
+
+```ruby
+require 'active_record'
+require 'activerecord-mysql-reconnect'
+require 'logger'
+
+ActiveRecord::Base.establish_connection(
+  adapter:  'mysql2',
+  host:     '127.0.0.1',
+  username: 'root',
+  database: 'employees',
+)
+
+ActiveRecord::Base.logger = Logger.new($stdout)
+ActiveRecord::Base.logger.formatter = proc {|_, _, _, message| "#{message}\n" }
+ActiveRecord::Base.enable_retry = true
+ActiveRecord::Base.execution_tries = 3
+
+class Employee < ActiveRecord::Base; end
+
+p Employee.count
+system('sudo /etc/init.d/mysqld restart')
+p Employee.count
+```
+
+```
+shell> ruby test.rb
+   (64.1ms)  SELECT COUNT(*) FROM `employees`
+300024
+Stopping mysqld:                                           [  OK  ]
+Starting mysqld:                                           [  OK  ]
+   (0.4ms)  SELECT COUNT(*) FROM `employees`
+Mysql2::Error: MySQL server has gone away: SELECT COUNT(*) FROM `employees`
+MySQL server has gone away. Trying to reconnect in 0.5 seconds. (cause: Mysql2::Error: MySQL server has gone away: SELECT COUNT(*) FROM `employees` [ActiveRecord::StatementInvalid], connection: host=127.0.0.1;database=employees;username=root)
+   (101.5ms)  SELECT COUNT(*) FROM `employees`
+300024
+```
+
+### without_retry
+
+```ruby
+ActiveRecord::Base.without_retry do
+  Employee.count
+end
+```
+
+### Add a retry error message
+
+```ruby
+Activerecord::Mysql::Reconnect.handle_rw_error_messages.update(
+  zapzapzap: 'ZapZapZap'
+)
+# or `Activerecord::Mysql::Reconnect.handle_r_error_messages...`
+```
+
+## Use on rails
+
+### Gemfile
+
+```ruby
+gem 'activerecord-mysql-reconnect'
+```
+
+### environment file
+
+```ruby
+MyApp::Application.configure do
+  ...
+  config.active_record.enable_retry = true
+  #config.active_record.retry_databases = :employees
+  # e.g. [:employees]
+  #      ['employees', 'localhost:test', '192.168.1.1:users']
+  #      ['192.168.%:emp\_all']
+  #      ['emp%']
+  # retry_databases -> nil: retry all databases (default)
+  config.active_record.execution_tries = 10 # times
+  # execution_tries -> 0: retry indefinitely
+  config.active_record.execution_retry_wait = 1.5 # sec
+  config.active_record.retry_mode = :rw # default: `:r`, valid values: `:r`, `:rw`, `:force`
+  ...
+ene
+```
+
+## Retry mode
+
+* `:r`      Retry only SELECT / SHOW / SET
+* `:rw`     Retry in all SQL, but does not retry if `Lost connection` has happened in write SQL
+* `:force`  Retry in all SQL
+
+## Run tests
+
+It requires the following:
+
+* Docker
+* Docker Compose
+
+```sh
+bundle install
+bundle exec appraisal install
+bundle exec appraisal activerecord-4.2 rake
+bundle exec appraisal activerecord-5.0 rake
+```

data/Rakefile

@@ -0,0 +1,5 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec

data/activerecord-mysql-reconnect.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'activerecord/mysql/reconnect/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'activerecord-mysql-reconnect-before-retry'
+  spec.version       = Activerecord::Mysql::Reconnect::VERSION
+  spec.authors       = ['Genki Sugawara']
+  spec.email         = ['sugawara@cookpad.com']
+  spec.description   = %q{It is the library to reconnect automatically when ActiveRecord is disconnected from MySQL.}
+  spec.summary       = spec.description
+  spec.homepage      = 'https://github.com/winebarrel/activerecord-mysql-reconnect'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  # '~> 4.2.6'
+  spec.add_dependency 'activerecord'
+  spec.add_dependency 'mysql2'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '>= 3.0.0'
+  spec.add_development_dependency "appraisal"
+end

data/docker-compose.yml

@@ -0,0 +1,6 @@
+mysql_for_ar_mysql_reconn:
+  image: "mysql:5.6"
+  ports:
+    - "14407:3306"
+  environment:
+    MYSQL_ALLOW_EMPTY_PASSWORD: "yes"

data/gemfiles/activerecord_4.2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 4.2.0"
+gem "mysql2", "< 0.5"
+
+gemspec path: "../"

data/gemfiles/activerecord_5.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.0.0"
+
+gemspec path: "../"

data/gemfiles/activerecord_5.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.1.0"
+
+gemspec path: "../"

data/gemfiles/activerecord_5.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.2.0"
+
+gemspec path: "../"

data/gemfiles/activerecord_6.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 6.0.2"
+
+gemspec path: "../"

data/gemfiles/activerecord_master.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", git: "https://github.com/rails/rails.git"
+
+gemspec path: "../"

data/lib/activerecord-mysql-reconnect.rb

@@ -0,0 +1,5 @@
+require 'active_support'
+
+ActiveSupport.on_load :active_record do
+  require_relative 'activerecord/mysql/reconnect'
+end

data/lib/activerecord/mysql/reconnect.rb

@@ -0,0 +1,282 @@
+require 'mysql2'
+require 'logger'
+require 'bigdecimal'
+require 'strscan'
+
+require 'active_record'
+require 'active_record/connection_adapters/abstract_adapter'
+require 'active_record/connection_adapters/abstract_mysql_adapter'
+require 'active_record/connection_adapters/mysql2_adapter'
+require 'active_record/connection_adapters/abstract/connection_pool'
+require 'active_record/connection_adapters/abstract/transaction'
+
+require 'activerecord/mysql/reconnect/version'
+require 'activerecord/mysql/reconnect/base_ext'
+
+require 'activerecord/mysql/reconnect/abstract_mysql_adapter_ext'
+require 'activerecord/mysql/reconnect/mysql2_adapter_ext'
+require 'activerecord/mysql/reconnect/connection_pool_ext'
+require 'activerecord/mysql/reconnect/null_transaction_ext'
+
+module Activerecord::Mysql::Reconnect
+  DEFAULT_EXECUTION_TRIES = 3
+  DEFAULT_EXECUTION_RETRY_WAIT = 0.5
+
+  WITHOUT_RETRY_KEY = 'activerecord-mysql-reconnect-without-retry'
+
+  HANDLE_ERROR = [
+    ActiveRecord::StatementInvalid,
+    Mysql2::Error,
+  ]
+
+  @@handle_r_error_messages = {
+    lost_connection: 'Lost connection to MySQL server during query',
+  }
+
+  @@handle_rw_error_messages = {
+    gone_away: 'MySQL server has gone away',
+    server_shutdown: 'Server shutdown in progress',
+    closed_connection: 'closed MySQL connection',
+    cannot_connect: "Can't connect to MySQL server",
+    interrupted: 'Query execution was interrupted',
+    access_denied: 'Access denied for user',
+    read_only: 'The MySQL server is running with the --read-only option',
+    cannot_connect_to_local: "Can't connect to local MySQL server", # When running in local sandbox, or using a socket file
+    unknown_host: 'Unknown MySQL server host', # For DNS blips
+    lost_connection: "Lost connection to MySQL server at 'reading initial communication packet'",
+    not_connected: "MySQL client is not connected",
+    killed: 'Connection was killed',
+  }
+
+  READ_SQL_REGEXP = /\A\s*(?:SELECT|SHOW|SET)\b/i
+
+  RETRY_MODES = [:r, :rw, :force]
+  DEFAULT_RETRY_MODE = :r
+
+  class << self
+    def handle_r_error_messages
+      @@handle_r_error_messages
+    end
+
+    def handle_rw_error_messages
+      @@handle_rw_error_messages
+    end
+
+    def execution_tries
+      ActiveRecord::Base.execution_tries || DEFAULT_EXECUTION_TRIES
+    end
+
+    def execution_retry_wait
+      wait = ActiveRecord::Base.execution_retry_wait || DEFAULT_EXECUTION_RETRY_WAIT
+      wait.kind_of?(BigDecimal) ? wait : BigDecimal(wait.to_s)
+    end
+
+    def enable_retry
+      !!ActiveRecord::Base.enable_retry
+    end
+
+    def retry_mode=(v)
+      unless RETRY_MODES.include?(v)
+        raise "Invalid retry_mode. Please set one of the following: #{RETRY_MODES.map {|i| i.inspect }.join(', ')}"
+      end
+
+      @activerecord_mysql_reconnect_retry_mode = v
+    end
+
+    def retry_mode
+      @activerecord_mysql_reconnect_retry_mode || DEFAULT_RETRY_MODE
+    end
+
+    def before_retry=(v)
+      @activerecord_mysql_reconnect_before_retry = v
+    end
+
+    def before_retry
+      @activerecord_mysql_reconnect_before_retry
+    end
+
+    def retry_databases=(v)
+      v ||= []
+
+      unless v.kind_of?(Array)
+        v = [v]
+      end
+
+      @activerecord_mysql_reconnect_retry_databases = v.map do |database|
+        if database.instance_of?(Symbol)
+          database = Regexp.escape(database.to_s)
+          [/.*/, /\A#{database}\z/]
+        else
+          host = '%'
+          database = database.to_s
+
+          if database =~ /:/
+            host, database = database.split(':', 2)
+          end
+
+          [create_pattern_match_regex(host), create_pattern_match_regex(database)]
+        end
+      end
+    end
+
+    def retry_databases
+      @activerecord_mysql_reconnect_retry_databases || []
+    end
+
+    def retryable(opts)
+      block        = opts.fetch(:proc)
+      on_error     = opts[:on_error]
+      conn         = opts[:connection]
+      sql          = opts[:sql]
+      tries        = self.execution_tries
+      before_retry = self.before_retry
+      retval       = nil
+
+      retryable_loop(tries) do |n|
+        begin
+          retval = block.call
+          break
+        rescue => e
+          if enable_retry and (tries.zero? or n < tries) and should_handle?(e, opts)
+            on_error.call if on_error
+
+            if before_retry.is_a?(Proc)
+              logger.warn("MySQL server has gone away. Running before retry proc")
+              before_retry.call(e, sql, conn)
+            end
+
+            wait = self.execution_retry_wait * n
+
+            logger.warn("MySQL server has gone away. Trying to reconnect in #{wait.to_f} seconds. (#{build_error_message(e, sql, conn)})")
+            sleep(wait)
+            next
+          else
+            if enable_retry and n > 1
+              logger.warn("Query retry failed. (#{build_error_message(e, sql, conn)})")
+            end
+
+            raise e
+          end
+        end
+      end
+
+      return retval
+    end
+
+    def logger
+      if defined?(Rails)
+        Rails.logger || ActiveRecord::Base.logger || Logger.new($stderr)
+      else
+        ActiveRecord::Base.logger || Logger.new($stderr)
+      end
+    end
+
+    def without_retry
+      begin
+        Thread.current[WITHOUT_RETRY_KEY] = true
+        yield
+      ensure
+        Thread.current[WITHOUT_RETRY_KEY] = nil
+      end
+    end
+
+    def without_retry?
+      !!Thread.current[WITHOUT_RETRY_KEY]
+    end
+
+    private
+
+    def retryable_loop(n)
+      if n.zero?
+        loop { n += 1 ; yield(n) }
+      else
+        n.times {|i| yield(i + 1) }
+      end
+    end
+
+    def should_handle?(e, opts = {})
+      sql        = opts[:sql]
+      retry_mode = opts[:retry_mode]
+      conn       = opts[:connection]
+
+      if without_retry?
+        return false
+      end
+
+      if conn and not retry_databases.empty?
+        conn_info = connection_info(conn)
+
+        included = retry_databases.any? do |host, database|
+          host =~ conn_info[:host] and database =~ conn_info[:database]
+        end
+
+        return false unless included
+      end
+
+      unless HANDLE_ERROR.any? {|i| e.kind_of?(i) }
+        return false
+      end
+
+      unless Regexp.union(@@handle_r_error_messages.values + @@handle_rw_error_messages.values) =~ e.message
+        return false
+      end
+
+      if sql and READ_SQL_REGEXP !~ sql
+        if retry_mode == :r
+          return false
+        end
+
+        if retry_mode != :force and Regexp.union(@@handle_r_error_messages.values) =~ e.message
+          return false
+        end
+      end
+
+      return true
+    end
+
+    def connection_info(conn)
+      conn_info = {}
+
+      if conn.kind_of?(Mysql2::Client)
+        [:host, :database, :username].each {|k| conn_info[k] = conn.query_options[k] }
+      elsif conn.kind_of?(Hash)
+        conn_info = conn.dup
+      end
+
+      return conn_info
+    end
+
+    def create_pattern_match_regex(str)
+      ss = StringScanner.new(str)
+      buf = []
+
+      until ss.eos?
+        if (tok = ss.scan(/[^\\%_]+/))
+          buf << Regexp.escape(tok)
+        elsif (tok = ss.scan(/\\/))
+          buf << Regexp.escape(ss.getch)
+        elsif (tok = ss.scan(/%/))
+          buf << '.*'
+        elsif (tok = ss.scan(/_/))
+          buf << '.'
+        else
+          raise 'must not happen'
+        end
+      end
+
+      /\A#{buf.join}\z/
+    end
+
+    def build_error_message(e, sql, conn)
+      msgs = {cause: "#{e.message} [#{e.class}]"}
+      msgs[:sql] = sql if sql
+
+      if conn
+        conn_info = connection_info(conn)
+        msgs[:connection] = [:host, :database, :username].map {|k| "#{k}=#{conn_info[k]}" }.join(";")
+      end
+
+      msgs.map {|k, v| "#{k}: #{v}" }.join(", ")
+    end
+  end # end of class methods
+end