mysql2-reconnect_with_readonly 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4cd04992532b8bd1014956e2f9b59fc3e403a9d3
+  data.tar.gz: 301ab0c6e0ff1ae23dd1593664c06788688a407f
+SHA512:
+  metadata.gz: b4a41e7d23cd8844f4a03ca0469b4eb7ccc671d8c3fefafbcb4aaf31b299f659cd03e6a3e82ca90612c4a01fb11806a46ed7ce405dea8db379df35eb8f888d62
+  data.tar.gz: 3f7abef72d4ed1e82cfc952a87f90f69e07a9d7a3397c403e144a468c06242645440acec7abbb1ab3650fd58a4f841f83382e944e561ff867224ba75bc65ba50

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.0 (2016-08-28)
+
+First version

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at sonots@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+gem 'pry'
+gem 'pry-nav'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Naotoshi Seo
+
+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,74 @@
+# Mysql2::ReconnectWithReadonly
+
+Reconnect your mysql2 connection if `Mysql2::Error: The MySQL server is running with the --read-only option so it cannot execute this statement` occurs because of failover.
+
+When mysql2 cluster failovers, the mysql2 master is depromoted to slave and will be READONLY. Such case we have to reconnect mysql2 connection so that new connection goes to new master which is writable.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mysql2-reconnect_with_readonly'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mysql2-reconnect_with_readonly
+
+## Usage
+
+```ruby
+require 'mysql2/reconnect_with_readonly'
+```
+
+## Configuration
+
+This gem tries to reconnect `reconnect_attempts` times.
+It will wait `initial_retry_wait * number of retries` seconds on each retry.
+The waiting interval can be suppressed up to `max_retry_wait` seconds.
+
+```
+Mysql2::ReconnectWithReadonly.reconnect_attempts = 10     # default: 3 (times)
+Mysql2::ReconnectWithReadonly.initial_retry_wait = 1.0    # default: 0.5 (sec)
+Mysql2::ReconnectWithReadonly.max_retry_wait     = 5.0    # default: nil which means no max (sec)
+Mysql2::ReconnectWithReadonly.logger = Logger.new(STDOUT) # default: nil
+```
+
+## Implementation
+
+This gem monkey patches `Mysql2::Client`.
+
+## Development
+
+To create a read-only mysql server:
+
+```
+$ mysql -uroot
+root> GRANT  CREATE, ALTER, DELETE, INSERT, UPDATE, SELECT ON *.* TO 'test'@'localhost' identified by 'test'
+root> SET GLOBAL read_only = ON;
+```
+
+Connect with `test` user (`root` has write privilege even in read_only mode):
+
+```
+$ bin/console
+> mysql2 = Mysql2::Client.new(username: 'test', password: 'test')
+> mysql2.query(%Q[create database 'test'])
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/sonots/mysql2-reconnect_with_readonly. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## ChangeLog
+
+[CHANGELOG.md](./CHANGELOG.md)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mysql2/reconnect_with_readonly"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/try

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mysql2/reconnect_with_readonly"
+require 'logger'
+
+Mysql2::ReconnectWithReadonly.reconnect_attempts = 5
+Mysql2::ReconnectWithReadonly.initial_retry_wait = 1
+Mysql2::ReconnectWithReadonly.max_retry_wait = 3
+Mysql2::ReconnectWithReadonly.logger = Logger.new(STDOUT)
+
+mysql2 = Mysql2::Client.new(host: 'localhost', username: 'test', password: 'test')
+mysql2.query('create database foo')

data/lib/mysql2/reconnect_with_readonly.rb

@@ -0,0 +1,83 @@
+require 'mysql2/reconnect_with_readonly/version'
+require 'mysql2'
+require 'mysql2/client'
+
+module Mysql2
+  class ReconnectWithReadonly
+    @reconnect_attempts  = 3
+    @initial_retry_wait = 0.5
+    @max_retry_wait  = nil
+    @logger = nil
+
+    class << self
+      attr_accessor :reconnect_attempts, :initial_retry_wait, :max_retry_wait, :logger
+    end
+
+    def self.reconnect_with_readonly(client, &block)
+      retries = 0
+      begin
+        yield block
+      rescue Mysql2::Error => e
+        if e.message =~ /read-only/
+          if retries < reconnect_attempts
+            wait = initial_retry_wait * retries
+            wait = [wait, max_retry_wait].min if max_retry_wait
+            logger.info {
+              "Reconnect with readonly: #{e.message} " \
+              "(retries: #{retries}/#{reconnect_attempts}) (wait: #{wait}sec)"
+            } if logger
+            sleep wait
+            retries += 1
+            client.reconnect
+            logger.debug { "Reconnect with readonly: disconnected and retry" } if logger
+            retry
+          else
+            logger.info {
+              "Reconnect with readonly: Give up " \
+              "(retries: #{retries}/#{reconnect_attempts})"
+            } if logger
+          end
+        else
+          raise
+        end
+      end
+    end
+
+    OriginalClient = ::Mysql2::Client
+    Mysql2.send(:remove_const, :Client)
+  end
+end
+
+module Mysql2
+  class Client
+    class << self
+      Mysql2::ReconnectWithReadonly::OriginalClient.methods(false).each do |method|
+        define_method(method) do |*args|
+          Mysql2::ReconnectWithReadonly::OriginalClient.send(method, *args)
+        end
+      end
+    end
+
+    Mysql2::ReconnectWithReadonly::OriginalClient.instance_methods(false).each do |method|
+      define_method(method) do |*args|
+        @original_client.send(method, *args)
+      end
+    end
+
+    def initialize(opts = {})
+      @opts = opts
+      @original_client = Mysql2::ReconnectWithReadonly::OriginalClient.new(@opts)
+    end
+
+    def reconnect
+      @original_client.close rescue nil
+      @original_client = Mysql2::ReconnectWithReadonly::OriginalClient.new(@opts)
+    end
+
+    def query(sql, options = {})
+      ReconnectWithReadonly.reconnect_with_readonly(self) do
+        @original_client.query(sql, options)
+      end
+    end
+  end
+end

data/lib/mysql2/reconnect_with_readonly/version.rb

@@ -0,0 +1,5 @@
+module Mysql2
+  class ReconnectWithReadonly
+    VERSION = "0.1.0"
+  end
+end

data/mysql2-reconnect_with_readonly.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mysql2/reconnect_with_readonly/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mysql2-reconnect_with_readonly"
+  spec.version       = Mysql2::ReconnectWithReadonly::VERSION
+  spec.authors       = ["Naotoshi Seo"]
+  spec.email         = ["sonots@gmail.com"]
+
+  spec.summary       = %q{Reconnect mysql2 if the MySQL server is running with the --read-only option.}
+  spec.description   = %q{Reconnect mysql2 if the MySQL server is running with the --read-only option.}
+  spec.homepage      = "https://github.com/sonots/mysql2-reconnect_with_readonly."
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "mysql2"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: mysql2-reconnect_with_readonly
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Naotoshi Seo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-08-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Reconnect mysql2 if the MySQL server is running with the --read-only
+  option.
+email:
+- sonots@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/try
+- lib/mysql2/reconnect_with_readonly.rb
+- lib/mysql2/reconnect_with_readonly/version.rb
+- mysql2-reconnect_with_readonly.gemspec
+homepage: https://github.com/sonots/mysql2-reconnect_with_readonly.
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Reconnect mysql2 if the MySQL server is running with the --read-only option.
+test_files: []