activerecord-bogacs 0.5.1 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d7d0cf56d16097d5faadc25e31228e1e6b6a1040703aa0fed0fd29a49d23622
-  data.tar.gz: 7f00210ced14e5963220980fd749d0c8765d7555deab200c508daa44ca0770c7
+  metadata.gz: 8272c1dff28e707a092e34ec3e95a0bcf76f31c7b38074da474db9e5cf520edd
+  data.tar.gz: fe9a92843c1b94098e9de4e85d830f96357aa8b49a0e769001eb14d37a71d334
 SHA512:
-  metadata.gz: ebc49df8d9f33381b3134b4dec5b5765abb06bb69b353f21ce695e9f0c4869f9ef36ad4005d6a716d2f73bebfe986158cfc237dd477f6247594a57337adb7bef
-  data.tar.gz: adc08a3fd5b9c6a2dde6daf9e75433c29fc7faf6c6832cd90e1fb8cf7f2be8a3df1e054486c13c22e8d5be1d4e3df74f4a42e27453d145b84a086e17f30efae4
+  metadata.gz: a9ccd085265c8f744dd7d7ef95dd38918ef2b37c029d1ad19a09322d727fa7a080f895ab14bab005cd54887402090798750a3ad9c1f6f7d0b8456a205ae7cd08
+  data.tar.gz: 40031eed7a1628094fc21d105006e32e06ab48b0890fa0abeb8379c2d513527a01c520e124438bb7dd380448e66cb8b3a2947beaf1cd15f1f2d074645b0b97d8

data/.github/workflows/test.yml

@@ -0,0 +1,82 @@
+name: Test
+
+on: [push, pull_request]
+
+env:
+  JAVA_OPTS: '-XX:+TieredCompilation -XX:TieredStopAtLevel=1'
+
+jobs:
+
+  rake-test:
+    runs-on: ubuntu-latest
+    services:
+      mysql:
+        image: mysql:5.7
+        env:
+            MYSQL_ALLOW_EMPTY_PASSWORD: yes
+            MYSQL_ROOT_PASSWORD: root
+            MYSQL_DATABASE: ar_bogacs
+        ports:
+          - 3306:3306
+        options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
+
+    env:
+      AR_ADAPTER: mysql2
+      AR_USERNAME: root
+      AR_PASSWORD: root
+      AR_HOST: 127.0.0.1
+      AR_VERSION: "~> 4.2"
+      HIKARI_VERSION: 2.3.12
+
+    strategy:
+      matrix:
+        java-version: [ 11 ]
+        ruby-version: [ jruby-9.3.6.0 ]
+        include:
+          - java-version: 11
+            ruby-version: jruby-9.2.20.1
+          - java-version: 11
+            ruby-version: jruby-9.2.10.0
+          - java-version: 17
+            ruby-version: jruby-9.2.20.1
+          - java-version: 8
+            ruby-version: jruby-9.2.9.0
+          - java-version: 8
+            ruby-version: jruby-9.1.17.0
+            env:
+              AR_VERSION: "~> 4.1.14"
+
+      fail-fast: false
+
+    steps:
+      - name: check mysql from host
+        run: |
+          sudo apt install -y mysql-client
+          mysql --host 127.0.0.1 --port 3306 -uroot -proot -e "SHOW DATABASES"
+
+      - name: checkout
+        uses: actions/checkout@v2
+
+      - name: set up java ${{ matrix.java-version }}
+        uses: actions/setup-java@v1.4.3
+        with:
+          java-version: ${{ matrix.java-version }}
+
+      - name: set up ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+
+      - name: install bundler
+        run: jruby -S gem install bundler -v "~>2.2.28"
+
+      - name: bundle install
+        run: jruby -S bundle install
+
+      - name: download jars
+        run: jruby -rbundler/setup -S rake tomcat:jndi:download tomcat:jdbc:download tomcat:dbcp:download hikari:download
+        shell: bash
+
+      - name: rake test
+        run: jruby -rbundler/setup -S rake test
+        shell: bash

data/Gemfile

