activerecord-mysql-reconnect 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 71e451da7545c291e59d8f60e217b79e079012b9
-  data.tar.gz: e1b74d9e7e5c7a099c74cd0c53e919a4c7519858
+SHA256:
+  metadata.gz: b22787c59f28400f81aa1dc6647ecd14ceca54ecb648285ddee05e96c652c90f
+  data.tar.gz: 0f97dc3481ca776b51390fb01ed799df7043be4e20299534726f51e75b584c88
 SHA512:
-  metadata.gz: 66a5760999823b8d478147048333654dc3c2decbbb9d4649b49712f5f36701fa02a9fa5e634da909ac8f1632c4ce04c177f18b9f851bdbb669af32b2f127945a
-  data.tar.gz: 04ed93663318b7ef51c7e3a8f71da99f46b0e286db93555b1bc6384a558d582b6840b5d8519ce7dff436db7a372ce083d89523a7e1721a258618659c98519231
+  metadata.gz: d7da6b4b5ff50f35254f9bdc9f14d040cb8930d483d35b574edf1d7ec8c024ee9cc4455fdeb85589ec2c920e299bbf6d0c5cf6f896f36efb70d2fc69ec90e8e1
+  data.tar.gz: cd45c8a2b11f9db45830da921a755dab9db9793910323c2b36f05da3c27ebdab51577e3de6d7566d9fb1a8b60b38a22ea817bf21c70b0f4a8f21a68c8559bb6d

data/.travis.yml

@@ -2,10 +2,9 @@ dist: trusty
 sudo: required
 language: ruby
 rvm:
-  - 2.1.9
-  - 2.2.6
-  - 2.3.4
-  - 2.4.1
+  - 2.3.6
+  - 2.4.4
+  - 2.5.1
 before_install:
   - docker-compose up -d
   - function mysql_ping { mysqladmin -u root -h 127.0.0.1 -ppassword ping > /dev/null 2> /dev/null; }
@@ -18,16 +17,11 @@ gemfile:
   - gemfiles/activerecord_4.2.gemfile
   - gemfiles/activerecord_5.0.gemfile
   - gemfiles/activerecord_5.1.gemfile
+  - gemfiles/activerecord_5.2.gemfile
 env:
   matrix:
     - ACTIVERECORD_MYSQL_RECONNECT_ENGINE=InnoDB
     - ACTIVERECORD_MYSQL_RECONNECT_ENGINE=MyISAM
-matrix:
-  exclude:
-    - rvm: 2.1.9
-      gemfile: gemfiles/activerecord_5.0.gemfile
-    - rvm: 2.1.9
-      gemfile: gemfiles/activerecord_5.1.gemfile
 addons:
   apt:
     packages:

data/Appraisals

@@ -1,5 +1,6 @@
 appraise "activerecord-4.2" do
   gem "activerecord", "~> 4.2.0"
+  gem "mysql2", "< 0.5"
 end
 
 appraise "activerecord-5.0" do
@@ -9,3 +10,7 @@ end
 appraise "activerecord-5.1" do
   gem "activerecord", "~> 5.1.0"
 end
+
+appraise "activerecord-5.2" do
+  gem "activerecord", "~> 5.2.0"
+end

data/README.md

@@ -66,6 +66,15 @@ ActiveRecord::Base.without_retry do
 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

data/gemfiles/activerecord_4.2.gemfile

@@ -3,5 +3,6 @@
 source "https://rubygems.org"
 
 gem "activerecord", "~> 4.2.0"
+gem "mysql2", "< 0.5"
 
 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/lib/activerecord/mysql/reconnect.rb

@@ -29,25 +29,24 @@ module Activerecord::Mysql::Reconnect
     Mysql2::Error,
   ]
 
-  HANDLE_R_ERROR_MESSAGES = [
-    'Lost connection to MySQL server during query',
-  ]
-
-  HANDLE_RW_ERROR_MESSAGES = [
-    'MySQL server has gone away',
-    'Server shutdown in progress',
-    'closed MySQL connection',
-    "Can't connect to MySQL server",
-    'Query execution was interrupted',
-    'Access denied for user',
-    'The MySQL server is running with the --read-only option',
-    "Can't connect to local MySQL server", # When running in local sandbox, or using a socket file
-    'Unknown MySQL server host', # For DNS blips
-    "Lost connection to MySQL server at 'reading initial communication packet'",
-    "MySQL client is not connected",
-  ]
-
-  HANDLE_ERROR_MESSAGES = HANDLE_R_ERROR_MESSAGES + HANDLE_RW_ERROR_MESSAGES
+  @@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
 
@@ -55,6 +54,14 @@ module Activerecord::Mysql::Reconnect
   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
@@ -195,7 +202,7 @@ module Activerecord::Mysql::Reconnect
         return false
       end
 
-      unless Regexp.union(HANDLE_ERROR_MESSAGES) =~ e.message
+      unless Regexp.union(@@handle_r_error_messages.values + @@handle_rw_error_messages.values) =~ e.message
         return false
       end
 
