active_record_mysql_xverify 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b9b9ce1ade186050ccfa538360ab9e4f05309b65a2d2fcc6e5d70532b95bf4e
-  data.tar.gz: 5eebab1a79aa13eb7dbc8d2c697495ca4dac550ceda70046698b7c89b6891f69
+  metadata.gz: 247cfa1e88c414475aedb0a0da825d5860bfa0bac37557ff7c635fb7dec70ea8
+  data.tar.gz: e5a2e3ecf2448e82d8cbd5cdaae403f37ce780b4e0ab4edea5f620a37ba27731
 SHA512:
-  metadata.gz: 783496ec07fe44f10c594a901cd46364add2257d4cee9cc4fc195567b54c28c0d5caf5d775f945d2e3f793a80e377b1bd64136b9080cb939c5cf34e3c9a7f861
-  data.tar.gz: e5b1a46379a954bc2bbc7a220237d283a5a40b0328caec95edcb026a1052c5d76be52213b6a3bbb9338b30c6a846b8a54657013cab66e60290af81b2a22c4895
+  metadata.gz: b140b35801f33cc584ba71283329a7ac79eeacd7b5db5ccc217b6a903b254d3a64f0a03138a3a437f44f7d23d9b0c8b6555274f2a0b710c6929ff0aaa92aa106
+  data.tar.gz: ae7d6b6d69c781ff0558d47d8f62e39d1f524585ee7bf31ae912b38f6eaeccabc81e13272ed5971986412590ab9b5259da5b12208bdfdad8ab0b95ad2be7b4b9

data/.rubocop.yml

@@ -1,16 +1,93 @@
 AllCops:
   Exclude:
-    - 'gemfiles/**/*'
-  TargetRubyVersion: 2.3
+    - "gemfiles/**/*"
+  TargetRubyVersion: 2.4
 Metrics/BlockLength:
   Enabled: false
 Metrics/LineLength:
   Enabled: false
 Metrics/MethodLength:
   Enabled: false
-Naming/UncommunicativeMethodParamName:
+Naming/MethodParameterName:
   Enabled: false
 Style/Documentation:
   Enabled: false
 Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: consistent_comma
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Lint/BinaryOperatorWithIdenticalOperands:
+  Enabled: true
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/DuplicateElsifCondition:
+  Enabled: true
+Lint/DuplicateRescueException:
+  Enabled: true
+Lint/EmptyConditionalBody:
+  Enabled: true
+Lint/FloatComparison:
+  Enabled: true
+Lint/MissingSuper:
+  Enabled: true
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Lint/OutOfRangeRegexpRef:
+  Enabled: true
+Lint/RaiseException:
+  Enabled: true
+Lint/SelfAssignment:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Lint/TopLevelReturnWithArgument:
+  Enabled: true
+Lint/UnreachableLoop:
+  Enabled: true
+Style/AccessorGrouping:
+  Enabled: true
+Style/ArrayCoercion:
+  Enabled: true
+Style/BisectedAttrAccessor:
+  Enabled: true
+Style/CaseLikeIf:
+  Enabled: true
+Style/ExplicitBlockArgument:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+Style/GlobalStdStream:
+  Enabled: true
+Style/HashAsLastArrayItem:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashLikeCase:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Style/OptionalBooleanParameter:
+  Enabled: true
+Style/RedundantAssignment:
+  Enabled: true
+Style/RedundantFetchBlock:
+  Enabled: true
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
+Style/SingleArgumentDig:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true
+Style/StringConcatenation:
+  Enabled: true

data/.travis.yml

@@ -1,17 +1,14 @@
 ---
-dist: xenial
-sudo: required
 language: ruby
 cache: bundler
 rvm:
-  - 2.3.8
-  - 2.4.6
-  - 2.5.3
-  - 2.6.3
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1
+env:
+  - DATABASE_HOST=localhost DATABASE_USER=travis
 before_install:
-  - docker-compose up -d
-  - function mysql_ping { mysqladmin -u root -h 127.0.0.1 -P 6033 ping > /dev/null 2> /dev/null; }
-  - for i in {1..60}; do mysql_ping && break; sleep 1; done
+  - for i in {1..60}; do mysqladmin -u travis ping && break; sleep 1; done
 script:
   - bundle exec rake
 gemfile:
@@ -19,8 +16,10 @@ gemfile:
   - gemfiles/ar50.gemfile
   - gemfiles/ar51.gemfile
   - gemfiles/ar52.gemfile
-addons:
-  apt:
-    packages:
-      - mysql-client-core-5.7
-      - mysql-client-5.7
+  - gemfiles/ar60.gemfile
+services:
+  - mysql
+jobs:
+  exclude:
+    - rvm: 2.7.1
+      gemfile: gemfiles/ar42.gemfile

data/Appraisals

@@ -16,3 +16,7 @@ end
 appraise 'ar52' do
   gem 'activerecord', '~> 5.2.1'
 end
+
+appraise 'ar60' do
+  gem 'activerecord', '~> 6.0.3'
+end

data/Dockerfile

@@ -0,0 +1,13 @@
+FROM rubylang/ruby:2.5-bionic
+
+RUN apt-get update && \
+  apt-get install -y \
+  mysql-client \
+  libmysqlclient-dev \
+  rubygems
+
+COPY ./ /mnt/
+WORKDIR /mnt
+RUN gem update bundler -f && \
+  bundle install && \
+  bundle exec appraisal install

data/README.md

@@ -1,10 +1,18 @@
 # active_record_mysql_xverify
 
