activerecord-mysql-reconnect 0.4.1.beta → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c37f85305063d95208c4a30ace243a62709d0d25
-  data.tar.gz: 55d1bf38531ede94d81d977e33f3def41719f09d
+  metadata.gz: 71e451da7545c291e59d8f60e217b79e079012b9
+  data.tar.gz: e1b74d9e7e5c7a099c74cd0c53e919a4c7519858
 SHA512:
-  metadata.gz: a83fe523cc08085211d963711f06264d20728cf8d7e3d3c9458cbd57f77faee1a2e597bd8487bc804bc81d83a23cdec747732a4d28c1b670ebe12de6f9376e2d
-  data.tar.gz: 17ce95bde54d2b35ef1a9f92dd9a6546dd1e6f02a85fd8bdc276c6d49133e95e960c1f14730e44d8c5f82e0e984772a0f12cd7763111a7c5ded6e6dac5d8c388
+  metadata.gz: 66a5760999823b8d478147048333654dc3c2decbbb9d4649b49712f5f36701fa02a9fa5e634da909ac8f1632c4ce04c177f18b9f851bdbb669af32b2f127945a
+  data.tar.gz: 04ed93663318b7ef51c7e3a8f71da99f46b0e286db93555b1bc6384a558d582b6840b5d8519ce7dff436db7a372ce083d89523a7e1721a258618659c98519231

data/.gitignore

@@ -18,3 +18,4 @@ tmp
 test.rb
 *.bak
 *.swp