@@ -204,7 +211,7 @@ module Activerecord::Mysql::Reconnect
           return false
         end
 
-        if retry_mode != :force and Regexp.union(HANDLE_R_ERROR_MESSAGES) =~ e.message
+        if retry_mode != :force and Regexp.union(@@handle_r_error_messages.values) =~ e.message
           return false
         end
       end

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

@@ -1,7 +1,7 @@
 module Activerecord
   module Mysql
     module Reconnect
-      VERSION = '0.4.1'
+      VERSION = '0.4.2'
     end
   end
 end

data/spec/activerecord-mysql-reconnect_spec.rb

@@ -451,27 +451,31 @@ describe 'activerecord-mysql-reconnect' do
       "%s (cause: %s, sql: SELECT `employees`.* FROM `employees`, connection: host=127.0.0.1;database=employees;username=root)"
     end
 
+    let(:mysql_error) do
+      Mysql2::Error.const_defined?(:ConnectionError) ? Mysql2::Error::ConnectionError : Mysql2::Error
+    end
+
     before do
-      allow_any_instance_of(Mysql2::Error).to receive(:message).and_return('Lost connection to MySQL server during query')
+      allow_any_instance_of(mysql_error).to receive(:message).and_return('Lost connection to MySQL server during query')
     end
 
     context "when retry failed " do
       specify do
         expect(ActiveRecord::Base.logger).to receive(:warn).with(warning_template % [
           "MySQL server has gone away. Trying to reconnect in 0.5 seconds.",
-          "Mysql2::Error: Lost connection to MySQL server during query: SELECT `employees`.* FROM `employees` [ActiveRecord::StatementInvalid]",
+          "#{mysql_error}: Lost connection to MySQL server during query: SELECT `employees`.* FROM `employees` [ActiveRecord::StatementInvalid]",
         ])
 
         (1.0..4.5).step(0.5).each do |sec|
           expect(ActiveRecord::Base.logger).to receive(:warn).with(warning_template % [
             "MySQL server has gone away. Trying to reconnect in #{sec} seconds.",
-            "Lost connection to MySQL server during query [Mysql2::Error]",
+            "Lost connection to MySQL server during query [#{mysql_error}]",
           ])
         end
 
         expect(ActiveRecord::Base.logger).to receive(:warn).with(warning_template % [
           "Query retry failed.",
-          "Lost connection to MySQL server during query [Mysql2::Error]",
+          "Lost connection to MySQL server during query [#{mysql_error}]",
         ])
 
         expect(Employee.all.length).to eq 1000
@@ -479,7 +483,7 @@ describe 'activerecord-mysql-reconnect' do
 
         expect {
           Employee.all.length
-        }.to raise_error(Mysql2::Error)
+        }.to raise_error(mysql_error)
       end
     end
 
@@ -487,7 +491,7 @@ describe 'activerecord-mysql-reconnect' do
       specify do
         expect(ActiveRecord::Base.logger).to receive(:warn).with(warning_template % [
           "MySQL server has gone away. Trying to reconnect in 0.5 seconds.",
-          "Mysql2::Error: Lost connection to MySQL server during query: SELECT `employees`.* FROM `employees` [ActiveRecord::StatementInvalid]",
+          "#{mysql_error}: Lost connection to MySQL server during query: SELECT `employees`.* FROM `employees` [ActiveRecord::StatementInvalid]",
         ])
 
         expect(Employee.all.length).to eq 1000
@@ -496,4 +500,31 @@ describe 'activerecord-mysql-reconnect' do
       end
     end
   end
+
+  # NOTE: The following test need to execute at the last
+  context "when the custom error is happened" do
+    before do
+      allow_any_instance_of(Mysql2::Error).to receive(:message).and_return('ZapZapZap')
+      Activerecord::Mysql::Reconnect.handle_rw_error_messages.update(zapzapzap: 'ZapZapZap')
+    end
+
+    specify do
+      th = thread_start {
+        emp = Employee.create(
+          :emp_no     => 9999,
+          :birth_date => Time.now,
+          # wait 10 sec
+          :first_name => "' + sleep(10) + '",
+          :last_name  => 'Tiger',
+          :hire_date  => Time.now
+        )
+
+        expect(emp.id).to eq 1001
+        expect(emp.emp_no).to eq 9999
+      }
+
+      MysqlServer.restart
+      th.join
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-mysql-reconnect
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Genki Sugawara
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-12 00:00:00.000000000 Z
+date: 2018-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -116,6 +116,7 @@ files:
 - gemfiles/activerecord_4.2.gemfile
 - gemfiles/activerecord_5.0.gemfile
 - gemfiles/activerecord_5.1.gemfile
+- gemfiles/activerecord_5.2.gemfile
 - lib/activerecord-mysql-reconnect.rb
 - lib/activerecord/mysql/reconnect.rb
 - lib/activerecord/mysql/reconnect/abstract_mysql_adapter_ext.rb
@@ -150,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: It is the library to reconnect automatically when ActiveRecord is disconnected