-It is a library that performs extended verification when an error occurs when executing SQL.
+It is a library to solve Amazon RDS failover problems.
+
+cf. https://github.com/brianmario/mysql2/issues/948
+
+**Note: This library does not retry queries. Just reconnect.**
 
 [![Gem Version](https://badge.fury.io/rb/active_record_mysql_xverify.svg)](http://badge.fury.io/rb/active_record_mysql_xverify)
 [![Build Status](https://travis-ci.org/winebarrel/active_record_mysql_xverify.svg?branch=master)](https://travis-ci.org/winebarrel/active_record_mysql_xverify)
 
+## How it works
+
+![](https://user-images.githubusercontent.com/117768/59007604-19a61c80-8862-11e9-9f4b-515527b33ded.png)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -49,9 +57,6 @@ ActiveRecordMysqlXverify.handle_if = ->(config) do
 end
 # Default: ->(_) { true }
 
-ActiveRecordMysqlXverify.only_on_error = false
-# Default: true
-
 # CREATE DATABASE IF NOT EXISTS bookshelf;
 # CREATE TABLE bookshelf.books (id INT PRIMARY KEY);
 class Book < ActiveRecord::Base; end
@@ -74,7 +79,7 @@ In `config/environments/production.rb`:
 
 ```ruby
 ActiveRecordMysqlXverify.verify = ->(conn) do
-  conn.ping && conn.query('show variables like "innodb_read_only"').first.fetch(1) == 'OFF'
+  conn.ping && conn.query('select @@innodb_read_only').first.fetch('@@innodb_read_only').zero?
 end
 # Same as below:
 #   ActiveRecordMysqlXverify.verify = ActiveRecordMysqlXverify::Verifiers::AURORA_MASTER
@@ -131,8 +136,13 @@ Completed 302 Found in 150ms (ActiveRecord: 145.2ms)
 
 ## Test
 
+## Test
+
+```sh
+docker-compose build
+docker-compose run client bundle exec appraisal ar60 rake
 ```
-bundle install
-docker-compose up -d
-bundle exec rake
-```
+
+## Related links
+
+* https://github.com/winebarrel/active_record_postgresql_xverify

data/bin/console

@@ -2,7 +2,7 @@
 # frozen_string_literal: true
 
 require 'bundler/setup'
-require 'activerecord_mysql_xverify'
+require 'active_record_mysql_xverify'
 
 # 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.

data/docker-compose.yml

@@ -1,8 +1,12 @@
-version: '3'
+version: "3.8"
 services:
+  client:
+    build: .
+    volumes:
+      - ./:/mnt
+    depends_on:
+      - mysql
   mysql:
     image: mysql:5.7
-    ports:
-     - 6033:3306
     environment:
-      MYSQL_ALLOW_EMPTY_PASSWORD: 'yes'
+      MYSQL_ALLOW_EMPTY_PASSWORD: "yes"

data/gemfiles/ar60.gemfile

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

data/lib/active_record_mysql_xverify/config.rb

@@ -4,7 +4,7 @@ module ActiveRecordMysqlXverify
   @config = {
     handle_if: ->(_) { true },
     verify: ->(conn) { conn.ping },
-    only_on_error: true,
+    only_on_error: false,
   }
 
   class << self

data/lib/active_record_mysql_xverify/verifiers/aurora_master.rb

@@ -3,7 +3,7 @@
 module ActiveRecordMysqlXverify
   module Verifiers
     AURORA_MASTER = lambda do |conn|
-      conn.ping && conn.query('show variables like "innodb_read_only"').first.fetch(1) == 'OFF'
+      conn.ping && conn.query('select @@innodb_read_only').first.fetch('@@innodb_read_only').zero?
     end
   end
 end

data/lib/active_record_mysql_xverify/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveRecordMysqlXverify
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/seq.wsd

@@ -0,0 +1,38 @@
+@startuml{seq.png}
+
+actor Client
+participant Rails
+participant "Connection pool" as cp
+participant "<size:10>active_recode_mysql_xverify</size>" as armx
+participant MySQL
+
+Client -> Rails : Request
+activate Rails
+Rails -> MySQL : Query
+activate MySQL
+group neg
+  Rails <-- MySQL : <font color=red>"read-only" error happen!</font>
+  deactivate MySQL
+  Client <-- Rails : <font color=red>Error</font>
+  deactivate Rails
+end
+
+Client -> Rails : Request
+activate Rails
+Rails -> cp : checkout
+activate cp
+cp -> armx : active?
+activate armx
+armx -> MySQL : Fetch "innodb_read_only"
+activate MySQL
+armx <-- MySQL : "ON"
+deactivate MySQL
+cp <-- armx : false
+deactivate armx
+cp --> MySQL : reconnect!
+activate MySQL
+deactivate MySQL
+Rails <-- cp : Connection
+deactivate cp
+
+@enduml

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_record_mysql_xverify
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - winebarrel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-30 00:00:00.000000000 Z
+date: 2020-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -121,6 +121,7 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - Appraisals
+- Dockerfile
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -134,6 +135,7 @@ files:
 - gemfiles/ar50.gemfile
 - gemfiles/ar51.gemfile
 - gemfiles/ar52.gemfile
+- gemfiles/ar60.gemfile
 - lib/active_record_mysql_xverify.rb
 - lib/active_record_mysql_xverify/config.rb
 - lib/active_record_mysql_xverify/constants.rb
@@ -143,6 +145,7 @@ files:
 - lib/active_record_mysql_xverify/verifier.rb
 - lib/active_record_mysql_xverify/verifiers/aurora_master.rb
 - lib/active_record_mysql_xverify/version.rb
+- seq.wsd
 homepage: https://github.com/winebarrel/active_record_mysql_xverify
 licenses:
 - MIT
@@ -162,8 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: It is a library that performs extended verification when an error occurs