activerecord-mysql-reconnect-new 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 40cb9b6f448d37763a9d1e12f54ab8ea980a31127a813865f11b8addf9a8cb7c
+  data.tar.gz: 55db8677ac2c73a1fb702ea25670a596dc5f614de5142fd6f83c02d458fde8df
+SHA512:
+  metadata.gz: b9bdff5e005aed4038a7460feb0b1546d1473d3346d3471231442a6bed1d690fe3261602e34b4f10400a6315830b6b07e2eb316a9be31f22276fa9f40555229d
+  data.tar.gz: ea1fd650384e2589123b212060b98187d8f0d964c95cabbe2a80e820b408310a1c6c7e1b4454360d052d48ac9aae195d06d858f6e5907c800d90b28c8b10db02

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/.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml

data/.idea/activerecord-mysql-reconnect.iml

@@ -0,0 +1,22 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="ModuleRunConfigurationManager">
+    <shared />
+  </component>
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/features" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/spec" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v1.17.2, ruby-2.6.8-p205) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v12.3.3, ruby-2.6.8-p205) [gem]" level="application" />
+  </component>
+  <component name="RakeTasksCache">
+    <option name="myRootTask">
+      <RakeTaskImpl id="rake" />
+    </option>
+  </component>
+</module>

data/.idea/misc.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectRootManager" version="2" project-jdk-name="ruby-2.6.8-p205" project-jdk-type="RUBY_SDK" />
+</project>

data/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/activerecord-mysql-reconnect.iml" filepath="$PROJECT_DIR$/.idea/activerecord-mysql-reconnect.iml" />
+    </modules>
+  </component>
+</project>

data/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

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,28 @@
+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-6.1" do
+  gem "activerecord", "~> 6.1.5"
+end
+
+appraise "activerecord-master" do
+  gem "activerecord", git: "https://github.com/rails/rails.git"
+end

data/ChangeLog

@@ -0,0 +1,35 @@
+activerecord-mysql-reconnect-new 0.6.0 (Jul 14, 2022)
+
+	* Support Rails 6.1
+
+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-new.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-new'
+  spec.version       = Activerecord::Mysql::Reconnect::VERSION
+  spec.authors       = ['Sundeep Yama', 'Lee Hester']
+  spec.email         = ['sundeepyama@gmail.com', 'lhester@simplenexus.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/SimpleNexus/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_6.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 6.1.5"
+
+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/abstract_mysql_adapter_ext.rb

@@ -0,0 +1,46 @@
+module Activerecord::Mysql::Reconnect::ExecuteWithReconnect
+  def execute(sql, name = nil)
+    retryable(sql, name) do |sql_names|
+      retval = nil
+
+      sql_names.each do |s, n|
+        retval = super(s, n)
+      end
+
+      retval
+    end
+  end
+end
+
+class ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter
+  prepend Activerecord::Mysql::Reconnect::ExecuteWithReconnect
+
+  private
+
+  def retryable(sql, name, &block)
+    block_with_reconnect = nil
+    sql_names = [[sql, name]]
+    transaction = current_transaction
+
+    if sql =~ /\ABEGIN\z/i and transaction.is_a?(ActiveRecord::ConnectionAdapters::NullTransaction)
+      def transaction.state; nil; end
+    end
+
+    Activerecord::Mysql::Reconnect.retryable(
+      :proc => proc {
+        (block_with_reconnect || block).call(sql_names)
+      },
+      :on_error => proc {
+        unless block_with_reconnect
+          block_with_reconnect = proc do |i|
+            reconnect_without_retry!
+            block.call(i)
+          end
+        end
+      },
+      :sql => sql,
+      :retry_mode => Activerecord::Mysql::Reconnect.retry_mode,
+      :connection => @connection
+    )
+  end
+end

data/lib/activerecord/mysql/reconnect/base_ext.rb

@@ -0,0 +1,32 @@
+class ActiveRecord::Base
+  class_attribute :execution_tries,      :instance_accessor => false
+  class_attribute :execution_retry_wait, :instance_accessor => false
+  class_attribute :enable_retry,         :instance_accessor => false
+
+  RETRY_MODES = [:r, :rw, :force]
+  DEFAULT_RETRY_MODE = :r
+
+  class << self
+    def retry_mode=(v)
+       Activerecord::Mysql::Reconnect.retry_mode = v
+    end
+
+    def retry_mode
+       Activerecord::Mysql::Reconnect.retry_mode
+    end
+
+    def retry_databases=(v)
+       Activerecord::Mysql::Reconnect.retry_databases = v
+    end
+
+    def retry_databases
+       Activerecord::Mysql::Reconnect.retry_databases
+    end
+
+    def without_retry
+      Activerecord::Mysql::Reconnect.without_retry do
+        yield
+      end
+    end
+  end
+end

data/lib/activerecord/mysql/reconnect/connection_pool_ext.rb

@@ -0,0 +1,18 @@
+module Activerecord::Mysql::Reconnect::NewConnectionWithRetry
+  def new_connection
+    if defined?(db_config)
+      Activerecord::Mysql::Reconnect.retryable(
+        :proc => proc { super },
+        :connection => db_config.configuration_hash
+      )
+    else
+      Activerecord::Mysql::Reconnect.retryable(
+        :proc => proc { super },
+        :connection => spec.config,
+      )
+    end
+  end
+end
+class ActiveRecord::ConnectionAdapters::ConnectionPool
+  prepend Activerecord::Mysql::Reconnect::NewConnectionWithRetry
+end

data/lib/activerecord/mysql/reconnect/mysql2_adapter_ext.rb

@@ -0,0 +1,13 @@
+module Activerecord::Mysql::Reconnect::ReconnectWithRetry
+  def reconnect!
+    Activerecord::Mysql::Reconnect.retryable(
+      :proc => proc { super },
+      :connection => @connection
+    )
+  end
+end
+
+class ActiveRecord::ConnectionAdapters::Mysql2Adapter
+  alias_method :reconnect_without_retry!, :reconnect!
+  prepend Activerecord::Mysql::Reconnect::ReconnectWithRetry
+end

data/lib/activerecord/mysql/reconnect/null_transaction_ext.rb

@@ -0,0 +1,9 @@
+module Activerecord::Mysql::Reconnect::NullTransactionExt
+  def state
+    nil
+  end
+end
+
+class ActiveRecord::ConnectionAdapters::NullTransaction
+  prepend Activerecord::Mysql::Reconnect::NullTransactionExt
+end

data/lib/activerecord/mysql/reconnect/version.rb

@@ -0,0 +1,7 @@
+module Activerecord
+  module Mysql
+    module Reconnect
+      VERSION = '0.6.0'
+    end
+  end
+end