@@ -16,14 +16,6 @@ else
   gem 'activerecord', :require => nil
 end
 
-if RUBY_VERSION.index('1.8') == 0
-  gem 'i18n', '< 0.7.0' # Gem::InstallError: i18n requires Ruby version >= 1.9.3
-  gem 'atomic', '1.1.16' # concurrent-ruby gem only for Ruby version >= 1.9.3
-  gem 'thread_safe', '~> 0.3'
-else
-  gem 'concurrent-ruby', '~> 1.0.0', :require => nil
-end
-
 platform :jruby do
   if version = ENV['AR_JDBC_VERSION']
     if version.index('/') && ::File.exist?(version)
@@ -40,16 +32,11 @@ platform :jruby do
   end
 end
 
-#gem 'thread_safe', :require => nil # "optional" - we can roll without it
-
-if defined?(JRUBY_VERSION) && JRUBY_VERSION < '1.7.0'
-gem 'jruby-openssl', :platform => :jruby
-end
-
 group :test do
   gem 'jdbc-mysql', :require => nil, :platform => :jruby
   gem 'jdbc-postgres', :require => nil, :platform => :jruby
+  gem 'jdbc-sqlite3', :require => nil, :platform => :jruby
 
   gem 'mysql2', :require => nil, :platform => :mri
   gem 'pg', :require => nil, :platform => :mri
-end
+end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013-2017 [Karol Bucek](http://kares.org)
+Copyright (c) 2013-2018 [Karol Bucek](http://kares.org)
 
 MIT License
 

data/README.md

@@ -6,7 +6,7 @@ ActiveRecord (all-year) pooling "alternatives" ... in a relaxed 'spa' fashion.
 
 Bogács is a village in Borsod-Abaúj-Zemplén county, Hungary.
 
-**WiP: do not put this on production if you do not understand the consequences!**
+**NOTE: do not put this on production if you do not understand the consequences!**
 
 ## Install
 
@@ -22,8 +22,8 @@ add this line to your application's *Gemfile*:
 
 Bogacs' pools rely on a small monkey-patch that allows to change the AR pool.
 The desired pool class needs to be set before `establish_connection` happens,
-thus an initializer won't work, you might consider setting the pool class at
-the bottom of your *application.rb* e.g. :
+thus an initializer (under Rails) won't work, you might consider setting the 
+pool class at the bottom of your *application.rb* e.g. :
 
 ```ruby
 Bundler.require(*Rails.groups)
@@ -34,19 +34,39 @@ module MyApp
   end
 end
 
-# sample AR-Bogacs setup using the "false" pool :
+# sample AR-Bogacs setup using the "default" pool :
 if Rails.env.production?
-  pool_class = ActiveRecord::Bogacs::FalsePool
+  pool_class = ActiveRecord::Bogacs::DefaultPool
   ActiveRecord::ConnectionAdapters::ConnectionHandler.connection_pool_class = pool_class
 end
 ```
 
-pools are expected to work with older ActiveRecord versions, if not let us know.
+Alternatively, for `FalsePool`, there's a configuration convention (no need to path 
+and set the connection_pool_class) :
+```yaml
+production:
+  adapter: mysql2
+  <% if $servlet_context %>
+  jndi: java:comp/env/jdbc/mydb
+  pool: false # use AR::Bogacs::FalsePool
+  <% else %>
+  port: <%= ENV['DATABASE_PORT'] || 3306 %>
+  database: mydb
+  # ...
+  <% end %>
+```
+
+This works only as long as one doesn't set a custom connection handler, since 
+*Bogacs* only sets up its custom `ActiveRecord::Base.default_connection_handler`.
+
+Pools are expected to work with older ActiveRecord versions: 3.x as well as 4.x.
 
 ### [Default Pool][2]
 
-Meant as a back-port for users stuck with old Rails versions (< 4.0) on production,
-facing potential (pool related) concurrency bugs e.g. with high-loads under JRuby.
+Meant, primarily, as a back-port for users stuck with old Rails versions (< 4.0) 
+on production, facing potential (pool related) concurrency bugs e.g. with highly 
+concurrent loads under JRuby, although it also enhances some of the thread locking
+issues present in 4.x's pool. 
 
 Based on pool code from 4.x (which works much better than any previous version),
 with a few minor tunings and extensions such as `pool_initial: 0.5` which allows
@@ -56,7 +76,7 @@ to specify how many connections to initialize in advance when the pool is create
 
 The false pool won't do any actual pooling, it is assumed that an underlying pool
 is configured. Still, it does maintain a hash of AR connections mapped to threads.
-Ignores pool related configurations such as `pool: 42` or `checkout_timeout: 2.5`.
+Ignores pool related configuration such as `pool: 42` or `checkout_timeout: 2.5`.
 
 **NOTE:** be sure to configure an underlying pool e.g. with Trinidad (using the
 default Tomcat JDBC pool) :
@@ -70,7 +90,7 @@ default Tomcat JDBC pool) :
     mysql_dbpool:
       url: jdbc:mysql:///my_production
       username: root
