active_record_postgresql_xverify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0ebabab6ed60b2663b586fb09aa491eb95f0572657e14be2794c17b9896f3008
+  data.tar.gz: 0a6798b753418981bb573ea2b470f4eca066668dc65ef2c901de76e5cf930a66
+SHA512:
+  metadata.gz: 3ae914c03ca5b5af6d3cd1fda4f425805daecdebd14b0581b97a6f82ae0b3ee7456224f31f6c2af86a1e12a4d92b9fce458d9eb339ab12851dd9090bc75ce214
+  data.tar.gz: a4efe1d28bda58233b274441bcd030ea8f436f4663e4c8c189bad3ad3a7bbd6d68bd50a31fef90c3f7edfcec22e345b2b490a357cf743e9abd24cce5a15aab29

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/test.rb
+/Gemfile.lock
+
+# rspec failure tracking
+.rspec_status
+
+# Appraisal Gemfile.lock
+/gemfiles/*.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  Exclude:
+    - 'gemfiles/**/*'
+  TargetRubyVersion: 2.3
+Metrics/BlockLength:
+  Enabled: false
+Metrics/LineLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Naming/UncommunicativeMethodParamName:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma

data/.travis.yml

@@ -0,0 +1,25 @@
+---
+dist: xenial
+sudo: required
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.8
+  - 2.4.6
+  - 2.5.3
+  - 2.6.3
+before_install:
+  - docker-compose up -d
+  - function pg_ping { PGPASSWORD=postgres pg_isready -U postgres -h 127.0.0.1 -p 12345 >/dev/null 2>/dev/null; }
+  - for i in {1..60}; do pg_ping && break; sleep 1; done
+script:
+  - bundle exec rake
+gemfile:
+  - gemfiles/ar42.gemfile
+  - gemfiles/ar50.gemfile
+  - gemfiles/ar51.gemfile
+  - gemfiles/ar52.gemfile
+addons:
+  apt:
+    packages:
+      - postgresql