+/gemfiles/*.lock

data/.travis.yml

@@ -3,20 +3,21 @@ sudo: required
 language: ruby
 rvm:
   - 2.1.9
-  - 2.2.5
-  - 2.3.1
+  - 2.2.6
+  - 2.3.4
+  - 2.4.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; }
   - for i in {1..60}; do mysql_ping && break; sleep 1; done
   - gem install bundler
   - docker-compose stop
-  - sudo rm -rf /tmp/mysql_for_ar_mysql_reconn
 script:
   - bundle exec rake
 gemfile:
   - gemfiles/activerecord_4.2.gemfile
   - gemfiles/activerecord_5.0.gemfile
+  - gemfiles/activerecord_5.1.gemfile
 env:
   matrix:
     - ACTIVERECORD_MYSQL_RECONNECT_ENGINE=InnoDB
@@ -25,6 +26,8 @@ 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

@@ -5,3 +5,7 @@ end
 appraise "activerecord-5.0" do
   gem "activerecord", "~> 5.0.0"
 end
+
+appraise "activerecord-5.1" do
+  gem "activerecord", "~> 5.1.0"
+end

data/docker-compose.yml

@@ -1,8 +1,6 @@
 mysql_for_ar_mysql_reconn:
   image: "mysql:5.6"
   ports:
-    - "3306:3306"
+    - "14407:3306"
   environment:
-    MYSQL_ROOT_PASSWORD: password
-  volumes:
-    - /tmp/mysql_for_ar_mysql_reconn:/var/lib/mysql
+    MYSQL_ALLOW_EMPTY_PASSWORD: "yes"

data/gemfiles/activerecord_4.2.gemfile

@@ -4,4 +4,4 @@ source "https://rubygems.org"
 
 gem "activerecord", "~> 4.2.0"
 
-gemspec :path => "../"
+gemspec path: "../"

data/gemfiles/activerecord_5.0.gemfile

@@ -4,4 +4,4 @@ source "https://rubygems.org"
 
 gem "activerecord", "~> 5.0.0"
 
-gemspec :path => "../"
+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/lib/activerecord/mysql/reconnect.rb

@@ -44,6 +44,7 @@ module Activerecord::Mysql::Reconnect
     "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
@@ -111,6 +112,7 @@ module Activerecord::Mysql::Reconnect
       block     = opts.fetch(:proc)
       on_error  = opts[:on_error]
       conn      = opts[:connection]
+      sql       = opts[:sql]
       tries     = self.execution_tries
       retval    = nil
 
@@ -123,17 +125,14 @@ module Activerecord::Mysql::Reconnect
             on_error.call if on_error
             wait = self.execution_retry_wait * n
 
-            opt_msgs = ["cause: #{e} [#{e.class}]"]
-
-            if conn
-              conn_info = connection_info(conn)
-              opt_msgs << 'connection: ' + [:host, :database, :username].map {|k| "#{k}=#{conn_info[k]}" }.join(";")
-            end
-
-            logger.warn("MySQL server has gone away. Trying to reconnect in #{wait.to_f} seconds. (#{opt_msgs.join(', ')})")
+            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
@@ -225,8 +224,6 @@ module Activerecord::Mysql::Reconnect
       return conn_info
     end
 
-    private
-
     def create_pattern_match_regex(str)
       ss = StringScanner.new(str)
       buf = []
@@ -247,5 +244,17 @@ module Activerecord::Mysql::Reconnect
 
       /\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

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

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

data/spec/activerecord-mysql-reconnect_spec.rb

@@ -4,7 +4,8 @@ describe 'activerecord-mysql-reconnect' do
       :adapter  => 'mysql2',
       :host     => '127.0.0.1',
       :username => 'root',
-      :database => 'employees'
+      :database => 'employees',
+      :port     => 14407,
     )
 
     ActiveRecord::Base.logger = Logger.new($stdout)
@@ -444,4 +445,55 @@ describe 'activerecord-mysql-reconnect' do
       end
     end
   end
+
+  context "when retry with warning" do
+    let(:warning_template) do
+      "%s (cause: %s, sql: SELECT `employees`.* FROM `employees`, connection: host=127.0.0.1;database=employees;username=root)"
+    end
+
+    before do
+      allow_any_instance_of(Mysql2::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]",
+        ])
+
+        (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]",
+          ])
+        end
+
+        expect(ActiveRecord::Base.logger).to receive(:warn).with(warning_template % [
+          "Query retry failed.",
+          "Lost connection to MySQL server during query [Mysql2::Error]",
+        ])
+
+        expect(Employee.all.length).to eq 1000
+        MysqlServer.stop
+
+        expect {
+          Employee.all.length
+        }.to raise_error(Mysql2::Error)
+      end
+    end
+
+    context "when retry succeeded" 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]",
+        ])
+
+        expect(Employee.all.length).to eq 1000
+        MysqlServer.restart
+        expect(Employee.all.length).to eq 1000
+      end
+    end
+  end
 end

data/spec/mysql_helper.rb

@@ -1,15 +1,10 @@
 require 'mysql2'
 
 class MysqlServer
-  CLI_ARGS = '-u root -P 3306 -h 127.0.0.1'
+  CLI_ARGS = '-u root -P 14407 -h 127.0.0.1'
   REDIRECT_TO_DEV_NULL = ENV['DEBUG'] == '1' ? '' : '> /dev/null 2> /dev/null'
 
   class << self
-    def setup
-      clean
-      system('mkdir -p /tmp/mysql_for_ar_mysql_reconn')
-    end
-
     def start
       system("docker-compose up -d #{REDIRECT_TO_DEV_NULL}")
       wait_mysql_start
@@ -44,11 +39,6 @@ class MysqlServer
 
     def clean
       stop
-
-      if ENV['SKIP_CLEAN_DATA'] != '1'
-        system("docker-compose rm -f mysql_for_ar_mysql_reconn #{REDIRECT_TO_DEV_NULL}")
-        system('rm -rf /tmp/mysql_for_ar_mysql_reconn')
-      end
     end
 
     def reset

data/spec/spec_helper.rb

@@ -35,12 +35,11 @@ include SpecHelper
 
 RSpec.configure do |config|
   config.before(:all) do
-    ENV['MYSQL_PWD'] = 'password'
-    MysqlServer.setup
+    MysqlServer.stop
   end
 
   config.after(:all) do
-    MysqlServer.clean
+    MysqlServer.stop
   end
 
   config.before(:each) do |context|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-mysql-reconnect
 version: !ruby/object:Gem::Version
-  version: 0.4.1.beta
+  version: 0.4.1
 platform: ruby
 authors:
 - Genki Sugawara
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-01 00:00:00.000000000 Z
+date: 2017-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -114,9 +114,8 @@ files:
 - activerecord-mysql-reconnect.gemspec
 - docker-compose.yml
 - gemfiles/activerecord_4.2.gemfile
-- gemfiles/activerecord_4.2.gemfile.lock
 - gemfiles/activerecord_5.0.gemfile
-- gemfiles/activerecord_5.0.gemfile.lock
+- gemfiles/activerecord_5.1.gemfile
 - lib/activerecord-mysql-reconnect.rb
 - lib/activerecord/mysql/reconnect.rb
 - lib/activerecord/mysql/reconnect/abstract_mysql_adapter_ext.rb
@@ -146,12 +145,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: It is the library to reconnect automatically when ActiveRecord is disconnected

data/gemfiles/activerecord_4.2.gemfile.lock

@@ -1,66 +0,0 @@
-PATH
-  remote: ../
-  specs:
-    activerecord-mysql-reconnect (0.4.0)
-      activerecord
-      mysql2
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activemodel (4.2.6)
-      activesupport (= 4.2.6)
-      builder (~> 3.1)
-    activerecord (4.2.6)
-      activemodel (= 4.2.6)
-      activesupport (= 4.2.6)
-      arel (~> 6.0)
-    activesupport (4.2.6)
-      i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
-      minitest (~> 5.1)
-      thread_safe (~> 0.3, >= 0.3.4)
-      tzinfo (~> 1.1)
-    appraisal (2.1.0)
-      bundler
-      rake
-      thor (>= 0.14.0)
-    arel (6.0.3)
-    builder (3.2.2)
-    diff-lcs (1.2.5)
-    i18n (0.7.0)
-    json (1.8.3)
-    minitest (5.8.4)
-    mysql2 (0.4.4)
-    rake (11.1.2)
-    rspec (3.4.0)
-      rspec-core (~> 3.4.0)
-      rspec-expectations (~> 3.4.0)
-      rspec-mocks (~> 3.4.0)
-    rspec-core (3.4.4)
-      rspec-support (~> 3.4.0)
-    rspec-expectations (3.4.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-mocks (3.4.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.4.0)
-    rspec-support (3.4.1)
-    thor (0.19.1)
-    thread_safe (0.3.5)
-    tzinfo (1.2.2)
-      thread_safe (~> 0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activerecord (~> 4.2.0)
-  activerecord-mysql-reconnect!
-  appraisal
-  bundler
-  rake
-  rspec (>= 3.0.0)
-
-BUNDLED WITH
-   1.11.2

data/gemfiles/activerecord_5.0.gemfile.lock

@@ -1,63 +0,0 @@
-PATH
-  remote: ../
-  specs:
-    activerecord-mysql-reconnect (0.4.0)
-      activerecord
-      mysql2
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activemodel (5.0.0)
-      activesupport (= 5.0.0)
-    activerecord (5.0.0)
-      activemodel (= 5.0.0)
-      activesupport (= 5.0.0)
-      arel (~> 7.0)
-    activesupport (5.0.0)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    appraisal (2.1.0)
-      bundler
-      rake
-      thor (>= 0.14.0)
-    arel (7.1.1)
-    concurrent-ruby (1.0.2)
-    diff-lcs (1.2.5)
-    i18n (0.7.0)
-    minitest (5.9.0)
-    mysql2 (0.4.4)
-    rake (11.2.2)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.2)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
-    thor (0.19.1)
-    thread_safe (0.3.5)
-    tzinfo (1.2.2)
-      thread_safe (~> 0.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  activerecord (~> 5.0.0)
-  activerecord-mysql-reconnect!
-  appraisal
-  bundler
-  rake
-  rspec (>= 3.0.0)
-
-BUNDLED WITH
-   1.11.2