-      jndi: jdbc/BogacsDB
+      jndi: jdbc/MyDB
       initialSize: <%= ENV['POOL_INITIAL'] || 25 %> # connections created on start
       maxActive: <%= ENV['POOL_SIZE'] || 100 %> # default 100 (AR pool: size)
       maxIdle: <%= ENV['POOL_SIZE'] || 100 %> # max connections kept in the pool
@@ -88,7 +108,7 @@ following configuration :
 ```
 production:
   adapter: mysql2
-  jndi: java:/comp/env/jdbc/BogacsDB
+  jndi: java:/comp/env/jdbc/MyDB
 ```
 
 **NOTE:** when using `FalsePool` there's nothing to configure (in *database.yml*)!
@@ -97,7 +117,7 @@ production:
 
 This pool allows for a database connection to be "shared" among threads, this is
 very **dangerous** normally. You will need to understand the underlying driver's
-connection whether it is thread-safe.
+connection implementation (whether its thread-safe).
 
 You'll need to manually declare blocks that run with a shared connection (**make
 sure** only read operations happen within such blocks) similar to the built-in
@@ -109,15 +129,15 @@ cache_fetch( [ 'user', user_id ] ) do
 end
 ```
 
-The pool will only share connections among such blocks and only if it runs out
-of all connections (until than it will always prefer checking out a connection
-just like a "regular" pool).
+The pool "might" share connections among such blocks but only if it runs out of 
+all connections (pool size is reached), until than it will always prefer checking 
+out a connection just like `with_connection` does.
 
-Only tested with ActiveRecord-JDBC-Adapter using the official Postgres' driver.
+Tested with ActiveRecord-JDBC-Adapter using the official Postgres' driver (< 42).
 
 ## Copyright
 
-Copyright (c) 2017 [Karol Bucek](http://kares.org).
+Copyright (c) 2018 [Karol Bucek](http://kares.org).
 See LICENSE (http://en.wikipedia.org/wiki/MIT_License) for details.
 
 [0]: http://res.cloudinary.com/kares/image/upload/c_scale,h_600,w_800/v1406451696/bogacs.jpg

data/Rakefile

@@ -105,9 +105,11 @@ def _download(uri, download_dir, as_file_name)
   FileUtils.rm_r temp_dir
 end
 
+MAVEN_BASE_URL = 'https://repo.maven.apache.org/maven2'
+
 namespace :tomcat do
 
-  tomcat_maven_repo = 'http://repo2.maven.org/maven2/org/apache/tomcat'
+  tomcat_maven_repo = "#{MAVEN_BASE_URL}/org/apache/tomcat"
   download_dir = File.expand_path('test/jars', File.dirname(__FILE__))
   version_default = '7.0.64'
 
@@ -191,7 +193,7 @@ end
 
 namespace :dbcp do # a.k.a DBCP2
 
-  commons_repo = 'http://repo2.maven.org/maven2/org/apache/commons'
+  commons_repo = "#{MAVEN_BASE_URL}/org/apache/commons"
   download_dir = File.expand_path('test/jars', File.dirname(__FILE__))
   version_default = '2.0.1'
 
@@ -213,7 +215,7 @@ end
 
 namespace :c3p0 do
 
-  mchange_base_repo = 'http://repo2.maven.org/maven2/com/mchange'
+  mchange_base_repo = "#{MAVEN_BASE_URL}/com/mchange"
   download_dir = File.expand_path('test/jars', File.dirname(__FILE__))
   c3p0_version = '0.9.5'
   mchange_commons_version = '0.2.9'
@@ -242,9 +244,9 @@ end
 
 namespace :hikari do
 
-  hikari_base_repo = 'http://repo2.maven.org/maven2/com/zaxxer'
-  slf4j_base_repo = 'http://repo2.maven.org/maven2/org/slf4j'
-  javassist_base_repo = 'http://repo2.maven.org/maven2/org/javassist'
+  hikari_base_repo = "#{MAVEN_BASE_URL}/com/zaxxer"
+  slf4j_base_repo = "#{MAVEN_BASE_URL}/org/slf4j"
+  javassist_base_repo = "#{MAVEN_BASE_URL}/org/javassist"
   download_dir = File.expand_path('test/jars', File.dirname(__FILE__))
   hikari_version = '1.4.0'
   slf4j_version = '1.7.10'

data/activerecord-bogacs.gemspec

@@ -9,10 +9,9 @@ Gem::Specification.new do |gem|
   gem.authors = ['Karol Bucek']
   gem.email = ['self@kares.org']
   gem.description = %q{Improved ActiveRecord::ConnectionAdapters::ConnectionPool alternatives}
-  gem.summary = 'Bogacs contains several pool implementations that can be used as a replacement ' <<
-  "for ActiveRecord's built-in pool, e.g. DefaultPool is an upstream tuned version with an API " <<
-  'that is compatible with older AR versions.' <<
-  "\n\nNOTE: you'll need concurrent-ruby or thread_safe gem."
+  gem.summary = 'Bogacs contains several pool implementations that can be used as a replacement ' +
+  "for ActiveRecord's built-in pool, e.g. DefaultPool is an upstream tuned version with an API " +
+  'that is compatible with older AR versions.'
   gem.homepage = "http://github.com/kares/activerecord-bogacs"
   gem.licenses = ['MIT']
 
@@ -21,8 +20,9 @@ Gem::Specification.new do |gem|
   gem.test_files = gem.files.grep(%r{^test/})
   gem.require_paths = ["lib"]
 
-  gem.add_development_dependency 'concurrent-ruby', '>= 0.9' if RUBY_VERSION.index('1.8') != 0
+  gem.add_dependency 'activerecord', '< 6' # '>= 4.0' # depends on: concurrent-ruby ~> 1.0, >= 1.0.2
+  gem.add_dependency 'concurrent-ruby', '~> 1.0'
 
-  gem.add_development_dependency 'rake', '~> 10.3'
+  gem.add_development_dependency 'rake'
   gem.add_development_dependency 'test-unit', '~> 2.5'
 end

data/lib/active_record/bogacs/connection_handler.rb

@@ -0,0 +1,36 @@
+require 'active_record/version'
+
+require 'active_record/connection_adapters/abstract/connection_pool'
+
+module ActiveRecord
+  module Bogacs
+    class ConnectionHandler < ConnectionAdapters::ConnectionHandler
+
+      if ActiveRecord::VERSION::MAJOR < 5
+
+        def establish_connection(owner, spec)
+          @class_to_pool.clear
+          if spec.config[:pool].eql? false
+            owner_to_pool[owner.name] = ActiveRecord::Bogacs::FalsePool.new(spec)
+          else # super
+            owner_to_pool[owner.name] = ActiveRecord::ConnectionAdapters::ConnectionPool.new(spec)
+          end
+        end
+
+      else
+
+        def establish_connection(config) # (spec) in 5.0
+          pool = super
+          spec = pool.spec
+          if spec.config[:pool].eql? false
+            owner_to_pool[spec.name] = ActiveRecord::Bogacs::FalsePool.new(spec)
+          else
+            pool
+          end
+        end
+
+      end
+
+    end
+  end
+end