data/Appraisals

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+appraise 'ar42' do
+  gem 'activerecord', '~> 4.2.10'
+  gem 'pg', '~> 0.15'
+end
+
+appraise 'ar50' do
+  gem 'activerecord', '~> 5.0.7'
+end
+
+appraise 'ar51' do
+  gem 'activerecord', '~> 5.1.6'
+end
+
+appraise 'ar52' do
+  gem 'activerecord', '~> 5.2.1'
+end

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in active_record_postgresql_xverify.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 TODO: Write your name
+
+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,112 @@
+# active_record_postgresql_xverify
+
+It is a library that performs extended verification when an error occurs when executing SQL.
+
+[![Gem Version](https://badge.fury.io/rb/active_record_postgresql_xverify.svg)](http://badge.fury.io/rb/active_record_postgresql_xverify)
+[![Build Status](https://travis-ci.org/winebarrel/active_record_postgresql_xverify.svg?branch=master)](https://travis-ci.org/winebarrel/active_record_postgresql_xverify)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'active_record_postgresql_xverify'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install active_record_postgresql_xverify
+
+## Usage
+
+```ruby
+#!/usr/bin/env ruby
+require 'active_record'
+require 'active_record_postgresql_xverify'
+require 'logger'
+
+ActiveRecord::Base.establish_connection(
+  adapter:  'postgresql',
+  host:     '127.0.0.1',
+  port:      5432,
+  username: 'root',
+  password: 'password',
+  database: 'bookshelf',
+)
+
+ActiveRecord::Base.logger = Logger.new($stdout)
+ActiveRecord::Base.logger.formatter = proc {|_, _, _, message| "#{message}\n" }
+
+ActiveRecordPostgresqlXverify.verify = ->(conn) do
+  ping = begin
+           conn.query 'SELECT 1'
+           true
+         rescue PG::Error
+           false
+         end
+
+  ping && false # force reconnect
+end
+# Default: ->(conn) do
+#            begin
+#              conn.query 'SELECT 1'
+#              true
+#            rescue PG::Error
+#              false
+#            end
+
+ActiveRecordPostgresqlXverify.handle_if = ->(config) do
+  config[:host] == '127.0.0.1'
+end
+# Default: ->(_) { true }
+
+ActiveRecordPostgresqlXverify.only_on_error = false
+# Default: true
+
+# CREATE DATABASE bookshelf;
+# CREATE TABLE bookshelf.books (id INT PRIMARY KEY);
+class Book < ActiveRecord::Base; end
+
+Book.count
+prev_process_id = Book.connection.query('select pg_backend_pid()').first.fetch(0)
+
+ActiveRecord::Base.connection_handler.connection_pool_list.each(&:release_connection)
+
+Book.count
+curr_process_id = Book.connection.query('select pg_backend_pid()').first.fetch(0)
+
+p curr_process_id == prev_process_id #=> false
+```
+
+## Rails configuration
+
+In `config/environments/production.rb`:
+
+```ruby
+ActiveRecordPostgresqlXverify.verify = ->(conn) do
+  ping = begin
+           conn.query 'SELECT 1'
+           true
+         rescue PG::Error
+           false
+         end
+
+  ping && conn.query('show transaction_read_only')
+              .first.fetch('transaction_read_only') == 'off'
+end
+# Same as below:
+#   ActiveRecordPostgresqlXverify.verify = ActiveRecordPostgresqlXverify::Verifiers::AURORA_MASTER
+```
+
+## Test
+
+```
+bundle install
+bundle exec appraisal install
+docker-compose up -d
+bundle exec appraisal ar52 rake
+```

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+RuboCop::RakeTask.new do |task|
+  task.options = %w[-c .rubocop.yml]
+end
+
+task default: %i[rubocop spec]

data/active_record_postgresql_xverify.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'active_record_postgresql_xverify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'active_record_postgresql_xverify'
+  spec.version       = ActiveRecordPostgresqlXverify::VERSION
+  spec.authors       = ['winebarrel']
+  spec.email         = ['sugawara@winebarrel.jp']
+
+  spec.summary       = 'It is a library that performs extended verification when an error occurs when executing SQL.'
+  spec.description   = 'It is a library that performs extended verification when an error occurs when executing SQL.'
+  spec.homepage      = 'https://github.com/winebarrel/active_record_postgresql_xverify'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord'
+  spec.add_dependency 'pg'
+  spec.add_development_dependency 'appraisal'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'active_record_postgresql_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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

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/docker-compose.yml

@@ -0,0 +1,8 @@
+version: '3'
+services:
+  mysql:
+    image: postgres:9.6
+    ports:
+     - 12345:5432
+    environment:
+      POSTGRES_PASSWORD: 'postgres'

data/gemfiles/.bundle/config

@@ -0,0 +1,2 @@
+---
+BUNDLE_RETRY: "1"

data/gemfiles/ar42.gemfile

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

data/gemfiles/ar50.gemfile

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

data/gemfiles/ar51.gemfile

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

data/gemfiles/ar52.gemfile

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

data/lib/active_record_postgresql_xverify.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'active_support'
+require 'active_record_postgresql_xverify/version'
+require 'active_record_postgresql_xverify/constants'
+require 'active_record_postgresql_xverify/logger'
+require 'active_record_postgresql_xverify/utils'
+require 'active_record_postgresql_xverify/config'
+require 'active_record_postgresql_xverify/error_handler'
+require 'active_record_postgresql_xverify/verifier'
+require 'active_record_postgresql_xverify/verifiers/aurora_master'
+
+ActiveSupport.on_load :active_record do
+  require 'active_record/connection_adapters/postgresql_adapter'
+  ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.prepend ActiveRecordPostgresqlXverify::ErrorHandler
+  ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.prepend ActiveRecordPostgresqlXverify::Verifier
+end

data/lib/active_record_postgresql_xverify/config.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module ActiveRecordPostgresqlXverify
+  @config = {
+    handle_if: ->(_) { true },
+    only_on_error: true,
+    verify: lambda do |conn|
+      begin
+        conn.query 'SELECT 1'
+        true
+      rescue PG::Error
+        false
+      end
+    end,
+  }
+
+  class << self
+    def handle_if=(proc)
+      @config[:handle_if] = proc
+    end
+
+    def handle_if
+      @config.fetch(:handle_if)
+    end
+
+    def verify=(proc)
+      @config[:verify] = proc
+    end
+
+    def verify
+      @config.fetch(:verify)
+    end
+
+    def only_on_error=(bool)
+      @config[:only_on_error] = bool
+    end
+
+    def only_on_error
+      @config.fetch(:only_on_error)
+    end
+  end
+end

data/lib/active_record_postgresql_xverify/constants.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActiveRecordPostgresqlXverify
+  EXTEND_VERIFY_FLAG = "#{ActiveRecordPostgresqlXverify}_EXTEND_VERIFY_FLAG"
+end

data/lib/active_record_postgresql_xverify/error_handler.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ActiveRecordPostgresqlXverify
+  module ErrorHandler
+    def execute(*)
+      super
+    rescue StandardError
+      _flag_extend_verify!
+      raise
+    end
+
+    def execute_and_clear(*)
+      super
+    rescue StandardError
+      _flag_extend_verify!
+      raise
+    end
+
+    def _flag_extend_verify!
+      Thread.current[ActiveRecordPostgresqlXverify::EXTEND_VERIFY_FLAG] = true
+    end
+  end
+end

data/lib/active_record_postgresql_xverify/logger.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ActiveRecordPostgresqlXverify
+  class << self
+    def logger
+      @logger ||= if defined?(Rails)
+                    Rails.logger || ActiveRecord::Base.logger || Logger.new($stderr)
+                  else
+                    ActiveRecord::Base.logger || Logger.new($stderr)
+                  end
+    end
+  end
+end

data/lib/active_record_postgresql_xverify/utils.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module ActiveRecordPostgresqlXverify
+  module Utils
+    class << self
+      def pg_connection_info(conn)
+        cih = conn.conninfo_hash
+        "host=#{cih[:host]}, database=#{cih[:dbname]}, username=#{cih[:user]}"
+      end
+    end
+  end
+end

data/lib/active_record_postgresql_xverify/verifier.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module ActiveRecordPostgresqlXverify
+  module Verifier
+    def active?
+      if _extend_verify?
+        is_active = begin
+                      verifier = ActiveRecordPostgresqlXverify.verify
+                      verifier.call(@connection)
+                    rescue StandardError => e
+                      ActiveRecordPostgresqlXverify.logger.warn("Connection verification failed: #{_build_verify_error_message(e)}")
+                      false
+                    ensure
+                      Thread.current[ActiveRecordPostgresqlXverify::EXTEND_VERIFY_FLAG] = false
+                    end
+
+        unless is_active
+          ActiveRecordPostgresqlXverify.logger.info(
+            "Invalid connection: #{ActiveRecordPostgresqlXverify::Utils.pg_connection_info(@connection)}"
+          )
+        end
+
+        is_active
+      else
+        super
+      end
+    end
+
+    def _build_verify_error_message(e)
+      "cause: #{e.message} [#{e.class}, " + ActiveRecordPostgresqlXverify::Utils.pg_connection_info(@connection)
+    end
+
+    def _extend_verify?
+      handle_if = ActiveRecordPostgresqlXverify.handle_if
+      (Thread.current[ActiveRecordPostgresqlXverify::EXTEND_VERIFY_FLAG] || !ActiveRecordPostgresqlXverify.only_on_error) && handle_if.call(@config)
+    end
+  end
+end

data/lib/active_record_postgresql_xverify/verifiers/aurora_master.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ActiveRecordPostgresqlXverify
+  module Verifiers
+    AURORA_MASTER = lambda do |conn|
+      ping = begin
+               conn.query 'SELECT 1'
+               true
+             rescue PG::Error
+               false
+             end
+
+      ping && conn.query('show transaction_read_only')
+                  .first.fetch('transaction_read_only') == 'off'
+    end
+  end
+end

data/lib/active_record_postgresql_xverify/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ActiveRecordPostgresqlXverify
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: active_record_postgresql_xverify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- winebarrel
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: pg
+  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: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: It is a library that performs extended verification when an error occurs
+  when executing SQL.
+email:
+- sugawara@winebarrel.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Appraisals
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- active_record_postgresql_xverify.gemspec
+- bin/console
+- bin/setup
+- docker-compose.yml
+- gemfiles/.bundle/config
+- gemfiles/ar42.gemfile
+- gemfiles/ar50.gemfile
+- gemfiles/ar51.gemfile
+- gemfiles/ar52.gemfile
+- lib/active_record_postgresql_xverify.rb
+- lib/active_record_postgresql_xverify/config.rb
+- lib/active_record_postgresql_xverify/constants.rb
+- lib/active_record_postgresql_xverify/error_handler.rb
+- lib/active_record_postgresql_xverify/logger.rb
+- lib/active_record_postgresql_xverify/utils.rb
+- lib/active_record_postgresql_xverify/verifier.rb
+- lib/active_record_postgresql_xverify/verifiers/aurora_master.rb
+- lib/active_record_postgresql_xverify/version.rb
+homepage: https://github.com/winebarrel/active_record_postgresql_xverify
+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.7.6.2
+signing_key: 
+specification_version: 4
+summary: It is a library that performs extended verification when an error occurs
+  when executing SQL.
+test_files: []